feat: save active tabs in dashboard permalink #19983

ktmud · 2022-05-07T00:40:04Z

SUMMARY

Save which tabs are selected in permalink state and restore the tab selection so we can restore the same tab selection when users open a dashboard using permalink.

Also renamed properties in the dashboard permalink state to make them easier to understand.

This is in preparation for #19354 where we allow users to set tab selection when generating email reports for dashboards. The next step is to generate dashboard screenshots from permalink as well and attach the permalink to the email reports (we will generate a new permalink in the backend based on reports metadata). The next next step is to allow saving filter states in dashboard reports, too.

Depends on #19966

This PR includes a db migration where we renamed a couple of properties in permalink states. The migration should be fairly low risk since we are only updating permalinks for dashboards. At Airbnb, after running Superset with the new permalink feature for 3 weeks, there are only about 1400 links generated.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A

TESTING INSTRUCTIONS

Go to a tabbed dashboard with multiple tabbed sections
Switch more than one tab sections and copy a permalink for some tab
When opening the permalink, the previous tab selection should be retained

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-05-07T00:46:49Z

Codecov Report

Merging #19983 (f4cae95) into master (f29cde2) will decrease coverage by 0.00%.
The diff coverage is 56.31%.

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

@@            Coverage Diff             @@
##           master   #19983      +/-   ##
==========================================
- Coverage   66.85%   66.85%   -0.01%     
==========================================
  Files        1749     1750       +1     
  Lines       65411    65424      +13     
  Branches     6906     6906              
==========================================
+ Hits        43730    43737       +7     
- Misses      19931    19937       +6     
  Partials     1750     1750

Flag	Coverage Δ
hive	`53.77% <41.93%> (-0.01%)`	⬇️
mysql	`82.39% <54.83%> (-0.02%)`	⬇️
postgres	`82.46% <54.83%> (-0.02%)`	⬇️
presto	`53.63% <41.93%> (-0.01%)`	⬇️
python	`82.89% <54.83%> (-0.02%)`	⬇️
sqlite	`82.25% <54.83%> (-0.02%)`	⬇️
unit	`50.66% <54.83%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...d/packages/superset-ui-chart-controls/src/types.ts	`100.00% <ø> (ø)`
.../superset-ui-core/src/query/types/QueryFormData.ts	`100.00% <ø> (ø)`
.../legacy-plugin-chart-world-map/src/controlPanel.ts	`25.00% <ø> (ø)`
...s/legacy-preset-chart-nvd3/src/Bar/controlPanel.ts	`14.28% <ø> (ø)`
...gacy-preset-chart-nvd3/src/DistBar/controlPanel.ts	`8.33% <0.00%> (ø)`
.../legacy-preset-chart-nvd3/src/Line/controlPanel.ts	`50.00% <ø> (ø)`
...harts/src/BigNumber/BigNumberTotal/controlPanel.ts	`100.00% <ø> (ø)`
.../BigNumber/BigNumberWithTrendline/controlPanel.tsx	`20.00% <ø> (ø)`
...s/plugin-chart-echarts/src/BoxPlot/controlPanel.ts	`25.00% <0.00%> (ø)`
...s/plugin-chart-echarts/src/Funnel/controlPanel.tsx	`57.14% <ø> (ø)`
... and 79 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 f29cde2...a3076c1. Read the comment docs.

eschutho · 2022-05-10T16:16:26Z

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

-    const canEdit = canUserEditDashboard(dashboardData, user);
+    const canEdit = canUserEditDashboard(dashboard, user);
+
+    console.log(activeTabs);


left over console log

Thanks for catching this! I'll keep iterating on this PR until #19966 is merged.

ktmud · 2022-06-27T22:10:16Z

@eschutho This should be ready for re-review.

@villebro @michael-s-molina in case you have an interest in this as well.

ktmud · 2022-06-27T22:17:28Z

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

+          onClick={e => {
+            e.stopPropagation();
+          }}
+        >


Stop clicking on the copy icon from switching tabs, which is kind of surprising/annoying----if clicking on the link icon doesn't switch tabs, then clicking on things in the popover triggered by the link icon shouldn't switch tabs either.

Before

After

etr2460

a few comments, but nothing blocking i think

etr2460 · 2022-06-28T03:31:14Z

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

@@ -66,7 +75,14 @@ export default function URLShortLinkButton({
      trigger="click"
      placement={placement}
      content={
-        <div id="shorturl-popover" data-test="shorturl-popover">
+        // eslint-disable-next-line jsx-a11y/no-static-element-interactions


hmm, shouldn't the stop propagation go on the copy to clipboard link instead? It's weird that we need to handle a click on a div

The click event also triggers popover open. Since this is related to the popover, I thought it'd make more sense to handle the event on the direct children of the popover trigger. If we stop propagation on the icon, the popover may not even open.

etr2460 · 2022-06-28T03:33:46Z

superset-frontend/src/utils/urlUtils.ts

-    .catch(response =>
-      // @ts-ignore
-      getClientErrorObject(response).then(({ error, statusText }) =>
-        Promise.reject(error || statusText),
-      ),
-    );


we'll never get an error here?

Errors should be handled downstream---when it's about to be rendered. These adhoc handling of API errors makes it more difficult to handle errors consistently.

etr2460 · 2022-06-28T03:34:09Z

superset/key_value/models.py

@@ -21,14 +21,16 @@
 from superset import security_manager
 from superset.models.helpers import AuditMixinNullable, ImportExportMixin

+VALUE_MAX_SIZE = 2**24 - 1


heh, nice bycatch

etr2460 · 2022-06-28T03:34:38Z

superset/migrations/versions/2022-06-27_14-59_7fb8bca906d2_permalink_rename_filterstate.py

+from superset.migrations.shared.utils import paginated_update
+
+Base = declarative_base()
+VALUE_MAX_SIZE = 2**24 - 1


can we import this from the model file instead of defining it twice?

We shouldn't import things from modules for migrations as modules may be move around and these constant values may change but migrations need to be deterministic.

etr2460 · 2022-06-28T03:35:05Z

superset/views/core.py

@@ -2001,13 +2001,13 @@ def dashboard_permalink(  # pylint: disable=no-self-use
            return redirect("/dashboard/list/")
        if not value:
            return json_error_response(_("permalink state not found"), status=404)
-        dashboard_id = value["dashboardId"]
+        dashboard_id, state = value["dashboardId"], value.get("state", {})


is this standard styling? i would just use 2 lines tbh

Nah, just my style choice. Since they are both derived from the same variable. It's more concise to be written in one line. This is similar to object expansion in JS.

(cherry picked from commit cadd259)

ktmud requested a review from a team as a code owner May 7, 2022 00:40

pull-request-size bot added the size/XXL label May 7, 2022

eschutho reviewed May 10, 2022

View reviewed changes

ktmud force-pushed the dashboard-active-tabs-in-url branch from 7b670a3 to e50a8eb Compare June 27, 2022 22:00

pull-request-size bot added size/L and removed size/XXL labels Jun 27, 2022

ktmud force-pushed the dashboard-active-tabs-in-url branch from 8019609 to d31f0a8 Compare June 27, 2022 22:07

ktmud commented Jun 27, 2022

View reviewed changes

ktmud force-pushed the dashboard-active-tabs-in-url branch from d31f0a8 to 61092e5 Compare June 28, 2022 00:07

feat: save active tabs in dashboard permalink

dbe28d1

ktmud force-pushed the dashboard-active-tabs-in-url branch from 61092e5 to dbe28d1 Compare June 28, 2022 00:18

etr2460 approved these changes Jun 28, 2022

View reviewed changes

fix unit test

a3076c1

ktmud merged commit cadd259 into apache:master Jun 29, 2022

ktmud mentioned this pull request Jun 29, 2022

feat(report): allow capturing dashboard reports in specific state #20552

Merged

11 tasks

ktmud deleted the dashboard-active-tabs-in-url branch July 11, 2022 22:36

diegomedina248 mentioned this pull request Jul 13, 2022

fix(dashboard): Native filter on the dashboard with multiple tabs is displayed as out of scope #20693

Merged

9 tasks

akshatsri pushed a commit to charan1314/superset that referenced this pull request Jul 19, 2022

feat: save active tabs in dashboard permalink (apache#19983)

36ab07e

john-bodley pushed a commit to airbnb/superset-fork that referenced this pull request Sep 8, 2022

feat: save active tabs in dashboard permalink (apache#19983)

aa34202

(cherry picked from commit cadd259)

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: save active tabs in dashboard permalink #19983

feat: save active tabs in dashboard permalink #19983

ktmud commented May 7, 2022 •

edited

Loading

codecov bot commented May 7, 2022 •

edited

Loading

eschutho May 10, 2022

ktmud May 10, 2022 •

edited

Loading

ktmud commented Jun 27, 2022

ktmud Jun 27, 2022

etr2460 left a comment

etr2460 Jun 28, 2022

ktmud Jun 28, 2022

etr2460 Jun 28, 2022

ktmud Jun 28, 2022

etr2460 Jun 28, 2022

etr2460 Jun 28, 2022

ktmud Jun 28, 2022

etr2460 Jun 28, 2022

ktmud Jun 28, 2022

feat: save active tabs in dashboard permalink #19983

feat: save active tabs in dashboard permalink #19983

Conversation

ktmud commented May 7, 2022 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented May 7, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

ktmud May 10, 2022 • edited Loading

Choose a reason for hiding this comment

ktmud commented Jun 27, 2022

Choose a reason for hiding this comment

Before

After

etr2460 left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ktmud commented May 7, 2022 •

edited

Loading

codecov bot commented May 7, 2022 •

edited

Loading

ktmud May 10, 2022 •

edited

Loading