Add assistant capabilities to control rendering components #267

songkant-aws · 2024-09-02T06:26:48Z

Description

Add assistant feature capabilities to allow users to override capability switcher function to control whether to show assistant feature UI components.

Issues Resolved

[List any issues this PR will resolve]

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test.
New functionality has user manual doc added.
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.

…tant feature UI Signed-off-by: Songkan Tang <[email protected]>

Signed-off-by: Songkan Tang <[email protected]>

codecov · 2024-09-03T06:38:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.44%. Comparing base (4f33fa0) to head (20a279e).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #267      +/-   ##
==========================================
- Coverage   90.34%   89.44%   -0.91%     
==========================================
  Files          59       60       +1     
  Lines        1575     1668      +93     
  Branches      377      407      +30     
==========================================
+ Hits         1423     1492      +69     
- Misses        150      174      +24     
  Partials        2        2

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

Signed-off-by: Songkan Tang <[email protected]>

Hailong-am · 2024-09-09T09:47:21Z

common/types/config.ts

@@ -6,8 +6,7 @@
 import { schema, TypeOf } from '@osd/config-schema';

 export const configSchema = schema.object({
-  // TODO: add here to prevent this plugin from being loaded
-  // enabled: schema.boolean({ defaultValue: true }),
+  enabled: schema.boolean({ defaultValue: true }),


enable this will allow whole dashboard assistant been disabled, is this expected?

Yes, I think it's upon agreement. Is it true? @ruanyl

I think so, this flag allows us to turnoff the entire plugin

Hailong-am · 2024-09-09T09:58:05Z

public/plugin.tsx

+          } else {
+            return () => {};
+          }


do we want to render some tips or instructions to direct user to active the subscription?

Add a default "Application Not Activated" danger tips now

…ot activated Signed-off-by: Songkan Tang <[email protected]>

Signed-off-by: Songkan Tang <[email protected]>

ruanyl · 2024-09-11T08:40:34Z

server/plugin.ts

+    }
+
+    core.capabilities.registerProvider(capabilitiesProvider);
+    core.capabilities.registerSwitcher(capabilitiesSwitcher);


Do we need this switcher in dashboards-assistant? The default value is true already, maybe just let whoever need to update the value to register the switcher?

Sure, that also makes sense. Developers can register their own switch per requirement. Removed the switcher registration now.

…ir requirement Signed-off-by: Songkan Tang <[email protected]>

opensearch-trigger-bot · 2024-09-11T09:30:29Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-assistant/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-assistant/backport-2.x
# Create a new branch
git switch --create backport/backport-267-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 4ec4f92b1ca2218fd5eb5498b73c1508f35262d0
# Push it to GitHub
git push --set-upstream origin backport/backport-267-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-assistant/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-267-to-2.x.

ruanyl · 2024-09-11T10:29:24Z

@songkant-aws backport to 2.x failed.

songkant-aws · 2024-09-12T01:49:35Z

@songkant-aws backport to 2.x failed.

Ok, will fix it. The PR is merged after this one [#266 ]. Since some conflicts are resolved based on #266, I will wait for its backport. Let me ping the owner to backport #266.

opensearch-trigger-bot · 2024-09-12T03:22:22Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-assistant/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-assistant/backport-2.x
# Create a new branch
git switch --create backport/backport-267-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 4ec4f92b1ca2218fd5eb5498b73c1508f35262d0
# Push it to GitHub
git push --set-upstream origin backport/backport-267-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-assistant/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-267-to-2.x.

* Add capabilities to check subscription active status to control assistant feature UI Signed-off-by: Songkan Tang <[email protected]> * Fix text2viz feature flag check in server/plugin.ts Signed-off-by: Songkan Tang <[email protected]> * Use assistant isSubscriptionActive capabilities to control text2viz UI Signed-off-by: Songkan Tang <[email protected]> * Add changelog Signed-off-by: Songkan Tang <[email protected]> * Add default app not activation page for text2viz if subscription is not activated Signed-off-by: Songkan Tang <[email protected]> * Rename assistant feature UI capabilities to a more general name Signed-off-by: Songkan Tang <[email protected]> * Rename changelog Signed-off-by: Songkan Tang <[email protected]> * Rephrase app not found page Signed-off-by: Songkan Tang <[email protected]> * Remove switcher registration in favor of developers adding it per their requirement Signed-off-by: Songkan Tang <[email protected]> --------- Signed-off-by: Songkan Tang <[email protected]> (cherry picked from commit 4ec4f92) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* Add capabilities to check subscription active status to control assistant feature UI Signed-off-by: Songkan Tang <[email protected]> * Fix text2viz feature flag check in server/plugin.ts Signed-off-by: Songkan Tang <[email protected]> * Use assistant isSubscriptionActive capabilities to control text2viz UI Signed-off-by: Songkan Tang <[email protected]> * Add changelog Signed-off-by: Songkan Tang <[email protected]> * Add default app not activation page for text2viz if subscription is not activated Signed-off-by: Songkan Tang <[email protected]> * Rename assistant feature UI capabilities to a more general name Signed-off-by: Songkan Tang <[email protected]> * Rename changelog Signed-off-by: Songkan Tang <[email protected]> * Rephrase app not found page Signed-off-by: Songkan Tang <[email protected]> * Remove switcher registration in favor of developers adding it per their requirement Signed-off-by: Songkan Tang <[email protected]> --------- Signed-off-by: Songkan Tang <[email protected]> (cherry picked from commit 4ec4f92) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

songkant-aws added 2 commits September 2, 2024 14:22

Add capabilities to check subscription active status to control assis…

02773ae

…tant feature UI Signed-off-by: Songkan Tang <[email protected]>

Fix text2viz feature flag check in server/plugin.ts

5304c8b

Signed-off-by: Songkan Tang <[email protected]>

songkant-aws requested review from lezzago, joshuali925, anirudha, ruanyl, SuZhou-Joe, xluo-aws, gaobinlong, Hailong-am, wanglam and raintygao as code owners September 2, 2024 06:26

Use assistant isSubscriptionActive capabilities to control text2viz UI

a71e358

Signed-off-by: Songkan Tang <[email protected]>

Add changelog

e452288

Signed-off-by: Songkan Tang <[email protected]>

songkant-aws changed the title ~~Assistant capabilities~~ Add assistant capabilities to control rendering components Sep 3, 2024

gaobinlong added backport 2.x Trigger the backport flow to 2.x v2.17.0 labels Sep 4, 2024

Merge remote-tracking branch 'main' into assistant-capabilities

fcfedf1

Signed-off-by: Songkan Tang <[email protected]>

ruanyl added the backport 2.17 label Sep 6, 2024

songkant-aws added 2 commits September 6, 2024 15:15

Merge branch 'main' into assistant-capabilities

4837c64

Signed-off-by: Songkan Tang <[email protected]>

Merge branch 'main' into assistant-capabilities

283af28

Hailong-am approved these changes Sep 9, 2024

View reviewed changes

Add default app not activation page for text2viz if subscription is n…

20a279e

…ot activated Signed-off-by: Songkan Tang <[email protected]>

songkant-aws requested a review from Hailong-am September 10, 2024 04:08

xluo-aws removed the backport 2.17 label Sep 10, 2024

ruanyl removed the v2.17.0 label Sep 11, 2024

songkant-aws added 3 commits September 11, 2024 13:50

Merge remote-tracking branch 'origin/main' into assistant-capabilities

aa30e87

Signed-off-by: Songkan Tang <[email protected]>

Merge remote-tracking branch 'origin/main' into assistant-capabilities

3217c75

Signed-off-by: Songkan Tang <[email protected]>

Rename assistant feature UI capabilities to a more general name

5fe214d

Signed-off-by: Songkan Tang <[email protected]>

songkant-aws added 2 commits September 11, 2024 15:47

Rename changelog

bbfa6a3

Signed-off-by: Songkan Tang <[email protected]>

Rephrase app not found page

ea41d06

Signed-off-by: Songkan Tang <[email protected]>

ruanyl reviewed Sep 11, 2024

View reviewed changes

Remove switcher registration in favor of developers adding it per the…

adb23a7

…ir requirement Signed-off-by: Songkan Tang <[email protected]>

songkant-aws requested a review from ruanyl September 11, 2024 08:59

ruanyl approved these changes Sep 11, 2024

View reviewed changes

ruanyl merged commit 4ec4f92 into opensearch-project:main Sep 11, 2024
10 checks passed

opensearch-trigger-bot bot added the failed backport label Sep 11, 2024

songkant-aws mentioned this pull request Sep 12, 2024

Support insight with RAG #266

Merged

4 tasks

ruanyl added backport 2.x Trigger the backport flow to 2.x and removed backport 2.x Trigger the backport flow to 2.x labels Sep 12, 2024

opensearch-trigger-bot bot mentioned this pull request Sep 12, 2024

[Backport 2.x] Add assistant capabilities to control rendering components #303

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add assistant capabilities to control rendering components #267

Add assistant capabilities to control rendering components #267

songkant-aws commented Sep 2, 2024 •

edited

Loading

codecov bot commented Sep 3, 2024 •

edited

Loading

Hailong-am Sep 9, 2024

songkant-aws Sep 10, 2024

ruanyl Sep 10, 2024

Hailong-am Sep 9, 2024

songkant-aws Sep 10, 2024

ruanyl Sep 11, 2024

songkant-aws Sep 11, 2024 •

edited

Loading

opensearch-trigger-bot bot commented Sep 11, 2024

ruanyl commented Sep 11, 2024

songkant-aws commented Sep 12, 2024

opensearch-trigger-bot bot commented Sep 12, 2024

Add assistant capabilities to control rendering components #267

Add assistant capabilities to control rendering components #267

Conversation

songkant-aws commented Sep 2, 2024 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Sep 3, 2024 • edited Loading

Codecov Report

Hailong-am Sep 9, 2024

Choose a reason for hiding this comment

songkant-aws Sep 10, 2024

Choose a reason for hiding this comment

ruanyl Sep 10, 2024

Choose a reason for hiding this comment

Hailong-am Sep 9, 2024

Choose a reason for hiding this comment

songkant-aws Sep 10, 2024

Choose a reason for hiding this comment

ruanyl Sep 11, 2024

Choose a reason for hiding this comment

songkant-aws Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Sep 11, 2024

ruanyl commented Sep 11, 2024

songkant-aws commented Sep 12, 2024

opensearch-trigger-bot bot commented Sep 12, 2024

songkant-aws commented Sep 2, 2024 •

edited

Loading

codecov bot commented Sep 3, 2024 •

edited

Loading

songkant-aws Sep 11, 2024 •

edited

Loading