@itwin/core-backend 5.15.0-dev.2 → 5.15.0-dev.20

package/lib/esm/test/standalone/BriefcaseManagerDelete.test.js

@@ -0,0 +1,159 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import * as path from "node:path";
+import * as sinon from "sinon";
+import { Guid, IModelStatus, OpenMode } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { BriefcaseManager } from "../../BriefcaseManager";
+import { StandaloneDb } from "../../IModelDb";
+import { IModelJsFs } from "../../IModelJsFs";
+import { checkFrontendBriefcaseDelete, isBriefcaseSidecar } from "../../internal/BriefcaseUtils";
+import { IModelNative } from "../../internal/NativePlatform";
+import { KnownTestLocations } from "../KnownTestLocations";
+describe("Deleting briefcase files", () => {
+    let outsideDir;
+    let insideDir;
+    const writeFile = (fileName, content = "test content") => {
+        IModelJsFs.writeFileSync(fileName, content);
+        return fileName;
+    };
+    const createIModel = (fileName) => {
+        const db = StandaloneDb.createEmpty(fileName, { rootSubject: { name: "DeleteBriefcaseFiles" } });
+        const pathName = db.pathName; // native appends ".bim" if fileName has no extension
+        db.close();
+        return pathName;
+    };
+    beforeEach(() => {
+        outsideDir = path.join(KnownTestLocations.outputDir, "DeleteBriefcaseFiles", Guid.createValue());
+        insideDir = path.join(BriefcaseManager.cacheDir, Guid.createValue(), "briefcases");
+        IModelJsFs.recursiveMkDirSync(outsideDir);
+        IModelJsFs.recursiveMkDirSync(insideDir);
+        const cacheRoot = path.resolve(BriefcaseManager.cacheDir) + path.sep;
+        expect(path.resolve(outsideDir).startsWith(cacheRoot)).to.be.false;
+        expect(path.resolve(insideDir).startsWith(cacheRoot)).to.be.true;
+    });
+    afterEach(() => {
+        sinon.restore();
+        IModelJsFs.removeSync(outsideDir);
+        IModelJsFs.removeSync(path.dirname(insideDir));
+    });
+    describe("BriefcaseManager.deleteBriefcaseFiles", () => {
+        /** Create an iModel with an assigned (valid) briefcaseId, so deleteBriefcaseFiles tries to clean up rebase folders and release it. */
+        const createAssignedBriefcase = (fileName) => {
+            const pathName = createIModel(fileName);
+            const nativeDb = new IModelNative.platform.DgnDb();
+            nativeDb.openIModel(pathName, OpenMode.ReadWrite);
+            nativeDb.resetBriefcaseId(2);
+            nativeDb.saveChanges();
+            nativeDb.closeFile();
+            return pathName;
+        };
+        it("releases the briefcaseId and deletes the file even if cleaning up rebase folders fails", async () => {
+            const bim = createAssignedBriefcase(path.join(insideDir, "5.bim"));
+            sinon.stub(BriefcaseManager, "cleanupRebaseFolders").throws(new Error("EBUSY"));
+            const release = sinon.stub(BriefcaseManager, "releaseBriefcase").resolves();
+            await BriefcaseManager.deleteBriefcaseFiles(bim, "access token");
+            expect(release.calledOnce).to.be.true;
+            expect(release.firstCall.args[1].briefcaseId).equal(2);
+            expect(IModelJsFs.existsSync(bim)).to.be.false;
+        });
+        it("cleans up rebase folders and deletes the file even if releasing the briefcaseId fails", async () => {
+            const bim = createAssignedBriefcase(path.join(insideDir, "6.bim"));
+            const rebaseDir = path.join(insideDir, ".rebasing", "2");
+            IModelJsFs.recursiveMkDirSync(rebaseDir);
+            sinon.stub(BriefcaseManager, "releaseBriefcase").rejects(new Error("hub unavailable"));
+            await BriefcaseManager.deleteBriefcaseFiles(bim, "access token");
+            expect(IModelJsFs.existsSync(rebaseDir)).to.be.false;
+            expect(IModelJsFs.existsSync(bim)).to.be.false;
+        });
+        it("deletes a briefcase along with its associated files, but not other files", async () => {
+            const bim = createIModel(path.join(insideDir, "1.bim"));
+            const sidecars = ["-wal", "-shm", "-journal", "-locks", "-locks-wal", "-locks-shm", ".Tiles", ".Tiles-journal", "-hierarchies", ".HierarchyCache.db", ".keep.txt"]
+                .map((suffix) => writeFile(`${bim}${suffix}`));
+            const unrelated = [writeFile(path.join(insideDir, "1.bim2")), writeFile(path.join(insideDir, "1.bimx.txt")), writeFile(path.join(insideDir, "x1.bim-wal"))];
+            const sidecarDir = path.join(insideDir, "1.bim.dir");
+            IModelJsFs.recursiveMkDirSync(sidecarDir);
+            await BriefcaseManager.deleteBriefcaseFiles(bim);
+            expect(IModelJsFs.existsSync(bim)).to.be.false;
+            for (const sidecar of sidecars)
+                expect(IModelJsFs.existsSync(sidecar), sidecar).to.be.false;
+            for (const file of unrelated)
+                expect(IModelJsFs.existsSync(file), file).to.be.true;
+            expect(IModelJsFs.existsSync(sidecarDir), "directories are not deleted").to.be.true;
+        });
+        it("deletes a corrupt file at any location, but not files that merely share a prefix", async () => {
+            const a = writeFile(path.join(outsideDir, "a"), "this is not an iModel");
+            const wal = writeFile(`${a}-wal`);
+            const unrelated = [writeFile(path.join(outsideDir, "abc.txt")), writeFile(path.join(outsideDir, "ab-c.txt"))];
+            await BriefcaseManager.deleteBriefcaseFiles(a);
+            expect(IModelJsFs.existsSync(a)).to.be.false;
+            expect(IModelJsFs.existsSync(wal)).to.be.false;
+            for (const file of unrelated)
+                expect(IModelJsFs.existsSync(file), file).to.be.true;
+        });
+        it("deletes stale associated files when the briefcase file is missing", async () => {
+            const bim = path.join(insideDir, "3.bim");
+            const wal = writeFile(`${bim}-wal`);
+            const locks = writeFile(`${bim}-locks`);
+            await BriefcaseManager.deleteBriefcaseFiles(bim);
+            expect(IModelJsFs.existsSync(wal)).to.be.false;
+            expect(IModelJsFs.existsSync(locks)).to.be.false;
+        });
+    });
+    describe("isBriefcaseSidecar", () => {
+        it("matches only <name>-* and <name>.*", () => {
+            for (const file of ["a.bim-wal", "a.bim-locks-shm", "a.bim.Tiles", "a.bim.HierarchyCache.db", "a.bim-hierarchies"])
+                expect(isBriefcaseSidecar(file, "a.bim"), file).to.be.true;
+            for (const file of ["a.bim", "a.bim-", "a.bim.", "a.bim2", "a.bimx.txt", "a.bim_wal", "xa.bim-wal", "b.bim-wal"])
+                expect(isBriefcaseSidecar(file, "a.bim"), file).to.be.false;
+        });
+    });
+    describe("checkFrontendBriefcaseDelete", () => {
+        const expectBadRequest = (filePath) => {
+            let error;
+            try {
+                checkFrontendBriefcaseDelete(filePath, BriefcaseManager.cacheDir);
+            }
+            catch (err) {
+                error = err;
+            }
+            expect(error).instanceOf(IModelError);
+            expect(error.errorNumber).equal(IModelStatus.BadRequest);
+        };
+        it("rejects a file outside the cache that is not an iModel", () => {
+            const notes = writeFile(path.join(outsideDir, "notes.txt"));
+            expectBadRequest(notes);
+            expect(IModelJsFs.existsSync(notes)).to.be.true;
+        });
+        it("rejects paths that use '..' to escape the cache", () => {
+            const notes = writeFile(path.join(outsideDir, "notes.txt"));
+            const escapingPath = `${insideDir}${path.sep}${path.relative(insideDir, notes)}`;
+            expect(escapingPath.startsWith(insideDir)).to.be.true;
+            expectBadRequest(escapingPath);
+        });
+        it("returns undefined for a missing file outside the cache, so its associated files are not deleted", () => {
+            writeFile(path.join(outsideDir, "a.docx"));
+            expect(checkFrontendBriefcaseDelete(path.join(outsideDir, "a"), BriefcaseManager.cacheDir)).to.be.undefined;
+        });
+        it("allows a valid iModel outside the cache", () => {
+            const bim = createIModel(path.join(outsideDir, "valid.bim"));
+            expect(checkFrontendBriefcaseDelete(bim, BriefcaseManager.cacheDir)).equal(path.resolve(bim));
+        });
+        it("allows any file, or missing file, inside the cache", () => {
+            const corrupt = writeFile(path.join(insideDir, "2.bim"), "this is not an iModel");
+            expect(checkFrontendBriefcaseDelete(corrupt, BriefcaseManager.cacheDir)).equal(path.resolve(corrupt));
+            const missing = path.join(insideDir, "3.bim");
+            expect(checkFrontendBriefcaseDelete(missing, BriefcaseManager.cacheDir)).equal(path.resolve(missing));
+        });
+        it("treats the cache directory case-insensitively on Windows", function () {
+            if (process.platform !== "win32")
+                this.skip();
+            const corrupt = writeFile(path.join(insideDir, "4.bim"), "this is not an iModel");
+            expect(checkFrontendBriefcaseDelete(corrupt.toUpperCase(), BriefcaseManager.cacheDir)).equal(path.resolve(corrupt.toUpperCase()));
+        });
+    });
+});
+//# sourceMappingURL=BriefcaseManagerDelete.test.js.map

package/lib/esm/test/standalone/BriefcaseManagerDelete.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BriefcaseManagerDelete.test.js","sourceRoot":"","sources":["../../../../src/test/standalone/BriefcaseManagerDelete.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,4BAA4B,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,IAAI,UAAkB,CAAC;IACvB,IAAI,SAAiB,CAAC;IAEtB,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,OAAO,GAAG,cAAc,EAAE,EAAE;QAC/D,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,EAAE;QACxC,MAAM,EAAE,GAAG,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,EAAE,CAAC,CAAC;QACjG,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,qDAAqD;QACnF,EAAE,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,sBAAsB,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACjG,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,YAAY,CAAC,CAAC;QACnF,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC1C,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEzC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACrE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;QACrD,sIAAsI;QACtI,MAAM,uBAAuB,GAAG,CAAC,QAAgB,EAAE,EAAE;YACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;YACxC,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnD,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;YAClD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAC7B,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,EAAE,CAAC,wFAAwF,EAAE,KAAK,IAAI,EAAE;YACtG,MAAM,GAAG,GAAG,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,gBAAuB,EAAE,sBAAsB,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACvF,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,QAAQ,EAAE,CAAC;YAE5E,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAEjE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACtC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;YACrG,MAAM,GAAG,GAAG,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACnE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;YACzD,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAEvF,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAEjE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACrD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,oBAAoB,EAAE,WAAW,CAAC;iBAC/J,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;YAC5J,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACrD,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE1C,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;YAEjD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC/C,KAAK,MAAM,OAAO,IAAI,QAAQ;gBAC5B,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC9D,KAAK,MAAM,IAAI,IAAI,SAAS;gBAC1B,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACvD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,6BAA6B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YAChG,MAAM,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,uBAAuB,CAAC,CAAC;YACzE,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,SAAS,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;YAE9G,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;YAE/C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC7C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC/C,KAAK,MAAM,IAAI,IAAI,SAAS;gBAC1B,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC;YACpC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;YAExC,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;YAEjD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC/C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,KAAK,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,yBAAyB,EAAE,mBAAmB,CAAC;gBAChH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC7D,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,CAAC;gBAC9G,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;QAC5C,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;YAC5C,IAAI,KAAc,CAAC;YACnB,IAAI,CAAC;gBACH,4BAA4B,CAAC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACpE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,GAAG,GAAG,CAAC;YACd,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACtC,MAAM,CAAE,KAAqB,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5E,CAAC,CAAC;QAEF,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAC5D,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACxB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC;YACjF,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACtD,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iGAAiG,EAAE,GAAG,EAAE;YACzG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAC9G,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAC7D,MAAM,CAAC,4BAA4B,CAAC,GAAG,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC;YAClF,MAAM,CAAC,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAEtG,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,CAAC,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE;YAC7D,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;gBAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;YAEd,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC;YAClF,MAAM,CAAC,4BAA4B,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACpI,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { expect } from \"chai\";\r\nimport * as path from \"node:path\";\r\nimport * as sinon from \"sinon\";\r\nimport { Guid, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { BriefcaseManager } from \"../../BriefcaseManager\";\r\nimport { StandaloneDb } from \"../../IModelDb\";\r\nimport { IModelJsFs } from \"../../IModelJsFs\";\r\nimport { checkFrontendBriefcaseDelete, isBriefcaseSidecar } from \"../../internal/BriefcaseUtils\";\r\nimport { IModelNative } from \"../../internal/NativePlatform\";\r\nimport { KnownTestLocations } from \"../KnownTestLocations\";\r\n\r\ndescribe(\"Deleting briefcase files\", () => {\r\n  let outsideDir: string;\r\n  let insideDir: string;\r\n\r\n  const writeFile = (fileName: string, content = \"test content\") => {\r\n    IModelJsFs.writeFileSync(fileName, content);\r\n    return fileName;\r\n  };\r\n\r\n  const createIModel = (fileName: string) => {\r\n    const db = StandaloneDb.createEmpty(fileName, { rootSubject: { name: \"DeleteBriefcaseFiles\" } });\r\n    const pathName = db.pathName; // native appends \".bim\" if fileName has no extension\r\n    db.close();\r\n    return pathName;\r\n  };\r\n\r\n  beforeEach(() => {\r\n    outsideDir = path.join(KnownTestLocations.outputDir, \"DeleteBriefcaseFiles\", Guid.createValue());\r\n    insideDir = path.join(BriefcaseManager.cacheDir, Guid.createValue(), \"briefcases\");\r\n    IModelJsFs.recursiveMkDirSync(outsideDir);\r\n    IModelJsFs.recursiveMkDirSync(insideDir);\r\n\r\n    const cacheRoot = path.resolve(BriefcaseManager.cacheDir) + path.sep;\r\n    expect(path.resolve(outsideDir).startsWith(cacheRoot)).to.be.false;\r\n    expect(path.resolve(insideDir).startsWith(cacheRoot)).to.be.true;\r\n  });\r\n\r\n  afterEach(() => {\r\n    sinon.restore();\r\n    IModelJsFs.removeSync(outsideDir);\r\n    IModelJsFs.removeSync(path.dirname(insideDir));\r\n  });\r\n\r\n  describe(\"BriefcaseManager.deleteBriefcaseFiles\", () => {\r\n    /** Create an iModel with an assigned (valid) briefcaseId, so deleteBriefcaseFiles tries to clean up rebase folders and release it. */\r\n    const createAssignedBriefcase = (fileName: string) => {\r\n      const pathName = createIModel(fileName);\r\n      const nativeDb = new IModelNative.platform.DgnDb();\r\n      nativeDb.openIModel(pathName, OpenMode.ReadWrite);\r\n      nativeDb.resetBriefcaseId(2);\r\n      nativeDb.saveChanges();\r\n      nativeDb.closeFile();\r\n      return pathName;\r\n    };\r\n\r\n    it(\"releases the briefcaseId and deletes the file even if cleaning up rebase folders fails\", async () => {\r\n      const bim = createAssignedBriefcase(path.join(insideDir, \"5.bim\"));\r\n      sinon.stub(BriefcaseManager as any, \"cleanupRebaseFolders\").throws(new Error(\"EBUSY\"));\r\n      const release = sinon.stub(BriefcaseManager, \"releaseBriefcase\").resolves();\r\n\r\n      await BriefcaseManager.deleteBriefcaseFiles(bim, \"access token\");\r\n\r\n      expect(release.calledOnce).to.be.true;\r\n      expect(release.firstCall.args[1].briefcaseId).equal(2);\r\n      expect(IModelJsFs.existsSync(bim)).to.be.false;\r\n    });\r\n\r\n    it(\"cleans up rebase folders and deletes the file even if releasing the briefcaseId fails\", async () => {\r\n      const bim = createAssignedBriefcase(path.join(insideDir, \"6.bim\"));\r\n      const rebaseDir = path.join(insideDir, \".rebasing\", \"2\");\r\n      IModelJsFs.recursiveMkDirSync(rebaseDir);\r\n      sinon.stub(BriefcaseManager, \"releaseBriefcase\").rejects(new Error(\"hub unavailable\"));\r\n\r\n      await BriefcaseManager.deleteBriefcaseFiles(bim, \"access token\");\r\n\r\n      expect(IModelJsFs.existsSync(rebaseDir)).to.be.false;\r\n      expect(IModelJsFs.existsSync(bim)).to.be.false;\r\n    });\r\n    it(\"deletes a briefcase along with its associated files, but not other files\", async () => {\r\n      const bim = createIModel(path.join(insideDir, \"1.bim\"));\r\n      const sidecars = [\"-wal\", \"-shm\", \"-journal\", \"-locks\", \"-locks-wal\", \"-locks-shm\", \".Tiles\", \".Tiles-journal\", \"-hierarchies\", \".HierarchyCache.db\", \".keep.txt\"]\r\n        .map((suffix) => writeFile(`${bim}${suffix}`));\r\n      const unrelated = [writeFile(path.join(insideDir, \"1.bim2\")), writeFile(path.join(insideDir, \"1.bimx.txt\")), writeFile(path.join(insideDir, \"x1.bim-wal\"))];\r\n      const sidecarDir = path.join(insideDir, \"1.bim.dir\");\r\n      IModelJsFs.recursiveMkDirSync(sidecarDir);\r\n\r\n      await BriefcaseManager.deleteBriefcaseFiles(bim);\r\n\r\n      expect(IModelJsFs.existsSync(bim)).to.be.false;\r\n      for (const sidecar of sidecars)\r\n        expect(IModelJsFs.existsSync(sidecar), sidecar).to.be.false;\r\n      for (const file of unrelated)\r\n        expect(IModelJsFs.existsSync(file), file).to.be.true;\r\n      expect(IModelJsFs.existsSync(sidecarDir), \"directories are not deleted\").to.be.true;\r\n    });\r\n\r\n    it(\"deletes a corrupt file at any location, but not files that merely share a prefix\", async () => {\r\n      const a = writeFile(path.join(outsideDir, \"a\"), \"this is not an iModel\");\r\n      const wal = writeFile(`${a}-wal`);\r\n      const unrelated = [writeFile(path.join(outsideDir, \"abc.txt\")), writeFile(path.join(outsideDir, \"ab-c.txt\"))];\r\n\r\n      await BriefcaseManager.deleteBriefcaseFiles(a);\r\n\r\n      expect(IModelJsFs.existsSync(a)).to.be.false;\r\n      expect(IModelJsFs.existsSync(wal)).to.be.false;\r\n      for (const file of unrelated)\r\n        expect(IModelJsFs.existsSync(file), file).to.be.true;\r\n    });\r\n\r\n    it(\"deletes stale associated files when the briefcase file is missing\", async () => {\r\n      const bim = path.join(insideDir, \"3.bim\");\r\n      const wal = writeFile(`${bim}-wal`);\r\n      const locks = writeFile(`${bim}-locks`);\r\n\r\n      await BriefcaseManager.deleteBriefcaseFiles(bim);\r\n\r\n      expect(IModelJsFs.existsSync(wal)).to.be.false;\r\n      expect(IModelJsFs.existsSync(locks)).to.be.false;\r\n    });\r\n  });\r\n\r\n  describe(\"isBriefcaseSidecar\", () => {\r\n    it(\"matches only <name>-* and <name>.*\", () => {\r\n      for (const file of [\"a.bim-wal\", \"a.bim-locks-shm\", \"a.bim.Tiles\", \"a.bim.HierarchyCache.db\", \"a.bim-hierarchies\"])\r\n        expect(isBriefcaseSidecar(file, \"a.bim\"), file).to.be.true;\r\n      for (const file of [\"a.bim\", \"a.bim-\", \"a.bim.\", \"a.bim2\", \"a.bimx.txt\", \"a.bim_wal\", \"xa.bim-wal\", \"b.bim-wal\"])\r\n        expect(isBriefcaseSidecar(file, \"a.bim\"), file).to.be.false;\r\n    });\r\n  });\r\n\r\n  describe(\"checkFrontendBriefcaseDelete\", () => {\r\n    const expectBadRequest = (filePath: string) => {\r\n      let error: unknown;\r\n      try {\r\n        checkFrontendBriefcaseDelete(filePath, BriefcaseManager.cacheDir);\r\n      } catch (err) {\r\n        error = err;\r\n      }\r\n      expect(error).instanceOf(IModelError);\r\n      expect((error as IModelError).errorNumber).equal(IModelStatus.BadRequest);\r\n    };\r\n\r\n    it(\"rejects a file outside the cache that is not an iModel\", () => {\r\n      const notes = writeFile(path.join(outsideDir, \"notes.txt\"));\r\n      expectBadRequest(notes);\r\n      expect(IModelJsFs.existsSync(notes)).to.be.true;\r\n    });\r\n\r\n    it(\"rejects paths that use '..' to escape the cache\", () => {\r\n      const notes = writeFile(path.join(outsideDir, \"notes.txt\"));\r\n      const escapingPath = `${insideDir}${path.sep}${path.relative(insideDir, notes)}`;\r\n      expect(escapingPath.startsWith(insideDir)).to.be.true;\r\n      expectBadRequest(escapingPath);\r\n    });\r\n\r\n    it(\"returns undefined for a missing file outside the cache, so its associated files are not deleted\", () => {\r\n      writeFile(path.join(outsideDir, \"a.docx\"));\r\n      expect(checkFrontendBriefcaseDelete(path.join(outsideDir, \"a\"), BriefcaseManager.cacheDir)).to.be.undefined;\r\n    });\r\n\r\n    it(\"allows a valid iModel outside the cache\", () => {\r\n      const bim = createIModel(path.join(outsideDir, \"valid.bim\"));\r\n      expect(checkFrontendBriefcaseDelete(bim, BriefcaseManager.cacheDir)).equal(path.resolve(bim));\r\n    });\r\n\r\n    it(\"allows any file, or missing file, inside the cache\", () => {\r\n      const corrupt = writeFile(path.join(insideDir, \"2.bim\"), \"this is not an iModel\");\r\n      expect(checkFrontendBriefcaseDelete(corrupt, BriefcaseManager.cacheDir)).equal(path.resolve(corrupt));\r\n\r\n      const missing = path.join(insideDir, \"3.bim\");\r\n      expect(checkFrontendBriefcaseDelete(missing, BriefcaseManager.cacheDir)).equal(path.resolve(missing));\r\n    });\r\n\r\n    it(\"treats the cache directory case-insensitively on Windows\", function () {\r\n      if (process.platform !== \"win32\")\r\n        this.skip();\r\n\r\n      const corrupt = writeFile(path.join(insideDir, \"4.bim\"), \"this is not an iModel\");\r\n      expect(checkFrontendBriefcaseDelete(corrupt.toUpperCase(), BriefcaseManager.cacheDir)).equal(path.resolve(corrupt.toUpperCase()));\r\n    });\r\n  });\r\n});\r\n"]}

package/lib/esm/test/standalone/ChangeUnifier.test.d.ts

@@ -0,0 +1,2 @@
+import "../TestUtils";
+//# sourceMappingURL=ChangeUnifier.test.d.ts.map

package/lib/esm/test/standalone/ChangeUnifier.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeUnifier.test.d.ts","sourceRoot":"","sources":["../../../../src/test/standalone/ChangeUnifier.test.ts"],"names":[],"mappings":"AAsBA,OAAO,cAAc,CAAC"}