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
Start the current-user request alongside the settings request (#82721)
Romeo Van Snick0c2a3008cb84
diff --git a/e2e/test/scenarios/metrics/browse.cy.spec.ts b/e2e/test/scenarios/metrics/browse.cy.spec.tsindex 07695e1eddf..de37985dbbc 100644--- a/e2e/test/scenarios/metrics/browse.cy.spec.ts+++ b/e2e/test/scenarios/metrics/browse.cy.spec.ts@@ -465,7 +465,7 @@ describe("scenarios > browse > metrics", () => {cy.intercept("GET", "/api/session/properties", (req) => {req.continue((res) => {- res.body["browse-filter-only-verified-metrics"] = true;+ res.body["browse-filter-only-verified-metrics"] = false;res.send();});});diff --git a/frontend/src/metabase/LoadCurrentUser.tsx b/frontend/src/metabase/LoadCurrentUser.tsxindex 76dbeff62ef..64e5abed315 100644--- a/frontend/src/metabase/LoadCurrentUser.tsx+++ b/frontend/src/metabase/LoadCurrentUser.tsx@@ -4,11 +4,16 @@ import { useEffect, useState } from "react";import { loadCurrentUser } from "metabase/current-user";import { useDispatch } from "metabase/redux";import { Outlet } from "metabase/router";+import { joinSiteSettingsRequest } from "metabase/settings";/*** Loads the current user before rendering the authenticated app, gating its* children until the request settles. The route guards below it read* `currentUser`, so they must not run before it has been fetched.+ *+ * With a user, it also waits for the settings request in flight. The page only+ * carries the public settings, so the app would otherwise render before the+ * rest has arrived.*/export function LoadCurrentUser({children = <Outlet />,@@ -20,7 +25,13 @@ export function LoadCurrentUser({useEffect(() => {let cancelled = false;- dispatch(loadCurrentUser()).finally(() => {+ const load = async () => {+ const { isSuccess: hasUser } = await dispatch(loadCurrentUser());+ if (hasUser) {+ await dispatch(joinSiteSettingsRequest());+ }+ };+ load().finally(() => {if (!cancelled) {setIsLoaded(true);}diff --git a/frontend/src/metabase/LoadCurrentUser.unit.spec.tsx b/frontend/src/metabase/LoadCurrentUser.unit.spec.tsxindex 398a9ff630c..78b11534c24 100644--- a/frontend/src/metabase/LoadCurrentUser.unit.spec.tsx+++ b/frontend/src/metabase/LoadCurrentUser.unit.spec.tsx@@ -1,26 +1,44 @@import fetchMock from "fetch-mock";import { setupCurrentUserEndpoint } from "__support__/server-mocks";-import { createMockState } from "__support__/state";+import { createMockSettingsState, createMockState } from "__support__/state";import { renderWithProviders, screen } from "__support__/ui";import { Route } from "metabase/router";-import { createMockUser } from "metabase-types/api/mocks";+import { refetchSiteSettings, useSetting } from "metabase/settings";+import { createMockSettings, createMockUser } from "metabase-types/api/mocks";import { LoadCurrentUser } from "./LoadCurrentUser";+const PAGE_SITE_NAME = "Site name on the page";+const LOADED_SITE_NAME = "Loaded site name";++const AppContent = ({ onRender }: { onRender: (siteName: string) => void }) => {+ const siteName = useSetting("site-name");+ onRender(siteName);+ return <div>app content</div>;+};+describe("LoadCurrentUser", () => {- const setup = () =>- renderWithProviders(+ const setup = () => {+ const onRender = jest.fn();++ const { store } = renderWithProviders(<Route element={<LoadCurrentUser />}>- <Route path="/" element={<div>app content</div>} />+ <Route path="/" element={<AppContent onRender={onRender} />} /></Route>,{- storeInitialState: createMockState({ currentUser: undefined }),+ storeInitialState: createMockState({+ currentUser: undefined,+ settings: createMockSettingsState({ "site-name": PAGE_SITE_NAME }),+ }),withRouter: true,initialRoute: "/",},);+ return { onRender, store };+ };+it("gates its children until the current user has loaded", async () => {setupCurrentUserEndpoint(createMockUser());setup();@@ -32,4 +50,32 @@ describe("LoadCurrentUser", () => {1,);});++ it("gates its children until the settings request in flight has settled", async () => {+ setupCurrentUserEndpoint(createMockUser());+ fetchMock.get(+ "path:/api/session/properties",+ createMockSettings({ "site-name": LOADED_SITE_NAME }),+ { delay: 50 },+ );+ const { onRender, store } = setup();+ store.dispatch(refetchSiteSettings());++ expect(await screen.findByText("app content")).toBeInTheDocument();+ expect(onRender).toHaveBeenNthCalledWith(1, LOADED_SITE_NAME);+ });++ it("does not wait for the settings when there is no user", async () => {+ fetchMock.get("path:/api/user/current", 401);+ fetchMock.get(+ "path:/api/session/properties",+ createMockSettings({ "site-name": LOADED_SITE_NAME }),+ { delay: 50 },+ );+ const { onRender, store } = setup();+ store.dispatch(refetchSiteSettings());++ expect(await screen.findByText("app content")).toBeInTheDocument();+ expect(onRender).toHaveBeenNthCalledWith(1, PAGE_SITE_NAME);+ });});diff --git a/frontend/src/metabase/app-main.ts b/frontend/src/metabase/app-main.tsindex 9c36b3fa4e6..130f9c7fa8c 100644--- a/frontend/src/metabase/app-main.ts+++ b/frontend/src/metabase/app-main.ts@@ -5,12 +5,13 @@ import "metabase-dev";import { Api } from "metabase/api";import { PLUGIN_API, api } from "metabase/api/client";import { init } from "metabase/app";-import { getUser } from "metabase/current-user";+import { getUser, loadCurrentUser } from "metabase/current-user";import { setRequestClientHeaders } from "metabase/embedding/lib/auth/set-request-client-headers";import { mainReducers } from "metabase/reducers-main";import { setErrorPage } from "metabase/redux/app";import { navigate } from "metabase/router";import { getRoutes } from "metabase/routes";+import { getSetting } from "metabase/settings";import { IFRAMED_IN_SELF, isWithinIframe } from "metabase/utils/iframe";// Let embedded children detect that their parent is a Metabase instance.@@ -35,6 +36,16 @@ if (isWithinIframe() && !IFRAMED_IN_SELF) {}init(mainReducers, getRoutes, (store) => {+ // `LoadCurrentUser` sends this request from an effect, after the route has+ // mounted. Sending it here puts it next to the settings request. The effect+ // joins it, reuses its result, or repeats it if it failed.+ //+ // `/setup` is outside that gate and does a forced refetch, which RTK drops+ // while a request is pending. An instance with no user has no session to load.+ if (getSetting(store.getState(), "has-user-setup")) {+ store.dispatch(loadCurrentUser());+ }+// received a 401 responseapi.on(401, (url) => {if (url.indexOf("/api/user/current") >= 0) {diff --git a/frontend/src/metabase/settings/api.ts b/frontend/src/metabase/settings/api.tsindex 45ba5b8690b..a80264e8ffe 100644--- a/frontend/src/metabase/settings/api.ts+++ b/frontend/src/metabase/settings/api.ts@@ -190,6 +190,13 @@ export const {export const useGetSettingsQuery = useGetSessionPropertiesQuery;export const useLazyGetSettingsQuery = useLazyGetSessionPropertiesQuery;+/**+ * The session properties (settings) request in flight, if there is one.+ * Await `dispatch(joinSiteSettingsRequest())` to wait for it without sending one.+ */+export const joinSiteSettingsRequest = () =>+ settingsApi.util.getRunningQueryThunk("getSessionProperties", undefined);+/*** Force a refetch of the session properties (settings) from non-React code.* Dispatch it via `dispatch(refetchSiteSettings())`.diff --git a/frontend/src/metabase/settings/index.ts b/frontend/src/metabase/settings/index.tsindex 1bfa94373f1..fde5882de17 100644--- a/frontend/src/metabase/settings/index.ts+++ b/frontend/src/metabase/settings/index.ts@@ -2,6 +2,7 @@// Names absent here are module-private on purpose — add them only when a real consumer needs them.export {+ joinSiteSettingsRequest,refetchSiteSettings,sessionPropertiesPath,settingsApi,