Enforce only JSONPath executed on output transforms

Signed-off-by: Tyler Ohlsen <[email protected]>
opensearch-project · Nov 15, 2024 · 7b21036 · 7b21036
1 parent 71eaf07
commit 7b21036
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 12 deletions.
diff --git a/common/constants.ts b/common/constants.ts
@@ -464,6 +464,10 @@ export enum PROCESSOR_CONTEXT {
   SEARCH_REQUEST = 'search_request',
   SEARCH_RESPONSE = 'search_response',
 }
+export enum TRANSFORM_CONTEXT {
+  INPUT = 'input',
+  OUTPUT = 'output',
+}
 export const START_FROM_SCRATCH_WORKFLOW_NAME = 'Start From Scratch';
 export const DEFAULT_NEW_WORKFLOW_NAME = 'new_workflow';
 export const DEFAULT_NEW_WORKFLOW_DESCRIPTION = 'My new workflow';

diff --git a/...c/pages/workflow_detail/workflow_inputs/processor_inputs/modals/input_transform_modal.tsx b/...c/pages/workflow_detail/workflow_inputs/processor_inputs/modals/input_transform_modal.tsx
@@ -42,6 +42,7 @@ import {
   PROCESSOR_CONTEXT,
   SearchHit,
   SimulateIngestPipelineResponse,
+  TRANSFORM_CONTEXT,
   WorkflowConfig,
   WorkflowFormValues,
   customStringify,
@@ -186,12 +187,14 @@ export function InputTransformModal(props: InputTransformModalProps) {
             ? generateArrayTransform(
                 sampleSourceInput as [],
                 tempInputMap[selectedTransformOption],
-                props.context
+                props.context,
+                TRANSFORM_CONTEXT.INPUT
               )
             : generateTransform(
                 sampleSourceInput,
                 tempInputMap[selectedTransformOption],
-                props.context
+                props.context,
+                TRANSFORM_CONTEXT.INPUT
               );
 
         setTransformedInput(customStringify(output));

diff --git a/.../pages/workflow_detail/workflow_inputs/processor_inputs/modals/output_transform_modal.tsx b/.../pages/workflow_detail/workflow_inputs/processor_inputs/modals/output_transform_modal.tsx
@@ -42,6 +42,7 @@ import {
   SearchHit,
   SearchPipelineConfig,
   SimulateIngestPipelineResponse,
+  TRANSFORM_CONTEXT,
   WorkflowConfig,
   WorkflowFormValues,
   customStringify,
@@ -158,7 +159,8 @@ export function OutputTransformModal(props: OutputTransformModalProps) {
         const output = generateTransform(
           sampleSourceOutput,
           reverseKeysAndValues(tempOutputMap[selectedTransformOption]),
-          props.context
+          props.context,
+          TRANSFORM_CONTEXT.OUTPUT
         );
         setTransformedOutput(customStringify(output));
       } catch {}

diff --git a/public/utils/utils.ts b/public/utils/utils.ts
@@ -18,6 +18,7 @@ import {
   PROCESSOR_CONTEXT,
   SimulateIngestPipelineDoc,
   SimulateIngestPipelineResponse,
+  TRANSFORM_CONTEXT,
   WORKFLOW_RESOURCE_TYPE,
   WORKFLOW_STEP_TYPE,
   Workflow,
@@ -186,7 +187,8 @@ export function unwrapTransformedDocs(
 export function generateTransform(
   input: {} | [],
   map: MapFormValue,
-  context: PROCESSOR_CONTEXT
+  context: PROCESSOR_CONTEXT,
+  transformContext: TRANSFORM_CONTEXT
 ): {} {
   let output = {};
   map.forEach((mapEntry) => {
@@ -195,7 +197,8 @@ export function generateTransform(
         mapEntry,
         input,
         mapEntry.value,
-        context
+        context,
+        transformContext
       );
       output = {
         ...output,
@@ -213,13 +216,20 @@ export function generateTransform(
 export function generateArrayTransform(
   input: [],
   map: MapFormValue,
-  context: PROCESSOR_CONTEXT
+  context: PROCESSOR_CONTEXT,
+  transformContext: TRANSFORM_CONTEXT
 ): {}[] {
   let output = [] as {}[];
   map.forEach((mapEntry) => {
     try {
       const transformedResult = input.map((inputEntry) =>
-        getTransformedResult(mapEntry, inputEntry, mapEntry.value, context)
+        getTransformedResult(
+          mapEntry,
+          inputEntry,
+          mapEntry.value,
+          context,
+          transformContext
+        )
       );
       output = {
         ...output,
@@ -234,14 +244,16 @@ function getTransformedResult(
   mapEntry: MapEntry,
   input: {},
   path: string,
-  context: PROCESSOR_CONTEXT
+  context: PROCESSOR_CONTEXT,
+  transformContext: TRANSFORM_CONTEXT
 ): any {
-  // Rregular dot notation can only be executed if 1/ the JSONPath selector is not explicitly defined,
-  // and 2/ it is in the context of ingest. For search request / search response parsing,
-  // it can only be JSONPath, due to backend parsing limitations.
+  // Regular dot notation can only be executed if 1/ the JSONPath selector is not explicitly defined,
+  // and 2/ it is in the context of ingest, and 3/ it is transforming the input (the source document).
+  // For all other scenarios, it can only be JSONPath, due to backend parsing limitations.
   if (
     !mapEntry.value.startsWith(JSONPATH_ROOT_SELECTOR) &&
-    context === PROCESSOR_CONTEXT.INGEST
+    context === PROCESSOR_CONTEXT.INGEST &&
+    transformContext === TRANSFORM_CONTEXT.INPUT
   ) {
     // sub-edge case: if the path is ".", it implies returning
     // the entire value. This may happen if full_response_path=false