Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
refactor: use atomic file writes and atomic bools for tunnel connections (#3097)
Kyle Mendell620407076af7
diff --git a/backend/go.mod b/backend/go.modindex dae9c350e..cd52e0285 100644--- a/backend/go.mod+++ b/backend/go.mod@@ -54,6 +54,7 @@ require (github.com/subosito/gotenv v1.6.0github.com/wneessen/go-mail v0.7.3go.getarcane.app/builds v0.1.0+ go.getarcane.app/sys/atomic v0.1.0go.getarcane.app/updater v0.4.0go.yaml.in/yaml/v4 v4.0.0-rc.6golang.org/x/crypto v0.53.0diff --git a/backend/go.sum b/backend/go.sumindex e680b8f35..4aa216b4d 100644--- a/backend/go.sum+++ b/backend/go.sum@@ -537,6 +537,8 @@ github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPogithub.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=go.getarcane.app/builds v0.1.0 h1:BOEFFFI35nQq/jowWs7+Uhi1XNoKIEKmNd7xnassCVg=go.getarcane.app/builds v0.1.0/go.mod h1:3g7+969+qWH33EXnA+nu5MKhs72JYDPf9Q/OtYO6CIA=+go.getarcane.app/sys/atomic v0.1.0 h1:0HhUeGXYdKAmMW24O+OaqcjDZx6twAuYPBu9T91zKsk=+go.getarcane.app/sys/atomic v0.1.0/go.mod h1:QPb5eUXYKYG5acp9jJBAZ/PTbHbByDAQG6eDNAsZZ2w=go.getarcane.app/updater v0.4.0 h1:ZVXZ8N/sXDZq7/0VvB8JMwtbwNpGqrswLDjESimL8mw=go.getarcane.app/updater v0.4.0/go.mod h1:Pqz4cI9nePA6abdZzfESZPxQC5jWVoiWKqcgX+pDkAk=go.opencensus.io v0.24.0 h1:y73uSU6J157QMP2kn2r30vwW1A2W2WFwSCGnAVxeaD0=diff --git a/backend/pkg/libarcane/crypto/encryption.go b/backend/pkg/libarcane/crypto/encryption.goindex b838052bf..38f80b169 100644--- a/backend/pkg/libarcane/crypto/encryption.go+++ b/backend/pkg/libarcane/crypto/encryption.go@@ -14,6 +14,8 @@ import ("os""path/filepath""strings"++ "go.getarcane.app/sys/atomic")var encryptionKey []byte@@ -125,35 +127,7 @@ func agentKeyDir() string {}func atomicWriteHexFile(path string, key []byte, mode os.FileMode) error {- dir := filepath.Dir(path)- tmp, err := os.CreateTemp(dir, "agent_key_")- if err != nil {- return err- }- tmpPath := tmp.Name()- defer func() {- _ = tmp.Close()- _ = os.Remove(tmpPath)- }()-- if _, err := tmp.WriteString(hex.EncodeToString(key) + "\n"); err != nil {- return err- }- if err := tmp.Sync(); err != nil {- // proceed, but return error if rename fails later- slog.Warn("Failed to sync agent key temp file; key may not be fully persisted", "err", err)- }- if err := tmp.Close(); err != nil {- return err- }- if err := os.Rename(tmpPath, path); err != nil {- return err- }- if err := os.Chmod(path, mode); err != nil {- // Non-fatal; permissions might be too permissive- slog.Warn("Failed to set permissions on agent key file", "path", path, "err", err)- }- return nil+ return atomic.WriteFile(path, []byte(hex.EncodeToString(key)+"\n"), mode)}func deriveDevKey() []byte {diff --git a/backend/pkg/libarcane/edge/tls.go b/backend/pkg/libarcane/edge/tls.goindex ba72b4a20..fc6e47d51 100644--- a/backend/pkg/libarcane/edge/tls.go+++ b/backend/pkg/libarcane/edge/tls.go@@ -28,6 +28,7 @@ import ("github.com/getarcaneapp/arcane/backend/v2/internal/common"libcrypto "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/crypto"certgen "github.com/getarcaneapp/arcane/cli/v2/pkg/generate"+ "go.getarcane.app/sys/atomic""google.golang.org/grpc/credentials""google.golang.org/grpc/peer")@@ -237,7 +238,7 @@ func recordManagerMTLSEnrollmentInternal(cfg *Config, envID string, now time.Timif now.IsZero() {now = time.Now()}- return writeFileAtomicInternal(markerPath, []byte(now.UTC().Format(time.RFC3339Nano)+"\n"), 0o600)+ return atomic.WriteFile(markerPath, []byte(now.UTC().Format(time.RFC3339Nano)+"\n"), 0o600)}func managerMTLSEnrollmentMarkerPathInternal(cfg *Config, envID string) (string, error) {@@ -303,7 +304,7 @@ func EnsureAgentMTLSAssets(ctx context.Context, cfg *Config) error {needsEnrollment, reason := agentMTLSAssetsNeedEnrollmentInternal(certPath, keyPath, time.Now())if !needsEnrollment {if !fileExistsInternal(filepath.Join(assetsDir, generatedMTLSEnrolledName)) {- if err := writeFileAtomicInternal(filepath.Join(assetsDir, generatedMTLSEnrolledName), []byte(time.Now().UTC().Format(time.RFC3339)+"\n"), 0o600); err != nil {+ if err := atomic.WriteFile(filepath.Join(assetsDir, generatedMTLSEnrolledName), []byte(time.Now().UTC().Format(time.RFC3339)+"\n"), 0o600); err != nil {return fmt.Errorf("failed to write edge mTLS enrollment marker: %w", err)}}@@ -374,7 +375,7 @@ func enrollAgentMTLSAssetsInternal(ctx context.Context, cfg *Config, assetsDir,if strings.TrimSpace(file.Permissions) == "0600" {perm = 0o600}- if err := writeFileAtomicInternal(targetPath, []byte(file.Content), perm); err != nil {+ if err := atomic.WriteFile(targetPath, []byte(file.Content), perm); err != nil {return fmt.Errorf("failed to write edge mTLS asset %s: %w", file.Name, err)}}@@ -382,7 +383,7 @@ func enrollAgentMTLSAssetsInternal(ctx context.Context, cfg *Config, assetsDir,if needsEnrollment {return fmt.Errorf("edge mTLS enrollment wrote unusable assets: %s", reason)}- if err := writeFileAtomicInternal(filepath.Join(assetsDir, generatedMTLSEnrolledName), []byte(time.Now().UTC().Format(time.RFC3339)+"\n"), 0o600); err != nil {+ if err := atomic.WriteFile(filepath.Join(assetsDir, generatedMTLSEnrolledName), []byte(time.Now().UTC().Format(time.RFC3339)+"\n"), 0o600); err != nil {return fmt.Errorf("failed to write edge mTLS enrollment marker: %w", err)}@@ -1205,7 +1206,7 @@ func writePEMFileInternal(path string, blockType string, bytes []byte, perm os.Fif pemBytes == nil {return fmt.Errorf("failed to encode PEM file %s", path)}- return writeFileAtomicInternal(path, pemBytes, perm)+ return atomic.WriteFile(path, pemBytes, perm)}// caKeyEncryptedPrefix marks files written with libcrypto envelope encryption.@@ -1231,7 +1232,7 @@ func writeCAKeyFileInternal(path string, derBytes []byte) error {return errors.New("failed to encrypt edge mTLS CA private key: encrypted payload is empty")}- return writeFileAtomicInternal(path, []byte(caKeyEncryptedPrefix+ciphertext), 0o600)+ return atomic.WriteFile(path, []byte(caKeyEncryptedPrefix+ciphertext), 0o600)}// readCAKeyPEMInternal returns the plain PEM bytes of the edge CA private key,@@ -1253,36 +1254,6 @@ func readCAKeyPEMInternal(path string) ([]byte, error) {return []byte(plaintext), nil}-// writeFileAtomicInternal writes data to path via a temp file + rename.-func writeFileAtomicInternal(path string, data []byte, perm os.FileMode) error {- dir := filepath.Dir(path)- tmp, err := os.CreateTemp(dir, filepath.Base(path)+".tmp-*")- if err != nil {- return fmt.Errorf("failed to create temp file for %s: %w", path, err)- }- tmpName := tmp.Name()- cleanup := func() { _ = os.Remove(tmpName) }- if _, err := tmp.Write(data); err != nil {- _ = tmp.Close()- cleanup()- return fmt.Errorf("failed to write temp file %s: %w", tmpName, err)- }- if err := tmp.Chmod(perm); err != nil {- _ = tmp.Close()- cleanup()- return fmt.Errorf("failed to chmod temp file %s: %w", tmpName, err)- }- if err := tmp.Close(); err != nil {- cleanup()- return fmt.Errorf("failed to close temp file %s: %w", tmpName, err)- }- if err := os.Rename(tmpName, path); err != nil {- cleanup()- return fmt.Errorf("failed to rename %s to %s: %w", tmpName, path, err)- }- return nil-}-func fileExistsInternal(path string) bool {if strings.TrimSpace(path) == "" {return falsediff --git a/backend/pkg/libarcane/edge/tunnel.go b/backend/pkg/libarcane/edge/tunnel.goindex 5f073bb0c..a2b4f322f 100644--- a/backend/pkg/libarcane/edge/tunnel.go+++ b/backend/pkg/libarcane/edge/tunnel.go@@ -6,6 +6,7 @@ import ("errors""io""sync"+ "sync/atomic""time"tunnelpb "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/edge/proto/tunnel/v1"@@ -134,10 +135,9 @@ const defaultSendRequestTimeout = 5 * time.Minute// TunnelConn wraps a WebSocket connection with send/receive helpers.type TunnelConn struct {- conn *websocket.Conn- mu sync.Mutex- closed bool- closedMu sync.RWMutex+ conn *websocket.Conn+ mu sync.Mutex+ closed atomic.Bool}// NewTunnelConn creates a new WebSocket tunnel connection wrapper.@@ -150,12 +150,9 @@ func (t *TunnelConn) Send(msg *TunnelMessage) error {t.mu.Lock()defer t.mu.Unlock()- t.closedMu.RLock()- if t.closed {- t.closedMu.RUnlock()+ if t.closed.Load() {return websocket.ErrCloseSent}- t.closedMu.RUnlock()data, err := json.Marshal(msg)if err != nil {@@ -197,9 +194,7 @@ func (t *TunnelConn) IsExpectedReceiveError(err error) bool {// Close closes the WebSocket tunnel connection.func (t *TunnelConn) Close() error {- t.closedMu.Lock()- t.closed = true- t.closedMu.Unlock()+ t.closed.Store(true)t.mu.Lock()defer t.mu.Unlock()@@ -208,9 +203,7 @@ func (t *TunnelConn) Close() error {// IsClosed returns whether the connection is closed.func (t *TunnelConn) IsClosed() bool {- t.closedMu.RLock()- defer t.closedMu.RUnlock()- return t.closed+ return t.closed.Load()}// SendRequest sends a request and waits for response.@@ -233,11 +226,10 @@ type grpcAgentStream interface {// GRPCManagerTunnelConn wraps the manager-side gRPC tunnel stream.type GRPCManagerTunnelConn struct {- stream grpcManagerStream- cancel context.CancelFunc- mu sync.Mutex- closed bool- closedMu sync.RWMutex+ stream grpcManagerStream+ cancel context.CancelFunc+ mu sync.Mutex+ closed atomic.Bool}// NewGRPCManagerTunnelConn creates a manager-side gRPC tunnel wrapper.@@ -310,9 +302,7 @@ func (t *GRPCManagerTunnelConn) Close() error {// IsClosed returns whether the stream is closed.func (t *GRPCManagerTunnelConn) IsClosed() bool {- t.closedMu.RLock()- defer t.closedMu.RUnlock()- return t.closed+ return t.closed.Load()}// SendRequest sends a request and waits for response.@@ -321,18 +311,15 @@ func (t *GRPCManagerTunnelConn) SendRequest(ctx context.Context, msg *TunnelMess}func (t *GRPCManagerTunnelConn) markClosed() {- t.closedMu.Lock()- t.closed = true- t.closedMu.Unlock()+ t.closed.Store(true)}// GRPCAgentTunnelConn wraps the agent-side gRPC tunnel stream.type GRPCAgentTunnelConn struct {- stream grpcAgentStream- cancel context.CancelFunc- mu sync.Mutex- closed bool- closedMu sync.RWMutex+ stream grpcAgentStream+ cancel context.CancelFunc+ mu sync.Mutex+ closed atomic.Bool}// NewGRPCAgentTunnelConn creates an agent-side gRPC tunnel wrapper.@@ -402,9 +389,7 @@ func (t *GRPCAgentTunnelConn) Close() error {// IsClosed returns whether the stream is closed.func (t *GRPCAgentTunnelConn) IsClosed() bool {- t.closedMu.RLock()- defer t.closedMu.RUnlock()- return t.closed+ return t.closed.Load()}// SendRequest sends a request and waits for response.@@ -413,9 +398,7 @@ func (t *GRPCAgentTunnelConn) SendRequest(ctx context.Context, msg *TunnelMessag}func (t *GRPCAgentTunnelConn) markClosed() {- t.closedMu.Lock()- t.closed = true- t.closedMu.Unlock()+ t.closed.Store(true)}func sendRequestWithPending(ctx context.Context, conn interface {diff --git a/backend/pkg/projects/fs_writer.go b/backend/pkg/projects/fs_writer.goindex 9e2029765..7e21b4b24 100644--- a/backend/pkg/projects/fs_writer.go+++ b/backend/pkg/projects/fs_writer.go@@ -9,6 +9,7 @@ import ("strings"pkgutils "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"+ "go.getarcane.app/sys/atomic")// DefaultComposeFileName is the compose filename Arcane writes when a project@@ -73,7 +74,7 @@ func WriteComposeFile(projectsRoot, dirPath, content string) error {composePath = filepath.Join(dirPath, DefaultComposeFileName)}- if err := os.WriteFile(composePath, []byte(content), pkgutils.FilePerm); err != nil {+ if err := atomic.WriteFile(composePath, []byte(content), pkgutils.FilePerm); err != nil {return fmt.Errorf("failed to write compose file: %w", err)}@@ -108,7 +109,7 @@ func WriteProjectFile(projectsRoot, dirPath, fileName, content string) error {}targetPath := filepath.Join(dirPath, fileName)- if err := os.WriteFile(targetPath, []byte(content), pkgutils.FilePerm); err != nil {+ if err := atomic.WriteFile(targetPath, []byte(content), pkgutils.FilePerm); err != nil {return fmt.Errorf("failed to write project file %s: %w", fileName, err)}@@ -193,7 +194,7 @@ func WriteTemplateFile(filePath, content string) error {return fmt.Errorf("failed to create template directory: %w", err)}- if err := os.WriteFile(filePath, []byte(content), pkgutils.FilePerm); err != nil {+ if err := atomic.WriteFile(filePath, []byte(content), pkgutils.FilePerm); err != nil {return fmt.Errorf("failed to write template file: %w", err)}@@ -207,7 +208,7 @@ func WriteFileWithPerm(filePath, content string, perm os.FileMode) error {return fmt.Errorf("failed to create directory: %w", err)}- if err := os.WriteFile(filePath, []byte(content), perm); err != nil {+ if err := atomic.WriteFile(filePath, []byte(content), perm); err != nil {return fmt.Errorf("failed to write file: %w", err)}@@ -281,14 +282,9 @@ func WriteSyncedDirectory(projectsRoot, projectPath string, files []SyncFile) ([if file.Executable {perm = 0o755}- if err := os.WriteFile(targetPathClean, file.Content, perm); err != nil {+ if err := atomic.WriteFile(targetPathClean, file.Content, perm); err != nil {return nil, fmt.Errorf("failed to write file %s: %w", file.RelativePath, err)}- // os.WriteFile only honors the mode on file creation. Re-chmod so an- // update path also lifts/lowers the +x bit to match the repo.- if err := os.Chmod(targetPathClean, perm); err != nil {- return nil, fmt.Errorf("failed to set mode on %s: %w", file.RelativePath, err)- }writtenPaths = append(writtenPaths, file.RelativePath)}diff --git a/backend/pkg/projects/fs_writer_test.go b/backend/pkg/projects/fs_writer_test.goindex af5895309..da8f5d85d 100644--- a/backend/pkg/projects/fs_writer_test.go+++ b/backend/pkg/projects/fs_writer_test.go@@ -190,6 +190,34 @@ func TestWriteSyncedDirectory_DowngradesExecutableBit(t *testing.T) {assert.Equal(t, os.FileMode(0), second.Mode().Perm()&0o111, "executable bit should clear on update when repo no longer marks +x")}+func TestWriteSyncedDirectory_UpgradesExecutableBitOnUpdate(t *testing.T) {+ if runtime.GOOS == "windows" {+ t.Skip("file mode bits are not represented on Windows FS")+ }++ root := t.TempDir()+ project := filepath.Join(root, "myproject")++ // First write: file committed without +x.+ _, err := WriteSyncedDirectory(root, project, []SyncFile{+ {RelativePath: "scripts/hook.sh", Content: []byte("#!/bin/sh\n"), Executable: false},+ })+ require.NoError(t, err)+ first, err := os.Stat(filepath.Join(project, "scripts/hook.sh"))+ require.NoError(t, err)+ require.Equal(t, os.FileMode(0), first.Mode().Perm()&0o111)++ // Second write: same file, now with +x (e.g. the repo added the bit).+ // The write path must apply the new mode on an update, not just on create.+ _, err = WriteSyncedDirectory(root, project, []SyncFile{+ {RelativePath: "scripts/hook.sh", Content: []byte("#!/bin/sh\necho updated\n"), Executable: true},+ })+ require.NoError(t, err)+ second, err := os.Stat(filepath.Join(project, "scripts/hook.sh"))+ require.NoError(t, err)+ assert.NotEqual(t, os.FileMode(0), second.Mode().Perm()&0o111, "executable bit should set on update when repo marks +x")+}+func TestWriteComposeFile_PreservesExistingCustomComposeNames(t *testing.T) {t.Parallel()diff --git a/cli/go.mod b/cli/go.modindex 4ff728505..195d65a12 100644--- a/cli/go.mod+++ b/cli/go.mod@@ -17,6 +17,7 @@ require (github.com/spf13/pflag v1.0.10github.com/spf13/viper v1.21.0github.com/stretchr/testify v1.11.1+ go.getarcane.app/sys/atomic v0.1.0go.withmatt.com/size v0.0.0-20250220224316-11aee5773e67)diff --git a/cli/go.sum b/cli/go.sumindex 4c0490963..46eed8dc2 100644--- a/cli/go.sum+++ b/cli/go.sum@@ -148,6 +148,8 @@ github.com/xhit/go-str2duration/v2 v2.1.0 h1:lxklc02Drh6ynqX+DdPyp5pCKLUQpRT8bp8github.com/xhit/go-str2duration/v2 v2.1.0/go.mod h1:ohY8p+0f07DiV6Em5LKB0s2YpLtXVyJfNt1+BlmyAsU=github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=+go.getarcane.app/sys/atomic v0.1.0 h1:0HhUeGXYdKAmMW24O+OaqcjDZx6twAuYPBu9T91zKsk=+go.getarcane.app/sys/atomic v0.1.0/go.mod h1:QPb5eUXYKYG5acp9jJBAZ/PTbHbByDAQG6eDNAsZZ2w=go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.69.0 h1:8tvICD4vSTOOsNrsI4Ljf6C+6UKvpTEH5XY3JMoyPoo=diff --git a/cli/pkg/generate/certs.go b/cli/pkg/generate/certs.goindex 79afd820a..67a328653 100644--- a/cli/pkg/generate/certs.go+++ b/cli/pkg/generate/certs.go@@ -18,6 +18,7 @@ import ("time""github.com/spf13/cobra"+ "go.getarcane.app/sys/atomic")const (@@ -378,49 +379,5 @@ func writePEMFileInternal(path, blockType string, bytes []byte, perm os.FileModeif pemBytes == nil {return fmt.Errorf("failed to encode PEM file %s", path)}- return writeFileAtomicInternal(path, pemBytes, perm)-}--func writeFileAtomicInternal(path string, data []byte, perm os.FileMode) error {- dir := filepath.Dir(path)- tmp, err := os.CreateTemp(dir, filepath.Base(path)+".tmp-*")- if err != nil {- return fmt.Errorf("failed to create temp file for %s: %w", path, err)- }- tmpName := tmp.Name()- cleanup := func() { _ = os.Remove(tmpName) }-- if _, err := tmp.Write(data); err != nil {- _ = tmp.Close()- cleanup()- return fmt.Errorf("failed to write temp file %s: %w", tmpName, err)- }- if err := tmp.Chmod(perm); err != nil {- _ = tmp.Close()- cleanup()- return fmt.Errorf("failed to chmod temp file %s: %w", tmpName, err)- }- if err := tmp.Sync(); err != nil {- _ = tmp.Close()- cleanup()- return fmt.Errorf("failed to sync temp file %s: %w", tmpName, err)- }- if err := tmp.Close(); err != nil {- cleanup()- return fmt.Errorf("failed to close temp file %s: %w", tmpName, err)- }- if err := os.Rename(tmpName, path); err != nil {- cleanup()- return fmt.Errorf("failed to rename %s to %s: %w", tmpName, path, err)- }-- dirFile, err := os.Open(dir)- if err != nil {- return fmt.Errorf("failed to open directory %s for sync: %w", dir, err)- }- defer func() { _ = dirFile.Close() }()- if err := dirFile.Sync(); err != nil {- return fmt.Errorf("failed to sync directory %s: %w", dir, err)- }- return nil+ return atomic.WriteFile(path, pemBytes, perm)}diff --git a/go.work.sum b/go.work.sumindex 13180ab4a..96a7baffa 100644--- a/go.work.sum+++ b/go.work.sum@@ -2076,6 +2076,8 @@ go.etcd.io/gofail v0.2.0 h1:p19drv16FKK345a09a1iubchlw/vmRuksmRzgBIGjcA=go.etcd.io/gofail v0.2.0/go.mod h1:nL3ILMGfkXTekKI3clMBNazKnjUZjYLKmBHzsVAnC1o=go.etcd.io/raft/v3 v3.6.0 h1:5NtvbDVYpnfZWcIHgGRk9DyzkBIXOi8j+DDp1IcnUWQ=go.etcd.io/raft/v3 v3.6.0/go.mod h1:nLvLevg6+xrVtHUmVaTcTz603gQPHfh7kUAwV6YpfGo=+go.getarcane.app/sys/atomic v0.1.0 h1:0HhUeGXYdKAmMW24O+OaqcjDZx6twAuYPBu9T91zKsk=+go.getarcane.app/sys/atomic v0.1.0/go.mod h1:QPb5eUXYKYG5acp9jJBAZ/PTbHbByDAQG6eDNAsZZ2w=go.getarcane.app/updater v0.3.6 h1:+BqoycaRsHj+cLVSzcYQuqbHxUKbtmaozMNblz5bVSw=go.getarcane.app/updater v0.3.6/go.mod h1:2ENitZR/lA5MuBn60OZYR5wvU3ZCE+pAgfrebfOlRDA=go.getarcane.app/updater v0.3.7 h1:WqHsxudvt8gvCR7iSHdxdzwH0+hM0FAh64bSypBX9Mo=