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
Move the segment fetch thunks into the reference module (#80059)
Romeo Van Snick3a0ac1ecbaf8
diff --git a/frontend/src/metabase/redux/metadata.ts b/frontend/src/metabase/redux/metadata.tsindex 3d28aac6a58..088cd75fd83 100644--- a/frontend/src/metabase/redux/metadata.ts+++ b/frontend/src/metabase/redux/metadata.ts@@ -3,25 +3,9 @@ import _ from "underscore";import { databaseApi, fieldApi, segmentApi, tableApi } from "metabase/api";import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";-import { createThunkAction } from "metabase/redux";-import { fetchRevisions } from "metabase/redux/revisions";import type { Dispatch } from "metabase/redux/store";-import {- fetchTableMetadata,- fetchTableMetadataAndForeignKeys,-} from "metabase/redux/tables";import { DatabaseSchema, FieldSchema, TableSchema } from "metabase/schema";-import { checkNotNull } from "metabase/utils/types";-import type {- Database,- DatabaseId,- Field,- GetDatabaseMetadataRequest,- Segment,- SegmentId,- Table,- TableId,-} from "metabase-types/api";+import type { Database, Field, Segment, Table } from "metabase-types/api";const UPDATE = "metabase/entities/UPDATE";@@ -34,23 +18,6 @@ export function updateMetadata(data: unknown, schema: Schema) {return { type: UPDATE, payload };}-export const fetchSegments =- () =>- (dispatch: Dispatch): Promise<Segment[]> =>- runRtkEndpoint(undefined, dispatch, segmentApi.endpoints.listSegments);--/**- * Resolves a segment's table from the list response rather than from- * `state.entities`, so these thunks do not read the mirror they feed.- */-const fetchSegmentTableId =- (segmentId: SegmentId) =>- async (dispatch: Dispatch): Promise<TableId> => {- const segments = await fetchSegments()(dispatch);- const segment = segments.find(({ id }) => id === segmentId);- return checkNotNull(segment).table_id;- };-export const updateSegment =(segment: Segment) =>(dispatch: Dispatch): Promise<unknown> =>@@ -100,57 +67,3 @@ export const updateField =dispatch(updateMetadata(result, FieldSchema));return result;};--// Private: the only caller left is `fetchSegmentFields` below. It deletes with-// that thunk.-const fetchDatabaseMetadata =- (id: DatabaseId) =>- (dispatch: Dispatch): Promise<unknown> =>- runRtkEndpoint(- { id, skip_fields: true } satisfies GetDatabaseMetadataRequest,- dispatch,- databaseApi.endpoints.getDatabaseMetadata,- { forceRefetch: false },- );--const FETCH_SEGMENT_FIELDS = "metabase/metadata/FETCH_SEGMENT_FIELDS";-export const fetchSegmentFields = createThunkAction(- FETCH_SEGMENT_FIELDS,- (segmentId: SegmentId) => {- return async (dispatch) => {- const tableId = await dispatch(fetchSegmentTableId(segmentId));- await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));- // Annotated, not cast: `fetchTableMetadata` returns the endpoint's- // untyped result and `db_id` is the only field this needs.- const table: { db_id: DatabaseId } = await dispatch(- fetchTableMetadata({ id: tableId }),- );- await dispatch(fetchDatabaseMetadata(table.db_id));- };- },-);--const FETCH_SEGMENT_TABLE = "metabase/metadata/FETCH_SEGMENT_TABLE";-export const fetchSegmentTable = createThunkAction(- FETCH_SEGMENT_TABLE,- (segmentId: SegmentId) => {- return async (dispatch) => {- const tableId = await dispatch(fetchSegmentTableId(segmentId));- await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));- };- },-);--const FETCH_SEGMENT_REVISIONS = "metabase/metadata/FETCH_SEGMENT_REVISIONS";-export const fetchSegmentRevisions = createThunkAction(- FETCH_SEGMENT_REVISIONS,- (segmentId: SegmentId) => {- return async (dispatch) => {- const [, tableId] = await Promise.all([- dispatch(fetchRevisions("segment", segmentId)),- dispatch(fetchSegmentTableId(segmentId)),- ]);- await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));- };- },-);diff --git a/frontend/src/metabase/redux/store/mocks/api.ts b/frontend/src/metabase/redux/store/mocks/api.tsindex c938a750c8b..f335b7f4f6c 100644--- a/frontend/src/metabase/redux/store/mocks/api.ts+++ b/frontend/src/metabase/redux/store/mocks/api.ts@@ -1,9 +1,11 @@// Import the `metabase/api` index, not the bare `Api` from ./api.// The index injects every endpoint module, and an endpoint must be registered-// before an upsert can build its cache entry. `getCurrentUser` is injected by-// the current-user module, so pull that in for the same reason.+// before an upsert can build its cache entry. `getCurrentUser` and+// `getSessionProperties` live outside that index, so pull in their modules for+// the same reason rather than relying on a transitive import.import { Api } from "metabase/api";import "metabase/current-user";+import "metabase/settings";import type { State } from "metabase/redux/store";import type { User } from "metabase-types/api";diff --git a/frontend/src/metabase/reference/fetch-data.ts b/frontend/src/metabase/reference/fetch-data.tsindex 43b2052b78b..da73e59f1ea 100644--- a/frontend/src/metabase/reference/fetch-data.ts+++ b/frontend/src/metabase/reference/fetch-data.ts@@ -1,19 +1,18 @@import { cardApi } from "metabase/api";import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";+import type { Dispatch } from "metabase/redux/store";+import { fetchTableMetadataAndForeignKeys } from "metabase/redux/tables";import {fetchSegmentFields,fetchSegmentRevisions,fetchSegmentTable,fetchSegments,-} from "metabase/redux/metadata";-import type { Dispatch } from "metabase/redux/store";-import { fetchTableMetadataAndForeignKeys } from "metabase/redux/tables";+} from "metabase/reference/segments/thunks";import type { SegmentId, TableId } from "metabase-types/api";/**- * What each reference page loads. Previously the `wrapped*` helpers, which also- * drove the module's loading state. That part now belongs to- * `useReferenceFetch`, so these are plain fetches.+ * What each reference page loads. Loading state is reported separately, by+ * `useReferenceFetch`.*/const fetchQuestions = (dispatch: Dispatch) =>diff --git a/frontend/src/metabase/reference/segments/thunks.ts b/frontend/src/metabase/reference/segments/thunks.tsnew file mode 100644index 00000000000..15daff1a25b--- /dev/null+++ b/frontend/src/metabase/reference/segments/thunks.ts@@ -0,0 +1,89 @@+import { databaseApi, segmentApi } from "metabase/api";+import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";+import { createThunkAction } from "metabase/redux";+import { fetchRevisions } from "metabase/redux/revisions";+import type { Dispatch } from "metabase/redux/store";+import {+ fetchTableMetadata,+ fetchTableMetadataAndForeignKeys,+} from "metabase/redux/tables";+import { checkNotNull } from "metabase/utils/types";+import type {+ DatabaseId,+ GetDatabaseMetadataRequest,+ Segment,+ SegmentId,+ TableId,+} from "metabase-types/api";++/**+ * Fetch orchestration for the reference segment pages.+ */++export const fetchSegments =+ () =>+ (dispatch: Dispatch): Promise<Segment[]> =>+ runRtkEndpoint(undefined, dispatch, segmentApi.endpoints.listSegments);++/**+ * Resolves a segment's table from the list response.+ */+const fetchSegmentTableId =+ (segmentId: SegmentId) =>+ async (dispatch: Dispatch): Promise<TableId> => {+ const segments = await fetchSegments()(dispatch);+ const segment = segments.find(({ id }) => id === segmentId);+ return checkNotNull(segment).table_id;+ };++const fetchDatabaseMetadata =+ (id: DatabaseId) =>+ (dispatch: Dispatch): Promise<unknown> =>+ runRtkEndpoint(+ { id, skip_fields: true } satisfies GetDatabaseMetadataRequest,+ dispatch,+ databaseApi.endpoints.getDatabaseMetadata,+ { forceRefetch: false },+ );++const FETCH_SEGMENT_FIELDS = "metabase/metadata/FETCH_SEGMENT_FIELDS";+export const fetchSegmentFields = createThunkAction(+ FETCH_SEGMENT_FIELDS,+ (segmentId: SegmentId) => {+ return async (dispatch) => {+ const tableId = await dispatch(fetchSegmentTableId(segmentId));+ await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));+ // Annotated, not cast: `fetchTableMetadata` returns the endpoint's+ // untyped result and `db_id` is the only field this needs.+ const table: { db_id: DatabaseId } = await dispatch(+ fetchTableMetadata({ id: tableId }),+ );+ await dispatch(fetchDatabaseMetadata(table.db_id));+ };+ },+);++const FETCH_SEGMENT_TABLE = "metabase/metadata/FETCH_SEGMENT_TABLE";+export const fetchSegmentTable = createThunkAction(+ FETCH_SEGMENT_TABLE,+ (segmentId: SegmentId) => {+ return async (dispatch) => {+ const tableId = await dispatch(fetchSegmentTableId(segmentId));+ await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));+ };+ },+);++const FETCH_SEGMENT_REVISIONS = "metabase/metadata/FETCH_SEGMENT_REVISIONS";+export const fetchSegmentRevisions = createThunkAction(+ FETCH_SEGMENT_REVISIONS,+ (segmentId: SegmentId) => {+ return async (dispatch) => {+ const [, tableId] = await Promise.all([+ dispatch(fetchRevisions("segment", segmentId)),+ dispatch(fetchSegmentTableId(segmentId)),+ ]);+ await dispatch(fetchTableMetadataAndForeignKeys({ id: tableId }));+ };+ },+);