Skip to content

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

Selectively enforce module boundaries (#72436)

Fraserc417b95a44d5
diff --git a/.github/workflows/module-boundaries-stats.yml b/.github/workflows/module-boundaries-stats.yml
index 7fce886fdda..e3d35a63092 100644
--- a/.github/workflows/module-boundaries-stats.yml
+++ b/.github/workflows/module-boundaries-stats.yml
@@ -24,6 +24,12 @@ jobs:
console.log(named.length);
")
+ ENFORCED_MODULES=$(node --input-type=module -e "
+ import { elements } from './frontend/lint/module-boundaries.mjs';
+ const enforced = new Set(elements.filter(e => e.enforceOutgoing).map(e => e.type));
+ console.log(enforced.size);
+ ")
+
NAMED_DIRS=$(node --input-type=module -e "
import { elements } from './frontend/lint/module-boundaries.mjs';
const dirs = new Set();
@@ -39,15 +45,17 @@ jobs:
VIOLATIONS=$(bun run module-boundaries 2>&1 | grep -o '✖ [0-9]* problems' | grep -o '[0-9]*' || echo "0")
- echo "$NAMED_MODULES modules, $UNMODULED unmoduled folders, $VIOLATIONS violations"
+ echo "$NAMED_MODULES modules, $ENFORCED_MODULES enforced, $UNMODULED unmoduled folders, $VIOLATIONS violations"
echo "NAMED_MODULES=$NAMED_MODULES" >> $GITHUB_OUTPUT
+ echo "ENFORCED_MODULES=$ENFORCED_MODULES" >> $GITHUB_OUTPUT
echo "UNMODULED=$UNMODULED" >> $GITHUB_OUTPUT
echo "VIOLATIONS=$VIOLATIONS" >> $GITHUB_OUTPUT
- name: Upload stats
uses: actions/github-script@v7
env:
NAMED_MODULES: ${{ steps.get-stats.outputs.NAMED_MODULES }}
+ ENFORCED_MODULES: ${{ steps.get-stats.outputs.ENFORCED_MODULES }}
UNMODULED: ${{ steps.get-stats.outputs.UNMODULED }}
VIOLATIONS: ${{ steps.get-stats.outputs.VIOLATIONS }}
API_KEY: ${{ secrets.STATS_API_KEY }}
@@ -56,6 +64,7 @@ jobs:
const { uploadCsvToMb } = require('${{ github.workspace }}/.github/scripts/csv-to-mb.js');
console.log("NAMED_MODULES", Number(process.env.NAMED_MODULES));
+ console.log("ENFORCED_MODULES", Number(process.env.ENFORCED_MODULES));
console.log("UNMODULED", Number(process.env.UNMODULED));
console.log("VIOLATIONS", Number(process.env.VIOLATIONS));
@@ -63,6 +72,7 @@ jobs:
{
'Date': new Date().toISOString().slice(0, 10), // YYYY-MM-DD
'Modules': Number(process.env.NAMED_MODULES),
+ 'Enforced modules': Number(process.env.ENFORCED_MODULES),
'Unmoduled folders': Number(process.env.UNMODULED),
'Violations': Number(process.env.VIOLATIONS),
}
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 4e4f9b16abf..f4e87c41525 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -22,7 +22,12 @@ import storybookPlugin from "eslint-plugin-storybook";
import i18nextPlugin from "eslint-plugin-i18next";
import ttagPlugin from "eslint-plugin-ttag";
+import boundaries from "eslint-plugin-boundaries";
import metabasePlugin from "./frontend/lint/eslint-plugin-metabase/index.js";
+import {
+ elements as boundaryElements,
+ enforcedRules as boundaryRules,
+} from "./frontend/lint/module-boundaries.mjs";
const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -271,6 +276,34 @@ const configs = [
...i18nextPlugin.configs["flat/recommended"].rules,
},
},
+ {
+ files: [
+ "frontend/src/**/*.{js,jsx,ts,tsx}",
+ "enterprise/frontend/src/**/*.{js,jsx,ts,tsx}",
+ ],
+ plugins: {
+ boundaries,
+ },
+ settings: {
+ "boundaries/elements": boundaryElements,
+ "boundaries/ignore": [
+ "**/*.unit.spec.*",
+ "**/e2e/**",
+ "*.stories.*",
+ "test/**",
+ ],
+ },
+ rules: {
+ "boundaries/element-types": [
+ "error",
+ {
+ default: "disallow",
+ rules: boundaryRules,
+ message: "${file.type} cannot import from ${dependency.type}",
+ },
+ ],
+ },
+ },
{
files: ["**/*.js", "**/*.jsx"],
languageOptions: {
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index a6c0cd04a28..10444a7ea1a 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -1,59 +1,95 @@
-const createElement = ({ type, name }) => ({
+const createElement = ({
+ type,
+ name,
+ pattern,
+ mode,
+ enforceOutgoing = false,
+}) => ({
type: `${type}/${name}`,
- pattern: `frontend/src/metabase/${name}/**`,
+ pattern: pattern ?? `frontend/src/metabase/${name}/**`,
+ ...(mode && { mode }),
+ enforceOutgoing,
});
-const libModules = ["lib", "css"];
-
-const basicModules = ["ui", "api"];
-
-const sharedModules = ["common", "querying", "visualizations"];
-
-const featureModules = ["dashboard", "query_builder", "admin", "reference"];
-
-const appMiscFilePaths = [
- "frontend/src/metabase/app.js",
- "frontend/src/metabase/app-embed-sdk.tsx",
- "frontend/src/metabase/app-main.js",
- "frontend/src/metabase/app-embed.ts",
- "frontend/src/metabase/app-public.ts",
- "frontend/src/metabase/App.tsx",
- "frontend/src/metabase/App.styled.tsx",
- "frontend/src/metabase/routes.jsx",
- "frontend/src/metabase/routes-embed.tsx",
- "frontend/src/metabase/routes-public.tsx",
- "frontend/src/metabase/AppThemeProvider.tsx",
- "frontend/src/metabase/AppColorSchemeProvider.tsx",
-];
-
const elements = [
- { type: "lib/types", pattern: "frontend/src/metabase-types/*/**" },
- {
- type: "lib/schema",
+ // lib
+ createElement({
+ type: "lib",
+ name: "types",
+ pattern: "frontend/src/metabase-types/*/**",
+ }),
+ createElement({
+ type: "lib",
+ name: "schema",
pattern: "frontend/src/metabase/schema.js",
- mode: "full", // matches the entire path
- },
- { type: "basic/mlv2", pattern: "frontend/src/metabase-lib/*/**" },
- ...libModules.map((name) => createElement({ type: "lib", name })),
- ...basicModules.map((name) => createElement({ type: "basic", name })),
- ...sharedModules.map((name) => createElement({ type: "shared", name })),
- ...featureModules.map((name) => createElement({ type: "feature", name })),
- {
- type: "feature/enterprise",
- pattern: "enterprise/frontend/src/metabase-enterprise/**",
- mode: "full", // matches the entire path, because enterprise is in a different directory
- },
- {
- type: "lib/env",
+ mode: "full",
+ }),
+ createElement({ type: "lib", name: "utils" }),
+ createElement({ type: "lib", name: "css" }),
+ createElement({
+ type: "lib",
+ name: "env",
pattern: "frontend/src/metabase/env.ts",
mode: "full",
- },
- ...appMiscFilePaths.map((path) => ({
- type: "app/misc",
- pattern: path,
+ enforceOutgoing: true,
+ }),
+ // basic
+ createElement({
+ type: "basic",
+ name: "mlv2",
+ pattern: "frontend/src/metabase-lib/*/**",
+ }),
+ createElement({ type: "basic", name: "ui" }),
+ createElement({ type: "basic", name: "api" }),
+ // shared
+ createElement({ type: "shared", name: "common" }),
+ createElement({ type: "shared", name: "querying" }),
+ createElement({ type: "shared", name: "visualizations" }),
+ // feature
+ createElement({ type: "feature", name: "dashboard" }),
+ createElement({
+ type: "feature",
+ name: "query_builder",
+ enforceOutgoing: true,
+ }),
+ createElement({ type: "feature", name: "admin" }),
+ createElement({ type: "feature", name: "reference" }),
+ createElement({
+ type: "feature",
+ name: "enterprise",
+ pattern: "enterprise/frontend/src/metabase-enterprise/**",
mode: "full",
- })),
- { type: "shared/other", pattern: "frontend/src/*/**" },
+ enforceOutgoing: true,
+ }),
+ // app
+ ...[
+ "frontend/src/metabase/app.js",
+ "frontend/src/metabase/app-embed-sdk.tsx",
+ "frontend/src/metabase/app-main.js",
+ "frontend/src/metabase/app-embed.ts",
+ "frontend/src/metabase/app-public.ts",
+ "frontend/src/metabase/App.tsx",
+ "frontend/src/metabase/App.styled.tsx",
+ "frontend/src/metabase/routes.jsx",
+ "frontend/src/metabase/routes-embed.tsx",
+ "frontend/src/metabase/routes-public.tsx",
+ "frontend/src/metabase/AppThemeProvider.tsx",
+ "frontend/src/metabase/AppColorSchemeProvider.tsx",
+ ].map((path) =>
+ createElement({
+ type: "app",
+ name: "misc",
+ pattern: path,
+ mode: "full",
+ enforceOutgoing: true,
+ }),
+ ),
+ // catch-all for unmoduled files - must be last
+ createElement({
+ type: "shared",
+ name: "other",
+ pattern: "frontend/src/*/**",
+ }),
];
const rules = [
@@ -96,4 +132,49 @@ const rules = [
},
];
-export { elements, rules };
+/**
+ * Returns a subset of rules that only enforces boundaries for modules with
+ * enforceOutgoing: true. Non-enforced modules get a blanket allow-all.
+ */
+function buildEnforcedRules(elements, rules) {
+ const enforcedTypes = new Set(
+ elements.filter((el) => el.enforceOutgoing).map((el) => el.type),
+ );
+ const nonEnforcedTypes = new Set(
+ elements.filter((el) => !el.enforceOutgoing).map((el) => el.type),
+ );
+
+ // Narrows a wildcard "from" pattern (e.g. "feature/*") to only the concrete
+ // types that have enforceOutgoing: true (e.g. ["feature/query_builder"]),
+ // so enforced rules don't accidentally apply to non-enforced modules.
+ const expandPattern = (pattern) => {
+ if (pattern.endsWith("/*")) {
+ const prefix = pattern.slice(0, -1);
+ return [...enforcedTypes].filter((type) => type.startsWith(prefix));
+ }
+ return enforcedTypes.has(pattern) ? [pattern] : [];
+ };
+
+ // Keep only rules whose `from` matches an enforced module, replacing
+ // wildcard patterns with the concrete enforced types.
+ const narrowedRules = rules.flatMap((rule) => {
+ const from = rule.from.flatMap(expandPattern);
+ return from.length > 0 ? [{ ...rule, from }] : [];
+ });
+
+ return [
+ ...narrowedRules,
+ ...(nonEnforcedTypes.size > 0
+ ? [
+ {
+ from: [...nonEnforcedTypes],
+ allow: ["lib/*", "basic/*", "shared/*", "feature/*", "app/*"],
+ },
+ ]
+ : []),
+ ];
+}
+
+const enforcedRules = buildEnforcedRules(elements, rules);
+
+export { elements, rules, enforcedRules };