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
chore: Convert schema.js to TypeScript (#79685)
Andrei Chernykh6580d359481d
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjsindex 3b7c29ce340..584ddd5b27b 100644--- a/frontend/lint/module-boundaries.mjs+++ b/frontend/lint/module-boundaries.mjs@@ -208,7 +208,7 @@ const elements = [createElement({type: "shared",name: "schema",- pattern: "frontend/src/metabase/schema.js",+ pattern: "frontend/src/metabase/schema.ts",mode: "full",enforceSharedTiers: false,}),diff --git a/frontend/src/metabase/schema.js b/frontend/src/metabase/schema.tssimilarity index 56%rename from frontend/src/metabase/schema.jsrename to frontend/src/metabase/schema.tsindex cfe182a9970..4e87e45cd7e 100644--- a/frontend/src/metabase/schema.js+++ b/frontend/src/metabase/schema.ts@@ -3,32 +3,64 @@import { schema } from "normalizr";import { entityTypeForObject } from "metabase/redux/store/entities";+import { checkNotNull } from "metabase/utils/types";import { getUniqueFieldId } from "metabase-lib/v1/metadata/utils/fields";import { SAVED_QUESTIONS_VIRTUAL_DB_ID } from "metabase-lib/v1/metadata/utils/saved-questions";import { generateSchemaId } from "metabase-lib/v1/metadata/utils/schema";+import type {+ Card,+ Collection,+ Dashboard,+ Database,+ Field,+ ForeignKey,+ Measure,+ Metric,+ NativeQuerySnippet,+ Schema,+ SchemaId,+ SchemaName,+ Segment,+ Table,+} from "metabase-types/api";++export const QuestionSchema = new schema.Entity<Card>("questions");+export const DashboardSchema = new schema.Entity<Dashboard>("dashboards");+export const CollectionSchema = new schema.Entity<Collection>("collections");++export const DatabaseSchema = new schema.Entity<Database>("databases");+export const SchemaSchema = new schema.Entity<Schema>("schemas");++type TableEntitySchema = {+ id: SchemaId;+ name: SchemaName | null;+ database: Pick<Database, "id" | "is_saved_questions">;+};-export const QuestionSchema = new schema.Entity("questions");-export const CacheConfigSchema = new schema.Entity("cacheConfigs");-export const DashboardSchema = new schema.Entity("dashboards");-export const CollectionSchema = new schema.Entity("collections");+// also accepts partial payloads (e.g. `{ id, fks }`) and already-processed tables+type TableEntityData = Partial<Omit<Table, "schema">> &+ Pick<Table, "id"> & {+ schema?: SchemaName | TableEntitySchema | null;+ schema_name?: SchemaName | null;+ original_fields?: Field[];+ };-export const DatabaseSchema = new schema.Entity("databases");-export const SchemaSchema = new schema.Entity("schemas");export const TableSchema = new schema.Entity("tables",{},{// convert "schema" returned by API as a string value to an object that can be normalized- processStrategy({ ...table }) {+ processStrategy({ ...table }: TableEntityData) {// Saved questions are represented as database tables,// and collections they're saved to as schemas// Virtual tables ID are strings like "card__45" (where 45 is a question ID)const isVirtualSchema = typeof table.id === "string";- const databaseId = isVirtualSchema- ? SAVED_QUESTIONS_VIRTUAL_DB_ID- : table.db_id;if (typeof table.schema === "string" || table.schema === null) {+ // tables with a raw string `schema` always carry `db_id`+ const databaseId = isVirtualSchema+ ? SAVED_QUESTIONS_VIRTUAL_DB_ID+ : checkNotNull(table.db_id);table.schema_name = table.schema;table.schema = {id: generateSchemaId(databaseId, table.schema_name),@@ -49,25 +81,32 @@ export const TableSchema = new schema.Entity(},);+type FieldEntityData = Partial<Field> & Pick<Field, "id">;++export type FieldEntity = FieldEntityData & { uniqueId: number | string };+export const FieldSchema = new schema.Entity("fields", undefined, {- processStrategy(field) {+ processStrategy(field: FieldEntityData): FieldEntity {const uniqueId = getUniqueFieldId(field);return {...field,uniqueId,};},- idAttribute: (field) => {- return getUniqueFieldId(field);+ idAttribute: (field: FieldEntityData) => {+ // numeric ids work as object keys at runtime; SchemaFunction declares string only+ return getUniqueFieldId(field) as string;},});-export const ForeignKeySchema = new schema.Entity("foreignKeys");-export const SegmentSchema = new schema.Entity("segments");-export const MeasureSchema = new schema.Entity("measures");-export const MetricSchema = new schema.Entity("metrics");-export const SnippetSchema = new schema.Entity("snippets");-export const SnippetCollectionSchema = new schema.Entity("snippetCollections");+export const ForeignKeySchema = new schema.Entity<ForeignKey>("foreignKeys");+export const SegmentSchema = new schema.Entity<Segment>("segments");+export const MeasureSchema = new schema.Entity<Measure>("measures");+export const MetricSchema = new schema.Entity<Metric>("metrics");+export const SnippetSchema = new schema.Entity<NativeQuerySnippet>("snippets");+export const SnippetCollectionSchema = new schema.Entity<Collection>(+ "snippetCollections",+);DatabaseSchema.define({tables: [TableSchema],@@ -111,11 +150,8 @@ MeasureSchema.define({table: TableSchema,});-CacheConfigSchema.define({});-export const ENTITIES_SCHEMA_MAP = {questions: QuestionSchema,- cacheConfigs: CacheConfigSchema,dashboards: DashboardSchema,collections: CollectionSchema,segments: SegmentSchema,@@ -127,7 +163,8 @@ export const ENTITIES_SCHEMA_MAP = {export const ObjectUnionSchema = new schema.Union(ENTITIES_SCHEMA_MAP,- (object, parent, key) => entityTypeForObject(object),+ // undefined (unknown model) just leaves the value unnormalized at runtime+ (object: { model: string }) => entityTypeForObject(object) as string,);CollectionSchema.define({diff --git a/frontend/src/metabase/selectors/metadata.ts b/frontend/src/metabase/selectors/metadata.tsindex 5b69aab70e5..34217e05622 100644--- a/frontend/src/metabase/selectors/metadata.ts+++ b/frontend/src/metabase/selectors/metadata.ts@@ -2,7 +2,7 @@ import { createSelector } from "@reduxjs/toolkit";import { normalize } from "normalizr";import type { State } from "metabase/redux/store";-import { FieldSchema } from "metabase/schema";+import { type FieldEntity, FieldSchema } from "metabase/schema";import { getSettings } from "metabase/settings";import Question from "metabase-lib/v1/Question";import Database from "metabase-lib/v1/metadata/Database";@@ -349,7 +349,11 @@ function hydrateTableFields(entityTable: Table, metadata: Metadata): Field[] {}return apiTable.original_fields.map((apiField) => {- const { entities, result } = normalize(apiField, FieldSchema);+ // normalizing a single field always stores it under `result`+ const { entities, result } = normalize<+ FieldEntity,+ Pick<State["entities"], "fields">+ >(apiField, FieldSchema);const normalizedField = entities.fields?.[result];return createField(normalizedField, metadata);});