Skip to content

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

Convert metabase-lib utils to ts (#70044)

Fraser8474a8f7f55c
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index 28524f89ad3..01db6526077 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -24,7 +24,7 @@ import "metabase/plugins/builtin";
// This is conditionally aliased in the webpack config.
// If EE isn't enabled, it loads an empty file.
-// Set nonce for mantine v6 deps
+// Set CSP nonce for dynamic style injection (e.g. CodeMirror)
import "metabase/lib/csp";
import { createHistory } from "history";
diff --git a/frontend/src/metabase/common/components/ErrorPages/use-error-info.ts b/frontend/src/metabase/common/components/ErrorPages/use-error-info.ts
index 8f2cd0a4ced..d2f0d8b8693 100644
--- a/frontend/src/metabase/common/components/ErrorPages/use-error-info.ts
+++ b/frontend/src/metabase/common/components/ErrorPages/use-error-info.ts
@@ -53,7 +53,6 @@ export const useErrorInfo = (
? UtilApi.logs().catch(nullOnCatch)
: Promise.resolve(null);
- // @ts-expect-error non-standard error property
const frontendErrors = console?.errorBuffer?.map?.((errArray) =>
errArray
.map((errLine: any) => JSON.stringify(errLine, maybeSerializeError))
diff --git a/frontend/src/metabase/entities/containers/EntityCopyModal.types.ts b/frontend/src/metabase/entities/containers/EntityCopyModal.types.ts
index b8be5fb332b..1813706b592 100644
--- a/frontend/src/metabase/entities/containers/EntityCopyModal.types.ts
+++ b/frontend/src/metabase/entities/containers/EntityCopyModal.types.ts
@@ -48,7 +48,7 @@ export interface EntityCopyModalProps<T extends CopyableEntityType> {
* still being safe in practice (forms validate their own values).
*/
export interface GenericEntityCopyModalProps {
- entityType: string;
+ entityType: string | undefined;
entityObject: any;
copy: (data: any) => Promise<any>;
title?: string;
diff --git a/frontend/src/metabase/lib/auth.js b/frontend/src/metabase/lib/auth.ts
similarity index 71%
rename from frontend/src/metabase/lib/auth.js
rename to frontend/src/metabase/lib/auth.ts
index c196f790d1d..6d8e2c9a553 100644
--- a/frontend/src/metabase/lib/auth.js
+++ b/frontend/src/metabase/lib/auth.ts
@@ -1,10 +1,11 @@
+import { isResourceNotFoundError } from "metabase/lib/errors/messages";
import { SessionApi } from "metabase/services";
export const deleteSession = async () => {
try {
await SessionApi.delete();
} catch (error) {
- if (error.status !== 404) {
+ if (!isResourceNotFoundError(error)) {
console.error("Problem clearing session", error);
}
}
@@ -14,7 +15,7 @@ export const initiateSLO = async () => {
try {
return await SessionApi.slo();
} catch (error) {
- if (error.status !== 404) {
+ if (!isResourceNotFoundError(error)) {
console.error("Problem clearing session", error);
}
}
diff --git a/frontend/src/metabase/lib/csp.js b/frontend/src/metabase/lib/csp.js
deleted file mode 100644
index aa26382769f..00000000000
--- a/frontend/src/metabase/lib/csp.js
+++ /dev/null
@@ -1,13 +0,0 @@
-/**
- * setNonce is required for react-remove-scroll which adds style and can handle
- * nonce but the method we use to set nonce is not compatible with
- * react-remove-scroll it expects __webpack_nonce__ to be defined, when we
- * generate it at BE and put directly into html file. `get-nonce` is used inside
- * react-remove-scroll to get nonce, so we put it manually here.
- * react-remove-scroll is a dependency of mantine v6
- *
- * TODO: remove it when we upgrade mantine to v7
- */
-import { setNonce } from "get-nonce";
-
-setNonce(window.MetabaseNonce);
diff --git a/frontend/src/metabase/lib/csp.ts b/frontend/src/metabase/lib/csp.ts
new file mode 100644
index 00000000000..a29e41a5dde
--- /dev/null
+++ b/frontend/src/metabase/lib/csp.ts
@@ -0,0 +1,8 @@
+/**
+ * Store the CSP nonce so that libraries using `get-nonce` (e.g. CodeMirror)
+ * can read it when injecting dynamic styles. The nonce is generated server-side
+ * and placed on the window by the HTML template.
+ */
+import { setNonce } from "get-nonce";
+
+setNonce(window.MetabaseNonce ?? "");
diff --git a/frontend/src/metabase/lib/errors/console.js b/frontend/src/metabase/lib/errors/console.ts
similarity index 72%
rename from frontend/src/metabase/lib/errors/console.js
rename to frontend/src/metabase/lib/errors/console.ts
index b0b73a60746..f7164e8c285 100644
--- a/frontend/src/metabase/lib/errors/console.js
+++ b/frontend/src/metabase/lib/errors/console.ts
@@ -1,3 +1,9 @@
+declare global {
+ interface Console {
+ errorBuffer: unknown[][];
+ }
+}
+
export const MAX_ERROR_LOGS = 20;
export function captureConsoleErrors() {
@@ -5,7 +11,7 @@ export function captureConsoleErrors() {
const originalError = console.error;
- console.error = function (...args) {
+ console.error = function (...args: unknown[]) {
if (console.errorBuffer.length >= MAX_ERROR_LOGS) {
console.errorBuffer.pop();
}
diff --git a/frontend/src/metabase/lib/errors/console.unit.spec.js b/frontend/src/metabase/lib/errors/console.unit.spec.ts
similarity index 100%
rename from frontend/src/metabase/lib/errors/console.unit.spec.js
rename to frontend/src/metabase/lib/errors/console.unit.spec.ts
diff --git a/frontend/src/metabase/lib/iframe.js b/frontend/src/metabase/lib/iframe.ts
similarity index 100%
rename from frontend/src/metabase/lib/iframe.js
rename to frontend/src/metabase/lib/iframe.ts
diff --git a/frontend/src/metabase/lib/schema/schema.js b/frontend/src/metabase/lib/schema/schema.js
deleted file mode 100644
index 725c0c3f957..00000000000
--- a/frontend/src/metabase/lib/schema/schema.js
+++ /dev/null
@@ -1,23 +0,0 @@
-import { PLUGIN_ENTITIES } from "metabase/plugins";
-
-// backend returns model = "card" instead of "question"
-export const entityTypeForModel = (model) => {
- if (model === "card" || model === "dataset" || model === "metric") {
- return "questions";
- }
- if (model === "indexed-entity") {
- // handle non-standard plural πŸ™ƒ
- return "indexedEntities";
- }
- return `${model}s`;
-};
-
-export const entityTypeForObject = (object) =>
- object && entityTypeForModel(object.model);
-
-export const entityForObject = (object) => {
- const entities = require("metabase/entities");
- const enterpriseEntities = PLUGIN_ENTITIES.entities;
-
- return { ...entities, ...enterpriseEntities }[entityTypeForObject(object)];
-};
diff --git a/frontend/src/metabase/lib/schema/schema.ts b/frontend/src/metabase/lib/schema/schema.ts
new file mode 100644
index 00000000000..40ebe3a1994
--- /dev/null
+++ b/frontend/src/metabase/lib/schema/schema.ts
@@ -0,0 +1,29 @@
+import { PLUGIN_ENTITIES } from "metabase/plugins";
+
+// backend returns model = "card" instead of "question"
+export const entityTypeForModel = (model: string): string => {
+ if (model === "card" || model === "dataset" || model === "metric") {
+ return "questions";
+ }
+ if (model === "indexed-entity") {
+ // handle non-standard plural πŸ™ƒ
+ return "indexedEntities";
+ }
+ return `${model}s`;
+};
+
+export const entityTypeForObject = (
+ object?: { model: string } | null,
+): string | undefined =>
+ object ? entityTypeForModel(object.model) : undefined;
+
+export const entityForObject = (object?: { model: string } | null) => {
+ // eslint-disable-next-line @typescript-eslint/no-require-imports -- dynamic require due to circular dependencies
+ const entities = require("metabase/entities");
+ const enterpriseEntities = PLUGIN_ENTITIES.entities;
+ const entityType = entityTypeForObject(object);
+ if (!entityType) {
+ return undefined;
+ }
+ return { ...entities, ...enterpriseEntities }[entityType];
+};