Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: surface Docker join errors and allow manager-address override in Easy Join (#4191)
Kyle Mendelle2312137c99f
diff --git a/backend/internal/swarm/handler.go b/backend/internal/swarm/handler.goindex 2ab03036d..c79c4b75f 100644--- a/backend/internal/swarm/handler.go+++ b/backend/internal/swarm/handler.go@@ -20,7 +20,6 @@ import ("github.com/getarcaneapp/arcane/backend/v2/internal/middleware""github.com/getarcaneapp/arcane/backend/v2/pkg/authz""github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/edge"- "github.com/getarcaneapp/arcane/backend/v2/pkg/pagination""github.com/getarcaneapp/arcane/backend/v2/pkg/remenv""github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil""github.com/getarcaneapp/arcane/types/v2/base"@@ -1208,7 +1207,14 @@ func (h *SwarmHandler) InitSwarm(ctx context.Context, input *InitSwarmInput) (*h// when the join operation fails.func (h *SwarmHandler) JoinSwarm(ctx context.Context, input *JoinSwarmInput) (*handlerutil.Out[base.MessageResponse], error) {if err := h.swarmService.JoinSwarm(ctx, input.Body); err != nil {- return nil, mapSwarmServiceErrorInternal(err, "Failed to join swarm")+ detail := redactSwarmJoinTokenInternal(err.Error(), input.Body.JoinToken)+ slog.WarnContext(ctx, "swarm join failed", "environmentId", input.EnvironmentID, "operation", "join-swarm", "error", detail)+ httpErr := mapSwarmServiceErrorInternal(err, detail)+ var model *huma.ErrorModel+ if errors.As(httpErr, &model) {+ model.Detail = redactSwarmJoinTokenInternal(model.Detail, input.Body.JoinToken)+ }+ return nil, httpErr}h.auditSwarmMutation(ctx, input.EnvironmentID, "lifecycle.join", "swarm", "cluster", "cluster", map[string]any{"remoteAddrs": input.Body.RemoteAddrs})@@ -1252,18 +1258,6 @@ func (h *SwarmHandler) JoinEnvironments(ctx context.Context, input *JoinSwarmEnv}}- if len(input.Body.RemoteAddrs) == 0 {- nodes, _, err := h.swarmService.ListNodesPaginated(ctx, input.EnvironmentID, pagination.QueryParams{Limit: -1})- if err != nil {- return nil, mapSwarmServiceErrorInternal(err, "Failed to derive swarm manager addresses")- }- for _, node := range nodes {- if node.ManagerAddress != "" {- input.Body.RemoteAddrs = append(input.Body.RemoteAddrs, node.ManagerAddress)- }- }- }-result, err := h.swarmService.JoinEnvironments(ctx, input.EnvironmentID, input.Body)if err != nil {return nil, mapSwarmServiceErrorInternal(err, "Failed to join swarm environments")diff --git a/backend/internal/swarm/service_test.go b/backend/internal/swarm/service_test.goindex 044b848a3..3f18d4d57 100644--- a/backend/internal/swarm/service_test.go+++ b/backend/internal/swarm/service_test.go@@ -12,10 +12,12 @@ import (cerrdefs "github.com/containerd/errdefs""github.com/getarcaneapp/arcane/backend/v2/internal/actors"+ "github.com/getarcaneapp/arcane/backend/v2/internal/common""github.com/getarcaneapp/arcane/backend/v2/internal/database""github.com/getarcaneapp/arcane/backend/v2/internal/docker""github.com/getarcaneapp/arcane/backend/v2/internal/environment""github.com/getarcaneapp/arcane/backend/v2/internal/settings"+ "github.com/getarcaneapp/arcane/backend/v2/pkg/remenv"swarmtypes "github.com/getarcaneapp/arcane/types/v2/swarm""github.com/libtnb/sqlite""github.com/moby/moby/api/types/swarm"@@ -98,6 +100,45 @@ func TestDefaultSwarmListenAddrInternal(t *testing.T) {require.Equal(t, "eth0:2377", defaultSwarmListenAddrInternal(" eth0:2377 "))}+func TestSelectSwarmManagerAddressesInternal(t *testing.T) {+ nodes := []swarmtypes.NodeSummary{+ {ID: "manager-1", ManagerAddress: "10.0.0.1:2377"},+ {ID: "worker-1"},+ {ID: "manager-2", ManagerAddress: "10.0.0.2:2377"},+ }++ addrs, err := selectSwarmManagerAddressesInternal([]string{" 100.64.0.10:2377 ", "", "100.64.0.11:2377"}, nodes)+ require.NoError(t, err)+ require.Equal(t, []string{"100.64.0.10:2377", "100.64.0.11:2377"}, addrs)++ addrs, err = selectSwarmManagerAddressesInternal([]string{" "}, nodes)+ require.NoError(t, err)+ require.Equal(t, []string{"10.0.0.1:2377", "10.0.0.2:2377"}, addrs)++ _, err = selectSwarmManagerAddressesInternal(nil, []swarmtypes.NodeSummary{{ID: "worker-1"}})+ require.ErrorIs(t, err, common.ErrBadRequest)+}++func TestDescribeSwarmJoinFailureInternal(t *testing.T) {+ const token = "SWMTKN-1-secret"+ statusErr := func(code int, body string) error {+ return errors.Join(&remenv.StatusError{StatusCode: code, Body: []byte(body)})+ }++ require.Equal(t,+ "failed to join swarm: Timeout was reached before node joined using [redacted]",+ describeSwarmJoinFailureInternal(statusErr(500, `{"title":"Internal Server Error","status":500,"detail":"failed to join swarm: Timeout was reached before node joined using `+token+`"}`), token),+ )+ require.Equal(t, "legacy join failure", describeSwarmJoinFailureInternal(statusErr(400, `{"success":false,"error":"legacy join failure"}`), token))+ require.Equal(t, "swarm join failed with HTTP 502 from the target agent", describeSwarmJoinFailureInternal(statusErr(502, "<html>bad gateway</html>"), token))+ require.Equal(t, "swarm join failed with HTTP 404 from the target agent", describeSwarmJoinFailureInternal(statusErr(404, ""), token))+ require.Equal(t,+ "failed to send request to environment edge: dial tcp 10.0.0.9:3552: connect: connection refused",+ describeSwarmJoinFailureInternal(errors.New("failed to send request to environment edge: dial tcp 10.0.0.9:3552: connect: connection refused"), token),+ )+ require.Equal(t, "token [redacted] rejected", describeSwarmJoinFailureInternal(errors.New("token "+token+" rejected"), token))+}+func TestSwarmService_FetchSwarmNodeIdentityViaEdgeInternal_UsesEnvironmentAccessToken(t *testing.T) {ctx := context.Background()db := setupSwarmServiceTestDBInternal(t)diff --git a/backend/internal/swarm/swarm.go b/backend/internal/swarm/swarm.goindex 5c45a0a9e..3a70e77bd 100644--- a/backend/internal/swarm/swarm.go+++ b/backend/internal/swarm/swarm.go@@ -31,6 +31,7 @@ import (libswarm "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/swarm""github.com/getarcaneapp/arcane/backend/v2/pkg/pagination"appfs "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"+ "github.com/getarcaneapp/arcane/backend/v2/pkg/remenv""github.com/getarcaneapp/arcane/backend/v2/pkg/utils"swarmtypes "github.com/getarcaneapp/arcane/types/v2/swarm"networktypes "github.com/moby/moby/api/types/network"@@ -888,15 +889,16 @@ func (s *SwarmService) JoinEnvironments(ctx context.Context, managerEnvironmentIif len(request.Targets) == 0 {return &swarmtypes.SwarmJoinEnvironmentsResponse{Results: []swarmtypes.SwarmJoinEnvironmentResult{}}, nil}- if len(request.RemoteAddrs) == 0 {- return nil, errors.New("at least one swarm manager address is required")- }- tokens, err := s.getSwarmJoinTokensForEnvironmentInternal(ctx, managerEnvironmentID)+ nodes, _, err := s.ListNodesPaginated(ctx, managerEnvironmentID, pagination.QueryParams{Limit: -1})if err != nil {return nil, err}- nodes, _, err := s.ListNodesPaginated(ctx, managerEnvironmentID, pagination.QueryParams{Limit: -1})+ remoteAddrs, err := selectSwarmManagerAddressesInternal(request.RemoteAddrs, nodes)+ if err != nil {+ return nil, err+ }+ tokens, err := s.getSwarmJoinTokensForEnvironmentInternal(ctx, managerEnvironmentID)if err != nil {return nil, err}@@ -908,7 +910,7 @@ func (s *SwarmService) JoinEnvironments(ctx context.Context, managerEnvironmentIresults := make([]swarmtypes.SwarmJoinEnvironmentResult, len(request.Targets))processTargetInternal := func(index int) {target := request.Targets[index]- results[index] = s.joinEnvironmentInternal(ctx, managerEnvironmentID, target, request.RemoteAddrs, tokens, memberNodeIDs)+ results[index] = s.joinEnvironmentInternal(ctx, managerEnvironmentID, target, remoteAddrs, tokens, memberNodeIDs)}for index, target := range request.Targets {@@ -937,6 +939,60 @@ func (s *SwarmService) JoinEnvironments(ctx context.Context, managerEnvironmentIreturn &swarmtypes.SwarmJoinEnvironmentsResponse{Results: results}, nil}+// selectSwarmManagerAddressesInternal prefers explicit manager addresses and+// otherwise uses the addresses advertised by the cluster's manager nodes.+func selectSwarmManagerAddressesInternal(explicit []string, nodes []swarmtypes.NodeSummary) ([]string, error) {+ addrs := make([]string, 0, len(explicit))+ for _, addr := range explicit {+ if trimmed := strings.TrimSpace(addr); trimmed != "" {+ addrs = append(addrs, trimmed)+ }+ }+ if len(addrs) > 0 {+ return addrs, nil+ }+ for _, node := range nodes {+ if node.ManagerAddress != "" {+ addrs = append(addrs, node.ManagerAddress)+ }+ }+ if len(addrs) == 0 {+ return nil, common.Classify(common.ErrBadRequest, errors.New("no swarm manager addresses were discovered; enter manager addresses reachable from the target hosts"))+ }+ return addrs, nil+}++// describeSwarmJoinFailureInternal turns a proxied join failure into a concise,+// token-free message. Agent HTTP errors contribute their detail; transport+// errors keep their own text.+func describeSwarmJoinFailureInternal(err error, joinToken string) string {+ var status *remenv.StatusError+ if !errors.As(err, &status) {+ return redactSwarmJoinTokenInternal(err.Error(), joinToken)+ }+ var body struct {+ Detail string `json:"detail"`+ Error string `json:"error"`+ }+ if len(bytes.TrimSpace(status.Body)) > 0 && json.Unmarshal(status.Body, &body) == nil {+ if detail := strings.TrimSpace(body.Detail); detail != "" {+ return redactSwarmJoinTokenInternal(detail, joinToken)+ }+ if legacy := strings.TrimSpace(body.Error); legacy != "" {+ return redactSwarmJoinTokenInternal(legacy, joinToken)+ }+ }+ return fmt.Sprintf("swarm join failed with HTTP %d from the target agent", status.StatusCode)+}++// redactSwarmJoinTokenInternal masks the join token wherever it appears in message.+func redactSwarmJoinTokenInternal(message, joinToken string) string {+ if joinToken == "" {+ return message+ }+ return strings.ReplaceAll(message, joinToken, "[redacted]")+}+func (s *SwarmService) getSwarmJoinTokensForEnvironmentInternal(ctx context.Context, environmentID string) (*swarmtypes.SwarmJoinTokensResponse, error) {if environmentID == "0" {return s.GetSwarmJoinTokens(ctx)@@ -1013,11 +1069,13 @@ func (s *SwarmService) joinEnvironmentInternal(var joinResponse struct {Success bool `json:"success"`}- if err := s.environmentService.ProxyJSONRequest(ctx, target.EnvironmentID, http.MethodPost, "/api/environments/0/swarm/join", body, &joinResponse); err != nil || !joinResponse.Success {+ if err := s.environmentService.ProxyJSONRequest(ctx, target.EnvironmentID, http.MethodPost, "/api/environments/0/swarm/join", body, &joinResponse); err != nil {+ message := describeSwarmJoinFailureInternal(err, joinToken)+ result.Error = &message+ return result+ }+ if !joinResponse.Success {message := "swarm join failed"- if err != nil {- message = err.Error()- }result.Error = &messagereturn result}diff --git a/frontend/messages/en.json b/frontend/messages/en.jsonindex 6c43fa81e..986848766 100644--- a/frontend/messages/en.json+++ b/frontend/messages/en.json@@ -1308,6 +1308,7 @@"swarm_easy_join_targets_required": "Select at least one Remote Environment.","worker": "Worker","swarm_easy_join_data_path_placeholder": "Data-path address (optional)",+ "swarm_easy_join_manager_addresses_help": "Leave blank to use the manager addresses discovered from this cluster. Any address you enter must be reachable from every selected Docker host, for example 100.64.0.10:2377.","swarm_easy_join_results_title": "Join results","swarm_easy_join_result_joined": "Joined and verified","swarm_easy_join_result_already_member": "Already a member and verified",diff --git a/frontend/src/routes/(app)/swarm/cluster/easy-join-dialog.svelte b/frontend/src/routes/(app)/swarm/cluster/easy-join-dialog.svelteindex 3c8af694a..e5fc6965c 100644--- a/frontend/src/routes/(app)/swarm/cluster/easy-join-dialog.svelte+++ b/frontend/src/routes/(app)/swarm/cluster/easy-join-dialog.svelte@@ -15,7 +15,8 @@import { m } from '#lib/paraglide/messages.js';import { swarmService } from '#lib/services/swarm-service.js';import type { SwarmJoinCandidate, SwarmJoinEnvironmentResult, SwarmJoinEnvironmentTarget } from '#lib/types/swarm.js';- import { extractApiErrorMessage } from '#lib/utils/api.js';+ import { extractApiErrorMessage, handleApiResultWithCallbacks } from '#lib/utils/api.js';+ import { parseList } from '#lib/utils/form-parsers.js';type Props = {open: boolean;@@ -40,6 +41,8 @@const candidates = $derived((candidatesQuery.data ?? []).filter((candidate) => !targetEnvironmentId || candidate.environmentId === targetEnvironmentId));+ let managerAddressesInput = $state('');+ const remoteAddrs = $derived(parseList(managerAddressesInput));let targetDraft = $state<Record<string, SwarmJoinEnvironmentTarget> | null>(null);const targets = $derived.by(() => {if (targetDraft) return targetDraft;@@ -101,23 +104,23 @@isJoining = true;mutationError = '';results = [];- try {- const operationResult = await tryCatch(- (async () => {- const response = await swarmService.joinEnvironments({ remoteAddrs: [], targets: selectedTargets }, environmentId);- if (destroyed || environmentId !== requestedManagerId) return;- results = response.results;- await onComplete?.();- })()- );- if (operationResult.error !== null && !destroyed && environmentId === requestedManagerId) {- const error = operationResult.error;-- mutationError = extractApiErrorMessage(error);- }- } finally {+ const result = await tryCatch(swarmService.joinEnvironments({ remoteAddrs, targets: selectedTargets }, environmentId));+ if (destroyed || environmentId !== requestedManagerId) {isJoining = false;+ return;}+ await handleApiResultWithCallbacks({+ result,+ message: m.swarm_cluster_join_failed(),+ setLoadingState: (value) => (isJoining = value),+ onSuccess: async (response) => {+ results = response.results;+ await onComplete?.();+ },+ onError: (error) => {+ mutationError = extractApiErrorMessage(error);+ }+ });}function resultLabel(result: SwarmJoinEnvironmentResult): string {@@ -157,6 +160,16 @@{m.swarm_easy_join_no_candidates()}</div>{:else}+ <div class="space-y-1.5">+ <label for="easy-join-manager-addresses" class="text-sm font-medium">{m.swarm_cluster_manager_addresses_label()}</label>+ <Input+ id="easy-join-manager-addresses"+ placeholder={m.swarm_cluster_join_remote_addrs_placeholder()}+ bind:value={managerAddressesInput}+ disabled={isJoining}+ />+ <p class="text-xs text-muted-foreground">{m.swarm_easy_join_manager_addresses_help()}</p>+ </div><div class="space-y-3">{#each candidates as candidate (candidate.environmentId)}{@const target = targets[candidate.environmentId]}@@ -165,6 +178,7 @@<inputtype="checkbox"checked={!!target}+ disabled={isJoining}onchange={(event) => toggleCandidate(candidate, event.currentTarget.checked)}/><span>@@ -181,6 +195,7 @@<selectclass="h-9 w-full rounded-md border border-input bg-background px-3"value={target.role}+ disabled={isJoining}onchange={(event) =>updateTarget(candidate.environmentId, {role: event.currentTarget.value as 'worker' | 'manager'@@ -195,6 +210,7 @@<selectclass="h-9 w-full rounded-md border border-input bg-background px-3"value={target.availability}+ disabled={isJoining}onchange={(event) =>updateTarget(candidate.environmentId, {availability: event.currentTarget.value as 'active' | 'pause' | 'drain'@@ -210,16 +226,19 @@<Inputplaceholder={m.swarm_cluster_listen_addr_placeholder()}value={target.listenAddr ?? ''}+ disabled={isJoining}oninput={(event) => updateTarget(candidate.environmentId, { listenAddr: event.currentTarget.value })}/><Inputplaceholder={m.swarm_cluster_advertise_addr_placeholder()}value={target.advertiseAddr ?? ''}+ disabled={isJoining}oninput={(event) => updateTarget(candidate.environmentId, { advertiseAddr: event.currentTarget.value })}/><Inputplaceholder={m.swarm_easy_join_data_path_placeholder()}value={target.dataPathAddr ?? ''}+ disabled={isJoining}oninput={(event) => updateTarget(candidate.environmentId, { dataPathAddr: event.currentTarget.value })}/></div>@@ -239,7 +258,11 @@>{candidates.find((candidate) => candidate.environmentId === result.environmentId)?.environmentName ??result.environmentId}</span>- <span class={result.state === 'failed' ? 'text-right text-destructive' : 'text-right text-muted-foreground'}>+ <span+ class={result.state === 'failed'+ ? 'min-w-0 text-right break-words text-destructive'+ : 'min-w-0 text-right break-words text-muted-foreground'}+ >{resultLabel(result)}{result.error ? `: ${result.error}` : ''}</span></div>