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
Convert the `onResponseError` to use EventEmitter event on API client and add event types (#74894)
Romeo Van Snick2b88cdbb34b5
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.tsindex 93ed221c9c5..e5e3d46e7b7 100644--- a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts@@ -39,6 +39,22 @@ const reactSdkEmbedReferrerHandler = async (},});+const sdkResponseErrorHandler = ({+ metabaseVersion,+}: {+ metabaseVersion: string | null;+}) => {+ if (metabaseVersion == null) {+ return;+ }+ // Use ensureMetabaseProviderPropsStore to access the current instance of reduxStore+ ensureMetabaseProviderPropsStore()+ .getState()+ .internalProps.reduxStore?.dispatch(+ setMetabaseInstanceVersion(metabaseVersion),+ );+};+const registerVisualizationsOnce = _.once(registerVisualizations);const registerDashboardVisualizationsOnce = _.once(registerDashboardVisualizations,@@ -113,18 +129,11 @@ export const useInitDataInternal = ({api.beforeRequestHandlers.push(reactSdkEmbedReferrerHandler);}- if (!api.onResponseError) {- api.onResponseError = ({ metabaseVersion }) => {- if (metabaseVersion == null) {- return;- }- // Use ensureMetabaseProviderPropsStore to access the current instance of reduxStore- ensureMetabaseProviderPropsStore()- .getState()- .internalProps.reduxStore?.dispatch(- setMetabaseInstanceVersion(metabaseVersion),- );- };+ // Dedupe by handler identity (matches the `beforeRequestHandlers` pattern+ // above) rather than total listener count — other code can register its own+ // `responseError` listeners without disabling ours.+ if (!api.listeners("responseError").includes(sdkResponseErrorHandler)) {+ api.on("responseError", sdkResponseErrorHandler);}useEffect(() => {diff --git a/frontend/src/metabase/api/legacy-client.ts b/frontend/src/metabase/api/legacy-client.tsindex 50ed3b2efb9..ba9a699f1b2 100644--- a/frontend/src/metabase/api/legacy-client.ts+++ b/frontend/src/metabase/api/legacy-client.ts@@ -79,12 +79,6 @@ type MethodCreator = (}) => Response | undefined),) => ApiMethod;-type ResponseErrorInfo = {- body: unknown;- status: number;- metabaseVersion: string | null;-};-/*** Thrown when the transport itself fails before a response is received —* e.g. the server dropped the connection, DNS lookup failed, or the user is@@ -98,11 +92,25 @@ export class NetworkError extends Error {}}-export class LegacyApi extends EventEmitter {+type ResponseErrorInfo = {+ body: unknown;+ status: number;+ metabaseVersion: string | null;+};++type EventMap = {+ // Per-status events. Listeners receive the request URL (with basename+ // stripped so subscribers see the relative path).+ [status: number]: [string];+ // Fired for any non-2xx response. Payload includes the response body so+ // callers can inspect the failure beyond just its status.+ responseError: [ResponseErrorInfo];+};++export class LegacyApi extends EventEmitter<EventMap> {basename = "";apiKey = "";sessionToken: string | undefined;- onResponseError: ((info: ResponseErrorInfo) => void) | undefined;requestClient: RequestClientInfo | undefined;beforeRequestHandlers: OnBeforeRequestHandler[] = [];@@ -383,13 +391,11 @@ export class LegacyApi extends EventEmitter {}resolve(responseBody);} else {- if (this.onResponseError) {- this.onResponseError({- body: responseBody,- status,- metabaseVersion,- });- }+ this.emit("responseError", {+ body: responseBody,+ status,+ metabaseVersion,+ });reject({status: status,@@ -398,7 +404,7 @@ export class LegacyApi extends EventEmitter {});}if (!options.noEvent) {- this.emit(String(status), url);+ this.emit(status, url);}}};@@ -481,7 +487,7 @@ export class LegacyApi extends EventEmitter {}if (!options.noEvent) {- this.emit(String(status), url);+ this.emit(status, url);}if (status >= 200 && status <= 299) {@@ -494,9 +500,7 @@ export class LegacyApi extends EventEmitter {}return body;} else {- if (this.onResponseError) {- this.onResponseError({ body, status, metabaseVersion });- }+ this.emit("responseError", { body, status, metabaseVersion });throw { status: status, data: body };}diff --git a/frontend/src/metabase/app-main.js b/frontend/src/metabase/app-main.jsindex ceec757bcf2..a609a852ff6 100644--- a/frontend/src/metabase/app-main.js+++ b/frontend/src/metabase/app-main.js@@ -32,7 +32,7 @@ if (isWithinIframe() && !IFRAMED_IN_SELF) {init(mainReducers, getRoutes, (store) => {// received a 401 response- api.on("401", (url) => {+ api.on(401, (url) => {if (url.indexOf("/api/user/current") >= 0) {return;}@@ -50,7 +50,7 @@ init(mainReducers, getRoutes, (store) => {});// received a 403 response- api.on("403", (url) => {+ api.on(403, (url) => {if (NOT_AUTHORIZED_TRIGGERS.some((regex) => regex.test(url))) {return store.dispatch(setErrorPage({ status: 403 }));}