Merge pull request #200 from pmrotule/fix/input-types

fix: allow all possible workflow input types

Author: Codex-

action.yml

@@ -24,7 +24,7 @@ inputs:
     description: Workflow to return an ID for. Can be the ID or the workflow filename.
     required: true
   workflow_inputs:
-    description: A flat JSON object, only supports strings (as per workflow inputs API).
+    description: A flat JSON object, only supports strings, numbers, and booleans (as per workflow inputs API).
   workflow_timeout_seconds:
     description: Time until giving up waiting for the start of the workflow run.
     default: 300

src/action.spec.ts

@@ -91,11 +91,22 @@ describe("Action", () => {
       expect(() => getConfig()).toThrowError();
     });
 
-    it("should throw if a workflow inputs JSON is contains non-strings", () => {
+    it("should handle workflow inputs JSON containing strings numbers or booleans", () => {
       mockEnvConfig.workflow_inputs =
-        '{"cake":"delicious","pie":{"powerLevel":9001}}';
+        '{"cake":"delicious","pie":9001,"parfait":false}';
 
-      expect(() => getConfig()).toThrowError();
+      expect(() => getConfig()).not.toThrowError();
+    });
+
+    it("should throw if a workflow inputs JSON doesn't contain strings numbers or booleans", () => {
+      mockEnvConfig.workflow_inputs = '{"pie":{"powerLevel":9001}}';
+      expect(() => getConfig()).toThrowError('"pie" value is object');
+
+      mockEnvConfig.workflow_inputs = '{"vegetable":null}';
+      expect(() => getConfig()).toThrowError('"vegetable" value is null');
+
+      mockEnvConfig.workflow_inputs = '{"fruit":[]}';
+      expect(() => getConfig()).toThrowError('"fruit" value is Array');
     });
   });
 });

src/action.ts

@@ -43,7 +43,7 @@ export interface ActionConfig {
 }
 
 interface ActionWorkflowInputs {
-  [input: string]: string;
+  [input: string]: string | number | boolean;
 }
 
 export enum ActionOutputs {
@@ -59,7 +59,7 @@ export function getConfig(): ActionConfig {
     workflow: getWorkflowValue(core.getInput("workflow", { required: true })),
     workflowInputs: getWorkflowInputs(core.getInput("workflow_inputs")),
     workflowTimeoutSeconds:
-      getNumberFromValue(core.getInput("workflow_timeout_seconds")) ||
+      getNumberFromValue(core.getInput("workflow_timeout_seconds")) ??
       WORKFLOW_TIMEOUT_SECONDS,
   };
 }
@@ -92,10 +92,22 @@ function getWorkflowInputs(
   try {
     const parsedJson = JSON.parse(workflowInputs);
     for (const key of Object.keys(parsedJson)) {
-      const type = typeof parsedJson[key];
-      if (type !== "string") {
+      const value = parsedJson[key];
+      const type = (() => {
+        switch (true) {
+          case value === null: {
+            return "null";
+          }
+          case Array.isArray(value): {
+            return "Array";
+          }
+          default:
+            return typeof value;
+        }
+      })();
+      if (!["string", "number", "boolean"].includes(type)) {
         throw new Error(
-          `Expected values to be strings, ${key} value is ${type}`,
+          `Expected value to be string, number, or boolean. "${key}" value is ${type}`,
         );
       }
     }