fix: Standardize parameter naming and enhance documentation across multiple files

hashkode · hashkode · commit 4084102a6618 · 2025-04-11T23:00:40.000+02:00
diff --git a/internal/app/app.go b/internal/app/app.go
@@ -102,12 +102,12 @@ var UpdaterModule = fx.Module("updater",
 	),
 	fx.Invoke(func(lc fx.Lifecycle, us updater.Service, logger log.Logger) {
 		lc.Append(fx.Hook{
-			OnStart: func(ctx context.Context) error {
+			OnStart: func(_ctx context.Context) error {
 				logger.Info().Msg("Registering Updater Service start hook")
-				us.Start(ctx)
+				us.Start(_ctx)
 				return nil
 			},
-			OnStop: func(ctx context.Context) error {
+			OnStop: func(_ctx context.Context) error {
 				logger.Info().Msg("Registering Updater Service stop hook")
 				us.Stop()
 				return nil
diff --git a/internal/backend/database/database.go b/internal/backend/database/database.go
@@ -53,6 +53,8 @@ CREATE TABLE IF NOT EXISTS tools (
 CREATE INDEX IF NOT EXISTS idx_tools_server_id ON tools(source_server_id);
 `
 
+// DB is the database implementation of the DBInterface.
+// It handles SQL operations for the agent-browser data persistence.
 type DB struct {
 	*sql.DB
 	// logger log.Logger // Optional: Inject logger if DB methods need logging
diff --git a/internal/backend/models/models.go b/internal/backend/models/models.go
@@ -1,3 +1,5 @@
+// Package models defines the data structures used by the agent-browser application.
+// It includes entity definitions for MCP servers, tools, and related data types.
 package models
 
 import "time"
diff --git a/internal/config/exporter_test.go b/internal/config/exporter_test.go
@@ -34,27 +34,27 @@ func (m *mockBackend) ListMCPServers() ([]models.MCPServer, error) {
 }
 
 //nolint:unused
-func (m *mockBackend) AddMCPServer(name, url string) (*models.MCPServer, error) {
+func (m *mockBackend) AddMCPServer(_name, _url string) (*models.MCPServer, error) {
 	return nil, errors.New("not implemented in mock")
 }
 
 //nolint:unused
-func (m *mockBackend) RemoveMCPServer(id int64) error {
+func (m *mockBackend) RemoveMCPServer(_id int64) error {
 	return errors.New("not implemented in mock")
 }
 
 //nolint:unused
-func (m *mockBackend) GetMCPServer(id int64) (*models.MCPServer, error) {
+func (m *mockBackend) GetMCPServer(_id int64) (*models.MCPServer, error) {
 	return nil, errors.New("not implemented in mock")
 }
 
 //nolint:unused
-func (m *mockBackend) ProcessFetchedTools(serverID int64, fetchedTools []models.FetchedTool) (added, updated int, err error) {
+func (m *mockBackend) ProcessFetchedTools(_serverID int64, _fetchedTools []models.FetchedTool) (added, updated int, err error) {
 	return 0, 0, errors.New("not implemented in mock")
 }
 
 //nolint:unused
-func (m *mockBackend) UpdateMCPServerStatus(id int64, checkErr error) {
+func (m *mockBackend) UpdateMCPServerStatus(_id int64, _checkErr error) {
 	// No-op in mock
 }
 
diff --git a/internal/events/events.go b/internal/events/events.go
@@ -1,3 +1,5 @@
+// Package events provides an event bus implementation for internal application events.
+// It defines event types and structures for communication between components.
 package events
 
 import (
diff --git a/internal/updater/service_test.go b/internal/updater/service_test.go
@@ -108,24 +108,24 @@ func (m *mockBackendService) UpdateMCPServerStatus(id int64, checkErr error) {
 // Add unused methods to satisfy interface
 //
 //nolint:unused
-func (m *mockBackendService) AddMCPServer(name, url string) (*models.MCPServer, error) {
+func (m *mockBackendService) AddMCPServer(_name, _url string) (*models.MCPServer, error) {
 	panic("unused")
 }
 
 //nolint:unused
-func (m *mockBackendService) RemoveMCPServer(id int64) error { panic("unused") }
+func (m *mockBackendService) RemoveMCPServer(_id int64) error { panic("unused") }
 
 //nolint:unused
-func (m *mockBackendService) GetMCPServer(id int64) (*models.MCPServer, error) { panic("unused") }
+func (m *mockBackendService) GetMCPServer(_id int64) (*models.MCPServer, error) { panic("unused") }
 
 // Helper to get recorded status update
 //
 //nolint:unused
-func (m *mockBackendService) getLastStatusUpdate(id int64) (error, bool) {
+func (m *mockBackendService) getLastStatusUpdate(id int64) (bool, error) {
 	m.mu.Lock()
 	defer m.mu.Unlock()
 	err, ok := m.statusUpdates[id]
-	return err, ok
+	return ok, err
 }
 
 // Helper to get recorded processed tools
diff --git a/internal/web/handlers/api.go b/internal/web/handlers/api.go
@@ -301,7 +301,6 @@ func (h *APIHandlers) ListTools(w http.ResponseWriter, r *http.Request) {
 	// Get all tools - not implemented yet
 	h.logger.Info().Msg("Listing all tools is not yet implemented")
 	http.Error(w, "Listing all tools is not implemented yet", http.StatusNotImplemented)
-	return
 }
 
 // RediscoverTools handles POST /api/mcp/rediscover-tools
diff --git a/internal/web/handlers/api_test.go b/internal/web/handlers/api_test.go
@@ -117,12 +117,12 @@ func (m *mockBackendServiceForAPI) GetMCPServer(id int64) (*models.MCPServer, er
 // --- Unused Service Methods (Panic if called) ---
 
 //nolint:unused
-func (m *mockBackendServiceForAPI) ProcessFetchedTools(serverID int64, fetchedTools []models.FetchedTool) (int, int, error) {
+func (m *mockBackendServiceForAPI) ProcessFetchedTools(_serverID int64, _fetchedTools []models.FetchedTool) (int, int, error) {
 	panic("ProcessFetchedTools not implemented/needed for API tests")
 }
 
 //nolint:unused
-func (m *mockBackendServiceForAPI) UpdateMCPServerStatus(id int64, checkErr error) {
+func (m *mockBackendServiceForAPI) UpdateMCPServerStatus(_id int64, _checkErr error) {
 	panic("UpdateMCPServerStatus not implemented/needed for API tests")
 }
 

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,8 @@ CREATE TABLE IF NOT EXISTS tools (`
`53`	`53`	`CREATE INDEX IF NOT EXISTS idx_tools_server_id ON tools(source_server_id);`
`54`	`54`	`
`55`	`55`
	`56`	`+// DB is the database implementation of the DBInterface.`
	`57`	`+// It handles SQL operations for the agent-browser data persistence.`
`56`	`58`	`type DB struct {`
`57`	`59`	`*sql.DB`
`58`	`60`	`// logger log.Logger // Optional: Inject logger if DB methods need logging`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// Package models defines the data structures used by the agent-browser application.`
	`2`	`+// It includes entity definitions for MCP servers, tools, and related data types.`
`1`	`3`	`package models`
`2`	`4`
`3`	`5`	`import "time"`
Original file line number	Diff line number	Diff line change
`@@ -34,27 +34,27 @@ func (m *mockBackend) ListMCPServers() ([]models.MCPServer, error) {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`//nolint:unused`
`37`		`-func (m mockBackend) AddMCPServer(name, url string) (models.MCPServer, error) {`
	`37`	`+func (m mockBackend) AddMCPServer(_name, _url string) (models.MCPServer, error) {`
`38`	`38`	`return nil, errors.New("not implemented in mock")`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`//nolint:unused`
`42`		`-func (m *mockBackend) RemoveMCPServer(id int64) error {`
	`42`	`+func (m *mockBackend) RemoveMCPServer(_id int64) error {`
`43`	`43`	`return errors.New("not implemented in mock")`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`//nolint:unused`
`47`		`-func (m mockBackend) GetMCPServer(id int64) (models.MCPServer, error) {`
	`47`	`+func (m mockBackend) GetMCPServer(_id int64) (models.MCPServer, error) {`
`48`	`48`	`return nil, errors.New("not implemented in mock")`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`//nolint:unused`
`52`		`-func (m *mockBackend) ProcessFetchedTools(serverID int64, fetchedTools []models.FetchedTool) (added, updated int, err error) {`
	`52`	`+func (m *mockBackend) ProcessFetchedTools(_serverID int64, _fetchedTools []models.FetchedTool) (added, updated int, err error) {`
`53`	`53`	`return 0, 0, errors.New("not implemented in mock")`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`//nolint:unused`
`57`		`-func (m *mockBackend) UpdateMCPServerStatus(id int64, checkErr error) {`
	`57`	`+func (m *mockBackend) UpdateMCPServerStatus(_id int64, _checkErr error) {`
`58`	`58`	`// No-op in mock`
`59`	`59`	`}`
`60`	`60`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// Package events provides an event bus implementation for internal application events.`
	`2`	`+// It defines event types and structures for communication between components.`
`1`	`3`	`package events`
`2`	`4`
`3`	`5`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,6 @@ func (h APIHandlers) ListTools(w http.ResponseWriter, r http.Request) {`
`301`	`301`	`// Get all tools - not implemented yet`
`302`	`302`	`h.logger.Info().Msg("Listing all tools is not yet implemented")`
`303`	`303`	`http.Error(w, "Listing all tools is not implemented yet", http.StatusNotImplemented)`
`304`		`- return`
`305`	`304`	`}`
`306`	`305`
`307`	`306`	`// RediscoverTools handles POST /api/mcp/rediscover-tools`
Original file line number	Diff line number	Diff line change
`@@ -117,12 +117,12 @@ func (m mockBackendServiceForAPI) GetMCPServer(id int64) (models.MCPServer, er`
`117`	`117`	`// --- Unused Service Methods (Panic if called) ---`
`118`	`118`
`119`	`119`	`//nolint:unused`
`120`		`-func (m *mockBackendServiceForAPI) ProcessFetchedTools(serverID int64, fetchedTools []models.FetchedTool) (int, int, error) {`
	`120`	`+func (m *mockBackendServiceForAPI) ProcessFetchedTools(_serverID int64, _fetchedTools []models.FetchedTool) (int, int, error) {`
`121`	`121`	`panic("ProcessFetchedTools not implemented/needed for API tests")`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`//nolint:unused`
`125`		`-func (m *mockBackendServiceForAPI) UpdateMCPServerStatus(id int64, checkErr error) {`
	`125`	`+func (m *mockBackendServiceForAPI) UpdateMCPServerStatus(_id int64, _checkErr error) {`
`126`	`126`	`panic("UpdateMCPServerStatus not implemented/needed for API tests")`
`127`	`127`	`}`
`128`	`128`