Skip to content

feat: multiple output images; replace http polling with websocket to check when a workflow is done #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
May 2, 2025

Conversation

TimPietrusky
Copy link
Member

@TimPietrusky TimPietrusky commented Apr 30, 2025

Breaking Change

  • Versions < 5.0.0 returned the primary image data (S3 URL or base64 string) directly within an output.message field
  • Starting with v5.0.0, the output format has changed significantly:
    • Image data is now returned within an output.images field
    • This field is a list of dictionaries. Each dictionary contains:
      • filename: The original filename from ComfyUI
      • type: Either "s3_url" or "base64"
      • data: The corresponding S3 URL or the base64 encoded image string
  • Clients need to be updated to handle this new structure as it's not compatible with previous versions.

Features

Documentation

  • Major Restructure: Refactored the main README.md into a concise overview and quickstart guide, moving detailed sections (deployment, configuration, customization, development, ci/cd, acknowledgments) into separate, focused files within the docs/ directory for improved readability and maintainability
  • Improved Customization Guide: Rewrote docs/customization.md to feature the new, simpler method using a custom Dockerfile with comfy-cli commands (comfy node install, comfy model download). Removed the old method requiring repository forks and snapshots

Bug Fixes

  • Input Image Base64 Decoding: Correctly handles optional data:[...];base64,... prefixes in input image strings.

@TimPietrusky TimPietrusky changed the title feat: remove polling; use websocket instead; allow multiple output images feat: multiple output images; replace http polling with websocket to check when a workflow is done May 2, 2025
@TimPietrusky TimPietrusky merged commit b14068f into main May 2, 2025
1 check passed
@TimPietrusky TimPietrusky deleted the feat/refactor branch May 2, 2025 22:50
TimPietrusky pushed a commit that referenced this pull request May 2, 2025
# [5.0.0](4.0.1...5.0.0) (2025-05-02)

### Features

* multiple output images; replace http polling with websocket to check when a workflow is done ([#118](#118)) ([b14068f](b14068f))

### BREAKING CHANGES

* api output is not compatible anymore

* docs: added all possible comfyui folders; simplified guide of method 1

* fix(model): flux.1-schnell is gated

* feat: update to 0.3.30

* test: don't run "snapshot_restoration" tests

* chore: force local images

* docs: lowercase for code comments

* ci: run release for changes in "main"

* fix: workflow trigger

* ci: build only base for now
@TimPietrusky
Copy link
Member Author

🎉 This PR is included in version 5.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment