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
Nick/uxw 3030 metadata info specs (#74285)
Nick Fitzpatrickd49765a06126
diff --git a/frontend/src/metabase-lib/query/types.ts b/frontend/src/metabase-lib/query/types.tsindex e645cf59eee..a82a58d4b3a 100644--- a/frontend/src/metabase-lib/query/types.ts+++ b/frontend/src/metabase-lib/query/types.ts@@ -222,16 +222,16 @@ export type TextFingerprintDisplayInfo = {percentUrl: number;};-// We're setting the values here as unknown even though-// the API will return numbers most of the time, because-// sometimes it doesn't!+// Properties are typed as optional unknown: the API returns numbers most of+// the time but sometimes returns non-numbers, and sometimes omits the property+// entirely.export type NumberFingerprintDisplayInfo = {- avg: unknown;- max: unknown;- min: unknown;- q1: unknown;- q3: unknown;- sd: unknown;+ avg?: unknown;+ max?: unknown;+ min?: unknown;+ q1?: unknown;+ q3?: unknown;+ sd?: unknown;};export type DateTimeFingerprintDisplayInfo = {diff --git a/frontend/src/metabase-types/api/field.ts b/frontend/src/metabase-types/api/field.tsindex d6bb097bd73..a1c01dbaa79 100644--- a/frontend/src/metabase-types/api/field.ts+++ b/frontend/src/metabase-types/api/field.ts@@ -29,12 +29,12 @@ export type TextFieldFingerprint = {};export type NumberFieldFingerprint = {- avg: number;- max: number;- min: number;- q1: number;- q3: number;- sd: number;+ avg?: number;+ max?: number;+ min?: number;+ q1?: number;+ q3?: number;+ sd?: number;};export type DateTimeFieldFingerprint = {diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.js b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.tsxsimilarity index 86%rename from frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.jsrename to frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.tsxindex 38ab84c389a..bf49fad88eb 100644--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.js+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.unit.spec.tsx@@ -2,6 +2,7 @@ import { createMockEntitiesState } from "__support__/store";import { renderWithProviders, screen } from "__support__/ui";import { createMockState } from "metabase/redux/store/mocks";import { getMetadata } from "metabase/selectors/metadata";+import type Field from "metabase-lib/v1/metadata/Field";import {PRODUCTS,createSampleDatabase,@@ -16,21 +17,20 @@ const state = createMockState({});const metadata = getMetadata(state);-function setup(field) {+function setup(field: Field, timezone?: string) {return renderWithProviders(<div data-testid="container">- <TableColumnFingerprintInfo- field={field}- timezone={field.table?.database?.timezone}- />+ <TableColumnFingerprintInfo field={field} timezone={timezone} /></div>,{ storeInitialState: state },);}describe("FieldFingerprintInfo", () => {+ const dateField = metadata.field(PRODUCTS.CREATED_AT)!;+describe("without fingerprint", () => {- const field = metadata.field(PRODUCTS.CREATED_AT).clone();+ const field = dateField.clone();delete field.fingerprint;@@ -41,8 +41,6 @@ describe("FieldFingerprintInfo", () => {});describe("Date field", () => {- const dateField = metadata.field(PRODUCTS.CREATED_AT);-describe("without type/DateTime fingerprint", () => {const field = dateField.clone();field.fingerprint = { type: {} };@@ -63,31 +61,27 @@ describe("FieldFingerprintInfo", () => {},},};- field.table = {- database: {- timezone: "America/Los_Angeles",- },- };+ const timezone = "America/Los_Angeles";it("should show the timezone of the field", () => {- setup(field);+ setup(field, timezone);expect(screen.getByText("America/Los_Angeles")).toBeVisible();});it("should render formatted earliest time", () => {- setup(field);+ setup(field, timezone);expect(screen.getByText("November 9, 2021, 4:43 AM")).toBeVisible();});it("should render formatted latest time", () => {- setup(field);+ setup(field, timezone);expect(screen.getByText("December 9, 2021, 4:43 AM")).toBeVisible();});});});describe("Number field", () => {- const numberField = metadata.field(PRODUCTS.RATING).clone();+ const numberField = metadata.field(PRODUCTS.RATING)!.clone();numberField.semantic_type = null;@@ -168,15 +162,13 @@ describe("FieldFingerprintInfo", () => {});describe("Other field types", () => {- const idField = metadata.field(PRODUCTS.ID);+ const idField = metadata.field(PRODUCTS.ID)!;const field = idField.clone();field.fingerprint = {- type: {- global: {- "distinct-count": 123,- },- "type/ID": {},+ global: {+ "distinct-count": 123,},+ type: {},};it("should render nothing", () => {diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.js b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.tsxsimilarity index 80%rename from frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.jsrename to frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.tsxindex 19f326b5f79..3a20edb6ba6 100644--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.js+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/GlobalFingerprint.unit.spec.tsx@@ -2,7 +2,7 @@ import { setupFieldValuesEndpoint } from "__support__/server-mocks";import { createMockEntitiesState } from "__support__/store";import { renderWithProviders, screen } from "__support__/ui";import { createMockState } from "metabase/redux/store/mocks";-import { getMetadata } from "metabase/selectors/metadata";+import type { FieldId } from "metabase-types/api";import {PEOPLE,PRODUCTS,@@ -18,22 +18,18 @@ const state = createMockState({}),});-function setup({ field }) {+function setup(fieldId: FieldId) {setupFieldValuesEndpoint(PRODUCT_CATEGORY_VALUES);- renderWithProviders(<GlobalFingerprint fieldId={field.id} />, {+ renderWithProviders(<GlobalFingerprint fieldId={fieldId} />, {storeInitialState: state,});}describe("GlobalFingerprint", () => {- const metadata = getMetadata(state);-describe("when the field does not have a `has_field_values` value of 'list'", () => {- const field = metadata.field(PEOPLE.ADDRESS);-it("should not fetch field values when field values are empty", () => {- setup({ field });+ setup(PEOPLE.ADDRESS);expect(screen.queryByText("Getting distinct values..."),).not.toBeInTheDocument();@@ -42,10 +38,8 @@ describe("GlobalFingerprint", () => {});describe("when the field has a `has_field_values` value of 'list'", () => {- const field = metadata.field(PRODUCTS.CATEGORY);-it("should fetch field values when field values are empty", async () => {- setup({ field });+ setup(PRODUCTS.CATEGORY);expect(screen.getByText("Getting distinct values..."),@@ -55,7 +49,7 @@ describe("GlobalFingerprint", () => {});it("should not throw an error when the field cannot be found", () => {- setup({ field: { id: 99942 } });+ setup(99942);expect(screen.queryByText("Getting distinct values..."),).not.toBeInTheDocument();diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/NumberFingerprint.unit.spec.tsx b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/NumberFingerprint.unit.spec.tsxindex 1c1f4baff8e..dca3ed37d28 100644--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/NumberFingerprint.unit.spec.tsx+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/NumberFingerprint.unit.spec.tsx@@ -4,21 +4,11 @@ import type * as Lib from "metabase-lib";import { NumberFingerprint } from "./NumberFingerprint";type SetupOpts = {- fingerprintTypeInfo?: {- avg: unknown;- min: unknown;- max: unknown;- };+ fingerprintTypeInfo?: Lib.NumberFingerprintDisplayInfo;};function setup({ fingerprintTypeInfo }: SetupOpts) {- render(- <NumberFingerprint- fingerprintTypeInfo={- fingerprintTypeInfo as Lib.NumberFingerprintDisplayInfo- }- />,- );+ render(<NumberFingerprint fingerprintTypeInfo={fingerprintTypeInfo} />);}describe("NumberFingerprint", () => {diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.js b/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.tsxsimilarity index 84%rename from frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.jsrename to frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.tsxindex c8c7340235c..2e10ecb503e 100644--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.js+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.unit.spec.tsx@@ -9,6 +9,7 @@ import {SAMPLE_PROVIDER,columnFinder,} from "metabase-lib/test-helpers";+import type Field from "metabase-lib/v1/metadata/Field";import {PRODUCTS,PRODUCT_CATEGORY_VALUES,@@ -25,14 +26,14 @@ const state = createMockState({const metadata = getMetadata(state);-function setup(field) {+function setup(field: Field) {setupFieldsValuesEndpoints([PRODUCT_CATEGORY_VALUES]);return renderWithProviders(<TableColumnInfo field={field} />, {storeInitialState: state,});}-function setupLib(table, column) {+function setupLib(table: string, column: string) {const query = Lib.createTestQuery(SAMPLE_PROVIDER, DEFAULT_TEST_QUERY);const columns = Lib.visibleColumns(query, 0);const findColumn = columnFinder(query, columns);@@ -44,23 +45,25 @@ function setupLib(table, column) {}describe("FieldInfo", () => {+ const categoryField = metadata.field(PRODUCTS.CATEGORY)!;+ const createdAtField = metadata.field(PRODUCTS.CREATED_AT)!;+it("should show the given dimension's semantic type name", async () => {- const field = metadata.field(PRODUCTS.CATEGORY);- setup(field);+ setup(categoryField);expect(await screen.findByText("Category")).toBeInTheDocument();});it("should display the given dimension's description", async () => {- const field = metadata.field(PRODUCTS.CATEGORY);- setup(field);+ setup(categoryField);- expect(await screen.findByText(field.description)).toBeInTheDocument();+ expect(+ await screen.findByText(categoryField.description!),+ ).toBeInTheDocument();});it("should show a placeholder for a dimension with no description", () => {- const field = metadata.field(PRODUCTS.CREATED_AT);- setup(field);+ setup(createdAtField);expect(screen.getByText("No description")).toBeInTheDocument();});diff --git a/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.js b/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsxsimilarity index 90%rename from frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.jsrename to frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsxindex d49076488ef..9c2017ce63b 100644--- a/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.js+++ b/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsx@@ -17,13 +17,13 @@ const state = createMockState({});const metadata = getMetadata(state);-function setup(semanticType) {+function setup(semanticType: string | null | undefined) {return renderWithProviders(<SemanticTypeLabel semanticType={semanticType} />);}describe("SemanticTypeLabel", () => {describe("given a dimension with a semantic type", () => {- const field = metadata.field(PRODUCTS.CREATED_AT);+ const field = metadata.field(PRODUCTS.CREATED_AT)!;it("should show an icon corresponding to the given semantic type", () => {setup(field.semantic_type);@@ -37,7 +37,7 @@ describe("SemanticTypeLabel", () => {});describe("given a dimension without a semantic type", () => {- const field = metadata.field(ORDERS.TAX);+ const field = metadata.field(ORDERS.TAX)!;it("should show an ellipsis icon representing the lack of semantic type", () => {setup(field.semantic_type);