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
Delete the entity-framework hooks (#80969)
Romeo Van Snick9b3874e11416
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.tsindex a907b4630ee..4c2ce268fd6 100644--- a/frontend/src/metabase-types/api/card.ts+++ b/frontend/src/metabase-types/api/card.ts@@ -576,6 +576,7 @@ export type CardFilterOption =| "recent"| "popular"| "using_model"+ | "using_segment"| "archived";export type CardQueryMetadata = {diff --git a/frontend/src/metabase/common/hooks/entity-framework/index.ts b/frontend/src/metabase/common/hooks/entity-framework/index.tsdeleted file mode 100644index 6965b7b0041..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/index.ts+++ /dev/null@@ -1,7 +0,0 @@-/*- * This directory is deprecated.- * Use "metabase/api" instead.- */--export * from "./use-question-list-query";-export * from "./use-question-query";diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/index.ts b/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/index.tsdeleted file mode 100644index 5836ce2b3a8..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./use-entity-list-query";diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.tsdeleted file mode 100644index 10cf6ca5c07..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.ts+++ /dev/null@@ -1,98 +0,0 @@-import type { Action } from "@reduxjs/toolkit";-import { useDeepCompareEffect, usePrevious } from "react-use";--import { useDispatch, useSelector } from "metabase/redux";-import type { State } from "metabase/redux/store";--export interface EntityFetchOptions {- reload?: boolean;-}--export interface EntityQueryOptions<TQuery = never> {- entityQuery?: TQuery;-}--export interface UseEntityListOwnProps<- TItem,- TQuery = never,- TMetadata = never,-> {- fetchList: (query?: TQuery, options?: EntityFetchOptions) => Action;- getList: (- state: State,- options: EntityQueryOptions<TQuery>,- ) => TItem[] | undefined;- getLoading: (- state: State,- options: EntityQueryOptions<TQuery>,- ) => boolean | undefined;- getLoaded: (- state: State,- options: EntityQueryOptions<TQuery>,- ) => boolean | undefined;- getError: (state: State, options: EntityQueryOptions<TQuery>) => unknown;- getListMetadata: (- state: State,- options: EntityQueryOptions<TQuery>,- ) => TMetadata | undefined;-}--export interface UseEntityListQueryProps<TQuery = never> {- query?: TQuery;- reload?: boolean;- enabled?: boolean;-}--export interface UseEntityListQueryResult<TItem, TMetadata = never> {- data?: TItem[];- metadata?: TMetadata;- isLoaded: boolean;- isLoading: boolean;- error: unknown;-}--/**- * @deprecated use "metabase/api" instead- */-export const useEntityListQuery = <TItem, TQuery = never, TMetadata = never>(- {- query: entityQuery,- reload = false,- enabled = true,- }: UseEntityListQueryProps<TQuery>,- {- fetchList,- getList,- getLoading,- getLoaded,- getError,- getListMetadata,- }: UseEntityListOwnProps<TItem, TQuery, TMetadata>,-): UseEntityListQueryResult<TItem, TMetadata> => {- const options = { entityQuery };- const data = useSelector((state) => getList(state, options));- const metadata = useSelector((state) => getListMetadata(state, options));- const error = useSelector((state) => getError(state, options));- const isLoading = useSelector((state) => getLoading(state, options));- const isLoadingOrDefault = isLoading ?? enabled;- const isLoaded = useSelector((state) => getLoaded(state, options)) ?? false;- const isLoadedPreviously = usePrevious(isLoaded);- const isInvalidated = !isLoaded && isLoadedPreviously;- const dispatch = useDispatch();-- useDeepCompareEffect(() => {- if (enabled) {- const action = dispatch(fetchList(entityQuery, { reload }));- Promise.resolve(action).catch(() => undefined);- }- }, [dispatch, fetchList, entityQuery, reload, enabled]);-- useDeepCompareEffect(() => {- if (enabled && isInvalidated) {- const action = dispatch(fetchList(entityQuery));- Promise.resolve(action).catch(() => undefined);- }- }, [dispatch, fetchList, entityQuery, reload, enabled, isInvalidated]);-- return { data, metadata, isLoading: isLoadingOrDefault, isLoaded, error };-};diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/index.ts b/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/index.tsdeleted file mode 100644index 1da70001dea..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./use-entity-query";diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.tsdeleted file mode 100644index 47ea8f68243..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.ts+++ /dev/null@@ -1,79 +0,0 @@-import type { Action } from "@reduxjs/toolkit";-import { useDeepCompareEffect } from "react-use";--import { useDispatch, useSelector } from "metabase/redux";-import type { State } from "metabase/redux/store";--export interface EntityQuery<TId> {- id: TId;-}--export interface EntityFetchOptions {- reload?: boolean;- requestType?: string;-}--export interface EntityQueryOptions<TId> {- entityId?: TId;-}--export interface UseEntityOwnProps<TId, TItem> {- fetch: (query: EntityQuery<TId>, options?: EntityFetchOptions) => Action;- getObject: (- state: State,- options: EntityQueryOptions<TId>,- ) => TItem | undefined;- getLoading: (state: State, options: EntityQueryOptions<TId>) => boolean;- getError: (state: State, options: EntityQueryOptions<TId>) => unknown;- requestType?: string;-}--export interface UseEntityQueryProps<TId, TQuery = never> {- id?: TId;- query?: TQuery;- reload?: boolean;- enabled?: boolean;-}--export interface UseEntityQueryResult<TItem> {- data?: TItem;- isLoading: boolean;- error: unknown;-}--/**- * @deprecated use "metabase/api" instead- */-export const useEntityQuery = <TId, TItem, TQuery = never>(- {- id: entityId,- query: entityQuery,- reload = false,- enabled = true,- }: UseEntityQueryProps<TId, TQuery>,- {- fetch,- getObject,- getLoading,- getError,- requestType,- }: UseEntityOwnProps<TId, TItem>,-): UseEntityQueryResult<TItem> => {- const options = { entityId, requestType };- const data = useSelector((state) => getObject(state, options));- const isLoading = useSelector((state) => getLoading(state, options));- const isActive = entityId != null && enabled;- const isLoadingOrDefault = isLoading ?? isActive;- const error = useSelector((state) => getError(state, options));-- const dispatch = useDispatch();- useDeepCompareEffect(() => {- if (isActive) {- const query = { ...entityQuery, id: entityId };- const action = dispatch(fetch(query, { reload, requestType }));- Promise.resolve(action).catch(() => undefined);- }- }, [dispatch, fetch, entityId, entityQuery, enabled, reload, requestType]);-- return { data, isLoading: isLoadingOrDefault, error };-};diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/index.ts b/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/index.tsdeleted file mode 100644index b0005e0b915..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./use-question-list-query";diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.tsdeleted file mode 100644index f56306994fd..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.ts+++ /dev/null@@ -1,42 +0,0 @@-import { skipToken, useListCardsQuery } from "metabase/api";-import type {- UseEntityListQueryProps,- UseEntityListQueryResult,-} from "metabase/common/hooks/entity-framework/use-entity-list-query";-import { useSelector } from "metabase/redux";-import { getMetadata } from "metabase/selectors/metadata";-import type Question from "metabase-lib/v1/Question";-import type { ListCardsRequest } from "metabase-types/api";--/**- * @deprecated use "metabase/api" instead- */-export const useQuestionListQuery = ({- query,- reload = false,- enabled = true,-}: UseEntityListQueryProps<ListCardsRequest> = {}): UseEntityListQueryResult<Question> => {- const {- data: response,- isFetching,- isSuccess,- error,- } = useListCardsQuery(enabled ? (query ?? undefined) : skipToken, {- refetchOnMountOrArgChange: reload,- });- const data = useSelector((state) => {- if (!response) {- return undefined;- }- const metadata = getMetadata(state);- return response- .map(({ id }) => metadata.question(id))- .filter((question): question is Question => question != null);- });- return {- data,- isLoading: isFetching,- isLoaded: isSuccess,- error,- };-};diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.unit.spec.tsxdeleted file mode 100644index 0edcd2e128c..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-list-query/use-question-list-query.unit.spec.tsx+++ /dev/null@@ -1,59 +0,0 @@-import { setupCardsEndpoints } from "__support__/server-mocks";-import {- renderWithProviders,- screen,- waitForLoaderToBeRemoved,- within,-} from "__support__/ui";-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { createMockCard } from "metabase-types/api/mocks";--import { useQuestionListQuery } from "./use-question-list-query";--const TEST_CARD = createMockCard();--const TestComponent = () => {- const { data = [], metadata, isLoading, error } = useQuestionListQuery();-- if (isLoading || error) {- return <LoadingAndErrorWrapper loading={isLoading} error={error} />;- }-- return (- <div>- {data.map((question) => (- <div key={question.id()}>{question.displayName()}</div>- ))}-- <div data-testid="metadata">- {(!metadata || Object.keys(metadata).length === 0) && "No metadata"}- </div>- </div>- );-};--const setup = () => {- setupCardsEndpoints([TEST_CARD]);- renderWithProviders(<TestComponent />);-};--describe("useQuestionListQuery", () => {- it("should be initially loading", () => {- setup();- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();- });-- it("should show data from the response", async () => {- setup();- await waitForLoaderToBeRemoved();- expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();- });-- it("should not have any metadata in the response", async () => {- setup();- await waitForLoaderToBeRemoved();- expect(- within(screen.getByTestId("metadata")).getByText("No metadata"),- ).toBeInTheDocument();- });-});diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/index.ts b/frontend/src/metabase/common/hooks/entity-framework/use-question-query/index.tsdeleted file mode 100644index a87e38417b3..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./use-question-query";diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.tsdeleted file mode 100644index 64284401ea4..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.ts+++ /dev/null@@ -1,36 +0,0 @@-import { skipToken, useGetCardQuery } from "metabase/api";-import type {- UseEntityQueryProps,- UseEntityQueryResult,-} from "metabase/common/hooks/entity-framework/use-entity-query";-import { useSelector } from "metabase/redux";-import { getMetadata } from "metabase/selectors/metadata";-import type Question from "metabase-lib/v1/Question";-import type { CardId, GetCardRequest } from "metabase-types/api";--/**- * @deprecated use "metabase/api" instead- */-export const useQuestionQuery = ({- id,- query,- reload = false,- enabled = true,-}: UseEntityQueryProps<- CardId,- Omit<GetCardRequest, "id">->): UseEntityQueryResult<Question> => {- const isActive = enabled && id != null;- const { isFetching, error } = useGetCardQuery(- isActive ? { id, ...query } : skipToken,- { refetchOnMountOrArgChange: reload },- );- const data = useSelector((state) =>- id != null ? (getMetadata(state).question(id) ?? undefined) : undefined,- );- return {- data,- isLoading: isFetching || (isActive && data == null),- error,- };-};diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.unit.spec.tsxdeleted file mode 100644index b357ebb54c2..00000000000--- a/frontend/src/metabase/common/hooks/entity-framework/use-question-query/use-question-query.unit.spec.tsx+++ /dev/null@@ -1,42 +0,0 @@-import { setupCardsEndpoints } from "__support__/server-mocks";-import {- renderWithProviders,- screen,- waitForLoaderToBeRemoved,-} from "__support__/ui";-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { createMockCard } from "metabase-types/api/mocks";--import { useQuestionQuery } from "./use-question-query";--const TEST_CARD = createMockCard();--const TestComponent = () => {- const { data, isLoading, error } = useQuestionQuery({- id: TEST_CARD.id,- });-- if (isLoading || error || !data) {- return <LoadingAndErrorWrapper loading={isLoading} error={error} />;- }-- return <div>{data.displayName()}</div>;-};--const setup = () => {- setupCardsEndpoints([TEST_CARD]);- renderWithProviders(<TestComponent />);-};--describe("useQuestionQuery", () => {- it("should be initially loading", () => {- setup();- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();- });-- it("should show data from the response", async () => {- setup();- await waitForLoaderToBeRemoved();- expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();- });-});diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.tsindex 94e27c6b401..7bae060658d 100644--- a/frontend/src/metabase/common/hooks/index.ts+++ b/frontend/src/metabase/common/hooks/index.ts@@ -1,4 +1,3 @@-export * from "./entity-framework";export * from "./use-attached-dwh";export * from "./use-abortable-query";export * from "./use-confirmation";diff --git a/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceCardModal.tsx b/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceCardModal.tsxindex 6381785b233..af050821428 100644--- a/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceCardModal.tsx+++ b/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceCardModal.tsx@@ -1,12 +1,12 @@import { useCallback } from "react";import { t } from "ttag";+import { skipToken, useGetCardQuery } from "metabase/api";import {QuestionPickerModal,type QuestionPickerValueItem,getQuestionPickerValue,} from "metabase/common/components/Pickers/QuestionPicker";-import { useQuestionQuery } from "metabase/common/hooks";import type { Parameter, ValuesSourceConfig } from "metabase-types/api";interface ValuesSourceCardModalProps {@@ -24,11 +24,12 @@ export const ValuesSourceCardModal = ({onSubmit,onClose,}: ValuesSourceCardModalProps): JSX.Element => {- const { data: question } = useQuestionQuery({ id: sourceConfig.card_id });+ const { data: card } = useGetCardQuery(+ sourceConfig.card_id != null ? { id: sourceConfig.card_id } : skipToken,+ );const initialValue =- question &&- getQuestionPickerValue({ id: question.id(), type: question.type() });+ card && getQuestionPickerValue({ id: card.id, type: card.type });const handleSubmit = useCallback((newQuestion: QuestionPickerValueItem) => {diff --git a/frontend/src/metabase/reference/segments/SegmentQuestions.tsx b/frontend/src/metabase/reference/segments/SegmentQuestions.tsxindex d98f5f641de..123ed36b770 100644--- a/frontend/src/metabase/reference/segments/SegmentQuestions.tsx+++ b/frontend/src/metabase/reference/segments/SegmentQuestions.tsx@@ -1,9 +1,9 @@import cx from "classnames";import { t } from "ttag";+import { useListCardsQuery } from "metabase/api";import { AdminAwareEmptyState } from "metabase/common/components/AdminAwareEmptyState";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { useQuestionListQuery } from "metabase/common/hooks";import { modelIconMap } from "metabase/common/utils/icon";import CS from "metabase/css/core/index.css";import { connect } from "metabase/redux";@@ -62,13 +62,10 @@ const SegmentQuestionsInner = ({metadata,}: SegmentQuestionsInnerProps) => {const {- data = [],+ data: cards = [],isLoading,error,- } = useQuestionListQuery({- // Unjustified type cast. FIXME- query: { f: "using_segment" as any, model_id: segment.id },- });+ } = useListCardsQuery({ f: "using_segment", model_id: segment.id });return (<div style={style} className={CS.full}>@@ -78,19 +75,19 @@ const SegmentQuestionsInner = ({/><LoadingAndErrorWrapper loading={!error && isLoading} error={error}>{() =>- data.length > 0 ? (+ cards.length > 0 ? (<div className={cx(CS.wrapper, CS.wrapperTrim)}><List>- {data.map(- (question) =>- question.id() &&- question.displayName() && (+ {cards.map(+ (card) =>+ card.id &&+ card.name && (<ListItem- key={question.id()}- name={question.displayName() ?? ""}- description={getDescription(question)}- url={Urls.card(question.card())}- icon={visualizations.get(question.display())?.iconName}+ key={card.id}+ name={card.name}+ description={getDescription(card)}+ url={Urls.card(card)}+ icon={visualizations.get(card.display)?.iconName}/>),)}diff --git a/frontend/src/metabase/reference/utils.ts b/frontend/src/metabase/reference/utils.tsindex fa5eca354ad..cd19ff0f4fa 100644--- a/frontend/src/metabase/reference/utils.ts+++ b/frontend/src/metabase/reference/utils.ts@@ -135,8 +135,8 @@ export const getQuestionUrl = (getQuestionArgs: GetQuestionArgs): string => {export const has = (entity: unknown): boolean =>Array.isArray(entity) ? entity.length > 0 : Boolean(entity);-export const getDescription = (question: Question): string => {- const timestamp = dayjs(question.getCreatedAt()).fromNow();- const author = question.getCreator().common_name;+export const getDescription = (card: Card): string => {+ const timestamp = dayjs(card.created_at).fromNow();+ const author = card.creator?.common_name;return t`Created ${timestamp} by ${author}`;};