fix: changed_keys and modified_keys output to handle json and escape_json inputs (#1585)

Co-authored-by: Arthur Volant <arthur.volant@adevinta.com>
Co-authored-by: Tonye Jack <jtonye@ymail.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>

dist/index.js

@@ -101,21 +101,25 @@ const processChangedFiles = ({ filePatterns, allDiffFiles, inputs, yamlFilePatte
             core.endGroup();
         }
         if (modifiedKeys.length > 0) {
+            core.debug(`All modifiedKeys: ${JSON.stringify(modifiedKeys)}`);
             yield (0, utils_1.setOutput)({
                 key: 'modified_keys',
-                value: modifiedKeys.join(inputs.separator),
+                value: inputs.json ? modifiedKeys : modifiedKeys.join(inputs.separator),
                 writeOutputFiles: inputs.writeOutputFiles,
                 outputDir: inputs.outputDir,
-                json: inputs.json
+                json: inputs.json,
+                shouldEscape: inputs.escapeJson
             });
         }
         if (changedKeys.length > 0) {
+            core.debug(`All changedKeys: ${JSON.stringify(changedKeys)}`);
             yield (0, utils_1.setOutput)({
                 key: 'changed_keys',
-                value: changedKeys.join(inputs.separator),
+                value: inputs.json ? changedKeys : changedKeys.join(inputs.separator),
                 writeOutputFiles: inputs.writeOutputFiles,
                 outputDir: inputs.outputDir,
-                json: inputs.json
+                json: inputs.json,
+                shouldEscape: inputs.escapeJson
             });
         }
     }

src/changedFiles.ts

@@ -17,7 +17,7 @@ import {
   gitSubmoduleDiffSHA,
   isWindows,
   jsonOutput,
-  setOutput
+  setArrayOutput
 } from './utils'
 
 export const processChangedFiles = async ({
@@ -85,22 +85,18 @@ export const processChangedFiles = async ({
     }
 
     if (modifiedKeys.length > 0) {
-      await setOutput({
+      await setArrayOutput({
         key: 'modified_keys',
-        value: modifiedKeys.join(inputs.separator),
+        inputs,
-        writeOutputFiles: inputs.writeOutputFiles,
+        value: modifiedKeys
-        outputDir: inputs.outputDir,
-        json: inputs.json
       })
     }
 
     if (changedKeys.length > 0) {
-      await setOutput({
+      await setArrayOutput({
         key: 'changed_keys',
-        value: changedKeys.join(inputs.separator),
+        inputs,
-        writeOutputFiles: inputs.writeOutputFiles,
+        value: changedKeys
-        outputDir: inputs.outputDir,
-        json: inputs.json
       })
     }
   }

src/changedFilesOutput.ts

@@ -6,11 +6,7 @@ import {
   getChangeTypeFiles
 } from './changedFiles'
 import {Inputs} from './inputs'
-import {setOutput} from './utils'
+import {getOutputKey, setArrayOutput, setOutput} from './utils'
-
-const getOutputKey = (key: string, outputPrefix: string): string => {
-  return outputPrefix ? `${outputPrefix}_${key}` : key
-}
 
 const getArrayFromPaths = (
   paths: string | string[],
@@ -283,15 +279,11 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     json: inputs.json
   })
 
-  await setOutput({
+  await setArrayOutput({
-    key: getOutputKey('other_changed_files', outputPrefix),
+    key: 'other_changed_files',
-    value: inputs.json
+    inputs,
-      ? otherChangedFiles
+    value: otherChangedFiles,
-      : otherChangedFiles.join(inputs.separator),
+    outputPrefix
-    writeOutputFiles: inputs.writeOutputFiles,
-    outputDir: inputs.outputDir,
-    json: inputs.json,
-    shouldEscape: inputs.escapeJson
   })
 
   await setOutput({
@@ -376,15 +368,11 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     json: inputs.json
   })
 
-  await setOutput({
+  await setArrayOutput({
-    key: getOutputKey('other_modified_files', outputPrefix),
+    key: 'other_modified_files',
-    value: inputs.json
+    inputs,
-      ? otherModifiedFiles
+    value: otherModifiedFiles,
-      : otherModifiedFiles.join(inputs.separator),
+    outputPrefix
-    writeOutputFiles: inputs.writeOutputFiles,
-    outputDir: inputs.outputDir,
-    json: inputs.json,
-    shouldEscape: inputs.escapeJson
   })
 
   await setOutput({
@@ -457,15 +445,11 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     json: inputs.json
   })
 
-  await setOutput({
+  await setArrayOutput({
-    key: getOutputKey('other_deleted_files', outputPrefix),
+    key: 'other_deleted_files',
-    value: inputs.json
+    inputs,
-      ? otherDeletedFiles
+    value: otherDeletedFiles,
-      : otherDeletedFiles.join(inputs.separator),
+    outputPrefix
-    writeOutputFiles: inputs.writeOutputFiles,
-    outputDir: inputs.outputDir,
-    json: inputs.json,
-    shouldEscape: inputs.escapeJson
   })
 
   await setOutput({

src/utils.ts

@@ -1222,6 +1222,32 @@ export const getRecoverFilePatterns = ({
   return filePatterns.filter(Boolean)
 }
 
+export const getOutputKey = (key: string, outputPrefix: string): string => {
+  return outputPrefix ? `${outputPrefix}_${key}` : key
+}
+
+export const setArrayOutput = async ({
+  key,
+  inputs,
+  value,
+  outputPrefix
+}: {
+  key: string
+  inputs: Inputs
+  value: string[]
+  outputPrefix?: string
+}): Promise<void> => {
+  core.debug(`${key}: ${JSON.stringify(value)}`)
+  await setOutput({
+    key: outputPrefix ? getOutputKey(key, outputPrefix) : key,
+    value: inputs.json ? value : value.join(inputs.separator),
+    writeOutputFiles: inputs.writeOutputFiles,
+    outputDir: inputs.outputDir,
+    json: inputs.json,
+    shouldEscape: inputs.escapeJson
+  })
+}
+
 export const setOutput = async ({
   key,
   value,