feat: Embed SDK 2.0 Development (wip) #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. Add embed query and merge query create and load methods

2. Regenerate documentation

2. Add proxy path config to allow embed server to proxy through Looker development environment ngnix server.

2. Remove dependency of beercss CDN

src/EmbedClientEx.ts

2. Correct LookSaveEventDetail documentation 3. Generate documentation 4. EmbedClientEx tracks looks being edited 5. Change of page resets editing status

2. fix skipped tests

2. Add more tests 3. Use Promise reject instead of throwing an error when page load not supported 4. use toThrow instead of deprecated toThrowError

2. Update documentation

2. Added signal to option object to allow caller to abort the request (to be implemented in a follow up change) 3. Updated documentation

2. Fixed 404 on beercss woff2 files 3. Remove beer css from repo. Now copied from node modules and gitignored

2. Add demo of use of abortable 3. Add env config to allow dev server to be connected from any hostname (allows testing of reports using an allow listed hostname defined in etc/hosts)

jkaster

There's a fair number of new files with a copyright date of 2024 instead of 2025 and some others with 2025. This pass is just for resolving typos/links then I can review again when that's resolved

jkaster · 2025-03-07T22:58:47Z

README.md

@@ -1,54 +1,60 @@
 # Looker JavaScript Embed SDK

+## Embed SDK version 2.0.0
+
+The following document has been updated to reflect the implementation of Embed SDK 2.0.0. Technically the 2.0.0 API is backwards compatible with Embed SDK 1.8.x but the underlying implementation has changed for some functionality. SDK 1.8.x exported a number of classes. SDK 2.0.0 replaces these classes with deprecated interfaces. It is preferred that application that uses the SDK use the 'I' prefixed interfaces (which are identical to the non prefixed interaces). Applications upgrading to SDK 2.0.0 should behave the same. In order to take advantage of the API improvements some refactoring will be required.


Suggested change

The following document has been updated to reflect the implementation of Embed SDK 2.0.0. Technically the 2.0.0 API is backwards compatible with Embed SDK 1.8.x but the underlying implementation has changed for some functionality. SDK 1.8.x exported a number of classes. SDK 2.0.0 replaces these classes with deprecated interfaces. It is preferred that application that uses the SDK use the 'I' prefixed interfaces (which are identical to the non prefixed interaces). Applications upgrading to SDK 2.0.0 should behave the same. In order to take advantage of the API improvements some refactoring will be required.

The following document has been updated to reflect the implementation of Embed SDK 2.0.0. Technically the 2.0.0 API is backwards compatible with Embed SDK 1.8.x but the underlying implementation has changed for some functionality. SDK 1.8.x exported a number of classes. SDK 2.0.0 replaces these classes with deprecated interfaces. It is preferred that application that uses the SDK use the 'I' prefixed interfaces (which are identical to the non prefixed interfaces). Applications upgrading to SDK 2.0.0 should behave the same. In order to take advantage of the API improvements some refactoring will be required.

jkaster · 2025-03-07T23:01:35Z

README.md

 ```

-A more complete example can be found [here](demo/demo.ts). Detailed instructions on how to use it are [here](#demo).
+A more complete example can be found [here](demo/demo_single_frame.ts) and [here](demo/demo_multi_frame.ts). Detailed instructions on how to use the SDK can be found [here](#demo).


these links are not resolving on the npm site

jkaster · 2025-03-07T23:02:45Z

README.md

 ```

-In this example, `/auth` is a backend service that you must implement as described in the [Auth](#the-auth-endpoint) section.
+In this example, `/auth` is a backend service that must be implemented as described in the [Auth](#the-auth-endpoint) section.


this link isn't resolving

jkaster · 2025-03-07T23:04:09Z

README.md


-### Advanced Auth Configuration
+If another IFRAME is required, the SDK will not call the auth endpoint again as the embed session already exists. Instead the IFRAME will be created with the requested embed URL without signing a `login/embed` URL. If multiple IFRAMEs are created on page load (not recommended but it does work), the SDK will wait for the first IFRAME to be created before creating the more IFRAMEs. This is done to reduce contention that can occur when complex embed users are created.


Suggested change

If another IFRAME is required, the SDK will not call the auth endpoint again as the embed session already exists. Instead the IFRAME will be created with the requested embed URL without signing a `login/embed` URL. If multiple IFRAMEs are created on page load (not recommended but it does work), the SDK will wait for the first IFRAME to be created before creating the more IFRAMEs. This is done to reduce contention that can occur when complex embed users are created.

If another IFRAME is required, the SDK will not call the auth endpoint again as the embed session already exists. Instead the IFRAME will be created with the requested embed URL without signing a `login/embed` URL. If multiple IFRAMEs are created on page load (not recommended but it does work), the SDK will wait for the first IFRAME to be created before creating more IFRAMEs. This is done to reduce contention that can occur when complex embed users are created.

jkaster · 2025-03-07T23:04:30Z

README.md


-This section does not apply to cookieless embed as an alternate mechanism for authentication is used. See the [cookieless embed](#cookieless) section for details.
+Different looker object types or object type instances can be loaded without recreating the IFRAME.


Suggested change

Different looker object types or object type instances can be loaded without recreating the IFRAME.

Different Looker object types or object type instances can be loaded without recreating the IFRAME.

jkaster · 2025-03-07T23:17:11Z

demo/demo_single_frame.ts

+
+ MIT License
+
+ Copyright (c) 2024 Looker Data Sciences, Inc.


jkaster · 2025-03-07T23:22:45Z

package.json

    "build": "npm run clean && npm run build_utils && tsc && webpack",
    "build_utils": "tsc --build tsconfig-server.json",
    "clean": "rm -rf lib dist",
    "docs": "typedoc --gitRevision master --githubPages false --out docs src/index.ts",
    "lint": "eslint --format stylish '**/*.ts'",
    "lint-fix": "eslint --format stylish --fix '**/*.ts'",
-    "start": "npm run build_utils && webpack serve --config webpack-devserver.config.js --hot --color --progress",
+    "start": "npm run beer-dev && npm run build_utils && webpack serve --config webpack-devserver.config.js --hot --color --progress",


no such thing as free beer?

jkaster · 2025-03-07T23:24:32Z

src/EmbedBuilderEx.ts

+
+ MIT License
+
+ Copyright (c) 2024 Looker Data Sciences, Inc.


jkaster · 2025-03-07T23:24:47Z

src/DashboardConnection.ts

+
+ MIT License
+
+ Copyright (c) 2024 Looker Data Sciences, Inc.


jkaster · 2025-03-07T23:27:12Z

src/QueryVisualizationConnection.ts

@@ -2,7 +2,7 @@

 MIT License

- Copyright (c) 2022 Looker Data Sciences, Inc.
+ Copyright (c) 2024 Looker Data Sciences, Inc.


this is a confused rename on this file name, but ok

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

bryans99 added 13 commits January 16, 2025 00:01

Really regenerate the docs this time

b478e4c

Update README and regenerated docs

16ad381

2.0.0-alpha-9

8467ebe

1. Fix private demo

9a95b9a

2. Add embed query and merge query create and load methods

Update docs

db70877

Fix reporting path (courtesy of Ryan)

11a9e4e

Fix docs

4705fa7

Allow dev server and demo server to run on https

614e759

1. Add clearSession method to SDK

5fc5dfc

2. Regenerate documentation

Fix code scanning non issue

73975a1

1. Replace tailwind with beercss (license issue, beercss is MIT)

ce3f278

2. Add proxy path config to allow embed server to proxy through Looker development environment ngnix server.

1. Remove vestige of tailwind

3f21f09

2. Remove dependency of beercss CDN

Fix error condition tests for cookieless embed

9141974

alexjesp reviewed Feb 7, 2025

View reviewed changes

src/EmbedClientEx.ts Show resolved Hide resolved

bryans99 added 13 commits February 26, 2025 00:58

1. Add look:edit:start and look:edit:cancel events

56a5905

2. Correct LookSaveEventDetail documentation 3. Generate documentation 4. EmbedClientEx tracks looks being edited 5. Change of page resets editing status

jest migration

62cad51

oops

ea2ed48

jest updated

13fbd2a

1. update ts-loader package

2e9eb7e

2. fix skipped tests

1, Add default jest reporter

4af0498

2. Add more tests 3. Use Promise reject instead of throwing an error when page load not supported 4. use toThrow instead of deprecated toThrowError

1. Detect session expired and expose to embedding application

ac858cd

2. Update documentation

1. Moved waitUntilLoaded to an option object

922f012

2. Added signal to option object to allow caller to abort the request (to be implemented in a follow up change) 3. Updated documentation

1. Implemented connect/load abort

791037f

2. Fixed 404 on beercss woff2 files 3. Remove beer css from repo. Now copied from node modules and gitignored

Really delete the bearcss artifcacts

77b2ebd

1. Add abortableCreateSignedUrl

add950b

2. Add demo of use of abortable 3. Add env config to allow dev server to be connected from any hostname (allows testing of reports using an allow listed hostname defined in etc/hosts)

2.0.0-beta-1

2d3dfda

fix publish test script

033fbac

bryans99 marked this pull request as ready for review March 7, 2025 22:57

bryans99 requested a review from a team as a code owner March 7, 2025 22:57

jkaster requested changes Mar 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Embed SDK 2.0 Development (wip) #210

feat: Embed SDK 2.0 Development (wip) #210

bryans99 commented Dec 24, 2024

bryans99 commented Dec 24, 2024

jkaster left a comment

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025

jkaster Mar 7, 2025


		### Advanced Auth Configuration
		If another IFRAME is required, the SDK will not call the auth endpoint again as the embed session already exists. Instead the IFRAME will be created with the requested embed URL without signing a `login/embed` URL. If multiple IFRAMEs are created on page load (not recommended but it does work), the SDK will wait for the first IFRAME to be created before creating the more IFRAMEs. This is done to reduce contention that can occur when complex embed users are created.


		This section does not apply to cookieless embed as an alternate mechanism for authentication is used. See the [cookieless embed](#cookieless) section for details.
		Different looker object types or object type instances can be loaded without recreating the IFRAME.

feat: Embed SDK 2.0 Development (wip) #210

Are you sure you want to change the base?

feat: Embed SDK 2.0 Development (wip) #210

Conversation

bryans99 commented Dec 24, 2024

bryans99 commented Dec 24, 2024

jkaster 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

Choose a reason for hiding this comment