Refactor error handling and utility functions; remove deprecated code and improve logging

core/sv1/server.go

@@ -1,3 +1,5 @@
+// Package sv1 provides the implementation of the Server V1 API handler.
+// It includes utilities for handling API requests, extracting descriptions, and managing UUIDs.
 package sv1
 
 import (
@@ -8,16 +10,7 @@ import (
 	"github.com/akyaiy/GoSally-mvp/core/config"
 )
 
-type ServerV1UtilsContract interface {
-	extractDescriptionStatic(path string) (string, error)
-	writeJSONError(status int, msg string)
-	newUUID() string
-
-	_errNotFound()
-	ErrNotFound(w http.ResponseWriter, r *http.Request)
-}
-
-// structure only for initialization
+// HandlerV1InitStruct structure is only for initialization
 type HandlerV1InitStruct struct {
 	Ver            string
 	Log            slog.Logger
@@ -26,6 +19,7 @@ type HandlerV1InitStruct struct {
 	ListAllowedCmd *regexp.Regexp
 }
 
+// HandlerV1 implements the ServerV1UtilsContract and serves as the main handler for API requests.
 type HandlerV1 struct {
 	w http.ResponseWriter
 	r *http.Request
@@ -34,12 +28,16 @@ type HandlerV1 struct {
 
 	cfg *config.ConfigConf
 
+	// allowedCmd and listAllowedCmd are regular expressions used to validate command names.
 	allowedCmd     *regexp.Regexp
 	listAllowedCmd *regexp.Regexp
 
 	ver string
 }
 
+// InitV1Server initializes a new HandlerV1 with the provided configuration and returns it.
+// Should be carefull with giving to this function invalid parameters,
+// because there is no validation of parameters in this function.
 func InitV1Server(o *HandlerV1InitStruct) *HandlerV1 {
 	return &HandlerV1{
 		log:            o.Log,
@@ -50,18 +48,8 @@ func InitV1Server(o *HandlerV1InitStruct) *HandlerV1 {
 	}
 }
 
-func (h *HandlerV1) Handle(w http.ResponseWriter, r *http.Request) {
-	h.w = w
-	h.r = r
-	h._handle()
-}
-
-func (h *HandlerV1) HandleList(w http.ResponseWriter, r *http.Request) {
-	h.w = w
-	h.r = r
-	h._handleList()
-}
-
+// GetVersion returns the API version of the HandlerV1, which is set during initialization.
+// This version is used to identify the API version in the request routing.
 func (h *HandlerV1) GetVersion() string {
 	return h.ver
 }