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

[Feature][UI] Provide a warning or error if Blob format field does not match expected value. #583

Closed
1 of 13 tasks
schottra opened this issue Nov 6, 2020 · 2 comments
Closed
1 of 13 tasks
Labels
enhancement New feature or request ui Admin console user interface untriaged This issues has not yet been looked at by the Maintainers

Comments

@schottra
Copy link
Contributor

schottra commented Nov 6, 2020

Motivation: Why do you think this is important?
It can be confusing when attempting to provide a value for a Blob input and being unsure what format is expected. There is no clear help for the user in Console, and the only recourse would be to look at the code for the selected workflow version and find the Task/Workflow input definition to check the format type.

Additionally, if you specify a format value that does not match the one in the input definition, you will receive an error when attempting to launch.

Goal: What should the final outcome look like, ideally?

  1. If the format field is set in a Blob input definition, I should have a hint in the UI telling me what format is expected.
  2. The value of the format field can/should be pre-filled with the value taken from the workflow/task definition and/or the launch plan.
  3. If I attempt to specify a format type that does not match the expected value, I get a client-side warning or error.

Describe alternatives you've considered
N/A

Flyte component

  • Overall
  • Flyte Setup and Installation scripts
  • Flyte Documentation
  • Flyte communication (slack/email etc)
  • FlytePropeller
  • FlyteIDL (Flyte specification language)
  • Flytekit (Python SDK)
  • FlyteAdmin (Control Plane service)
  • FlytePlugins
  • DataCatalog
  • FlyteStdlib (common libraries)
  • FlyteConsole (UI)
  • Other

[Optional] Propose: Link/Inline

  • Decorate either the placeholder text or helper text for a blob input with the format value taken from the input definition. This serves as a hint to the user of the expected format of the data stored at the given uri
  • Read the format value from the workflow/task/launch plan and pre-fill the format field.
  • If the user chooses not to provide a value for format, but one exists in the spec, copy that value over when constructing the inputs for the launch request.
  • Either:
    • When validating inputs on the client side, generate an error if the format field does not match the type specified in the input definition
    • Add functionality to generate a validation warning client side if the value doesn't match the expected value. This would differ from our existing functionality in that it would not wait for first submission to begin showing the warning. It would use the same debouncing logic (don't validate until no input has been received for some time) and then immediately set the field to a warning and revalidate on new user input.
@schottra schottra added enhancement New feature or request ui Admin console user interface untriaged This issues has not yet been looked at by the Maintainers efficiency labels Nov 6, 2020
@kumare3
Copy link
Contributor

kumare3 commented Nov 6, 2020

I think we should set the format field and dimensionality and probably make them immutable
The input form should set the "type" and "meta type" information for the form. For example set the format in the case of Blob or Multipart-blob, set the schema columns to be what are expected.

@kumare3 kumare3 removed the efficiency label Feb 9, 2021
@anrusina
Copy link

Closed as we get rid of Blobs (deprecated)

eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
eapolinario added a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
* Revert "Only register core (flyteorg#598)"

This reverts commit e4be1f8.

Signed-off-by: Eduardo Apolinario <[email protected]>

* Revert "Fix master (flyteorg#597)"

This reverts commit 503fd43.

Signed-off-by: Eduardo Apolinario <[email protected]>

* Revert "Use slimmer version of flytekit (flyteorg#583)"

This reverts commit 9993b98.

Signed-off-by: Eduardo Apolinario <[email protected]>

Co-authored-by: Eduardo Apolinario <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
Signed-off-by: Jason Porter <[email protected]>

Signed-off-by: Jason Porter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ui Admin console user interface untriaged This issues has not yet been looked at by the Maintainers
Projects
None yet
Development

No branches or pull requests

3 participants