@tenonhq/dovetail-core 0.0.96 → 0.0.97

package/dist/appUtils.js

@@ -118,7 +118,13 @@ const processFilesInManRec = async (recPath, rec, forceWrite) => {
 const processRecsInManTable = async (tablePath, table, forceWrite, onRecordProcessed) => {
     const { records } = table;
     const recKeys = Object.keys(records);
-    const recKeyToPath = (key) => path_1.default.join(tablePath, records[key].name);
+    // Derive the folder name via toSafeFolderName, not the raw record.name. The
+    // download path normalizes manifest keys upstream (processManifest), but the
+    // refresh path (processMissingFiles) feeds this writer the raw bulkDownload
+    // response, whose .name is the unmodified ServiceNow display name — which can
+    // be filesystem-unsafe (e.g. a `<table>.*` ACL). toSafeFolderName is
+    // idempotent on already-safe names, so re-applying it here is harmless.
+    const recKeyToPath = (key) => path_1.default.join(tablePath, (0, exports.toSafeFolderName)(records[key]));
     const recPathPromises = recKeys
         .map(recKeyToPath)
         .map(fUtils.createDirRecursively);
@@ -511,11 +517,16 @@ const refreshAllFiles = async (newManifest, sourcePath, options = {}) => {
             var recs = filesToProcess[tableName].records;
             var recKeys = Object.keys(recs);
             await Promise.all(recKeys.map(function (k) {
-                return fUtils.createDirRecursively(path_1.default.join(tablePath, recs[k].name));
+                // toSafeFolderName, not raw recs[k].name: the bulkDownload response
+                // carries the unmodified ServiceNow display name, which may be
+                // filesystem-unsafe (e.g. a `<table>.*` ACL). Without this, refresh
+                // recreates Windows-illegal folders that normalizeManifestKeys
+                // already removed from the manifest.
+                return fUtils.createDirRecursively(path_1.default.join(tablePath, (0, exports.toSafeFolderName)(recs[k])));
             }));
             await (0, genericUtils_1.processBatched)(recKeys, constants_1.CONCURRENCY_RECORDS, async function (recKey) {
                 var rec = recs[recKey];
-                var recPath = path_1.default.join(tablePath, rec.name);
+                var recPath = path_1.default.join(tablePath, (0, exports.toSafeFolderName)(rec));
                 // Split server-provided metadata off from the regular files so we can
                 // track whether any regular file actually changed — metaData shouldn't
                 // be the trigger for "this record changed" since we stamp it on every

package/dist/tests/refreshSafeFolderNames.test.js

@@ -0,0 +1,216 @@
+"use strict";
+/**
+ * Regression: the refresh path must write filesystem-SAFE folder names.
+ *
+ * normalizeManifestKeys() (PR #117) re-keys the manifest object so a record
+ * with a Windows-illegal display name (e.g. a table-wildcard ACL named
+ * `x_cadso_work_campaign.*`) maps to its sys_id. But the refresh writer
+ * (`refreshAllFiles`) builds folders from the raw `getMissingFiles`
+ * (bulkDownload) server response, whose `.name` is the unmodified display
+ * name — so it recreated the illegal `<table>.*` folders on every refresh,
+ * silently breaking the folder ≡ manifest-key invariant and aborting
+ * `git clone` on Windows.
+ *
+ * These tests assert the writer routes through toSafeFolderName: a `.*` ACL
+ * record lands in a sys_id folder, while a safe name stays human-readable.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+// ---------- mocks (must come before importing the module under test) ----------
+var mockLogger = {
+    info: jest.fn(),
+    debug: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+    success: jest.fn(),
+    getLogLevel: function () { return "warn"; },
+};
+var mockFileLogger = {
+    debug: jest.fn(),
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+};
+var mockClient = {
+    getManifest: jest.fn(),
+    getMissingFiles: jest.fn(),
+};
+jest.mock("../Logger", function () { return { logger: mockLogger }; });
+jest.mock("../FileLogger", function () { return { fileLogger: mockFileLogger }; });
+jest.mock("../snClient", function () {
+    return {
+        defaultClient: function () { return mockClient; },
+        unwrapSNResponse: function (p) { return Promise.resolve(p).then(function (r) { return r; }); },
+        processPushResponse: jest.fn(),
+        retryOnErr: jest.fn(),
+        retryOnHttpErr: jest.fn(),
+        unwrapTableAPIFirstItem: jest.fn(),
+    };
+});
+var mockConfig = {
+    getConfig: jest.fn().mockReturnValue({
+        scopes: { x_cadso_work: {} },
+        tableOptions: {},
+    }),
+    getManifest: jest.fn().mockResolvedValue({
+        x_cadso_work: { scope: "x_cadso_work", tables: {} },
+    }),
+    getSourcePathForScope: jest.fn(),
+    getSourcePath: jest.fn(),
+    getManifestPath: jest.fn().mockReturnValue("/tmp/dove.manifest.json"),
+    resolveConfigForScope: jest.fn().mockImplementation(function () {
+        return {
+            tables: ["sys_security_acl"],
+            fieldOverrides: {},
+            apiIncludes: {},
+            apiExcludes: {},
+        };
+    }),
+    isMultiScopeManifest: jest.fn().mockReturnValue(true),
+    updateManifest: jest.fn(),
+};
+jest.mock("../config", function () { return mockConfig; });
+jest.mock("progress", function () {
+    return jest.fn().mockImplementation(function () {
+        return { tick: jest.fn() };
+    });
+});
+// Keep real FileUtils so we assert against the actual file system; stub only
+// writeScopeManifest so no manifest file is written.
+jest.mock("../FileUtils", function () {
+    var actual = jest.requireActual("../FileUtils");
+    return Object.assign({}, actual, {
+        writeScopeManifest: jest.fn().mockResolvedValue(undefined),
+    });
+});
+const AppUtils = __importStar(require("../appUtils"));
+// ---------- helpers ----------
+var tmpRoot;
+var ACL_SYS_ID = "bc91c2a5f334621048dff31590812771";
+function listAclFolders() {
+    var dir = path.join(tmpRoot, "sys_security_acl");
+    try {
+        return fs.readdirSync(dir).sort();
+    }
+    catch (e) {
+        return [];
+    }
+}
+describe("refresh — folder names are filesystem-safe (sys_id fallback)", function () {
+    beforeEach(function () {
+        jest.clearAllMocks();
+        tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), "dove-safe-folder-"));
+        mockConfig.getSourcePathForScope.mockReturnValue(tmpRoot);
+        mockConfig.getSourcePath.mockReturnValue(tmpRoot);
+    });
+    afterEach(function () {
+        try {
+            fs.rmSync(tmpRoot, { recursive: true, force: true });
+        }
+        catch (e) { }
+    });
+    test("a `<table>.*` ACL record is written to its sys_id folder, never `.*`", async function () {
+        // Manifest as the server returns it: keyed by the illegal display name.
+        // normalizeManifestKeys re-keys this to sys_id inside syncManifest.
+        mockClient.getManifest.mockResolvedValue({
+            scope: "x_cadso_work",
+            tables: {
+                sys_security_acl: {
+                    records: {
+                        "x_cadso_work_campaign.*": {
+                            name: "x_cadso_work_campaign.*",
+                            sys_id: ACL_SYS_ID,
+                            files: [{ name: "script", type: "js" }],
+                        },
+                    },
+                },
+            },
+        });
+        // bulkDownload echoes the RAW display name back — the bug source. The
+        // writer must not trust it for the folder path.
+        mockClient.getMissingFiles.mockResolvedValue({
+            sys_security_acl: {
+                records: {
+                    "x_cadso_work_campaign.*": {
+                        name: "x_cadso_work_campaign.*",
+                        sys_id: ACL_SYS_ID,
+                        files: [{ name: "script", type: "js", content: "// acl" }],
+                    },
+                },
+            },
+        });
+        await AppUtils.syncManifest("x_cadso_work");
+        var folders = listAclFolders();
+        expect(folders).toContain(ACL_SYS_ID);
+        expect(folders).not.toContain("x_cadso_work_campaign.*");
+        // The file landed inside the sys_id folder.
+        expect(fs.readFileSync(path.join(tmpRoot, "sys_security_acl", ACL_SYS_ID, "script.js"), "utf8")).toBe("// acl");
+    });
+    test("a filesystem-safe ACL name stays human-readable (no needless sys_id fallback)", async function () {
+        var SAFE_SYS_ID = "aa11bb22cc33dd44ee55ff6600112233";
+        mockClient.getManifest.mockResolvedValue({
+            scope: "x_cadso_work",
+            tables: {
+                sys_security_acl: {
+                    records: {
+                        x_cadso_work_campaign: {
+                            name: "x_cadso_work_campaign",
+                            sys_id: SAFE_SYS_ID,
+                            files: [{ name: "script", type: "js" }],
+                        },
+                    },
+                },
+            },
+        });
+        mockClient.getMissingFiles.mockResolvedValue({
+            sys_security_acl: {
+                records: {
+                    x_cadso_work_campaign: {
+                        name: "x_cadso_work_campaign",
+                        sys_id: SAFE_SYS_ID,
+                        files: [{ name: "script", type: "js", content: "// safe" }],
+                    },
+                },
+            },
+        });
+        await AppUtils.syncManifest("x_cadso_work");
+        var folders = listAclFolders();
+        expect(folders).toContain("x_cadso_work_campaign");
+        expect(folders).not.toContain(SAFE_SYS_ID);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenonhq/dovetail-core",
-  "version": "0.0.96",
+  "version": "0.0.97",
   "description": "Next-gen file syncer",
   "license": "GPL-3.0",
   "main": "./dist/index.js",

package/release-manifest.json

@@ -1,7 +1,109 @@
 {
   "$schema": "dovetail-manifest/v1",
-  "generated_at": "2026-05-31T16:52:41.031Z",
+  "generated_at": "2026-06-01T21:28:08.741Z",
   "events": [
+    {
+      "$schema": "dovetail-release-event/v1",
+      "event_id": "dovetail-core@0.0.96",
+      "package": "@tenonhq/dovetail-core",
+      "version": "0.0.96",
+      "prev_version": "0.0.95",
+      "published_at": "2026-06-01T21:28:08.724Z",
+      "git": {
+        "sha": "a3ea5ead48b0bd4c324e0847e7e768a43520c7ec",
+        "tag": "dovetail-core@0.0.96"
+      },
+      "semver_bump": "patch",
+      "commits": [
+        {
+          "sha": "a3ea5ead4",
+          "subject": "feat(client): point Dovetail clients at the scoped dovetail_* APIs (#132)",
+          "pr": 132
+        },
+        {
+          "sha": "93d180eef",
+          "subject": "chore(release): @tenonhq/dovetail-servicenow@0.0.9 [skip ci]"
+        },
+        {
+          "sha": "d32523991",
+          "subject": "chore(release): @tenonhq/dovetail-servicenow@0.0.8 [skip ci]"
+        },
+        {
+          "sha": "ba1c67775",
+          "subject": "chore(release): @tenonhq/dovetail-dashboard@0.0.36 [skip ci]"
+        },
+        {
+          "sha": "9901285c6",
+          "subject": "chore(release): @tenonhq/dovetail-dashboard@0.0.35 [skip ci]"
+        },
+        {
+          "sha": "55de31527",
+          "subject": "chore(release): @tenonhq/dovetail-dashboard@0.0.34 [skip ci]"
+        },
+        {
+          "sha": "776f1fc53",
+          "subject": "chore(release): @tenonhq/dovetail-sawmill@0.0.7 [skip ci]"
+        },
+        {
+          "sha": "407d6d75e",
+          "subject": "chore(release): publish 2 packages [skip ci]"
+        }
+      ],
+      "exports_delta": null,
+      "narrative": null
+    },
+    {
+      "$schema": "dovetail-release-event/v1",
+      "event_id": "dovetail-servicenow@0.0.10",
+      "package": "@tenonhq/dovetail-servicenow",
+      "version": "0.0.10",
+      "prev_version": "0.0.9",
+      "published_at": "2026-06-01T21:28:08.724Z",
+      "git": {
+        "sha": "a3ea5ead48b0bd4c324e0847e7e768a43520c7ec",
+        "tag": "dovetail-servicenow@0.0.10"
+      },
+      "semver_bump": "patch",
+      "commits": [
+        {
+          "sha": "a3ea5ead4",
+          "subject": "feat(client): point Dovetail clients at the scoped dovetail_* APIs (#132)",
+          "pr": 132
+        },
+        {
+          "sha": "93d180eef",
+          "subject": "chore(release): @tenonhq/dovetail-servicenow@0.0.9 [skip ci]"
+        }
+      ],
+      "exports_delta": null,
+      "narrative": null
+    },
+    {
+      "$schema": "dovetail-release-event/v1",
+      "event_id": "dovetail-sawmill@0.0.8",
+      "package": "@tenonhq/dovetail-sawmill",
+      "version": "0.0.8",
+      "prev_version": "0.0.7",
+      "published_at": "2026-06-01T21:28:08.724Z",
+      "git": {
+        "sha": "a3ea5ead48b0bd4c324e0847e7e768a43520c7ec",
+        "tag": "dovetail-sawmill@0.0.8"
+      },
+      "semver_bump": "patch",
+      "commits": [
+        {
+          "sha": "a3ea5ead4",
+          "subject": "feat(client): point Dovetail clients at the scoped dovetail_* APIs (#132)",
+          "pr": 132
+        },
+        {
+          "sha": "776f1fc53",
+          "subject": "chore(release): @tenonhq/dovetail-sawmill@0.0.7 [skip ci]"
+        }
+      ],
+      "exports_delta": null,
+      "narrative": null
+    },
     {
       "$schema": "dovetail-release-event/v1",
       "event_id": "dovetail-servicenow@0.0.9",