Skip to content

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

Build data apps into build/ by default (#85333)

Alexander Polyankin2bd7c397c11c
diff --git a/e2e/support/helpers/build-data-app-fixture.mjs b/e2e/support/helpers/build-data-app-fixture.mjs
index 1d18213b3fe..fa19b3dad42 100644
--- a/e2e/support/helpers/build-data-app-fixture.mjs
+++ b/e2e/support/helpers/build-data-app-fixture.mjs
@@ -61,5 +61,6 @@ await build({
...buildInfoDefine,
"process.env.IS_EMBEDDING_SDK": '"true"',
},
+ build: { outDir: "dist" },
plugins: dataAppConfig().plugins,
});
diff --git a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.ts b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.ts
index 6ad02e9e089..8e876e6734b 100644
--- a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.ts
@@ -1,4 +1,4 @@
-import type { LibraryFormats } from "vite";
+import type { LibraryFormats, UserConfig } from "vite";
import cssInjectedByJsPlugin from "vite-plugin-css-injected-by-js";
import svgr from "vite-plugin-svgr";
@@ -9,6 +9,12 @@ import {
DATA_APP_GLOBALS,
} from "../constants/bundle";
+const DEFAULT_OUT_DIR = "build";
+
+export function dataAppOutDir(config: UserConfig) {
+ return config.build?.outDir ?? DEFAULT_OUT_DIR;
+}
+
export function dataAppLibBuild(fileName: string) {
return {
assetsInlineLimit: () => true,
diff --git a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.unit.spec.ts b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.unit.spec.ts
new file mode 100644
index 00000000000..e055c1bdd0d
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/config/build-config.unit.spec.ts
@@ -0,0 +1,11 @@
+import { dataAppOutDir } from "./build-config";
+
+describe("dataAppOutDir", () => {
+ it("builds into build/ by default", () => {
+ expect(dataAppOutDir({})).toBe("build");
+ });
+
+ it("builds into the outDir the user passes", () => {
+ expect(dataAppOutDir({ build: { outDir: "dist" } })).toBe("dist");
+ });
+});
diff --git a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/index.ts b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/index.ts
index d5d0fb13e36..c3b45b2e0c7 100644
--- a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/index.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/index.ts
@@ -8,7 +8,11 @@ import {
loadEnv,
} from "vite";
-import { dataAppBuildPlugins, dataAppLibBuild } from "./config/build-config";
+import {
+ dataAppBuildPlugins,
+ dataAppLibBuild,
+ dataAppOutDir,
+} from "./config/build-config";
import { getDataAppDefine } from "./config/define";
import { buildDevCsp } from "./config/dev-connect-src";
import { dataAppEnvPrefix } from "./config/env-prefix";
@@ -31,14 +35,14 @@ function dataAppVitePlugin(): PluginOption[] {
name: "metabase-data-app",
// Merged over the user's config, so these win — the bundle Metabase loads
// always matches what dev runs.
- config: (_config: UserConfig, env: ConfigEnv): UserConfig => ({
+ config: (config: UserConfig, env: ConfigEnv): UserConfig => ({
define: getDataAppDefine(env.mode),
envDir,
envPrefix: dataAppEnvPrefix(env.command),
// The dev plugin serves a synthetic index.html; there's no file on disk.
appType: "custom",
build: {
- outDir: "dist",
+ outDir: dataAppOutDir(config),
emptyOutDir: true,
...dataAppLibBuild("index.js"),
},