feat: Embed SDK 2.0 #210

bryans99 · 2024-12-24T16:32:46Z

No description provided.

bryans99 · 2024-12-24T16:36:17Z

The beginnings of Embed SDK 2.0.

Very much a WIP but I want to get a backup

demo/demo_config.ts

src/v2/EmbedBuilderEx.ts

2. Upgrade karma type script packages. 3. Update documentation. 4. Reduce exposed embed sdk 2.0.0 classes to the minumum. 5. Update version to 2.0.0 6. Fix minor issue with comment in demo. 7. Correct copyright dates.

out code. 2. Fix internal event handler setup so that users of the sdk can listen to events (internal event handler was overwriting handlers added with "on". 3. Fix cookieless login. Incorrect separator used. 4. Fix asLookConnection return type. Was ILookerEmbedExtension. Now is ILookerEmbedLook (copy pasta error). 5. Fix LookerEmbedSDKFactory constructor input type. Now is interface. 6. Initial karma tests for 2.0.

2. Various fixes for issues found while writing tests for LokerEmbedExSDK

2. Add more withApiHost and withAuth tests to LookerEmbedExSDK tests 3. Hide internal properties and methods from documentation 4. Regenerate documentation

2. LookerEmbedExSDK test update 3. doc cleanup 4. Clean up function names 5. Remove unnecessary assertions 6. Clean up generateTokens error handling 7. Fix appendRequiredParameters processing for sandboxed host 8. Add clarifying comments for sandboxed host 9. Fix connect for private embed 10. Fix isCookielessEmbed check (replaces assertions)

2. Update docs to reflect generatTokens change

does not support it) 2. fix generateTokens handling of fetch init object 3. clean up generate error handling 4. correct initCookieless generateTokens typing 5. more EmbedClientEx tests

2. Updated documentation to reflect removed method 3. EmbedConnection.loadUrl method is the only method for setting default values for pushHistory and waitUntilLoaded 4. DashbordConnection tests 5. Updated EmbedClientEx tests to spy on mocks instead of connection. Spy ons now callThrough. 6. EmbedConnection tests 7. Add mock sendAndReceive method

2. ExploreConnection test 3. ExtensionConnection test 4. LookConnection test

SDK. 2. Rename original demo to multi frame demo 3. Rename new demo to single frame demo 4. Change title of message example tp Embed Message API Demo

2. use auto gen cert for npm start

jkaster

I think there are still more readme changes pending?

jkaster

Nice update for certs

2. Embed sdk sanitizes the URL before determining the page type 3, createLookWithId accepts a string and a number 4. Increased test coverage 5. Added history fallback to dev and demo servers 6. Added history support to demo. 7. Updated docs

Co-authored-by: John Kaster <[email protected]>

jkaster

Non-blocking suggestions on the README

jkaster · 2025-04-28T23:52:58Z

README.md


-The _frontend_ process using the Embed SDK entails:
+In order to use the Embed SDK on the frontend you must supply a backend service that handles signing of the Embed URL. This service is called by the Embed SDK to generate a signed URL that is unique to the requesting user. The backend process can either generate the signed embed URL itself using an embed secret or can generate the URL by calling the [Looker Create Signed Embed URL API](https://cloud.google.com/looker/docs/reference/looker-api/latest/methods/Auth/create_sso_embed_url). Manual URL generation and signing avoids calling the Looker API resulting in decreased latency. Calling the Looker API requires less code and is easier to maintain.


Suggested change

In order to use the Embed SDK on the frontend you must supply a backend service that handles signing of the Embed URL. This service is called by the Embed SDK to generate a signed URL that is unique to the requesting user. The backend process can either generate the signed embed URL itself using an embed secret or can generate the URL by calling the [Looker Create Signed Embed URL API](https://cloud.google.com/looker/docs/reference/looker-api/latest/methods/Auth/create_sso_embed_url). Manual URL generation and signing avoids calling the Looker API resulting in decreased latency. Calling the Looker API requires less code and is easier to maintain.

In order to use the Embed SDK on the frontend you must supply a backend service that handles signing of the Embed URL. This service is called by the Embed SDK to generate a signed URL that is unique to the requesting user. The backend process can either generate the signed embed URL itself using an embed secret or can generate the URL by calling the [Looker Create Signed Embed URL API](https://cloud.google.com/looker/docs/reference/looker-api/latest/methods/Auth/create_sso_embed_url). Manual URL generation and signing avoids calling the Looker API, resulting in decreased latency. Calling the Looker API requires less code and is easier to maintain.

Not a blocker

README.md

Co-authored-by: John Kaster <[email protected]>

ryandunlavy

LGTM

feat: Embed SDK 2.0 Development (wip)

ca5ea63

bryans99 requested review from ryandunlavy, jkaster, josephaxisa, pjmsmithgoogle, treshugart and prescottbreeden December 24, 2024 16:33

jkaster reviewed Dec 27, 2024

View reviewed changes

demo/demo_config.ts Outdated Show resolved Hide resolved

src/v2/EmbedBuilderEx.ts Outdated Show resolved Hide resolved

bryans99 added 21 commits January 3, 2025 19:41

Merge branch 'master' into bnr/development-2.0

1b040f2

1. Fix karma tests (new tests not added yet)

559f5eb

2. Upgrade karma type script packages. 3. Update documentation. 4. Reduce exposed embed sdk 2.0.0 classes to the minumum. 5. Update version to 2.0.0 6. Fix minor issue with comment in demo. 7. Correct copyright dates.

2.0.0-alpha

ff47ee9

1. Add tests for LookerEmbedExSDK

f272d77

2. Various fixes for issues found while writing tests for LokerEmbedExSDK

1. EmbedBuilderEx tests

84c8481

2. Add more withApiHost and withAuth tests to LookerEmbedExSDK tests 3. Hide internal properties and methods from documentation 4. Regenerate documentation

2.0.0-alpha-2

8d93ea1

1. generateTokens callback now receives current tokens

5e13a02

2. Update docs to reflect generatTokens change

1. turn off jest-dom/prefer-to-have-style eslint rule (karma

f87a7e2

does not support it) 2. fix generateTokens handling of fetch init object 3. clean up generate error handling 4. correct initCookieless generateTokens typing 5. more EmbedClientEx tests

Fix docs

9595d34

1. Move test utils into its own file

822a4ac

1. Add clarification about message to ExploreConnection

6483368

2. ExploreConnection test 3. ExtensionConnection test 4. LookConnection test

1. Add new method to original SDK to return instance of new

e7c4c1e

SDK. 2. Rename original demo to multi frame demo 3. Rename new demo to single frame demo 4. Change title of message example tp Embed Message API Demo

Remove python server

4295c70

Update docs

ece9196

Update multi frame demo to use getSDKFactory to instantiate SDK

8146cdd

Update existing SDK docs to reflect deprecation

61f9ba3

Be more forgiving about api host provided to init functions

18e8d44

Fix documentation

565a55f

1. docs update

f8a2227

2. use auto gen cert for npm start

jkaster reviewed Apr 2, 2025

View reviewed changes

README update

8f64494

jkaster previously approved these changes Apr 3, 2025

View reviewed changes

2.0.0-beta-2

5450dc3

bryans99 dismissed jkaster’s stale review via 5450dc3 April 3, 2025 15:20

jkaster previously approved these changes Apr 3, 2025

View reviewed changes

1. EmbedBuilder withUrl now sanitizes the URL

e8b2114

2. Embed sdk sanitizes the URL before determining the page type 3, createLookWithId accepts a string and a number 4. Increased test coverage 5. Added history fallback to dev and demo servers 6. Added history support to demo. 7. Updated docs

bryans99 dismissed jkaster’s stale review via e8b2114 April 6, 2025 19:29

bryans99 requested a review from jkaster April 6, 2025 19:30

2.0.0-beta-3

dae6688

jkaster previously approved these changes Apr 6, 2025

View reviewed changes

rename css scripts

4a6d6b4

bryans99 dismissed jkaster’s stale review via 4a6d6b4 April 6, 2025 20:18

jkaster previously approved these changes Apr 6, 2025

View reviewed changes

Fix tsc issue

f8338e9

bryans99 dismissed jkaster’s stale review via f8338e9 April 15, 2025 22:18

Minor docs update

de6d686

bryans99 changed the title ~~feat: Embed SDK 2.0 Development (wip)~~ feat: Embed SDK 2.0 Development Apr 28, 2025

bryans99 changed the title ~~feat: Embed SDK 2.0 Development~~ feat: Embed SDK 2.0 Apr 28, 2025

Update README.md

fd57900

Co-authored-by: John Kaster <[email protected]>

jkaster previously approved these changes Apr 29, 2025

View reviewed changes

Update README.md

afb7d18

Co-authored-by: John Kaster <[email protected]>

bryans99 dismissed jkaster’s stale review via afb7d18 April 29, 2025 14:51

bryans99 and others added 3 commits April 29, 2025 07:51

Update README.md

d4bc4e6

Co-authored-by: John Kaster <[email protected]>

Update README.md

783ff86

Co-authored-by: John Kaster <[email protected]>

Update docs

58650a7

ryandunlavy approved these changes Apr 29, 2025

View reviewed changes

bryans99 merged commit 9ef9bf7 into master Apr 29, 2025
6 checks passed

bryans99 deleted the bnr/development-2.0 branch April 29, 2025 15:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Embed SDK 2.0 #210

feat: Embed SDK 2.0 #210

Uh oh!

bryans99 commented Dec 24, 2024

Uh oh!

bryans99 commented Dec 24, 2024

Uh oh!

Uh oh!

Uh oh!

jkaster left a comment

Uh oh!

jkaster left a comment

Uh oh!

jkaster left a comment

Uh oh!

jkaster Apr 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryandunlavy left a comment

Uh oh!

Uh oh!

Uh oh!


		The _frontend_ process using the Embed SDK entails:
		In order to use the Embed SDK on the frontend you must supply a backend service that handles signing of the Embed URL. This service is called by the Embed SDK to generate a signed URL that is unique to the requesting user. The backend process can either generate the signed embed URL itself using an embed secret or can generate the URL by calling the [Looker Create Signed Embed URL API](https://cloud.google.com/looker/docs/reference/looker-api/latest/methods/Auth/create_sso_embed_url). Manual URL generation and signing avoids calling the Looker API resulting in decreased latency. Calling the Looker API requires less code and is easier to maintain.

feat: Embed SDK 2.0 #210

feat: Embed SDK 2.0 #210

Uh oh!

Conversation

bryans99 commented Dec 24, 2024

Uh oh!

bryans99 commented Dec 24, 2024

Uh oh!

Uh oh!

Uh oh!

jkaster left a comment

Choose a reason for hiding this comment

Uh oh!

jkaster left a comment

Choose a reason for hiding this comment

Uh oh!

jkaster left a comment

Choose a reason for hiding this comment

Uh oh!

jkaster Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryandunlavy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!