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
Derive each store root's state type from the slices it composes (#81481)
Romeo Van Snickdbc843ce2346
diff --git a/frontend/src/embedding-sdk-bundle/store/index.ts b/frontend/src/embedding-sdk-bundle/store/index.tsindex 12b0127227d..35f25b6b6c7 100644--- a/frontend/src/embedding-sdk-bundle/store/index.ts+++ b/frontend/src/embedding-sdk-bundle/store/index.ts@@ -1,4 +1,8 @@-import { type Reducer, combineReducers } from "@reduxjs/toolkit";+import {+ type Reducer,+ type StateFromReducersMapObject,+ combineReducers,+} from "@reduxjs/toolkit";import { useContext } from "react";import * as pulse from "metabase/notifications/pulse/reducers";@@ -13,14 +17,21 @@ import { sdkListenerMiddleware } from "./listener-middleware";import { sdk } from "./reducer";import type { SdkDispatch, SdkStore } from "./types";-// Unjustified type cast. FIXME-export const sdkReducers = {+const sdkReducerMap = {...commonReducers,pulse: combineReducers(pulse),qb: queryBuilderReducer,visualizer,sdk,-} as unknown as Record<string, Reducer>;+};++/**+ * The SDK's state, derived from the slices this root composes.+ */+export type SdkState = StateFromReducersMapObject<typeof sdkReducerMap>;++// Unjustified type cast. FIXME+export const sdkReducers = sdkReducerMap as unknown as Record<string, Reducer>;export const getSdkStore = () =>// Unjustified type cast. FIXMEdiff --git a/frontend/src/metabase/metadata-store/selectors.ts b/frontend/src/metabase/metadata-store/selectors.tsindex 7bac505dd61..57750e94b9a 100644--- a/frontend/src/metabase/metadata-store/selectors.ts+++ b/frontend/src/metabase/metadata-store/selectors.ts@@ -1,7 +1,7 @@import { createSelector } from "@reduxjs/toolkit";import { normalize } from "normalizr";-import type { State } from "metabase/redux/store";+import type { EntitiesState, State } from "metabase/redux/store";import { getSettings } from "metabase/settings";import Question from "metabase-lib/v1/Question";import Database from "metabase-lib/v1/metadata/Database";@@ -35,6 +35,13 @@ import type {import { type FieldEntity, FieldSchema } from "./schema";+/**+ * The slice these selectors read. Naming it here rather than taking the global+ * `State` keeps the shape this module depends on explicit, and lets a caller+ * that holds only the mirror use them.+ */+type MetadataState = { entities: EntitiesState };+type TableSelectorOpts = {includeHiddenTables?: boolean;};@@ -45,13 +52,17 @@ type FieldSelectorOpts = {export type MetadataSelectorOpts = TableSelectorOpts & FieldSelectorOpts;-const getNormalizedDatabases = (state: State) => state.entities.databases;-const getNormalizedSchemas = (state: State) => state.entities.schemas;+const getNormalizedDatabases = (state: MetadataState) =>+ state.entities.databases;+const getNormalizedSchemas = (state: MetadataState) => state.entities.schemas;-const getNormalizedTablesUnfiltered = (state: State) => state.entities.tables;+const getNormalizedTablesUnfiltered = (state: MetadataState) =>+ state.entities.tables;-const getIncludeHiddenTables = (_state: State, props?: TableSelectorOpts) =>- !!props?.includeHiddenTables;+const getIncludeHiddenTables = (+ _state: MetadataState,+ props?: TableSelectorOpts,+) => !!props?.includeHiddenTables;const getNormalizedTables = createSelector([getNormalizedTablesUnfiltered, getIncludeHiddenTables],@@ -65,9 +76,12 @@ const getNormalizedTables = createSelector(),);-const getNormalizedFieldsUnfiltered = (state: State) => state.entities.fields;-const getIncludeSensitiveFields = (_state: State, props?: FieldSelectorOpts) =>- !!props?.includeSensitiveFields;+const getNormalizedFieldsUnfiltered = (state: MetadataState) =>+ state.entities.fields;+const getIncludeSensitiveFields = (+ _state: MetadataState,+ props?: FieldSelectorOpts,+) => !!props?.includeSensitiveFields;const getNormalizedFields = createSelector([@@ -92,17 +106,22 @@ const getNormalizedFields = createSelector(),);-const getNormalizedSegments = (state: State) => state.entities.segments;-const getNormalizedMeasures = (state: State) => state.entities.measures ?? {};-const getNormalizedMetrics = (state: State) => state.entities.metrics ?? {};-const getNormalizedQuestions = (state: State) => state.entities.questions;-const getNormalizedSnippets = (state: State) => state.entities.snippets;+const getNormalizedSegments = (state: MetadataState) => state.entities.segments;+const getNormalizedMeasures = (state: MetadataState) =>+ state.entities.measures ?? {};+const getNormalizedMetrics = (state: MetadataState) =>+ state.entities.metrics ?? {};+const getNormalizedQuestions = (state: MetadataState) =>+ state.entities.questions;+const getNormalizedSnippets = (state: MetadataState) => state.entities.snippets;export const getShallowDatabases = getNormalizedDatabases;export const getShallowTables = getNormalizedTables;export const getShallowFields = getNormalizedFields;export const getShallowSegments = getNormalizedSegments;+// Takes the whole `State`, not `MetadataState`: it composes `getSettings`,+// which reads settings out of the RTK Query cache. It narrows when that does.export const getMetadata: (state: State,props?: MetadataSelectorOpts,@@ -449,7 +468,7 @@ function hydrateMeasureTable(* another, so a component cannot answer this from its own result.*/export function getFieldRemappings(- state: State,+ state: MetadataState,fieldId: FieldId,): FieldValue[] {return state.entities.fields[fieldId]?.remappings ?? [];diff --git a/frontend/src/metabase/reducers-main.ts b/frontend/src/metabase/reducers-main.tsindex 21a76cb3f04..6b4bce295dd 100644--- a/frontend/src/metabase/reducers-main.ts+++ b/frontend/src/metabase/reducers-main.ts@@ -1,12 +1,16 @@// Reducers needed for main application-import { combineReducers } from "@reduxjs/toolkit";+import {+ type StateFromReducersMapObject,+ combineReducers,+} from "@reduxjs/toolkit";import { admin } from "metabase/admin/admin";import * as pulse from "metabase/notifications/pulse/reducers";import { PLUGIN_REDUCERS } from "metabase/plugins";import { queryBuilderReducer } from "metabase/query_builder";import revisions from "metabase/redux/revisions";+import type { State } from "metabase/redux/store";import reference from "metabase/reference/reference";import { reducer as setup } from "metabase/setup/reducers";import { reducer as visualizer } from "metabase/visualizer/visualizer.slice";@@ -36,3 +40,46 @@ export function makeMainReducers() {}export const mainReducers = makeMainReducers();++/**+ * The main app's state, derived from the slices this root composes.+ *+ * Registering a slice here is the only way to add a key. Nothing declares the+ * shape by hand, so a root and its state type cannot drift apart.+ */+export type MainState = StateFromReducersMapObject<+ ReturnType<typeof makeMainReducers>+>;++/**+ * `State` is still written by hand in `metabase/redux/store`, and modules type+ * their selectors against it. These checks fail the build when it stops+ * describing what this root composes. Remove them with `State` itself.+ */+type Assert<T extends true> = T;++/**+ * Every key `State` declares is a slice this root really registers. A key left+ * behind after its slice moves out fails here.+ */+export type _EveryStateKeyIsRegistered = Assert<+ keyof State extends keyof MainState ? true : false+>;++/**+ * The reverse does not hold. This root registers three slices that `State`+ * never declared, so code reading them types them itself.+ *+ * Declaring them would mean importing their types into `metabase/redux/store`,+ * which sits far below this root and may not reach up to it. They resolve when+ * `State` moves out of the shared tier, not before. Pinned here so the gap+ * cannot grow.+ */+export type _UndeclaredKeysAreOnlyTheKnownThree = Assert<+ Exclude<keyof MainState, keyof State> extends+ | "reference"+ | "revisions"+ | "plugins"+ ? true+ : false+>;diff --git a/frontend/src/metabase/reducers-public.ts b/frontend/src/metabase/reducers-public.tsindex 3591824726e..5d560c1a22d 100644--- a/frontend/src/metabase/reducers-public.ts+++ b/frontend/src/metabase/reducers-public.ts@@ -1,7 +1,14 @@// Reducers needed for public questions and dashboards+import type { StateFromReducersMapObject } from "@reduxjs/toolkit";+import { commonReducers } from "./reducers-common";export const publicReducers = {...commonReducers,};++/**+ * The public app's state, derived from the slices this root composes.+ */+export type PublicState = StateFromReducersMapObject<typeof publicReducers>;