Skip to content

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

Convert `lib/schema_metadata` to TypeScript (#69425)

Fraser801720f07757
diff --git a/frontend/src/metabase/lib/schema_metadata.js b/frontend/src/metabase/lib/schema_metadata.js
deleted file mode 100644
index 67f8a903d8f..00000000000
--- a/frontend/src/metabase/lib/schema_metadata.js
+++ /dev/null
@@ -1,31 +0,0 @@
-import { FIELD_SEMANTIC_TYPES_MAP } from "metabase/lib/core";
-
-export function foreignKeyCountsByOriginTable(fks) {
- if (fks === null || !Array.isArray(fks)) {
- return null;
- }
-
- return fks
- .map(function (fk) {
- return "origin" in fk ? fk.origin.table.id : null;
- })
- .reduce(function (prev, curr, idx, array) {
- if (curr in prev) {
- prev[curr]++;
- } else {
- prev[curr] = 1;
- }
-
- return prev;
- }, {});
-}
-
-export function getSemanticTypeIcon(semanticType, fallback) {
- const semanticTypeMetadata = FIELD_SEMANTIC_TYPES_MAP[semanticType];
- return semanticTypeMetadata?.icon ?? fallback;
-}
-
-export function getSemanticTypeName(semanticType) {
- const semanticTypeMetadata = FIELD_SEMANTIC_TYPES_MAP[semanticType];
- return semanticTypeMetadata?.name;
-}
diff --git a/frontend/src/metabase/lib/schema_metadata.ts b/frontend/src/metabase/lib/schema_metadata.ts
new file mode 100644
index 00000000000..4540433af9d
--- /dev/null
+++ b/frontend/src/metabase/lib/schema_metadata.ts
@@ -0,0 +1,40 @@
+import { FIELD_SEMANTIC_TYPES_MAP } from "metabase/lib/core";
+import type { IconName } from "metabase/ui";
+import type ForeignKey from "metabase-lib/v1/metadata/ForeignKey";
+
+export function foreignKeyCountsByOriginTable(fks: ForeignKey[]) {
+ return fks
+ .map(function (fk) {
+ return fk.origin?.table?.id ?? undefined;
+ })
+ .reduce<Record<number | string, number>>(function (prev, curr) {
+ if (curr !== undefined) {
+ if (curr in prev) {
+ prev[curr]++;
+ } else {
+ prev[curr] = 1;
+ }
+ }
+
+ return prev;
+ }, {});
+}
+
+export function getSemanticTypeIcon(
+ semanticType: string | null | undefined,
+ fallback?: IconName,
+): IconName | undefined {
+ if (!semanticType) {
+ return fallback;
+ }
+ const semanticTypeMetadata = FIELD_SEMANTIC_TYPES_MAP[semanticType];
+ return semanticTypeMetadata?.icon ?? fallback;
+}
+
+export function getSemanticTypeName(semanticType: string | null | undefined) {
+ if (!semanticType) {
+ return undefined;
+ }
+ const semanticTypeMetadata = FIELD_SEMANTIC_TYPES_MAP[semanticType];
+ return semanticTypeMetadata?.name;
+}
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index d7ead41afe4..70e6d54c303 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -610,7 +610,7 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
[DatasetEditorS.isSelected]: isSelected,
})}
size={14}
- name={getSemanticTypeIcon(column.semantic_type, "ellipsis")}
+ name={getSemanticTypeIcon(column.semantic_type) ?? "ellipsis"}
/>
<span>{column.display_name}</span>
</Flex>
diff --git a/frontend/test/metabase/lib/schema_metadata.unit.spec.ts b/frontend/test/metabase/lib/schema_metadata.unit.spec.ts
index bba47b88611..fb6b4261f64 100644
--- a/frontend/test/metabase/lib/schema_metadata.unit.spec.ts
+++ b/frontend/test/metabase/lib/schema_metadata.unit.spec.ts
@@ -3,18 +3,11 @@ import {
getSemanticTypeIcon,
getSemanticTypeName,
} from "metabase/lib/schema_metadata";
+import type ForeignKey from "metabase-lib/v1/metadata/ForeignKey";
import { TYPE } from "metabase-lib/v1/types/constants";
describe("schema_metadata", () => {
describe("foreignKeyCountsByOriginTable", () => {
- it("should work with null input", () => {
- expect(foreignKeyCountsByOriginTable(null)).toEqual(null);
- });
-
- it("should require an array as input", () => {
- expect(foreignKeyCountsByOriginTable({})).toEqual(null);
- });
-
it("should count occurrences by origin.table.id", () => {
expect(
foreignKeyCountsByOriginTable([
@@ -22,7 +15,7 @@ describe("schema_metadata", () => {
{ origin: { table: { id: 123 } } },
{ origin: { table: { id: 123 } } },
{ origin: { table: { id: 456 } } },
- ]),
+ ] as ForeignKey[]),
).toEqual({ 123: 3, 456: 1 });
});
});