1.17.0 download improvements (#130)

shawnrushefsky · web-flow · commit 65ab27b391dd · 2026-01-12T19:16:32.000+04:00
* bump to comfy 0.8.2

* version bump to 1.17.0

* enhance downloading capabilities
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.16.1
+ARG api_version=1.17.0
 
 # Download the comfyui-api binary, and make it executable
 ADD https://github.com/SaladTechnologies/comfyui-api/releases/download/${api_version}/comfyui-api .
@@ -597,6 +597,8 @@ pip:
 custom_nodes:
   - node-name-from-comfy-registry
   - https://github.com/username/repo
+  - https://github.com/username/repo/tree/commit-hash-or-branch
+  - https://github.com/username/repo@v1.0.0
 models:
   before_start:
     - url: https://example.com/model.ckpt
@@ -612,7 +614,13 @@ If a manifest is provided, the server will perform the following in order:
 
 1. Install any apt packages listed in the `apt` field.
 2. Install any pip packages listed in the `pip` field. Uses `uv`, otherwise falls back to `pip`.
-3. Install any custom nodes listed in the `custom_nodes` field, using the `comfy` cli tool if available and a plain string is provided, or by cloning the provided git repository if a URL is provided. If cloned, `requirements.txt` will be installed if it exists, using `uv` if available, otherwise falling back to `pip`.
+3. Install any custom nodes listed in the `custom_nodes` field, using the `comfy` cli tool if available and a plain string is provided, or by cloning the provided git repository if a URL is provided. You can pin a specific commit, branch, or tag using various URL formats:
+   - **GitHub**: `/tree/{ref}`, `/commit/{sha}`, `/releases/tag/{tag}`
+   - **GitLab**: `/-/tree/{ref}`, `/-/commit/{sha}`
+   - **Bitbucket**: `/src/{ref}`, `/commits/{sha}`
+   - **Generic**: `repo@{ref}` (npm/pip style, e.g., `https://github.com/user/repo@v1.0.0`)
+
+   Example: `https://github.com/kijai/ComfyUI-KJNodes/tree/204f6d5aae73b10c0fe2fb26e61405fd6337bb77`. If cloned, `requirements.txt` will be installed if it exists, using `uv` if available, otherwise falling back to `pip`.
 4. Download any models listed in the `models.before_start` field, and save them to the specified `local_path`.
 5. Start background downloading any models listed in the `models.after_start` field, and save them to the specified `local_path`. These downloads will be started in the background and will not block the server from accepting requests. This is useful for preloading less frequently used models.
 
@@ -1007,7 +1015,8 @@ If you are using the azure blob storage functionality, make sure to set all of t
 | SYSTEM_META\_\*              | (not set)                  | Any environment variable starting with SYSTEM*META* will be sent to the system webhook as metadata. i.e. `SYSTEM_META_batch=abc` will add `{"batch": "abc"}` to the `.metadata` field on system webhooks.                                    |
 | SYSTEM_WEBHOOK_EVENTS        | (not set)                  | Comma separated list of events to send to the webhook. Only selected events will be sent. If not set, no events will be sent. See [System Events](#system-events). You may also use the special value `all` to subscribe to all event types. |
 | SYSTEM_WEBHOOK_URL           | (not set)                  | Optionally receive via webhook the events that ComfyUI emits on websocket. This includes progress events.                                                                                                                                    |
-| WARMUP_PROMPT_FILE           | (not set)                  | Path to warmup prompt file (optional)                                                                                                                                                                                                        |
+| WARMUP_PROMPT_FILE           | (not set)                  | Path to warmup prompt file (optional). If both `WARMUP_PROMPT_FILE` and `WARMUP_PROMPT_URL` are set, `WARMUP_PROMPT_FILE` takes precedence.                                                                                                  |
+| WARMUP_PROMPT_URL            | (not set)                  | URL to download warmup prompt from (optional). Allows using a remote warmup workflow without building a custom Docker image. Downloaded and parsed at startup before ComfyUI launches.                                                       |
 | WEBHOOK_SECRET               | (empty string)             | If set, the server will sign webhook_v2 requests with this secret.                                                                                                                                                                           |
 | WORKFLOW_DIR                 | "/workflows"               | Directory for workflow files                                                                                                                                                                                                                 |
 
@@ -1089,6 +1098,8 @@ Notes:
 5. **Warmup Prompt**:
 
    - If `WARMUP_PROMPT_FILE` is set, the application will load and parse a warmup prompt from this file.
+   - Alternatively, set `WARMUP_PROMPT_URL` to download the warmup prompt from a remote URL at startup. This allows using a custom warmup workflow without building a custom Docker image.
+   - If both are set, `WARMUP_PROMPT_FILE` takes precedence.
    - The checkpoint used in this prompt can be used as the default for workflow models.
 
 6. **Models**:
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,6 +1,6 @@
 services:
   comfyui:
-    image: ghcr.io/saladtechnologies/comfyui-api:comfy0.7.0-torch2.8.0-cuda12.8-runtime
+    image: ghcr.io/saladtechnologies/comfyui-api:comfy0.8.2-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.7.0
+ARG comfy_version=0.8.2
 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.1
+ARG api_version=1.17.0
 
 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.7.0}
+comfy_version=${1:-0.8.2}
 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.7.0}
+comfy_version=${1:-0.8.2}
 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.7.0
+ARG comfy_version=0.8.2
 
 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.7.0}
+comfy_version=${1:-0.8.2}
 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,6 +1,6 @@
 {
   "name": "comfyui-api",
-  "version": "1.16.1",
+  "version": "1.17.0",
   "description": "Wraps comfyui to make it easier to use as a stateless web service",
   "main": "dist/src/index.js",
   "scripts": {
diff --git a/src/config.ts b/src/config.ts
@@ -44,6 +44,7 @@ const {
   SYSTEM_WEBHOOK_EVENTS,
   SYSTEM_WEBHOOK_URL,
   WARMUP_PROMPT_FILE,
+  WARMUP_PROMPT_URL,
   WEBHOOK_SECRET,
   WORKFLOW_DIR = "/workflows",
 } = process.env;
@@ -606,6 +607,12 @@ const config = {
    */
   warmupPrompt,
 
+  /**
+   * (Optional) URL to download the warmup prompt from. Specified by WARMUP_PROMPT_URL env var.
+   * If both WARMUP_PROMPT_FILE and WARMUP_PROMPT_URL are set, WARMUP_PROMPT_FILE takes precedence.
+   */
+  warmupPromptUrl: WARMUP_PROMPT_URL,
+
   /**
    * (Optional) The secret used to sign webhooks. Specified by WEBHOOK_SECRET env var.
    */
@@ -666,4 +673,26 @@ if (
   config.saladMetadata = null;
 }
 
+/**
+ * Set the warmup prompt from downloaded content.
+ * This function is called when WARMUP_PROMPT_URL is used to download the warmup file.
+ */
+export function setWarmupPrompt(content: string): void {
+  try {
+    const parsed = JSON.parse(content);
+    config.warmupPrompt = parsed;
+
+    // Extract checkpoint from warmup prompt
+    for (const nodeId in parsed) {
+      const node = parsed[nodeId];
+      if (node.class_type === "CheckpointLoaderSimple") {
+        config.warmupCkpt = node.inputs.ckpt_name;
+        break;
+      }
+    }
+  } catch (e: any) {
+    throw new Error(`Failed to parse warmup prompt: ${e.message}`);
+  }
+}
+
 export default config;
diff --git a/src/git-url-parser.ts b/src/git-url-parser.ts
@@ -0,0 +1,78 @@
+/**
+ * Parse a Git URL to extract the base repository URL and optional ref (branch/commit/tag).
+ * Supports multiple formats from different Git hosting platforms:
+ *
+ * GitHub:
+ * - https://github.com/user/repo/tree/{ref}
+ * - https://github.com/user/repo/commit/{sha}
+ * - https://github.com/user/repo/releases/tag/{tag}
+ *
+ * GitLab:
+ * - https://gitlab.com/user/repo/-/tree/{ref}
+ * - https://gitlab.com/user/repo/-/commit/{sha}
+ *
+ * Bitbucket:
+ * - https://bitbucket.org/user/repo/src/{ref}
+ * - https://bitbucket.org/user/repo/commits/{sha}
+ *
+ * Generic (npm/pip style):
+ * - https://github.com/user/repo@{ref}
+ * - https://github.com/user/repo.git@{ref}
+ *
+ * Plain URLs (no ref):
+ * - https://github.com/user/repo
+ * - https://github.com/user/repo.git
+ */
+export function parseGitUrl(repoUrl: string): {
+  baseUrl: string;
+  ref: string | null;
+} {
+  // npm/pip style: repo@ref or repo.git@ref
+  const atRefMatch = repoUrl.match(/^(.+?)@([^@\/]+)$/);
+  if (atRefMatch) {
+    return { baseUrl: atRefMatch[1], ref: atRefMatch[2] };
+  }
+
+  // GitLab: /-/tree/{ref}, /-/commit/{sha}
+  // Check GitLab BEFORE GitHub because GitLab URLs contain /tree/ and /commit/
+  // which would otherwise match the less specific GitHub patterns
+  const gitlabTreeMatch = repoUrl.match(/^(.+?)\/-\/tree\/([^\/]+)$/);
+  if (gitlabTreeMatch) {
+    return { baseUrl: gitlabTreeMatch[1], ref: gitlabTreeMatch[2] };
+  }
+
+  const gitlabCommitMatch = repoUrl.match(/^(.+?)\/-\/commit\/([^\/]+)$/);
+  if (gitlabCommitMatch) {
+    return { baseUrl: gitlabCommitMatch[1], ref: gitlabCommitMatch[2] };
+  }
+
+  // GitHub: /tree/{ref}, /commit/{sha}, /releases/tag/{tag}
+  const githubTreeMatch = repoUrl.match(/^(.+?)\/tree\/([^\/]+)$/);
+  if (githubTreeMatch) {
+    return { baseUrl: githubTreeMatch[1], ref: githubTreeMatch[2] };
+  }
+
+  const githubCommitMatch = repoUrl.match(/^(.+?)\/commit\/([^\/]+)$/);
+  if (githubCommitMatch) {
+    return { baseUrl: githubCommitMatch[1], ref: githubCommitMatch[2] };
+  }
+
+  const githubReleaseMatch = repoUrl.match(/^(.+?)\/releases\/tag\/([^\/]+)$/);
+  if (githubReleaseMatch) {
+    return { baseUrl: githubReleaseMatch[1], ref: githubReleaseMatch[2] };
+  }
+
+  // Bitbucket: /src/{ref} (may have trailing path), /commits/{sha}
+  const bitbucketSrcMatch = repoUrl.match(/^(.+?)\/src\/([^\/]+)(?:\/.*)?$/);
+  if (bitbucketSrcMatch) {
+    return { baseUrl: bitbucketSrcMatch[1], ref: bitbucketSrcMatch[2] };
+  }
+
+  const bitbucketCommitsMatch = repoUrl.match(/^(.+?)\/commits\/([^\/]+)$/);
+  if (bitbucketCommitsMatch) {
+    return { baseUrl: bitbucketCommitsMatch[1], ref: bitbucketCommitsMatch[2] };
+  }
+
+  // No ref found, return URL as-is
+  return { baseUrl: repoUrl, ref: null };
+}
diff --git a/src/remote-storage-manager.ts b/src/remote-storage-manager.ts
@@ -14,6 +14,7 @@ import {
   getContentTypeFromUrl,
   getDirectorySizeInBytes,
 } from "./utils";
+import { parseGitUrl } from "./git-url-parser";
 
 /**
  * Metadata for cached files, stored in sidecar .meta files.
@@ -501,22 +502,47 @@ class RemoteStorageManager {
     targetDir: string
   ): Promise<string> {
     await fsPromises.mkdir(targetDir, { recursive: true });
+
+    // Parse the URL to extract base URL and optional ref (branch/commit/tag)
+    const { baseUrl, ref } = parseGitUrl(repoUrl);
+
     // Check to see if the repo is already cloned
-    const repoName = repoUrl
-      .substring(repoUrl.lastIndexOf("/") + 1)
+    const repoName = baseUrl
+      .substring(baseUrl.lastIndexOf("/") + 1)
       .replace(/\.git$/, "");
     const existingDir = path.join(targetDir, repoName);
     if (fs.existsSync(existingDir)) {
       // Check if it's a git repo
       if (fs.existsSync(path.join(existingDir, ".git"))) {
-        this.log.info(`Repository ${repoUrl} already cloned, pulling latest`);
-        try {
-          await execFilePromise("git", ["pull"], { cwd: existingDir });
-        } catch (error) {
-          this.log.error(
-            { error },
-            `Error pulling latest changes for ${repoUrl}, using existing copy`
+        if (ref) {
+          // If a specific ref is requested, fetch and checkout that ref
+          this.log.info(
+            `Repository ${baseUrl} already cloned, checking out ref: ${ref}`
           );
+          try {
+            await execFilePromise("git", ["fetch", "--all"], {
+              cwd: existingDir,
+            });
+            await execFilePromise("git", ["checkout", ref], {
+              cwd: existingDir,
+            });
+          } catch (error) {
+            this.log.error(
+              { error },
+              `Error checking out ref ${ref} for ${baseUrl}, using existing copy`
+            );
+          }
+        } else {
+          // No specific ref, just pull latest
+          this.log.info(`Repository ${baseUrl} already cloned, pulling latest`);
+          try {
+            await execFilePromise("git", ["pull"], { cwd: existingDir });
+          } catch (error) {
+            this.log.error(
+              { error },
+              `Error pulling latest changes for ${baseUrl}, using existing copy`
+            );
+          }
         }
         return existingDir;
       } else {
@@ -526,9 +552,15 @@ class RemoteStorageManager {
       }
     }
 
-    // Clone the url to the custom nodes directory
-    this.log.info(`Cloning ${repoUrl} to ${targetDir}`);
-    await execFilePromise("git", ["clone", repoUrl], { cwd: targetDir });
+    // Clone the repo to the custom nodes directory
+    this.log.info(`Cloning ${baseUrl} to ${targetDir}`);
+    await execFilePromise("git", ["clone", baseUrl], { cwd: targetDir });
+
+    // If a specific ref was requested, checkout that ref
+    if (ref) {
+      this.log.info(`Checking out ref: ${ref}`);
+      await execFilePromise("git", ["checkout", ref], { cwd: existingDir });
+    }
 
     return path.join(targetDir, repoName);
   }
diff --git a/src/server.ts b/src/server.ts
@@ -9,7 +9,7 @@ import {
 } from "fastify-type-provider-zod";
 import fsPromises from "fs/promises";
 import path from "path";
-import config from "./config";
+import config, { setWarmupPrompt } from "./config";
 import {
   zodToMarkdownTable,
   setDeletionCost,
@@ -863,6 +863,36 @@ async function downloadAllModels(
   }
 }
 
+async function downloadWarmupPrompt() {
+  // Skip if warmup prompt is already set (from WARMUP_PROMPT_FILE)
+  if (config.warmupPrompt) {
+    return;
+  }
+
+  // Download warmup prompt from URL if specified
+  if (config.warmupPromptUrl) {
+    server.log.info(
+      `Downloading warmup prompt from ${config.warmupPromptUrl}`
+    );
+    const start = Date.now();
+    const resp = await fetch(config.warmupPromptUrl, {
+      headers: config.httpAuthHeader,
+      dispatcher: getProxyDispatcher(),
+    });
+    if (!resp.ok) {
+      throw new Error(
+        `Failed to download warmup prompt from ${config.warmupPromptUrl}: ${resp.status} ${resp.statusText}`
+      );
+    }
+    const content = await resp.text();
+    setWarmupPrompt(content);
+    const duration = (Date.now() - start) / 1000;
+    server.log.info(
+      `Downloaded and parsed warmup prompt in ${duration.toFixed(2)}s`
+    );
+  }
+}
+
 async function processManifest() {
   if (config.manifest) {
     if (config.manifest.apt) {
@@ -906,6 +936,7 @@ export async function start() {
   try {
     const start = Date.now();
     await remoteStorageManager.enforceCacheSize();
+    await downloadWarmupPrompt();
     await processManifest();
     if (config.manifest) {
       server.log.info(
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

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "comfyui-api",`
`3`		`- "version": "1.16.1",`
	`3`	`+ "version": "1.17.0",`
`4`	`4`	`"description": "Wraps comfyui to make it easier to use as a stateless web service",`
`5`	`5`	`"main": "dist/src/index.js",`
`6`	`6`	`"scripts": {`