feat: add opt-in auto-unlock feature to remove locks on forget and pr…

…une (#107)
garethgeorge · Feb 19, 2024 · c1ee33f · c1ee33f
1 parent 40e3e04
commit c1ee33f
Show file tree

Hide file tree

Showing 9 changed files with 215 additions and 149 deletions.
diff --git a/gen/go/v1/config.pb.go b/gen/go/v1/config.pb.go
diff --git a/gen/go/v1/restic.pb.go b/gen/go/v1/restic.pb.go
diff --git a/internal/orchestrator/repo.go b/internal/orchestrator/repo.go
@@ -195,6 +195,20 @@ func (r *RepoOrchestrator) Restore(ctx context.Context, snapshotId string, path
 	return protoutil.RestoreProgressEntryToProto(summary), nil
 }
 
+// UnlockIfAutoEnabled unlocks the repo if the auto unlock feature is enabled.
+func (r *RepoOrchestrator) UnlockIfAutoEnabled(ctx context.Context) error {
+	if !r.repoConfig.AutoUnlock {
+		return nil
+	}
+
+	r.mu.Lock()
+	defer r.mu.Unlock()
+
+	zap.L().Debug("AutoUnlocking repo", zap.String("repo", r.repoConfig.Id))
+
+	return r.repo.Unlock(ctx)
+}
+
 func (r *RepoOrchestrator) Unlock(ctx context.Context) error {
 	r.mu.Lock()
 	defer r.mu.Unlock()

diff --git a/internal/orchestrator/taskforget.go b/internal/orchestrator/taskforget.go
@@ -70,6 +70,11 @@ func (t *ForgetTask) Run(ctx context.Context) error {
 			return fmt.Errorf("get repo %q: %w", t.plan.Repo, err)
 		}
 
+		err = repo.UnlockIfAutoEnabled(ctx)
+		if err != nil {
+			return fmt.Errorf("auto unlock repo %q: %w", t.plan.Repo, err)
+		}
+
 		forgot, err := repo.Forget(ctx, t.plan)
 		if err != nil {
 			return fmt.Errorf("forget: %w", err)

diff --git a/internal/orchestrator/taskprune.go b/internal/orchestrator/taskprune.go
@@ -107,6 +107,11 @@ func (t *PruneTask) Run(ctx context.Context) error {
 			return fmt.Errorf("get repo %v: %w", t.plan.Repo, err)
 		}
 
+		err = repo.UnlockIfAutoEnabled(ctx)
+		if err != nil {
+			return fmt.Errorf("auto unlock repo %q: %w", t.plan.Repo, err)
+		}
+
 		opPrune := &v1.Operation_OperationPrune{
 			OperationPrune: &v1.OperationPrune{},
 		}

diff --git a/proto/v1/config.proto b/proto/v1/config.proto
@@ -25,6 +25,7 @@ message Repo {
   repeated string flags = 5 [json_name="flags"]; // extra flags set on the restic command.
   PrunePolicy prune_policy = 6 [json_name="prunePolicy"]; // policy for when to run prune.
   repeated Hook hooks = 7 [json_name="hooks"]; // hooks to run on events for this repo.
+  bool auto_unlock = 8 [json_name="autoUnlock"]; // automatically unlock the repo when needed.
 }
 
 message Plan {

diff --git a/webui/gen/ts/v1/config_pb.ts b/webui/gen/ts/v1/config_pb.ts
@@ -126,6 +126,13 @@ export class Repo extends Message<Repo> {
    */
   hooks: Hook[] = [];
 
+  /**
+   * automatically unlock the repo when needed.
+   *
+   * @generated from field: bool auto_unlock = 8;
+   */
+  autoUnlock = false;
+
   constructor(data?: PartialMessage<Repo>) {
     super();
     proto3.util.initPartial(data, this);
@@ -141,6 +148,7 @@ export class Repo extends Message<Repo> {
     { no: 5, name: "flags", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
     { no: 6, name: "prune_policy", kind: "message", T: PrunePolicy },
     { no: 7, name: "hooks", kind: "message", T: Hook, repeated: true },
+    { no: 8, name: "auto_unlock", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Repo {

diff --git a/webui/gen/ts/v1/restic_pb.ts b/webui/gen/ts/v1/restic_pb.ts
@@ -384,6 +384,11 @@ export class BackupProgressError extends Message<BackupProgressError> {
    */
   during = "";
 
+  /**
+   * @generated from field: string message = 3;
+   */
+  message = "";
+
   constructor(data?: PartialMessage<BackupProgressError>) {
     super();
     proto3.util.initPartial(data, this);
@@ -394,6 +399,7 @@ export class BackupProgressError extends Message<BackupProgressError> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "item", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "during", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BackupProgressError {

diff --git a/webui/src/views/AddRepoModal.tsx b/webui/src/views/AddRepoModal.tsx
@@ -12,6 +12,7 @@ import {
   InputNumber,
   FormInstance,
   Collapse,
+  Checkbox,
 } from "antd";
 import React, { useEffect, useState } from "react";
 import { useShowModal } from "../components/ModalManager";
@@ -421,6 +422,13 @@ export const AddRepoModal = ({
             </Form.Item>
           </Form.Item>
 
+          <Form.Item label={<Tooltip title={"Auto-unlock will remove lockfiles at the start of forget and prune operations. "
+            + "This is potentially unsafe if the repo is shared by multiple client devices. Opt-in (and disabled) by default."}>
+            Auto Unlock
+          </Tooltip>} name="autoUnlock" valuePropName="checked">
+            <Checkbox />
+          </Form.Item>
+
           <Form.Item
             label={<Tooltip title={hooksListTooltipText}>Hooks</Tooltip>}
           >
@@ -446,7 +454,7 @@ export const AddRepoModal = ({
             )}
           </Form.Item>
         </Form>
-      </Modal>
+      </Modal >
     </>
   );
 };
@@ -547,7 +555,7 @@ const checkSchemeEnvVars = (scheme: string, envVarNames: string[]): Promise<void
 const formatMissingEnvVars = (partialMatches: string[][]): string => {
   return partialMatches.map(x => {
     if (x.length > 1) {
-      return `[ ${ x.join(", ") } ]`;
+      return `[ ${x.join(", ")} ]`;
     }
     return x[0];
   }).join(" or ");