feat: public api for embeds #6680

mindspank · 2025-02-14T10:10:54Z

Adds a RPC API for Rill embeds.

methods:

setState
getState

notifications:

stateChange

Checklist:

Covered by tests
Ran it and it works as intended
Reviewed the diff before requesting a review
Checked for unhandled edge cases
Linked the issues it closes
Checked if the docs need to be updated
Intend to cherry-pick into the release branch
I'm proud of this work!

web-admin/src/features/embeds/EmbedPublicAPI.svelte

mindspank · 2025-02-14T10:14:15Z

web-admin/src/routes/-/embed/+layout.svelte


  const instanceId = $page.url.searchParams.get("instance_id");
  const runtimeHost = $page.url.searchParams
    .get("runtime_host")
    .replace("localhost:9091", "localhost:8081");
  const accessToken = $page.url.searchParams.get("access_token");
+
+  onMount(() => {


kept the initializing here if we want to support state for canvas in the future

Makes sense. Though for now I'd propose this code would be easier-to-follow (more co-located) if this went in the initEmbedPublicAPI() function.

… feat/emit-state-embed

mindspank · 2025-02-14T14:14:18Z

Closes #5490

ericpgreen2

Regarding the strict JSON-RPC 2.0 interface, I think it's too heavy to ask that host application developers implement their own JSON-RPC 2.0 over postMessage client (since there's no widely adopted NPM library for this). I looked around a little bit and didn't find any other BI tools that take this approach (correct me if I'm wrong).

Instead, I'd propose we either:

Use a simple custom JSON interface, much like what Looker, Sigma, and Metabase offer.
Build a Javascript SDK that hides the JSON-RPC 2.0 exchange under-the-hood.

I'd suggest we do Option 1 in the short-run and explore Option 2 in the long-run.

web-admin/src/features/embeds/EmbedPublicAPI.svelte

web-common/src/lib/rpc.ts

This reverts commit 2e33082.

This reverts commit 46ee2b3.

This reverts commit ec97c8e.

mindspank · 2025-02-18T13:33:42Z

Regarding the strict JSON-RPC 2.0 interface, I think it's too heavy to ask that host application developers implement their own JSON-RPC 2.0 over postMessage client (since there's no widely adopted NPM library for this). I looked around a little bit and didn't find any other BI tools that take this approach (correct me if I'm wrong).

For ref: removed references to JSON-RPC and made id optional if you do not want a response back.
It diverges slightly from the standard but still maintains the core rpc functionality.

web-admin/tests/setup/setup.ts

web-admin/src/features/embeds/EmbedPublicAPI.svelte

web-common/src/lib/rpc.ts

web-admin/tests/embeds.spec.ts

web-admin/tests/utils/generateEmbed.ts

web-admin/src/features/embeds/init-embed-publicapi.ts

web-admin/tests/utils/generate-embed.ts

web-common/src/lib/rpc.ts

ericpgreen2 · 2025-02-20T09:31:18Z

web-admin/src/routes/-/embed/+layout.svelte


  const instanceId = $page.url.searchParams.get("instance_id");
  const runtimeHost = $page.url.searchParams
    .get("runtime_host")
    .replace("localhost:9091", "localhost:8081");
  const accessToken = $page.url.searchParams.get("access_token");
+
+  onMount(() => {


Makes sense. Though for now I'd propose this code would be easier-to-follow (more co-located) if this went in the initEmbedPublicAPI() function.

web-common/src/features/dashboards/workspace/Dashboard.svelte

web-admin/tests/embeds.spec.ts

ericpgreen2

Great feature. Big thanks – especially for the tests!

ericpgreen2 · 2025-02-21T12:38:55Z

web-admin/tests/setup/base.ts

+      await generateEmbed(
+        RILL_ORG_NAME,
+        RILL_PROJECT_NAME,
+        "bids_explore",
+        rillServiceToken,
+      );
+      const filePath = "file://" + path.resolve(__dirname, "..", "embed.html");


Suggestion, so we don't have embed.html hardcoded in two places:

const embedPath = await generateEmbed( RILL_ORG_NAME, RILL_PROJECT_NAME, "bids_explore", rillServiceToken ); const filePath = "file://" + path.resolve(embedPath);

I'll keep the two versions for now since resolve is relative to the callers directory. Could make sense to move into a constant though since the file location would always have to be in the root of tests

web-admin/tests/setup/constants.ts

web-admin/tests/setup/git/repos/rill-examples

* feat: first rpc stub * add emit * feat: embed public api * fix: better name for state stream * fix: error handling and better spec conformatiy * fix: cleanup * fix: format * fix: make id optional * fix: first stub of tests * Revert "fix: first stub of tests" This reverts commit 2e33082. * fix: clear method names * fix: check input * fix: gitignore * fix: ignore * Revert "fix: ignore" This reverts commit 46ee2b3. * Revert "fix: gitignore" This reverts commit ec97c8e. * fix: add tests * Merge remote-tracking branch 'origin/main' into feat/emit-state-embed * fix: comments * fix: moving org and project to const * fix: moving embed to test hook * fix: format * fix: read token * fix: more fixes * fix: comments * fix: format * .gitignore * delete test file * fix: pr comments * fix: cleaner init * fix: format * fix: lint * fix: more lint (in my pocket) * fix: wait for bids * fix: format * fix: nits * fix: format

mindspank added 5 commits February 11, 2025 16:27

feat: first rpc stub

6f10f15

add emit

81d6583

feat: embed public api

63f5d76

fix: better name for state stream

ced764d

fix: error handling and better spec conformatiy

ba61995

mindspank requested review from AdityaHegde and ericpgreen2 February 14, 2025 10:10

mindspank commented Feb 14, 2025

View reviewed changes

web-admin/src/features/embeds/EmbedPublicAPI.svelte Outdated Show resolved Hide resolved

mindspank commented Feb 14, 2025

View reviewed changes

mindspank added 4 commits February 14, 2025 11:15

fix: cleanup

610aabb

Merge branch 'main' into feat/emit-state-embed

e5f248e

fix: format

4065767

Merge branch 'feat/emit-state-embed' of github.com:rilldata/rill into…

516af60

… feat/emit-state-embed

ericpgreen2 reviewed Feb 16, 2025

View reviewed changes

mindspank added 3 commits February 16, 2025 15:02

fix: make id optional

00a065b

Merge remote-tracking branch 'origin/main' into feat/emit-state-embed

92a2478

fix: first stub of tests

2e33082

AdityaHegde reviewed Feb 17, 2025

View reviewed changes

web-admin/src/features/embeds/EmbedPublicAPI.svelte Outdated Show resolved Hide resolved

web-common/src/lib/rpc.ts Outdated Show resolved Hide resolved

mindspank added 8 commits February 17, 2025 10:27

Revert "fix: first stub of tests"

fbbe87a

This reverts commit 2e33082.

fix: clear method names

b002ef5

fix: check input

880fd04

fix: gitignore

ec97c8e

fix: ignore

46ee2b3

Revert "fix: ignore"

92aa0b2

This reverts commit 46ee2b3.

Revert "fix: gitignore"

6fc5e76

This reverts commit ec97c8e.

fix: add tests

008d5b8

mindspank force-pushed the feat/emit-state-embed branch from 355cd82 to 008d5b8 Compare February 17, 2025 21:59

mindspank added 2 commits February 17, 2025 23:01

Merge remote-tracking branch 'origin/main' into feat/emit-state-embed

abc6272

Merge remote-tracking branch 'origin/main' into feat/emit-state-embed

1010941

ericpgreen2 requested changes Feb 18, 2025

View reviewed changes

mindspank and others added 11 commits February 18, 2025 16:04

fix: comments

2e0c395

fix: moving org and project to const

1f40902

fix: moving embed to test hook

cbb0655

fix: format

087287e

Merge branch 'main' into feat/emit-state-embed

662b5e7

fix: read token

523f8aa

fix: more fixes

e39c60d

fix: comments

23cb12e

fix: format

639b877

.gitignore

49ad482

delete test file

f84603d

ericpgreen2 reviewed Feb 20, 2025

View reviewed changes

mindspank added 8 commits February 20, 2025 13:41

fix: pr comments

382ffca

fix: cleaner init

b883803

Merge remote-tracking branch 'origin/main' into feat/emit-state-embed

1af607c

fix: format

a85c482

fix: lint

62e6657

fix: more lint (in my pocket)

bb0957c

fix: wait for bids

e158eca

fix: format

f71a539

ericpgreen2 approved these changes Feb 21, 2025

View reviewed changes

mindspank added 2 commits February 21, 2025 14:10

fix: nits

5c170ef

fix: format

01d6777

mindspank merged commit e6942b9 into main Feb 21, 2025
9 checks passed

mindspank deleted the feat/emit-state-embed branch February 21, 2025 14:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: public api for embeds #6680

feat: public api for embeds #6680

mindspank commented Feb 14, 2025 •

edited

Loading

mindspank Feb 14, 2025

ericpgreen2 Feb 20, 2025

mindspank commented Feb 14, 2025

ericpgreen2 left a comment •

edited

Loading

mindspank commented Feb 18, 2025

ericpgreen2 Feb 20, 2025

ericpgreen2 left a comment

ericpgreen2 Feb 21, 2025

mindspank Feb 21, 2025

feat: public api for embeds #6680

feat: public api for embeds #6680

Conversation

mindspank commented Feb 14, 2025 • edited Loading

mindspank Feb 14, 2025

Choose a reason for hiding this comment

ericpgreen2 Feb 20, 2025

Choose a reason for hiding this comment

mindspank commented Feb 14, 2025

ericpgreen2 left a comment • edited Loading

Choose a reason for hiding this comment

mindspank commented Feb 18, 2025

ericpgreen2 Feb 20, 2025

Choose a reason for hiding this comment

ericpgreen2 left a comment

Choose a reason for hiding this comment

ericpgreen2 Feb 21, 2025

Choose a reason for hiding this comment

mindspank Feb 21, 2025

Choose a reason for hiding this comment

mindspank commented Feb 14, 2025 •

edited

Loading

ericpgreen2 left a comment •

edited

Loading