feat(welcome): make examples tab customizable #22302

villebro · 2022-12-01T13:06:10Z

SUMMARY

Currently the Welcome page features an "Examples" tab for Dashboards and Charts. While this is ok for test environments utilizing the examples datasets/charts/dashboards, this is of little utility in production environments. To make the Welcome page more useful in Production environments, this PR adds a simple configuration option WELCOME_PAGE_LAST_TAB to show "All" charts/dashboards that would be accessible via the list views, and also makes it possible to define a custom title and filters for more custom use cases.

This also fixes the birth names example datasets, charts and dashboards, which unlike other examples, were created by the admin user, causing them not to show up on the Examples tab. I also decided to clean up some types along the way, and that turned into a pretty horrible journey 😱 I think I need to follow up with some additional cleanup later.

AFTER

By changing WELCOME_PAGE_LAST_TAB to "all", the last tab displays all dashboards/charts that the users would see in their respective list views:

By creating the following custom tab config, the last tab only shows charts/dashboards created by user number 10:

WELCOME_PAGE_LAST_TAB = ("Xyz", [{"col": 'created_by', "opr": 'rel_o_m', "value": 10}])

BEFORE

Previously only examples were available in the dashboard and chart sections:

TESTING 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

codecov · 2022-12-01T13:13:40Z

Codecov Report

Merging #22302 (f5160cf) into master (2679ee2) will decrease coverage by 0.83%.
The diff coverage is 63.63%.

@@            Coverage Diff             @@
##           master   #22302      +/-   ##
==========================================
- Coverage   66.90%   66.07%   -0.84%     
==========================================
  Files        1850     1851       +1     
  Lines       70701    70693       -8     
  Branches     7750     7758       +8     
==========================================
- Hits        47306    46707     -599     
- Misses      21379    21967     +588     
- Partials     2016     2019       +3

Flag	Coverage Δ
hive	`?`
mysql	`?`
postgres	`?`
presto	`52.35% <62.50%> (-0.01%)`	⬇️
python	`79.48% <62.50%> (-1.77%)`	⬇️
sqlite	`76.49% <62.50%> (-0.02%)`	⬇️
unit	`50.96% <12.50%> (+0.02%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/featureFlags.ts	`28.57% <ø> (ø)`
superset-frontend/src/types/bootstrapTypes.ts	`100.00% <ø> (ø)`
superset-frontend/src/utils/localStorageHelpers.ts	`90.00% <ø> (ø)`
superset-frontend/src/utils/urlUtils.ts	`50.90% <ø> (ø)`
...tend/src/views/CRUD/data/database/DatabaseList.tsx	`65.68% <ø> (ø)`
superset-frontend/src/views/components/Menu.tsx	`49.23% <ø> (ø)`
...perset-frontend/src/views/components/RightMenu.tsx	`78.23% <ø> (ø)`
superset-frontend/src/views/components/SubMenu.tsx	`86.88% <ø> (ø)`
superset/examples/supported_charts_dashboard.py	`0.00% <0.00%> (ø)`
superset/views/base.py	`76.28% <ø> (ø)`
... and 52 more

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

rusackas · 2022-12-01T16:19:33Z

This is a great tweak, and I appreciate all the cleanup work along the way. I also appreciate that the default config keeps the default functionality the same, so it's a seamless transition.

My only curiosity is if you think it's worth considering making ALL the tabs configurable... I can see just as many users not being concerned about "Favorites" or wanting to add a fourth tab fo their own (e.g. "My Team"). The config could be an array of tab definitions, perhaps... though on the other hand that might be pushing it in terms of complexity for a config option ;)

villebro · 2022-12-01T16:36:34Z

This is a great tweak, and I appreciate all the cleanup work along the way. I also appreciate that the default config keeps the default functionality the same, so it's a seamless transition.

My only curiosity is if you think it's worth considering making ALL the tabs configurable... I can see just as many users not being concerned about "Favorites" or wanting to add a fourth tab fo their own (e.g. "My Team"). The config could be an array of tab definitions, perhaps... though on the other hand that might be pushing it in terms of complexity for a config option ;)

That's a REALLY good idea. Let me see if this could be done easily.

villebro · 2022-12-07T14:26:58Z

@rusackas it turns out making ithis more generic would require a pretty substantial refactor, so I propose tackling that in a separate PR

rusackas · 2022-12-08T21:59:57Z

/testenv up

rusackas

Thanks for all the cleanup in this! Changes seem sensible to me, though a second pair of eyes sure would be very welcomed - there's a lot to comb through here!

rusackas · 2022-12-08T22:01:19Z

cc @eric-briscoe for a potential reviewer as well

github-actions · 2022-12-08T22:02:15Z

@rusackas Ephemeral environment spinning up at http://54.203.164.117:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

superset-frontend/src/views/CRUD/welcome/ChartTable.tsx

superset-frontend/src/views/CRUD/welcome/Welcome.tsx

superset/config.py

superset-frontend/src/utils/getBootstrapData.ts

superset-frontend/src/types/bootstrapTypes.ts

villebro · 2022-12-15T07:19:44Z

Thanks for the valuable reviews @kgabryje and @michael-s-molina ! ❤️ I'll address the comments shortly.

villebro · 2022-12-16T19:25:57Z

/testenv up

github-actions · 2022-12-16T19:29:56Z

@villebro Ephemeral environment spinning up at http://52.36.216.8:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

villebro · 2022-12-18T08:52:20Z

/testenv up

github-actions · 2022-12-18T08:56:16Z

@villebro Ephemeral environment spinning up at http://35.87.47.150:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

villebro · 2022-12-19T06:44:21Z

/testenv up

github-actions · 2022-12-19T06:48:52Z

@villebro Ephemeral environment spinning up at http://54.245.133.177:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

villebro · 2022-12-19T07:16:56Z

@jinghua-qa I've created an eph env http://54.245.133.177:8080/ where you can verify that the welcome page works as expected with the defaults (should display "Examples" charts/dashboards). Note the following:

I've created a chart and dashboard in the eph env to show that the "Mine" tab is working as expected. I've also favorited one own and one example chart/dashboard
Previous to this PR, the birth names dataset, charts and dashboards were displayed as being created by Admin user. That's now changed so that the birth names examples don't have a creator (same as the other examples).

superset/examples/birth_names.py

superset-frontend/src/views/CRUD/utils.test.tsx

jinghua-qa · 2022-12-20T11:52:10Z

@jinghua-qa I've created an eph env http://54.245.133.177:8080/ where you can verify that the welcome page works as expected with the defaults (should display "Examples" charts/dashboards). Note the following:

I've created a chart and dashboard in the eph env to show that the "Mine" tab is working as expected. I've also favorited one own and one example chart/dashboard

Previous to this PR, the birth names dataset, charts and dashboards were displayed as being created by Admin user. That's now changed so that the birth names examples don't have a creator (same as the other examples).

Thank you Ville for the testing instruction!

jinghua-qa

Tested welcome page with default, LGTM

github-actions · 2022-12-21T07:29:09Z

Ephemeral environment shutdown and build artifacts deleted.

pull-request-size bot added the size/L label Dec 1, 2022

villebro force-pushed the villebro/welcome branch from 14b101b to 09ab79c Compare December 1, 2022 13:43

villebro requested review from michael-s-molina, kgabryje and geido December 7, 2022 18:33

rusackas approved these changes Dec 8, 2022

View reviewed changes

kgabryje reviewed Dec 14, 2022

View reviewed changes

superset-frontend/src/views/CRUD/welcome/ChartTable.tsx Outdated Show resolved Hide resolved

kgabryje reviewed Dec 14, 2022

View reviewed changes

superset-frontend/src/views/CRUD/welcome/Welcome.tsx Outdated Show resolved Hide resolved

kgabryje reviewed Dec 14, 2022

View reviewed changes

superset-frontend/src/views/CRUD/welcome/Welcome.tsx Outdated Show resolved Hide resolved

kgabryje reviewed Dec 14, 2022

View reviewed changes

superset/config.py Show resolved Hide resolved

michael-s-molina reviewed Dec 14, 2022

View reviewed changes

superset-frontend/src/utils/getBootstrapData.ts Outdated Show resolved Hide resolved

michael-s-molina reviewed Dec 14, 2022

View reviewed changes

superset-frontend/src/utils/getBootstrapData.ts Show resolved Hide resolved

superset-frontend/src/types/bootstrapTypes.ts Show resolved Hide resolved

villebro added 5 commits December 15, 2022 09:22

feat(welcome): make examples tab customizable

7c68da1

add license

c607c89

fix types

c0f7a87

more types

d2a5d0f

more fixing

e63231d

villebro force-pushed the villebro/welcome branch from ba214e1 to 274ff53 Compare December 15, 2022 13:34

pull-request-size bot added size/XL and removed size/L labels Dec 15, 2022

lots of refactoring

201e447

villebro force-pushed the villebro/welcome branch from 274ff53 to 201e447 Compare December 15, 2022 13:41

villebro added 2 commits December 17, 2022 10:51

default to examples

d0fcc95

add tests

9f161d8

pull-request-size bot added size/XXL and removed size/XL labels Dec 18, 2022

villebro force-pushed the villebro/welcome branch from 51fadf8 to 5323255 Compare December 19, 2022 05:36

remove admin as birth_names owner/creator

f5160cf

villebro force-pushed the villebro/welcome branch from 5323255 to f5160cf Compare December 19, 2022 05:51

villebro commented Dec 19, 2022

View reviewed changes

superset/examples/birth_names.py Show resolved Hide resolved

villebro commented Dec 19, 2022

View reviewed changes

superset-frontend/src/views/CRUD/utils.test.tsx Show resolved Hide resolved

jinghua-qa approved these changes Dec 21, 2022

View reviewed changes

villebro merged commit b954f8f into apache:master Dec 21, 2022

villebro deleted the villebro/welcome branch December 21, 2022 07:28

codyml mentioned this pull request Dec 21, 2022

chore: Bump Pillow to 9.3.0 #22489

Merged

9 tasks

villebro mentioned this pull request Dec 22, 2022

fix(cypress): disable flaky tests #22512

Merged

9 tasks

This was referenced Jan 3, 2023

chore: Migrate /superset/search_queries to API v1 #22579

Merged

chore: Migrate /superset/queries/<last_updated_ms> to API v1 #22611

Merged

villebro mentioned this pull request Jan 20, 2023

chore(welcome): change default last tab to "all" #22798

Merged

9 tasks

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(welcome): make examples tab customizable #22302

feat(welcome): make examples tab customizable #22302

villebro commented Dec 1, 2022 •

edited

Loading

codecov bot commented Dec 1, 2022 •

edited

Loading

rusackas commented Dec 1, 2022

villebro commented Dec 1, 2022

villebro commented Dec 7, 2022

rusackas commented Dec 8, 2022

rusackas left a comment

rusackas commented Dec 8, 2022

github-actions bot commented Dec 8, 2022

villebro commented Dec 15, 2022

villebro commented Dec 16, 2022

github-actions bot commented Dec 16, 2022

villebro commented Dec 18, 2022

github-actions bot commented Dec 18, 2022

villebro commented Dec 19, 2022

github-actions bot commented Dec 19, 2022

villebro commented Dec 19, 2022

jinghua-qa commented Dec 20, 2022

jinghua-qa left a comment

github-actions bot commented Dec 21, 2022

feat(welcome): make examples tab customizable #22302

feat(welcome): make examples tab customizable #22302

Conversation

villebro commented Dec 1, 2022 • edited Loading

SUMMARY

AFTER

BEFORE

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Dec 1, 2022 • edited Loading

Codecov Report

rusackas commented Dec 1, 2022

villebro commented Dec 1, 2022

villebro commented Dec 7, 2022

rusackas commented Dec 8, 2022

rusackas left a comment

Choose a reason for hiding this comment

rusackas commented Dec 8, 2022

github-actions bot commented Dec 8, 2022

villebro commented Dec 15, 2022

villebro commented Dec 16, 2022

github-actions bot commented Dec 16, 2022

villebro commented Dec 18, 2022

github-actions bot commented Dec 18, 2022

villebro commented Dec 19, 2022

github-actions bot commented Dec 19, 2022

villebro commented Dec 19, 2022

jinghua-qa commented Dec 20, 2022

jinghua-qa left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 21, 2022

villebro commented Dec 1, 2022 •

edited

Loading

codecov bot commented Dec 1, 2022 •

edited

Loading