308e4de7a6
## What — TDD coverage layer, no fixes Renders every twenty-ui component export inside the real front-component sandbox (opaque-origin iframe + remote-dom worker, real SDK esbuild pipeline) through the existing Playwright-backed storybook vitest suite, and expresses **every sandbox gap as a golden known-failure test**. This PR deliberately ships **zero fixes** and is **fully green (267/267)**: each known issue has a test asserting the exact current broken behavior. A golden test fails on regression (an unexpected component starts failing) AND on fix (the documented failure disappears) — so every future fix must flip its golden assertion to the strict one, whose acceptance criteria are spelled out in each story's comment. - One gallery fixture per submodule under `src/__stories__/twenty-ui-gallery/` (~150 components) - `component-gallery.tsx`: each component renders inside its own error boundary; failures are aggregated with component name and error message (`data-failed-messages`) so one crash cannot mask the rest - Behavior-level stories that a fake fix cannot pass (MutationObserver must actually fire; a link click must reach `hostApi.navigate`) - `vitest.config.ts` re-export so the storybook in-UI "Run tests" button works ## Current state: 267/267 green — mergeable; 18 golden tests encode the catalog below ## Failure catalog (each entry = golden tests asserting today's broken behavior) ### 1. `MutationObserver.observe is not a function` — 6 failing tests `@remote-dom/polyfill` ships `MutationObserver` as an empty class: construction succeeds, the first `.observe()` call crashes. | Failing test | twenty-ui export(s) | Call site | |---|---|---| | Input React + Preact | `Radio`, `RadioGroup`, `CardPicker` | `@base-ui/react` field internals observe form state | | Surfaces React + Preact | `AppTooltip` | twenty-ui observes `document.body` to track anchors | | Worker Platform APIs: Mutation Observer React + Preact | (behavior test) | asserts the observer actually fires on a React-driven insertion — a no-op stub cannot pass it | Validated fix (branch history, commit 94b96d01e79e): implement real mutation semantics **locally in the worker** by tapping the same `@remote-dom/polyfill` hooks (`insertChild`/`removeChild`/`setAttribute`/`removeAttribute`/`setText`) remote-dom already uses to mirror mutations to the host. The worker tree is the source of truth — no host bridge needed. ### 2. `getComputedStyle is not a function` — 4 failing tests The remote-dom `Window` polyfill does not implement `getComputedStyle`; `@base-ui/react` Collapsible calls it on open. | Failing test | twenty-ui export(s) | |---|---| | Layout React + Preact | `AnimatedEaseInOut`, `AnimatedExpandableContainer` | | Json Visualizer React + Preact | `JsonTree`, `JsonArrayNode`, `JsonObjectNode`, `JsonNestedNode` (all via `JsonNestedNode`'s Collapsible) | Validated fix (commit 7af577054fd9): `getComputedStyle` is synchronous and layout only exists host-side, so a bridge is impossible — an inert-but-valid stub (`0s` durations, `none` animation names) is the honest terminal state. ### 3. No router context in the sandbox — 5 failing tests react-router's `Link` reads `NavigationContext`, which has no provider inside the worker: `Cannot destructure property 'basename' of 'useContext(...)' as it is null`. | Failing test | twenty-ui export(s) | |---|---| | Navigation React + Preact | `RawLink`, `UndecoratedLink` | | Data Display React + Preact | `LinkChip` | | HostApi: Router Link | acceptance test — the link must render AND its click must reach `hostApi.navigate` | Validated fix (commit 221c9c353dc8): SDK build plugin wraps the component tree in a low-level react-router `<Router>` whose custom navigator forwards `push`/`replace` to the SDK `navigate` host API (NOT a MemoryRouter, which would render links but swallow clicks into in-memory history). Falls back to a pass-through provider when the app has no react-router-dom dependency. **Security finding bundled in that commit:** clicking a mirrored `<a>` performs a native host-page navigation before the async worker round-trip can `preventDefault` — a front component can escape the sandbox by rendering a link. Fix: apply the renderer's existing preventDefault-then-forward guard (already used for form submits) to anchor clicks, keeping `target="_blank"` native. The Router Link story's flip-to acceptance assertions (click must reach `hostApi.navigate`) will hard-crash the vitest browser the moment links render without this guard — by design. ### 4. Open `Modal` hangs the React runtime — 1 failing test base-ui Dialog portal with `isOpen` never commits under the React runtime (no error thrown); works under Preact. | Failing test | twenty-ui export | |---|---| | Modal Open React (Modal Open Preact passes) | `Modal` | Isolated in its own fixture so the hang cannot mask the rest of the surfaces gallery (which keeps a closed Modal for mount coverage). Root cause not yet identified — first experiment: portal into a worker-owned container instead of the polyfilled `document.body`. ### 5. monaco cannot load in the sandbox — 2 failing tests `@monaco-editor/react` lazy-loads monaco via script injection, impossible in the polyfilled worker DOM (opaque-origin CSP, no script loading). The CodeEditor wrapper mounts; monaco's `onMount` never fires. | Failing test | twenty-ui export | |---|---| | Code Editor React + Preact | `CodeEditor` | Probably wont-fix in the worker: if front components need a code editor, the path is a host-rendered privileged component. The failing test is the documentation. ### Also worth knowing (no failing test possible yet) - `ResizeObserver` / `IntersectionObserver` / `matchMedia` are absent in the worker: components mount without them today only because nothing crashes at mount — behavior like popup auto-resize and `useIsMobile` is silently wrong. Real fix is a host bridge (async observers on the component's own mirrored elements only — never the host document). Behavior tests should land with that fix. - `Icon`/`IconsProvider`/`useIcons` are excluded from galleries by choice: they dynamic-import the multi-MB Tabler catalog; direct icon imports are the supported pattern in bundled front components. ## Iteration plan Each fix is one commit + one set of stories flipping green, in suggested order: 1. Worker-local MutationObserver (6 tests) — cherry-pick base: 94b96d01e79e 2. `getComputedStyle` + observer/matchMedia stubs (4 tests) — cherry-pick base: 7af577054fd9 3. Router provider + anchor click guard (5 tests) — cherry-pick base: 221c9c353dc8 4. Open-Modal React hang investigation (1 test) 5. CodeEditor: decide wont-fix + keep the failing story or convert to a documented skip (2 tests) ## How to run ``` npx nx run twenty-front-component-renderer:storybook:prebuild cd packages/twenty-front-component-renderer npx vitest run --config vitest.storybook.config.ts --project storybook ```
238 lines
5.8 KiB
TypeScript
238 lines
5.8 KiB
TypeScript
import * as esbuild from 'esbuild';
|
|
import * as fs from 'node:fs';
|
|
import * as path from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
import { getFrontComponentBuildPlugins } from 'twenty-sdk/front-component-renderer/build';
|
|
|
|
const dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
const storiesDir = path.resolve(dirname, '../../src/__stories__');
|
|
const exampleSourcesBuiltDir = path.resolve(
|
|
dirname,
|
|
'../../src/__stories__/example-sources-built',
|
|
);
|
|
const exampleSourcesBuiltPreactDir = path.resolve(
|
|
dirname,
|
|
'../../src/__stories__/example-sources-built-preact',
|
|
);
|
|
|
|
const SOURCE_SCAN_ROOTS = [
|
|
'html-tag',
|
|
'host-api',
|
|
'showcase',
|
|
'twenty-ui-gallery',
|
|
];
|
|
|
|
const rootNodeModules = path.resolve(dirname, '../../../../node_modules');
|
|
|
|
const twentyUiIndividualIndex = path.resolve(
|
|
dirname,
|
|
'../../../twenty-ui/dist/individual/individual-entry.js',
|
|
);
|
|
|
|
const sdkDefineIndex = path.resolve(
|
|
dirname,
|
|
'../../../twenty-sdk/dist/define/index.mjs',
|
|
);
|
|
|
|
const sdkFrontComponentIndex = path.resolve(
|
|
dirname,
|
|
'../../../twenty-sdk/dist/front-component/index.mjs',
|
|
);
|
|
|
|
const twentySharedIndividualDir = path.resolve(
|
|
dirname,
|
|
'../../../twenty-shared/dist/individual',
|
|
);
|
|
|
|
const TWENTY_SHARED_SUBMODULES = [
|
|
'ai',
|
|
'application',
|
|
'constants',
|
|
'database-events',
|
|
'metadata',
|
|
'testing',
|
|
'translations',
|
|
'types',
|
|
'utils',
|
|
'workflow',
|
|
'workspace',
|
|
];
|
|
|
|
const twentySharedAliases = Object.fromEntries(
|
|
TWENTY_SHARED_SUBMODULES.map((submodule) => [
|
|
`twenty-shared/${submodule}`,
|
|
path.join(twentySharedIndividualDir, submodule, 'index.js'),
|
|
]),
|
|
);
|
|
|
|
const TWENTY_UI_SUBMODULES = [
|
|
'accessibility',
|
|
'data-display',
|
|
'feedback',
|
|
'icon',
|
|
'input',
|
|
'json-visualizer',
|
|
'layout',
|
|
'navigation',
|
|
'surfaces',
|
|
'theme-constants',
|
|
'typography',
|
|
'utilities',
|
|
];
|
|
|
|
const twentyUiAliases = {
|
|
'twenty-ui': twentyUiIndividualIndex,
|
|
...Object.fromEntries(
|
|
TWENTY_UI_SUBMODULES.map((submodule) => [
|
|
`twenty-ui/${submodule}`,
|
|
twentyUiIndividualIndex,
|
|
]),
|
|
),
|
|
};
|
|
|
|
const storyAlias = {
|
|
react: path.join(rootNodeModules, 'react'),
|
|
'react-dom': path.join(rootNodeModules, 'react-dom'),
|
|
'twenty-sdk/define': sdkDefineIndex,
|
|
'twenty-sdk/front-component': sdkFrontComponentIndex,
|
|
...twentyUiAliases,
|
|
...twentySharedAliases,
|
|
};
|
|
|
|
const ENTRY_POINT_PATTERN = /\.front-component\.tsx$/;
|
|
|
|
const findEntryPointFiles = (directory: string): string[] => {
|
|
const result: string[] = [];
|
|
|
|
if (!fs.existsSync(directory)) {
|
|
return result;
|
|
}
|
|
|
|
for (const dirent of fs.readdirSync(directory, { withFileTypes: true })) {
|
|
const absolutePath = path.join(directory, dirent.name);
|
|
|
|
if (dirent.isDirectory()) {
|
|
if (dirent.name === 'shared') {
|
|
continue;
|
|
}
|
|
|
|
result.push(...findEntryPointFiles(absolutePath));
|
|
continue;
|
|
}
|
|
|
|
if (!dirent.isFile()) {
|
|
continue;
|
|
}
|
|
|
|
if (ENTRY_POINT_PATTERN.test(dirent.name)) {
|
|
result.push(absolutePath);
|
|
}
|
|
}
|
|
|
|
return result;
|
|
};
|
|
|
|
const resolveEntryPoints = (): Record<string, string> => {
|
|
const files = SOURCE_SCAN_ROOTS.flatMap((root) =>
|
|
findEntryPointFiles(path.join(storiesDir, root)),
|
|
);
|
|
|
|
const entryPoints: Record<string, string> = {};
|
|
|
|
for (const filePath of files) {
|
|
const basename = path.basename(filePath).replace(/\.tsx$/, '');
|
|
|
|
if (entryPoints[basename] !== undefined) {
|
|
throw new Error(
|
|
`Duplicate front-component basename "${basename}" found at ${filePath} and ${entryPoints[basename]}`,
|
|
);
|
|
}
|
|
|
|
entryPoints[basename] = filePath;
|
|
}
|
|
|
|
if (Object.keys(entryPoints).length === 0) {
|
|
throw new Error(
|
|
`No front-component source files found under ${storiesDir} (scanned: ${SOURCE_SCAN_ROOTS.join(', ')})`,
|
|
);
|
|
}
|
|
|
|
return entryPoints;
|
|
};
|
|
|
|
const STORY_COMPONENTS = Object.keys(resolveEntryPoints());
|
|
|
|
type BundleSizeEntry = {
|
|
name: string;
|
|
reactBytes: number;
|
|
preactBytes: number;
|
|
};
|
|
|
|
const collectBundleSizes = (): BundleSizeEntry[] =>
|
|
STORY_COMPONENTS.map((name) => {
|
|
const reactFile = path.join(exampleSourcesBuiltDir, `${name}.mjs`);
|
|
const preactFile = path.join(exampleSourcesBuiltPreactDir, `${name}.mjs`);
|
|
|
|
return {
|
|
name,
|
|
reactBytes: fs.existsSync(reactFile) ? fs.statSync(reactFile).size : 0,
|
|
preactBytes: fs.existsSync(preactFile) ? fs.statSync(preactFile).size : 0,
|
|
};
|
|
});
|
|
|
|
const buildSourceExamples = async (): Promise<void> => {
|
|
const entryPoints = resolveEntryPoints();
|
|
const tsconfigPath = path.join(dirname, '../../tsconfig.json');
|
|
|
|
const commonOptions: esbuild.BuildOptions = {
|
|
entryPoints,
|
|
bundle: true,
|
|
splitting: false,
|
|
format: 'esm',
|
|
outExtension: { '.js': '.mjs' },
|
|
tsconfig: tsconfigPath,
|
|
jsx: 'automatic',
|
|
sourcemap: true,
|
|
metafile: true,
|
|
logLevel: 'silent',
|
|
minify: true,
|
|
alias: storyAlias,
|
|
};
|
|
|
|
fs.mkdirSync(exampleSourcesBuiltDir, { recursive: true });
|
|
|
|
await esbuild.build({
|
|
...commonOptions,
|
|
outdir: exampleSourcesBuiltDir,
|
|
plugins: getFrontComponentBuildPlugins(),
|
|
});
|
|
|
|
console.log(
|
|
`Built ${STORY_COMPONENTS.length} React story components to ${exampleSourcesBuiltDir}`,
|
|
);
|
|
|
|
fs.mkdirSync(exampleSourcesBuiltPreactDir, { recursive: true });
|
|
|
|
await esbuild.build({
|
|
...commonOptions,
|
|
outdir: exampleSourcesBuiltPreactDir,
|
|
plugins: getFrontComponentBuildPlugins({ usePreact: true }),
|
|
});
|
|
|
|
console.log(
|
|
`Built ${STORY_COMPONENTS.length} Preact story components to ${exampleSourcesBuiltPreactDir}`,
|
|
);
|
|
|
|
const sizes = collectBundleSizes();
|
|
const manifestPath = path.join(exampleSourcesBuiltDir, 'bundle-sizes.json');
|
|
|
|
fs.writeFileSync(manifestPath, JSON.stringify(sizes, null, 2));
|
|
console.log(`Wrote bundle size manifest to ${manifestPath}`);
|
|
};
|
|
|
|
buildSourceExamples().catch((error) => {
|
|
console.error('Failed to build mock components:', error);
|
|
process.exit(1);
|
|
});
|