@itwin/core-backend 3.3.0-dev.9 → 3.4.0-dev.0

package/lib/cjs/GeoCoordConfig.js

@@ -0,0 +1,74 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoCoordConfig = void 0;
+// cspell:ignore customuri
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelHost_1 = require("./IModelHost");
+const SQLiteDb_1 = require("./SQLiteDb");
+const loggerCat = "GeoCoord";
+/** Internal class to configure and load the gcs workspaces for an iModel. */
+class GeoCoordConfig {
+    static addGcsWorkspace(gcsDbAlias) {
+        const ws = IModelHost_1.IModelHost.appWorkspace;
+        const dbProps = ws.resolveDatabase(gcsDbAlias);
+        const containerProps = ws.resolveContainer(dbProps.containerName);
+        const account = ws.resolveAccount(containerProps.accountName);
+        containerProps.syncOnConnect = true;
+        try {
+            const container = ws.getContainer(containerProps, account);
+            const cloudContainer = container.cloudContainer;
+            if (!(cloudContainer === null || cloudContainer === void 0 ? void 0 : cloudContainer.isConnected)) {
+                core_bentley_1.Logger.logInfo("GeoCoord", `could not load gcs database "${gcsDbAlias}"`);
+                return;
+            }
+            const gcsDbName = container.resolveDbFileName(dbProps);
+            const gcsDbProps = cloudContainer.queryDatabase(gcsDbName);
+            if (undefined === gcsDbProps)
+                throw new Error(`database "${gcsDbName}" not found in container "${containerProps.containerId}"`);
+            if (!IModelHost_1.IModelHost.platform.addGcsWorkspaceDb(gcsDbName, cloudContainer, dbProps.priority))
+                return; // already had this db
+            if (IModelHost_1.IModelHost.appWorkspace.settings.getBoolean("gcs/noLocalData", false))
+                IModelHost_1.IModelHost.platform.enableLocalGcsFiles(false);
+            core_bentley_1.Logger.logInfo(loggerCat, `loaded gcsDb "${gcsDbName}", from "${account.accessName}${containerProps.containerId}" size=${gcsDbProps.totalBlocks}, local=${gcsDbProps.localBlocks}`);
+            if (true === dbProps.prefetch)
+                SQLiteDb_1.SQLiteDb.startCloudPrefetch(cloudContainer, gcsDbName);
+        }
+        catch (e) {
+            core_bentley_1.Logger.logError(loggerCat, `Cannot load GCS workspace: ${core_bentley_1.BentleyError.getErrorMessage(e)}, account=${account.accessName}`);
+        }
+    }
+    static loadAll(settings, settingName) {
+        settings.resolveSetting(settingName, (val) => {
+            if (Array.isArray(val)) {
+                for (const entry of val) {
+                    if (typeof entry === "string")
+                        this.addGcsWorkspace(entry);
+                }
+            }
+            return undefined; // keep going through all dictionaries
+        });
+    }
+    static onStartup() {
+        this._defaultDbsLoaded = false;
+    }
+    static loadDefaultDatabases() {
+        if (!this._defaultDbsLoaded) {
+            this._defaultDbsLoaded = true;
+            this.loadAll(IModelHost_1.IModelHost.appWorkspace.settings, "gcs/default/databases");
+        }
+    }
+    static loadForImodel(settings) {
+        this.loadDefaultDatabases();
+        this.loadAll(settings, "gcs/databases");
+    }
+}
+exports.GeoCoordConfig = GeoCoordConfig;
+GeoCoordConfig._defaultDbsLoaded = false;
+//# sourceMappingURL=GeoCoordConfig.js.map

package/lib/cjs/GeoCoordConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeoCoordConfig.js","sourceRoot":"","sources":["../../src/GeoCoordConfig.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0BAA0B;AAE1B,sDAA2D;AAC3D,6CAA0C;AAC1C,yCAAsC;AAItC,MAAM,SAAS,GAAG,UAAU,CAAC;AAO7B,6EAA6E;AAC7E,MAAa,cAAc;IAEjB,MAAM,CAAC,eAAe,CAAC,UAAkB;QAC/C,MAAM,EAAE,GAAG,uBAAU,CAAC,YAAY,CAAC;QACnC,MAAM,OAAO,GAAG,EAAE,CAAC,eAAe,CAAC,UAAU,CAAe,CAAC;QAC7D,MAAM,cAAc,GAAG,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAClE,MAAM,OAAO,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC9D,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;QACpC,IAAI;YACF,MAAM,SAAS,GAAG,EAAE,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;YAChD,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,CAAA,EAAE;gBAChC,qBAAM,CAAC,OAAO,CAAC,UAAU,EAAE,gCAAgC,UAAU,GAAG,CAAC,CAAC;gBAC1E,OAAO;aACR;YAED,MAAM,SAAS,GAAG,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;YAC3D,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,KAAK,CAAC,aAAa,SAAS,6BAA6B,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC;YAEpG,IAAI,CAAC,uBAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC;gBACrF,OAAO,CAAC,sBAAsB;YAEhC,IAAI,uBAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,KAAK,CAAC;gBACvE,uBAAU,CAAC,QAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAEjD,qBAAM,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,SAAS,YAAY,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,WAAW,UAAU,UAAU,CAAC,WAAW,WAAW,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;YAEpL,IAAI,IAAI,KAAK,OAAO,CAAC,QAAQ;gBAC3B,mBAAQ,CAAC,kBAAkB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;SAE1D;QAAC,OAAO,CAAU,EAAE;YACnB,qBAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,8BAA8B,2BAAY,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;SAC5H;IACH,CAAC;IAEO,MAAM,CAAC,OAAO,CAAC,QAAkB,EAAE,WAAmB;QAC5D,QAAQ,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;iBAC/B;aACF;YACD,OAAO,SAAS,CAAC,CAAC,sCAAsC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAGM,MAAM,CAAC,SAAS;QACrB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,oBAAoB;QAChC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,uBAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;SACzE;IACH,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,QAAkB;QAC5C,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC1C,CAAC;;AAhEH,wCAiEC;AAhBgB,gCAAiB,GAAG,KAAK,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/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\n// cspell:ignore customuri\r\n\r\nimport { BentleyError, Logger } from \"@itwin/core-bentley\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\nimport { Settings } from \"./workspace/Settings\";\r\nimport { WorkspaceContainer, WorkspaceDb } from \"./workspace/Workspace\";\r\n\r\nconst loggerCat = \"GeoCoord\";\r\n\r\ninterface GcsDbProps extends WorkspaceDb.Props, WorkspaceContainer.Alias {\r\n  prefetch?: boolean;\r\n  priority?: number;\r\n}\r\n\r\n/** Internal class to configure and load the gcs workspaces for an iModel. */\r\nexport class GeoCoordConfig {\r\n\r\n  private static addGcsWorkspace(gcsDbAlias: string) {\r\n    const ws = IModelHost.appWorkspace;\r\n    const dbProps = ws.resolveDatabase(gcsDbAlias) as GcsDbProps;\r\n    const containerProps = ws.resolveContainer(dbProps.containerName);\r\n    const account = ws.resolveAccount(containerProps.accountName);\r\n    containerProps.syncOnConnect = true;\r\n    try {\r\n      const container = ws.getContainer(containerProps, account);\r\n      const cloudContainer = container.cloudContainer;\r\n      if (!cloudContainer?.isConnected) {\r\n        Logger.logInfo(\"GeoCoord\", `could not load gcs database \"${gcsDbAlias}\"`);\r\n        return;\r\n      }\r\n\r\n      const gcsDbName = container.resolveDbFileName(dbProps);\r\n      const gcsDbProps = cloudContainer.queryDatabase(gcsDbName);\r\n      if (undefined === gcsDbProps)\r\n        throw new Error(`database \"${gcsDbName}\" not found in container \"${containerProps.containerId}\"`);\r\n\r\n      if (!IModelHost.platform.addGcsWorkspaceDb(gcsDbName, cloudContainer, dbProps.priority))\r\n        return; // already had this db\r\n\r\n      if (IModelHost.appWorkspace.settings.getBoolean(\"gcs/noLocalData\", false))\r\n        IModelHost.platform.enableLocalGcsFiles(false);\r\n\r\n      Logger.logInfo(loggerCat, `loaded gcsDb \"${gcsDbName}\", from \"${account.accessName}${containerProps.containerId}\" size=${gcsDbProps.totalBlocks}, local=${gcsDbProps.localBlocks}`);\r\n\r\n      if (true === dbProps.prefetch)\r\n        SQLiteDb.startCloudPrefetch(cloudContainer, gcsDbName);\r\n\r\n    } catch (e: unknown) {\r\n      Logger.logError(loggerCat, `Cannot load GCS workspace: ${BentleyError.getErrorMessage(e)}, account=${account.accessName}`);\r\n    }\r\n  }\r\n\r\n  private static loadAll(settings: Settings, settingName: string) {\r\n    settings.resolveSetting(settingName, (val) => {\r\n      if (Array.isArray(val)) {\r\n        for (const entry of val) {\r\n          if (typeof entry === \"string\")\r\n            this.addGcsWorkspace(entry);\r\n        }\r\n      }\r\n      return undefined; // keep going through all dictionaries\r\n    });\r\n  }\r\n\r\n  private static _defaultDbsLoaded = false;\r\n  public static onStartup() {\r\n    this._defaultDbsLoaded = false;\r\n  }\r\n\r\n  public static loadDefaultDatabases(): void {\r\n    if (!this._defaultDbsLoaded) {\r\n      this._defaultDbsLoaded = true;\r\n      this.loadAll(IModelHost.appWorkspace.settings, \"gcs/default/databases\");\r\n    }\r\n  }\r\n\r\n  public static loadForImodel(settings: Settings) {\r\n    this.loadDefaultDatabases();\r\n    this.loadAll(settings, \"gcs/databases\");\r\n  }\r\n}\r\n"]}

package/lib/cjs/HubMock.d.ts

@@ -0,0 +1,94 @@
+import { GuidString } from "@itwin/core-bentley";
+import { ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName } from "@itwin/core-common";
+import { AcquireNewBriefcaseIdArg, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, CheckpointArg, CreateNewIModelProps, DownloadChangesetArg, DownloadChangesetRangeArg, IModelIdArg, IModelNameArg, LockMap, LockProps, V2CheckpointAccessProps } from "./BackendHubAccess";
+import { CheckpointProps } from "./CheckpointManager";
+import { LocalHub } from "./LocalHub";
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+export declare class HubMock {
+    private static mockRoot;
+    private static hubs;
+    private static _saveHubAccess;
+    private static _iTwinId;
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid(): boolean;
+    static get iTwinId(): string;
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName: LocalDirName, outputDir: string): void;
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown(): void;
+    static findLocalHub(iModelId: GuidString): LocalHub;
+    /** create a [[LocalHub]] for an iModel.  */
+    static createNewIModel(arg: CreateNewIModelProps): Promise<GuidString>;
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId: GuidString): void;
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static getChangesetFromNamedVersion(arg: IModelIdArg & {
+        versionName: string;
+    }): Promise<ChangesetProps>;
+    private static changesetIndexFromArg;
+    static getChangesetFromVersion(arg: IModelIdArg & {
+        version: IModelVersion;
+    }): Promise<ChangesetProps>;
+    static getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps>;
+    private static getAccessToken;
+    static getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]>;
+    static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number>;
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static releaseBriefcase(arg: BriefcaseIdArg): Promise<void>;
+    static downloadChangeset(arg: DownloadChangesetArg): Promise<ChangesetFileProps>;
+    static downloadChangesets(arg: DownloadChangesetRangeArg): Promise<ChangesetFileProps[]>;
+    static queryChangeset(arg: ChangesetArg): Promise<ChangesetProps>;
+    static queryChangesets(arg: IModelIdArg & {
+        range?: ChangesetRange;
+    }): Promise<ChangesetProps[]>;
+    static pushChangeset(arg: IModelIdArg & {
+        changesetProps: ChangesetFileProps;
+    }): Promise<ChangesetIndex>;
+    static queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined>;
+    static downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId>;
+    static releaseAllLocks(arg: BriefcaseDbArg): Promise<void>;
+    static queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]>;
+    static acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void>;
+    static queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined>;
+    static deleteIModel(arg: IModelIdArg & {
+        iTwinId: GuidString;
+    }): Promise<void>;
+}
+//# sourceMappingURL=HubMock.d.ts.map

package/lib/cjs/HubMock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubMock.d.ts","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EACrH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,wBAAwB,EACN,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,WAAW,EAAE,aAAa,EAChL,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAC5C,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAClD,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,OAAO,CAAC,MAAM,CAAC,cAAc,CAA+B;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyB;IAEhD,oEAAoE;IACpE,WAAkB,OAAO,YAA0C;IAEnE,WAAkB,OAAO,WAIxB;IAED;;;;OAIG;WACW,OAAO,CAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM;IAc/D;;OAEG;WACW,QAAQ;WAiBR,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,QAAQ;IAO1D,4CAA4C;WACxB,eAAe,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAUnF,4CAA4C;WAC9B,OAAO,CAAC,QAAQ,EAAE,UAAU;IAK1C,wEAAwE;WAEpD,4BAA4B,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrH,OAAO,CAAC,MAAM,CAAC,qBAAqB;WAIhB,uBAAuB,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAiB/F,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;mBAI5D,cAAc;WAIf,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;WAKtD,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzF,gHAAgH;WAC5F,gBAAgB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;WAIpD,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAIzE,kBAAkB,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;WAIjF,cAAc,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;WAI1D,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,KAAK,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;WAIzF,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAIjG,iBAAiB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;WAKtF,oBAAoB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;WAItE,eAAe,CAAC,GAAG,EAAE,cAAc;WAKnC,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;WAIzD,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;WAIhE,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;WAStE,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5F"}

package/lib/cjs/HubMock.js

@@ -0,0 +1,191 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubMock = void 0;
+const path_1 = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelHost_1 = require("./IModelHost");
+const IModelJsFs_1 = require("./IModelJsFs");
+const LocalHub_1 = require("./LocalHub");
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+class HubMock {
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid() { return undefined !== this.mockRoot; }
+    static get iTwinId() {
+        if (undefined === this._iTwinId)
+            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
+        return this._iTwinId;
+    }
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName, outputDir) {
+        if (this.isValid)
+            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
+        this.hubs.clear();
+        this.mockRoot = (0, path_1.join)(outputDir, "HubMock", mockName);
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this.mockRoot);
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        this._saveHubAccess = IModelHost_1.IModelHost.getHubAccess();
+        IModelHost_1.IModelHost.setHubAccess(this);
+        HubMock._iTwinId = core_bentley_1.Guid.createValue(); // all iModels for this test get the same "iTwinId"
+    }
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown() {
+        if (!this.isValid)
+            return;
+        HubMock._iTwinId = undefined;
+        for (const hub of this.hubs)
+            hub[1].cleanup();
+        this.hubs.clear();
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        IModelJsFs_1.IModelJsFs.removeSync(this.mockRoot);
+        IModelHost_1.IModelHost.setHubAccess(this._saveHubAccess);
+        this.mockRoot = undefined;
+    }
+    static findLocalHub(iModelId) {
+        const hub = this.hubs.get(iModelId);
+        if (!hub)
+            throw new Error(`local hub for iModel ${iModelId} not created`);
+        return hub;
+    }
+    /** create a [[LocalHub]] for an iModel.  */
+    static async createNewIModel(arg) {
+        if (!this.mockRoot)
+            throw new Error("call startup first");
+        const props = { ...arg, iModelId: core_bentley_1.Guid.createValue() };
+        const mock = new LocalHub_1.LocalHub((0, path_1.join)(this.mockRoot, props.iModelId), props);
+        this.hubs.set(props.iModelId, mock);
+        return props.iModelId;
+    }
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId) {
+        this.findLocalHub(iModelId).cleanup();
+        this.hubs.delete(iModelId);
+    }
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static async getChangesetFromNamedVersion(arg) {
+        return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);
+    }
+    static changesetIndexFromArg(arg) {
+        return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);
+    }
+    static async getChangesetFromVersion(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        const version = arg.version;
+        if (version.isFirst)
+            return hub.getChangesetByIndex(0);
+        const asOf = version.getAsOfChangeSet();
+        if (asOf)
+            return hub.getChangesetById(asOf);
+        const versionName = version.getName();
+        if (versionName)
+            return hub.findNamedVersion(versionName);
+        return hub.getLatestChangeset();
+    }
+    static async getLatestChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getLatestChangeset();
+    }
+    static async getAccessToken(arg) {
+        var _a;
+        return (_a = arg.accessToken) !== null && _a !== void 0 ? _a : await IModelHost_1.IModelHost.getAccessToken();
+    }
+    static async getMyBriefcaseIds(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);
+    }
+    static async acquireNewBriefcaseId(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);
+    }
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static async releaseBriefcase(arg) {
+        return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);
+    }
+    static async downloadChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });
+    }
+    static async downloadChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });
+    }
+    static async queryChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));
+    }
+    static async queryChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);
+    }
+    static async pushChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
+    }
+    static async queryV2Checkpoint(_arg) {
+        return undefined;
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    static async downloadV1Checkpoint(arg) {
+        return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });
+    }
+    static async releaseAllLocks(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });
+    }
+    static async queryAllLocks(_arg) {
+        return [];
+    }
+    static async acquireLocks(arg, locks) {
+        this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);
+    }
+    static async queryIModelByName(arg) {
+        for (const hub of this.hubs) {
+            const localHub = hub[1];
+            if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)
+                return localHub.iModelId;
+        }
+        return undefined;
+    }
+    static async deleteIModel(arg) {
+        return this.destroy(arg.iModelId);
+    }
+}
+exports.HubMock = HubMock;
+HubMock.hubs = new Map();
+//# sourceMappingURL=HubMock.js.map

package/lib/cjs/HubMock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubMock.js","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,+BAA4B;AAC5B,sDAAuD;AAUvD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,OAAO;IAMlB,oEAAoE;IAC7D,MAAM,KAAK,OAAO,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE5D,MAAM,KAAK,OAAO;QACvB,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAC9K,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAsB,EAAE,SAAiB;QAC7D,IAAI,IAAI,CAAC,OAAO;YACd,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAE9K,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,uBAAU,CAAC,YAAY,EAAE,CAAC;QAEhD,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,QAAQ,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,mDAAmD;IAC5F,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO;QAET,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,oEAAoE;QACpE,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;QACxC,oEAAoE;QACpE,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;QACtC,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAoB;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,cAAc,CAAC,CAAC;QAClE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAyB;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAExC,MAAM,KAAK,GAAG,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,mBAAQ,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,wEAAwE;IAEjE,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAA0C;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,GAAiB;QACpD,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAA6C;QACvF,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,IAAI,OAAO,CAAC,OAAO;YACjB,OAAO,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACxC,IAAI,IAAI;YACN,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,WAAW;YACb,OAAO,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE3C,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAClC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAgB;QACrD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9D,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAa;;QAC/C,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAgB;QACpD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAChG,CAAC;IAED,gHAAgH;IACzG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAmB;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAyB;QAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IACjI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAA8B;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAiB;QAClD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAA6C;QAC/E,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,GAAyD;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAqB;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAkB;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAmB;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,GAAG,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAoB;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAmB,EAAE,KAAc;QAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,QAAQ,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU;gBAC5E,OAAO,QAAQ,CAAC,QAAQ,CAAC;SAC5B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAA0C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;;AArLH,0BAsLC;AApLgB,YAAI,GAAG,IAAI,GAAG,EAAoB,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 { join } from \"path\";\r\nimport { Guid, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName,\r\n} from \"@itwin/core-common\";\r\nimport {\r\n  AcquireNewBriefcaseIdArg,\r\n  BackendHubAccess, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, CheckpointArg, CreateNewIModelProps, DownloadChangesetArg, DownloadChangesetRangeArg, IModelIdArg, IModelNameArg,\r\n  LockMap, LockProps, V2CheckpointAccessProps,\r\n} from \"./BackendHubAccess\";\r\nimport { CheckpointProps } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { LocalHub } from \"./LocalHub\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\n/**\r\n * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.\r\n *\r\n * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:\r\n * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs\r\n * - waste network and data center resources (i.e. $$$s),\r\n * - interfere with other tests running on the same or other systems, and\r\n * - (far worse) are the source of test flakiness outside of the api being tested.\r\n *\r\n * This class can be used to create tests that do not require authentication, are synchronous,\r\n * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside\r\n * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.\r\n *\r\n * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests\r\n * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to\r\n * low level testing of the core apis only.\r\n *\r\n * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be\r\n * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean\r\n * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the\r\n * test against a \"real\" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your\r\n * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)\r\n *\r\n * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.\r\n * They use mock (aka \"bogus\") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current\r\n * computer.\r\n *\r\n * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests\r\n * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.\r\n *\r\n * @internal\r\n */\r\nexport class HubMock {\r\n  private static mockRoot: LocalDirName | undefined;\r\n  private static hubs = new Map<string, LocalHub>();\r\n  private static _saveHubAccess: BackendHubAccess | undefined;\r\n  private static _iTwinId: GuidString | undefined;\r\n\r\n  /** Determine whether a test us currently being run under HubMock */\r\n  public static get isValid() { return undefined !== this.mockRoot; }\r\n\r\n  public static get iTwinId() {\r\n    if (undefined === this._iTwinId)\r\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\r\n    return this._iTwinId;\r\n  }\r\n\r\n  /**\r\n   * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].\r\n   * @param mockName a unique name (e.g. \"MyTest\") for this HubMock to disambiguate tests when more than one is simultaneously active.\r\n   * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.\r\n   */\r\n  public static startup(mockName: LocalDirName, outputDir: string) {\r\n    if (this.isValid)\r\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\r\n\r\n    this.hubs.clear();\r\n    this.mockRoot = join(outputDir, \"HubMock\", mockName);\r\n    IModelJsFs.recursiveMkDirSync(this.mockRoot);\r\n    IModelJsFs.purgeDirSync(this.mockRoot);\r\n    this._saveHubAccess = IModelHost.getHubAccess();\r\n\r\n    IModelHost.setHubAccess(this);\r\n    HubMock._iTwinId = Guid.createValue(); // all iModels for this test get the same \"iTwinId\"\r\n  }\r\n\r\n  /** Stop a HubMock that was previously started with [[startup]]\r\n   * @note this function throws an exception if any of the iModels used during the tests are left open.\r\n   */\r\n  public static shutdown() {\r\n    if (!this.isValid)\r\n      return;\r\n\r\n    HubMock._iTwinId = undefined;\r\n    for (const hub of this.hubs)\r\n      hub[1].cleanup();\r\n\r\n    this.hubs.clear();\r\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n    IModelJsFs.purgeDirSync(this.mockRoot!);\r\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n    IModelJsFs.removeSync(this.mockRoot!);\r\n    IModelHost.setHubAccess(this._saveHubAccess);\r\n    this.mockRoot = undefined;\r\n  }\r\n\r\n  public static findLocalHub(iModelId: GuidString): LocalHub {\r\n    const hub = this.hubs.get(iModelId);\r\n    if (!hub)\r\n      throw new Error(`local hub for iModel ${iModelId} not created`);\r\n    return hub;\r\n  }\r\n\r\n  /** create a [[LocalHub]] for an iModel.  */\r\n  public static async createNewIModel(arg: CreateNewIModelProps): Promise<GuidString> {\r\n    if (!this.mockRoot)\r\n      throw new Error(\"call startup first\");\r\n\r\n    const props = { ...arg, iModelId: Guid.createValue() };\r\n    const mock = new LocalHub(join(this.mockRoot, props.iModelId), props);\r\n    this.hubs.set(props.iModelId, mock);\r\n    return props.iModelId;\r\n  }\r\n\r\n  /** remove the [[LocalHub]] for an iModel */\r\n  public static destroy(iModelId: GuidString) {\r\n    this.findLocalHub(iModelId).cleanup();\r\n    this.hubs.delete(iModelId);\r\n  }\r\n\r\n  /** All methods below are mocks of the [[BackendHubAccess]] interface */\r\n\r\n  public static async getChangesetFromNamedVersion(arg: IModelIdArg & { versionName: string }): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);\r\n  }\r\n\r\n  private static changesetIndexFromArg(arg: ChangesetArg) {\r\n    return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);\r\n  }\r\n\r\n  public static async getChangesetFromVersion(arg: IModelIdArg & { version: IModelVersion }): Promise<ChangesetProps> {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    const version = arg.version;\r\n    if (version.isFirst)\r\n      return hub.getChangesetByIndex(0);\r\n\r\n    const asOf = version.getAsOfChangeSet();\r\n    if (asOf)\r\n      return hub.getChangesetById(asOf);\r\n\r\n    const versionName = version.getName();\r\n    if (versionName)\r\n      return hub.findNamedVersion(versionName);\r\n\r\n    return hub.getLatestChangeset();\r\n  }\r\n\r\n  public static async getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getLatestChangeset();\r\n  }\r\n\r\n  private static async getAccessToken(arg: TokenArg) {\r\n    return arg.accessToken ?? await IModelHost.getAccessToken();\r\n  }\r\n\r\n  public static async getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);\r\n  }\r\n\r\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);\r\n  }\r\n\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  public static async releaseBriefcase(arg: BriefcaseIdArg): Promise<void> {\r\n    return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);\r\n  }\r\n\r\n  public static async downloadChangeset(arg: DownloadChangesetArg): Promise<ChangesetFileProps> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async downloadChangesets(arg: DownloadChangesetRangeArg): Promise<ChangesetFileProps[]> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async queryChangeset(arg: ChangesetArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));\r\n  }\r\n\r\n  public static async queryChangesets(arg: IModelIdArg & { range?: ChangesetRange }): Promise<ChangesetProps[]> {\r\n    return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);\r\n  }\r\n\r\n  public static async pushChangeset(arg: IModelIdArg & { changesetProps: ChangesetFileProps }): Promise<ChangesetIndex> {\r\n    return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);\r\n  }\r\n\r\n  public static async queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined> {\r\n    return undefined;\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public static async downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId> {\r\n    return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });\r\n  }\r\n\r\n  public static async releaseAllLocks(arg: BriefcaseDbArg) {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });\r\n  }\r\n\r\n  public static async queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]> {\r\n    return [];\r\n  }\r\n\r\n  public static async acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void> {\r\n    this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);\r\n  }\r\n\r\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\r\n    for (const hub of this.hubs) {\r\n      const localHub = hub[1];\r\n      if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)\r\n        return localHub.iModelId;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public static async deleteIModel(arg: IModelIdArg & { iTwinId: GuidString }): Promise<void> {\r\n    return this.destroy(arg.iModelId);\r\n  }\r\n}\r\n"]}

package/lib/cjs/IModelDb.d.ts

@@ -3,7 +3,7 @@
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
 import { AccessToken, BeEvent, DbResult, GuidString, Id64Arg, Id64Array, Id64Set, Id64String, IModelStatus, OpenMode } from "@itwin/core-bentley";
-import { AxisAlignedBox3d, BRepGeometryCreate, BriefcaseId, ChangesetIdWithIndex, Code, CodeSpec, CreateEmptySnapshotIModelProps, CreateEmptyStandaloneIModelProps, CreateSnapshotIModelProps, EcefLocation, ECSqlReader, ElementAspectProps, ElementGeometryRequest, ElementGraphicsRequestProps, ElementLoadProps, ElementProps, EntityMetaData, EntityProps, EntityQueryParams, FilePropertyProps, FontId, FontMap, FontType, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, IModel, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelTileTreeProps, LocalFileName, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelLoadProps, ModelProps, OpenBriefcaseProps, PropertyCallback, QueryBinder, QueryOptions, RpcActivity, SchemaState, SnapRequestProps, SnapResponseProps, SnapshotOpenOptions, StandaloneOpenOptions, TextureData, TextureLoadProps, ThumbnailProps, UpgradeOptions, ViewDefinitionProps, ViewQueryParams, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
+import { AxisAlignedBox3d, BRepGeometryCreate, BriefcaseId, ChangesetIdWithIndex, Code, CodeSpec, CreateEmptySnapshotIModelProps, CreateEmptyStandaloneIModelProps, CreateSnapshotIModelProps, EcefLocation, ECSqlReader, ElementAspectProps, ElementGeometryRequest, ElementGraphicsRequestProps, ElementLoadProps, ElementProps, EntityMetaData, EntityProps, EntityQueryParams, FilePropertyProps, FontId, FontMap, FontType, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, IModel, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelTileTreeProps, LocalFileName, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelLoadProps, ModelProps, OpenBriefcaseProps, PropertyCallback, QueryBinder, QueryOptions, SchemaState, SnapRequestProps, SnapResponseProps, SnapshotOpenOptions, TextureData, TextureLoadProps, ThumbnailProps, UpgradeOptions, ViewDefinitionProps, ViewQueryParams, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
 import { Range3d } from "@itwin/core-geometry";
 import { PullChangesArgs, PushChangesArgs } from "./BriefcaseManager";
 import { CheckpointProps } from "./CheckpointManager";
@@ -21,6 +21,7 @@ import { TxnManager } from "./TxnManager";
 import { ViewDefinition } from "./ViewDefinition";
 import { SettingDictionary } from "./workspace/Settings";
 import { Workspace } from "./workspace/Workspace";
+import { SQLiteDb } from "./SQLiteDb";
 /** Options for [[IModelDb.Models.updateModel]]
  * @note To mark *only* the geometry as changed, use [[IModelDb.Models.updateGeometryGuid]] instead.
  * @public
@@ -135,7 +136,7 @@ export declare abstract class IModelDb extends IModel {
     private _classMetaDataRegistry?;
     protected _fontMap?: FontMap;
     /** @internal */
-    protected _workspace: Workspace;
+    private _workspace?;
     private readonly _snaps;
     private static _shutdownListener;
     /** @internal */
@@ -193,7 +194,7 @@ export declare abstract class IModelDb extends IModel {
     /** Close this IModel, if it is currently open. */
     close(): void;
     /** @internal */
-    reattachDaemon(_accessToken: AccessToken): Promise<void>;
+    refreshContainerSas(_userAccessToken: AccessToken): Promise<void>;
     /** Event called when the iModel is about to be closed. */
     readonly onBeforeClose: BeEvent<() => void>;
     /**
@@ -424,7 +425,7 @@ export declare abstract class IModelDb extends IModel {
     static openDgnDb(file: {
         path: LocalFileName;
         key?: string;
-    }, openMode: OpenMode, upgradeOptions?: UpgradeOptions, props?: SnapshotOpenOptions): IModelJsNative.DgnDb;
+    }, openMode: OpenMode, upgradeOptions?: UpgradeOptions, props?: SnapshotOpenOptions & CloudContainerArgs): IModelJsNative.DgnDb;
     /**
      * Determines if the schemas in the Db must or can be upgraded by comparing them with those included in the
      * current version of the software.
@@ -730,7 +731,7 @@ export declare namespace IModelDb {
          */
         getElementJson<T extends ElementProps>(elementId: ElementLoadProps): T;
         /** Read element data from the iModel as JSON
-         * @param elementIdArg a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
+         * @param loadProps - a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
          * @returns The JSON properties of the element or `undefined` if the element is not found.
          * @throws [[IModelError]] if the element exists, but cannot be loaded.
          * @see getElementJson
@@ -937,13 +938,23 @@ export interface TokenArg {
     /** If present, the access token for the requested operation. If not present, use [[IModelHost.getAccessToken]] */
     readonly accessToken?: AccessToken;
 }
+/** Augments a [[SnapshotDbOpenArgs]] or [[OpenBriefcaseArgs]] with a [CloudContainer]($docs/learning/backend/Workspace.md).
+ * The properties are this interface are reserved for internal use only.
+ * @public
+ */
+export interface CloudContainerArgs {
+    /** @internal */
+    container?: SQLiteDb.CloudContainer;
+}
+/** Options to open a [SnapshotDb]($backend).
+ * @public
+ */
+export declare type SnapshotDbOpenArgs = SnapshotOpenOptions & CloudContainerArgs;
 /**
  * Arguments to open a BriefcaseDb
  * @public
  */
-export declare type OpenBriefcaseArgs = OpenBriefcaseProps & {
-    rpcActivity?: RpcActivity;
-};
+export declare type OpenBriefcaseArgs = OpenBriefcaseProps & CloudContainerArgs;
 /**
  * A local copy of an iModel from iModelHub that can pull and potentially push changesets.
  * BriefcaseDb raises a set of events to allow apps and subsystems to track its object life cycle, including [[onOpen]] and [[onOpened]].
@@ -1023,7 +1034,7 @@ export declare class BriefcaseDb extends IModelDb {
  */
 export declare class SnapshotDb extends IModelDb {
     get isSnapshot(): boolean;
-    private _daemonReattach;
+    private _refreshSas;
     private _createClassViewsOnClose?;
     private constructor();
     static findByKey(key: string): SnapshotDb;
@@ -1050,14 +1061,14 @@ export declare class SnapshotDb extends IModelDb {
     /** open this SnapshotDb read/write, strictly to apply incoming changesets. Used for creating new checkpoints.
      * @internal
      */
-    static openForApplyChangesets(path: LocalFileName, props?: SnapshotOpenOptions): SnapshotDb;
+    static openForApplyChangesets(path: LocalFileName, props?: SnapshotDbOpenArgs): SnapshotDb;
     /** Open a read-only iModel *snapshot*.
      * @param path the full path of the snapshot iModel file to open.
      * @param props options for opening snapshot
      * @see [[close]]
      * @throws [[IModelError]] If the file is not found or is not a valid *snapshot*.
      */
-    static openFile(path: LocalFileName, opts?: SnapshotOpenOptions): SnapshotDb;
+    static openFile(path: LocalFileName, opts?: SnapshotDbOpenArgs): SnapshotDb;
     /** Open a previously downloaded V1 checkpoint file.
      * @note The key is generated by this call is predictable and is formed from the IModelId and ChangeSetId.
      * This is so every backend working on the same checkpoint will use the same key, to permit multiple backends
@@ -1068,17 +1079,17 @@ export declare class SnapshotDb extends IModelDb {
     /** Open a V2 *checkpoint*, a special form of snapshot iModel that represents a read-only snapshot of an iModel from iModelHub at a particular point in time.
      * > Note: The checkpoint daemon must already be running and a checkpoint must already exist in iModelHub's storage *before* this function is called.
      * @param checkpoint The checkpoint to open
-     * @note The key is generated by this call is predictable and is formed from the IModelId and ChangeSetId.
+     * @note The key generated by this call is predictable and is formed from the IModelId and ChangeSetId.
      * This is so every backend working on the same checkpoint will use the same key, to permit multiple backends
      * servicing the same checkpoint.
      * @throws [[IModelError]] If the checkpoint is not found in iModelHub or the checkpoint daemon is not supported in the current environment.
      * @internal
      */
     static openCheckpointV2(checkpoint: CheckpointProps): Promise<SnapshotDb>;
-    /** Used to refresh the daemon's accessToken if this is a V2 checkpoint.
+    /** Used to refresh the container sasToken using the current user's accessToken
      * @internal
      */
-    reattachDaemon(accessToken: AccessToken): Promise<void>;
+    refreshContainerSas(userAccessToken: AccessToken): Promise<void>;
     /** @internal */
     beforeClose(): void;
 }
@@ -1123,6 +1134,6 @@ export declare class StandaloneDb extends BriefcaseDb {
      * @throws [[IModelError]] if the file is not a standalone iModel.
      * @see [BriefcaseConnection.openStandalone]($frontend) to open a StandaloneDb from the frontend
      */
-    static openFile(filePath: LocalFileName, openMode?: OpenMode, options?: StandaloneOpenOptions): StandaloneDb;
+    static openFile(filePath: LocalFileName, openMode?: OpenMode, options?: SnapshotDbOpenArgs): StandaloneDb;
 }
 //# sourceMappingURL=IModelDb.d.ts.map