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
import fs from "node:fs";
import { createRequire } from "node:module";
import path from "node:path";
import { fileURLToPath } from "node:url";
// A namespace import stays single-line so the disable covers the reported line.
// eslint-disable-next-line metabase/no-external-references-for-sdk-package-code
import * as dataAppVirtualModules from "build-configs/embedding-sdk/constants/data-app-virtual-modules";
import {
DATA_APP_BUILD_ID_HEADER,
DATA_APP_BUNDLE_URL,
DATA_APP_REBUILT_EVENT,
} from "../constants/bundle";
import { DATA_APP_DIAGNOSTICS_CHANGED_EVENT } from "../constants/diagnostics-channel";
import {
DATA_APP_DEV_ENTRY_FILE_NAME,
PACKAGE_JSON_FILE_NAME,
SDK_PACKAGE_NAME,
} from "../constants/paths";
const {
DATA_APP_DEV_CONFIG_VIRTUAL_ID,
DATA_APP_DEV_ENTRY_VIRTUAL_ID,
DATA_APP_VIRTUAL_RESOLVED_PREFIX: RESOLVED_PREFIX,
} = dataAppVirtualModules;
const DEV_ENTRY_SOURCE_PATH = fileURLToPath(
new URL(DATA_APP_DEV_ENTRY_FILE_NAME, import.meta.url),
);
const readInstalledSdkVersion = (appRoot: string): string | null => {
try {
const requireFromApp = createRequire(
path.join(appRoot, PACKAGE_JSON_FILE_NAME),
);
const pkg: unknown = requireFromApp(
`${SDK_PACKAGE_NAME}/${PACKAGE_JSON_FILE_NAME}`,
);
return typeof pkg === "object" &&
pkg !== null &&
"version" in pkg &&
typeof pkg.version === "string"
? pkg.version
: null;
} catch {
return null;
}
};
export const resolveDataAppVirtualId = (id: string): string | undefined =>
id === DATA_APP_DEV_ENTRY_VIRTUAL_ID || id === DATA_APP_DEV_CONFIG_VIRTUAL_ID
? RESOLVED_PREFIX + id
: undefined;
export interface DataAppVirtualConfig {
appSlug: string;
allowedHosts: string[];
}
export const loadDataAppVirtualModule = (
id: string,
{ appSlug, allowedHosts }: DataAppVirtualConfig,
): string | undefined => {
if (id === RESOLVED_PREFIX + DATA_APP_DEV_ENTRY_VIRTUAL_ID) {
return fs.readFileSync(DEV_ENTRY_SOURCE_PATH, "utf8");
}
if (id === RESOLVED_PREFIX + DATA_APP_DEV_CONFIG_VIRTUAL_ID) {
return [
`export const allowedHosts = ${JSON.stringify(allowedHosts)};`,
`export const appSlug = ${JSON.stringify(appSlug)};`,
`export const bundleUrl = ${JSON.stringify(DATA_APP_BUNDLE_URL)};`,
`export const buildIdHeader = ${JSON.stringify(DATA_APP_BUILD_ID_HEADER)};`,
`export const rebuiltEvent = ${JSON.stringify(DATA_APP_REBUILT_EVENT)};`,
`export const diagnosticsChangedEvent = ${JSON.stringify(DATA_APP_DIAGNOSTICS_CHANGED_EVENT)};`,
`export const sdkVersion = ${JSON.stringify(readInstalledSdkVersion(process.cwd()))};`,
].join("\n");
}
};