migrate: find+replace Calculate output prop with fn (#4083)

theopensystemslab · Jan 8, 2025 · bfec874 · bfec874
1 parent 9ab99a3
commit bfec874
Show file tree

Hide file tree

Showing 15 changed files with 168 additions and 174 deletions.
diff --git a/api.planx.uk/modules/flows/downloadSchema/service.ts b/api.planx.uk/modules/flows/downloadSchema/service.ts
@@ -19,7 +19,6 @@ export const getFlowSchema = async (flowId: string) => {
       planx_variable:
         nodeData.data?.fn ||
         nodeData.data?.val ||
-        nodeData.data?.output ||
         nodeData.data?.dataFieldBoundary,
     }),
   );

diff --git a/e2e/tests/api-driven/src/invite-to-pay/mocks/flow.json b/e2e/tests/api-driven/src/invite-to-pay/mocks/flow.json
diff --git a/e2e/tests/ui-driven/src/mocks/flows/invite-to-pay-flow.ts b/e2e/tests/ui-driven/src/mocks/flows/invite-to-pay-flow.ts
@@ -23,7 +23,7 @@ const flow: FlowGraph = {
   },
   F9iwWG1jBQ: {
     data: {
-      output: "application.fee.payable",
+      fn: "application.fee.payable",
       formula: "123.45",
     },
     type: ComponentType.Calculate,

diff --git a/e2e/tests/ui-driven/src/mocks/flows/pay-flow.json b/e2e/tests/ui-driven/src/mocks/flows/pay-flow.json
@@ -10,7 +10,7 @@
   },
   "KzuRf6vqc1": {
     "data": {
-      "output": "pay.test",
+      "fn": "pay.test",
       "formula": "10"
     },
     "type": 700

diff --git a/editor.planx.uk/src/@planx/components/Calculate/Editor.tsx b/editor.planx.uk/src/@planx/components/Calculate/Editor.tsx
@@ -127,8 +127,8 @@ export default function Component(props: Props) {
         <ModalSectionContent title="Output">
           <DataFieldAutocomplete
             required
-            value={formik.values.output}
-            onChange={(value) => formik.setFieldValue("output", value)}
+            value={formik.values.fn}
+            onChange={(value) => formik.setFieldValue("fn", value)}
           />
           <InputRow>
           <Switch            
@@ -196,7 +196,7 @@ export default function Component(props: Props) {
             <></>
           )}
           <p>
-            <strong>{formik.values.output || "<output>"}</strong> would be set
+            <strong>{formik.values.fn || "<output>"}</strong> would be set
             to <strong>{sampleResult}</strong>
           </p>
         </ModalSectionContent>

diff --git a/editor.planx.uk/src/@planx/components/Calculate/Public.test.tsx b/editor.planx.uk/src/@planx/components/Calculate/Public.test.tsx
@@ -9,7 +9,7 @@ describe("Calculate component", () => {
     const handleSubmit = vi.fn();
     setup(
       <Calculate
-        output="testGroup"
+        fn="testGroup"
         formula="pickRandom([1,2])"
         formatOutputForAutomations={true}
         defaults={{}}

diff --git a/editor.planx.uk/src/@planx/components/Calculate/Public.tsx b/editor.planx.uk/src/@planx/components/Calculate/Public.tsx
@@ -19,7 +19,7 @@ export default function Component(props: Props) {
         props.formatOutputForAutomations
           ? [evaluatedResult.toString()]
           : evaluatedResult,
-        props.output,
+        props.fn,
       ),
       // don't show this component to the user, auto=true required
       // for back button to skip past this component when going back

diff --git a/editor.planx.uk/src/@planx/components/Calculate/logic.test.ts b/editor.planx.uk/src/@planx/components/Calculate/logic.test.ts
@@ -54,7 +54,7 @@ const flowWithAutomation: Store.Flow = {
   },
   Calculate: {
     data: {
-      output: "testGroup",
+      fn: "testGroup",
       formula: "pickRandom([1,2])",
       formatOutputForAutomations: true,
     },
@@ -108,7 +108,7 @@ const flowWithoutAutomation: Store.Flow = {
   },
   Calculate: {
     data: {
-      output: "testGroup",
+      fn: "testGroup",
       formula: "pickRandom([1,2])",
       formatOutputForAutomations: false,
     },

diff --git a/editor.planx.uk/src/@planx/components/Calculate/model.ts b/editor.planx.uk/src/@planx/components/Calculate/model.ts
@@ -4,7 +4,7 @@ import { BaseNodeData, parseBaseNodeData } from "../shared";
 
 export interface Calculate extends BaseNodeData {
   title?: string;
-  output: string;
+  fn: string;
   defaults: Record<string, number>;
   formula: string;
   samples: Record<string, number>;
@@ -20,7 +20,7 @@ export const parseCalculate = (
   data: Record<string, any> | undefined,
 ): Calculate => ({
   ...parseBaseNodeData(data),
-  output: data?.output || "",
+  fn: data?.fn || "",
   defaults: data?.defaults || {},
   formula: data?.formula || "",
   samples: data?.samples || {},

diff --git a/...anx.uk/src/pages/FlowEditor/components/Sidebar/Search/SearchResultCard/dataFacets.test.ts b/...anx.uk/src/pages/FlowEditor/components/Sidebar/Search/SearchResultCard/dataFacets.test.ts
@@ -93,7 +93,7 @@ describe("Calculate component", () => {
       componentType: "Calculate",
       headline: "calculateOutput",
       iconKey: ComponentType.Calculate,
-      key: "Output (data)",
+      key: "Data",
       title: "This is a calculate component",
     });
   });

diff --git a/...ages/FlowEditor/components/Sidebar/Search/SearchResultCard/getDisplayDetailsForResult.tsx b/...ages/FlowEditor/components/Sidebar/Search/SearchResultCard/getDisplayDetailsForResult.tsx
@@ -198,9 +198,6 @@ const keyFormatters: KeyMap = {
     getDisplayKey: () => "Formula",
     getHeadline: ({ item }) => (item.data as unknown as Calculate).formula,
   },
-  "data.output": {
-    getDisplayKey: () => "Output (data)",
-  },
   // List contains data variables nested within its schema
   "data.schema.fields.data.fn": {
     getDisplayKey: () => "Data",

diff --git a/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/Search/facets.ts b/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/Search/facets.ts
@@ -9,7 +9,6 @@ const generalData: SearchFacets = ["data.fn", "data.val"];
 const fileUploadAndLabelData: SearchFacets = ["data.fileTypes.fn"];
 
 const calculateData: SearchFacets = [
-  "data.output",
   {
     name: "formula",
     getFn: (node: IndexedNode) => Object.keys(node.data?.defaults || {}),

diff --git a/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/Search/mocks/dataFacetFlow.ts b/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/Search/mocks/dataFacetFlow.ts
@@ -181,7 +181,7 @@ export const mockFlow: FlowGraph = {
   zryBH8H7vD: {
     data: {
       title: "This is a calculate component",
-      output: "calculateOutput",
+      fn: "calculateOutput",
       formula: "formulaOne + formulaTwo",
       defaults: {
         formulaOne: "1",
@@ -623,7 +623,7 @@ export const mockCalculateRootResult: SearchResult<IndexedNode> = {
     type: 700,
     data: {
       title: "This is a calculate component",
-      output: "calculateOutput",
+      fn: "calculateOutput",
       formula: "formulaOne + formulaTwo",
       defaults: {
         formulaOne: "1",
@@ -633,7 +633,7 @@ export const mockCalculateRootResult: SearchResult<IndexedNode> = {
       samples: {},
     },
   },
-  key: "data.output",
+  key: "data.fn",
   matchIndices: [[0, 14]],
   refIndex: 0,
   matchValue: "calculateOutput",
@@ -646,7 +646,7 @@ export const mockCalculateFormulaResult: SearchResult<IndexedNode> = {
     type: 700,
     data: {
       title: "This is a calculate component",
-      output: "calculateOutput",
+      fn: "calculateOutput",
       formula: "formulaOne + formulaTwo",
       defaults: {
         formulaOne: "1",

diff --git a/editor.planx.uk/src/pages/FlowEditor/lib/__tests__/preview/canGoBack.test.ts b/editor.planx.uk/src/pages/FlowEditor/lib/__tests__/preview/canGoBack.test.ts
@@ -34,7 +34,7 @@ const flow: Store.Flow = {
   Calculate: {
     type: TYPES.Calculate,
     data: {
-      output: "fee",
+      fn: "fee",
       formula: "10",
     },
   },

diff --git a/editor.planx.uk/src/pages/FlowEditor/lib/store/editor.ts b/editor.planx.uk/src/pages/FlowEditor/lib/store/editor.ts
@@ -618,7 +618,6 @@ export const editorStore: StateCreator<
       };
 
       // TODO align to (reuse?) data facets from search
-      if (node.data?.output) nodes.add(node.data.output);
       if (node.data?.dataFieldBoundary) nodes.add(node.data.dataFieldBoundary);
 
       if (node.data?.val) {