Skip to content

The open alternative to Salesforce, designed for AI.

Fix duplicate AI component previews and empty sample data (#29471)

Weiko9cffc8ef65ea
diff --git a/packages/twenty-front/src/modules/ai/components/AiChatFrontComponentToolPreview.tsx b/packages/twenty-front/src/modules/ai/components/AiChatFrontComponentToolPreview.tsx
index bc81d1800d4..3ffd78b21fb 100644
--- a/packages/twenty-front/src/modules/ai/components/AiChatFrontComponentToolPreview.tsx
+++ b/packages/twenty-front/src/modules/ai/components/AiChatFrontComponentToolPreview.tsx
@@ -1,8 +1,10 @@
import { type DynamicToolUIPart, type ToolUIPart } from 'ai';
+import { PUBLISH_FRONT_COMPONENT_TOOL_NAME } from 'twenty-shared/ai';
import { isDefined } from 'twenty-shared/utils';
import { AiChatFrontComponentPreview } from '@/ai/components/AiChatFrontComponentPreview';
import { ThinkingToolStepRow } from '@/ai/components/ThinkingToolStepRow';
+import { useAgentChatPendingToolCalls } from '@/ai/hooks/useAgentChatPendingToolCalls';
import { getFrontComponentDraftId } from '@/ai/utils/getFrontComponentDraftId';
import { isThinkingStepPartActive } from '@/ai/utils/isThinkingStepPartActive';
@@ -16,6 +18,20 @@ export const AiChatFrontComponentToolPreview = ({
isStreaming,
}: AiChatFrontComponentToolPreviewProps) => {
const draftId = getFrontComponentDraftId(toolPart);
+ const pendingToolCalls = useAgentChatPendingToolCalls();
+
+ if (
+ isDefined(draftId) &&
+ pendingToolCalls.some(
+ (pendingToolCall) =>
+ pendingToolCall.kind === 'toolCallApproval' &&
+ pendingToolCall.proposal.toolName ===
+ PUBLISH_FRONT_COMPONENT_TOOL_NAME &&
+ pendingToolCall.proposal.arguments.draftId === draftId,
+ )
+ ) {
+ return null;
+ }
return isDefined(draftId) ? (
<AiChatFrontComponentPreview key={draftId} draftId={draftId} />
diff --git a/packages/twenty-front/src/modules/ai/components/__mocks__/aiChatFrontComponentPreviewMocks.ts b/packages/twenty-front/src/modules/ai/components/__mocks__/aiChatFrontComponentPreviewMocks.ts
index cda1dcb9754..4c9ad45b794 100644
--- a/packages/twenty-front/src/modules/ai/components/__mocks__/aiChatFrontComponentPreviewMocks.ts
+++ b/packages/twenty-front/src/modules/ai/components/__mocks__/aiChatFrontComponentPreviewMocks.ts
@@ -16,6 +16,50 @@ const COMPONENT_SOURCE = `export default function render(container) {
container.appendChild(button);
}`;
+const COMPANY_PREVIEW_SOURCE = `import { CoreApiClient } from 'twenty-client-sdk/core';
+export default async function render(container) {
+ const result = await new CoreApiClient().query({ companies: {
+ edges: { node: { id: true, name: true, employees: true, idealCustomerProfile: true } },
+ totalCount: true,
+ pageInfo: { hasNextPage: true },
+ } });
+ const companies = result.companies.edges.map(({ node }) => node);
+ const heading = document.createElement('html-h2');
+ heading.textContent = 'Company size overview';
+ const summary = document.createElement('html-p');
+ const search = document.createElement('html-input');
+ search.setAttribute('aria-label', 'Search companies');
+ const sort = document.createElement('html-button');
+ const list = document.createElement('html-ul');
+ let filter = '';
+ let sortByName = false;
+ const update = () => {
+ const visible = companies
+ .filter(company => company.name.toLowerCase().includes(filter))
+ .sort((left, right) => sortByName
+ ? left.name.localeCompare(right.name)
+ : right.employees - left.employees);
+ summary.textContent = visible.length + ' companies listed, ' +
+ visible.filter(company => company.idealCustomerProfile).length + ' ideal customer profiles';
+ sort.textContent = sortByName ? 'Sort by size' : 'Sort by name';
+ list.replaceChildren(...visible.map(company => {
+ const item = document.createElement('html-li');
+ item.textContent = company.name + ': ' + company.employees + ' employees';
+ return item;
+ }));
+ };
+ search.addEventListener('input', event => { filter = event.target.value.toLowerCase(); update(); });
+ sort.addEventListener('click', () => { sortByName = !sortByName; update(); });
+ container.append(heading, summary, search, sort, list);
+ update();
+}`;
+
+const COMPANY_RECORDS = [
+ { id: 'acme', name: 'Acme', employees: 50, idealCustomerProfile: true },
+ { id: 'nova', name: 'Nova', employees: 220, idealCustomerProfile: false },
+ { id: 'orbit', name: 'Orbit', employees: 10, idealCustomerProfile: true },
+];
+
const RUNTIME_ERROR_SOURCE = `export default function render() {
throw new Error('Component crashed.');
}`;
@@ -36,10 +80,22 @@ export const getFrontComponentPreviewMock = (draftId = 'current') => ({
: PageLayoutType.DASHBOARD,
isCurrent: draftId !== 'superseded',
publishedComponentId: draftId === 'saved' ? 'saved-component' : undefined,
- componentSource: RUNTIME_ERROR_SOURCES[draftId] ?? COMPONENT_SOURCE,
+ componentSource:
+ draftId === 'companies'
+ ? COMPANY_PREVIEW_SOURCE
+ : (RUNTIME_ERROR_SOURCES[draftId] ?? COMPONENT_SOURCE),
applicationId: 'storybook-app',
sharedDependenciesChecksum: 'storybook-checksum',
- mockQueryResult: {},
+ mockQueryResult:
+ draftId === 'companies'
+ ? {
+ companies: {
+ edges: COMPANY_RECORDS.map((node) => ({ node })),
+ totalCount: COMPANY_RECORDS.length,
+ pageInfo: { hasNextPage: false },
+ },
+ }
+ : {},
});
export const seedFrontComponentPreviewWorkspace = (isEnabled = true) => {
diff --git a/packages/twenty-front/src/modules/ai/components/__stories__/AiChatFrontComponentPreview.stories.tsx b/packages/twenty-front/src/modules/ai/components/__stories__/AiChatFrontComponentPreview.stories.tsx
index 9586d6021d7..fa561b6ca67 100644
--- a/packages/twenty-front/src/modules/ai/components/__stories__/AiChatFrontComponentPreview.stories.tsx
+++ b/packages/twenty-front/src/modules/ai/components/__stories__/AiChatFrontComponentPreview.stories.tsx
@@ -57,6 +57,45 @@ export const InteractivePreview: Story = {
},
};
+export const CompanySampleRecords: Story = {
+ args: { draftId: 'companies' },
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+ await expect(
+ await canvas.findByText(
+ '3 companies listed, 2 ideal customer profiles',
+ {},
+ { timeout: 30000 },
+ ),
+ ).toBeVisible();
+ const companyNames = () =>
+ canvas.getAllByRole('listitem').map((item) => item.textContent);
+ await expect(companyNames()).toEqual([
+ 'Nova: 220 employees',
+ 'Acme: 50 employees',
+ 'Orbit: 10 employees',
+ ]);
+ await userEvent.click(canvas.getByRole('button', { name: 'Sort by name' }));
+ await waitFor(() =>
+ expect(companyNames()).toEqual([
+ 'Acme: 50 employees',
+ 'Nova: 220 employees',
+ 'Orbit: 10 employees',
+ ]),
+ );
+ const search = canvas.getByRole('textbox', { name: 'Search companies' });
+ await userEvent.type(search, 'AC');
+ await expect(
+ await canvas.findByText('1 companies listed, 1 ideal customer profiles'),
+ ).toBeVisible();
+ await expect(companyNames()).toEqual(['Acme: 50 employees']);
+ await userEvent.clear(search);
+ await expect(
+ await canvas.findByText('3 companies listed, 2 ideal customer profiles'),
+ ).toBeVisible();
+ },
+};
+
export const RecordPage: Story = {
args: { draftId: 'record-page' },
play: async ({ canvasElement }) => {
diff --git a/packages/twenty-front/src/modules/ai/components/__stories__/AiChatToolCallApprovalCard.stories.tsx b/packages/twenty-front/src/modules/ai/components/__stories__/AiChatToolCallApprovalCard.stories.tsx
index 88bcf9be452..78c82c61c8a 100644
--- a/packages/twenty-front/src/modules/ai/components/__stories__/AiChatToolCallApprovalCard.stories.tsx
+++ b/packages/twenty-front/src/modules/ai/components/__stories__/AiChatToolCallApprovalCard.stories.tsx
@@ -3,6 +3,7 @@ import { http, HttpResponse } from 'msw';
import { getWorker } from 'msw-storybook-addon';
import { expect, userEvent, waitFor, within } from 'storybook/test';
import {
+ PREVIEW_FRONT_COMPONENT_TOOL_NAME,
PUBLISH_FRONT_COMPONENT_TOOL_NAME,
PROPOSE_TOOL_CALL_TOOL_NAME,
type ProposedToolCall,
@@ -11,6 +12,7 @@ import {
import { ComponentDecorator } from 'twenty-ui/testing';
import { AiChatPendingAskGate } from '@/ai/components/AiChatPendingAskGate';
+import { AiChatFrontComponentToolPreview } from '@/ai/components/AiChatFrontComponentToolPreview';
import { AGENT_CHAT_REFETCH_MESSAGES_EVENT_NAME } from '@/ai/constants/AgentChatRefetchMessagesEventName';
import { agentChatDisplayedThreadState } from '@/ai/states/agentChatDisplayedThreadState';
import { agentChatMessagesFamilyState } from '@/ai/states/agentChatMessagesFamilyState';
@@ -161,9 +163,21 @@ const requestedDraftIds: string[] = [];
export const PendingRequests: Story = {
render: () => (
- <AiChatPendingAskGate>
- <span>No pending requests</span>
- </AiChatPendingAskGate>
+ <>
+ <AiChatFrontComponentToolPreview
+ toolPart={{
+ type: `tool-${PREVIEW_FRONT_COMPONENT_TOOL_NAME}`,
+ toolCallId: 'preview-call',
+ state: 'output-available',
+ input: {},
+ output: { success: true, result: { draftId: 'current' } },
+ }}
+ isStreaming={false}
+ />
+ <AiChatPendingAskGate>
+ <span>No pending requests</span>
+ </AiChatPendingAskGate>
+ </>
),
beforeEach: () => {
requestedDraftIds.length = 0;
@@ -220,6 +234,11 @@ export const PendingRequests: Story = {
const canvas = within(canvasElement);
await canvas.findByRole('button', { name: 'Count: 0' }, { timeout: 30000 });
await expect(requestedDraftIds).toEqual(['current']);
+ await expect(
+ canvas.getAllByRole('region', {
+ name: 'Component preview with sample data',
+ }),
+ ).toHaveLength(1);
await userEvent.click(canvas.getByRole('button', { name: 'Add feedback' }));
await userEvent.type(
canvas.getByRole('textbox', { name: 'Feedback' }),
diff --git a/packages/twenty-front/src/modules/ai/components/__tests__/AiChatFrontComponentToolPreview.test.tsx b/packages/twenty-front/src/modules/ai/components/__tests__/AiChatFrontComponentToolPreview.test.tsx
new file mode 100644
index 00000000000..ce3d3c21be0
--- /dev/null
+++ b/packages/twenty-front/src/modules/ai/components/__tests__/AiChatFrontComponentToolPreview.test.tsx
@@ -0,0 +1,114 @@
+import { render, screen } from '@testing-library/react';
+import { type ToolUIPart } from 'ai';
+import {
+ PREVIEW_FRONT_COMPONENT_TOOL_NAME,
+ PUBLISH_FRONT_COMPONENT_TOOL_NAME,
+} from 'twenty-shared/ai';
+
+import { AiChatFrontComponentToolPreview } from '@/ai/components/AiChatFrontComponentToolPreview';
+import { type AgentChatPendingToolCall } from '@/ai/types/AgentChatPendingToolCall';
+
+let pendingToolCalls: AgentChatPendingToolCall[] = [];
+
+jest.mock('@/ai/hooks/useAgentChatPendingToolCalls', () => ({
+ useAgentChatPendingToolCalls: () => pendingToolCalls,
+}));
+
+jest.mock('@/ai/components/AiChatFrontComponentPreview', () => ({
+ AiChatFrontComponentPreview: () => (
+ <div role="region" aria-label="Component preview" />
+ ),
+}));
+
+jest.mock('@/ai/components/ThinkingToolStepRow', () => ({
+ ThinkingToolStepRow: () => <span>Preview tool result</span>,
+}));
+
+const TOOL_PART: ToolUIPart = {
+ type: `tool-${PREVIEW_FRONT_COMPONENT_TOOL_NAME}`,
+ toolCallId: 'preview-call',
+ state: 'output-available',
+ input: {},
+ output: { success: true, result: { draftId: 'draft' } },
+};
+
+const approval = (
+ draftId: string,
+ toolName = PUBLISH_FRONT_COMPONENT_TOOL_NAME,
+): AgentChatPendingToolCall => ({
+ kind: 'toolCallApproval',
+ toolCallId: 'approval-call',
+ proposal: {
+ toolName,
+ toolLabel: 'Publish Front Component',
+ summary: 'Save this component',
+ template: 'frontComponent',
+ arguments: { draftId, checksum: 'a'.repeat(64) },
+ },
+});
+
+describe('AiChatFrontComponentToolPreview', () => {
+ beforeEach(() => {
+ pendingToolCalls = [];
+ });
+
+ it('shows the preview before approval and again after the request is answered', () => {
+ const component = (
+ <AiChatFrontComponentToolPreview
+ toolPart={TOOL_PART}
+ isStreaming={false}
+ />
+ );
+ const { rerender } = render(component);
+ expect(
+ screen.getByRole('region', { name: 'Component preview' }),
+ ).toBeInTheDocument();
+
+ pendingToolCalls = [approval('draft')];
+ rerender(
+ <AiChatFrontComponentToolPreview
+ toolPart={TOOL_PART}
+ isStreaming={false}
+ />,
+ );
+ expect(
+ screen.queryByRole('region', { name: 'Component preview' }),
+ ).not.toBeInTheDocument();
+
+ pendingToolCalls = [];
+ rerender(component);
+ expect(
+ screen.getByRole('region', { name: 'Component preview' }),
+ ).toBeInTheDocument();
+ });
+
+ it.each([approval('other-draft'), approval('draft', 'another_tool')])(
+ 'keeps the preview for an unrelated approval',
+ (pendingApproval) => {
+ pendingToolCalls = [pendingApproval];
+ render(
+ <AiChatFrontComponentToolPreview
+ toolPart={TOOL_PART}
+ isStreaming={false}
+ />,
+ );
+ expect(
+ screen.getByRole('region', { name: 'Component preview' }),
+ ).toBeInTheDocument();
+ },
+ );
+
+ it('keeps failed preview tool results visible during approval', () => {
+ pendingToolCalls = [approval('draft')];
+ render(
+ <AiChatFrontComponentToolPreview
+ toolPart={{
+ ...TOOL_PART,
+ output: { success: false, error: 'Build failed' },
+ }}
+ isStreaming={false}
+ />,
+ );
+ expect(screen.getByText('Preview tool result')).toBeInTheDocument();
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.spec.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.spec.ts
index c0fce797eb7..d5627cb8c00 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.spec.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.spec.ts
@@ -6,10 +6,23 @@ const INPUT = {
name: 'Companies',
source: 'export const Component = () => <div />;',
query: { objectName: 'company', select: ['name'], limit: 20 },
- sampleRecords: [],
+ sampleRecords: [{ name: 'Acme' }],
};
describe('frontComponentDraftSchema', () => {
+ it('requires sample records to preview the component', () => {
+ const result = frontComponentDraftSchema.safeParse({
+ ...INPUT,
+ pageLayoutType: PageLayoutType.DASHBOARD,
+ sampleRecords: [],
+ });
+
+ expect(result.success).toBe(false);
+ expect(result.error?.issues).toEqual([
+ expect.objectContaining({ path: ['sampleRecords'], code: 'too_small' }),
+ ]);
+ });
+
it.each([PageLayoutType.DASHBOARD, PageLayoutType.RECORD_PAGE])(
'accepts one %s surface',
(pageLayoutType) => {
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.ts
index c3ec3b92d3e..745b5ff5741 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/schemas/front-component-draft.schema.ts
@@ -15,10 +15,16 @@ export const frontComponentDraftSchema = z.object({
.min(1)
.max(50000)
.describe(
- 'TSX exporting a named Component that takes no props, with no default export. Load records with CoreApiClient from twenty-client-sdk/core, using the workspace object plural name and selecting edges.node, totalCount and pageInfo.hasNextPage. The query must match the preview query. Twenty adds the theme and defineFrontComponent registration. Use React and supported twenty-ui imports.',
+ 'TSX exporting a named Component that takes no props, with no default export. Load records with CoreApiClient from twenty-client-sdk/core, using an object selection keyed by the workspace object plural name and selecting edges.node, totalCount and pageInfo.hasNextPage. Read the result directly by that plural name, without a data wrapper. The query must match the preview query. Twenty adds the theme and defineFrontComponent registration. Use React and supported twenty-ui imports.',
),
query: frontComponentQuerySchema.describe(
'Object and fields mocked during preview. Saved components load their own data through the app SDK; this query is not persisted in their source.',
),
- sampleRecords: z.array(z.record(z.string(), z.unknown())).max(100),
+ sampleRecords: z
+ .array(z.record(z.string(), z.unknown()))
+ .min(1)
+ .max(100)
+ .describe(
+ 'Provide realistic fictional records for preview, including every selected field with its metadata type. Use varied values so filters, sorting and summary counts can be exercised. These records are only used in preview, never saved as workspace records or embedded in the component source.',
+ ),
});
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/validate-front-component-sample-records-or-throw.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/validate-front-component-sample-records-or-throw.util.spec.ts
index 965378f75eb..855c36c8157 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/validate-front-component-sample-records-or-throw.util.spec.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/__tests__/validate-front-component-sample-records-or-throw.util.spec.ts
@@ -9,15 +9,26 @@ it('allows selected fields and record IDs', () => {
).not.toThrow();
});
-it('allows an empty mock dataset', () => {
+it('allows null and falsy values for selected fields', () => {
expect(() =>
validateFrontComponentSampleRecordsOrThrow({
- sampleRecords: [],
- selectedFields: ['name'],
+ sampleRecords: [
+ { employees: 0, idealCustomerProfile: false, city: null },
+ ],
+ selectedFields: ['employees', 'idealCustomerProfile', 'city'],
}),
).not.toThrow();
});
+it('rejects samples missing a selected field', () => {
+ expect(() =>
+ validateFrontComponentSampleRecordsOrThrow({
+ sampleRecords: [{ name: 'Acme', employees: 50 }, { name: 'Nova' }],
+ selectedFields: ['name', 'employees'],
+ }),
+ ).toThrow('Sample records must include every selected field.');
+});
+
it('rejects a field outside the query selection', () => {
expect(() =>
validateFrontComponentSampleRecordsOrThrow({
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/validate-front-component-sample-records-or-throw.util.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/validate-front-component-sample-records-or-throw.util.ts
index 28f9137210a..fe162210a61 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/validate-front-component-sample-records-or-throw.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-front-component/utils/validate-front-component-sample-records-or-throw.util.ts
@@ -37,4 +37,19 @@ export const validateFrontComponentSampleRecordsOrThrow = ({
},
);
}
+ if (
+ sampleRecords.some((record) =>
+ selectedFields.some(
+ (field) => !Object.prototype.hasOwnProperty.call(record, field),
+ ),
+ )
+ ) {
+ throw new ApplicationException(
+ doNotTranslate('Sample records must include every selected field.'),
+ ApplicationExceptionCode.INVALID_INPUT,
+ {
+ userFriendlyMessage: msg`Sample records must include every selected field.`,
+ },
+ );
+ }
};