[workspace]Hide the assistant entry when there isn't data2summary agent #9277

Qxisylolo · 2025-01-27T06:23:05Z

Description

This pr hides the assistant entry when there isn't data2summary agent.

Screenshot

No agent:

Has agent:

Testing the changes

Changelog

fix: Hide the assistant entry when there isn't data2summary agent

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

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

codecov · 2025-01-27T06:38:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.70%. Comparing base (ec6d7df) to head (3e37c55).
Report is 35 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9277   +/-   ##
=======================================
  Coverage   61.70%   61.70%           
=======================================
  Files        3816     3815    -1     
  Lines       91829    91819   -10     
  Branches    14543    14543           
=======================================
- Hits        56666    56660    -6     
+ Misses      31507    31505    -2     
+ Partials     3656     3654    -2

Flag	Coverage Δ
Linux_1	`28.99% <ø> (ø)`
Linux_2	`56.46% <ø> (ø)`
Linux_3	`39.18% <ø> (+<0.01%)`	⬆️
Linux_4	`28.89% <100.00%> (-0.01%)`	⬇️
Windows_1	`29.00% <ø> (ø)`
Windows_2	`56.41% <ø> (ø)`
Windows_3	`39.18% <ø> (ø)`
Windows_4	`28.89% <100.00%> (-0.01%)`	⬇️

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 · 2025-01-27T06:56:19Z

src/plugins/query_enhancements/public/query_assist/utils/create_extension.tsx

  question$?: BehaviorSubject<string>;
 }

 const QueryAssistWrapper: React.FC<QueryAssistWrapperProps> = (props) => {
  const [visible, setVisible] = useState(false);
  const [question, setQuestion] = useState('');
  const [isQuerySummaryCollapsed, setIsQuerySummaryCollapsed] = useState(true);
+  const [isSummaryAgentAvailable, setIsSummaryAgentAvailable] = useState(false);


What about we using useObservable(props.isSummaryAgentAvailable$)?

Thanks for the comments, already been updated. but would it be more organized to update state of isSummaryAgentAvailable together with isQuerySummaryCollapsed and question together in useEffect?

SuZhou-Joe · 2025-01-27T06:58:38Z

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

-  useEffect(() => {
-    setIsSummaryAgentAvailable(false);
-    const fetchSummaryAgent = async () => {
-      try {
-        const summaryAgentStatus = await checkAgentsExist(
-          props.http,
-          DATA2SUMMARY_AGENT_CONFIG_ID,
-          selectedDataset.current?.dataSource?.id
-        );
-        setIsSummaryAgentAvailable(summaryAgentStatus.exists);
-      } catch (error) {
-        // eslint-disable-next-line no-console
-        console.error(error);
-      }
-    };
-    if (isEnabledByCapability) {
-      fetchSummaryAgent();
-    }
-  }, [selectedDataset.current?.dataSource?.id, props.http, isEnabledByCapability]);


Is there case that assistant is not installed but we turn on result summary?

Will this summary agent work correctly if the dashboard assistant was disabled before this code change? After this change, the isSummaryAgentAvailable$ will be updated out of query enhancements, right? Just want to confirm if it's dependent on the dashboard assistant before.

I will perform the check in https://github.com/opensearch-project/dashboards-assistant/blob/d9266cf6dbe3af769433241bd47adedc4e482f2c/public/plugin.tsx#L285-L320 to see if the assistant is enabled. If it is, the action context menu will be rendered, and action context menu will call API to check if summary agent exists.

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

wanglam · 2025-02-06T08:39:41Z

src/plugins/data/public/query/query_string/query_string_manager.test.ts

@@ -108,7 +113,6 @@ describe('QueryStringManager', () => {
  test('clearQueryHistory clears the query history', () => {
    service.addToQueryHistory({ query: 'test query 1', language: 'sql' });
    service.addToQueryHistory({ query: 'test query 2', language: 'sql' });
-    expect(service.getQueryHistory()).toHaveLength(2);


Nit: The fixing of unit tests seems not related to the current PR. Shall we separate a PR to fix it?

Ok, I will revert this commit. thanks~

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

…nt (#9277) * fix summary entry when no agent in workspace Signed-off-by: Qxisylolo <qianxisy@amazon.com> * Changeset file for PR #9277 created/updated * resolve comments Signed-off-by: Qxisylolo <qianxisy@amazon.com> * fix test Signed-off-by: Qxisylolo <qianxisy@amazon.com> * separate test Signed-off-by: Qxisylolo <qianxisy@amazon.com> --------- Signed-off-by: Qxisylolo <qianxisy@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 46ee60c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

fix summary entry when no agent in workspace

4b7cf42

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

github-actions bot added the all-star-contributor label Jan 27, 2025

Changeset file for PR opensearch-project#9277 created/updated

ef1ab32

Qxisylolo marked this pull request as ready for review January 27, 2025 06:31

Qxisylolo mentioned this pull request Jan 27, 2025

Hide the assistant entry when there isn't data2summary agent opensearch-project/dashboards-assistant#417

Merged

4 tasks

SuZhou-Joe reviewed Jan 27, 2025

View reviewed changes

Qxisylolo and others added 3 commits February 5, 2025 14:26

resolve comments

01dda91

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

fix test

79802a8

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

Merge branch 'main' into fix/hide_entry

67c1c2b

wanglam reviewed Feb 6, 2025

View reviewed changes

separate test

3e37c55

Signed-off-by: Qxisylolo <qianxisy@amazon.com>

Qxisylolo force-pushed the fix/hide_entry branch from 7844fab to 3e37c55 Compare February 7, 2025 04:01

Hailong-am approved these changes Feb 19, 2025

View reviewed changes

ruanyl added the backport 2.x label Feb 19, 2025

SuZhou-Joe approved these changes Feb 25, 2025

View reviewed changes

SuZhou-Joe merged commit 46ee60c into opensearch-project:main Feb 25, 2025
71 of 73 checks passed

opensearch-trigger-bot bot mentioned this pull request Feb 25, 2025

[Backport 2.x] [workspace]Hide the assistant entry when there isn't data2summary agent #9441

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[workspace]Hide the assistant entry when there isn't data2summary agent #9277

[workspace]Hide the assistant entry when there isn't data2summary agent #9277

Qxisylolo commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading

SuZhou-Joe Jan 27, 2025

Qxisylolo Feb 5, 2025

SuZhou-Joe Jan 27, 2025 •

edited

Loading

wanglam Feb 6, 2025

Qxisylolo Feb 7, 2025 •

edited

Loading

wanglam Feb 6, 2025

Qxisylolo Feb 7, 2025

[workspace]Hide the assistant entry when there isn't data2summary agent #9277

[workspace]Hide the assistant entry when there isn't data2summary agent #9277

Conversation

Qxisylolo commented Jan 27, 2025 • edited Loading

Description

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Jan 27, 2025 • edited Loading

Codecov Report

SuZhou-Joe Jan 27, 2025

Choose a reason for hiding this comment

Qxisylolo Feb 5, 2025

Choose a reason for hiding this comment

SuZhou-Joe Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

wanglam Feb 6, 2025

Choose a reason for hiding this comment

Qxisylolo Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

wanglam Feb 6, 2025

Choose a reason for hiding this comment

Qxisylolo Feb 7, 2025

Choose a reason for hiding this comment

Qxisylolo commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading

SuZhou-Joe Jan 27, 2025 •

edited

Loading

Qxisylolo Feb 7, 2025 •

edited

Loading