Files
twenty/packages/twenty-front/scripts/mock-data/generate-record-data.ts
T
Charles Bochet 8a7a19f312 Improve test tooling (#18259)
## Summary

Unifies test mocking tooling across Jest and Storybook, replaces
handcrafted mock data with auto-generated server-fetched data, and
restructures the mock data generation script for maintainability.

### Mock data generation

- Split `generate-mock-data.ts` into three focused modules under
`scripts/mock-data/`:
  - `utils.ts` — shared authentication, GraphQL client, and file writer
  - `generate-metadata.ts` — fetches object metadata from `/metadata`
- `generate-record-data.ts` — fetches record data from `/graphql` using
metadata-driven dynamic queries
- The orchestrator (`generate-mock-data.ts`) authenticates once and
passes the token to both generators
- Company records are now fetched from the actual server (limited to 10
records) instead of being handcrafted
- Generated files are organized under `generated/metadata/objects/` and
`generated/data/companies/`

### Unified test utilities

- Consolidated Jest and MSW mocking into shared utilities that compose
production code (`prefillRecord`, `getRecordNodeFromRecord`,
`getRecordConnectionFromRecords`) with mock metadata
- Renamed `generateEmptyJestRecordNode` → `generateMockRecordNode` and
moved to `testing/utils/`
- Extracted `generateMockRecordConnection` into its own file
- Removed `sanitizeInputForPrefill` workaround (no longer needed with
correctly shaped generated data)
2026-02-26 14:31:54 +01:00

86 lines
2.7 KiB
TypeScript

/* eslint-disable no-console */
import { print } from 'graphql';
import { type ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
import { generateDepthRecordGqlFieldsFromObject } from '@/object-record/graphql/record-gql-fields/utils/generateDepthRecordGqlFieldsFromObject';
import { generateFindManyRecordsQuery } from '@/object-record/utils/generateFindManyRecordsQuery';
import { graphqlRequest, writeGeneratedFile } from './utils.js';
const RECORDS_LIMIT = 10;
// Production query builders omit __typename on connection/edge wrappers
// since Apollo Client injects them automatically. Raw fetch needs them explicit.
const addTypenamesToSelections = (query: string): string =>
query.replace(/\{(?!\s*__typename\b)/g, '{\n__typename');
const toObjectMetadataItems = (rawMetadata: {
objects: { edges: { node: Record<string, unknown> }[] };
}): ObjectMetadataItem[] =>
rawMetadata.objects.edges.map((edge) => {
const { fieldsList, indexMetadataList, ...rest } = edge.node;
return {
...rest,
fields: fieldsList,
readableFields: fieldsList,
updatableFields: fieldsList,
indexMetadatas: ((indexMetadataList as unknown[]) ?? []).map(
(index: any) => ({
...index,
indexFieldMetadatas: index.indexFieldMetadataList ?? [],
}),
),
} as unknown as ObjectMetadataItem;
});
export const generateRecordData = async (
token: string,
rawMetadata: { objects: { edges: { node: Record<string, unknown> }[] } },
) => {
const objectMetadataItems = toObjectMetadataItems(rawMetadata);
const companyObject = objectMetadataItems.find(
(item) => item.nameSingular === 'company',
);
if (!companyObject) {
throw new Error('Company object metadata not found');
}
const recordGqlFields = generateDepthRecordGqlFieldsFromObject({
objectMetadataItems,
objectMetadataItem: companyObject,
depth: 1,
});
const queryDocument = generateFindManyRecordsQuery({
objectMetadataItem: companyObject,
objectMetadataItems,
recordGqlFields,
objectPermissionsByObjectMetadataId: {},
});
const query = addTypenamesToSelections(print(queryDocument));
console.log(
`Fetching ${companyObject.namePlural} (limit: ${RECORDS_LIMIT}) from /graphql ...`,
);
const data = (await graphqlRequest('/graphql', query, token, {
limit: RECORDS_LIMIT,
})) as Record<string, { edges: { node: Record<string, unknown> }[] }>;
const records = data[companyObject.namePlural].edges.map((edge) => edge.node);
console.log(` Got ${records.length} ${companyObject.namePlural}.`);
writeGeneratedFile(
'data/companies/mock-companies-data.ts',
'mockedCompanyRecords',
'Record<string, unknown>[]',
'',
records,
);
};