The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Make the metabot state channel payload opaque (#79800)
Romeo Van Snick21600b34b277
diff --git a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.ts b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.tsindex 46bfd8066bd..6fcb928b0bd 100644--- a/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.ts+++ b/enterprise/frontend/src/embedding-sdk-package/hooks/public/use-metabot.ts@@ -27,6 +27,6 @@ const getServerSnapshot = (): UseMetabotResult | null => null;export const useMetabot = (): UseMetabotResult | null =>useSyncExternalStore(subscribeMetabotState,- getMetabotStateSnapshot,+ getMetabotStateSnapshot<UseMetabotResult>,getServerSnapshot,);diff --git a/frontend/src/embedding-sdk-shared/lib/metabot-state-channel.ts b/frontend/src/embedding-sdk-shared/lib/metabot-state-channel.tsindex 66d8fa657f9..2737c207ddc 100644--- a/frontend/src/embedding-sdk-shared/lib/metabot-state-channel.ts+++ b/frontend/src/embedding-sdk-shared/lib/metabot-state-channel.ts@@ -1,9 +1,11 @@-import type { UseMetabotResult } from "embedding-sdk-bundle/types/metabot";-import { getWindow } from "./get-window";-type MetabotStateChannel = {- value: UseMetabotResult | null;+// The payload is generic here so this module never imports the bundle's types.+// The bundle publishes its `UseMetabotResult` and the package reads it back+// with the same type parameter; both sides compile against the same bundle+// version (see the collision note below).+type MetabotStateChannel<TState = unknown> = {+ value: TState | null;listeners: Set<() => void>;};@@ -12,12 +14,12 @@ type MetabotStateChannel = {// clobbers the state. Not a supported scenario.const METABOT_STATE_KEY = "METABASE_EMBEDDING_SDK_METABOT_STATE";-const EMPTY_CHANNEL: MetabotStateChannel = {+const EMPTY_CHANNEL: MetabotStateChannel<never> = {value: null,listeners: new Set(),};-function getChannel(): MetabotStateChannel {+function getChannel<TState>(): MetabotStateChannel<TState> {const windowObject = getWindow();if (!windowObject) {return EMPTY_CHANNEL;@@ -25,11 +27,13 @@ function getChannel(): MetabotStateChannel {if (!windowObject[METABOT_STATE_KEY]) {windowObject[METABOT_STATE_KEY] = { value: null, listeners: new Set() };}- return windowObject[METABOT_STATE_KEY];+ // The window holds one untyped singleton; the caller picks the state type,+ // and publisher and reader compile against the same bundle version.+ return windowObject[METABOT_STATE_KEY] as MetabotStateChannel<TState>;}-export function publishMetabotState(value: UseMetabotResult | null): void {- const channel = getChannel();+export function publishMetabotState<TState>(value: TState | null): void {+ const channel = getChannel<TState>();channel.value = value;channel.listeners.forEach((listener) => listener());}@@ -42,8 +46,8 @@ export function subscribeMetabotState(listener: () => void): () => void {};}-export function getMetabotStateSnapshot(): UseMetabotResult | null {- return getChannel().value;+export function getMetabotStateSnapshot<TState>(): TState | null {+ return getChannel<TState>().value;}export type { MetabotStateChannel };