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
fix: wait for all databases to be loaded and fix sources of flakinesses (#75173)
Uladzimir Havenchyk08fd1557395d
diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.tsindex 2c08f06c6ef..07766bebad5 100644--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts@@ -1,7 +1,7 @@import type { LocationDescriptorObject } from "history";import { replace } from "react-router-redux";-import { cardApi, snippetApi } from "metabase/api";+import { cardApi, databaseApi, snippetApi } from "metabase/api";import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";import {cardIsEquivalent,@@ -286,6 +286,20 @@ async function handleQBInit(dispatch(resetQB());dispatch(cancelQuery());+ // Preload the full database list up front so the data selector already has it+ // when it mounts+ const databasesPromise = runRtkEndpoint(+ { "can-query": true },+ dispatch,+ databaseApi.endpoints.listDatabases,+ { forceRefetch: false },+ ).catch((error) => {+ console.error(+ "Failed to load database list during QB initialization",+ error,+ );+ });+const queryParams = location.query;const isTableRoute = location.pathname?.startsWith("/table");const slugEntityId = Urls.extractEntityId(params.slug);@@ -447,6 +461,13 @@ async function handleQBInit(uiControls.notebookNativePreviewSidebarWidth =getNotebookNativePreviewSidebarWidth(getState());+ // make sure db list is loaded+ await databasesPromise;++ if (isStale()) {+ return;+ }+dispatch({type: INITIALIZE_QB,payload: {diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.tsindex 425cfd7ccaa..4542cca380e 100644--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts@@ -2,7 +2,8 @@ import fetchMock from "fetch-mock";import type { LocationDescriptorObject } from "history";import { createMockEntitiesState } from "__support__/store";-import { snippetApi } from "metabase/api";+import { databaseApi, snippetApi } from "metabase/api";+import * as rtkEndpointUtils from "metabase/api/utils/run-rtk-endpoint";import * as CardLib from "metabase/common/utils/card";import * as questionActions from "metabase/questions/actions";import { setErrorPage } from "metabase/redux/app";@@ -10,6 +11,7 @@ import * as sharedQB from "metabase/redux/query-builder";import { createMockState } from "metabase/redux/store/mocks";import { getMetadata } from "metabase/selectors/metadata";import * as Urls from "metabase/urls";+import { defer } from "metabase/utils/promise";import { checkNotNull } from "metabase/utils/types";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";@@ -90,7 +92,7 @@ async function baseSetup({jest.runAllTimers();const actions = dispatch.mock.calls.find(- (call) => call[0]?.type === "metabase/qb/INITIALIZE_QB",+ (call) => call[0]?.type === sharedQB.INITIALIZE_QB,);const hasDispatchedInitAction = Array.isArray(actions);const result = hasDispatchedInitAction ? actions[0].payload : null;@@ -673,30 +675,30 @@ describe("QB Actions > initializeQB", () => {});});- describe("staleness / overlapping initializeQB calls", () => {- function startInit(- card: Card,- dispatch: jest.Mock,- getState: () => ReturnType<typeof createMockState>,- ) {- return initializeQB(- getLocationForCard(card),- getQueryParamsForCard(card),- )(dispatch, getState);- }+ function startInitializeDB(+ card: Card,+ dispatch: jest.Mock,+ getState: () => ReturnType<typeof createMockState>,+ ) {+ return initializeQB(getLocationForCard(card), getQueryParamsForCard(card))(+ dispatch,+ getState,+ );+ }- function makeState() {- const state = createMockState({- entities: createMockEntitiesState({- databases: [createSampleDatabase()],- }),- currentUser: createMockUser({- permissions: createMockUserPermissions({ can_create_queries: true }),- }),- });- return { state, getState: () => state };- }+ function makeState() {+ const state = createMockState({+ entities: createMockEntitiesState({+ databases: [createSampleDatabase()],+ }),+ currentUser: createMockUser({+ permissions: createMockUserPermissions({ can_create_queries: true }),+ }),+ });+ return { state, getState: () => state };+ }+ describe("staleness / overlapping initializeQB calls", () => {it("aborts a stale initializeQB once a newer one is in flight", async () => {const firstCard = createSavedStructuredCard({ id: 1, name: "first" });const secondCard = createSavedStructuredCard({ id: 2, name: "second" });@@ -718,11 +720,15 @@ describe("QB Actions > initializeQB", () => {fetchMock.get(`path:/api/card/${secondCard.id}`, secondCard);// First init: hangs on loadCard- const firstInit = startInit(firstCard as Card, dispatch, getState);+ const firstInit = startInitializeDB(+ firstCard as Card,+ dispatch,+ getState,+ );await Promise.resolve();// Second init runs to completion, superseding the first- await startInit(secondCard as Card, dispatch, getState);+ await startInitializeDB(secondCard as Card, dispatch, getState);jest.runAllTimers();// Unblock the first init; it should bail out once it sees the version@@ -732,7 +738,7 @@ describe("QB Actions > initializeQB", () => {jest.runAllTimers();const initActions = dispatch.mock.calls.filter(- (call) => call[0]?.type === "metabase/qb/INITIALIZE_QB",+ (call) => call[0]?.type === sharedQB.INITIALIZE_QB,);expect(initActions).toHaveLength(1);expect(initActions[0][0].payload.card.id).toBe(secondCard.id);@@ -769,10 +775,14 @@ describe("QB Actions > initializeQB", () => {fetchMock.get(`path:/api/card/${firstCard.id}`, firstCard);fetchMock.get(`path:/api/card/${secondCard.id}`, secondCard);- const firstInit = startInit(firstCard as Card, dispatch, getState);+ const firstInit = startInitializeDB(+ firstCard as Card,+ dispatch,+ getState,+ );await Promise.resolve();- await startInit(secondCard as Card, dispatch, getState);+ await startInitializeDB(secondCard as Card, dispatch, getState);jest.runAllTimers();resolveFirstLoad(firstCard as Card);@@ -786,6 +796,40 @@ describe("QB Actions > initializeQB", () => {});});+ describe("database list preload", () => {+ it("loads the database list before dispatching INITIALIZE_QB so the data selector mounts with a complete list (metabase#75173)", async () => {+ const card = createSavedStructuredCard({ id: 1, name: "first" });+ const { getState } = makeState();+ const dispatch = jest.fn((action) => action);++ jest.spyOn(cardActions, "loadCard").mockResolvedValue(card);++ const databasesRequest = defer();+ const runRtkEndpointSpy = jest+ .spyOn(rtkEndpointUtils, "runRtkEndpoint")+ .mockReturnValue(databasesRequest.promise);++ const initializeDBPromise = startInitializeDB(card, dispatch, getState);++ expect(runRtkEndpointSpy).toHaveBeenCalledWith(+ { "can-query": true },+ dispatch,+ databaseApi.endpoints.listDatabases,+ { forceRefetch: false },+ );+ expect(dispatch).not.toHaveBeenCalledWith(+ expect.objectContaining({ type: sharedQB.INITIALIZE_QB }),+ );++ databasesRequest.resolve();+ await initializeDBPromise;++ expect(dispatch).toHaveBeenCalledWith(+ expect.objectContaining({ type: sharedQB.INITIALIZE_QB }),+ );+ });+ });+describe("blank question", () => {type BlankSetupOpts = Omit<BaseSetupOpts, "location" | "params"> & {db?: DatabaseId;diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsxindex eec990d2b11..b8d48e8b695 100644--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx@@ -1147,9 +1147,9 @@ function withAvailableModels(WrappedComponent) {};}-function withAllDatabases(WrappedComponent) {- return function DataSelectorWithAllDatabases(props) {- useListDatabasesQuery();+function withDatabaseList(WrappedComponent) {+ return function DataSelectorWithDatabaseList(props) {+ useListDatabasesQuery({ "can-query": true });return <WrappedComponent {...props} />;};}@@ -1158,7 +1158,7 @@ const isListDatabasesQuerySuccess = (state, query) =>databaseApi.endpoints.listDatabases.select(query)(state).isSuccess;const DataSelector = _.compose(- withAllDatabases,+ withDatabaseList,withAvailableModels,withSchemaFetchers,connect(