@regressionproof/snapshotter 0.6.5 → 0.7.0

package/build/esm/index.d.ts

@@ -1,2 +1,2 @@
-export { snapshot } from './snapshot.js';
+export { snapshot, checkForPreviousSnapshotFailure } from './snapshot.js';
 export * from './snapshotter.types.js';

package/build/esm/index.js

@@ -1,2 +1,2 @@
-export { snapshot } from './snapshot.js.js';
+export { snapshot, checkForPreviousSnapshotFailure } from './snapshot.js.js';
 export * from './snapshotter.types.js.js';

package/build/esm/scripts/runSnapshot.d.ts

@@ -0,0 +1 @@
+export {};

package/build/esm/scripts/runSnapshot.js

@@ -0,0 +1,125 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync, } from 'fs';
+import path from 'path';
+import { buildLog } from '@sprucelabs/spruce-skill-utils';
+import { gitCommit, gitPush } from '../git.js.js';
+import { syncFiles } from '../sync.js.js';
+const ERROR_FILE_NAME = 'lastError.json';
+const LOCK_FILE_NAME = 'snapshot.lock';
+const PENDING_FILE_NAME = 'pending.json';
+const log = buildLog('Snapshotter');
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const snapshotterDir = process.argv[2];
+        if (!snapshotterDir) {
+            console.error('Usage: runSnapshot <snapshotter-dir>');
+            process.exit(1);
+        }
+        const lockPath = path.join(snapshotterDir, LOCK_FILE_NAME);
+        if (existsSync(lockPath)) {
+            log.info('Another snapshot is running, exiting');
+            process.exit(0);
+        }
+        try {
+            writeFileSync(lockPath, process.pid.toString());
+            yield processLoop(snapshotterDir);
+        }
+        finally {
+            if (existsSync(lockPath)) {
+                unlinkSync(lockPath);
+            }
+        }
+    });
+}
+function processLoop(snapshotterDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const pendingPath = path.join(snapshotterDir, PENDING_FILE_NAME);
+        while (existsSync(pendingPath)) {
+            const options = JSON.parse(readFileSync(pendingPath, 'utf-8'));
+            unlinkSync(pendingPath);
+            yield executeSnapshot(options);
+        }
+    });
+}
+function executeSnapshot(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const sourcePath = (_a = options.sourcePath) !== null && _a !== void 0 ? _a : process.cwd();
+        const { mirrorPath, testResults, remote } = options;
+        log.info('Starting snapshot', sourcePath, mirrorPath);
+        try {
+            yield syncFiles(sourcePath, mirrorPath);
+            log.info('Files synced', mirrorPath);
+            const snapshotterDir = path.join(mirrorPath, '.snapshotter');
+            mkdirSync(snapshotterDir, { recursive: true });
+            writeFileSync(path.join(snapshotterDir, 'testResults.json'), JSON.stringify(sortTestResults(testResults), null, 2));
+            log.info('Test results saved', snapshotterDir);
+            const committed = yield gitCommit(mirrorPath, log);
+            if (!committed) {
+                log.info('No changes to commit', mirrorPath);
+                clearError(mirrorPath);
+                return;
+            }
+            log.info('Commit created, pushing', remote.url);
+            yield gitPush(mirrorPath, remote, log);
+            log.info('Push completed', remote.url);
+            clearError(mirrorPath);
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            log.error('Snapshot failed (will surface on next test run)', message);
+            persistError(mirrorPath, err);
+        }
+    });
+}
+function persistError(mirrorPath, err) {
+    const snapshotterDir = path.join(mirrorPath, '.snapshotter');
+    mkdirSync(snapshotterDir, { recursive: true });
+    const errorPath = getErrorFilePath(mirrorPath);
+    const errorData = {
+        message: err instanceof Error ? err.message : String(err),
+        stack: err instanceof Error ? err.stack : undefined,
+        timestamp: new Date().toISOString(),
+    };
+    writeFileSync(errorPath, JSON.stringify(errorData, null, 2));
+}
+function clearError(mirrorPath) {
+    const errorPath = getErrorFilePath(mirrorPath);
+    if (existsSync(errorPath)) {
+        unlinkSync(errorPath);
+    }
+}
+function getErrorFilePath(mirrorPath) {
+    return path.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
+}
+function sortTestResults(testResults) {
+    const suites = [...testResults.suites].map((suite) => (Object.assign(Object.assign({}, suite), { tests: [...suite.tests].sort((left, right) => left.name.localeCompare(right.name)) })));
+    suites.sort((left, right) => left.path.localeCompare(right.path));
+    const typeErrors = testResults.typeErrors
+        ? [...testResults.typeErrors].sort((left, right) => {
+            const fileCompare = left.file.localeCompare(right.file);
+            if (fileCompare !== 0) {
+                return fileCompare;
+            }
+            const lineCompare = left.line - right.line;
+            if (lineCompare !== 0) {
+                return lineCompare;
+            }
+            return left.column - right.column;
+        })
+        : undefined;
+    return Object.assign(Object.assign({}, testResults), { suites,
+        typeErrors });
+}
+main().catch((err) => {
+    console.error('Snapshot script failed:', err);
+    process.exit(1);
+});

package/build/esm/snapshot.d.ts

@@ -1,2 +1,3 @@
 import { SnapshotOptions } from './snapshotter.types.js';
-export declare function snapshot(options: SnapshotOptions): Promise<boolean>;
+export declare function snapshot(options: SnapshotOptions): void;
+export declare function checkForPreviousSnapshotFailure(mirrorPath: string): void;

package/build/esm/snapshot.js

@@ -1,73 +1,40 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { mkdirSync, writeFileSync } from 'fs';
+import { spawn } from 'child_process';
+import { existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync, } from 'fs';
 import path from 'path';
 import { buildLog } from '@sprucelabs/spruce-skill-utils';
-import { gitCommit, gitPush } from './git.js.js';
-import { syncFiles } from './sync.js.js';
-class Snapshotter {
-    constructor() {
-        this.log = buildLog('Snapshotter');
-    }
-    snapshot(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const sourcePath = (_a = options.sourcePath) !== null && _a !== void 0 ? _a : process.cwd();
-            const { mirrorPath, testResults, remote } = options;
-            this.log.info('Starting snapshot', sourcePath, mirrorPath);
-            try {
-                yield syncFiles(sourcePath, mirrorPath);
-                this.log.info('Files synced', mirrorPath);
-                const snapshotterDir = path.join(mirrorPath, '.snapshotter');
-                mkdirSync(snapshotterDir, { recursive: true });
-                writeFileSync(path.join(snapshotterDir, 'testResults.json'), JSON.stringify(sortTestResults(testResults), null, 2));
-                this.log.info('Test results saved', snapshotterDir);
-                const committed = yield gitCommit(mirrorPath, this.log);
-                if (!committed) {
-                    this.log.info('No changes to commit', mirrorPath);
-                    return false;
-                }
-                this.log.info('Commit created, pushing', remote.url);
-                yield gitPush(mirrorPath, remote, this.log);
-                this.log.info('Push completed', remote.url);
-                return true;
-            }
-            catch (err) {
-                const message = err instanceof Error ? err.message : String(err);
-                this.log.error('Snapshot failed', message);
-                throw err;
-            }
-        });
+const ERROR_FILE_NAME = 'lastError.json';
+const log = buildLog('Snapshotter');
+const scriptPath = path.join(__dirname, 'scripts', 'runSnapshot.js');
+export function snapshot(options) {
+    const snapshotterDir = writeOptionsFile(options);
+    spawnSnapshotProcess(snapshotterDir);
+    log.info('Snapshot queued (running in background)', options.mirrorPath);
+}
+export function checkForPreviousSnapshotFailure(mirrorPath) {
+    const errorPath = getErrorFilePath(mirrorPath);
+    if (existsSync(errorPath)) {
+        const errorData = JSON.parse(readFileSync(errorPath, 'utf-8'));
+        unlinkSync(errorPath);
+        throw new Error(`Previous snapshot failed: ${errorData.message}\n` +
+            `Timestamp: ${errorData.timestamp}\n` +
+            `This error was from a background snapshot that failed. ` +
+            `The snapshot has been retried - if this error persists, check your configuration.`);
     }
 }
-export function snapshot(options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Snapshotter().snapshot(options);
+function writeOptionsFile(options) {
+    const snapshotterDir = path.join(options.mirrorPath, '.snapshotter');
+    mkdirSync(snapshotterDir, { recursive: true });
+    const optionsPath = path.join(snapshotterDir, 'pending.json');
+    writeFileSync(optionsPath, JSON.stringify(options, null, 2));
+    return snapshotterDir;
+}
+function spawnSnapshotProcess(snapshotterDir) {
+    const child = spawn('node', [scriptPath, snapshotterDir], {
+        detached: true,
+        stdio: 'ignore',
     });
+    child.unref();
 }
-function sortTestResults(testResults) {
-    const suites = [...testResults.suites].map((suite) => (Object.assign(Object.assign({}, suite), { tests: [...suite.tests].sort((left, right) => left.name.localeCompare(right.name)) })));
-    suites.sort((left, right) => left.path.localeCompare(right.path));
-    const typeErrors = testResults.typeErrors
-        ? [...testResults.typeErrors].sort((left, right) => {
-            const fileCompare = left.file.localeCompare(right.file);
-            if (fileCompare !== 0) {
-                return fileCompare;
-            }
-            const lineCompare = left.line - right.line;
-            if (lineCompare !== 0) {
-                return lineCompare;
-            }
-            return left.column - right.column;
-        })
-        : undefined;
-    return Object.assign(Object.assign({}, testResults), { suites,
-        typeErrors });
+function getErrorFilePath(mirrorPath) {
+    return path.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
 }

package/build/index.d.ts

@@ -1,2 +1,2 @@
-export { snapshot } from './snapshot.js';
+export { snapshot, checkForPreviousSnapshotFailure } from './snapshot.js';
 export * from './snapshotter.types.js';

package/build/index.js

@@ -14,7 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snapshot = void 0;
+exports.checkForPreviousSnapshotFailure = exports.snapshot = void 0;
 var snapshot_js_1 = require("./snapshot.js");
 Object.defineProperty(exports, "snapshot", { enumerable: true, get: function () { return snapshot_js_1.snapshot; } });
+Object.defineProperty(exports, "checkForPreviousSnapshotFailure", { enumerable: true, get: function () { return snapshot_js_1.checkForPreviousSnapshotFailure; } });
 __exportStar(require("./snapshotter.types.js"), exports);

package/build/scripts/runSnapshot.d.ts

@@ -0,0 +1 @@
+export {};

package/build/scripts/runSnapshot.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const spruce_skill_utils_1 = require("@sprucelabs/spruce-skill-utils");
+const git_js_1 = require("../git.js");
+const sync_js_1 = require("../sync.js");
+const ERROR_FILE_NAME = 'lastError.json';
+const LOCK_FILE_NAME = 'snapshot.lock';
+const PENDING_FILE_NAME = 'pending.json';
+const log = (0, spruce_skill_utils_1.buildLog)('Snapshotter');
+async function main() {
+    const snapshotterDir = process.argv[2];
+    if (!snapshotterDir) {
+        console.error('Usage: runSnapshot <snapshotter-dir>');
+        process.exit(1);
+    }
+    const lockPath = path_1.default.join(snapshotterDir, LOCK_FILE_NAME);
+    if ((0, fs_1.existsSync)(lockPath)) {
+        log.info('Another snapshot is running, exiting');
+        process.exit(0);
+    }
+    try {
+        (0, fs_1.writeFileSync)(lockPath, process.pid.toString());
+        await processLoop(snapshotterDir);
+    }
+    finally {
+        if ((0, fs_1.existsSync)(lockPath)) {
+            (0, fs_1.unlinkSync)(lockPath);
+        }
+    }
+}
+async function processLoop(snapshotterDir) {
+    const pendingPath = path_1.default.join(snapshotterDir, PENDING_FILE_NAME);
+    while ((0, fs_1.existsSync)(pendingPath)) {
+        const options = JSON.parse((0, fs_1.readFileSync)(pendingPath, 'utf-8'));
+        (0, fs_1.unlinkSync)(pendingPath);
+        await executeSnapshot(options);
+    }
+}
+async function executeSnapshot(options) {
+    const sourcePath = options.sourcePath ?? process.cwd();
+    const { mirrorPath, testResults, remote } = options;
+    log.info('Starting snapshot', sourcePath, mirrorPath);
+    try {
+        await (0, sync_js_1.syncFiles)(sourcePath, mirrorPath);
+        log.info('Files synced', mirrorPath);
+        const snapshotterDir = path_1.default.join(mirrorPath, '.snapshotter');
+        (0, fs_1.mkdirSync)(snapshotterDir, { recursive: true });
+        (0, fs_1.writeFileSync)(path_1.default.join(snapshotterDir, 'testResults.json'), JSON.stringify(sortTestResults(testResults), null, 2));
+        log.info('Test results saved', snapshotterDir);
+        const committed = await (0, git_js_1.gitCommit)(mirrorPath, log);
+        if (!committed) {
+            log.info('No changes to commit', mirrorPath);
+            clearError(mirrorPath);
+            return;
+        }
+        log.info('Commit created, pushing', remote.url);
+        await (0, git_js_1.gitPush)(mirrorPath, remote, log);
+        log.info('Push completed', remote.url);
+        clearError(mirrorPath);
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        log.error('Snapshot failed (will surface on next test run)', message);
+        persistError(mirrorPath, err);
+    }
+}
+function persistError(mirrorPath, err) {
+    const snapshotterDir = path_1.default.join(mirrorPath, '.snapshotter');
+    (0, fs_1.mkdirSync)(snapshotterDir, { recursive: true });
+    const errorPath = getErrorFilePath(mirrorPath);
+    const errorData = {
+        message: err instanceof Error ? err.message : String(err),
+        stack: err instanceof Error ? err.stack : undefined,
+        timestamp: new Date().toISOString(),
+    };
+    (0, fs_1.writeFileSync)(errorPath, JSON.stringify(errorData, null, 2));
+}
+function clearError(mirrorPath) {
+    const errorPath = getErrorFilePath(mirrorPath);
+    if ((0, fs_1.existsSync)(errorPath)) {
+        (0, fs_1.unlinkSync)(errorPath);
+    }
+}
+function getErrorFilePath(mirrorPath) {
+    return path_1.default.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
+}
+function sortTestResults(testResults) {
+    const suites = [...testResults.suites].map((suite) => ({
+        ...suite,
+        tests: [...suite.tests].sort((left, right) => left.name.localeCompare(right.name)),
+    }));
+    suites.sort((left, right) => left.path.localeCompare(right.path));
+    const typeErrors = testResults.typeErrors
+        ? [...testResults.typeErrors].sort((left, right) => {
+            const fileCompare = left.file.localeCompare(right.file);
+            if (fileCompare !== 0) {
+                return fileCompare;
+            }
+            const lineCompare = left.line - right.line;
+            if (lineCompare !== 0) {
+                return lineCompare;
+            }
+            return left.column - right.column;
+        })
+        : undefined;
+    return {
+        ...testResults,
+        suites,
+        typeErrors,
+    };
+}
+main().catch((err) => {
+    console.error('Snapshot script failed:', err);
+    process.exit(1);
+});

package/build/snapshot.d.ts

@@ -1,2 +1,3 @@
 import { SnapshotOptions } from './snapshotter.types.js';
-export declare function snapshot(options: SnapshotOptions): Promise<boolean>;
+export declare function snapshot(options: SnapshotOptions): void;
+export declare function checkForPreviousSnapshotFailure(mirrorPath: string): void;

package/build/snapshot.js

@@ -4,68 +4,44 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.snapshot = snapshot;
+exports.checkForPreviousSnapshotFailure = checkForPreviousSnapshotFailure;
+const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const spruce_skill_utils_1 = require("@sprucelabs/spruce-skill-utils");
-const git_js_1 = require("./git.js");
-const sync_js_1 = require("./sync.js");
-class Snapshotter {
-    constructor() {
-        this.log = (0, spruce_skill_utils_1.buildLog)('Snapshotter');
-    }
-    async snapshot(options) {
-        const sourcePath = options.sourcePath ?? process.cwd();
-        const { mirrorPath, testResults, remote } = options;
-        this.log.info('Starting snapshot', sourcePath, mirrorPath);
-        try {
-            await (0, sync_js_1.syncFiles)(sourcePath, mirrorPath);
-            this.log.info('Files synced', mirrorPath);
-            const snapshotterDir = path_1.default.join(mirrorPath, '.snapshotter');
-            (0, fs_1.mkdirSync)(snapshotterDir, { recursive: true });
-            (0, fs_1.writeFileSync)(path_1.default.join(snapshotterDir, 'testResults.json'), JSON.stringify(sortTestResults(testResults), null, 2));
-            this.log.info('Test results saved', snapshotterDir);
-            const committed = await (0, git_js_1.gitCommit)(mirrorPath, this.log);
-            if (!committed) {
-                this.log.info('No changes to commit', mirrorPath);
-                return false;
-            }
-            this.log.info('Commit created, pushing', remote.url);
-            await (0, git_js_1.gitPush)(mirrorPath, remote, this.log);
-            this.log.info('Push completed', remote.url);
-            return true;
-        }
-        catch (err) {
-            const message = err instanceof Error ? err.message : String(err);
-            this.log.error('Snapshot failed', message);
-            throw err;
-        }
+const ERROR_FILE_NAME = 'lastError.json';
+const log = (0, spruce_skill_utils_1.buildLog)('Snapshotter');
+const scriptPath = path_1.default.join(__dirname, 'scripts', 'runSnapshot.js');
+function snapshot(options) {
+    const snapshotterDir = writeOptionsFile(options);
+    spawnSnapshotProcess(snapshotterDir);
+    log.info('Snapshot queued (running in background)', options.mirrorPath);
+}
+function checkForPreviousSnapshotFailure(mirrorPath) {
+    const errorPath = getErrorFilePath(mirrorPath);
+    if ((0, fs_1.existsSync)(errorPath)) {
+        const errorData = JSON.parse((0, fs_1.readFileSync)(errorPath, 'utf-8'));
+        (0, fs_1.unlinkSync)(errorPath);
+        throw new Error(`Previous snapshot failed: ${errorData.message}\n` +
+            `Timestamp: ${errorData.timestamp}\n` +
+            `This error was from a background snapshot that failed. ` +
+            `The snapshot has been retried - if this error persists, check your configuration.`);
     }
 }
-async function snapshot(options) {
-    return new Snapshotter().snapshot(options);
+function writeOptionsFile(options) {
+    const snapshotterDir = path_1.default.join(options.mirrorPath, '.snapshotter');
+    (0, fs_1.mkdirSync)(snapshotterDir, { recursive: true });
+    const optionsPath = path_1.default.join(snapshotterDir, 'pending.json');
+    (0, fs_1.writeFileSync)(optionsPath, JSON.stringify(options, null, 2));
+    return snapshotterDir;
+}
+function spawnSnapshotProcess(snapshotterDir) {
+    const child = (0, child_process_1.spawn)('node', [scriptPath, snapshotterDir], {
+        detached: true,
+        stdio: 'ignore',
+    });
+    child.unref();
 }
-function sortTestResults(testResults) {
-    const suites = [...testResults.suites].map((suite) => ({
-        ...suite,
-        tests: [...suite.tests].sort((left, right) => left.name.localeCompare(right.name)),
-    }));
-    suites.sort((left, right) => left.path.localeCompare(right.path));
-    const typeErrors = testResults.typeErrors
-        ? [...testResults.typeErrors].sort((left, right) => {
-            const fileCompare = left.file.localeCompare(right.file);
-            if (fileCompare !== 0) {
-                return fileCompare;
-            }
-            const lineCompare = left.line - right.line;
-            if (lineCompare !== 0) {
-                return lineCompare;
-            }
-            return left.column - right.column;
-        })
-        : undefined;
-    return {
-        ...testResults,
-        suites,
-        typeErrors,
-    };
+function getErrorFilePath(mirrorPath) {
+    return path_1.default.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regressionproof/snapshotter",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "publishConfig": {
     "access": "public"
   },
@@ -94,5 +94,5 @@
     "@sprucelabs/spruce-core-schemas": "^42.1.3",
     "@sprucelabs/spruce-skill-utils": "^34.0.3"
   },
-  "gitHead": "352f13a4d1696f99936450a1ae88c195457b22ad"
+  "gitHead": "860c3695ab884487c654e5cf794262bff8ea1570"
 }