[Feature] Data sources associated objects tab #1470

RyanL1997 · 2024-02-26T21:05:44Z

Description

Add Data sources associated objects tab

Issues Resolved

[List any issues this PR will resolve]

Demo

Without data:

With data:

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- 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.

Signed-off-by: Ryan Liang <jiallian@amazon.com>

opensearch_dashboards.json

public/components/datasources/components/manage/data_connection.tsx

package.json

public/components/datasources/components/manage/associated_objects_tab.tsx

sejli · 2024-02-26T21:28:20Z

public/components/datasources/components/manage/associated_objects_tab.tsx

+        <EuiInMemoryTable
+          items={associatedObjects}
+          columns={columns}
+          search={search}


May need to move this out for an external search bar component since the EuiInMemoryTable doesn't have support for search bar and filters, but that can be done in a future PR.

lets do this as a follow up

public/components/datasources/components/manage/associated_objects_tab.tsx

ps48 · 2024-02-26T21:44:38Z

@RyanL1997 can you please fix linting and test apart from the above comments. Thanks!

sejli · 2024-02-26T21:47:59Z

In order to fix test and build workflows, yarn test -u should be run to update the snapshots. That should fix those workflows.

Signed-off-by: Ryan Liang <jiallian@amazon.com>

codecov · 2024-02-26T23:27:37Z

Codecov Report

Attention: Patch coverage is 7.14286% with 26 lines in your changes are missing coverage. Please review.

Project coverage is 56.38%. Comparing base (403eece) to head (5004ee8).

Files	Patch %	Lines
...urces/components/manage/associated_objects_tab.tsx	4.00%	24 Missing ⚠️
...ts/manage/accelerations_recommendation_callout.tsx	50.00%	1 Missing ⚠️
.../datasources/components/manage/data_connection.tsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1470      +/-   ##
==========================================
- Coverage   56.49%   56.38%   -0.12%     
==========================================
  Files         320      322       +2     
  Lines       11739    11766      +27     
  Branches     3055     3059       +4     
==========================================
+ Hits         6632     6634       +2     
- Misses       5053     5078      +25     
  Partials       54       54

Flag	Coverage Δ
dashboards-observability	`56.38% <7.14%> (-0.12%)`	⬇️

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.

ps48

@RyanL1997 For the below lint error let's add a console.error to log the error whenever it occurs.

136:15  error    'err' is defined but never used. Allowed unused args must match /^_/u

Thanks! for quick the updates on the PR

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 · 2024-02-27T00:26:59Z

@ps48 @sejli , I have addressed the comments above and also fixed that lint ( that was irrelevant from this change btw. ). And I'm updating the screenshots to the description.

joshuali925 · 2024-02-27T17:33:16Z

common/types/data_connections.ts

+  database: string;
+  type: string;
+  createdByIntegration: string;
+  accelerations: string;


would any of these fields be a smaller type than string, or all of them can be arbitrary strings?

I think for now they should be all strings.

joshuali925 · 2024-02-27T17:36:08Z

public/components/datasources/components/manage/associated_objects_tab.tsx

+        <AccelerationsRecommendationCallout />
+        <EuiSpacer />
+        {associatedObjects.length > 0 ? (
+          <EuiInMemoryTable


would there be a case that associatedObjects gets large and doesn't fit in memory?

Good point, I think for the memory fitting issue, we may need to do something like virtualization with react-window to limit the size of the list. However, since this this is a skeleton for now, and lets just leave like this. I will test it when we connect the actual data content, so that we can decide which approaches we need for addressing the memory issue. I will not resolve this comment btw until we have a concrete solution on this.

Swiddis · 2024-02-27T18:26:18Z

common/types/data_connections.ts

+  name: string;
+  database: string;
+  type: string;
+  createdByIntegration: string;


I don't know if createdByIntegration is a field that AssociatedObject would contain, I'd expect this to be queried from the integrations that store all the contained object information. Do you see us modifying Integrations to add fields like this to arbitrary objects? If so, it might be worth adding this requirement in #1442

Transferring some of the discussion over here: for now, since we should able to have this field with the source of integration, lets have this field for now for this skeleton PR. We can sync up on this again when we actually do the connection of actual data content.

Signed-off-by: Ryan Liang <jiallian@amazon.com> (cherry picked from commit 187b112) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Signed-off-by: Ryan Liang <jiallian@amazon.com>

… (opensearch-project#1486) Signed-off-by: Ryan Liang <jiallian@amazon.com> (cherry picked from commit 7eaa762)

RyanL1997 added 3 commits February 23, 2024 15:24

Data sources panel re-design

53190ae

Signed-off-by: Ryan Liang <jiallian@amazon.com>

Add refresh button

d4be2da

Signed-off-by: Ryan Liang <jiallian@amazon.com>

Update the skeleton

c1e000d

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 commented Feb 26, 2024

View reviewed changes

opensearch_dashboards.json Outdated Show resolved Hide resolved

RyanL1997 commented Feb 26, 2024

View reviewed changes

public/components/datasources/components/manage/data_connection.tsx Outdated Show resolved Hide resolved

ps48 reviewed Feb 26, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

sejli reviewed Feb 26, 2024

View reviewed changes

sejli added the enhancement New feature or request label Feb 26, 2024

RyanL1997 added 4 commits February 26, 2024 14:05

Address some comments

d0a5282

Signed-off-by: Ryan Liang <jiallian@amazon.com>

export the tab interface

79a7076

Signed-off-by: Ryan Liang <jiallian@amazon.com>

fix the refresh fonts

065531f

Signed-off-by: Ryan Liang <jiallian@amazon.com>

update snapshots

6684bfe

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 marked this pull request as ready for review February 26, 2024 23:54

RyanL1997 requested review from kavithacm, derek-ho, joshuali925, dai-chen, YANG-DB, rupal-bq, mengweieric, vmmusings, Swiddis, penghuo, seankao-az, anirudha, paulstn and sumukhswamy as code owners February 26, 2024 23:54

ps48 reviewed Feb 27, 2024

View reviewed changes

ps48 approved these changes Feb 27, 2024

View reviewed changes

ps48 added the backport 2.x label Feb 27, 2024

Add a page for empty table

5004ee8

Signed-off-by: Ryan Liang <jiallian@amazon.com>

joshuali925 approved these changes Feb 27, 2024

View reviewed changes

Swiddis approved these changes Feb 27, 2024

View reviewed changes

Swiddis reviewed Feb 27, 2024

View reviewed changes

joshuali925 merged commit 187b112 into opensearch-project:main Feb 27, 2024
14 of 21 checks passed

opensearch-trigger-bot bot mentioned this pull request Feb 27, 2024

[Backport 2.x] [Feature] Data sources associated objects tab #1473

Closed

RyanL1997 mentioned this pull request Feb 28, 2024

[Feature] Associated objects searchbar filters #1474

Merged

6 tasks

RyanL1997 added a commit to RyanL1997/dashboards-observability that referenced this pull request Mar 5, 2024

[Feature] Data sources associated objects tab (opensearch-project#1470)

8397549

Signed-off-by: Ryan Liang <jiallian@amazon.com>

RyanL1997 mentioned this pull request Mar 5, 2024

[Backport 2.x] Data sources associated objects tab (#1470) #1486

Merged

6 tasks

ps48 pushed a commit that referenced this pull request Mar 5, 2024

[Feature] Data sources associated objects tab (#1470) (#1486)

7eaa762

Signed-off-by: Ryan Liang <jiallian@amazon.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Data sources associated objects tab #1470

[Feature] Data sources associated objects tab #1470

RyanL1997 commented Feb 26, 2024 •

edited

Loading

sejli Feb 26, 2024

RyanL1997 Feb 27, 2024

ps48 commented Feb 26, 2024

sejli commented Feb 26, 2024

codecov bot commented Feb 26, 2024 •

edited

Loading

ps48 left a comment

RyanL1997 commented Feb 27, 2024

joshuali925 Feb 27, 2024

RyanL1997 Feb 27, 2024

joshuali925 Feb 27, 2024

RyanL1997 Feb 27, 2024

Swiddis Feb 27, 2024

RyanL1997 Feb 27, 2024

[Feature] Data sources associated objects tab #1470

[Feature] Data sources associated objects tab #1470

Conversation

RyanL1997 commented Feb 26, 2024 • edited Loading

Description

Issues Resolved

Demo

Check List

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ps48 commented Feb 26, 2024

sejli commented Feb 26, 2024

codecov bot commented Feb 26, 2024 • edited Loading

Codecov Report

ps48 left a comment

Choose a reason for hiding this comment

RyanL1997 commented Feb 27, 2024

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

RyanL1997 commented Feb 26, 2024 •

edited

Loading

codecov bot commented Feb 26, 2024 •

edited

Loading