Skip to content
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

Ensure frontend functions work when they don't return a value #8521

Merged
merged 8 commits into from
Jun 21, 2024
Merged

Conversation

pngwn
Copy link
Member

@pngwn pngwn commented Jun 10, 2024

Description

We now expect some kind of value to be passed into a 'submit' even if it is an empty array (no data). This normally happens even where there are no component inputs, the exception to this is when the frontend function returns nothing or a falsey value. Since the return value of the frontend function gets passed into the 'submit' call, this was causing an error.

I have added a default value to the problematic function to address this, and added a few unit tests to prevent regressions.

Closes: #8495

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Tests

  1. PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests: bash scripts/run_all_tests.sh

  2. You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 10, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
Storybook ready! Storybook preview
🦄 Changes detecting...

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/e9b044aa697c604c819be8fd7533913b45e5de93/gradio-4.36.1-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@e9b044aa697c604c819be8fd7533913b45e5de93#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/e9b044aa697c604c819be8fd7533913b45e5de93/gradio-client-1.1.1.tgz

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 10, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/app patch
@gradio/client patch
gradio patch
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Ensure frontend functions work when they don't return a value

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

@abidlabs abidlabs requested a review from aliabid94 June 10, 2024 16:38
@aliabid94
Copy link
Collaborator

aliabid94 commented Jun 11, 2024

The root problem is that Payload.data is supposed to be of unknown[], but if the js function does not return anything, Payload.data gets set to undefined, which is not of type unknown[]. This will cause issues downstream, which currently is manifesting in map_data_to_params. I believe the appropriate way to fix the overall problem would be to modify process_frontend_fn to return [] when there are no output components.

@pngwn
Copy link
Member Author

pngwn commented Jun 11, 2024

Yeah I can change that. I'm not sure what other downstream issues it would cause though. This has been the behaviour forever, it just hasn't been erroring until now.

@aliabid94
Copy link
Collaborator

aliabid94 commented Jun 17, 2024

Actually its probably enough to just type Payload.data as unknown[] | undefined and keep the current logic. I just meant the reason that things broke is because the typing was wrong - Payload.data could be undefined as well - and this caused an issue downstream in map_data_to_params, but if we simply fix the typing, then the typechecker should also catch anywhere else we assumed it to be a list.

@pngwn
Copy link
Member Author

pngwn commented Jun 20, 2024

I think it's cleaner to always return an array from the frontend function, so I've added some logic for that. Should be good now.

Copy link
Collaborator

@aliabid94 aliabid94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome LGTM!

@pngwn pngwn merged commit 900cf25 into main Jun 21, 2024
8 checks passed
@pngwn pngwn deleted the 8495-js branch June 21, 2024 08:17
This was referenced Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error when using js for event listeners
3 participants