Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Remove requests reducer (#74994)

Romeo Van Snick5ef9224d2732
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts
index 1f8d8fe4652..0ab52925ab8 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts
@@ -1,5 +1,4 @@
import type { PartialBy } from "metabase/common/types";
-import type { RequestState, RequestsState } from "metabase/redux/store";
import type { EnterpriseSharedState } from "metabase-enterprise/shared/reducer";
import type { EnterpriseState } from "metabase-enterprise/shared/types";
import type { DatabaseId, GroupId, Impersonation } from "metabase-types/api";
@@ -9,13 +8,6 @@ import type { AdvancedPermissionsState } from "./reducer";
export type ImpersonationParams = { groupId: GroupId; databaseId: DatabaseId };
export interface AdvancedPermissionsStoreState extends EnterpriseState {
- requests: RequestsState & {
- plugins: {
- advancedPermissionsPlugin: {
- policies: Record<string, RequestState>;
- };
- };
- };
plugins: {
shared: EnterpriseSharedState;
advancedPermissionsPlugin: AdvancedPermissionsState;
diff --git a/frontend/src/metabase/query_builder/containers/test-utils.tsx b/frontend/src/metabase/query_builder/containers/test-utils.tsx
index f8f1f989768..c76dd601aa0 100644
--- a/frontend/src/metabase/query_builder/containers/test-utils.tsx
+++ b/frontend/src/metabase/query_builder/containers/test-utils.tsx
@@ -37,7 +37,6 @@ import { NewItemMenu } from "metabase/common/components/NewItemMenu";
import { LOAD_COMPLETE_FAVICON } from "metabase/common/hooks/constants";
import { serializeCardForUrl } from "metabase/common/utils/card";
import NewModelOptions from "metabase/models/containers/NewModelOptions";
-import type { RequestState, State } from "metabase/redux/store";
import { createMockState } from "metabase/redux/store/mocks";
import { checkNotNull } from "metabase/utils/types";
import type { Card, Dataset, UnsavedCard } from "metabase-types/api";
@@ -280,11 +279,7 @@ export const setup = async ({
const mockEventListener = jest.spyOn(window, "addEventListener");
- const {
- store: { getState },
- container,
- history,
- } = renderWithProviders(
+ const { container, history } = renderWithProviders(
<div>
<Route>
<Route path="/" component={TestHome} />
@@ -324,9 +319,7 @@ export const setup = async ({
},
);
- await waitForLoadingRequests(getState);
await waitForLoaderToBeRemoved();
- await waitForLoadingRequests(getState);
return {
container,
@@ -335,25 +328,6 @@ export const setup = async ({
};
};
-const waitForLoadingRequests = async (getState: () => State) => {
- await waitFor(
- () => {
- const requests = getRequests(getState());
- const areRequestsLoading = requests.some((request) => request.loading);
- expect(areRequestsLoading).toBe(false);
- },
- { timeout: 5000 },
- );
-};
-
-const getRequests = (state: State): RequestState[] => {
- return Object.values(state.requests).flatMap((group) =>
- Object.values(group).flatMap((entity) =>
- Object.values(entity).flatMap((request) => Object.values(request)),
- ),
- );
-};
-
export const startNewNotebookModel = async () => {
await userEvent.click(screen.getByText("Use the notebook editor"));
await waitForLoaderToBeRemoved();
diff --git a/frontend/src/metabase/reducers-common.ts b/frontend/src/metabase/reducers-common.ts
index 48899b7d56f..d82001a457e 100644
--- a/frontend/src/metabase/reducers-common.ts
+++ b/frontend/src/metabase/reducers-common.ts
@@ -13,7 +13,6 @@ import { reducer as downloads } from "metabase/redux/downloads";
import { embed } from "metabase/redux/embed";
import { reducer as embeddingDataPicker } from "metabase/redux/embedding-data-picker";
import entities from "metabase/redux/entities";
-import { requestsReducer } from "metabase/redux/requests";
import { settings } from "metabase/redux/settings";
import { modal } from "metabase/redux/ui";
import { undoReducer as undo } from "metabase/redux/undo";
@@ -28,7 +27,6 @@ export const commonReducers = {
embed,
embeddingDataPicker,
currentUser,
- requests: requestsReducer,
settings,
undo,
entities,
diff --git a/frontend/src/metabase/redux/requests.ts b/frontend/src/metabase/redux/requests.ts
deleted file mode 100644
index 40acff92894..00000000000
--- a/frontend/src/metabase/redux/requests.ts
+++ /dev/null
@@ -1,203 +0,0 @@
-import { assoc, getIn, updateIn } from "icepick";
-import { type Action, createAction, handleActions } from "redux-actions";
-
-export type RequestState = {
- loading: boolean;
- loaded: boolean;
- fetched: boolean;
- error: unknown | null;
- queryKey?: string;
- queryPromise?: Promise<unknown> | null;
- _isRequestState: true;
-};
-
-export type RequestsStateTree = {
- [key: string]: RequestsStateTree | RequestState;
-};
-
-type StatePath = (string | number)[];
-
-type RequestActionPayload = {
- statePath?: StatePath;
- queryKey?: string;
- queryPromise?: Promise<unknown>;
- error?: unknown;
-};
-
-type RequestsAction = Action<RequestActionPayload | undefined>;
-
-export const setRequestLoading = createAction<
- RequestActionPayload,
- StatePath,
- string | undefined
->(
- "metabase/requests/SET_REQUEST_LOADING",
- (statePath: StatePath, queryKey?: string) => ({
- statePath,
- queryKey,
- }),
-);
-
-export const setRequestPromise = createAction<
- RequestActionPayload,
- StatePath,
- string | undefined,
- Promise<unknown>
->(
- "metabase/requests/SET_REQUEST_PROMISE",
- (
- statePath: StatePath,
- queryKey: string | undefined,
- queryPromise: Promise<unknown>,
- ) => ({
- statePath,
- queryKey,
- queryPromise,
- }),
-);
-
-export const setRequestLoaded = createAction<
- RequestActionPayload,
- StatePath,
- string | undefined
->(
- "metabase/requests/SET_REQUEST_LOADED",
- (statePath: StatePath, queryKey?: string) => ({
- statePath,
- queryKey,
- }),
-);
-
-export const setRequestError = createAction<
- RequestActionPayload,
- StatePath,
- string | undefined,
- unknown
->(
- "metabase/requests/SET_REQUEST_ERROR",
- (statePath: StatePath, queryKey: string | undefined, error: unknown) => ({
- statePath,
- queryKey,
- error,
- }),
-);
-
-export const setRequestUnloaded = createAction<RequestActionPayload, StatePath>(
- "metabase/requests/SET_REQUEST_UNLOADED",
- (statePath: StatePath) => ({ statePath }),
-);
-
-const initialRequestState: RequestState = {
- loading: false,
- loaded: false,
- fetched: false,
- error: null,
- _isRequestState: true,
-};
-
-const requestStateReducer = handleActions<
- RequestState,
- RequestActionPayload | undefined
->(
- {
- [setRequestLoading.toString()]: {
- next: (
- state,
- { payload: { queryKey, queryPromise } = {} }: RequestsAction,
- ) => ({
- ...state,
- queryKey,
- queryPromise,
- loading: true,
- loaded: false,
- error: null,
- }),
- },
- [setRequestPromise.toString()]: {
- next: (
- state,
- { payload: { queryKey, queryPromise } = {} }: RequestsAction,
- ) => ({
- ...state,
- queryKey,
- queryPromise,
- }),
- },
- [setRequestLoaded.toString()]: {
- next: (state, { payload: { queryKey } = {} }: RequestsAction) => ({
- ...state,
- queryKey,
- loading: false,
- loaded: true,
- error: null,
- fetched: true,
- }),
- },
- [setRequestError.toString()]: {
- next: (state, { payload: { queryKey, error } = {} }: RequestsAction) => ({
- ...state,
- queryKey,
- loading: false,
- loaded: false,
- error: error,
- }),
- },
- [setRequestUnloaded.toString()]: {
- next: (state) => ({
- ...state,
- loaded: false,
- error: null,
- queryPromise: null,
- }),
- },
- },
- initialRequestState,
-);
-
-function isRequestState(
- state: RequestState | RequestsStateTree,
-): state is RequestState {
- return "_isRequestState" in state && !!state._isRequestState;
-}
-
-function requestStateReducerRecursive(
- state: RequestState | RequestsStateTree | undefined,
- action: RequestsAction,
-): RequestState | RequestsStateTree {
- if (!state || isRequestState(state)) {
- return requestStateReducer(state, action);
- } else {
- let newState = state;
- for (const [key, subState] of Object.entries(state)) {
- newState = assoc(
- newState,
- key,
- requestStateReducerRecursive(subState, action),
- );
- }
-
- return newState;
- }
-}
-
-const isBulkInvalidation = (statePath: (string | number)[]): boolean => {
- // Bulk invalidations only have a statePath with a length of 2
- return statePath.length <= 2;
-};
-
-export const requestsReducer = (
- state: RequestsStateTree = {},
- action: RequestsAction,
-): RequestsStateTree => {
- if (action?.payload?.statePath) {
- const statePath = action.payload.statePath;
- const hasStateToUpdate = !!getIn(state, statePath);
-
- if (hasStateToUpdate || !isBulkInvalidation(statePath)) {
- state = updateIn(state, statePath, (subState: RequestState | undefined) =>
- requestStateReducerRecursive(subState, action),
- );
- }
- }
- return state;
-};
diff --git a/frontend/src/metabase/redux/store/index.ts b/frontend/src/metabase/redux/store/index.ts
index 5ac06fade95..12b5a46af4b 100644
--- a/frontend/src/metabase/redux/store/index.ts
+++ b/frontend/src/metabase/redux/store/index.ts
@@ -8,7 +8,6 @@ export * from "./embed";
export * from "./entities";
export * from "./pulse";
export * from "./qb";
-export * from "./requests";
export * from "./settings";
export * from "./setup";
export * from "./state";
diff --git a/frontend/src/metabase/redux/store/mocks/requests.ts b/frontend/src/metabase/redux/store/mocks/requests.ts
deleted file mode 100644
index 57453817d7b..00000000000
--- a/frontend/src/metabase/redux/store/mocks/requests.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import type { RequestsState } from "../requests";
-
-export const createMockRequestsState = (
- opts: Partial<RequestsState> = {},
-): RequestsState => {
- return {
- entities: {},
- plugins: {},
- ...opts,
- };
-};
diff --git a/frontend/src/metabase/redux/store/mocks/state.ts b/frontend/src/metabase/redux/store/mocks/state.ts
index 29c9817d3b1..f5627eeafc8 100644
--- a/frontend/src/metabase/redux/store/mocks/state.ts
+++ b/frontend/src/metabase/redux/store/mocks/state.ts
@@ -13,7 +13,6 @@ import { createMockNormalizedEntitiesState } from "./entities";
import { createMockModalState } from "./modal";
import { createMockParametersState } from "./parameters";
import { createMockQueryBuilderState } from "./qb";
-import { createMockRequestsState } from "./requests";
import { createMockRoutingState } from "./routing";
import { createMockSettingsState } from "./settings";
import { createMockSetupState } from "./setup";
@@ -37,7 +36,6 @@ export function createMockState(opts: any) {
"metabase-api": createMockApiState(),
parameters: createMockParametersState(),
qb: createMockQueryBuilderState(),
- requests: createMockRequestsState(),
routing: createMockRoutingState(),
settings: createMockSettingsState(),
setup: createMockSetupState(),
diff --git a/frontend/src/metabase/redux/store/requests.ts b/frontend/src/metabase/redux/store/requests.ts
deleted file mode 100644
index 4a85f7c193a..00000000000
--- a/frontend/src/metabase/redux/store/requests.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-type EntityKey = string;
-
-type QueryKey = string;
-
-type RequestType = string; // only "fetch"?
-
-// See initialRequestState in metabase/redux/requests.js
-export interface RequestState {
- loading: boolean;
- loaded: boolean;
- fetched: boolean;
- error: unknown | null;
- _isRequestState: true;
-}
-
-type RequestsGroupState = Record<
- EntityKey,
- Record<QueryKey, Record<RequestType, RequestState>>
->;
-
-export type RequestsState = {
- plugins: RequestsGroupState;
- entities: RequestsGroupState;
-};
diff --git a/frontend/src/metabase/redux/store/state.ts b/frontend/src/metabase/redux/store/state.ts
index 56064b52c5f..c2d16705e7d 100644
--- a/frontend/src/metabase/redux/store/state.ts
+++ b/frontend/src/metabase/redux/store/state.ts
@@ -18,7 +18,6 @@ import type { ModalState } from "./modal";
import type { ParametersState } from "./parameters";
import type { PulseState } from "./pulse";
import type { QueryBuilderState } from "./qb";
-import type { RequestsState } from "./requests";
import type { SettingsState } from "./settings";
import type { SetupState } from "./setup";
import type { UndoState } from "./undo";
@@ -40,7 +39,6 @@ export interface State {
parameters: ParametersState;
pulse: PulseState;
qb: QueryBuilderState;
- requests: RequestsState;
routing: RouterState;
settings: SettingsState;
setup: SetupState;
diff --git a/frontend/test/__support__/entities-store.ts b/frontend/test/__support__/entities-store.ts
index c5ec93a53a9..dc274e52e5e 100644
--- a/frontend/test/__support__/entities-store.ts
+++ b/frontend/test/__support__/entities-store.ts
@@ -2,7 +2,6 @@ import type { Middleware, Reducer } from "@reduxjs/toolkit";
import { combineReducers, configureStore } from "@reduxjs/toolkit";
import { reducer as entitiesReducer } from "metabase/redux/entities";
-import { requestsReducer } from "metabase/redux/requests";
import type { State } from "metabase/redux/store";
/**
@@ -18,7 +17,6 @@ export function getStore(
) {
const reducer = combineReducers({
entities: entitiesReducer,
- requests: requestsReducer,
...reducers,
}) as unknown as Reducer<State>;