Merge branch 'master' into io-schema-localization

Author: naveedkhan8067

common/api/core-backend.api.md

@@ -5141,6 +5141,7 @@ export class LocalHub {
     queryLocks(): LocksEntry[];
     // (undocumented)
     queryLockStatus(elementId: Id64String): LockStatus;
+    queryNearestCheckpoint(changesetIndex: ChangesetIndex): ChangesetIndex;
     queryPreviousCheckpoint(changesetIndex: ChangesetIndex): ChangesetIndex;
     // (undocumented)
     releaseAllLocks(arg: {

common/changes/@itwin/core-backend/affank-allow-reversing-schema-changes_2026-05-06-16-00.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-backend",
+      "comment": "Allow reversing schema changeset",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-backend"
+}

common/config/azure-pipelines/jobs/version-bump.yaml

@@ -216,6 +216,22 @@ jobs:
         displayName: rush audit
 
       - ${{ if or(eq(parameters.BumpType, 'minor'), eq(parameters.BumpType, 'patch')) }}:
+          - bash: |
+              # Keep this aligned with the version policy used by the release version bump steps below.
+              versionPolicyName=prerelease-monorepo-lockStep
+              currentVersion=$(jq -r --arg policyName "$versionPolicyName" '.[] | select(.policyName == $policyName) | .version' common/config/rush/version-policies.json)
+              if [ -z "$currentVersion" ] || [ "$currentVersion" = "null" ]; then
+                echo "Failed to find version policy '$versionPolicyName' in common/config/rush/version-policies.json" >&2
+                exit 1
+              fi
+              # Deprecation comments require a released minor/patch version like 5.10.0, not a prerelease suffix like 5.10.0-dev.10.
+              # For non-prerelease versions, this parameter expansion leaves the version unchanged.
+              deprecationVersion=${currentVersion%%-*}
+              sed -i "s/\(addVersion: \"\)[^\"]*/\1$deprecationVersion/" common/config/eslint/eslint.config.deprecation-policy.js
+              echo "Using deprecation addVersion=$deprecationVersion from version policy $versionPolicyName"
+              echo "##vso[task.setvariable variable=deprecationVersion]$deprecationVersion"
+            displayName: Sync deprecation policy addVersion to current version
+
           - bash: node common/scripts/install-run-rush.js lint-deprecation
             displayName: rush lint-deprecation
 
@@ -236,7 +252,7 @@ jobs:
             displayName: Determine whether ESLint rule made any changes
 
           - bash: |
-              git commit -m "Apply deprecation date rule"
+              git commit -m "Apply deprecation date rule for v$(deprecationVersion)"
             displayName: Commit deprecation comment changes to release branch
             condition: eq(variables['deprecationCommentChangesMade'], 'true')
 

common/config/rush/pnpm-lock.yaml

@@ -2,7 +2,7 @@
   {
     "policyName": "prerelease-monorepo-lockStep",
     "definitionName": "lockStepVersion",
-    "version": "5.10.0-dev.10",
+    "version": "5.10.0-dev.11",
     "nextBump": "prerelease"
   }
 ]

common/config/rush/version-policies.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "5.10.0-dev.10",
+  "version": "5.10.0-dev.11",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "module": "lib/esm/core-backend.js",
@@ -113,7 +113,7 @@
     "webpack": "^5.97.1"
   },
   "dependencies": {
-    "@bentley/imodeljs-native": "5.10.11",
+    "@bentley/imodeljs-native": "5.10.12",
     "@itwin/object-storage-azure": "^3.0.4",
     "@azure/storage-blob": "^12.28.0",
     "form-data": "^4.0.4",

core/backend/package.json

@@ -430,6 +430,34 @@ export class LocalHub {
     });
   }
 
+  /**
+   * Find the checkpoint nearest to `changesetIndex` (searching both backward and forward).
+   * When the previous and next checkpoints are equidistant, the newer (next) checkpoint is preferred,
+   * which enables the tip-then-reverse download path in [[V2CheckpointManager]].
+   */
+  public queryNearestCheckpoint(changesetIndex: ChangesetIndex): ChangesetIndex {
+    const prev = this.queryPreviousCheckpoint(changesetIndex); // always ≥ 0; returns 0 when none found
+
+    const next: ChangesetIndex | undefined = this.db.withSqliteStatement(
+      "SELECT min(csIndex) FROM checkpoints WHERE csIndex >= ?",
+      (stmt) => {
+        stmt.bindInteger(1, changesetIndex);
+        stmt.step();
+        const val = stmt.getValue(0);
+        return val.isNull ? undefined : val.getInteger();
+      }
+    );
+
+    if (next === undefined) return prev; // no checkpoint at or after requested index
+    if (next === prev) return prev;      // exact match
+
+    // Prefer the newer (next) checkpoint when equidistant so that CheckpointManager
+    // will reverse from a tip checkpoint rather than apply from an old seed.
+    const distPrev = changesetIndex - prev;
+    const distNext = next - changesetIndex;
+    return distNext <= distPrev ? next : prev;
+  }
+
   /** "download" a checkpoint */
   public downloadCheckpoint(arg: { changeset: ChangesetIndexOrId, targetFile: LocalFileName }) {
     const index = this.getIndexFromChangeset(arg.changeset);

core/backend/src/LocalHub.ts

@@ -17,28 +17,40 @@ import { CheckpointProps, DownloadRequest, MockCheckpoint, ProgressFunction, Pro
 import { IModelHost } from "../IModelHost";
 import { IModelJsFs } from "../IModelJsFs";
 import { LocalHub } from "../LocalHub";
-import { TokenArg } from "../IModelDb";
-import { _getHubAccess, _mockCheckpoint, _setHubAccess } from "./Symbols";
+import { SnapshotDb, TokenArg } from "../IModelDb";
+import { _getHubAccess, _mockCheckpoint, _nativeDb, _setHubAccess } from "./Symbols";
 import { BriefcaseManager } from "../BriefcaseManager";
-import * as path from "path";
 
 function wasStarted(val: string | undefined): asserts val is string {
   if (undefined === val)
     throw new Error("Call HubMock.startup first");
 }
 
-function doDownload(args: { iModelId: string, changeset: ChangesetIndexOrId, targetFile: string }) {
+// Used by mockAttach: copies the nearest *prior* checkpoint (never newer) so the
+// returned file is already at or before the requested version.
+function doDownloadPrior(args: { iModelId: string, changeset: ChangesetIndexOrId, targetFile: string }) {
   HubMock.findLocalHub(args.iModelId).downloadCheckpoint(args);
 }
+
+// Used by mockDownload: copies the *nearest* checkpoint (forward or backward).
+// When the nearest is newer than the requested version, CheckpointManager.updateToRequestedVersion
+// will reverse it to the requested version via BriefcaseManager.pullAndApplyChangesets.
+function doDownloadNearest(args: { iModelId: string, changeset: ChangesetIndexOrId, targetFile: string }) {
+  const hub = HubMock.findLocalHub(args.iModelId);
+  const requestedIndex = hub.getIndexFromChangeset(args.changeset);
+  const nearest = hub.queryNearestCheckpoint(requestedIndex);
+  IModelJsFs.copySync(join(hub.checkpointDir, hub.checkpointNameFromIndex(nearest)), args.targetFile);
+}
+
 const mockCheckpoint: MockCheckpoint = {
   mockAttach: (checkpoint: CheckpointProps) => {
-    const targetFile = path.join(BriefcaseManager.getBriefcaseBasePath(checkpoint.iModelId), `${checkpoint.changeset.index}.bim`);
-    doDownload({ ...checkpoint, targetFile })
+    const targetFile = join(BriefcaseManager.getBriefcaseBasePath(checkpoint.iModelId), `${checkpoint.changeset.index}.bim`);
+    doDownloadPrior({ ...checkpoint, targetFile });
     return targetFile;
   },
 
   mockDownload: (request: DownloadRequest) => {
-    doDownload({ ...request.checkpoint, targetFile: request.localFile });
+    doDownloadNearest({ ...request.checkpoint, targetFile: request.localFile });
   }
 };
 
@@ -74,11 +86,22 @@ const mockCheckpoint: MockCheckpoint = {
  *
  * @internal
  */
+/** Options for [[HubMock.startup]]. @internal */
+export interface HubMockStartupOptions {
+  /**
+   * When `true`, every successful [[HubMock.pushChangeset]] call automatically uploads a V1 checkpoint
+   * (the current briefcase `.bim` file) for the tip changeset index into [[LocalHub]].
+   * This lets tests download a tip checkpoint and reverse changesets from it.
+   */
+  createTipCheckpointOnPush?: boolean;
+}
+
 export class HubMock {
   private static mockRoot: LocalDirName | undefined;
   private static hubs = new Map<string, LocalHub>();
   private static _saveHubAccess: BackendHubAccess | undefined;
   private static _iTwinId: GuidString | undefined;
+  private static _createTipCheckpointOnPush = false;
 
   /** Determine whether a test us currently being run under HubMock */
   public static get isValid() { return undefined !== this.mockRoot; }
@@ -92,7 +115,7 @@ export class HubMock {
    * @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.
    */
-  public static startup(mockName: LocalDirName, outputDir: string) {
+  public static startup(mockName: LocalDirName, outputDir: string, options?: HubMockStartupOptions) {
     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");
 
@@ -104,6 +127,7 @@ export class HubMock {
 
     IModelHost[_setHubAccess](this);
     HubMock._iTwinId = Guid.createValue(); // all iModels for this test get the same "iTwinId"
+    this._createTipCheckpointOnPush = options?.createTipCheckpointOnPush ?? false;
 
     V2CheckpointManager[_mockCheckpoint] = mockCheckpoint;
   }
@@ -116,6 +140,7 @@ export class HubMock {
       return;
 
     V2CheckpointManager[_mockCheckpoint] = undefined;
+    this._createTipCheckpointOnPush = false;
 
     HubMock._iTwinId = undefined;
     for (const hub of this.hubs)
@@ -232,7 +257,46 @@ export class HubMock {
   }
 
   public static async pushChangeset(arg: IModelIdArg & { changesetProps: ChangesetFileProps }): Promise<ChangesetIndex> {
-    return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
+    const csIndex = this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
+    if (this._createTipCheckpointOnPush)
+      await this.createTipCheckpoint(arg.iModelId);
+    return csIndex;
+  }
+
+  /**
+   * Build and upload a V1 checkpoint at the current tip changeset of the given iModel.
+   *
+   * The checkpoint is constructed by copying the nearest prior checkpoint from [[LocalHub]] as a
+   * starting base, then applying all subsequent changesets forward to the latest index via
+   * [[BriefcaseManager.pullAndApplyChangesets]].  The result is registered in [[LocalHub]] so that
+   * [[V2CheckpointManager]] (mock path) can serve it to consumers.
+   *
+   * When [[HubMockStartupOptions.createTipCheckpointOnPush]] is `true` this is called automatically
+   * after every successful [[pushChangeset]].  Tests can also call it explicitly to create a single
+   * checkpoint at the tip after all changesets have been pushed.
+   */
+  public static async createTipCheckpoint(iModelId: GuidString): Promise<void> {
+    const hub = this.findLocalHub(iModelId);
+    const csIndex = hub.latestChangesetIndex;
+    // Find the nearest checkpoint that precedes the new tip and use it as the base.
+    const prevIndex = hub.queryPreviousCheckpoint(csIndex);
+    const prevCheckpointFile = join(hub.checkpointDir, hub.checkpointNameFromIndex(prevIndex));
+    const tempFile = join(hub.rootDir, `checkpoint-building-${csIndex}.bim`);
+    IModelJsFs.copySync(prevCheckpointFile, tempFile);
+  try {
+    const db = SnapshotDb.openForApplyChangesets(tempFile);
+    try {
+      await BriefcaseManager.pullAndApplyChangesets(db, { accessToken: "", toIndex: csIndex });
+      db[_nativeDb].saveChanges();
+    } finally {
+      db.close();
+    }
+
+    hub.uploadCheckpoint({ changesetIndex: csIndex, localFile: tempFile });
+  } finally {
+    if (IModelJsFs.existsSync(tempFile))
+      IModelJsFs.removeSync(tempFile);
+  }
   }
 
   public static async queryV2Checkpoint(arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined> {