feat: Shows related dashboards in Explore #21685

michael-s-molina · 2022-10-03T16:40:17Z

SUMMARY

Adds a new section to the "More" button in Explore that displays a list of dashboards in which the chart is included.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2022-10-03.at.9.56.43.AM.mov

TESTING INSTRUCTIONS

Check the video and the related tests for instructions.

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

...t-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.test.tsx

codecov · 2022-10-04T12:32:54Z

Codecov Report

Merging #21685 (52f92f1) into master (f1fbaf8) will increase coverage by 0.01%.
The diff coverage is 56.75%.

@@            Coverage Diff             @@
##           master   #21685      +/-   ##
==========================================
+ Coverage   66.82%   66.83%   +0.01%     
==========================================
  Files        1799     1800       +1     
  Lines       68884    68937      +53     
  Branches     7319     7335      +16     
==========================================
+ Hits        46031    46077      +46     
- Misses      20966    20967       +1     
- Partials     1887     1893       +6

Flag	Coverage Δ
hive	`52.91% <ø> (+<0.01%)`	⬆️
javascript	`53.15% <56.75%> (+<0.01%)`	⬆️
mysql	`78.24% <ø> (?)`
postgres	`78.30% <ø> (-0.01%)`	⬇️
presto	`52.82% <ø> (+<0.01%)`	⬆️
python	`81.44% <ø> (+0.04%)`	⬆️
sqlite	`76.80% <ø> (-0.01%)`	⬇️
unit	`50.96% <ø> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/dashboard/actions/hydrate.js	`1.78% <0.00%> (-0.14%)`	⬇️
...rontend/src/dashboard/containers/DashboardPage.tsx	`7.25% <0.00%> (-0.06%)`	⬇️
...rc/explore/components/ExploreChartHeader/index.jsx	`55.76% <0.00%> (-1.10%)`	⬇️
...mponents/useExploreAdditionalActionsMenu/index.jsx	`62.65% <50.00%> (-0.77%)`	⬇️
...ExploreAdditionalActionsMenu/DashboardsSubMenu.tsx	`83.33% <83.33%> (ø)`
...frontend/src/SqlLab/components/SaveQuery/index.tsx	`75.00% <0.00%> (-1.75%)`	⬇️
superset-frontend/src/SqlLab/actions/sqlLab.js	`62.66% <0.00%> (-0.33%)`	⬇️
...tend/plugins/plugin-chart-table/src/TableChart.tsx	`46.19% <0.00%> (-0.26%)`	⬇️
superset/db_engine_specs/gsheets.py	`75.91% <0.00%> (-0.21%)`	⬇️
superset/queries/saved_queries/api.py	`95.28% <0.00%> (ø)`
... and 10 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

kgabryje · 2022-10-06T15:25:49Z

/testenv up FEATURE_CROSS_REFERENCES=true

geido

Some non-blocking nits from looking at the code. I will manually test as well

superset-frontend/src/explore/components/ExploreChartHeader/index.jsx

geido · 2022-10-06T15:30:41Z

...t-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.test.tsx

+    const dashboards = [];
+    for (let i = 1; i <= numberOfItems; i += 1) {
+      dashboards.push({ id: i, dashboard_title: `Dashboard ${i}` });
+    }


Just a shortcut if you like

Suggested change

const dashboards = [];

for (let i = 1; i <= numberOfItems; i += 1) {

dashboards.push({ id: i, dashboard_title: `Dashboard ${i}` });

}

const dashboards = Array.from({ length: numberOfItems }, (_, i) => ({ id: i+1, dashboard_title: `Dashboard ${i+1}`}));

Interesting! For this specific case though, after formatting, both options take 4 lines of code and your suggestion requires more knowledge about iterable objects with the length property. I think the original code is more developer friendly in this case. Nevertheless, I liked the suggested pattern and will use it in other cases.

geido · 2022-10-06T15:33:13Z

superset-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.tsx

+  return (
+    <>
+      {showSearch && (
+        <AntdInput


Should we move this to its own directory and enhance it like we did for all other Antd components? Definitely not a blocker for the PR though

What do you mean by "enhance it"?

Just move it in its own components directory and wrap it with styled components. As I said, it's just a plus

I changed the code to use our styled component from src/components/Input 👍🏼

superset-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.tsx

superset-frontend/src/dashboard/actions/hydrate.js

superset-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.tsx

kgabryje · 2022-10-06T15:36:38Z

superset-frontend/src/explore/components/useExploreAdditionalActionsMenu/index.jsx

-          </>
-        )}
+          )}
+          {isFeatureEnabled(FeatureFlag.CROSS_REFERENCES) && (


this should be behind the slice && check too. If you create a new chart, slice is undefined before saving, so there's no point in showing "Dashboards added to" because it's always empty. If you do that, you can also make chartId required instead of optional in types of DashboardSubMenu

The design specification shows the "Dashboards added to" with a None item. I think this is intentional to present the user with the same experience when there's no dashboard associated whether is a new chart or a saved one.

superset-frontend/src/explore/components/ExploreChartHeader/index.jsx

kgabryje · 2022-10-07T10:07:01Z

/testenv up FEATURE_CROSS_REFERENCES=true

geido

LGMT!

github-actions · 2022-10-07T16:00:07Z

Ephemeral environment shutdown and build artifacts deleted.

michael-s-molina requested review from rusackas, kgabryje and geido October 3, 2022 16:40

pull-request-size bot added the size/L label Oct 3, 2022

villebro reviewed Oct 4, 2022

View reviewed changes

...t-frontend/src/explore/components/useExploreAdditionalActionsMenu/DashboardsSubMenu.test.tsx Show resolved Hide resolved

michael-s-molina requested a review from jinghua-qa as a code owner October 4, 2022 11:41

michael-s-molina force-pushed the add-dashboards-to-explore branch from 66dee30 to 02a89a6 Compare October 6, 2022 14:03

michael-s-molina added 4 commits October 6, 2022 11:04

feat: Shows related dashboards in Explore

c6deb8a

Fixes Cypress test

caaa0d4

Implement autofocus when opening a dashboard

687ae58

Uses CROSS_REFERENCES feature flag

b0c5e8f

michael-s-molina force-pushed the add-dashboards-to-explore branch from 02a89a6 to b0c5e8f Compare October 6, 2022 14:23

geido reviewed Oct 6, 2022

View reviewed changes

kgabryje reviewed Oct 6, 2022

View reviewed changes

michael-s-molina added 2 commits October 6, 2022 13:50

Addresses reviews

0bd045a

Uses getUrlParam to retrieve focused chart id

9df97be

Uses styled Input

52f92f1

geido approved these changes Oct 7, 2022

View reviewed changes

michael-s-molina merged commit 200bed6 into apache:master Oct 7, 2022

mistercrunch added the 🚢 2.1.3 label Feb 18, 2024

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.1.0 and removed 🚢 2.1.3 labels Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Shows related dashboards in Explore #21685

feat: Shows related dashboards in Explore #21685

michael-s-molina commented Oct 3, 2022 •

edited

codecov bot commented Oct 4, 2022 •

edited

kgabryje commented Oct 6, 2022

geido left a comment

geido Oct 6, 2022

michael-s-molina Oct 6, 2022

geido Oct 6, 2022

michael-s-molina Oct 6, 2022

geido Oct 7, 2022

michael-s-molina Oct 7, 2022 •

edited

kgabryje Oct 6, 2022

michael-s-molina Oct 6, 2022

kgabryje commented Oct 7, 2022

geido left a comment

github-actions bot commented Oct 7, 2022

feat: Shows related dashboards in Explore #21685

feat: Shows related dashboards in Explore #21685

Conversation

michael-s-molina commented Oct 3, 2022 • edited

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Oct 4, 2022 • edited

Codecov Report

kgabryje commented Oct 6, 2022

geido left a comment

Choose a reason for hiding this comment

geido Oct 6, 2022

Choose a reason for hiding this comment

michael-s-molina Oct 6, 2022

Choose a reason for hiding this comment

geido Oct 6, 2022

Choose a reason for hiding this comment

michael-s-molina Oct 6, 2022

Choose a reason for hiding this comment

geido Oct 7, 2022

Choose a reason for hiding this comment

michael-s-molina Oct 7, 2022 • edited

Choose a reason for hiding this comment

kgabryje Oct 6, 2022

Choose a reason for hiding this comment

michael-s-molina Oct 6, 2022

Choose a reason for hiding this comment

kgabryje commented Oct 7, 2022

geido left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 7, 2022

michael-s-molina commented Oct 3, 2022 •

edited

codecov bot commented Oct 4, 2022 •

edited

michael-s-molina Oct 7, 2022 •

edited