[Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7612

raintygao · 2024-08-02T03:31:55Z

Description

Only allow essential use case when creating workspace if all data sources are serverless

Screenshot

Create workspace

Testing the changes

Set all data sources as serverless, then go to workspace create page or detail page.

Changelog

feat: Only allow essential use case when creating workspace if all data sources are serverless

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

codecov · 2024-08-02T03:52:09Z

Codecov Report

Attention: Patch coverage is 90.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 63.70%. Comparing base (1bf63e3) to head (f069430).
Report is 208 commits behind head on main.

Files with missing lines	Patch %	Lines
src/plugins/workspace/public/utils.ts	71.42%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7612   +/-   ##
=======================================
  Coverage   63.69%   63.70%           
=======================================
  Files        3633     3633           
  Lines       80135    80153   +18     
  Branches    12699    12702    +3     
=======================================
+ Hits        51043    51061   +18     
  Misses      25984    25984           
  Partials     3108     3108

Flag	Coverage Δ
Linux_1	`30.60% <90.00%> (+0.01%)`	⬆️
Linux_2	`55.63% <ø> (ø)`
Linux_3	`40.56% <ø> (?)`
Linux_4	`31.31% <ø> (ø)`
Windows_1	`30.62% <90.00%> (+0.01%)`	⬆️
Windows_2	`55.58% <ø> (ø)`
Windows_3	`40.56% <ø> (ø)`
Windows_4	`31.31% <ø> (ø)`

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.

src/plugins/workspace/public/utils.ts

ruanyl · 2024-08-02T04:07:37Z

src/plugins/workspace/public/utils.ts

+export const getIsOnlyAllowEssentialUseCase = async (client: SavedObjectsStart['client']) => {
+  const allDataSources = await getDataSourcesList(client, ['*']);
+  if (allDataSources.length > 0) {
+    const serverlessDataSource = allDataSources.filter(


Can use allDataSources.every()

Thanks, updated.

ruanyl · 2024-08-02T04:14:37Z

src/plugins/workspace/public/components/workspace_form/workspace_use_case.tsx

@@ -54,21 +60,60 @@ const WorkspaceUseCaseCard = ({
  );
 };

+type AvailableUseCase = Pick<
+  WorkspaceUseCaseObject,
+  'id' | 'title' | 'description' | 'systematic'


Maybe this is irrelevant, but what does systematic stand for? cc @wanglam

For filtering out system nav group, we won't show system nav groups in the use case selector.

Hailong-am · 2024-08-06T10:02:29Z

src/plugins/workspace/public/components/workspace_form/workspace_use_case.tsx

+        {displayedUseCases.map(({ id, title, description, disabled }) => (
+          <EuiFlexItem key={id}>
+            <WorkspaceUseCaseCard
+              id={id}
+              title={title}
+              description={description}
+              checked={value === id}
+              onChange={onChange}
+              disabled={disabled}
+            />
+          </EuiFlexItem>
+        ))}


can't find the place set disabled, do we still need it? I see we are doing filter instead of setting other use cases disabled.

// When creating and isOnlyAllowEssential is true, only display essential use case if (isOnlyAllowEssential && operationType === WorkspaceOperationType.Create) { allAvailableUseCases = allAvailableUseCases.filter( (item) => item.id === DEFAULT_NAV_GROUPS.analytics.id ); } setDisplayedUseCases(allAvailableUseCases);

Oh, I missed to delete it.Thanks for catching it. Will update it soon.

Signed-off-by: tygao <[email protected]>

ruanyl · 2024-08-12T01:34:58Z

src/plugins/workspace/public/components/workspace_form/workspace_use_case.tsx

+  useEffect(() => {
+    if (operationType === WorkspaceOperationType.Create) {
+      getIsOnlyAllowEssentialUseCase(savedObjects.client).then((result: boolean) => {
+        setIsOnlyAllowEssential(result);
+      });
+    }
+  }, [savedObjects, operationType]);


It looks we can simply use useMemo instead of useEffect + useState

Here useMemo would be hard to combine with promise.

So I used useEffect + useState to make it clear.

right, that's a promise

ruanyl · 2024-08-12T01:35:33Z

src/plugins/workspace/public/components/workspace_form/workspace_use_case.tsx

+  useEffect(() => {
+    let allAvailableUseCases = availableUseCases
+      .filter((item) => !item.systematic)
+      .concat(DEFAULT_NAV_GROUPS.all);
+    // When creating and isOnlyAllowEssential is true, only display essential use case
+    if (isOnlyAllowEssential && operationType === WorkspaceOperationType.Create) {
+      allAvailableUseCases = allAvailableUseCases.filter(
+        (item) => item.id === DEFAULT_NAV_GROUPS.analytics.id
+      );
+    }
+    setDisplayedUseCases(allAvailableUseCases);
+  }, [availableUseCases, isOnlyAllowEssential, operationType]);


The same here, we can simply use useMemo, isn't it?

Signed-off-by: tygao <[email protected]>

raintygao · 2024-08-12T04:51:28Z

@SuZhou-Joe @ruanyl Could you help me approve it again? Just fix a error that use case changes from analytics to essential after pulling main.

…ce if all data sources are serverless (#7612) * feat: only allow essential use case when all data sources are serverless Signed-off-by: tygao <[email protected]> * Changeset file for PR #7612 created/updated * update and only keep workspace create case Signed-off-by: tygao <[email protected]> * Changeset file for PR #7612 created/updated * remove useless disabled logic Signed-off-by: tygao <[email protected]> * use useMemo Signed-off-by: tygao <[email protected]> * update filter and tests to update with essiential use case change Signed-off-by: tygao <[email protected]> --------- Signed-off-by: tygao <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit f59c2b9) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ce if all data sources are serverless (#7612) (#7684) * feat: only allow essential use case when all data sources are serverless * Changeset file for PR #7612 created/updated * update and only keep workspace create case * Changeset file for PR #7612 created/updated * remove useless disabled logic * use useMemo * update filter and tests to update with essiential use case change --------- (cherry picked from commit f59c2b9) Signed-off-by: tygao <[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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

github-actions bot added the all-star-contributor label Aug 2, 2024

opensearch-changeset-bot bot added a commit to raintygao/OpenSearch-Dashboards that referenced this pull request Aug 2, 2024

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

94c8b20

ruanyl added v2.17.0 workspace labels Aug 2, 2024

wanglam reviewed Aug 2, 2024

View reviewed changes

src/plugins/workspace/public/utils.ts Show resolved Hide resolved

ruanyl reviewed Aug 2, 2024

View reviewed changes

raintygao pushed a commit to raintygao/OpenSearch-Dashboards that referenced this pull request Aug 2, 2024

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

795d0d0

raintygao force-pushed the use-case branch from 511a50a to bfc32df Compare August 2, 2024 09:54

raintygao changed the title ~~[Workspace] feat: only allow essential use case when creating or updating workspace if all data sources are serverless~~ [Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless Aug 2, 2024

opensearch-changeset-bot bot added a commit to raintygao/OpenSearch-Dashboards that referenced this pull request Aug 2, 2024

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

6ce7a97

Hailong-am reviewed Aug 6, 2024

View reviewed changes

raintygao and others added 5 commits August 6, 2024 22:30

feat: only allow essential use case when all data sources are serverless

d403392

Signed-off-by: tygao <[email protected]>

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

a8d293b

update and only keep workspace create case

f29bad9

Signed-off-by: tygao <[email protected]>

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

a4e963e

remove useless disabled logic

8412b0e

Signed-off-by: tygao <[email protected]>

raintygao force-pushed the use-case branch from 6ce7a97 to 8412b0e Compare August 6, 2024 14:35

ruanyl reviewed Aug 12, 2024

View reviewed changes

raintygao added 2 commits August 12, 2024 09:46

use useMemo

b22aa9a

Signed-off-by: tygao <[email protected]>

Merge branch 'main' into use-case

cffca1e

ruanyl previously approved these changes Aug 12, 2024

View reviewed changes

SuZhou-Joe previously approved these changes Aug 12, 2024

View reviewed changes

update filter and tests to update with essiential use case change

f069430

Signed-off-by: tygao <[email protected]>

raintygao dismissed stale reviews from SuZhou-Joe and ruanyl via f069430 August 12, 2024 03:06

ruanyl approved these changes Aug 12, 2024

View reviewed changes

SuZhou-Joe added the backport 2.x label Aug 12, 2024

SuZhou-Joe approved these changes Aug 12, 2024

View reviewed changes

ruanyl merged commit f59c2b9 into opensearch-project:main Aug 12, 2024
69 checks passed

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

[Backport 2.x] [Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7684

Merged

AMoo-Miki added the in-next label Sep 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7612

[Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7612

raintygao commented Aug 2, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

ruanyl Aug 2, 2024

raintygao Aug 2, 2024

ruanyl Aug 2, 2024

wanglam Aug 2, 2024

Hailong-am Aug 6, 2024 •

edited

Loading

raintygao Aug 6, 2024 •

edited

Loading

raintygao Aug 7, 2024

ruanyl Aug 12, 2024

raintygao Aug 12, 2024

raintygao Aug 12, 2024

ruanyl Aug 12, 2024

ruanyl Aug 12, 2024

raintygao Aug 12, 2024

raintygao commented Aug 12, 2024

[Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7612

[Workspace] feat: only allow essential use case when creating workspace if all data sources are serverless #7612

Conversation

raintygao commented Aug 2, 2024 • edited Loading

Description

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Aug 2, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hailong-am Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

raintygao Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raintygao commented Aug 12, 2024

raintygao commented Aug 2, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

Hailong-am Aug 6, 2024 •

edited

Loading

raintygao Aug 6, 2024 •

edited

Loading