fix(ui): disable width and height output on image batch output #7361
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There's a technical challenge with outputting these values directly. `ImageField` does not store them, so the batch's `ImageField` collection does not have width and height for each image. In order to set up the batch and pass along width and height for each image, we'd need to make a network request for each image when the user clicks Invoke. It would often be cached, but this will eventually create a scaling issue and poor user experience. As a very simple workaround, users can output the batch image output into an `Image Primitive` node to access the width and height. This change is implemented by adding some simple special handling when parsing the output fields for the `image_batch` node. I'll keep this situation in mind when extending the batching system to other field types.
psychedelicious
requested review from
blessedcoolant,
maryhipp and
hipsterusername
as code owners
maryhipp
approved these changes
Nov 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
There's a technical challenge with outputting these values directly.
ImageFielddoes not store them, so the batch'sImageFieldcollection does not have width and height for each image.In order to set up the batch and pass along width and height for each image, we'd need to make a network request for each image when the user clicks Invoke. It would often be cached, but this will eventually create a scaling issue and poor user experience.
As a very simple workaround, users can output the batch image output into an
Image Primitivenode to access the width and height.This change is implemented by adding some simple special handling when parsing the output fields for the
image_batchnode.I'll keep this situation in mind when extending the batching system to other field types.
Related Issues / Discussions
https://discord.com/channels/1020123559063990373/1149506274971631688/1308789783560196157
QA Instructions
You should no longer see
widthandheightas output fields for theImage Batchnode.Merge Plan
n/a
Checklist