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

[Workspace] Add WorkspacePluginSetup interface #6118

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

Hailong-am
Copy link
Collaborator

@Hailong-am Hailong-am commented Mar 12, 2024

Description

Add a new interface WorkspacePluginSetup, so that other plugins depends on workspace plugin.

Issues Resolved

related to opensearch-project/security-dashboards-plugin#1822

Screenshot

Testing the changes

Check List

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

Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.14%. Comparing base (4b89ad0) to head (e9a969a).
Report is 606 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6118   +/-   ##
=======================================
  Coverage   67.14%   67.14%           
=======================================
  Files        3326     3326           
  Lines       64394    64394           
  Branches    10358    10358           
=======================================
  Hits        43237    43237           
  Misses      18627    18627           
  Partials     2530     2530           
Flag Coverage Δ
Linux_1 31.73% <ø> (ø)
Linux_2 55.23% <ø> (ø)
Linux_3 44.72% <ø> (+0.01%) ⬆️
Linux_4 35.08% <ø> (ø)
Windows_1 31.75% <ø> (ø)
Windows_2 55.20% <ø> (ø)
Windows_3 44.73% <ø> (ø)
Windows_4 35.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@SuZhou-Joe SuZhou-Joe added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Mar 12, 2024
@@ -18,4 +18,4 @@ export const config: PluginConfigDescriptor = {
schema: configSchema,
};

export { WorkspaceFindOptions } from './types';
export { WorkspaceFindOptions, WorkspacePluginSetup } from './types';
Copy link
Member

@SuZhou-Joe SuZhou-Joe Mar 12, 2024

Choose a reason for hiding this comment

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

Though only Setup is needed, shall we export Start as well to keep the convention?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

sounds good, WorkspacePluginStart added.

Hailong-am and others added 4 commits March 12, 2024 16:18
…oject#6094)

* feat: add comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: update unit test

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: add CHANGELOG

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize code

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize code

Signed-off-by: SuZhou-Joe <[email protected]>

---------

Signed-off-by: SuZhou-Joe <[email protected]>
Signed-off-by: Hailong Cui <[email protected]>
This reverts commit 55f6344.

Signed-off-by: Hailong Cui <[email protected]>
@ruanyl ruanyl merged commit 9cdc7c9 into opensearch-project:main Mar 13, 2024
76 of 80 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 16, 2024
* Add workspacePluginSetup type

Signed-off-by: Hailong Cui <[email protected]>

* add fakenews.co to .lycheeexclude

Signed-off-by: Hailong Cui <[email protected]>

* [Workspace] Add a workspace client in workspace plugin (#6094)

* feat: add comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: update unit test

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: add CHANGELOG

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize comment

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize code

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: optimize code

Signed-off-by: SuZhou-Joe <[email protected]>

---------

Signed-off-by: SuZhou-Joe <[email protected]>
Signed-off-by: Hailong Cui <[email protected]>

* Revert "add fakenews.co to .lycheeexclude"

This reverts commit 55f6344.

Signed-off-by: Hailong Cui <[email protected]>

* Add WorkspacePluginStart

Signed-off-by: Hailong Cui <[email protected]>

---------

Signed-off-by: Hailong Cui <[email protected]>
Signed-off-by: SuZhou-Joe <[email protected]>
Co-authored-by: SuZhou-Joe <[email protected]>
(cherry picked from commit 9cdc7c9)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
SuZhou-Joe added a commit that referenced this pull request Apr 16, 2024
* Add workspacePluginSetup type



* add fakenews.co to .lycheeexclude



* [Workspace] Add a workspace client in workspace plugin (#6094)

* feat: add comment



* feat: update unit test



* feat: add CHANGELOG



* feat: optimize comment



* feat: optimize comment



* feat: optimize code



* feat: optimize code



---------




* Revert "add fakenews.co to .lycheeexclude"

This reverts commit 55f6344.



* Add WorkspacePluginStart



---------




(cherry picked from commit 9cdc7c9)

Signed-off-by: Hailong Cui <[email protected]>
Signed-off-by: SuZhou-Joe <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: SuZhou-Joe <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x in-next Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry v2.14.0 valued-contributor workspace
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants