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

ENG 2154 Add parameter information to save operator #1137

Merged
merged 11 commits into from
Apr 3, 2023

Conversation

eunice-chan
Copy link
Contributor

@eunice-chan eunice-chan commented Mar 25, 2023

Describe your changes and why you are making these changes

In the UI, when I click on a save operator, there is nothing in the sidesheet that is helpful for discovering where the operator is: e.g. where in the integration it is saved (table_name, path, etc).

This PR adds parameter information. Combined with #1121, which will add the integration information, will provide all necessary information.

Related issue number (if any)

ENG 2154

Loom demo (if any)

Tested with save-to-S3; save-to-SQLite (relational DB)
image

UPDATE 3/27 11:27AM:
S3:
Screen Shot 2023-03-27 at 11 23 13 AM
RelationalDB:
Screen Shot 2023-03-27 at 11 23 22 AM
RelationalDB Tooltip:
Screen Shot 2023-03-27 at 11 23 30 AM

UPDATE 3/31 8:44AM:
Screen Shot 2023-03-31 at 8 43 15 AM
Screen Shot 2023-03-31 at 8 43 06 AM

Checklist before requesting a review

  • I have created a descriptive PR title. The PR title should complete the sentence "This PR...".
  • I have performed a self-review of my code.
  • I have included a small demo of the changes. For the UI, this would be a screenshot or a Loom video.
  • [N/A] If this is a new feature, I have added unit tests and integration tests.
  • [N/A] I have run the integration tests locally and they are passing.
  • I have run the linter script locally (See python3 scripts/run_linters.py -h for usage).
  • All features on the UI continue to work correctly.
  • Added one of the following CI labels:
    • run_integration_test: Runs integration tests
    • skip_integration_test: Skips integration tests (Should be used when changes are ONLY documentation/UI)

@eunice-chan eunice-chan added the skip_integration_test Skips required integration test (only documentation/UI changes) label Mar 25, 2023
Copy link
Contributor

@agiron123 agiron123 left a comment

Choose a reason for hiding this comment

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

Left some comments but you can merge once you resolve.

@vsreekanti
Copy link
Contributor

@eunice-chan, not sure if you've marked this as a draft because it's not ready for feedback yet. If so, feel free to disregard and share an update once you're ready.

Otherwise, here's a few small design tweaks:

  1. Since the parameters section is pretty small, let's lay it out side by side with the inputs section.
  2. Let's say "Table Name" rather than just "Table" for clarity's sake.
  3. Let's add a tooltip to the update mode explaining what it is.

Good work!

@eunice-chan
Copy link
Contributor Author

S3:
Screen Shot 2023-03-27 at 11 23 13 AM
RelationalDB:
Screen Shot 2023-03-27 at 11 23 22 AM
RelationalDB Tooltip:
Screen Shot 2023-03-27 at 11 23 30 AM

@eunice-chan eunice-chan marked this pull request as ready for review March 27, 2023 18:28
@vsreekanti
Copy link
Contributor

Hey Eunice, sorry if my first message wasn't clear. My suggestion was not to layout the parameters horizontally but instead to put the Inputs section of the view horizontally next to the Parameters section of the view. The original layout of the parameters was better.

Copy link
Contributor

@likawind likawind left a comment

Choose a reason for hiding this comment

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

Great job getting all components modularized for reusability! My main feedback is that we already have a component directory and it's not very clear what goes to pages/components and what does not. I'd suggest moving InfoTooltip to primitive and other 3 files to workflow/operator.

@vsreekanti
Copy link
Contributor

@eunice-chan, I merged #1121 just now, so you should be able to reuse the ResourceItem component there.

@eunice-chan
Copy link
Contributor Author

@likawind
Thanks for your feedback.
I added the components to src/components/pages/components since the DetailPageHeader was there. I agree workflow/operator is a better place for the LoadParamDisplay components. However, the primitives folder looks like it only contains stylings (*.styles.tsx) so I am not too sure if that is the best place for InfoTooltip

@kenxu95 kenxu95 removed their request for review March 28, 2023 17:35
@likawind
Copy link
Contributor

@eunice-chan sorry for the late reply. But yes, I agree with what you suggested by moving the two ParamsDisplay files to /operator and keep the other two in pages/components for now

@eunice-chan
Copy link
Contributor Author

Screen Shot 2023-03-31 at 8 43 15 AM

Screen Shot 2023-03-31 at 8 43 06 AM

@vsreekanti
Copy link
Contributor

Just a friendly reminder to add the ResourceItem to the sidesheet, so users know which system the data is being saved to.

@eunice-chan
Copy link
Contributor Author

(Oops apparently I never commented this)

Added the resource items to the sidesheet:

image

image

image

@eunice-chan
Copy link
Contributor Author

Screen Shot 2023-04-03 at 11 51 34 AM

Screen Shot 2023-04-03 at 11 51 42 AM

Screen Shot 2023-04-03 at 11 51 50 AM

@eunice-chan eunice-chan merged commit b0928d6 into main Apr 3, 2023
@vsreekanti vsreekanti deleted the eng-2154-add-information-about-the-saved-object branch April 3, 2023 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip_integration_test Skips required integration test (only documentation/UI changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants