@foss.global/gitmanager 1.7.1 → 2.1.0

package/ts/rust-gitmanager-bridge.ts

@@ -1,5 +1,7 @@
 import * as plugins from './plugins.js';
+import { GitManagerError, isGitManagerErrorCode } from './classes.gitmanagererror.js';
 import type {
+  IGitManagerAncestryRequest,
   IGitManagerCommitDetail,
   IGitManagerCommitRequest,
   IGitManagerCommitSummary,
@@ -13,7 +15,6 @@ import type {
   IGitManagerMergeRequest,
   IGitManagerMergeResult,
   IGitManagerReadFileRequest,
-  IGitManagerRef,
   IGitManagerRefRequest,
   IGitManagerProtectedRefsApplyResult,
   IGitManagerSmartHttpRepositoryProtectedRefs,
@@ -34,6 +35,7 @@ import type {
   IGitManagerTreeEntry,
   IGitManagerTreeRequest,
   IRustGitManagerConfig,
+  TGitManagerRefInventoryResult,
   IRustGitManagerRepositoryServiceDescriptor,
 } from './models.js';
 
@@ -69,11 +71,12 @@ type TGitManagerCommands = {
   prepareRepositoryService: { params: IGitManagerRepositoryServiceRequest; result: IRustGitManagerRepositoryServiceDescriptor };
   restoreRepositoryBundle: { params: IGitManagerRestoreBundleRequest; result: IGitManagerRepositoryInfo };
   listRepositories: { params: Record<string, never>; result: IGitManagerRepositoryInfo[] };
-  listRefs: { params: IGitManagerRefRequest; result: IGitManagerRef[] };
+  listRefs: { params: IGitManagerRefRequest; result: TGitManagerRefInventoryResult };
   listRepositoryLfsPointers: { params: IGitManagerRepositorySelector; result: IGitManagerRepositoryLfsPointer[] };
   mergeRepository: { params: IGitManagerMergeRequest; result: IGitManagerMergeResult };
   listTree: { params: IGitManagerTreeRequest; result: IGitManagerTreeEntry[] };
   readFile: { params: IGitManagerReadFileRequest; result: IGitManagerFileContent };
+  isAncestor: { params: IGitManagerAncestryRequest; result: boolean };
   listCommits: { params: IGitManagerListCommitsRequest; result: IGitManagerCommitSummary[] };
   getCommit: { params: IGitManagerCommitRequest; result: IGitManagerCommitDetail };
   getDiff: { params: IGitManagerDiffRequest; result: IGitManagerDiff };
@@ -109,16 +112,37 @@ function buildLocalPaths(): string[] {
   return paths;
 }
 
+/**
+ * Rethrows a Rust response that carries a stable GitManager error code as a
+ * `GitManagerError`; every other failure is rethrown unchanged.
+ */
+const rethrowCodedError = (errorArg: unknown): never => {
+  if (
+    errorArg instanceof plugins.smartrust.RustBridgeRequestError
+    && isGitManagerErrorCode(errorArg.responseErrorCode)
+  ) {
+    throw new GitManagerError(errorArg.responseErrorCode, errorArg.message, {
+      cause: errorArg,
+    });
+  }
+  throw errorArg;
+};
+
 export class RustGitManagerBridge extends plugins.EventEmitter {
   private bridge: plugins.smartrust.RustBridge<TGitManagerCommands>;
+  private binaryLocator: plugins.smartrust.RustBinaryLocator;
 
   constructor() {
     super();
-    this.bridge = new plugins.smartrust.RustBridge<TGitManagerCommands>({
+    const binaryLocatorOptions: plugins.smartrust.IBinaryLocatorOptions = {
       binaryName: 'rustgitmanager',
       envVarName: 'GITMANAGER_RUST_BINARY',
       platformPackagePrefix: '@foss.global/gitmanager',
       localPaths: buildLocalPaths(),
+    };
+    this.binaryLocator = new plugins.smartrust.RustBinaryLocator(binaryLocatorOptions);
+    this.bridge = new plugins.smartrust.RustBridge<TGitManagerCommands>({
+      ...binaryLocatorOptions,
       requestTimeoutMs: 130000,
       readyTimeoutMs: 10000,
     });
@@ -135,6 +159,15 @@ export class RustGitManagerBridge extends plugins.EventEmitter {
     return this.bridge.spawn();
   }
 
+  /** Resolves the engine binary the bridge spawns, for its one-shot modes. */
+  public async findBinary(): Promise<string> {
+    const binaryPath = await this.binaryLocator.findBinary();
+    if (!binaryPath) {
+      throw new Error('Unable to locate the rustgitmanager binary');
+    }
+    return binaryPath;
+  }
+
   public kill(): void {
     this.bridge.kill();
   }
@@ -278,7 +311,9 @@ export class RustGitManagerBridge extends plugins.EventEmitter {
     return this.bridge.sendCommand('listRepositories', {});
   }
 
-  public async listRefs(requestArg: IGitManagerRefRequest): Promise<IGitManagerRef[]> {
+  public async listRefs(
+    requestArg: IGitManagerRefRequest,
+  ): Promise<TGitManagerRefInventoryResult> {
     return this.bridge.sendCommand('listRefs', requestArg);
   }
 
@@ -302,6 +337,20 @@ export class RustGitManagerBridge extends plugins.EventEmitter {
     return this.bridge.sendCommand('readFile', requestArg);
   }
 
+  public async isAncestor(requestArg: IGitManagerAncestryRequest): Promise<boolean> {
+    const result = await this.bridge.sendCommand('isAncestor', {
+      org: requestArg.org,
+      repo: requestArg.repo,
+      ancestorObjectId: requestArg.ancestorObjectId,
+      descendantObjectId: requestArg.descendantObjectId,
+      ...(requestArg.timeoutMs === undefined ? {} : { timeoutMs: requestArg.timeoutMs }),
+    }).catch(rethrowCodedError);
+    if (typeof result !== 'boolean') {
+      throw new Error('Rust GitManager returned an invalid ancestry result');
+    }
+    return result;
+  }
+
   public async listCommits(requestArg: IGitManagerListCommitsRequest): Promise<IGitManagerCommitSummary[]> {
     return this.bridge.sendCommand('listCommits', requestArg);
   }