@regressionproof/snapshotter 0.6.2 → 0.6.4

package/build/esm/snapshot.d.ts

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

package/build/esm/snapshot.js

@@ -7,16 +7,52 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { mkdirSync, writeFileSync } from 'fs';
+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';
 class Snapshotter {
     constructor() {
         this.log = buildLog('Snapshotter');
+        this.queue = [];
+        this.isProcessing = false;
     }
     snapshot(options) {
+        this.checkForPreviousFailure(options.mirrorPath);
+        this.enqueue(options);
+    }
+    checkForPreviousFailure(mirrorPath) {
+        const errorPath = this.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.`);
+        }
+    }
+    enqueue(options) {
+        this.queue.push(options);
+        this.log.info('Snapshot queued', options.mirrorPath);
+        void this.processQueue();
+    }
+    processQueue() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isProcessing || this.queue.length === 0) {
+                return;
+            }
+            this.isProcessing = true;
+            while (this.queue.length > 0) {
+                const options = this.queue.shift();
+                yield this.executeSnapshot(options);
+            }
+            this.isProcessing = false;
+        });
+    }
+    executeSnapshot(options) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const sourcePath = (_a = options.sourcePath) !== null && _a !== void 0 ? _a : process.cwd();
@@ -32,25 +68,45 @@ class Snapshotter {
                 const committed = yield gitCommit(mirrorPath, this.log);
                 if (!committed) {
                     this.log.info('No changes to commit', mirrorPath);
-                    return false;
+                    this.clearError(mirrorPath);
+                    return;
                 }
                 this.log.info('Commit created, pushing', remote.url);
                 yield gitPush(mirrorPath, remote, this.log);
                 this.log.info('Push completed', remote.url);
-                return true;
+                this.clearError(mirrorPath);
             }
             catch (err) {
                 const message = err instanceof Error ? err.message : String(err);
-                this.log.error('Snapshot failed', message);
-                throw err;
+                this.log.error('Snapshot failed (will surface on next test run)', message);
+                this.persistError(mirrorPath, err);
             }
         });
     }
+    persistError(mirrorPath, err) {
+        const snapshotterDir = path.join(mirrorPath, '.snapshotter');
+        mkdirSync(snapshotterDir, { recursive: true });
+        const errorPath = this.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));
+    }
+    clearError(mirrorPath) {
+        const errorPath = this.getErrorFilePath(mirrorPath);
+        if (existsSync(errorPath)) {
+            unlinkSync(errorPath);
+        }
+    }
+    getErrorFilePath(mirrorPath) {
+        return path.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
+    }
 }
+const snapshotter = new Snapshotter();
 export function snapshot(options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Snapshotter().snapshot(options);
-    });
+    snapshotter.snapshot(options);
 }
 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)) })));

package/build/snapshot.d.ts

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

package/build/snapshot.js

@@ -9,11 +9,45 @@ 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';
 class Snapshotter {
     constructor() {
         this.log = (0, spruce_skill_utils_1.buildLog)('Snapshotter');
+        this.queue = [];
+        this.isProcessing = false;
     }
-    async snapshot(options) {
+    snapshot(options) {
+        this.checkForPreviousFailure(options.mirrorPath);
+        this.enqueue(options);
+    }
+    checkForPreviousFailure(mirrorPath) {
+        const errorPath = this.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.`);
+        }
+    }
+    enqueue(options) {
+        this.queue.push(options);
+        this.log.info('Snapshot queued', options.mirrorPath);
+        void this.processQueue();
+    }
+    async processQueue() {
+        if (this.isProcessing || this.queue.length === 0) {
+            return;
+        }
+        this.isProcessing = true;
+        while (this.queue.length > 0) {
+            const options = this.queue.shift();
+            await this.executeSnapshot(options);
+        }
+        this.isProcessing = false;
+    }
+    async executeSnapshot(options) {
         const sourcePath = options.sourcePath ?? process.cwd();
         const { mirrorPath, testResults, remote } = options;
         this.log.info('Starting snapshot', sourcePath, mirrorPath);
@@ -27,22 +61,44 @@ class Snapshotter {
             const committed = await (0, git_js_1.gitCommit)(mirrorPath, this.log);
             if (!committed) {
                 this.log.info('No changes to commit', mirrorPath);
-                return false;
+                this.clearError(mirrorPath);
+                return;
             }
             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;
+            this.clearError(mirrorPath);
         }
         catch (err) {
             const message = err instanceof Error ? err.message : String(err);
-            this.log.error('Snapshot failed', message);
-            throw err;
+            this.log.error('Snapshot failed (will surface on next test run)', message);
+            this.persistError(mirrorPath, err);
         }
     }
+    persistError(mirrorPath, err) {
+        const snapshotterDir = path_1.default.join(mirrorPath, '.snapshotter');
+        (0, fs_1.mkdirSync)(snapshotterDir, { recursive: true });
+        const errorPath = this.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));
+    }
+    clearError(mirrorPath) {
+        const errorPath = this.getErrorFilePath(mirrorPath);
+        if ((0, fs_1.existsSync)(errorPath)) {
+            (0, fs_1.unlinkSync)(errorPath);
+        }
+    }
+    getErrorFilePath(mirrorPath) {
+        return path_1.default.join(mirrorPath, '.snapshotter', ERROR_FILE_NAME);
+    }
 }
-async function snapshot(options) {
-    return new Snapshotter().snapshot(options);
+const snapshotter = new Snapshotter();
+function snapshot(options) {
+    snapshotter.snapshot(options);
 }
 function sortTestResults(testResults) {
     const suites = [...testResults.suites].map((suite) => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regressionproof/snapshotter",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "publishConfig": {
     "access": "public"
   },
@@ -94,5 +94,5 @@
     "@sprucelabs/spruce-core-schemas": "^42.1.3",
     "@sprucelabs/spruce-skill-utils": "^34.0.3"
   },
-  "gitHead": "97dd0de8de268600fd4727669c045cef16f82d8c"
+  "gitHead": "d2f31ff2ccfed75b6b5638510b4bbeebcbe0ec1b"
 }