add supportsIncrementalSync in ParamDef to support incremental sync (#…

…2975) * add supportsIncrementalSync * update version to prerelease
coda · Jul 1, 2024 · 38bbde8 · 38bbde8
1 parent cbcff0f
commit 38bbde8
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 3 deletions.
diff --git a/api_types.ts b/api_types.ts
@@ -339,6 +339,14 @@ export interface ParamDef<T extends UnionType> {
   // TODO(patrick): Unhide this
   /** @hidden */
   crawlStrategy?: CrawlStrategy;
+
+  /**
+   * Whether this parameter is compatible with incremental sync.
+   * If not, it will be hidden from the Coda Brain setup UI.
+   */
+  // TODO(ebo): Unhide this
+  /** @hidden */
+  supportsIncrementalSync?: boolean;
 }
 
 /**

diff --git a/dist/api_types.d.ts b/dist/api_types.d.ts
diff --git a/dist/bundle.d.ts b/dist/bundle.d.ts
diff --git a/dist/testing/upload_validation.js b/dist/testing/upload_validation.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@codahq/packs-sdk",
-  "version": "1.7.8",
+  "version": "1.7.8-prerelease.1",
   "license": "MIT",
   "workspaces": [
     "dev/eslint"

diff --git a/test/upload_validation_test.ts b/test/upload_validation_test.ts
@@ -4471,6 +4471,37 @@ describe('Pack metadata Validation', async () => {
         },
       ]);
     });
+
+    it('rejects required param does not support incremental sync', async () => {
+      const formula = makeFormula({
+        resultType: ValueType.String,
+        name: 'Hi',
+        description: 'A',
+        examples: [],
+        parameters: [
+          makeParameter({
+            type: ParameterType.String,
+            name: 'myParam',
+            description: '',
+            optional: false,
+            supportsIncrementalSync: false,
+          }),
+        ],
+        execute: () => '',
+      });
+
+      const metadata = createFakePackVersionMetadata({
+        formulas: [formula],
+        formulaNamespace: 'MyNamespace',
+      });
+      const err = await validateJsonAndAssertFails(metadata);
+      assert.deepEqual(err.validationErrors, [
+        {
+          message: `Required params should support incremental sync.`,
+          path: 'formulas[0].parameters[0]',
+        },
+      ]);
+    });
   });
 
   describe('deprecation warnings', () => {

diff --git a/testing/upload_validation.ts b/testing/upload_validation.ts
@@ -717,7 +717,13 @@ function buildMetadataSchema({sdkVersion}: BuildMetadataSchemaArgs): {
     defaultValue: z.unknown().optional(),
     suggestedValue: z.unknown().optional(),
     crawlStrategy: z.unknown().optional(),
-  });
+    supportsIncrementalSync: z.boolean().optional().default(true),
+  }).refine(
+    param => {
+      return param.optional || param.supportsIncrementalSync;
+    },
+    {message: 'Required params should support incremental sync.'},
+  );
 
   const commonPackFormulaSchema = {
     // It would be preferable to use validateFormulaName here, but we have to exempt legacy packs with sync tables