@datatruck/cli 0.38.2 → 0.39.0

package/config.schema.json

@@ -645,9 +645,6 @@
     "server": {
       "type": "object",
       "properties": {
-        "log": {
-          "type": "boolean"
-        },
         "repository": {
           "type": "object",
           "properties": {
@@ -757,14 +754,46 @@
           "type": "object",
           "properties": {
             "enabled": {
+              "default": true,
               "type": "boolean"
             },
-            "logPath": {
-              "default": "'/var/logs/datatruck'",
-              "type": [
-                "string",
-                "boolean"
-              ]
+            "log": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "default": true,
+                  "type": "boolean"
+                },
+                "path": {
+                  "default": "/var/logs/datatruck",
+                  "type": "string"
+                },
+                "rotate": {
+                  "type": "object",
+                  "properties": {
+                    "maxAge": {
+                      "default": {
+                        "days": 14
+                      },
+                      "type": "object",
+                      "properties": {
+                        "days": {
+                          "type": "number"
+                        },
+                        "hours": {
+                          "type": "number"
+                        },
+                        "minutes": {
+                          "type": "number"
+                        }
+                      },
+                      "additionalProperties": false
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              },
+              "additionalProperties": false
             }
           },
           "additionalProperties": false

package/lib/commands/RunCommand.js

@@ -23,7 +23,6 @@ class RunCommand extends CommandAbstract_1.CommandAbstract {
     async exec() {
         const config = await ConfigAction_1.ConfigAction.fromGlobalOptionsWithPath(this.globalOptions);
         const verbose = !!this.globalOptions.verbose;
-        const log = config.data.server?.log ?? true;
         const jobs = config.data.jobs || {};
         const jobName = this.options.jobName;
         const job = jobName ? jobs[jobName] : undefined;
@@ -33,10 +32,9 @@ class RunCommand extends CommandAbstract_1.CommandAbstract {
             return { exitCode: 1 };
         }
         await (0, job_1.runJob)(job, jobName, {
-            log,
             verbose: verbose,
             configPath: config.path,
-            logPath: config.data.server?.cron?.logPath,
+            log: "inherit",
         });
         return { exitCode: 0 };
     }

package/lib/commands/StartServerCommand.js

@@ -23,12 +23,10 @@ class StartServerCommand extends CommandAbstract_1.CommandAbstract {
         const config = await ConfigAction_1.ConfigAction.fromGlobalOptions(this.globalOptions);
         const configPath = this.configPath;
         const verbose = !!this.globalOptions.verbose;
-        const log = config.server?.log ?? true;
         const repositoryOptions = config.server?.repository || {};
         if (repositoryOptions.enabled ?? true) {
             const server = (0, repository_server_1.createDatatruckRepositoryServer)(repositoryOptions, {
                 configPath,
-                log,
             });
             const port = repositoryOptions.listen?.port ?? 8888;
             const address = repositoryOptions.listen?.address ?? "127.0.0.1";
@@ -40,18 +38,15 @@ class StartServerCommand extends CommandAbstract_1.CommandAbstract {
             server.listen(port, address);
         }
         const cronOptions = config.server?.cron || {};
-        const logPath = config.server?.cron?.logPath;
         if (cronOptions.enabled ?? true) {
             if (typeof configPath !== "string")
                 throw new error_1.AppError(`Config path is required by cron server`);
             const server = await (0, cron_server_1.createCronServer)({
                 configPath,
                 verbose,
-                log,
-                logPath,
+                log: config.server?.cron?.log,
             });
             server.start();
-            (0, cli_1.logJson)("cron-server", `server started`);
         }
         const exitCode = await new Promise((resolve) => {
             process.on("SIGINT", () => resolve(1)).on("SIGTERM", () => resolve(1));

package/lib/utils/datatruck/config-type.d.ts

@@ -23,7 +23,6 @@ export type Config = {
     prunePolicy?: DatatruckPolicyConfig;
 };
 export type DatatruckServerOptions = {
-    log?: boolean;
     repository?: DatatruckRepositoryServerOptions;
     cron?: DatatruckCronServerOptions;
 };

package/lib/utils/datatruck/cron-server.d.ts

@@ -1,11 +1,26 @@
+import { MaxAge } from "../logs";
 import { JobConfig } from "./job";
-export declare const defaultsLogPath: string;
 export type DatatruckCronServerOptions = {
-    enabled?: boolean;
     /**
-     * @default '/var/logs/datatruck'
+     * @default true
      */
-    logPath?: string | boolean;
+    enabled?: boolean;
+    log?: {
+        /**
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * @default "/var/logs/datatruck"
+         */
+        path?: string;
+        rotate?: {
+            /**
+             * @default {"days":14}
+             */
+            maxAge?: MaxAge;
+        };
+    };
 };
 export declare function createCronServer(options: JobConfig): Promise<{
     start: () => void;

package/lib/utils/datatruck/cron-server.js

@@ -1,18 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCronServer = exports.defaultsLogPath = void 0;
+exports.createCronServer = void 0;
 const ConfigAction_1 = require("../../actions/ConfigAction");
 const cli_1 = require("../cli");
 const cron_1 = require("../cron");
+const logs_1 = require("../logs");
 const string_1 = require("../string");
 const watcher_1 = require("../watcher");
 const job_1 = require("./job");
 const croner_1 = require("croner");
-const os_1 = require("os");
-const path_1 = require("path");
-exports.defaultsLogPath = (0, os_1.platform)() === "win32"
-    ? (0, path_1.join)(process.env.APPDATA ?? `${process.env.HOMEDRIVE ?? "C:"}\\ProgramData`, "datatruck\\logs")
-    : "/var/logs/datatruck";
 function createCrons(jobs, options) {
     const crons = [];
     for (const name in jobs) {
@@ -34,31 +30,55 @@ async function createCronServer(options) {
         config: options.configPath,
     });
     let crons = createCrons(config.jobs || {}, options);
+    let log = config.server?.cron?.log;
+    const getLogPath = () => log?.path ?? logs_1.defaultsLogPath;
+    let reloading = false;
     const watcher = (0, watcher_1.createWatcher)({
         onRead: () => ConfigAction_1.ConfigAction.findAndParseFile(options.configPath),
         onCheck: (prev, current) => (0, string_1.compareJsons)(prev, current),
         onError: (error) => {
-            if (options.log) {
-                (0, cli_1.logJson)("cron-server", "job update error");
-                console.error(error);
-            }
+            (0, cli_1.logJson)("cron-server", "job update error");
+            console.error(error);
         },
         onChange: (data) => {
-            if (options.log)
-                (0, cli_1.logJson)("cron-server", "jobs updated");
-            handler.stop();
-            const enabled = data?.server?.cron?.enabled ?? true;
-            crons = enabled ? createCrons(data?.jobs || {}, options) : [];
-            handler.start();
+            (0, cli_1.logJson)("cron-server", "jobs updated");
+            try {
+                reloading = true;
+                handler.stop();
+                const enabled = data?.server?.cron?.enabled ?? true;
+                crons = enabled ? createCrons(data?.jobs || {}, options) : [];
+                log = data?.server?.cron?.log;
+                handler.start();
+            }
+            finally {
+                reloading = false;
+            }
         },
     });
+    let rotateLogsInterval;
+    const rotateLogs = async () => {
+        const removed = await (0, logs_1.removeOldLogs)(getLogPath(), log?.rotate?.maxAge ?? { days: 14 });
+        if (removed.length)
+            (0, cli_1.logJson)("cron-server", "old logs removed", {
+                amount: removed.length,
+            });
+    };
     const handler = {
         start: () => {
+            if (!reloading) {
+                (0, cli_1.logJson)("cron-server", `server started`, {
+                    "log.path": getLogPath(),
+                });
+                clearInterval(rotateLogsInterval);
+                rotateLogsInterval = setInterval(rotateLogs, 60_000);
+            }
             for (const cron of crons)
                 cron.resume();
             watcher.start();
         },
         stop: () => {
+            if (!reloading)
+                clearInterval(rotateLogsInterval);
             watcher.stop();
             for (const cron of crons)
                 cron.stop();

package/lib/utils/datatruck/job.d.ts

@@ -1,6 +1,7 @@
 import { BackupCommandOptions } from "../../commands/BackupCommand";
 import { CopyCommandOptions } from "../../commands/CopyCommand";
 import { PruneCommandOptions } from "../../commands/PruneCommand";
+import { DatatruckCronServerOptions } from "./cron-server";
 export type JobScheduleObject = {
     minute?: number | {
         each: number;
@@ -33,8 +34,7 @@ export type Job = JobAction & {
     schedule?: JobSchedule;
 };
 export type JobConfig = {
-    log: boolean;
-    logPath: string | boolean | undefined;
+    log: DatatruckCronServerOptions["log"] | "inherit";
     verbose: boolean;
     configPath: string;
 };

package/lib/utils/datatruck/job.js

@@ -4,12 +4,31 @@ exports.runJob = void 0;
 const async_process_1 = require("../async-process");
 const cli_1 = require("../cli");
 const fs_1 = require("../fs");
+const logs_1 = require("../logs");
 const options_1 = require("../options");
 const command_1 = require("./command");
-const cron_server_1 = require("./cron-server");
 const fs_2 = require("fs");
 const promises_1 = require("fs/promises");
 const path_1 = require("path");
+async function createJobLog(config, name) {
+    if (typeof config === "object" && (config?.enabled ?? true)) {
+        const dt = new Date().toISOString().replaceAll(":", "-");
+        const dir = config?.path ?? logs_1.defaultsLogPath;
+        const tmpLogPath = (0, path_1.join)(dir, `${dt}_${name}.tmp.log`);
+        await (0, promises_1.mkdir)(dir, { recursive: true });
+        return {
+            type: "file",
+            dt,
+            dir,
+            stream: (0, fs_2.createWriteStream)(tmpLogPath),
+        };
+    }
+    else if (config === "inherit") {
+        return {
+            type: "inherit",
+        };
+    }
+}
 async function runJob(job, name, config) {
     let pid = 0;
     try {
@@ -19,14 +38,6 @@ async function runJob(job, name, config) {
             ? ({ ...job.options, confirm: true })
             : job.options);
         const [node, bin] = process.argv;
-        const baseLogPath = typeof config.logPath === "string"
-            ? config.logPath
-            : config.logPath === true || config.logPath === undefined
-                ? cron_server_1.defaultsLogPath
-                : config.logPath;
-        let stream;
-        let logPath;
-        const dt = new Date().toISOString().replaceAll(":", "-");
         const argv = [
             process.env.DTT_BIN_SCRIPT ?? process.env.pm_exec_path ?? bin,
             "--tty",
@@ -38,12 +49,9 @@ async function runJob(job, name, config) {
             job.action,
             ...cliOptions,
         ];
-        if (baseLogPath) {
-            const tmpLogPath = (0, path_1.join)(baseLogPath, dt) + ".log";
-            await (0, promises_1.mkdir)(baseLogPath, { recursive: true });
-            stream = (0, fs_2.createWriteStream)(tmpLogPath);
-            stream.write(`+ dtt ${argv.join(" ")}\n`);
-        }
+        const log = await createJobLog(config.log, name);
+        if (log?.type === "file")
+            log.stream.write(`+ dtt ${argv.join(" ")}\n`);
         const p = new async_process_1.AsyncProcess(node, argv, {
             $log: config.verbose,
             $exitCode: false,
@@ -53,29 +61,33 @@ async function runJob(job, name, config) {
                 NO_COLOR: "1",
                 JOB_NAME: name,
             },
+            ...(log?.type === "inherit" && {
+                stdio: "inherit",
+            }),
         });
         pid = p.child.pid || 0;
-        if (config.log)
-            (0, cli_1.logJson)("job", `'${name}' started`, { pid });
+        (0, cli_1.logJson)("job", `'${name}' started`, { pid });
         const [exitCode] = await Promise.all([
             p.waitForClose(),
-            stream && p.stderr.pipe(stream),
-            stream && p.stdout.pipe(stream),
+            ...(log?.stream
+                ? [p.stderr.pipe(log?.stream), p.stdout.pipe(log?.stream)]
+                : []),
         ]);
-        if (stream) {
-            const base = (0, path_1.dirname)(stream.path.toString());
-            await (0, fs_1.safeRename)(stream.path.toString(), (logPath = (0, path_1.join)(base, `${dt}-${pid}.log`)));
+        let logData = {};
+        if (log?.stream) {
+            const base = (0, path_1.dirname)(log?.stream.path.toString());
+            const logPath = (0, path_1.join)(base, `${log.dt}_${name}_${pid}.log`);
+            await (0, fs_1.safeRename)(log?.stream.path.toString(), logPath);
+            logData["log"] = logPath;
         }
-        if (config.log)
-            (0, cli_1.logJson)("job", `'${name}' finished`, {
-                pid,
-                exitCode,
-                ...(logPath && { log: logPath }),
-            });
+        (0, cli_1.logJson)("job", `'${name}' finished`, {
+            pid,
+            exitCode,
+            ...logData,
+        });
     }
     catch (error) {
-        if (config.log)
-            (0, cli_1.logJson)("job", `'${name}' failed`, { pid });
+        (0, cli_1.logJson)("job", `'${name}' failed`, { pid });
         console.error(error);
     }
 }

package/lib/utils/datatruck/repository-server.d.ts

@@ -37,7 +37,6 @@ export declare const headerKey: {
     password: string;
 };
 export declare function createDatatruckRepositoryServer(inOptions: Omit<DatatruckRepositoryServerOptions, "listen">, config?: {
-    log?: boolean;
     configPath?: string;
 }): import("http").Server<typeof IncomingMessage, typeof import("http").ServerResponse>;
 export {};

package/lib/utils/datatruck/repository-server.js

@@ -80,8 +80,7 @@ function createDatatruckRepositoryServer(inOptions, config = {}) {
             const backend = findRepositoryBackend(req, repository, options);
             if (!backend)
                 return res.writeHead(401);
-            if (config.log)
-                (0, cli_1.logJson)("repository-server", "request", { id, repository, url });
+            (0, cli_1.logJson)("repository-server", "request", { id, repository, url });
             const fs = new virtual_fs_1.LocalFs({ backend: backend.path });
             if (action === "comcheck") {
                 res.write(JSON.stringify({ success: true }));
@@ -111,14 +110,11 @@ function createDatatruckRepositoryServer(inOptions, config = {}) {
                 if (json !== undefined)
                     res.write(JSON.stringify(json));
             }
-            if (config.log)
-                (0, cli_1.logJson)("repository-server", "request finished", { id });
+            (0, cli_1.logJson)("repository-server", "request finished", { id });
         }
         catch (error) {
-            if (config.log) {
-                (0, cli_1.logJson)("repository-server", "request failed", { id });
-                console.error(error);
-            }
+            (0, cli_1.logJson)("repository-server", "request failed", { id });
+            console.error(error);
             if (!res.writableEnded && !res.headersSent)
                 res.writeHead(500, error.message);
         }

package/lib/utils/logs.d.ts

@@ -0,0 +1,8 @@
+export type MaxAge = {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+};
+export declare function maxAgeToMS(input: MaxAge): number;
+export declare const defaultsLogPath: string;
+export declare function removeOldLogs(path: string, inMaxAge: MaxAge): Promise<string[]>;

package/lib/utils/logs.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeOldLogs = exports.defaultsLogPath = exports.maxAgeToMS = void 0;
+const promises_1 = require("fs/promises");
+const os_1 = require("os");
+const path_1 = require("path");
+const maxAgeUnits = {
+    minutes: () => 60 * 1000,
+    hours: () => 60 * maxAgeUnits.minutes(),
+    days: () => 24 * maxAgeUnits.hours(),
+};
+function maxAgeToMS(input) {
+    let ms = 0;
+    for (const key in input) {
+        const units = input[key];
+        if (units && units >= 0) {
+            const factor = maxAgeUnits[key]();
+            ms += units * factor;
+        }
+    }
+    return ms;
+}
+exports.maxAgeToMS = maxAgeToMS;
+exports.defaultsLogPath = (0, os_1.platform)() === "win32"
+    ? (0, path_1.join)(process.env.APPDATA ?? `${process.env.HOMEDRIVE ?? "C:"}\\ProgramData`, "datatruck\\logs")
+    : "/var/logs/datatruck";
+async function removeOldLogs(path, inMaxAge) {
+    const maxAge = maxAgeToMS(inMaxAge);
+    const hasMaxAge = Object.values(inMaxAge).some((v) => typeof v === "number");
+    if (!hasMaxAge)
+        return [];
+    const files = (await (0, promises_1.readdir)(path)).filter((file) => file.endsWith(".log"));
+    const now = Date.now();
+    const paths = [];
+    for (const file of files) {
+        const filePath = (0, path_1.join)(path, file);
+        const { mtimeMs } = await (0, promises_1.stat)((0, path_1.join)(path, file));
+        const ms = now - mtimeMs;
+        if (ms > maxAge) {
+            await (0, promises_1.rm)(filePath);
+            paths.push(filePath);
+        }
+    }
+    return paths;
+}
+exports.removeOldLogs = removeOldLogs;

package/lib/utils/mysql.d.ts

@@ -22,12 +22,12 @@ export declare function createMysqlCli(options: MysqlCliOptions): Promise<{
     dump: (input: {
         output: string;
         database: string;
-        items?: string[] | undefined;
-        onlyStoredPrograms?: boolean | undefined;
-        controller?: AbortController | undefined;
-        onProgress?: ((data: {
+        items?: string[];
+        onlyStoredPrograms?: boolean;
+        controller?: AbortController;
+        onProgress?: (data: {
             totalBytes: number;
-        }) => void) | undefined;
+        }) => void;
     }) => Promise<void>;
     assertDumpFile: typeof assertDumpFile;
     fetchTableNames: (database: string, include?: string[], exclude?: string[]) => Promise<string[]>;

package/lib/utils/options.js

@@ -68,9 +68,9 @@ exports.createCommand = createCommand;
 function stringifyOptions(options, object) {
     const result = [];
     const prepend = [];
-    for (const key in options) {
-        const option = options[key];
-        const value = object[key];
+    for (const name in options) {
+        const option = options[name];
+        const value = object[name];
         if (value === undefined)
             continue;
         if (option.flag === false) {
@@ -79,7 +79,7 @@ function stringifyOptions(options, object) {
         else {
             const flag = option.shortFlag
                 ? `-${option.shortFlag}`
-                : `--${option.flag ?? option.shortFlag}`;
+                : `--${option.flag ?? name}`;
             if (option.value === "boolean") {
                 if (option.value)
                     result.push(flag);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatruck/cli",
-  "version": "0.38.2",
+  "version": "0.39.0",
   "description": "Tool for creating and managing backups",
   "homepage": "https://github.com/swordev/datatruck#readme",
   "bugs": {
@@ -35,7 +35,7 @@
     "dayjs": "^1.11.10",
     "fast-folder-size": "^2.2.0",
     "fast-glob": "^3.3.2",
-    "listr2": "^8.0.2",
+    "listr2": "^8.2.1",
     "micromatch": "^4.0.5",
     "mysql2": "^3.9.3",
     "tty-table": "^4.2.3",