refactor: cleanup backend code

Author: kmendell

.github/ISSUE_TEMPLATE/config.yml

@@ -2,6 +2,7 @@ blank_issues_enabled: false
 contact_links:
   - name: Track the Most Upvoted Features
     url: https://upvotes.getarcane.app/
+    about: Track the Most Upvoted Features
   - name: 💬 Discord
     url: https://discord.gg/WyXYpdyV3Z
     about: For help and chatting with the community

backend/internal/api/diagnostics_handler.go

@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/getarcaneapp/arcane/backend/internal/middleware"
-	ws "github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
+	"github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
 	"github.com/gin-gonic/gin"
 )
 

backend/internal/api/ws_handler.go

@@ -24,7 +24,7 @@ import (
 	"github.com/getarcaneapp/arcane/backend/internal/middleware"
 	"github.com/getarcaneapp/arcane/backend/internal/services"
 	docker "github.com/getarcaneapp/arcane/backend/pkg/dockerutil"
-	ws "github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
+	"github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
 	httputil "github.com/getarcaneapp/arcane/backend/pkg/utils/httpx"
 	systemtypes "github.com/getarcaneapp/arcane/types/system"
 	"github.com/gin-gonic/gin"

backend/internal/api/ws_handler_test.go

@@ -13,7 +13,7 @@ import (
 	"time"
 
 	docker "github.com/getarcaneapp/arcane/backend/pkg/dockerutil"
-	ws "github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
+	"github.com/getarcaneapp/arcane/backend/pkg/libarcane/ws"
 	systemtypes "github.com/getarcaneapp/arcane/types/system"
 	"github.com/gin-gonic/gin"
 	"github.com/gorilla/websocket"

backend/internal/bootstrap/jobs_bootstrap.go

@@ -8,44 +8,44 @@ import (
 
 	"github.com/getarcaneapp/arcane/backend/internal/config"
 	"github.com/getarcaneapp/arcane/backend/pkg/libarcane"
-	pkg_scheduler "github.com/getarcaneapp/arcane/backend/pkg/scheduler"
+	"github.com/getarcaneapp/arcane/backend/pkg/scheduler"
 )
 
-func registerJobs(appCtx context.Context, newScheduler *pkg_scheduler.JobScheduler, appServices *Services, appConfig *config.Config) {
-	autoUpdateJob := pkg_scheduler.NewAutoUpdateJob(appServices.Updater, appServices.Settings)
+func registerJobs(appCtx context.Context, newScheduler *scheduler.JobScheduler, appServices *Services, appConfig *config.Config) {
+	autoUpdateJob := scheduler.NewAutoUpdateJob(appServices.Updater, appServices.Settings)
 	newScheduler.RegisterJob(autoUpdateJob)
 
-	imagePollingJob := pkg_scheduler.NewImagePollingJob(appServices.ImageUpdate, appServices.Settings, appServices.Environment)
+	imagePollingJob := scheduler.NewImagePollingJob(appServices.ImageUpdate, appServices.Settings, appServices.Environment)
 	newScheduler.RegisterJob(imagePollingJob)
 
-	environmentHealthJob := pkg_scheduler.NewEnvironmentHealthJob(appServices.Environment, appServices.Settings)
+	environmentHealthJob := scheduler.NewEnvironmentHealthJob(appServices.Environment, appServices.Settings)
 	if !appConfig.AgentMode {
 		newScheduler.RegisterJob(environmentHealthJob)
 	}
 
-	analyticsJob := pkg_scheduler.NewAnalyticsJob(appServices.Settings, appServices.KV, nil, appConfig)
+	analyticsJob := scheduler.NewAnalyticsJob(appServices.Settings, appServices.KV, nil, appConfig)
 	newScheduler.RegisterJob(analyticsJob)
 	// Send initial heartbeat on startup without blocking bootstrap.
 	go analyticsJob.Run(appCtx)
 
-	eventCleanupJob := pkg_scheduler.NewEventCleanupJob(appServices.Event, appServices.Settings)
+	eventCleanupJob := scheduler.NewEventCleanupJob(appServices.Event, appServices.Settings)
 	newScheduler.RegisterJob(eventCleanupJob)
 
-	scheduledPruneJob := pkg_scheduler.NewScheduledPruneJob(appServices.System, appServices.Settings, appServices.Notification)
+	scheduledPruneJob := scheduler.NewScheduledPruneJob(appServices.System, appServices.Settings, appServices.Notification)
 	newScheduler.RegisterJob(scheduledPruneJob)
 
-	fsWatcherJob, err := pkg_scheduler.RegisterFilesystemWatcherJob(appCtx, appServices.Project, appServices.Template, appServices.Settings, appConfig.ProjectScanMaxDepth)
+	fsWatcherJob, err := scheduler.RegisterFilesystemWatcherJob(appCtx, appServices.Project, appServices.Template, appServices.Settings, appConfig.ProjectScanMaxDepth)
 	if err != nil {
 		slog.ErrorContext(appCtx, "Failed to register filesystem watcher job", "error", err)
 	}
 
-	gitOpsSyncJob := pkg_scheduler.NewGitOpsSyncJob(appServices.GitOpsSync, appServices.Settings)
+	gitOpsSyncJob := scheduler.NewGitOpsSyncJob(appServices.GitOpsSync, appServices.Settings)
 	newScheduler.RegisterJob(gitOpsSyncJob)
 
-	vulnerabilityScanJob := pkg_scheduler.NewVulnerabilityScanJob(appServices.Vulnerability, appServices.Settings)
+	vulnerabilityScanJob := scheduler.NewVulnerabilityScanJob(appServices.Vulnerability, appServices.Settings)
 	newScheduler.RegisterJob(vulnerabilityScanJob)
 
-	autoHealJob := pkg_scheduler.NewAutoHealJob(appServices.Docker, appServices.Settings, appServices.Event, appServices.Notification)
+	autoHealJob := scheduler.NewAutoHealJob(appServices.Docker, appServices.Settings, appServices.Event, appServices.Notification)
 	newScheduler.RegisterJob(autoHealJob)
 
 	setupJobScheduleCallbacks(
@@ -69,15 +69,15 @@ func setupJobScheduleCallbacks(
 	lifecycleCtx context.Context,
 	appServices *Services,
 	appConfig *config.Config,
-	newScheduler *pkg_scheduler.JobScheduler,
-	imagePollingJob *pkg_scheduler.ImagePollingJob,
-	autoUpdateJob *pkg_scheduler.AutoUpdateJob,
-	environmentHealthJob *pkg_scheduler.EnvironmentHealthJob,
-	eventCleanupJob *pkg_scheduler.EventCleanupJob,
-	scheduledPruneJob *pkg_scheduler.ScheduledPruneJob,
-	gitOpsSyncJob *pkg_scheduler.GitOpsSyncJob,
-	vulnerabilityScanJob *pkg_scheduler.VulnerabilityScanJob,
-	autoHealJob *pkg_scheduler.AutoHealJob,
+	newScheduler *scheduler.JobScheduler,
+	imagePollingJob *scheduler.ImagePollingJob,
+	autoUpdateJob *scheduler.AutoUpdateJob,
+	environmentHealthJob *scheduler.EnvironmentHealthJob,
+	eventCleanupJob *scheduler.EventCleanupJob,
+	scheduledPruneJob *scheduler.ScheduledPruneJob,
+	gitOpsSyncJob *scheduler.GitOpsSyncJob,
+	vulnerabilityScanJob *scheduler.VulnerabilityScanJob,
+	autoHealJob *scheduler.AutoHealJob,
 ) {
 	if appServices.JobSchedule == nil {
 		return
@@ -108,15 +108,15 @@ func handleJobScheduleChangeInternal(
 	ctx context.Context,
 	key string,
 	appConfig *config.Config,
-	newScheduler *pkg_scheduler.JobScheduler,
-	imagePollingJob *pkg_scheduler.ImagePollingJob,
-	autoUpdateJob *pkg_scheduler.AutoUpdateJob,
-	environmentHealthJob *pkg_scheduler.EnvironmentHealthJob,
-	eventCleanupJob *pkg_scheduler.EventCleanupJob,
-	scheduledPruneJob *pkg_scheduler.ScheduledPruneJob,
-	gitOpsSyncJob *pkg_scheduler.GitOpsSyncJob,
-	vulnerabilityScanJob *pkg_scheduler.VulnerabilityScanJob,
-	autoHealJob *pkg_scheduler.AutoHealJob,
+	newScheduler *scheduler.JobScheduler,
+	imagePollingJob *scheduler.ImagePollingJob,
+	autoUpdateJob *scheduler.AutoUpdateJob,
+	environmentHealthJob *scheduler.EnvironmentHealthJob,
+	eventCleanupJob *scheduler.EventCleanupJob,
+	scheduledPruneJob *scheduler.ScheduledPruneJob,
+	gitOpsSyncJob *scheduler.GitOpsSyncJob,
+	vulnerabilityScanJob *scheduler.VulnerabilityScanJob,
+	autoHealJob *scheduler.AutoHealJob,
 ) {
 	switch key {
 	case "pollingInterval":
@@ -157,7 +157,7 @@ func handleJobScheduleChangeInternal(
 	}
 }
 
-func setupSettingsCallbacks(lifecycleCtx context.Context, appServices *Services, appConfig *config.Config, newScheduler *pkg_scheduler.JobScheduler, imagePollingJob *pkg_scheduler.ImagePollingJob, autoUpdateJob *pkg_scheduler.AutoUpdateJob, environmentHealthJob *pkg_scheduler.EnvironmentHealthJob, fsWatcherJob *pkg_scheduler.FilesystemWatcherJob, scheduledPruneJob *pkg_scheduler.ScheduledPruneJob, vulnerabilityScanJob *pkg_scheduler.VulnerabilityScanJob, autoHealJob *pkg_scheduler.AutoHealJob) {
+func setupSettingsCallbacks(lifecycleCtx context.Context, appServices *Services, appConfig *config.Config, newScheduler *scheduler.JobScheduler, imagePollingJob *scheduler.ImagePollingJob, autoUpdateJob *scheduler.AutoUpdateJob, environmentHealthJob *scheduler.EnvironmentHealthJob, fsWatcherJob *scheduler.FilesystemWatcherJob, scheduledPruneJob *scheduler.ScheduledPruneJob, vulnerabilityScanJob *scheduler.VulnerabilityScanJob, autoHealJob *scheduler.AutoHealJob) {
 	appServices.Settings.OnImagePollingSettingsChanged = func(_ context.Context) {
 		if err := newScheduler.RescheduleJob(lifecycleCtx, imagePollingJob); err != nil {
 			slog.WarnContext(lifecycleCtx, "Failed to reschedule image-polling job", "error", err)

backend/internal/bootstrap/router_bootstrap.go

@@ -119,7 +119,7 @@ func setupRouter(ctx context.Context, cfg *config.Config, appServices *Services)
 	handlers.RegisterWebhookTrigger(apiGroup, appServices.Webhook) //nolint:contextcheck
 
 	apiGroup.Use(middleware.NewEnvProxyMiddlewareWithParam(
-		types.LOCAL_DOCKER_ENVIRONMENT_ID,
+		types.LocalDockerEnvironmentId,
 		"id",
 		envResolver,
 		createAuthValidator(appServices),

backend/internal/common/errors.go

@@ -1205,6 +1205,24 @@ func (e *ApiKeyNotFoundError) Error() string {
 	return "API key not found"
 }
 
+type ApiKeyExpiredError struct{}
+
+func (e *ApiKeyExpiredError) Error() string {
+	return "API key has expired"
+}
+
+type ApiKeyInvalidError struct{}
+
+func (e *ApiKeyInvalidError) Error() string {
+	return "invalid API key"
+}
+
+type ApiKeyProtectedError struct{}
+
+func (e *ApiKeyProtectedError) Error() string {
+	return "API key is protected"
+}
+
 type ApiKeyUpdateError struct {
 	Err error
 }

backend/internal/huma/handlers/apikeys.go

@@ -256,10 +256,10 @@ func (h *ApiKeyHandler) UpdateApiKey(ctx context.Context, input *UpdateApiKeyInp
 
 	apiKey, err := h.apiKeyService.UpdateApiKey(ctx, input.ID, input.Body)
 	if err != nil {
-		if errors.Is(err, services.ErrApiKeyNotFound) {
+		if _, ok := errors.AsType[*common.ApiKeyNotFoundError](err); ok {
 			return nil, huma.Error404NotFound((&common.ApiKeyNotFoundError{}).Error())
 		}
-		if errors.Is(err, services.ErrApiKeyProtected) {
+		if _, ok := errors.AsType[*common.ApiKeyProtectedError](err); ok {
 			return nil, huma.Error403Forbidden("static API keys cannot be updated")
 		}
 		return nil, huma.Error500InternalServerError((&common.ApiKeyUpdateError{Err: err}).Error())
@@ -285,10 +285,10 @@ func (h *ApiKeyHandler) DeleteApiKey(ctx context.Context, input *DeleteApiKeyInp
 	}
 
 	if err := h.apiKeyService.DeleteApiKey(ctx, input.ID); err != nil {
-		if errors.Is(err, services.ErrApiKeyNotFound) {
+		if _, ok := errors.AsType[*common.ApiKeyNotFoundError](err); ok {
 			return nil, huma.Error404NotFound((&common.ApiKeyNotFoundError{}).Error())
 		}
-		if errors.Is(err, services.ErrApiKeyProtected) {
+		if _, ok := errors.AsType[*common.ApiKeyProtectedError](err); ok {
 			return nil, huma.Error403Forbidden("static API keys cannot be deleted")
 		}
 		return nil, huma.Error500InternalServerError((&common.ApiKeyDeletionError{Err: err}).Error())

backend/internal/huma/handlers/containers.go

@@ -25,7 +25,7 @@ type ContainerHandler struct {
 	settingsService  *services.SettingsService
 }
 
-// Paginated response
+// ContainerPaginatedResponse response
 type ContainerPaginatedResponse struct {
 	Success    bool                          `json:"success"`
 	Data       []containertypes.Summary      `json:"data"`
@@ -121,7 +121,7 @@ type DeleteContainerOutput struct {
 	Body ContainerActionResponse
 }
 
-// RegisterContainers registers container endpoints.
+// SetAutoUpdateInput sets the auto update value for a container.
 type SetAutoUpdateInput struct {
 	EnvironmentID string `path:"id" doc:"Environment ID"`
 	ContainerID   string `path:"containerId" doc:"Container ID"`

backend/internal/huma/handlers/environments.go

@@ -464,7 +464,7 @@ func (h *EnvironmentHandler) createEnvironmentWithApiKey(ctx context.Context, en
 func (h *EnvironmentHandler) createEnvironmentLegacy(ctx context.Context, env *models.Environment, user *models.User, body environment.Create) (*CreateEnvironmentOutput, error) {
 	// Legacy pairing flows
 	if (body.AccessToken == nil || *body.AccessToken == "") && body.BootstrapToken != nil && *body.BootstrapToken != "" {
-		token, err := h.environmentService.PairAgentWithBootstrap(ctx, body.ApiUrl, *body.BootstrapToken)
+		token, err := h.environmentService.PairAgentWithBootstrap(ctx, body.ApiUrl, *body.BootstrapToken) //nolint:staticcheck
 		if err != nil {
 			slog.ErrorContext(ctx, "Failed to pair with agent", "apiUrl", body.ApiUrl, "error", err.Error())
 			return nil, huma.Error502BadGateway((&common.AgentPairingError{Err: err}).Error())