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

Add a new vis_augmenter plugin #3107

Conversation

ohltyler
Copy link
Member

@ohltyler ohltyler commented Dec 19, 2022

Signed-off-by: Tyler Ohlsen ohltyler@amazon.com

Description

Adds a new vis_augmenter plugin which will maintain & support different interfaces & types related to plugin integration projects, such as the to-be-renamed 'Feature Anywhere' project. Details on the purpose & responsibilities of this new plugin can be found in the issue.

This PR only sets up the boilerplate code for the new plugin. The additions of the new saved object type and expression function types will be added in later PRs. Breaking it up for readability purposes.

Issues Resolved

Closes #2958

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler requested a review from a team as a code owner December 19, 2022 19:49
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler changed the title Add new plugin_integration plugin Add a new plugin_integration plugin Dec 19, 2022
@kristenTian
Copy link
Contributor

kristenTian commented Dec 20, 2022

Reminder to update changelog.md so the check passes - Discard this, didn't notice it's feature branch.

@kavilla kavilla linked an issue Dec 20, 2022 that may be closed by this pull request
@ohltyler
Copy link
Member Author

Reminder to update changelog.md so the check passes

What's the strategy for this for PRs into feature branches? Should it be added to the Unreleased section? And even so, I could imagine a lot of merge conflicts when trying to finally merge this branch into main and subsequently 2.x.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler
Copy link
Member Author

@kavilla @joshuarrrr @kristenTian let me know if you have concerns for the name of this plugin. My goal is to have a generic enough name such that this plugin can be used for supporting the ongoing integrations (AD/alerting with visualizations, AD forecasting with visualizations) + future integrations.

I was thinking visualization_plugin_integration or visualization_integration at first, but I figure we may have future integrations potentially with other saved objects, like Dashboards.

@kristenTian
Copy link
Contributor

@kavilla @joshuarrrr @kristenTian let me know if you have concerns for the name of this plugin. My goal is to have a generic enough name such that this plugin can be used for supporting the ongoing integrations (AD/alerting with visualizations, AD forecasting with visualizations) + future integrations.

I was thinking visualization_plugin_integration or visualization_integration at first, but I figure we may have future integrations potentially with other saved objects, like Dashboards.

Do you foreseen plugins other than AD/alerting can also be benefiting from this work? For example ISM or security, or would this just be extended usage for Analytics Plugins?

@ohltyler
Copy link
Member Author

ohltyler commented Dec 20, 2022

@kavilla @joshuarrrr @kristenTian let me know if you have concerns for the name of this plugin. My goal is to have a generic enough name such that this plugin can be used for supporting the ongoing integrations (AD/alerting with visualizations, AD forecasting with visualizations) + future integrations.
I was thinking visualization_plugin_integration or visualization_integration at first, but I figure we may have future integrations potentially with other saved objects, like Dashboards.

Do you foreseen plugins other than AD/alerting can also be benefiting from this work? For example ISM or security, or would this just be extended usage for Analytics Plugins?

I could see potential with ML commons, such as showing model results on top of visualizations or dashboards. Essentially, I want to avoid having a narrowly-scoped name which would be changed to something more generic in the future, since plugin renaming could cause lots of headaches regarding upgrades, BWC compatibility, etc.

At a high level, this is setting up a framework to persist relationships from arbitrary plugin resources to arbitrary saved objects, as well as how to append or augment data for those saved objects

@joshuarrrr
Copy link
Member

Reminder to update changelog.md so the check passes

What's the strategy for this for PRs into feature branches? Should it be added to the Unreleased section? And even so, I could imagine a lot of merge conflicts when trying to finally merge this branch into main and subsequently 2.x.

I'd argue that it doesn't make sense to update the CHANGELOG for feature branch development, and that we can add thoughtful CHANGELOG items when merging the feature branch to main. So my vote would be to just use the Skip-Changelog label for now, and to update the workflow to not include CHANGELOG checks on feature branches.

@ohltyler
Copy link
Member Author

After speaking with @joshuarrrr we've come to agreement to rename this to vis_augmenter. It’s worth keeping it vis-centric rather than too generic, and a little more descriptive in what our feature actually does, which is augmenting a vis rather than simply linking it. Also it will be better to avoid plugin in the plugin name itself since that could cause confusion in what the plugin's purpose is.

@ohltyler ohltyler added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Dec 22, 2022
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler
Copy link
Member Author

I'm going to keep #3108 as a standalone PR. I'll rebase it after this is merged; it will be a quick follow-up.

@ohltyler ohltyler changed the title Add a new plugin_integration plugin Add a new vis_augmenter plugin Dec 22, 2022
@codecov-commenter
Copy link

codecov-commenter commented Dec 22, 2022

Codecov Report

Merging #3107 (241c133) into feature/feature-anywhere (808129b) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@                     Coverage Diff                      @@
##           feature/feature-anywhere    #3107      +/-   ##
============================================================
- Coverage                     66.67%   66.67%   -0.01%     
============================================================
  Files                          3219     3219              
  Lines                         61450    61450              
  Branches                       9417     9417              
============================================================
- Hits                          40973    40969       -4     
- Misses                        18232    18234       +2     
- Partials                       2245     2247       +2     
Impacted Files Coverage Δ
...ic/application/models/sense_editor/sense_editor.ts 64.00% <0.00%> (-1.78%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@joshuarrrr joshuarrrr merged commit ba6f9eb into opensearch-project:feature/feature-anywhere Dec 22, 2022
@ohltyler ohltyler deleted the add-base-plugin branch December 22, 2022 19:14
@joshuarrrr joshuarrrr added the v2.5.0 'Issues and PRs related to version v2.5.0' label Dec 23, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 5, 2023
This PR only sets up the boilerplate code for the new plugin. The additions of the new saved object type and expression function types will be added in later PRs. Breaking it up for readability purposes.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
(cherry picked from commit ba6f9eb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@joshuarrrr joshuarrrr removed backport 2.x v2.5.0 'Issues and PRs related to version v2.5.0' labels Jan 5, 2023
ohltyler added a commit to ohltyler/OpenSearch-Dashboards that referenced this pull request Feb 1, 2023
This PR only sets up the boilerplate code for the new plugin. The additions of the new saved object type and expression function types will be added in later PRs. Breaking it up for readability purposes.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
ohltyler added a commit to ohltyler/OpenSearch-Dashboards that referenced this pull request Feb 1, 2023
This PR only sets up the boilerplate code for the new plugin. The additions of the new saved object type and expression function types will be added in later PRs. Breaking it up for readability purposes.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Anywhere] Introduce a new Feature-Anywhere plugin
5 participants