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
Wait for loading databases (#75216)
Romeo Van Snick38783c07975b
diff --git a/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx b/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsxindex 28f9cfc8ea6..c2573df6953 100644--- a/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx+++ b/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx@@ -917,10 +917,19 @@ function withAvailableModels(WrappedComponent) {};}+// Prefetches the saved-databases list and forwards its loading state as+// `allLoading` so the picker waits for the databases (not just the models+// search) before hydrating its initial step. Without this the picker would+// briefly show only models and stream the databases in afterwards.function withSavedDatabasesPrefetch(WrappedComponent) {return function DataSelectorWithSavedDatabasesPrefetch(props) {- useListDatabasesQuery({ saved: true });- return <WrappedComponent {...props} />;+ const { isLoading } = useListDatabasesQuery({ saved: true });+ return (+ <WrappedComponent+ {...props}+ allLoading={isLoading || (props.allLoading ?? false)}+ />+ );};}diff --git a/enterprise/frontend/src/embedding/data-picker/DataSelector/tests/DataSourceSelector.unit.spec.tsx b/enterprise/frontend/src/embedding/data-picker/DataSelector/tests/DataSourceSelector.unit.spec.tsxindex d39834de5e6..57af03cc660 100644--- a/enterprise/frontend/src/embedding/data-picker/DataSelector/tests/DataSourceSelector.unit.spec.tsx+++ b/enterprise/frontend/src/embedding/data-picker/DataSelector/tests/DataSourceSelector.unit.spec.tsx@@ -6,7 +6,7 @@ import {setupCollectionsEndpoints,setupDatabasesEndpoints,} from "__support__/server-mocks";-import { renderWithProviders, screen } from "__support__/ui";+import { renderWithProviders, screen, waitFor } from "__support__/ui";import { getNextId } from "__support__/utils";import { ROOT_COLLECTION } from "metabase/collections/constants";import type { EmbeddingEntityType } from "metabase/redux/store/embedding-data-picker";@@ -15,7 +15,12 @@ import {createMockState,} from "metabase/redux/store/mocks";import type { Database, SearchModel, Table } from "metabase-types/api";-import { createMockDatabase, createMockTable } from "metabase-types/api/mocks";+import {+ createMockDatabase,+ createMockTable,+ createMockUser,+ createMockUserPermissions,+} from "metabase-types/api/mocks";import { createSampleDatabase } from "metabase-types/api/mocks/presets";import { DataSourceSelector } from "../DataSelector";@@ -243,6 +248,112 @@ describe("DataSourceSelector", () => {expect(screen.getByText("Saved Questions")).toBeInTheDocument();});});++ // metabase#74428: after the "Remove database entity" PR the picker hydrated as+ // soon as the (fast) models search resolved, so it showed the models bucket+ // before the database list had loaded and streamed the databases in+ // afterwards. The picker must wait for both before rendering its first step.+ describe("when the database list resolves after the models search (metabase#74428)", () => {+ function setupWithDeferredDatabaseList() {+ let resolveSearch!: () => void;+ const searchResponse = new Promise<void>((resolve) => {+ resolveSearch = resolve;+ });+ fetchMock.get({+ url: "path:/api/search",+ query: {+ calculate_available_models: true,+ limit: 0,+ models: ["dataset"],+ },+ response: () =>+ searchResponse.then(() => ({+ data: [],+ limit: 0,+ models: ["dataset"],+ offset: 0,+ table_db_id: null,+ total: 1,+ available_models: ["table", "dataset"],+ })),+ name: "deferred-search",+ });++ let resolveDatabaseList!: () => void;+ const databaseListResponse = new Promise<void>((resolve) => {+ resolveDatabaseList = resolve;+ });+ fetchMock.get({+ url: "path:/api/database",+ query: { saved: true },+ response: () =>+ databaseListResponse.then(() => ({+ data: DATABASES,+ total: DATABASES.length,+ })),+ name: "deferred-database-list",+ });++ renderWithProviders(+ <DataSourceSelector+ isInitiallyOpen+ querySourceType={undefined}+ canChangeDatabase+ selectedDatabaseId={null}+ canSelectModel+ canSelectTable+ canSelectQuestion+ triggerElement={<div>Click me to open or close data picker</div>}+ setSourceTableFn={jest.fn()}+ />,+ {+ storeInitialState: createMockState({+ // `databases` is empty while the list request is in flight, so we+ // need data-access permissions to render the picker (rather than the+ // "add some data first" empty state) during that window.+ currentUser: createMockUser({+ permissions: createMockUserPermissions({+ can_create_queries: true,+ }),+ }),+ settings: createMockSettingsState({+ "enable-nested-queries": true,+ }),+ }),+ },+ );++ return { resolveSearch, resolveDatabaseList };+ }++ it("does not render the data bucket step until the databases have loaded", async () => {+ const { resolveSearch, resolveDatabaseList } =+ setupWithDeferredDatabaseList();++ // Both requests are in flight, so the picker shows its loading state.+ expect(+ await screen.findByTestId("loading-indicator"),+ ).toBeInTheDocument();++ // The models search resolves first; the database list is still pending.+ resolveSearch();+ await waitFor(() => {+ expect(+ screen.queryByTestId("loading-indicator"),+ ).not.toBeInTheDocument();+ });++ // Regression: the bucket step must NOT appear yet. Before the fix, "Models"+ // showed here, ahead of the still-loading databases.+ expect(screen.queryByText("Models")).not.toBeInTheDocument();+ expect(screen.queryByText("Raw Data")).not.toBeInTheDocument();++ // Once the databases load, the bucket step appears with everything at once.+ resolveDatabaseList();+ expect(await screen.findByText("Models")).toBeInTheDocument();+ expect(screen.getByText("Raw Data")).toBeInTheDocument();+ });+ });});function createNNumberOfTables(numberOfTables: number, dbId: number): Table[] {