fix: field formValue is sometimes not correctly provided in execute c…

…ontext (#894) * fix: field formValue is sometimes not correctly provided in execute context [skip ci] * refactor: remove wrong changes * test: add unit tests * chore: remove typings * test: fix collection unit test * refactor: rename argument * refactor: update name in action.ts --------- Co-authored-by: Nicolas Moreau <nicolas.moreau76@gmail.com>
ForestAdmin · Dec 11, 2023 · a24aab1 · a24aab1
1 parent eaf3804
commit a24aab1
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 18 deletions.
diff --git a/packages/agent/src/routes/modification/action/action.ts b/packages/agent/src/routes/modification/action/action.ts
@@ -98,6 +98,7 @@ export default class ActionRoute extends CollectionRoute {
       this.actionName,
       unsafeData,
       filterForCaller,
+      { includeHiddenFields: true }, // during execute, we need all possible fields
     );
 
     // Now that we have the field list, we can parse the data again.
@@ -156,6 +157,7 @@ export default class ActionRoute extends CollectionRoute {
       changedField: body.data.attributes.changed_field,
       searchField: body.data.attributes.search_field,
       searchValues,
+      includeHiddenFields: false,
     });
 
     context.response.body = {

diff --git a/packages/agent/test/routes/modification/action/action.test.ts b/packages/agent/test/routes/modification/action/action.test.ts
@@ -539,7 +539,12 @@ describe('ActionRoute', () => {
           searchExtended: false,
           segment: null,
         },
-        { changedField: undefined, searchField: undefined, searchValues: {} },
+        {
+          changedField: undefined,
+          searchField: undefined,
+          searchValues: {},
+          includeHiddenFields: false,
+        },
       );
 
       expect(context.response.body).toEqual({ fields: [{ field: 'firstname', type: 'String' }] });
@@ -585,6 +590,7 @@ describe('ActionRoute', () => {
           searchValues: {
             firstname: undefined,
           },
+          includeHiddenFields: false,
         },
       );
 

diff --git a/packages/datasource-customizer/src/decorators/actions/collection.ts b/packages/datasource-customizer/src/decorators/actions/collection.ts
@@ -6,6 +6,7 @@ import {
   CollectionSchema,
   DataSourceDecorator,
   Filter,
+  GetFormMetas,
   PlainFilter,
   RecordData,
 } from '@forestadmin/datasource-toolkit';
@@ -54,11 +55,7 @@ export default class ActionCollectionDecorator extends CollectionDecorator {
     name: string,
     data?: RecordData,
     filter?: Filter,
-    metas?: {
-      changedField: string;
-      searchField?: string | null;
-      searchValues?: Record<string, string | null>;
-    },
+    metas?: GetFormMetas,
   ): Promise<ActionField[]> {
     const action = this.actions[name];
     if (!action) return this.childCollection.getForm(caller, name, data, filter, metas);
@@ -78,7 +75,7 @@ export default class ActionCollectionDecorator extends CollectionDecorator {
     }
 
     dynamicFields = await this.dropDefaults(context, dynamicFields, formValues);
-    dynamicFields = await this.dropIfs(context, dynamicFields);
+    if (!metas?.includeHiddenFields) dynamicFields = await this.dropIfs(context, dynamicFields);
 
     const fields = await this.dropDeferred(context, metas?.searchValues, dynamicFields);
 

diff --git a/packages/datasource-customizer/test/decorators/actions/collection.test.ts b/packages/datasource-customizer/test/decorators/actions/collection.test.ts
@@ -155,6 +155,75 @@ describe('ActionDecorator', () => {
       ]);
     });
   });
+  describe('with single action with ifs', () => {
+    beforeEach(() => {
+      newBooks.addAction('make photocopy', {
+        scope: 'Single',
+        execute: () => {},
+        form: [
+          {
+            label: 'noIf',
+            type: 'String',
+          },
+          {
+            label: 'dynamicIfFalse',
+            type: 'String',
+            if: () => false,
+          },
+          {
+            label: 'dynamicIfTrue',
+            type: 'String',
+            if: () => true,
+          },
+        ],
+      });
+    });
+
+    test('should dropIfs which are false if required', async () => {
+      const fields = await newBooks.getForm(
+        factories.caller.build(),
+        'make photocopy',
+        undefined,
+        undefined,
+        { includeHiddenFields: false },
+      );
+
+      expect(fields).toEqual([
+        expect.objectContaining({
+          label: 'noIf',
+          type: 'String',
+        }),
+        expect.objectContaining({
+          label: 'dynamicIfTrue',
+          type: 'String',
+        }),
+      ]);
+    });
+    test('should not dropIfs if required', async () => {
+      const fields = await newBooks.getForm(
+        factories.caller.build(),
+        'make photocopy',
+        undefined,
+        undefined,
+        { includeHiddenFields: true },
+      );
+
+      expect(fields).toEqual([
+        expect.objectContaining({
+          label: 'noIf',
+          type: 'String',
+        }),
+        expect.objectContaining({
+          label: 'dynamicIfFalse',
+          type: 'String',
+        }),
+        expect.objectContaining({
+          label: 'dynamicIfTrue',
+          type: 'String',
+        }),
+      ]);
+    });
+  });
 
   describe('with single action with both load and change hooks', () => {
     beforeEach(() => {

diff --git a/packages/datasource-toolkit/src/decorators/collection-decorator.ts b/packages/datasource-toolkit/src/decorators/collection-decorator.ts
@@ -1,7 +1,7 @@
 import { ActionField, ActionResult } from '../interfaces/action';
 import { Caller } from '../interfaces/caller';
 import { Chart } from '../interfaces/chart';
-import { Collection, DataSource } from '../interfaces/collection';
+import { Collection, DataSource, GetFormMetas } from '../interfaces/collection';
 import Aggregation, { AggregateResult } from '../interfaces/query/aggregation';
 import PaginatedFilter from '../interfaces/query/filter/paginated';
 import Filter from '../interfaces/query/filter/unpaginated';
@@ -69,11 +69,7 @@ export default class CollectionDecorator implements Collection {
     name: string,
     data?: RecordData,
     filter?: Filter,
-    metas?: {
-      changedField?: string;
-      searchValue?: Record<string, string | null>;
-      searchField?: string;
-    },
+    metas?: GetFormMetas,
   ): Promise<ActionField[]> {
     const refinedFilter = await this.refineFilter(caller, filter);
 

diff --git a/packages/datasource-toolkit/src/interfaces/collection.ts b/packages/datasource-toolkit/src/interfaces/collection.ts
@@ -17,6 +17,13 @@ export interface DataSource<C extends Collection = Collection> {
   renderChart(caller: Caller, name: string): Promise<Chart>;
 }
 
+export type GetFormMetas = {
+  changedField?: string;
+  searchField?: string | null;
+  searchValues?: Record<string, string | null>;
+  includeHiddenFields?: boolean;
+};
+
 export interface Collection {
   get nativeDriver(): unknown | null;
   get dataSource(): DataSource;
@@ -35,11 +42,7 @@ export interface Collection {
     name: string,
     formValues?: RecordData,
     filter?: Filter,
-    metas?: {
-      changedField?: string;
-      searchValues?: Record<string, string | null>;
-      searchField?: string;
-    },
+    metas?: GetFormMetas,
   ): Promise<ActionField[]>;
 
   create(caller: Caller, data: RecordData[]): Promise<RecordData[]>;