feat: entry for embedded dashboard #17529

lilykuang · 2021-11-23T23:18:41Z

Note: This is a PR into a feature branch, not into master. #17530

creates a frontend entry with listener to get guest token coming from host app (see feat: Guest token (for embedded dashboard auth) #17517)
set guest token as cookies and sends to backend for verification

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

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

superset/views/core.py

@@ -1955,6 +1955,38 @@ def dashboard(
            ),
        )

+
+    @expose("/dashboard/<dashboard_id_or_slug>/embedded")


codecov · 2021-12-03T00:08:39Z

Codecov Report

Merging #17529 (37731e1) into embedded (4c74e53) will decrease coverage by 0.03%.
The diff coverage is 17.24%.

@@             Coverage Diff              @@
##           embedded   #17529      +/-   ##
============================================
- Coverage     66.39%   66.35%   -0.04%     
============================================
  Files          1571     1573       +2     
  Lines         61801    61848      +47     
  Branches       6243     6251       +8     
============================================
+ Hits          41031    41039       +8     
- Misses        19172    19210      +38     
- Partials       1598     1599       +1

Flag	Coverage Δ
hive	`53.25% <46.15%> (-0.01%)`	⬇️
javascript	`50.88% <8.88%> (-0.05%)`	⬇️
mysql	`82.11% <46.15%> (-0.02%)`	⬇️
postgres	`82.16% <46.15%> (-0.02%)`	⬇️
presto	`53.09% <46.15%> (-0.01%)`	⬇️
python	`82.60% <46.15%> (-0.02%)`	⬇️
sqlite	`81.85% <46.15%> (-0.02%)`	⬇️

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

Impacted Files	Coverage Δ
.../superset-ui-core/src/connection/SupersetClient.ts	`100.00% <ø> (ø)`
...ackages/superset-ui-core/src/utils/featureFlags.ts	`100.00% <ø> (ø)`
superset-frontend/src/embedded/index.tsx	`0.00% <0.00%> (ø)`
superset-frontend/src/preamble.ts	`0.00% <ø> (ø)`
superset-frontend/src/setup/setupClient.ts	`0.00% <0.00%> (ø)`
superset-frontend/src/views/App.tsx	`0.00% <0.00%> (ø)`
...perset-frontend/src/views/RootContextProviders.tsx	`0.00% <0.00%> (ø)`
superset/views/dashboard/views.py	`65.16% <46.15%> (-4.07%)`	⬇️
...rset-ui-core/src/connection/SupersetClientClass.ts	`97.01% <66.66%> (-2.99%)`	⬇️

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 4c74e53...37731e1. Read the comment docs.

craig-rueda · 2021-12-09T03:12:49Z

Looks like something went wrong with your merge? 2k+ commits?

# Conflicts: # superset-frontend/src/embedded/index.tsx # superset/views/core.py

superset-frontend/src/embedded/index.tsx

suddjian · 2022-01-05T20:56:31Z

superset-frontend/src/embedded/index.tsx

+// if the page is embedded in an origin that hasn't
+// been authorized by the curator, we forbid access entirely.
+// todo: check the referrer on the route serving this page instead
+const ALLOW_ORIGINS = ['http://127.0.0.1:9001', 'http://localhost:9001'];


Maybe for now we could read the allowed origins from bootstrap data/config values, until there is an embedded dashboards table available. We will need something like that to get Preset's embedded dash working outside of localhost.

Or could just comment this out until then

commenting it out should be better so we dont have to remove bootstrap data later

superset-frontend/src/embedded/index.tsx

Co-authored-by: David Aaron Suddjian <[email protected]>

…ntry-point # Conflicts: # superset-frontend/src/views/App.tsx

suddjian

yas

* feat(dashboard): embedded dashboard UI configuration (#17175) (#17450) * setup embedded provider * update ui configuration * fix test * feat: Guest token (for embedded dashboard auth) (#17517) * generate an embed token * improve existing tests * add some auth setup, and rename token * fix the stuff for compatibility with external request loaders * docs, standard jwt claims, tweaks * black * lint * tests, and safer token decoding * linting * type annotation * prettier * add feature flag * quiet pylint * apparently typing is a problem again * Make guest role name configurable * fake being a non-anonymous user * just one log entry * customizable algo * lint * lint again * 403 works now! * get guest token from header instead of cookie * Revert "403 works now!" This reverts commit df2f49a. * fix tests * Revert "Revert "403 works now!"" This reverts commit 883dff3. * rename method * correct import * feat: entry for embedded dashboard (#17529) * create entry for embedded dashboard in webpack * add cookies * lint * token message handshake * guestTokenHeaderName * use setupClient instead of calling configure * rename the webpack chunk * simplified handshake * embedded entrypoint: render a proper app * make the embedded page accept anonymous connections * format * lint * fix test # Conflicts: # superset-frontend/src/embedded/index.tsx # superset/views/core.py * lint * Update superset-frontend/src/embedded/index.tsx Co-authored-by: David Aaron Suddjian <[email protected]> * comment out origins checks * move embedded for core to dashboard * pylint * isort Co-authored-by: David Aaron Suddjian <[email protected]> Co-authored-by: David Aaron Suddjian <[email protected]> * feat: Authorizing guest access to embedded dashboards (#17757) * helper methods and dashboard access * guest token dashboard authz * adjust csrf exempt list * eums don't work that way * Remove unnecessary import * move row level security tests to their own file * a bit of refactoring * add guest token security tests * refactor tests * clean imports * variable names can be too long apparently * missing argument to get_user_roles * don't redefine builtins * remove unused imports * fix test import * default to global user when getting roles * missing import * mock it * test get_user_roles * infer g.user for ease of tests * remove redundant check * tests for guest user security manager fns * use algo to get rid of warning messages * tweaking access checks * fix guest token security tests * missing imports * more tests * more testing and also some small refactoring * move validation out of parsing * fix dashboard access check again * add more test Co-authored-by: Lily Kuang <[email protected]> * feat: Row Level Security rules for guest tokens (#17836) * helper methods and dashboard access * guest token dashboard authz * adjust csrf exempt list * eums don't work that way * Remove unnecessary import * move row level security tests to their own file * a bit of refactoring * add guest token security tests * refactor tests * clean imports * variable names can be too long apparently * missing argument to get_user_roles * don't redefine builtins * remove unused imports * fix test import * default to global user when getting roles * missing import * mock it * test get_user_roles * infer g.user for ease of tests * remove redundant check * tests for guest user security manager fns * use algo to get rid of warning messages * tweaking access checks * fix guest token security tests * missing imports * more tests * more testing and also some small refactoring * move validation out of parsing * fix dashboard access check again * rls rules for guest tokens * test guest token rls rules * more flexible rls rules * lint * fix tests * fix test * defaults * fix some tests * fix some tests * lint Co-authored-by: Lily Kuang <[email protected]> * SupersetClient guest token test * Apply suggestions from code review Co-authored-by: Lily Kuang <[email protected]> Co-authored-by: Lily Kuang <[email protected]>

* feat(dashboard): embedded dashboard UI configuration (apache#17175) (apache#17450) * setup embedded provider * update ui configuration * fix test * feat: Guest token (for embedded dashboard auth) (apache#17517) * generate an embed token * improve existing tests * add some auth setup, and rename token * fix the stuff for compatibility with external request loaders * docs, standard jwt claims, tweaks * black * lint * tests, and safer token decoding * linting * type annotation * prettier * add feature flag * quiet pylint * apparently typing is a problem again * Make guest role name configurable * fake being a non-anonymous user * just one log entry * customizable algo * lint * lint again * 403 works now! * get guest token from header instead of cookie * Revert "403 works now!" This reverts commit df2f49a. * fix tests * Revert "Revert "403 works now!"" This reverts commit 883dff3. * rename method * correct import * feat: entry for embedded dashboard (apache#17529) * create entry for embedded dashboard in webpack * add cookies * lint * token message handshake * guestTokenHeaderName * use setupClient instead of calling configure * rename the webpack chunk * simplified handshake * embedded entrypoint: render a proper app * make the embedded page accept anonymous connections * format * lint * fix test # Conflicts: # superset-frontend/src/embedded/index.tsx # superset/views/core.py * lint * Update superset-frontend/src/embedded/index.tsx Co-authored-by: David Aaron Suddjian <[email protected]> * comment out origins checks * move embedded for core to dashboard * pylint * isort Co-authored-by: David Aaron Suddjian <[email protected]> Co-authored-by: David Aaron Suddjian <[email protected]> * feat: Authorizing guest access to embedded dashboards (apache#17757) * helper methods and dashboard access * guest token dashboard authz * adjust csrf exempt list * eums don't work that way * Remove unnecessary import * move row level security tests to their own file * a bit of refactoring * add guest token security tests * refactor tests * clean imports * variable names can be too long apparently * missing argument to get_user_roles * don't redefine builtins * remove unused imports * fix test import * default to global user when getting roles * missing import * mock it * test get_user_roles * infer g.user for ease of tests * remove redundant check * tests for guest user security manager fns * use algo to get rid of warning messages * tweaking access checks * fix guest token security tests * missing imports * more tests * more testing and also some small refactoring * move validation out of parsing * fix dashboard access check again * add more test Co-authored-by: Lily Kuang <[email protected]> * feat: Row Level Security rules for guest tokens (apache#17836) * helper methods and dashboard access * guest token dashboard authz * adjust csrf exempt list * eums don't work that way * Remove unnecessary import * move row level security tests to their own file * a bit of refactoring * add guest token security tests * refactor tests * clean imports * variable names can be too long apparently * missing argument to get_user_roles * don't redefine builtins * remove unused imports * fix test import * default to global user when getting roles * missing import * mock it * test get_user_roles * infer g.user for ease of tests * remove redundant check * tests for guest user security manager fns * use algo to get rid of warning messages * tweaking access checks * fix guest token security tests * missing imports * more tests * more testing and also some small refactoring * move validation out of parsing * fix dashboard access check again * rls rules for guest tokens * test guest token rls rules * more flexible rls rules * lint * fix tests * fix test * defaults * fix some tests * fix some tests * lint Co-authored-by: Lily Kuang <[email protected]> * SupersetClient guest token test * Apply suggestions from code review Co-authored-by: Lily Kuang <[email protected]> Co-authored-by: Lily Kuang <[email protected]>

superset-github-bot bot added the preset-io label Nov 23, 2021

pull-request-size bot added the size/M label Nov 23, 2021

lilykuang requested a review from suddjian November 23, 2021 23:18

lilykuang marked this pull request as draft November 23, 2021 23:19

lilykuang commented Nov 29, 2021

View reviewed changes

superset/views/core.py Outdated

@@ -1955,6 +1955,38 @@ def dashboard(

),

)

@expose("/dashboard/<dashboard_id_or_slug>/embedded")

This comment was marked as resolved.

Sign in to view

lilykuang changed the title ~~wip: entry for embedded dashboard~~ feat: entry for embedded dashboard Nov 30, 2021

lilykuang changed the title ~~feat: entry for embedded dashboard~~ feat: entry for embedded dashboard (wip) Nov 30, 2021

lilykuang changed the title ~~feat: entry for embedded dashboard (wip)~~ feat: entry for embedded dashboard Dec 2, 2021

lilykuang marked this pull request as ready for review December 2, 2021 21:34

lilykuang force-pushed the embedded-entry-point branch from 7d125dd to d918435 Compare December 2, 2021 23:09

pull-request-size bot added size/L and removed size/M labels Dec 2, 2021

lilykuang force-pushed the embedded-entry-point branch from d918435 to a3d1e38 Compare December 2, 2021 23:31

lilykuang requested review from geido, michael-s-molina and a team as code owners December 9, 2021 01:00

pull-request-size bot added size/XXL and removed size/L labels Dec 9, 2021

Lily Kuang and others added 8 commits December 9, 2021 10:22

create entry for embedded dashboard in webpack

50b0f44

add cookies

305dbf8

lint

e5d4bf2

token message handshake

fcbaac9

guestTokenHeaderName

7b15c34

use setupClient instead of calling configure

c0eefcb

rename the webpack chunk

4138527

simplified handshake

8482f42

suddjian force-pushed the embedded-entry-point branch from 8b388e1 to 8482f42 Compare December 9, 2021 18:23

pull-request-size bot removed the size/XXL label Dec 9, 2021

pull-request-size bot added the size/L label Dec 9, 2021

suddjian and others added 8 commits December 10, 2021 23:49

embedded entrypoint: render a proper app

cec1061

make the embedded page accept anonymous connections

0bab7bf

format

b447e72

Merge branch 'embedded' into embedded-entry-point

2c8b7bf

lint

c05b8d7

fix test

7c8ab52

# Conflicts: # superset-frontend/src/embedded/index.tsx # superset/views/core.py

lint

25567b2

Merge branch 'embedded' into embedded-entry-point

7123276

suddjian reviewed Jan 5, 2022

View reviewed changes

superset-frontend/src/embedded/index.tsx Outdated Show resolved Hide resolved

suddjian reviewed Jan 5, 2022

View reviewed changes

superset-frontend/src/embedded/index.tsx Show resolved Hide resolved

Lily Kuang and others added 4 commits January 5, 2022 16:44

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

ea05b89

Co-authored-by: David Aaron Suddjian <[email protected]>

comment out origins checks

ca7f4c5

Merge branch 'embedded' of github.com:apache/superset into embedded-e…

2a4e08b

…ntry-point # Conflicts: # superset-frontend/src/views/App.tsx

move embedded for core to dashboard

cd45b1b

suddjian approved these changes Jan 14, 2022

View reviewed changes

Lily Kuang added 2 commits January 13, 2022 16:56

pylint

ccc090a

isort

37731e1

lilykuang merged commit fe63435 into apache:embedded Jan 14, 2022

lilykuang deleted the embedded-entry-point branch January 14, 2022 17:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: entry for embedded dashboard #17529

feat: entry for embedded dashboard #17529

lilykuang commented Nov 23, 2021 •

edited

Loading

This comment was marked as resolved.

codecov bot commented Dec 3, 2021 •

edited

Loading

craig-rueda commented Dec 9, 2021

suddjian Jan 5, 2022 •

edited

Loading

suddjian Jan 5, 2022

lilykuang Jan 6, 2022

suddjian left a comment

feat: entry for embedded dashboard #17529

feat: entry for embedded dashboard #17529

Conversation

lilykuang commented Nov 23, 2021 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

This comment was marked as resolved.

codecov bot commented Dec 3, 2021 • edited Loading

Codecov Report

craig-rueda commented Dec 9, 2021

suddjian Jan 5, 2022 • edited Loading

Choose a reason for hiding this comment

suddjian Jan 5, 2022

Choose a reason for hiding this comment

lilykuang Jan 6, 2022

Choose a reason for hiding this comment

suddjian left a comment

Choose a reason for hiding this comment

lilykuang commented Nov 23, 2021 •

edited

Loading

codecov bot commented Dec 3, 2021 •

edited

Loading

suddjian Jan 5, 2022 •

edited

Loading