CLI Deploy: Don't send empty collections (#862)

* do not send empty collections * add changeset * version: [email protected] --------- Co-authored-by: Joe Clark <[email protected]>
OpenFn · Jan 29, 2025 · 3633241 · 3633241
1 parent 084fe7e
commit 3633241
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 7 deletions.
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @openfn/cli
 
+## 1.10.4
+
+### Patch Changes
+
+- 295ceed: CLI Deploy: Don't send empty collections
+- Updated dependencies [295ceed]
+  - @openfn/deploy@0.10.0
+
 ## 1.10.3
 
 ### Patch Changes

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.10.3",
+  "version": "1.10.4",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",

diff --git a/packages/deploy/CHANGELOG.md b/packages/deploy/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @openfn/deploy
 
+## 0.10.0
+
+### Minor Changes
+
+- 295ceed: CLI Deploy: Don't send empty collections
+
 ## 0.9.0
 
 ### Minor Changes

diff --git a/packages/deploy/package.json b/packages/deploy/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/deploy",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Deploy projects to Lightning instances",
   "type": "module",
   "exports": {

diff --git a/packages/deploy/src/stateTransform.ts b/packages/deploy/src/stateTransform.ts
@@ -502,7 +502,7 @@ export function mergeProjectPayloadIntoState(
   );
 
   const nextCollections = Object.fromEntries(
-    idKeyPairs(project.collections || {}, state.collections || {}).map(
+    idKeyPairs(project.collections || [], state.collections || {}).map(
       ([key, nextCollection, _state]) => {
         return [key, nextCollection];
       }
@@ -557,10 +557,12 @@ export function toProjectPayload(state: ProjectState): ProjectPayload {
     state.collections
   );
 
+  const { collections: _, ...stateWithoutCollections } = state;
+
   return {
-    ...state,
-    collections,
+    ...stateWithoutCollections,
     project_credentials,
     workflows,
+    ...(collections.length > 0 && { collections }),
   };
 }
diff --git a/packages/deploy/src/types.ts b/packages/deploy/src/types.ts
@@ -139,7 +139,7 @@ export interface ProjectPayload {
   id: string;
   name: string;
   description: string;
-  collections: Concrete<CollectionState>[];
+  collections?: Concrete<CollectionState>[];
   project_credentials: Concrete<CredentialState>[];
   workflows: {
     id: string;

diff --git a/packages/deploy/test/stateTransform.test.ts b/packages/deploy/test/stateTransform.test.ts
@@ -4,6 +4,7 @@ import {
   getStateFromProjectPayload,
   mergeProjectPayloadIntoState,
   mergeSpecIntoState,
+  toProjectPayload,
 } from '../src/stateTransform';
 import { ProjectPayload } from '../src/types';
 import {
@@ -616,10 +617,21 @@ test('getStateFromProjectPayload with minimal project', (t) => {
 });
 
 test('getStateFromProjectPayload with full lightning project', (t) => {
-  const project = lightningProjectPayload;
   const expectedState = lightningProjectState;
 
+  const project = lightningProjectPayload;
+
   const state = getStateFromProjectPayload(project);
 
   t.deepEqual(state, expectedState);
 });
+
+test('toProjectPayload drops empty collections key', (t) => {
+  const { collections: _, ...projectState } = lightningProjectState;
+  projectState.collections = {};
+  const { collections: _c, ...expectedPayload } = lightningProjectPayload;
+
+  const payload = toProjectPayload(projectState);
+
+  t.deepEqual(payload, expectedPayload);
+});