1.16.1 bug fixes (#127)

shawnrushefsky · web-flow · commit 910c42638e11 · 2026-01-05T19:29:42.000+04:00
* version bump, add tests

* version bump comfyui

* improved custom workflow debugging

* more test

* bug fix and test
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -11,6 +11,7 @@ It covers setting up the development environment, coding standards, testing proc
     - [Running Tests](#running-tests)
   - [Generating New Workflow Endpoints](#generating-new-workflow-endpoints)
     - [Automating with Claude 4 Sonnet](#automating-with-claude-4-sonnet)
+    - [Debugging Custom Workflows](#debugging-custom-workflows)
   - [Storage Providers](#storage-providers)
     - [Adding a New Storage Provider](#adding-a-new-storage-provider)
 
@@ -307,6 +308,88 @@ Where `<inputFile>` is the JSON prompt graph, and `<outputFile>` is the output f
 
 As with all AI-generated code, it is strongly recommended to review the generated code before using it in production.
 
+### Debugging Custom Workflows
+
+When developing or troubleshooting custom workflows, enable debug logging to see detailed information about what's happening under the hood.
+
+#### Enabling Debug Logging
+
+Set the `LOG_LEVEL` environment variable to `debug`:
+
+```shell
+# Docker
+docker run -e LOG_LEVEL=debug ...
+
+# Docker Compose
+environment:
+  - LOG_LEVEL=debug
+```
+
+#### What Debug Logging Shows
+
+With `LOG_LEVEL=debug`, the server will log:
+
+1. **Workflow Loading** (at startup):
+   - Which workflow directories are being scanned
+   - TypeScript files being transpiled
+   - Each workflow file being evaluated
+   - Successfully loaded workflows
+   - Warnings for files that don't export valid Workflow objects
+   - Errors if workflow files fail to evaluate (with stack traces)
+
+2. **Workflow Execution** (per request):
+   - The input received from the request (`Workflow input received`)
+   - The generated ComfyUI prompt (`Generated ComfyUI prompt from workflow`)
+   - The full request body sent to `/prompt` (`Sending request to /prompt endpoint`)
+   - Any errors from the `/prompt` endpoint (including the full prompt that failed)
+
+#### Common Issues and Solutions
+
+**Problem: 400 error from `/prompt` endpoint with validation errors**
+
+Debug logs will show the exact prompt being sent. Common causes:
+- Missing required nodes (e.g., no `SaveImage` node with `filename_prefix`)
+- Invalid node references (e.g., referencing a node ID that doesn't exist)
+- Invalid input types (e.g., string where number expected)
+
+Check the `promptRequestBody` in the error log to see exactly what was sent.
+
+**Problem: Workflow file not loading**
+
+Debug logs will show if the file:
+- Failed to transpile (TypeScript syntax error)
+- Failed to evaluate (JavaScript runtime error)
+- Doesn't export a valid Workflow object
+
+**Problem: Workflow generates wrong output**
+
+Use debug logs to compare:
+1. The `input` received by the workflow
+2. The `prompt` generated by your `generateWorkflow` function
+3. Compare against a known-working prompt from ComfyUI's web interface
+
+#### Example Debug Output
+
+```
+{"level":30,"workflow":"txt2img","msg":"Workflow input received","input":{"prompt":"a cat","width":512}}
+{"level":30,"workflow":"txt2img","msg":"Generated ComfyUI prompt from workflow","prompt":{"3":{"inputs":{"seed":123...}}}}
+{"level":30,"workflow":"txt2img","msg":"Sending request to /prompt endpoint","promptRequestBody":{...}}
+{"level":30,"workflow":"txt2img","msg":"Workflow completed successfully","status":200}
+```
+
+When a workflow fails:
+```
+{"level":50,"workflow":"txt2img","msg":"Workflow request to /prompt endpoint failed","status":400,"error":"Prompt must contain a node with a \"filename_prefix\" input","location":"prompt","promptRequestBody":{...}}
+```
+
+#### Inspecting Prompts Without Debug Logging
+
+If you can't enable debug logging, you can still inspect your generated prompts by:
+
+1. **Using the `/docs` endpoint**: Access the Swagger UI at `http://localhost:3000/docs` to test your workflow endpoints interactively
+2. **Testing generateWorkflow locally**: Import your workflow file and call `generateWorkflow()` with test inputs to see the output
+3. **Comparing with ComfyUI**: Export a working prompt from ComfyUI's web interface and compare it to your generated prompt
+
 ## Storage Providers
 
 Storage providers are modular components that handle the downloading of models and input media, as well as the uploading of completed outputs.
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ If you have your own ComfyUI dockerfile, you can add the comfyui-api server to i
 
 ```dockerfile
 # Change this to the version you want to use
-ARG api_version=1.15.0
+ARG api_version=1.16.1
 
 # Download the comfyui-api binary, and make it executable
 ADD https://github.com/SaladTechnologies/comfyui-api/releases/download/${api_version}/comfyui-api .
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,6 +1,6 @@
 services:
   comfyui:
-    image: ghcr.io/saladtechnologies/comfyui-api:comfy0.5.1-torch2.8.0-cuda12.8-runtime
+    image: ghcr.io/saladtechnologies/comfyui-api:comfy0.7.0-torch2.8.0-cuda12.8-runtime
     volumes:
       - type: bind
         source: ./bin
diff --git a/docker/api.dockerfile b/docker/api.dockerfile
@@ -1,5 +1,5 @@
 ARG base=runtime
-ARG comfy_version=0.5.1
+ARG comfy_version=0.7.0
 ARG pytorch_version=2.8.0
 ARG cuda_version=12.6
 
@@ -8,7 +8,7 @@ FROM ghcr.io/saladtechnologies/comfyui-api:comfy${comfy_version}-torch${pytorch_
 ENV WORKFLOW_DIR=/workflows
 ENV STARTUP_CHECK_MAX_TRIES=30
 
-ARG api_version=1.16.0
+ARG api_version=1.16.1
 
 ADD https://github.com/SaladTechnologies/comfyui-api/releases/download/${api_version}/comfyui-api .
 
diff --git a/docker/build-api-images b/docker/build-api-images
@@ -2,7 +2,7 @@
 
 usage="Usage: $0 [comfy_version] [torch_version] [cuda_version] [api_version]"
 
-comfy_version=${1:-0.5.1}
+comfy_version=${1:-0.7.0}
 torch_version=${2:-2.8.0}
 cuda_version=${3:-12.6}
 
diff --git a/docker/build-comfy-base-images b/docker/build-comfy-base-images
@@ -1,6 +1,6 @@
 #! /usr/bin/bash
 
-comfy_version=${1:-0.5.1}
+comfy_version=${1:-0.7.0}
 torch_version=${2:-2.8.0}
 cuda_version=${3:-12.6}
 bases=("devel" "runtime")
diff --git a/docker/comfyui.dockerfile b/docker/comfyui.dockerfile
@@ -24,7 +24,7 @@ RUN uv pip install --no-cache-dir --system comfy-cli "huggingface_hub[cli]"
 
 WORKDIR /opt
 
-ARG comfy_version=0.5.1
+ARG comfy_version=0.7.0
 
 RUN git clone --depth 1 --branch v${comfy_version} https://github.com/comfyanonymous/ComfyUI.git
 
diff --git a/docker/push-comfy-base-images b/docker/push-comfy-base-images
@@ -2,7 +2,7 @@
 
 usage="Usage: $0 [comfy_version] [torch_version] [cuda_version]"
 
-comfy_version=${1:-0.5.1}
+comfy_version=${1:-0.7.0}
 torch_version=${2:-2.8.0}
 cuda_version=${3:-12.6}
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,11 +1,12 @@
 {
   "name": "comfyui-api",
-  "version": "1.16.0",
+  "version": "1.16.1",
   "description": "Wraps comfyui to make it easier to use as a stateless web service",
   "main": "dist/src/index.js",
   "scripts": {
     "full-test": "mocha --require ts-node/register --timeout=0 test/*.spec.ts",
-    "test": "mocha --require ts-node/register --timeout=0 test/core.spec.ts",
+    "test": "mocha --require ts-node/register --timeout=0 test/core.spec.ts test/utils.spec.ts",
+    "unit-test": "mocha --require ts-node/register --timeout=0 test/utils.spec.ts",
     "build": "tsc",
     "build-binary": "./build-binary",
     "postinstall": "npm install --cpu=wasm32 sharp"
diff --git a/src/server.ts b/src/server.ts
@@ -720,7 +720,35 @@ server.after(() => {
             },
           },
           async (request, reply) => {
-            const prompt = await node.generateWorkflow(request.body.input);
+            const log = app.log.child({ workflow: `${route}/${key}` });
+
+            log.debug({ input: request.body.input }, "Workflow input received");
+
+            let prompt;
+            try {
+              prompt = await node.generateWorkflow(request.body.input);
+              log.debug({ prompt }, "Generated ComfyUI prompt from workflow");
+            } catch (e: any) {
+              log.error(
+                { error: e.message, stack: e.stack },
+                "Failed to generate workflow prompt"
+              );
+              return reply.code(400).send({
+                error: `Failed to generate workflow prompt: ${e.message}`,
+                location: "input",
+              });
+            }
+
+            const promptRequestBody = {
+              ...request.body,
+              prompt,
+              input: undefined,
+            };
+
+            log.debug(
+              { promptRequestBody },
+              "Sending request to /prompt endpoint"
+            );
 
             const resp = await fetch(
               `http://localhost:${config.wrapperPort}/prompt`,
@@ -729,19 +757,26 @@ server.after(() => {
                 headers: {
                   "Content-Type": "application/json",
                 },
-                body: JSON.stringify({
-                  ...request.body,
-                  prompt,
-                  input: undefined,
-                }),
+                body: JSON.stringify(promptRequestBody),
                 dispatcher: getProxyDispatcher(),
               }
             );
             const body = (await resp.json()) as any;
             if (!resp.ok) {
+              log.error(
+                {
+                  status: resp.status,
+                  error: body.error,
+                  location: body.location,
+                  promptRequestBody,
+                },
+                "Workflow request to /prompt endpoint failed"
+              );
               return reply.code(resp.status).send(body);
             }
 
+            log.debug({ status: resp.status }, "Workflow completed successfully");
+
             body.input = request.body.input;
 
             return reply.code(resp.status).send(body);
diff --git a/src/storage-providers/hf.ts b/src/storage-providers/hf.ts
@@ -47,7 +47,13 @@ export class HFStorageProvider implements StorageProvider {
     }
     // Add repo type prefix for datasets
     const repoPrefix = repo_type === "dataset" ? "datasets/" : "";
-    return `https://huggingface.co/${repoPrefix}${repo}/resolve/${revision}/${directory}/${filename}`;
+    // URL-encode directory and filename to handle spaces and special characters
+    const encodedDirectory = directory
+      .split("/")
+      .map((part) => encodeURIComponent(part))
+      .join("/");
+    const encodedFilename = encodeURIComponent(filename);
+    return `https://huggingface.co/${repoPrefix}${repo}/resolve/${revision}/${encodedDirectory}/${encodedFilename}`;
   }
 
   testUrl(url: string): boolean {
diff --git a/src/types.ts b/src/types.ts
@@ -161,7 +161,12 @@ export interface Workflow {
 }
 
 export function isWorkflow(obj: any): obj is Workflow {
-  return "RequestSchema" in obj && "generateWorkflow" in obj;
+  return (
+    obj != null &&
+    typeof obj === "object" &&
+    "RequestSchema" in obj &&
+    "generateWorkflow" in obj
+  );
 }
 
 export interface WorkflowTree {
diff --git a/src/workflows/index.ts b/src/workflows/index.ts
@@ -2,6 +2,9 @@ import config from "../config";
 import { WorkflowTree, isWorkflow } from "../types";
 import fs from "fs";
 import ts from "typescript";
+import pino from "pino";
+
+const log = pino({ level: config.logLevel });
 
 const workflows: WorkflowTree = {};
 
@@ -10,12 +13,14 @@ const walk = (dir: string, tree: WorkflowTree) => {
   files.forEach((file) => {
     let filePath = `${dir}/${file}`;
     if (fs.statSync(filePath).isDirectory()) {
+      log.debug({ directory: filePath }, "Scanning workflow directory");
       tree[file] = {};
       walk(filePath, tree[file] as WorkflowTree);
     } else {
       // This is happening at runtime, so if it's .ts we need to compile it
       const newPath = filePath.replace(".ts", ".js");
       if (file.endsWith(".ts")) {
+        log.debug({ file: filePath }, "Transpiling TypeScript workflow");
         const source = fs.readFileSync(filePath, "utf8");
         const result = ts.transpileModule(source, {
           compilerOptions: { module: ts.ModuleKind.CommonJS },
@@ -29,10 +34,24 @@ const walk = (dir: string, tree: WorkflowTree) => {
       }
 
       // Eval the file in the current context
-      console.log(`Evaluating ${newPath}`);
-      const workflow = eval(fs.readFileSync(newPath, "utf8"));
-      if (workflow && isWorkflow(workflow)) {
-        tree[file.replace(".js", "").replace(".ts", "")] = workflow;
+      log.debug({ file: newPath }, "Evaluating workflow file");
+      try {
+        const workflow = eval(fs.readFileSync(newPath, "utf8"));
+        if (workflow && isWorkflow(workflow)) {
+          const workflowName = file.replace(".js", "").replace(".ts", "");
+          tree[workflowName] = workflow;
+          log.info({ workflow: workflowName, file: newPath }, "Loaded workflow");
+        } else {
+          log.warn(
+            { file: newPath },
+            "File does not export a valid Workflow object"
+          );
+        }
+      } catch (e: any) {
+        log.error(
+          { file: newPath, error: e.message, stack: e.stack },
+          "Failed to evaluate workflow file"
+        );
       }
     }
   });
diff --git a/test/core.spec.ts b/test/core.spec.ts
diff --git a/test/docker-image/Dockerfile b/test/docker-image/Dockerfile
diff --git a/test/docker-image/Dockerfile.smoketest b/test/docker-image/Dockerfile.smoketest
diff --git a/test/utils.spec.ts b/test/utils.spec.ts
