Skip to content

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

Convert browse tables to ts (#72810)

Ryan Laurie9e349ef44f8a
diff --git a/frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.jsx b/frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.jsx
deleted file mode 100644
index d0fba9d95cb..00000000000
--- a/frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.jsx
+++ /dev/null
@@ -1,59 +0,0 @@
-import _ from "underscore";
-
-import { Tables } from "metabase/entities/tables";
-import { getMetadata } from "metabase/selectors/metadata";
-import { getSetting } from "metabase/selectors/settings";
-import { connect } from "metabase/utils/redux";
-import { isSyncInProgress } from "metabase/utils/syncing";
-import * as Urls from "metabase/utils/urls";
-import { SAVED_QUESTIONS_VIRTUAL_DB_ID } from "metabase-lib/v1/metadata/utils/saved-questions";
-import * as ML_Urls from "metabase-lib/v1/urls";
-
-import { RELOAD_INTERVAL } from "../../constants";
-import TableBrowser from "../../tables/TableBrowser";
-
-const getDatabaseId = (props, { includeVirtual } = {}) => {
- const { params } = props;
- const dbId =
- parseInt(props.dbId) ||
- parseInt(params.dbId) ||
- Urls.extractEntityId(params.slug);
-
- if (!Number.isSafeInteger(dbId)) {
- return undefined;
- } else if (dbId === SAVED_QUESTIONS_VIRTUAL_DB_ID && !includeVirtual) {
- return undefined;
- } else {
- return dbId;
- }
-};
-
-const getSchemaName = (props) => {
- return props.schemaName || props.params.schemaName;
-};
-
-const getReloadInterval = (_state, _props, tables = []) =>
- tables.some((t) => isSyncInProgress(t)) ? RELOAD_INTERVAL : 0;
-
-export const getTableUrl = (table, metadata) => {
- const metadataTable = metadata?.table(table.id);
- return ML_Urls.getUrl(metadataTable?.newQuestion(), { clean: false });
-};
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(
- Tables.loadList({
- query: (state, props) => ({
- dbId: getDatabaseId(props, { includeVirtual: true }),
- schemaName: getSchemaName(props),
- }),
- reloadInterval: getReloadInterval,
- }),
- connect((state, props) => ({
- dbId: getDatabaseId(props, { includeVirtual: true }),
- schemaName: getSchemaName(props),
- metadata: getMetadata(state),
- xraysEnabled: getSetting(state, "enable-xrays"),
- getTableUrl,
- })),
-)(TableBrowser);
diff --git a/frontend/src/metabase/browse/containers/TableBrowser/index.ts b/frontend/src/metabase/browse/containers/TableBrowser/index.ts
deleted file mode 100644
index 3809193d462..00000000000
--- a/frontend/src/metabase/browse/containers/TableBrowser/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export { default } from "./TableBrowser";
diff --git a/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx b/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
index 24d1ba55bad..4f7a0e24ea7 100644
--- a/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
+++ b/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
@@ -1,7 +1,7 @@
import cx from "classnames";
import { t } from "ttag";
-import TableBrowser from "metabase/browse/containers/TableBrowser";
+import { TableBrowser } from "metabase/browse/tables/TableBrowser";
import { BrowserCrumbs } from "metabase/common/components/BrowserCrumbs";
import CS from "metabase/css/core/index.css";
import { Databases } from "metabase/entities/databases";
diff --git a/frontend/src/metabase/browse/tables/BrowseTables.tsx b/frontend/src/metabase/browse/tables/BrowseTables.tsx
index 7b3d60cf73a..8936e7ad10d 100644
--- a/frontend/src/metabase/browse/tables/BrowseTables.tsx
+++ b/frontend/src/metabase/browse/tables/BrowseTables.tsx
@@ -2,7 +2,8 @@ import { Flex } from "metabase/ui";
import S from "../components/BrowseContainer.module.css";
import { BrowseDataHeader } from "../components/BrowseDataHeader";
-import TableBrowser from "../containers/TableBrowser";
+
+import { TableBrowser } from "./TableBrowser";
export const BrowseTables = ({
params: { dbId, schemaName },
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.tsx b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.tsx
new file mode 100644
index 00000000000..30247e586c4
--- /dev/null
+++ b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.tsx
@@ -0,0 +1,80 @@
+import _ from "underscore";
+
+import { Tables } from "metabase/entities/tables";
+import type { State } from "metabase/redux/store";
+import { getMetadata } from "metabase/selectors/metadata";
+import { getSetting } from "metabase/selectors/settings";
+import { connect } from "metabase/utils/redux";
+import { isSyncInProgress } from "metabase/utils/syncing";
+import * as Urls from "metabase/utils/urls";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import { SAVED_QUESTIONS_VIRTUAL_DB_ID } from "metabase-lib/v1/metadata/utils/saved-questions";
+import * as ML_Urls from "metabase-lib/v1/urls";
+import type { DatabaseId, Table } from "metabase-types/api";
+
+import { RELOAD_INTERVAL } from "../../constants";
+
+import { TableBrowserInner } from "./TableBrowserInner";
+
+type RouteParams = {
+ dbId?: string;
+ schemaName?: string;
+ slug?: string;
+};
+
+type TableBrowserContainerProps = {
+ dbId?: DatabaseId | string;
+ schemaName?: string;
+ params?: RouteParams;
+};
+
+const getDatabaseId = (
+ props: TableBrowserContainerProps,
+ { includeVirtual = false }: { includeVirtual?: boolean } = {},
+): DatabaseId | undefined => {
+ const { params } = props;
+ const dbId =
+ parseInt(String(props.dbId)) ||
+ parseInt(String(params?.dbId)) ||
+ Urls.extractEntityId(params?.slug);
+
+ if (!Number.isSafeInteger(dbId)) {
+ return undefined;
+ } else if (dbId === SAVED_QUESTIONS_VIRTUAL_DB_ID && !includeVirtual) {
+ return undefined;
+ } else {
+ return dbId as DatabaseId;
+ }
+};
+
+const getSchemaName = (props: TableBrowserContainerProps): string | undefined =>
+ props.schemaName ?? props.params?.schemaName;
+
+const getReloadInterval = (
+ _state: State,
+ _props: TableBrowserContainerProps,
+ tables: Table[] = [],
+): number => (tables.some((t) => isSyncInProgress(t)) ? RELOAD_INTERVAL : 0);
+
+export const getTableUrl = (table: Table, metadata?: Metadata): string => {
+ const metadataTable = metadata?.table(table.id);
+ const question = metadataTable?.newQuestion();
+ return question ? ML_Urls.getUrl(question) : "";
+};
+
+export const TableBrowser = _.compose(
+ Tables.loadList({
+ query: (_state: State, props: TableBrowserContainerProps) => ({
+ dbId: getDatabaseId(props, { includeVirtual: true }),
+ schemaName: getSchemaName(props),
+ }),
+ reloadInterval: getReloadInterval,
+ }),
+ connect((state: State, props: TableBrowserContainerProps) => ({
+ dbId: getDatabaseId(props, { includeVirtual: true }),
+ schemaName: getSchemaName(props),
+ metadata: getMetadata(state),
+ xraysEnabled: getSetting(state, "enable-xrays"),
+ getTableUrl,
+ })),
+)(TableBrowserInner);
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.js b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.js
deleted file mode 100644
index 63711a0fa88..00000000000
--- a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.js
+++ /dev/null
@@ -1,43 +0,0 @@
-import { setupDatabaseEndpoints } from "__support__/server-mocks";
-import { renderWithProviders, screen } from "__support__/ui";
-import { createMockDatabase } from "metabase-types/api/mocks";
-
-import TableBrowser from "./TableBrowser";
-
-const setup = (table) => {
- setupDatabaseEndpoints(createMockDatabase());
- renderWithProviders(
- <TableBrowser
- tables={[table]}
- dbId={1}
- getTableUrl={() => `/question/${table.id}`}
- xraysEnabled={true}
- />,
- );
-};
-
-describe("TableBrowser", () => {
- it("should render synced tables", () => {
- setup({ id: 1, name: "Orders", initial_sync_status: "complete" });
-
- expect(screen.getByText("Orders")).toBeInTheDocument();
- expect(screen.getByLabelText("bolt icon")).toBeInTheDocument();
- expect(screen.queryByTestId("loading-indicator")).not.toBeInTheDocument();
- });
-
- it("should render syncing tables", () => {
- setup({ id: 1, name: "Orders", initial_sync_status: "incomplete" });
-
- expect(screen.getByText("Orders")).toBeInTheDocument();
- expect(screen.queryByLabelText("bolt icon")).not.toBeInTheDocument();
- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
- });
-
- it("should render tables with a sync error", () => {
- setup({ id: 1, name: "Orders", initial_sync_status: "aborted" });
-
- expect(screen.getByText("Orders")).toBeInTheDocument();
- expect(screen.getByLabelText("bolt icon")).toBeInTheDocument();
- expect(screen.queryByTestId("loading-indicator")).not.toBeInTheDocument();
- });
-});
diff --git a/frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.unit.spec.js b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.tsx
similarity index 93%
rename from frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.unit.spec.js
rename to frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.tsx
index 03c470d81f1..aaf5de5db4d 100644
--- a/frontend/src/metabase/browse/containers/TableBrowser/TableBrowser.unit.spec.js
+++ b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.unit.spec.tsx
@@ -7,9 +7,7 @@ import {
waitForLoaderToBeRemoved,
} from "__support__/ui";
-// import { RELOAD_INTERVAL } from "../../constants";
-
-import TableBrowser from "./TableBrowser";
+import { TableBrowser } from "./TableBrowser";
describe("TableBrowser", () => {
it("should poll until tables have completed initial sync", async () => {
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowserInner.tsx
similarity index 78%
rename from frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx
rename to frontend/src/metabase/browse/tables/TableBrowser/TableBrowserInner.tsx
index 7799df4356e..071ec2346f4 100644
--- a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx
+++ b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowserInner.tsx
@@ -1,5 +1,4 @@
import cx from "classnames";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { BrowseCard } from "metabase/browse/components/BrowseCard";
@@ -13,7 +12,14 @@ import { getUserIsAdmin } from "metabase/selectors/user";
import { ActionIcon, Flex, Group, Icon, Loader, Paper } from "metabase/ui";
import { useSelector } from "metabase/utils/redux";
import { isSyncInProgress } from "metabase/utils/syncing";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
import { isVirtualCardId } from "metabase-lib/v1/metadata/utils/saved-questions";
+import type {
+ ConcreteTableId,
+ Database,
+ DatabaseId,
+ Table,
+} from "metabase-types/api";
import {
trackBrowseXRayClicked,
@@ -24,17 +30,19 @@ import {
import S from "./TableBrowser.module.css";
import { useDatabaseCrumb } from "./useDatabaseCrumb";
-const propTypes = {
- tables: PropTypes.array.isRequired,
- getTableUrl: PropTypes.func.isRequired,
- metadata: PropTypes.object,
- dbId: PropTypes.number,
- schemaName: PropTypes.string,
- xraysEnabled: PropTypes.bool,
- showSchemaInHeader: PropTypes.bool,
+type GetTableUrl = (table: Table, metadata?: Metadata) => string;
+
+type TableBrowserProps = {
+ tables: Table[];
+ getTableUrl: GetTableUrl;
+ metadata?: Metadata;
+ dbId: DatabaseId;
+ schemaName?: string;
+ xraysEnabled?: boolean;
+ showSchemaInHeader?: boolean;
};
-export const TableBrowser = ({
+export const TableBrowserInner = ({
tables,
getTableUrl,
metadata,
@@ -42,15 +50,15 @@ export const TableBrowser = ({
schemaName,
xraysEnabled,
showSchemaInHeader = true,
-}) => {
+}: TableBrowserProps) => {
const databases = useSelector(getDatabases);
const database = databases[dbId];
const isAdmin = useSelector(getUserIsAdmin);
const databaseCrumb = useDatabaseCrumb(dbId);
const canEditTables =
- database &&
+ !!database &&
isAdmin &&
- PLUGIN_TABLE_EDITING.isDatabaseTableEditingEnabled(database);
+ PLUGIN_TABLE_EDITING.isDatabaseTableEditingEnabled(database as Database);
return (
<>
@@ -59,7 +67,7 @@ export const TableBrowser = ({
crumbs={[
{ title: t`Databases`, to: "/browse/databases" },
databaseCrumb,
- showSchemaInHeader && { title: schemaName },
+ ...(showSchemaInHeader ? [{ title: schemaName }] : []),
]}
/>
</Flex>
@@ -80,15 +88,13 @@ export const TableBrowser = ({
);
};
-TableBrowser.propTypes = propTypes;
-
-const itemPropTypes = {
- table: PropTypes.object.isRequired,
- dbId: PropTypes.number,
- xraysEnabled: PropTypes.bool,
- metadata: PropTypes.object,
- getTableUrl: PropTypes.func.isRequired,
- canEditTables: PropTypes.bool,
+type TableBrowserItemProps = {
+ table: Table;
+ dbId: DatabaseId;
+ xraysEnabled?: boolean;
+ metadata?: Metadata;
+ getTableUrl: GetTableUrl;
+ canEditTables?: boolean;
};
const TableBrowserItem = ({
@@ -98,7 +104,7 @@ const TableBrowserItem = ({
metadata,
getTableUrl,
canEditTables,
-}) => {
+}: TableBrowserItemProps) => {
const isVirtual = isVirtualCardId(table.id);
const isLoading = isSyncInProgress(table);
const isTableWritable = table.is_writable;
@@ -108,13 +114,13 @@ const TableBrowserItem = ({
to={!isSyncInProgress(table) ? getTableUrl(table, metadata) : ""}
icon="table"
title={table.display_name || table.name}
- onClick={() => trackTableClick(table.id)}
+ onClick={() => trackTableClick(table.id as ConcreteTableId)}
>
<>
{isLoading && <Loader size="xs" data-testid="loading-indicator" />}
{!isLoading && !isVirtual && (
<TableBrowserItemButtons
- tableId={table.id}
+ tableId={table.id as ConcreteTableId}
dbId={dbId}
xraysEnabled={xraysEnabled}
canEditTables={canEditTables && isTableWritable}
@@ -125,13 +131,11 @@ const TableBrowserItem = ({
);
};
-TableBrowserItem.propTypes = itemPropTypes;
-
-const itemButtonsPropTypes = {
- tableId: PropTypes.number,
- dbId: PropTypes.number,
- xraysEnabled: PropTypes.bool,
- canEditTables: PropTypes.bool,
+type TableBrowserItemButtonsProps = {
+ tableId: ConcreteTableId;
+ dbId: DatabaseId;
+ xraysEnabled?: boolean;
+ canEditTables?: boolean;
};
const TableBrowserItemButtons = ({
@@ -139,7 +143,7 @@ const TableBrowserItemButtons = ({
dbId,
xraysEnabled,
canEditTables,
-}) => {
+}: TableBrowserItemButtonsProps) => {
const handleEditTableClicked = () => {
trackEditDataButtonClicked(tableId);
};
@@ -188,8 +192,3 @@ const TableBrowserItemButtons = ({
</Paper>
);
};
-
-TableBrowserItemButtons.propTypes = itemButtonsPropTypes;
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default TableBrowser;
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/index.ts b/frontend/src/metabase/browse/tables/TableBrowser/index.ts
index 3809193d462..34e56e7cb9a 100644
--- a/frontend/src/metabase/browse/tables/TableBrowser/index.ts
+++ b/frontend/src/metabase/browse/tables/TableBrowser/index.ts
@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export { default } from "./TableBrowser";
+export * from "./TableBrowser";