fix(dashboard): copy permalink to dashboard chart #19772

villebro · 2022-04-19T08:54:45Z

SUMMARY

The PR #18181 changed dashboard chart permalinks to link to explore view, while previously they would create a permalink to the dashboard with an anchor pointing to the chart. This changes this behavior back to how it was originally implemented.

AFTER

Now the permalink will link to the dashboard with the chart anchor:

new-chart-perma.mp4

BEFORE

Before the permalink sent the user to explore:

old-dash-perma.mp4

TESTING INSTRUCTIONS

go to the Video Games Dashboard
Go to the "Explore Trends" tab
Copy a permalink from one of the charts
follow the permalink and see where you end up

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

codecov · 2022-04-19T11:05:53Z

Codecov Report

Merging #19772 (38f75bd) into master (594523e) will increase coverage by 0.01%.
The diff coverage is 65.21%.

❗ Current head 38f75bd differs from pull request most recent head c4862e2. Consider uploading reports for the commit c4862e2 to get more accurate results

@@            Coverage Diff             @@
##           master   #19772      +/-   ##
==========================================
+ Coverage   66.49%   66.51%   +0.01%     
==========================================
  Files        1689     1690       +1     
  Lines       64614    64614              
  Branches     6650     6655       +5     
==========================================
+ Hits        42966    42978      +12     
+ Misses      19947    19936      -11     
+ Partials     1701     1700       -1

Flag	Coverage Δ
javascript	`51.19% <65.21%> (+0.03%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/components/Chart/Chart.jsx	`52.54% <0.00%> (+2.54%)`	⬆️
...dashboard/components/SliceHeaderControls/index.tsx	`66.66% <ø> (ø)`
.../src/explore/components/ControlPanelsContainer.tsx	`79.80% <ø> (ø)`
superset-frontend/src/utils/urlUtils.ts	`46.93% <ø> (ø)`
.../explore/components/ExploreViewContainer/index.jsx	`52.29% <10.00%> (-0.61%)`	⬇️
...t-frontend/src/explore/components/ExploreAlert.tsx	`58.33% <58.33%> (ø)`
.../src/utils/getChartRequiredFieldsMissingMessage.ts	`66.66% <66.66%> (ø)`
...et-frontend/src/components/Chart/ChartRenderer.jsx	`54.23% <100.00%> (+1.60%)`	⬆️
...ontend/src/components/URLShortLinkButton/index.jsx	`93.75% <100.00%> (ø)`
...dashboard/components/menu/ShareMenuItems/index.tsx	`90.00% <100.00%> (+8.18%)`	⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 594523e...c4862e2. Read the comment docs.

ktmud

LGTM with a couple of nits.

Should we include this in v1.5 release? I'd assume it breaks a lot of users' workflow.

ktmud · 2022-04-19T17:12:29Z

superset-frontend/src/dashboard/components/menu/ShareMenuItems/index.tsx

@@ -49,23 +45,17 @@ const ShareMenuItems = (props: ShareMenuItemProps) => {
    addDangerToast,
    addSuccessToast,
    dashboardId,
-    formData,
+    hash,


I'm trying to understand what hash means and how it is used but couldn't wrap my head around it very easily. Can it be named to something more unique so it's more searchable?

I would have personally gone with anchor, but

the previous implementation used the term hash

I found references to hash elsewhere, too: https://www.w3schools.com/jsref/prop_anchor_hash.asp

So I went with hash. Since it's already in the schema, I think it might be a good idea to leave it like that, but I'm happy to change it if you feel even remotely strongly about this.

I think it's okay to keep it as long as it is pushed downward to when the URL is actually used. Or we can add some comments.

ktmud · 2022-04-19T17:21:40Z

superset-frontend/src/dashboard/components/SliceHeaderControls/index.tsx

@@ -310,13 +311,14 @@ class SliceHeaderControls extends React.PureComponent<

        {supersetCanShare && (
          <ShareMenuItems
+            dashboardId={dashboardId}
+            hash={componentId}


Suggested change

hash={componentId}

dashboardComponentId={componentId}

Can we push down the concept of hash to only when we interact with the URL? It took me a while to realize what it really means.

That's a good idea, I like it 👍

ktmud · 2022-04-19T17:23:33Z

superset-frontend/src/dashboard/components/menu/ShareMenuItems/index.tsx

    const nativeFiltersKey = getUrlParam(URL_PARAMS.nativeFiltersKey);
    let filterState = {};
    if (nativeFiltersKey && dashboardId) {
      filterState = await getFilterValue(dashboardId, nativeFiltersKey);
    }
-    return getDashboardPermalink(String(dashboardId), filterState);
+    return getDashboardPermalink(String(dashboardId), filterState, hash);


Would be nice if we make this more explicit:

Suggested change

return getDashboardPermalink(String(dashboardId), filterState, hash);

return getDashboardPermalink({

dashboardId, # need to relax the type restriction in `getDashboardPermalink` as well

filterState,

hash: dashboardComponentId

});

villebro · 2022-04-19T18:14:04Z

@ktmud I believe this should address your comments: c4862e2

Should we include this in v1.5 release? I'd assume it breaks a lot of users' workflow.

There's already a -1 vote on 1.5.0rc3. So if you feel this is important for 1.5.0, for the sake of formality I'd love it if you could vote a -1 in reference to this regression, so we can kill it and get rc4 up for vote asap.

ktmud

LGTM!

* fix(dashboard): copy permalink to dashboard chart * lint * address comments (cherry picked from commit e061955)

* fix(dashboard): copy permalink to dashboard chart * lint * address comments

fix(dashboard): copy permalink to dashboard chart

4bd59d8

superset-github-bot bot added the preset-io label Apr 19, 2022

pull-request-size bot added the size/S label Apr 19, 2022

lint

783d590

pull-request-size bot added size/M and removed size/S labels Apr 19, 2022

ktmud approved these changes Apr 19, 2022

View reviewed changes

address comments

c4862e2

ktmud approved these changes Apr 19, 2022

View reviewed changes

villebro merged commit e061955 into apache:master Apr 19, 2022

villebro deleted the villebro/dashboard-share-chart branch April 20, 2022 05:31

villebro added v1.5 lts-v1 labels Apr 20, 2022

villebro added a commit that referenced this pull request Apr 25, 2022

fix(dashboard): copy permalink to dashboard chart (#19772)

c9e3ca1

* fix(dashboard): copy permalink to dashboard chart * lint * address comments (cherry picked from commit e061955)

philipher29 pushed a commit to ValtechMobility/superset that referenced this pull request Jun 9, 2022

fix(dashboard): copy permalink to dashboard chart (apache#19772)

c37e53a

* fix(dashboard): copy permalink to dashboard chart * lint * address comments

michael-s-molina removed the v1.5 label Jan 3, 2023

mistercrunch added 🍒 1.5.0 🍒 1.5.1 🍒 1.5.2 🍒 1.5.3 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(dashboard): copy permalink to dashboard chart #19772

fix(dashboard): copy permalink to dashboard chart #19772

villebro commented Apr 19, 2022

codecov bot commented Apr 19, 2022 •

edited

Loading

ktmud left a comment •

edited

Loading

ktmud Apr 19, 2022

villebro Apr 19, 2022

ktmud Apr 19, 2022

ktmud Apr 19, 2022

villebro Apr 19, 2022

ktmud Apr 19, 2022

villebro commented Apr 19, 2022

ktmud left a comment

-    return getDashboardPermalink(String(dashboardId), filterState, hash);
+    return getDashboardPermalink({
+      dashboardId,   # need to relax the type restriction in `getDashboardPermalink` as well
+      filterState,
+      hash: dashboardComponentId
+    });

fix(dashboard): copy permalink to dashboard chart #19772

fix(dashboard): copy permalink to dashboard chart #19772

Conversation

villebro commented Apr 19, 2022

SUMMARY

AFTER

BEFORE

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Apr 19, 2022 • edited Loading

Codecov Report

ktmud left a comment • edited Loading

Choose a reason for hiding this comment

ktmud Apr 19, 2022

Choose a reason for hiding this comment

villebro Apr 19, 2022

Choose a reason for hiding this comment

ktmud Apr 19, 2022

Choose a reason for hiding this comment

ktmud Apr 19, 2022

Choose a reason for hiding this comment

villebro Apr 19, 2022

Choose a reason for hiding this comment

ktmud Apr 19, 2022

Choose a reason for hiding this comment

villebro commented Apr 19, 2022

ktmud left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 19, 2022 •

edited

Loading

ktmud left a comment •

edited

Loading