Adding sync state service to get latest row version based on given ro…

…w ids (#3128) * add row version service * add row version service * use syncStateService
coda · Dec 11, 2024 · 1a4d5b9 · 1a4d5b9
1 parent e4fcbd5
commit 1a4d5b9
Show file tree

Hide file tree

Showing 21 changed files with 198 additions and 14 deletions.
diff --git a/api_types.ts b/api_types.ts
@@ -781,6 +781,29 @@ export interface TemporaryBlobStorage {
   ): Promise<string>;
 }
 
+
+/**
+ * A service for retrieving the sync state in Coda Brain.
+ * @hidden
+ *
+ * TODO(ebo): unhide this
+ */
+export interface SyncStateService {
+  /**
+   * Retrieve the latest version of rows with the given row ids and returns a mapping of row ids to
+   * their latest version, e.g. {"Id-123": "1.0.0"}.
+   *
+   * If the row id is not found, it will not be included in the response.
+   *
+   * If the row version is not defined, it will be set to an empty string.
+   *
+   * @hidden
+   *
+   * TODO(ebo): unhide this
+   */
+  getLatestRowVersions(rowIds: string[]): Promise<{[rowId: string]: string}>;
+}
+
 /**
  * TODO(patrick): Unhide this
  * @hidden
@@ -1062,6 +1085,21 @@ export interface SyncExecutionContext<
    * Information about state of the current sync.
    */
   readonly sync: Sync<ContinuationT, IncrementalContinuationT, IncrementalSyncContinuationT>;
+
+  /**
+   * A service for retrieving the sync state in Coda Brain.
+   * @hidden
+   *
+   * TODO(ebo): unhide this
+   */
+  readonly syncStateService: SyncStateService;
+}
+
+/**
+ * A function to check if a given {@link ExecutionContext} is a {@link SyncExecutionContext}.
+ */
+export function isSyncExecutionContext(context: ExecutionContext): context is SyncExecutionContext {
+  return context.hasOwnProperty('sync') && context.hasOwnProperty('syncStateService');
 }
 
 /**

diff --git a/dist/api_types.d.ts b/dist/api_types.d.ts
diff --git a/dist/api_types.js b/dist/api_types.js
diff --git a/dist/bundle.d.ts b/dist/bundle.d.ts
diff --git a/dist/index.d.ts b/dist/index.d.ts
diff --git a/dist/runtime/bootstrap/index.d.ts b/dist/runtime/bootstrap/index.d.ts
diff --git a/dist/runtime/bootstrap/index.js b/dist/runtime/bootstrap/index.js
diff --git a/dist/testing/execution.js b/dist/testing/execution.js
diff --git a/dist/testing/fetcher.js b/dist/testing/fetcher.js
diff --git a/dist/testing/ivm_helper.d.ts b/dist/testing/ivm_helper.d.ts
diff --git a/dist/testing/ivm_helper.js b/dist/testing/ivm_helper.js
diff --git a/dist/testing/mocks.d.ts b/dist/testing/mocks.d.ts
diff --git a/dist/testing/mocks.js b/dist/testing/mocks.js
diff --git a/docs/reference/sdk/interfaces/testing.MockSyncExecutionContext.md b/docs/reference/sdk/interfaces/testing.MockSyncExecutionContext.md
diff --git a/index.ts b/index.ts
@@ -122,6 +122,7 @@ export type {SyncExecutionContext} from './api_types';
 export type {SyncFormulaResult} from './api';
 export type {SyncTableDef} from './api';
 export type {SyncTableOptions} from './api';
+export type {SyncStateService} from './api_types';
 export type {TemporaryBlobStorage} from './api_types';
 export {Type} from './api_types';
 export type {TypedPackFormula} from './api';

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@codahq/packs-sdk",
-  "version": "1.8.6-prerelease.2",
+  "version": "1.8.6-prerelease.3",
   "license": "MIT",
   "workspaces": [
     "dev/eslint"

diff --git a/runtime/bootstrap/index.ts b/runtime/bootstrap/index.ts
@@ -11,6 +11,7 @@ import type {Logger} from '../../api_types';
 import type {PackFunctionResponse} from '../types';
 import type {ParamDefs} from '../../api_types';
 import type {ParamValues} from '../../api_types';
+import type {SyncStateService} from '../../api_types';
 import type {SyncUpdate} from '../../api';
 import type {TemporaryBlobStorage} from '../../api_types';
 import {ensureNever} from '../../helpers/ensure';
@@ -228,6 +229,7 @@ export async function injectExecutionContext({
   context,
   fetcher,
   temporaryBlobStorage,
+  syncStateService,
   logger,
   endpoint,
   invocationLocation,
@@ -242,13 +244,15 @@ export async function injectExecutionContext({
   context: Context;
   fetcher: Fetcher;
   temporaryBlobStorage: TemporaryBlobStorage;
+  syncStateService: SyncStateService | undefined;
   logger: Logger;
 } & ExecutionContextPrimitives): Promise<void> {
   ensureNever<keyof typeof rest>();
   // Inject all of the primitives into a global we'll access when we execute the pack function.
   const executionContextPrimitives = {
     fetcher: {},
     temporaryBlobStorage: {},
+    syncStateService: {},
     logger: {},
     endpoint,
     invocationLocation,
@@ -286,6 +290,14 @@ export async function injectExecutionContext({
     'executionContext.temporaryBlobStorage.storeUrl',
     temporaryBlobStorage.storeUrl.bind(temporaryBlobStorage),
   );
+
+  if (syncStateService) {
+    await injectAsyncFunction(
+      context,
+      'executionContext.syncStateService.getLatestRowVersions',
+      syncStateService.getLatestRowVersions.bind(syncStateService),
+    );
+  }
 }
 
 export async function registerBundle(