Skip to content

The open alternative to Salesforce, designed for AI.

Render supplied frontend component source and data (#29263)

Weikoab962b01c4fd
diff --git a/packages/twenty-cli/src/app/bundles/front-component-build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts b/packages/twenty-cli/src/app/bundles/front-component-build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
index 88b5922414e..4e1b6569467 100644
--- a/packages/twenty-cli/src/app/bundles/front-component-build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
+++ b/packages/twenty-cli/src/app/bundles/front-component-build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
@@ -59,7 +59,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
'component: createSummarizeRecordEffect(SUMMARIZE_TARGETS.company),',
);
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineFrontComponent');
});
@@ -71,7 +71,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
expect(output).toContain('component: SummarizeRecordEffect,');
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineFrontComponent');
});
@@ -85,7 +85,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
);
const renderer =
- '\nexport default function __renderFrontComponent(__container) { __createRoot(__container).render(__frontComponentJsx(__frontComponentDefinition.component, {})); }\n';
+ 'export default function __renderFrontComponent(__container, __props = {})';
expect(inlineOutput).toContain(renderer);
expect(identifierOutput).toContain(renderer);
@@ -98,7 +98,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
expect(output).toContain('component: AppSettings,');
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineSettingsFrontComponent');
});
diff --git a/packages/twenty-front-component-renderer/src/host/component-source/utils/__tests__/fetchComponentSourceFromNetwork.spec.ts b/packages/twenty-front-component-renderer/src/host/component-source/utils/__tests__/fetchComponentSourceFromNetwork.spec.ts
index 454795af3c8..bbccecb2084 100644
--- a/packages/twenty-front-component-renderer/src/host/component-source/utils/__tests__/fetchComponentSourceFromNetwork.spec.ts
+++ b/packages/twenty-front-component-renderer/src/host/component-source/utils/__tests__/fetchComponentSourceFromNetwork.spec.ts
@@ -59,6 +59,26 @@ describe('fetchComponentSourceFromNetwork', () => {
});
});
+ it('can load an app bundle without the user session', async () => {
+ const fetchMock = jest
+ .fn()
+ .mockResolvedValue(
+ createFakeResponse({ body: 'export const shared = true;' }),
+ );
+ globalThis.fetch = fetchMock;
+
+ await fetchComponentSourceFromNetwork({
+ url: COMPONENT_URL,
+ headers: { Authorization: 'Bearer app-token' },
+ credentials: 'omit',
+ });
+ expect(fetchMock).toHaveBeenCalledTimes(1);
+ expect(fetchMock).toHaveBeenCalledWith(CACHE_BUSTED_COMPONENT_URL, {
+ headers: { Authorization: 'Bearer app-token' },
+ credentials: 'omit',
+ });
+ });
+
it('follows the JSON handoff and fetches the presigned URL header-less', async () => {
const fetchMock = jest
.fn()
@@ -89,6 +109,40 @@ describe('fetchComponentSourceFromNetwork', () => {
});
});
+ it('does not forward app authorization to a presigned handoff', async () => {
+ globalThis.fetch = jest
+ .fn()
+ .mockResolvedValueOnce(
+ createFakeResponse({
+ contentType: 'application/json',
+ json: { url: PRESIGNED_URL },
+ }),
+ )
+ .mockResolvedValueOnce(
+ createFakeResponse({ body: 'presigned bundle source' }),
+ );
+
+ await fetchComponentSourceFromNetwork({
+ url: COMPONENT_URL,
+ headers: { Authorization: 'Bearer token' },
+ credentials: 'omit',
+ });
+
+ expect(globalThis.fetch).toHaveBeenNthCalledWith(
+ 1,
+ CACHE_BUSTED_COMPONENT_URL,
+ {
+ headers: {
+ Authorization: 'Bearer token',
+ },
+ credentials: 'omit',
+ },
+ );
+ expect(globalThis.fetch).toHaveBeenNthCalledWith(2, PRESIGNED_URL, {
+ credentials: 'same-origin',
+ });
+ });
+
it('preserves existing query parameters when appending the cache bust parameter', async () => {
const fetchMock = jest.fn(async () =>
createFakeResponse({ body: 'export default () => {};' }),
diff --git a/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSource.ts b/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSource.ts
index 945b53cb49c..821bf12adfc 100644
--- a/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSource.ts
+++ b/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSource.ts
@@ -12,9 +12,11 @@ import { writeComponentSourceToCache } from '@/host/component-source/utils/write
export const fetchComponentSource = async ({
url,
headers,
+ credentials,
}: {
url: string;
headers?: Record<string, string>;
+ credentials?: RequestCredentials;
}): Promise<string> => {
const expectedChecksum = extractComponentChecksumFromUrl({ url });
@@ -40,7 +42,11 @@ export const fetchComponentSource = async ({
}
}
- const source = await fetchComponentSourceFromNetwork({ url, headers });
+ const source = await fetchComponentSourceFromNetwork({
+ url,
+ headers,
+ credentials,
+ });
if (!isDefined(expectedChecksum)) {
return source;
diff --git a/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSourceFromNetwork.ts b/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSourceFromNetwork.ts
index 8f2e54cca63..595d7c42a8d 100644
--- a/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSourceFromNetwork.ts
+++ b/packages/twenty-front-component-renderer/src/host/component-source/utils/fetchComponentSourceFromNetwork.ts
@@ -25,13 +25,15 @@ const appendCacheBustQueryParameter = (url: string): string => {
export const fetchComponentSourceFromNetwork = async ({
url,
headers,
+ credentials = 'same-origin',
}: {
url: string;
headers?: Record<string, string>;
+ credentials?: RequestCredentials;
}): Promise<string> => {
const response = await fetch(appendCacheBustQueryParameter(url), {
headers,
- credentials: 'same-origin',
+ credentials,
});
if (!response.ok) {
diff --git a/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
index b4edc94667b..d765a02c759 100644
--- a/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
+++ b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
@@ -40,6 +40,10 @@ const fallbackComponentRegistry =
type FrontComponentRendererProps = {
componentUrl: string;
+ componentSource?: string;
+ componentProps?: Record<string, unknown>;
+ sharedDependenciesSource?: string;
+ onReady?: () => void;
applicationAccessToken?: string;
apiUrl?: string;
functionsBaseUrl?: string;
@@ -57,6 +61,10 @@ type FrontComponentRendererProps = {
export const FrontComponentRenderer = ({
componentUrl,
+ componentSource,
+ componentProps,
+ sharedDependenciesSource,
+ onReady,
applicationAccessToken,
apiUrl,
functionsBaseUrl,
@@ -110,6 +118,10 @@ export const FrontComponentRenderer = ({
>
<FrontComponentWorkerEffect
componentUrl={componentUrl}
+ componentSource={componentSource}
+ componentProps={componentProps}
+ sharedDependenciesSource={sharedDependenciesSource}
+ onReady={onReady}
applicationAccessToken={applicationAccessToken}
apiUrl={apiUrl}
functionsBaseUrl={functionsBaseUrl}
diff --git a/packages/twenty-front-component-renderer/src/host/components/FrontComponentSourceRenderer.tsx b/packages/twenty-front-component-renderer/src/host/components/FrontComponentSourceRenderer.tsx
new file mode 100644
index 00000000000..9ef71c06176
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/host/components/FrontComponentSourceRenderer.tsx
@@ -0,0 +1,52 @@
+import { useMemo } from 'react';
+
+import { FrontComponentRenderer } from '@/host/components/FrontComponentRenderer';
+import { FRONT_COMPONENT_HOST_COMMUNICATION_API_NOOP } from '@/host/thread/constants/FrontComponentHostCommunicationApiNoop';
+
+type FrontComponentSourceRendererProps = {
+ componentId: string;
+ componentSource: string;
+ sharedDependenciesSource?: string;
+ data: Record<string, unknown>;
+ colorScheme: 'light' | 'dark';
+ onReady?: () => void;
+ onError: (error?: Error) => void;
+};
+
+export const FrontComponentSourceRenderer = ({
+ componentId,
+ componentSource,
+ sharedDependenciesSource,
+ data,
+ colorScheme,
+ onReady,
+ onError,
+}: FrontComponentSourceRendererProps) => {
+ const executionContext = useMemo(
+ () => ({
+ frontComponentId: componentId,
+ userId: null,
+ recordId: null,
+ selectedRecordIds: [],
+ timelineActivityId: null,
+ colorScheme,
+ }),
+ [componentId, colorScheme],
+ );
+
+ return (
+ <FrontComponentRenderer
+ componentUrl={`about:blank#${componentId}`}
+ componentSource={componentSource}
+ sharedDependenciesSource={sharedDependenciesSource}
+ componentProps={data}
+ executionContext={executionContext}
+ frontComponentHostCommunicationApi={
+ FRONT_COMPONENT_HOST_COMMUNICATION_API_NOOP
+ }
+ colorScheme={colorScheme}
+ onReady={onReady}
+ onError={onError}
+ />
+ );
+};
diff --git a/packages/twenty-front-component-renderer/src/host/effect-components/FrontComponentWorkerEffect.tsx b/packages/twenty-front-component-renderer/src/host/effect-components/FrontComponentWorkerEffect.tsx
index 6bec2e16073..b361e7064ff 100644
--- a/packages/twenty-front-component-renderer/src/host/effect-components/FrontComponentWorkerEffect.tsx
+++ b/packages/twenty-front-component-renderer/src/host/effect-components/FrontComponentWorkerEffect.tsx
@@ -1,7 +1,7 @@
import { release, retain } from '@quilted/threads';
import { RemoteReceiver } from '@remote-dom/core/receivers';
import { useEffect, useRef } from 'react';
-import { isDefined } from 'twenty-shared/utils';
+import { fastDeepEqual, isDefined } from 'twenty-shared/utils';
import { createFileInputAwareRemoteConnection } from '@/host/file-input/utils/createFileInputAwareRemoteConnection';
import { createFileInputHost } from '@/host/file-input/utils/createFileInputHost';
@@ -31,6 +31,10 @@ import { containsSharedDependenciesImportSpecifier } from '@/utils/module-import
type FrontComponentWorkerEffectProps = {
componentUrl: string;
+ componentSource?: string;
+ componentProps?: Record<string, unknown>;
+ sharedDependenciesSource?: string;
+ onReady?: () => void;
applicationAccessToken?: string;
apiUrl?: string;
functionsBaseUrl?: string;
@@ -54,6 +58,10 @@ export const FrontComponentWorkerEffect = ({
hostScrollController,
outsidePressController,
componentUrl,
+ componentSource: providedComponentSource,
+ componentProps,
+ sharedDependenciesSource: providedSharedDependenciesSource,
+ onReady,
applicationAccessToken,
apiUrl,
functionsBaseUrl,
@@ -69,12 +77,26 @@ export const FrontComponentWorkerEffect = ({
setError,
}: FrontComponentWorkerEffectProps) => {
const isInitializedRef = useRef(false);
+ const onReadyRef = useRef(onReady);
+ const componentPropsRef = useRef(componentProps);
+
+ if (!fastDeepEqual(componentPropsRef.current, componentProps)) {
+ componentPropsRef.current = componentProps;
+ }
+
+ const stableComponentProps = componentPropsRef.current;
+
+ useEffect(() => {
+ onReadyRef.current = onReady;
+ }, [onReady]);
useEffect(() => {
if (isInitializedRef.current) {
return;
}
+ setError(null);
+
const newReceiver = new RemoteReceiver({ retain, release });
const sandboxIframe = createFrontComponentSandboxIframe(
@@ -123,15 +145,35 @@ export const FrontComponentWorkerEffect = ({
applicationAccessToken,
);
- const componentSource = await fetchComponentSource({
- url: componentUrl,
- headers: authorizationHeaders,
- });
+ const componentSource =
+ providedComponentSource ??
+ (await fetchComponentSource({
+ url: componentUrl,
+ headers: authorizationHeaders,
+ }));
if (isCancelled) {
return;
}
+ const resolveSharedDependenciesSource = () => {
+ if (isDefined(providedSharedDependenciesSource)) {
+ return providedSharedDependenciesSource;
+ }
+
+ if (
+ !isDefined(sharedDependenciesUrl) ||
+ !containsSharedDependenciesImportSpecifier(componentSource)
+ ) {
+ return undefined;
+ }
+
+ return fetchComponentSource({
+ url: sharedDependenciesUrl,
+ headers: authorizationHeaders,
+ });
+ };
+
const [sdkClientSources, sharedDependenciesSource] = await Promise.all([
isDefined(sdkClientUrls) &&
containsSdkClientImportSpecifier(componentSource)
@@ -140,13 +182,7 @@ export const FrontComponentWorkerEffect = ({
headers: authorizationHeaders,
})
: undefined,
- isDefined(sharedDependenciesUrl) &&
- containsSharedDependenciesImportSpecifier(componentSource)
- ? fetchComponentSource({
- url: sharedDependenciesUrl,
- headers: authorizationHeaders,
- })
- : undefined,
+ resolveSharedDependenciesSource(),
]);
if (isCancelled) {
@@ -157,6 +193,8 @@ export const FrontComponentWorkerEffect = ({
? buildFrontComponentStorageSnapshots(storageNamespace)
: undefined;
+ setReceiver(newReceiver);
+
await thread.imports.render(
createFileInputAwareRemoteConnection({
fileInputHost,
@@ -168,6 +206,7 @@ export const FrontComponentWorkerEffect = ({
{
componentUrl,
componentSource,
+ componentProps: stableComponentProps,
applicationAccessToken,
apiUrl,
functionsBaseUrl,
@@ -184,7 +223,7 @@ export const FrontComponentWorkerEffect = ({
);
if (!isCancelled) {
- setReceiver(newReceiver);
+ onReadyRef.current?.();
}
} catch (error) {
if (!isCancelled) {
@@ -211,6 +250,9 @@ export const FrontComponentWorkerEffect = ({
};
}, [
componentUrl,
+ providedComponentSource,
+ stableComponentProps,
+ providedSharedDependenciesSource,
applicationAccessToken,
apiUrl,
functionsBaseUrl,
diff --git a/packages/twenty-front-component-renderer/src/host/effect-components/__tests__/FrontComponentWorkerEffect.test.ts b/packages/twenty-front-component-renderer/src/host/effect-components/__tests__/FrontComponentWorkerEffect.test.ts
index d293c6ddc76..c59c4a6a03f 100644
--- a/packages/twenty-front-component-renderer/src/host/effect-components/__tests__/FrontComponentWorkerEffect.test.ts
+++ b/packages/twenty-front-component-renderer/src/host/effect-components/__tests__/FrontComponentWorkerEffect.test.ts
@@ -1,7 +1,13 @@
import '@/testing/setupServerRenderingGlobals';
+import { ThreadMessagePort } from '@quilted/threads';
+import {
+ MUTATION_TYPE_INSERT_CHILD,
+ NODE_TYPE_TEXT,
+ ROOT_ID,
+} from '@remote-dom/core';
import { RemoteReceiver } from '@remote-dom/core/receivers';
-import { act, createElement } from 'react';
+import { act, createElement, type ComponentProps } from 'react';
import { createRoot, type Root } from 'react-dom/client';
import { fetchComponentSource } from '@/host/component-source/utils/fetchComponentSource';
@@ -58,24 +64,36 @@ const createHostScrollControllerStub = (): HostScrollController => ({
});
const createDeferredRender = () => {
- let resolveRender: () => void = () => {};
- let rejectRender: (error: Error) => void = () => {};
-
- const render = jest.fn(
- () =>
- new Promise<void>((resolve, reject) => {
- resolveRender = resolve;
- rejectRender = reject;
- }),
- );
+ const control = {
+ resolveRender: () => {},
+ rejectRender: (_error: Error) => {},
+ };
+ const pendingRender = new Promise<void>((resolve, reject) => {
+ control.resolveRender = resolve;
+ control.rejectRender = reject;
+ });
return {
- render,
- resolveRender: () => resolveRender(),
- rejectRender: (error: Error) => rejectRender(error),
+ ...control,
+ render: jest.fn<
+ ReturnType<FrontComponentThread['imports']['render']>,
+ Parameters<FrontComponentThread['imports']['render']>
+ >(() => pendingRender),
};
};
+const mockThreadRender = (
+ render: FrontComponentThread['imports']['render'],
+) => {
+ const thread: FrontComponentThread = new ThreadMessagePort(
+ new MessageChannel().port1,
+ { imports: ['render'] },
+ );
+
+ Object.defineProperty(thread.imports, 'render', { value: render });
+ jest.mocked(createFrontComponentHostThread).mockReturnValue(thread);
+};
+
const flushPendingWork = () =>
act(() => new Promise<void>((resolve) => setTimeout(resolve, 0)));
@@ -84,6 +102,7 @@ describe('FrontComponentWorkerEffect', () => {
let root: Root;
beforeEach(() => {
+ jest.clearAllMocks();
container = document.createElement('div');
document.body.appendChild(container);
root = createRoot(container);
@@ -103,73 +122,179 @@ describe('FrontComponentWorkerEffect', () => {
const mountEffect = ({
setReceiver,
setError,
- }: {
- setReceiver: jest.Mock;
- setError: jest.Mock;
- }) => {
- act(() => {
- root.render(
- createElement(FrontComponentWorkerEffect, {
- componentUrl: 'https://app.twenty.test/component.js',
- initialExecutionContext: {
- frontComponentId: 'front-component-id',
- userId: null,
- recordId: null,
- selectedRecordIds: [],
- timelineActivityId: null,
- colorScheme: 'light',
- },
- geometryTracker: createGeometryTrackerStub(),
- hostFocusController: createHostFocusControllerStub(),
- hostScrollController: createHostScrollControllerStub(),
- outsidePressController: createHostOutsidePressControllerStub(),
- setReceiver,
- setThread: jest.fn(),
- setError,
- }),
- );
- });
+ componentProps,
+ onReady,
+ }: Pick<
+ ComponentProps<typeof FrontComponentWorkerEffect>,
+ 'setReceiver' | 'setError' | 'componentProps' | 'onReady'
+ >) => {
+ const props: ComponentProps<typeof FrontComponentWorkerEffect> = {
+ componentUrl: 'https://app.twenty.test/component.js',
+ initialExecutionContext: {
+ frontComponentId: 'front-component-id',
+ userId: null,
+ recordId: null,
+ selectedRecordIds: [],
+ timelineActivityId: null,
+ colorScheme: 'light',
+ },
+ geometryTracker: createGeometryTrackerStub(),
+ hostFocusController: createHostFocusControllerStub(),
+ hostScrollController: createHostScrollControllerStub(),
+ outsidePressController: createHostOutsidePressControllerStub(),
+ setReceiver,
+ setThread: jest.fn(),
+ setError,
+ componentProps,
+ onReady,
+ };
+ const renderEffect = (
+ updates: Partial<ComponentProps<typeof FrontComponentWorkerEffect>> = {},
+ ) => {
+ act(() => {
+ root.render(
+ createElement(FrontComponentWorkerEffect, { ...props, ...updates }),
+ );
+ });
+ };
+
+ renderEffect();
+
+ return renderEffect;
};
- it('should hand the receiver to the host only once the worker has rendered', async () => {
+ it('keeps the receiver connected while waiting for readiness', async () => {
const { render, resolveRender } = createDeferredRender();
-
- jest.mocked(createFrontComponentHostThread).mockReturnValue({
- imports: { render },
- } as unknown as FrontComponentThread);
-
+ mockThreadRender(render);
const setReceiver = jest.fn();
+ const onReady = jest.fn();
- mountEffect({ setReceiver, setError: jest.fn() });
+ mountEffect({ setReceiver, setError: jest.fn(), onReady });
await flushPendingWork();
- expect(render).toHaveBeenCalledTimes(1);
- expect(setReceiver).not.toHaveBeenCalled();
+ expect(setReceiver).toHaveBeenCalledWith(expect.any(RemoteReceiver));
+ expect(onReady).not.toHaveBeenCalled();
resolveRender();
await flushPendingWork();
expect(setReceiver).toHaveBeenCalledTimes(1);
- expect(setReceiver).toHaveBeenCalledWith(expect.any(RemoteReceiver));
+ expect(onReady).toHaveBeenCalledTimes(1);
});
- it('should report a failed render instead of handing over the receiver', async () => {
+ it('keeps receiving late mutations after the initial render times out', async () => {
const { render, rejectRender } = createDeferredRender();
+ mockThreadRender(render);
+ const setReceiver = jest.fn();
+ const setError = jest.fn();
+ const onReady = jest.fn();
- jest.mocked(createFrontComponentHostThread).mockReturnValue({
- imports: { render },
- } as unknown as FrontComponentThread);
+ mountEffect({ setReceiver, setError, onReady });
+ await flushPendingWork();
- const setReceiver = jest.fn();
+ const error = new Error('Front component initial render timed out.');
+ rejectRender(error);
+ await flushPendingWork();
+
+ const receiver = setReceiver.mock.calls[0][0] as RemoteReceiver;
+ const connection = render.mock.calls[0][0];
+ connection.mutate([
+ [
+ MUTATION_TYPE_INSERT_CHILD,
+ ROOT_ID,
+ { id: 'late-text', type: NODE_TYPE_TEXT, data: 'Late render' },
+ 0,
+ ],
+ ]);
+
+ expect(receiver.root.children).toEqual([
+ expect.objectContaining({ data: 'Late render' }),
+ ]);
+ expect(setReceiver).toHaveBeenCalledTimes(1);
+ expect(setError).toHaveBeenLastCalledWith(error);
+ expect(onReady).not.toHaveBeenCalled();
+ });
+
+ it('clears a previous error when new props restart the worker', async () => {
+ const error = new Error('Initial render failed');
+ const render = jest
+ .fn()
+ .mockRejectedValueOnce(error)
+ .mockResolvedValue(undefined);
+ mockThreadRender(render);
const setError = jest.fn();
+ const onReady = jest.fn();
+ const rerender = mountEffect({
+ setReceiver: jest.fn(),
+ setError,
+ onReady,
+ componentProps: { count: 1 },
+ });
+ await flushPendingWork();
+ expect(setError).toHaveBeenLastCalledWith(error);
+
+ rerender({ componentProps: { count: 2 } });
+ expect(setError).toHaveBeenLastCalledWith(null);
+ await flushPendingWork();
+
+ expect(setError).toHaveBeenLastCalledWith(null);
+ expect(onReady).toHaveBeenCalledTimes(1);
+ });
- mountEffect({ setReceiver, setError });
+ it('keeps the worker for equal props and uses the latest ready callback', async () => {
+ const { render, resolveRender } = createDeferredRender();
+ mockThreadRender(render);
+ const firstReady = jest.fn();
+ const latestReady = jest.fn();
+ const setReceiver = jest.fn();
+ const rerender = mountEffect({
+ setReceiver,
+ setError: jest.fn(),
+ componentProps: { records: [{ id: 'sample' }] },
+ onReady: firstReady,
+ });
+ await flushPendingWork();
+
+ rerender({
+ componentProps: { records: [{ id: 'sample' }] },
+ onReady: latestReady,
+ });
+ resolveRender();
+ await flushPendingWork();
+
+ const nextReady = jest.fn();
+ rerender({
+ componentProps: { records: [{ id: 'sample' }] },
+ onReady: nextReady,
+ });
+ await flushPendingWork();
+
+ expect(createFrontComponentHostThread).toHaveBeenCalledTimes(1);
+ expect(render).toHaveBeenCalledTimes(1);
+ expect(setReceiver).toHaveBeenCalledTimes(1);
+ expect(firstReady).not.toHaveBeenCalled();
+ expect(latestReady).toHaveBeenCalledTimes(1);
+ expect(nextReady).not.toHaveBeenCalled();
+ });
+
+ it('restarts with new data when props actually change', async () => {
+ const render = jest.fn(async () => {});
+ mockThreadRender(render);
+ const rerender = mountEffect({
+ setReceiver: jest.fn(),
+ setError: jest.fn(),
+ componentProps: { count: 1 },
+ });
await flushPendingWork();
- rejectRender(new Error('render failed'));
+ rerender({ componentProps: { count: 2 } });
await flushPendingWork();
- expect(setReceiver).not.toHaveBeenCalled();
- expect(setError).toHaveBeenCalledWith(expect.any(Error));
+ expect(createFrontComponentHostThread).toHaveBeenCalledTimes(2);
+ expect(render).toHaveBeenCalledTimes(2);
+ expect(render).toHaveBeenLastCalledWith(
+ expect.any(Object),
+ expect.objectContaining({ componentProps: { count: 2 } }),
+ );
});
});
diff --git a/packages/twenty-front-component-renderer/src/index.ts b/packages/twenty-front-component-renderer/src/index.ts
index 203cb98a8fc..b30e181772c 100644
--- a/packages/twenty-front-component-renderer/src/index.ts
+++ b/packages/twenty-front-component-renderer/src/index.ts
@@ -1,3 +1,5 @@
+export { fetchComponentSource } from '@/host/component-source/utils/fetchComponentSource';
+export { FrontComponentSourceRenderer } from '@/host/components/FrontComponentSourceRenderer';
export { FrontComponentRenderer } from '@/host/components/FrontComponentRenderer';
export { FrontComponentInputFocusContext } from '@/host/caret/contexts/FrontComponentInputFocusContext';
export { type SetEditableFocused } from '@/host/caret/types/SetEditableFocused';
diff --git a/packages/twenty-front-component-renderer/src/remote/worker/module-loading/utils/loadFrontComponentModule.ts b/packages/twenty-front-component-renderer/src/remote/worker/module-loading/utils/loadFrontComponentModule.ts
index 3023728fd37..080c743f19a 100644
--- a/packages/twenty-front-component-renderer/src/remote/worker/module-loading/utils/loadFrontComponentModule.ts
+++ b/packages/twenty-front-component-renderer/src/remote/worker/module-loading/utils/loadFrontComponentModule.ts
@@ -15,7 +15,11 @@ type LoadFrontComponentModuleInput = {
};
type FrontComponentModule = {
- default: (container: Element) => void;
+ // Already-built components expect the container as their first argument.
+ default: (
+ container: Element,
+ props?: Record<string, unknown>,
+ ) => void | Promise<void>;
};
export const loadFrontComponentModule = async ({
diff --git a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/__tests__/renderFrontComponent.test.ts b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/__tests__/renderFrontComponent.test.ts
index c0e04320752..6e593264ccc 100644
--- a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/__tests__/renderFrontComponent.test.ts
+++ b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/__tests__/renderFrontComponent.test.ts
@@ -87,6 +87,48 @@ describe('renderFrontComponent', () => {
delete (globalThis as Record<string, unknown>)[FRONT_COMPONENT_CONTEXT_KEY];
});
+ it('passes the supplied data and waits for initial rendering', async () => {
+ const componentProps = { records: [{ id: 'sample', name: 'Example' }] };
+ const initialRenderControl = { resolve: () => {} };
+ const initialRender = new Promise<void>((resolve) => {
+ initialRenderControl.resolve = resolve;
+ });
+ const render = jest.fn(() => initialRender);
+ jest
+ .mocked(loadFrontComponentModule)
+ .mockResolvedValue({ default: render });
+ const onReady = jest.fn();
+ const result = renderFrontComponent({
+ connection: createConnection(),
+ renderContext: { ...COMPONENT_RENDER_CONTEXT, componentProps },
+ hostFetch: jest.fn(),
+ }).then(onReady);
+
+ await Promise.resolve();
+ expect(render).toHaveBeenCalledTimes(1);
+ expect(render).toHaveBeenCalledWith({}, componentProps);
+ expect(onReady).not.toHaveBeenCalled();
+ initialRenderControl.resolve();
+ await result;
+ expect(onReady).toHaveBeenCalledTimes(1);
+ });
+
+ it('propagates asynchronous initial rendering failures', async () => {
+ jest.mocked(loadFrontComponentModule).mockResolvedValue({
+ default: async () => {
+ throw new Error('Component failed');
+ },
+ });
+
+ await expect(
+ renderFrontComponent({
+ connection: createConnection(),
+ renderContext: COMPONENT_RENDER_CONTEXT,
+ hostFetch: jest.fn(),
+ }),
+ ).rejects.toThrow('Component failed');
+ });
+
it('should fail closed when the host fetch bridge is unavailable', async () => {
await expect(
renderFrontComponent({
diff --git a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/renderFrontComponent.ts b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/renderFrontComponent.ts
index f8ff65552d8..3268de6bedc 100644
--- a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/renderFrontComponent.ts
+++ b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/renderFrontComponent.ts
@@ -71,7 +71,7 @@ export const renderFrontComponent = async ({
sharedDependenciesSource: renderContext.sharedDependenciesSource,
});
- componentModule.default(renderContainer);
+ await componentModule.default(renderContainer, renderContext.componentProps);
await waitForScheduledReactCommit();
flushPendingMutations();
diff --git a/packages/twenty-front-component-renderer/src/types/HostToWorkerRenderContext.ts b/packages/twenty-front-component-renderer/src/types/HostToWorkerRenderContext.ts
index 30bbaefd459..45870f44018 100644
--- a/packages/twenty-front-component-renderer/src/types/HostToWorkerRenderContext.ts
+++ b/packages/twenty-front-component-renderer/src/types/HostToWorkerRenderContext.ts
@@ -8,6 +8,7 @@ import { type ViewportGeometrySnapshot } from '@/types/ViewportGeometrySnapshot'
export type HostToWorkerRenderContext = {
componentUrl: string;
componentSource: string;
+ componentProps?: Record<string, unknown>;
applicationAccessToken?: string;
apiUrl?: string;
functionsBaseUrl?: string;
diff --git a/packages/twenty-sdk/src/front-component-renderer/build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts b/packages/twenty-sdk/src/front-component-renderer/build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
index 8dd27a13440..ac41881fa62 100644
--- a/packages/twenty-sdk/src/front-component-renderer/build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
+++ b/packages/twenty-sdk/src/front-component-renderer/build/utils/__tests__/unwrap-define-front-component-to-direct-export.spec.ts
@@ -1,4 +1,5 @@
import { transformSync } from 'esbuild';
+import { vi } from 'vitest';
import { unwrapDefineFrontComponentToDirectExport } from '@/front-component-renderer/build/utils/unwrap-define-front-component-to-direct-export';
@@ -49,16 +50,44 @@ export default defineSettingsFrontComponent({
});
`;
-const loadRenderer = (render: (element: unknown) => void) => {
+type RenderedElement = {
+ component: (props: object) => unknown;
+ props: object;
+};
+
+const loadRenderer = ({
+ render,
+ useEffect = () => {},
+ onCreateRoot = () => {},
+}: {
+ render: (element: RenderedElement) => void;
+ useEffect?: (effect: () => void) => void;
+ onCreateRoot?: (options: { onUncaughtError: (error: Error) => void }) => void;
+}) => {
const source = unwrapDefineFrontComponentToDirectExport(`
import { defineFrontComponent } from 'twenty-sdk/define';
export default defineFrontComponent({ component: () => null });
`);
const { code } = transformSync(source, { format: 'cjs' });
- const bundleModule = { exports: {} };
+ const bundleModule: {
+ exports: {
+ default?: (container: object, props?: object) => Promise<void>;
+ };
+ } = { exports: {} };
const requireModule = (specifier: string) => {
+ if (specifier === 'react') {
+ return { useEffect };
+ }
if (specifier === 'react-dom/client') {
- return { createRoot: () => ({ render }) };
+ return {
+ createRoot: (
+ _container: object,
+ options: { onUncaughtError: (error: Error) => void },
+ ) => {
+ onCreateRoot(options);
+ return { render };
+ },
+ };
}
if (specifier === 'react/jsx-runtime') {
return {
@@ -74,10 +103,19 @@ const loadRenderer = (render: (element: unknown) => void) => {
requireModule,
);
- return bundleModule.exports as { default: (container: object) => unknown };
+ if (typeof bundleModule.exports.default !== 'function') {
+ throw new Error('The compiled component did not export a renderer.');
+ }
+
+ return { default: bundleModule.exports.default };
};
describe('unwrapDefineFrontComponentToDirectExport', () => {
+ afterEach(() => {
+ vi.restoreAllMocks();
+ vi.useRealTimers();
+ });
+
it('renders the component when component is an inline factory call', () => {
const output = unwrapDefineFrontComponentToDirectExport(
INLINE_EXPRESSION_COMPONENT_SOURCE,
@@ -87,7 +125,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
'component: createSummarizeRecordEffect(SUMMARIZE_TARGETS.company),',
);
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineFrontComponent');
});
@@ -99,7 +137,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
expect(output).toContain('component: SummarizeRecordEffect,');
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineFrontComponent');
});
@@ -113,7 +151,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
);
const renderer =
- '\nexport default function __renderFrontComponent(__container) { __createRoot(__container).render(__frontComponentJsx(__frontComponentDefinition.component, {})); }\n';
+ 'export default function __renderFrontComponent(__container, __props = {})';
expect(inlineOutput).toContain(renderer);
expect(identifierOutput).toContain(renderer);
@@ -126,7 +164,7 @@ describe('unwrapDefineFrontComponentToDirectExport', () => {
expect(output).toContain('component: AppSettings,');
expect(output).toContain(
- '__frontComponentJsx(__frontComponentDefinition.component, {})',
+ '__frontComponentJsx(__frontComponentDefinition.component, __props)',
);
expect(output).not.toContain('defineSettingsFrontComponent');
});
@@ -140,23 +178,107 @@ export const createSummarizeRecordEffect = () => () => null;
expect(unwrapDefineFrontComponentToDirectExport(source)).toBe(source);
});
- it('keeps the synchronous renderer contract for existing callers', () => {
+ it('passes data props and waits for the initial commit', async () => {
+ vi.useFakeTimers();
const renderedElements: unknown[] = [];
- const renderer = loadRenderer((element) => renderedElements.push(element));
+ const effects: (() => void)[] = [];
+ const props = { records: [{ id: 'sample', name: 'Example' }] };
+ const renderer = loadRenderer({
+ render: (element) =>
+ renderedElements.push(element.component(element.props)),
+ useEffect: (effect) => effects.push(effect),
+ });
+ const onReady = vi.fn();
+ const result = renderer.default({}, props).then(onReady);
- expect(renderer.default({})).toBeUndefined();
+ await Promise.resolve();
+ expect(onReady).not.toHaveBeenCalled();
expect(renderedElements).toEqual([
- { component: expect.any(Function), props: {} },
+ { component: expect.any(Function), props },
]);
+ effects.forEach((effect) => effect());
+ await result;
+ expect(onReady).toHaveBeenCalledTimes(1);
+ expect(vi.getTimerCount()).toBe(0);
});
- it('propagates synchronous rendering failures to the caller', () => {
+ it('rejects the initial render when mounting fails', async () => {
+ vi.useFakeTimers();
const error = new Error('Cannot mount component');
- const renderer = loadRenderer(() => {
- throw error;
+ const renderer = loadRenderer({
+ render: () => {
+ throw error;
+ },
});
- expect(() => renderer.default({})).toThrow(error);
+ await expect(renderer.default({})).rejects.toThrow(error);
+ expect(vi.getTimerCount()).toBe(0);
+ });
+
+ it('reports an initial React error only through the render promise', async () => {
+ vi.useFakeTimers();
+ const queueMicrotask = vi.spyOn(globalThis, 'queueMicrotask');
+ const error = new Error('Initial React render failed');
+ const renderer = loadRenderer({
+ render: () => {},
+ onCreateRoot: ({ onUncaughtError }) => onUncaughtError(error),
+ });
+
+ await expect(renderer.default({})).rejects.toThrow(error);
+
+ expect(queueMicrotask).not.toHaveBeenCalled();
+ expect(vi.getTimerCount()).toBe(0);
+ });
+
+ it.each(['commit', 'timeout'])(
+ 'reports later React errors after the initial %s',
+ async (settlement) => {
+ vi.useFakeTimers();
+ const effects: (() => void)[] = [];
+ const rootOptions = { onUncaughtError: (_error: Error) => {} };
+ const renderer = loadRenderer({
+ render: (element) => element.component(element.props),
+ useEffect: (effect) => effects.push(effect),
+ onCreateRoot: (options) => {
+ rootOptions.onUncaughtError = options.onUncaughtError;
+ },
+ });
+ const result = renderer.default({});
+ if (settlement === 'commit') {
+ effects.forEach((effect) => effect());
+ await result;
+ } else {
+ const rejection = expect(result).rejects.toThrow(
+ 'Front component initial render timed out.',
+ );
+ await vi.advanceTimersByTimeAsync(30_000);
+ await rejection;
+ }
+
+ const queueMicrotask = vi
+ .spyOn(globalThis, 'queueMicrotask')
+ .mockImplementation(() => {});
+ const error = new Error('Later React render failed');
+ rootOptions.onUncaughtError(error);
+
+ expect(queueMicrotask).toHaveBeenCalledTimes(1);
+ expect(queueMicrotask.mock.calls[0][0]).toThrow(error);
+ expect(vi.getTimerCount()).toBe(0);
+ },
+ );
+
+ it('rejects when the first render never commits', async () => {
+ vi.useFakeTimers();
+ const renderer = loadRenderer({ render: () => {} });
+ const result = renderer.default({});
+ const rejection = expect(result).rejects.toThrow(
+ 'Front component initial render timed out.',
+ );
+
+ await vi.advanceTimersByTimeAsync(30_000);
+
+ await rejection;
+ expect(vi.getTimerCount()).toBe(0);
});
it('keeps imports used by a non-default definition', () => {
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/build-front-component.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/build-front-component.util.spec.ts
index 2085d89fb1d..53d883f0ec6 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/build-front-component.util.spec.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/build-front-component.util.spec.ts
@@ -13,7 +13,10 @@ const sharedDependencies: Parameters<
>[0]['sharedDependencies'] = {
checksum: 'a'.repeat(64),
exportNamesBySpecifier: new Map([
- ['react', { namedExports: ['useState'], hasDefaultExport: true }],
+ [
+ 'react',
+ { namedExports: ['useEffect', 'useState'], hasDefaultExport: true },
+ ],
[
'react/jsx-runtime',
{ namedExports: ['jsx', 'jsxs', 'Fragment'], hasDefaultExport: false },
diff --git a/packages/twenty-shared/src/front-component-build/unwrap-define-front-component-to-direct-export.ts b/packages/twenty-shared/src/front-component-build/unwrap-define-front-component-to-direct-export.ts
index e0559199091..f566806c67f 100644
--- a/packages/twenty-shared/src/front-component-build/unwrap-define-front-component-to-direct-export.ts
+++ b/packages/twenty-shared/src/front-component-build/unwrap-define-front-component-to-direct-export.ts
@@ -43,8 +43,38 @@ export const unwrapDefineFrontComponentToDirectExport = (
return (
`import { createRoot as __createRoot } from 'react-dom/client';\n` +
+ `import { useEffect as __useEffect } from 'react';\n` +
`import { jsx as __frontComponentJsx } from 'react/jsx-runtime';\n` +
transformedSource +
- `\nexport default function __renderFrontComponent(__container) { __createRoot(__container).render(__frontComponentJsx(${FRONT_COMPONENT_DEFINITION_NAME}.component, {})); }\n`
+ `\nexport default function __renderFrontComponent(__container, __props = {}) {
+ return new Promise((resolve, reject) => {
+ let hasSettled = false;
+ const timeout = setTimeout(() => {
+ settle(reject, new Error('Front component initial render timed out.'));
+ }, 30000);
+ function settle(callback, value) {
+ hasSettled = true;
+ clearTimeout(timeout);
+ callback(value);
+ }
+ function FrontComponentReadyEffect() {
+ __useEffect(() => {
+ settle(resolve);
+ }, []);
+ return __frontComponentJsx(${FRONT_COMPONENT_DEFINITION_NAME}.component, __props);
+ }
+ try {
+ __createRoot(__container, { onUncaughtError(error) {
+ if (hasSettled) {
+ queueMicrotask(() => { throw error; });
+ return;
+ }
+ settle(reject, error);
+ } }).render(__frontComponentJsx(FrontComponentReadyEffect, {}));
+ } catch (error) {
+ settle(reject, error);
+ }
+ });
+ }\n`
);
};