feat: Embedded dashboard configuration by suddjian · Pull Request #19364 · apache/superset

suddjian · 2022-03-25T08:20:33Z

SUMMARY

Related to #17187.

This adds UI to make a dashboard embeddable. To support this I also wrote a backend model and some crud endpoints. The migration to create the table for this model was already done in #18561.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2022-03-25.at.10.03.11.PM.mov

TESTING INSTRUCTIONS

Turn on the EMBEDDED_SUPERSET feature flag, mark a dashboard as embedded, and embed it using the SDK.

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

suddjian · 2022-03-28T17:32:34Z

check feature flag on endpoints
change the embedded page route to use the new model
check permissions on the frontend
fix linting and maybe tests

…perset into embedded-setup-ui

…o embedded-setup-ui

codecov · 2022-03-30T18:04:36Z

Codecov Report

Merging #19364 (62b16f8) into master (0968f86) will increase coverage by 0.01%.
The diff coverage is 65.27%.

@@            Coverage Diff             @@
##           master   #19364      +/-   ##
==========================================
+ Coverage   66.55%   66.57%   +0.01%     
==========================================
  Files        1670     1675       +5     
  Lines       63824    64092     +268     
  Branches     6510     6519       +9     
==========================================
+ Hits        42481    42672     +191     
- Misses      19654    19729      +75     
- Partials     1689     1691       +2

Flag	Coverage Δ
hive	`52.70% <61.40%> (-0.23%)`	⬇️
javascript	`51.25% <14.70%> (-0.08%)`	⬇️
mysql	`81.91% <85.38%> (+0.04%)`	⬆️
postgres	`81.95% <85.38%> (+0.04%)`	⬆️
presto	`52.55% <61.40%> (-0.23%)`	⬇️
python	`82.39% <85.38%> (+0.04%)`	⬆️
sqlite	`81.72% <85.38%> (+0.05%)`	⬆️

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

Impacted Files	Coverage Δ
.../components/Header/HeaderActionsDropdown/index.jsx	`67.79% <0.00%> (-3.64%)`	⬇️
...ontend/src/dashboard/containers/DashboardRoute.tsx	`0.00% <0.00%> (ø)`
superset-frontend/src/embedded/index.tsx	`0.00% <0.00%> (ø)`
superset-frontend/src/preamble.ts	`0.00% <ø> (ø)`
superset/common/query_context_processor.py	`90.65% <0.00%> (ø)`
superset/dashboards/commands/export.py	`83.78% <0.00%> (-1.15%)`	⬇️
superset/views/dashboard/views.py	`65.51% <ø> (ø)`
...rc/dashboard/components/DashboardEmbedControls.tsx	`8.16% <8.16%> (ø)`
...frontend/src/dashboard/components/Header/index.jsx	`60.92% <50.00%> (-0.46%)`	⬇️
...rset-frontend/src/hooks/apiResources/dashboards.ts	`36.36% <50.00%> (+3.03%)`	⬆️
... and 22 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 0968f86...62b16f8. Read the comment docs.

lilykuang

LGTM

* embedded dashboard model * embedded dashboard endpoints * DRY up using the with_dashboard decorator elsewhere * wip * check feature flags and permissions * wip * sdk * urls * dao option for id column * got it working * Update superset/embedded/view.py * use the curator check * put back old endpoint, for now * allow access by either embedded.uuid or dashboard.id * keep the old endpoint around, for the time being * openapi * lint * lint * lint * test stuff * lint, test * typo * Update superset-frontend/src/embedded/index.tsx * Update superset-frontend/src/embedded/index.tsx * fix tests * bump sdk (cherry picked from commit 8e29ec5)

sadpandajoe · 2022-04-04T21:37:24Z

🏷️ preset:2022.11

* embedded dashboard model * embedded dashboard endpoints * DRY up using the with_dashboard decorator elsewhere * wip * check feature flags and permissions * wip * sdk * urls * dao option for id column * got it working * Update superset/embedded/view.py * use the curator check * put back old endpoint, for now * allow access by either embedded.uuid or dashboard.id * keep the old endpoint around, for the time being * openapi * lint * lint * lint * test stuff * lint, test * typo * Update superset-frontend/src/embedded/index.tsx * Update superset-frontend/src/embedded/index.tsx * fix tests * bump sdk

pull-request-size Bot added size/L size/XL and removed size/L labels Mar 25, 2022

suddjian added 10 commits March 29, 2022 10:05

embedded dashboard model

eb0e4a9

embedded dashboard endpoints

0732aca

DRY up using the with_dashboard decorator elsewhere

d718e6f

wip

16f08d0

check feature flags and permissions

5f431b5

wip

451e47d

sdk

bbdee14

urls

8051d99

dao option for id column

703a076

got it working

7e5cb37

suddjian force-pushed the embedded-setup-ui branch from 186fdc7 to 7e5cb37 Compare March 29, 2022 17:05

pull-request-size Bot added size/XXL and removed size/XL labels Mar 29, 2022

suddjian changed the title ~~feat: [WIP] Embedded Dashboard setup UI~~ feat: Embedded Dashboard setup UI Mar 29, 2022

suddjian changed the title ~~feat: Embedded Dashboard setup UI~~ feat: Embedded Dashboard configuration UI Mar 29, 2022

suddjian changed the title ~~feat: Embedded Dashboard configuration UI~~ feat: Embedded dashboard configuration Mar 29, 2022

suddjian requested a review from lilykuang March 29, 2022 17:06

lilykuang reviewed Mar 29, 2022

View reviewed changes

Comment thread superset-frontend/src/dashboard/components/Header/index.jsx Outdated

suddjian commented Mar 29, 2022

View reviewed changes

Comment thread superset/embedded/view.py Outdated

suddjian and others added 7 commits March 29, 2022 10:57

Update superset/embedded/view.py

4250165

use the curator check

c50e920

Merge branch 'embedded-setup-ui' of github.com:preset-io/incubator-su…

ae9a873

…perset into embedded-setup-ui

put back old endpoint, for now

e181fba

allow access by either embedded.uuid or dashboard.id

6d03361

keep the old endpoint around, for the time being

fd543a4

Merge branch 'master' into embedded-setup-ui

9e1762b

suddjian added 5 commits March 29, 2022 19:30

lint

2180db2

lint

4bbbd72

test stuff

86ff579

lint, test

b05ca22

typo

4d713bf

suddjian commented Mar 30, 2022

View reviewed changes

Comment thread superset-frontend/src/embedded/index.tsx

Update superset-frontend/src/embedded/index.tsx

4237402

suddjian commented Mar 30, 2022

View reviewed changes

Comment thread superset-frontend/src/embedded/index.tsx Outdated

suddjian and others added 4 commits March 29, 2022 22:53

Update superset-frontend/src/embedded/index.tsx

067b0b4

fix tests

7edb89f

Merge branch 'embedded-setup-ui' of github.com:preset-io/superset int…

54abe55

…o embedded-setup-ui

bump sdk

62b16f8

lilykuang approved these changes Mar 30, 2022

View reviewed changes

suddjian merged commit 8e29ec5 into apache:master Mar 30, 2022

villebro added the lts-v1 label Apr 1, 2022

superset-github-bot Bot added the preset:2022.11 label Apr 4, 2022

Usiel mentioned this pull request Dec 20, 2022

fix(embed): fix server error due to breaking change on flask-login #22462

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Embedded dashboard configuration#19364

feat: Embedded dashboard configuration#19364
suddjian merged 29 commits into
apache:masterfrom
preset-io:embedded-setup-ui

suddjian commented Mar 25, 2022 •

edited

Loading

Uh oh!

suddjian commented Mar 28, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Mar 30, 2022 •

edited

Loading

Uh oh!

lilykuang left a comment

Uh oh!

sadpandajoe commented Apr 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

suddjian commented Mar 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

suddjian commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Mar 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lilykuang left a comment

Choose a reason for hiding this comment

Uh oh!

sadpandajoe commented Apr 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

suddjian commented Mar 25, 2022 •

edited

Loading

suddjian commented Mar 28, 2022 •

edited

Loading

codecov Bot commented Mar 30, 2022 •

edited

Loading