@datatruck/restic 0.0.3 → 0.0.5

package/lib/actions/backup.d.ts

@@ -5,16 +5,11 @@ export type BackupOptions = {
     prune?: boolean;
 };
 export type CommonResticBackupTags = {
+    dt: boolean;
     id: string;
-    shortId: string;
-    hostname: string;
-    date: string;
-    vendor: string;
-    version: string;
 };
 export type ResticBackupTags = CommonResticBackupTags & {
-    package: string;
-    tags?: string[];
+    pkg: string;
 };
 export declare class Backup extends Action {
     protected runSingle(repoName: string, pkgName: string, tags: CommonResticBackupTags): Promise<{

package/lib/actions/backup.js

@@ -1,17 +1,15 @@
 import { createRunner, safeRun } from "../utils/async.js";
 import { checkDiskSpace, fetchMultipleDiskStats } from "../utils/fs.js";
 import { MySQLDump } from "../utils/mysql.js";
+import { randomString } from "../utils/string.js";
+import { stringifyTags } from "../utils/tags.js";
 import { Action } from "./base.js";
 import { Prune } from "./prune.js";
-import { SnapshotTagEnum } from "@datatruck/cli/repositories/RepositoryAbstract.js";
-import { ResticRepository } from "@datatruck/cli/repositories/ResticRepository.js";
 import { formatBytes } from "@datatruck/cli/utils/bytes.js";
 import { isLocalDir } from "@datatruck/cli/utils/fs.js";
 import { progressPercent } from "@datatruck/cli/utils/math.js";
 import { Restic } from "@datatruck/cli/utils/restic.js";
 import { match } from "@datatruck/cli/utils/string.js";
-import { randomUUID } from "crypto";
-import { hostname } from "os";
 export class Backup extends Action {
     async runSingle(repoName, pkgName, tags) {
         const repo = this.cm.findRepository(repoName);
@@ -34,14 +32,19 @@ export class Backup extends Action {
                 minFreeSpace: this.config.minFreeSpace,
                 minFreeSpacePath: targetPath ?? process.cwd(),
                 targetPath,
-                rutine: () => {
-                    const pkgTags = {
-                        ...tags,
-                        package: pkg.name,
-                        tags: [],
-                    };
-                    return restic.backup({
-                        tags: ResticRepository.createSnapshotTags(pkgTags),
+                rutine: async () => {
+                    const last = await restic.snapshots({
+                        latest: 1,
+                        host: this.config.hostname,
+                        tags: stringifyTags({ pkg: pkg.name }),
+                    });
+                    return await restic.backup({
+                        parent: last.at(0)?.id,
+                        host: this.config.hostname,
+                        tags: stringifyTags({
+                            ...tags,
+                            pkg: pkg.name,
+                        }),
                         paths: [pkg.path],
                         exclude: pkg.exclude,
                         onStream(data) {
@@ -55,9 +58,7 @@ export class Backup extends Action {
             });
             const snapshots = await restic.snapshots({
                 json: true,
-                tags: [
-                    ResticRepository.createSnapshotTag(SnapshotTagEnum.PACKAGE, pkg.name),
-                ],
+                tags: stringifyTags({ pkg: pkg.name }),
             });
             snapshotsAmount = snapshots.length;
         }).start(async (data) => {
@@ -101,14 +102,8 @@ export class Backup extends Action {
                 .filter((repo) => isLocalDir(repo.uri))
                 .map((repo) => repo.uri);
             const tags = {
-                id: randomUUID().replaceAll("-", ""),
-                get shortId() {
-                    return this.id.slice(0, 8);
-                },
-                hostname: this.config.hostname ?? hostname(),
-                date: new Date().toISOString(),
-                vendor: "dtt-restic",
-                version: "1",
+                dt: true,
+                id: randomString(8),
             };
             for (const task of tasks ?? []) {
                 if (task.type === "mysql-dump") {
@@ -181,7 +176,7 @@ export class Backup extends Action {
                     !!diskStats.result?.length && { key: "Disk stats", value: "" },
                     ...(diskStats.result?.map((p) => ({
                         key: p.name,
-                        value: `${formatBytes(p.free)}/${formatBytes(p.total)} (${progressPercent(p.total, p.free)}%)`,
+                        value: `${formatBytes(p.free)}/${formatBytes(p.total)} (${progressPercent(p.total, p.total - p.free)}%)`,
                         level: 1,
                     })) || []),
                     !!sqlDumpProcesses.length && { key: "SQL Dumps", value: "" },

package/lib/actions/copy.d.ts

@@ -8,7 +8,6 @@ export type CopyOptions = {
 export declare class Copy extends Action {
     protected initializedRepos: Set<string>;
     private findSnapshots;
-    private findPackageTag;
     runSingle(options: {
         source: string;
         target: string;

package/lib/actions/copy.js

@@ -1,9 +1,8 @@
 import { createRunner } from "../utils/async.js";
 import { checkDiskSpace } from "../utils/fs.js";
+import { parseTags, stringifyTags } from "../utils/tags.js";
 import { Action } from "./base.js";
 import { Prune } from "./prune.js";
-import { SnapshotTagEnum } from "@datatruck/cli/repositories/RepositoryAbstract.js";
-import { ResticRepository } from "@datatruck/cli/repositories/ResticRepository.js";
 import { formatBytes } from "@datatruck/cli/utils/bytes.js";
 import { isLocalDir } from "@datatruck/cli/utils/fs.js";
 import { Restic } from "@datatruck/cli/utils/restic.js";
@@ -22,23 +21,16 @@ export class Copy extends Action {
             latest: 1,
             group: ["path"],
             tags: packages
-                ? packages.map((name) => ResticRepository.createSnapshotTag(SnapshotTagEnum.PACKAGE, name))
+                ? packages.flatMap((name) => stringifyTags({ pkg: name }))
                 : undefined,
         }));
         return snapshots.flatMap((s) => s.snapshots);
     }
-    findPackageTag(inTags) {
-        const tags = inTags
-            .map((t) => ResticRepository.parseSnapshotTag(t))
-            .filter((t) => !!t);
-        return tags.find((t) => t.name === SnapshotTagEnum.PACKAGE);
-    }
     async runSingle(options) {
         const { snapshot } = options;
         const targetRepo = this.cm.findRepository(options.target);
         const sourceRepo = this.cm.findRepository(options.source);
-        const pkgTag = this.findPackageTag(snapshot.tags);
-        const packageName = pkgTag?.value;
+        const packageName = parseTags(snapshot.tags).pkg;
         const targetPath = isLocalDir(targetRepo.uri) ? targetRepo.uri : undefined;
         const target = new Restic({
             log: this.verbose,

package/lib/actions/prune.js

@@ -1,8 +1,7 @@
 import { createRunner, safeRun } from "../utils/async.js";
 import { checkDiskSpace, fetchMultipleDiskStats } from "../utils/fs.js";
+import { parseTags, stringifyTags } from "../utils/tags.js";
 import { Action } from "./base.js";
-import { SnapshotTagEnum } from "@datatruck/cli/repositories/RepositoryAbstract.js";
-import { ResticRepository } from "@datatruck/cli/repositories/ResticRepository.js";
 import { formatBytes } from "@datatruck/cli/utils/bytes.js";
 import { isLocalDir } from "@datatruck/cli/utils/fs.js";
 import { progressPercent } from "@datatruck/cli/utils/math.js";
@@ -24,9 +23,7 @@ export class Prune extends Action {
                         json: true,
                         prune: true,
                         args: ["--group-by", ""],
-                        tag: [
-                            ResticRepository.createSnapshotTag(SnapshotTagEnum.PACKAGE, pkgName),
-                        ],
+                        tag: stringifyTags({ pkg: pkgName }),
                     });
                     stats = {
                         keep: results.at(0)?.keep?.length ?? 0,
@@ -61,10 +58,7 @@ export class Prune extends Action {
         if (!(await restic.checkRepository()))
             return [];
         const snapshots = await restic.snapshots({ json: true });
-        const packages = new Set(snapshots.map((s) => {
-            const tags = ResticRepository.parseSnapshotTags(s.tags ?? []);
-            return tags[SnapshotTagEnum.PACKAGE];
-        }));
+        const packages = new Set(snapshots.map((s) => parseTags(s.tags ?? []).pkg));
         return [...packages].filter((v) => typeof v === "string");
     }
     async run(options) {
@@ -113,7 +107,7 @@ export class Prune extends Action {
                     !!diskStats.result?.length && { key: "Disk stats", value: "" },
                     ...(diskStats.result?.map((p) => ({
                         key: p.name,
-                        value: `${formatBytes(p.free)}/${formatBytes(p.total)} (${progressPercent(p.total, p.free)}%)`,
+                        value: `${formatBytes(p.free)}/${formatBytes(p.total)} (${progressPercent(p.total, p.total - p.free)}%)`,
                         level: 1,
                     })) || []),
                 ],

package/lib/actions/run.d.ts

@@ -0,0 +1,8 @@
+import { Action } from "./base.js";
+export type RunOptions = {
+    repository: string;
+    args: string[];
+};
+export declare class Run extends Action {
+    run(options: RunOptions): Promise<void>;
+}

package/lib/actions/run.js

@@ -0,0 +1,16 @@
+import { Action } from "./base.js";
+import { logExec } from "@datatruck/cli/utils/cli.js";
+import { spawnSync } from "child_process";
+export class Run extends Action {
+    async run(options) {
+        const [restic] = this.cm.createRestic(options.repository, this.verbose);
+        if (this.verbose)
+            logExec("restic", options.args, restic.options.env);
+        const p = spawnSync("restic", options.args, {
+            stdio: "inherit",
+            env: { ...process.env, ...restic.options.env },
+        });
+        if (p.status)
+            process.exit(p.status);
+    }
+}

package/lib/bin.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/lib/bin.js

@@ -1,2 +1,3 @@
+#!/usr/bin/env node
 import { createBin } from "./create-bin.js";
 createBin().parse();

package/lib/create-bin.js

@@ -3,6 +3,7 @@ import { Copy } from "./actions/copy.js";
 import { Create } from "./actions/create.js";
 import { Init } from "./actions/init.js";
 import { Prune } from "./actions/prune.js";
+import { Run } from "./actions/run.js";
 import { parseConfigFile } from "./config.js";
 import { parseStringList } from "@datatruck/cli/utils/string.js";
 import { Command } from "commander";
@@ -32,6 +33,21 @@ export function createBin(inConfig) {
         const create = new Create();
         await create.run(options);
     });
+    program
+        .command("run")
+        .description("Run arbitrary restic command")
+        .option("-r, --repository <name>", "Repository name")
+        .argument("[args...]", "Restic arguments")
+        .allowUnknownOption()
+        .allowExcessArguments()
+        .action(async (args, options) => {
+        const { config, globalOptions } = await load();
+        if (!options.repository && config.repositories.length !== 1)
+            throw new Error("Repository name is required");
+        const repository = options.repository ?? config.repositories[0].name;
+        const run = new Run(config, globalOptions);
+        await run.run({ repository, args });
+    });
     program
         .command("init")
         .alias("i")
@@ -79,5 +95,23 @@ export function createBin(inConfig) {
         const prune = new Prune(config, globalOptions);
         await prune.run(options);
     });
+    const parse = program.parse.bind(program);
+    program.parse = function (args, options) {
+        if (!args)
+            args = process.argv;
+        const [node, script, command, ...rest] = args;
+        if (command === "run") {
+            const repositoryIndex = rest.findIndex((v) => v === "-r" || v === "--repository");
+            if (repositoryIndex !== -1) {
+                const repositoryName = rest[repositoryIndex + 1];
+                const others = rest.filter((_, i) => i !== repositoryIndex && i !== repositoryIndex + 1);
+                args = [node, script, command, "-r", repositoryName, "--", ...others];
+            }
+            else {
+                args = [node, script, command, "--", ...rest];
+            }
+        }
+        return parse(args, options);
+    };
     return program;
 }

package/lib/utils/string.d.ts

@@ -1 +1,2 @@
 export declare function unstyle(str: string): string;
+export declare function randomString(length: number): string;

package/lib/utils/string.js

@@ -1,3 +1,13 @@
+import { randomInt } from "crypto";
 export function unstyle(str) {
     return str.replace(/\x1B\[[0-9;]*m/g, "");
 }
+const charset = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+export function randomString(length) {
+    let string = "";
+    for (let i = 0; i < length; i++) {
+        const index = randomInt(0, charset.length);
+        string += charset[index];
+    }
+    return string;
+}

package/lib/utils/tags.d.ts

@@ -0,0 +1,3 @@
+export declare function stringifyTags(inTags: Record<string, any>): string[];
+export declare function parseTagPrefix(tag: string): string | undefined;
+export declare function parseTags(inTags: string[]): Record<string, any>;

package/lib/utils/tags.js

@@ -0,0 +1,37 @@
+const prefix = "dt";
+const prefixSep = "-";
+const valueSep = ":";
+const fullPrefix = `${prefix}${prefixSep}`;
+export function stringifyTags(inTags) {
+    const tags = [];
+    for (const [key, value] of Object.entries(inTags)) {
+        const tagName = key === prefix ? key : `${prefix}${prefixSep}${key}`;
+        tags.push(value === true ? tagName : `${tagName}${valueSep}${value}`);
+    }
+    return tags;
+}
+export function parseTagPrefix(tag) {
+    if (tag === prefix) {
+        return tag;
+    }
+    else if (tag.startsWith(fullPrefix)) {
+        return tag.slice(fullPrefix.length);
+    }
+}
+export function parseTags(inTags) {
+    const tags = {};
+    for (const tag of inTags) {
+        const str = parseTagPrefix(tag);
+        if (!str) {
+            continue;
+        }
+        else if (str.includes(valueSep)) {
+            const [tagName, tagValue] = str.split(valueSep);
+            tags[tagName] = tagValue ?? "";
+        }
+        else {
+            tags[str] = true;
+        }
+    }
+    return tags;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatruck/restic",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Tool for creating and managing backups",
   "homepage": "https://github.com/swordev/datatruck#readme",
   "bugs": {
@@ -34,7 +34,7 @@
     "ajv": "^8.17.1",
     "commander": "^14.0.2",
     "undici": "^7.18.2",
-    "@datatruck/cli": "0.41.6"
+    "@datatruck/cli": "0.41.7"
   },
   "engine": {
     "node": ">=20.0.0"