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

Refactor component types and component inheritance #110

Merged
merged 2 commits into from
Mar 12, 2024

Conversation

ohltyler
Copy link
Member

@ohltyler ohltyler commented Mar 12, 2024

Description

This PR refactors, renames, and improves upon the UI component class hierarchy used in the drag-and-drop workspace:

  • aligns the component types more closely with the backend direction of retrievers/indexers/transformers by refactoring, updating names, and adding new component types
  • improves inheritance on these base types to easily support sub-classes for creating specialty components (e.g., an OOTB text embedding transformer). An important goal is to have minimal code changes to support new component types in the future to encourage community involvement and rapid development
  • re-enables some placeholder values for the UI components for easy sanity testing. See demo video below.

Demo video with hardcoded workflow state:

screen-capture.16.webm

Issues Resolved

Makes progress on #73

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tyler Ohlsen <[email protected]>
@@ -6,7 +6,8 @@
"ui": true,
"requiredBundles": [],
"requiredPlugins": [
"navigation"
"navigation",
"opensearchDashboardsUtils"
Copy link
Member Author

@ohltyler ohltyler Mar 12, 2024

Choose a reason for hiding this comment

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

needed for createGetterSetter() used in services.ts. Was recently removed from requiredBundles due to it causing build errors, but without it it causes runtime errors. Correct pattern is to include this in requiredPlugins.

Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.42%. Comparing base (2d176f0) to head (2eed26e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #110      +/-   ##
==========================================
+ Coverage   19.30%   25.42%   +6.12%     
==========================================
  Files          50       53       +3     
  Lines         746      763      +17     
  Branches       71       73       +2     
==========================================
+ Hits          144      194      +50     
+ Misses        595      562      -33     
  Partials        7        7              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ohltyler ohltyler merged commit 616b1cb into opensearch-project:main Mar 12, 2024
8 checks passed
@ohltyler ohltyler deleted the blocks-update branch March 12, 2024 16:12
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 12, 2024
Signed-off-by: Tyler Ohlsen <[email protected]>
(cherry picked from commit 616b1cb)
ohltyler added a commit that referenced this pull request Mar 12, 2024
Signed-off-by: Tyler Ohlsen <[email protected]>
(cherry picked from commit 616b1cb)

Co-authored-by: Tyler Ohlsen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants