Skip to content

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

Convert embedding SDK shared files to TypeScript (#72521)

Timofey Kachalov80671e664339
diff --git a/frontend/build/shared/rspack/resolve-aliases.js b/frontend/build/shared/rspack/resolve-aliases.js
index 2413274e229..8853179ebef 100644
--- a/frontend/build/shared/rspack/resolve-aliases.js
+++ b/frontend/build/shared/rspack/resolve-aliases.js
@@ -28,7 +28,7 @@ const E2E_PATH = ROOT_PATH + "/e2e";
const isDevMode = IS_DEV_MODE;
-const resolveEnterprisePathOrNoop = (subpath) =>
+const resolveEnterprisePathOrNoop = (/** @type {string} */ subpath) =>
process.env.MB_EDITION === "ee"
? ENTERPRISE_SRC_PATH + subpath
: SRC_PATH + "/utils/noop";
diff --git a/frontend/src/embedding-sdk-shared/.storybook/main.js b/frontend/src/embedding-sdk-shared/.storybook/main.ts
similarity index 64%
rename from frontend/src/embedding-sdk-shared/.storybook/main.js
rename to frontend/src/embedding-sdk-shared/.storybook/main.ts
index c6ad94af8f6..8dcd5b094a3 100644
--- a/frontend/src/embedding-sdk-shared/.storybook/main.js
+++ b/frontend/src/embedding-sdk-shared/.storybook/main.ts
@@ -1,26 +1,81 @@
-/* eslint-disable import/no-commonjs */
+import fs from "fs";
+import path from "path";
-const fs = require("fs");
-const path = require("path");
+import type { StorybookConfig } from "@storybook/react-webpack5";
+import MiniCssExtractPlugin from "mini-css-extract-plugin";
+import webpack, { type Configuration } from "webpack";
-const MiniCssExtractPlugin = require("mini-css-extract-plugin");
-const webpack = require("webpack");
-
-const {
- getBuildInfoValues,
-} = require("build-configs/embedding-sdk/rspack/get-build-info-values");
+import { getBuildInfoValues } from "build-configs/embedding-sdk/rspack/get-build-info-values";
const { isEmbeddingSdkPackageInstalled, embeddingSdkPackageVersion } =
resolveEmbeddingSdkPackage();
-// eslint-disable-next-line no-undef
const rootRepoPath = path.resolve(__dirname, "../../../../");
-const appConfig = require(
+// eslint-disable-next-line @typescript-eslint/no-require-imports -- dynamic path, cannot use static import
+const appConfig: Configuration = require(
path.resolve(rootRepoPath, "rspack.embedding-sdk-bundle.config"),
);
-module.exports = {
+type ModuleRule = NonNullable<
+ NonNullable<Configuration["module"]>["rules"]
+>[number];
+
+const isCSSRule = (rule: ModuleRule): boolean =>
+ typeof rule === "object" &&
+ rule !== null &&
+ rule.test?.toString() === "/\\.css$/";
+
+const isSvgRule = (rule: ModuleRule): boolean =>
+ typeof rule === "object" &&
+ rule !== null &&
+ rule.test instanceof RegExp &&
+ rule.test.test(".svg");
+
+interface ResolvedSdkPackage {
+ isEmbeddingSdkPackageInstalled: boolean;
+ embeddingSdkPackageVersion: string;
+}
+
+function resolveEmbeddingSdkPackage(): ResolvedSdkPackage {
+ let isEmbeddingSdkPackageInstalled = false;
+ let embeddingSdkPackageVersion: string;
+
+ try {
+ const packagePath = require.resolve("@metabase/embedding-sdk-react");
+ if (packagePath.includes("node_modules")) {
+ isEmbeddingSdkPackageInstalled = true;
+ }
+
+ const packageJsonContent = fs.readFileSync(
+ path.join(packagePath, "package.json"),
+ "utf-8",
+ );
+ embeddingSdkPackageVersion = JSON.stringify(
+ (JSON.parse(packageJsonContent) as { version: string }).version,
+ );
+ } catch {
+ const sdkPackageTemplateJson = fs.readFileSync(
+ path.resolve(
+ "./enterprise/frontend/src/embedding-sdk-package/package.template.json",
+ ),
+ "utf-8",
+ );
+ const sdkPackageTemplateJsonContent = JSON.parse(
+ sdkPackageTemplateJson,
+ ) as { version: string };
+ embeddingSdkPackageVersion = JSON.stringify(
+ sdkPackageTemplateJsonContent.version,
+ );
+ }
+
+ return {
+ isEmbeddingSdkPackageInstalled,
+ embeddingSdkPackageVersion,
+ };
+}
+
+const config: StorybookConfig = {
stories: [
path.resolve(
rootRepoPath,
@@ -57,7 +112,7 @@ module.exports = {
webpackFinal: (storybookConfig) => ({
...storybookConfig,
plugins: [
- ...storybookConfig.plugins,
+ ...(storybookConfig.plugins ?? []),
new MiniCssExtractPlugin(),
new webpack.ProvidePlugin({
Buffer: ["buffer", "Buffer"],
@@ -70,10 +125,10 @@ module.exports = {
module: {
...storybookConfig.module,
rules: [
- ...storybookConfig.module.rules.filter(
+ ...(storybookConfig.module?.rules ?? []).filter(
(rule) => !isCSSRule(rule) && !isSvgRule(rule),
),
- ...appConfig.module.rules.filter(
+ ...(appConfig.module?.rules ?? []).filter(
(rule) => isCSSRule(rule) || isSvgRule(rule),
),
],
@@ -81,7 +136,7 @@ module.exports = {
resolve: {
...storybookConfig.resolve,
alias: {
- ...appConfig.resolve.alias,
+ ...appConfig.resolve?.alias,
...(isEmbeddingSdkPackageInstalled && {
// $ means that only exact "embedding-sdk-package" imports will be rerouted, all nested embedding-sdk-package/* will still be resolved locally
"embedding-sdk-package$": require.resolve(
@@ -89,7 +144,7 @@ module.exports = {
),
}),
},
- extensions: appConfig.resolve.extensions,
+ extensions: appConfig.resolve?.extensions,
fallback: {
...storybookConfig.resolve?.fallback,
...appConfig.resolve?.fallback,
@@ -98,41 +153,5 @@ module.exports = {
}),
};
-const isCSSRule = (rule) => rule.test?.toString() === "/\\.css$/";
-const isSvgRule = (rule) => rule.test && rule.test?.test(".svg");
-
-function resolveEmbeddingSdkPackage() {
- let isEmbeddingSdkPackageInstalled = false;
- let embeddingSdkPackageVersion;
-
- try {
- const packagePath = require.resolve("@metabase/embedding-sdk-react");
- if (packagePath.includes("node_modules")) {
- isEmbeddingSdkPackageInstalled = true;
- }
-
- const packageJsonContent = fs.readFileSync(
- path.join(packagePath, "package.json"),
- "utf-8",
- );
- embeddingSdkPackageVersion = JSON.stringify(
- JSON.parse(packageJsonContent)?.version,
- );
- } catch (err) {
- const sdkPackageTemplateJson = fs.readFileSync(
- path.resolve(
- "./enterprise/frontend/src/embedding-sdk-package/package.template.json",
- ),
- "utf-8",
- );
- const sdkPackageTemplateJsonContent = JSON.parse(sdkPackageTemplateJson);
- embeddingSdkPackageVersion = JSON.stringify(
- sdkPackageTemplateJsonContent.version,
- );
- }
-
- return {
- isEmbeddingSdkPackageInstalled,
- embeddingSdkPackageVersion,
- };
-}
+// eslint-disable-next-line import/no-default-export -- required by Storybook
+export default config;
diff --git a/frontend/src/embedding-sdk-shared/jest/console-restrictions.js b/frontend/src/embedding-sdk-shared/jest/console-restrictions.ts
similarity index 90%
rename from frontend/src/embedding-sdk-shared/jest/console-restrictions.js
rename to frontend/src/embedding-sdk-shared/jest/console-restrictions.ts
index 40491f1c555..8e08d67ec26 100644
--- a/frontend/src/embedding-sdk-shared/jest/console-restrictions.js
+++ b/frontend/src/embedding-sdk-shared/jest/console-restrictions.ts
@@ -1,4 +1,4 @@
-const RESTRICTED_CONSOLE_PATTERNS = [
+const RESTRICTED_CONSOLE_PATTERNS: RegExp[] = [
/UNSAFE_component.*Visualization/,
/UNSAFE_component.*DashboardGrid/,
/Warning: React does not recognize the `.*?` prop on a DOM element/,
@@ -11,7 +11,7 @@ const RESTRICTED_CONSOLE_PATTERNS = [
const originalConsoleError = console.error;
// Override console.error to only fail tests on specific patterns
-console.error = (...args) => {
+console.error = (...args: unknown[]) => {
originalConsoleError(...args);
// parse `null` as a string, otherwise, it will get dropped with `join()`
diff --git a/frontend/src/embedding-sdk-shared/jest/setup-after-env.js b/frontend/src/embedding-sdk-shared/jest/setup-after-env.ts
similarity index 100%
rename from frontend/src/embedding-sdk-shared/jest/setup-after-env.js
rename to frontend/src/embedding-sdk-shared/jest/setup-after-env.ts
diff --git a/frontend/src/embedding-sdk-shared/jest/setup-env.js b/frontend/src/embedding-sdk-shared/jest/setup-env.ts
similarity index 80%
rename from frontend/src/embedding-sdk-shared/jest/setup-env.js
rename to frontend/src/embedding-sdk-shared/jest/setup-env.ts
index a5c963776f5..1ea959e4012 100644
--- a/frontend/src/embedding-sdk-shared/jest/setup-env.js
+++ b/frontend/src/embedding-sdk-shared/jest/setup-env.ts
@@ -1,6 +1,5 @@
import { EMBEDDING_SDK_CONFIG } from "metabase/embedding-sdk/config";
-// eslint-disable-next-line no-undef
process.env.IS_EMBEDDING_SDK = "true";
EMBEDDING_SDK_CONFIG.isEmbeddingSdk = true;
diff --git a/jest.config.js b/jest.config.js
index 7615dba50b4..42e5905d5fd 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -120,13 +120,13 @@ const config = {
setupFiles: [
...baseConfig.setupFiles,
- "<rootDir>/frontend/src/embedding-sdk-shared/jest/setup-env.js",
+ "<rootDir>/frontend/src/embedding-sdk-shared/jest/setup-env.ts",
],
setupFilesAfterEnv: [
...baseConfig.setupFilesAfterEnv,
- "<rootDir>/frontend/src/embedding-sdk-shared/jest/setup-after-env.js",
- "<rootDir>/frontend/src/embedding-sdk-shared/jest/console-restrictions.js",
+ "<rootDir>/frontend/src/embedding-sdk-shared/jest/setup-after-env.ts",
+ "<rootDir>/frontend/src/embedding-sdk-shared/jest/console-restrictions.ts",
],
},
{
diff --git a/rspack.main.config.js b/rspack.main.config.js
index 6047d2e02f9..c2635fba2af 100644
--- a/rspack.main.config.js
+++ b/rspack.main.config.js
@@ -77,8 +77,8 @@ const SWC_LOADER = {
};
class OnScriptError {
- apply(compiler) {
- compiler.hooks.compilation.tap("OnScriptError", (compilation) => {
+ apply(/** @type {import("webpack").Compiler} */ compiler) {
+ compiler.hooks.compilation.tap("OnScriptError", (/** @type {import("webpack").Compilation} */ compilation) => {
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync(
"OnScriptError",
(data, cb) => {
diff --git a/tsconfig.json b/tsconfig.json
index ff4abbd2c3a..78a2f32786a 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -26,6 +26,7 @@
},
"include": [
"frontend/src/**/*",
+ "frontend/build/**/*",
"enterprise/frontend/src/**/*",
"frontend/test/**/*",
"enterprise/frontend/test/**/*"