b0d7516951
## Summary Fully deprecates the cached `asExpression` / `generatedType` settings on `TS_VECTOR` (searchVector) fields. Previously the generated-column expression was stored in `FieldMetadataSettings` and kept in sync via imperative recompute side-effects. It is now **derived at DDL time** from the `searchFieldMetadata` rows that describe which fields feed the search vector, making `searchFieldMetadata` the single source of truth and removing a whole class of cache-drift bugs. This is delivered across the milestones tracked in #2587 and coordinates with the frontend migration (#1428). ## Why - The searchVector expression lived in two places (stored `settings.asExpression` + the actual generated column), kept consistent by bespoke side-effects (`recompute-search-vector-on-field-rename`, label-identifier recompute, etc.). - The frontend reconstructed the searchable-fields list by **regex-parsing** the stored `asExpression`. - Both are brittle. Deriving the expression from `searchFieldMetadata` rows at build/run time removes the cache and the parsing. ## What changed ### Server - data model & derivation - Introduce the `tsVectorFieldMetadata` relation on `searchFieldMetadata` (`tsVectorFieldMetadataId` / universal identifier) linking each searchable-field row to its target `TS_VECTOR` field. - New runtime derivation `deriveSearchVectorAsExpressionForTsVectorField` (`flat-search-field-metadata/utils/...`) used by the create-object and update-field handlers to generate the column expression from `searchFieldMetadata` rows. - Remove `asExpression` / `generatedType` from stored settings: `FieldMetadataSettings.TS_VECTOR` is now `null`; the column builder (`generate-column-definitions.util.ts`) hardcodes `generatedType: 'STORED'` and requires the derived expression. - Delete the imperative recompute side-effects and the `compute-search-vector-universal-settings-from-object-manifest` path; drop the `settings` block from all 28 standard `compute-*-standard-flat-field-metadata` utils. ### Server - migration runner - New `rebuildSearchVector` marker on `update-field` actions: the orchestrator synthesizes targeted column rebuilds (`compute-search-vector-rebuild-target-universal-identifiers.util.ts` + the deprioritize aggregator) only when a searchFieldMetadata change or indexed-field rename actually requires it - instead of rebuilding on every settings touch. - Deferrable FKs + in-flight ID resolution so a `searchFieldMetadata` row and its `TS_VECTOR` field can be created in the same transaction (deterministic UUIDs). ### Frontend (contract change, #1428) - New `SearchFieldMetadataDTO` + dataloader exposing `searchFieldMetadataList` on object metadata. - `SettingsObjectSearchSection` now reads `objectMetadataItem.searchFieldMetadatas` instead of parsing `asExpression`; new `SearchFieldMetadataItem` type, fragment, and mapping updates. ### Upgrade commands (2.18) - `2-18-instance-command-fast-...-add-ts-vector-field-metadata-id-to-search-field-metadata` - `2-18-instance-command-fast-...-make-search-field-metadata-fks-deferrable` - `2-18-instance-command-slow-...-backfill-ts-vector-field-metadata-id-on-search-field-metadata` (These were relocated from 2.16 to 2.18 and re-timestamped into an ordered block - add column -> make FK deferrable -> backfill data - since 2.16/2.17 are released.) ### Tests - Updated search-vector side-effect integration specs to assert behavior (search works) rather than the now-removed `asExpression`; removed the obsolete expression-validation specs; refreshed the application-sync snapshot (`universalSettings: null`). ## Upgrade / compatibility notes - Existing workspaces keep their stored `settings` until a later cleanup; nothing reads it anymore. The new derivation drives all DDL going forward. - Schema changes are gated behind the 2.18 instance commands above. ## Known follow-up (separate PR) https://github.com/twentyhq/core-team-issues/issues/2620 - The column rebuild (`DROP`/`ADD` of the `searchVector` STORED column) cascade-drops its GIN index and does not recreate it - a pre-existing regression on `main` inherited here. A follow-up PR will fix the rebuild handler to recreate the GIN index and add a 2.18 workspace command to recompute every search vector + strip the deprecated settings. (Planned.) ## Test plan - [ ] `npx nx typecheck twenty-server` / `twenty-front` - [ ] `npx nx lint:diff-with-main twenty-server` / `twenty-front` - [ ] Server integration: create/update/delete field, rename indexed field, update object - search returns expected records - [ ] Run the 2.18 instance commands on a seeded DB; verify `tsVectorFieldMetadataId` backfilled and FKs deferrable - [ ] Frontend: object Search settings tab lists the correct searchable fields (no `asExpression` parsing) close https://github.com/twentyhq/core-team-issues/issues/2587 <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22287?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. -->
109 lines
4.9 KiB
TypeScript
109 lines
4.9 KiB
TypeScript
import { type FromTo } from 'twenty-shared/types';
|
|
import { isDefined } from 'twenty-shared/utils';
|
|
|
|
import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
|
|
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
|
|
import { computeSearchFieldMetadataToCreateOnLabelIdentifierUpdate } from 'src/engine/metadata-modules/flat-object-metadata/utils/compute-search-field-metadata-to-create-on-label-identifier-update.util';
|
|
import { recomputeIndexAfterFlatObjectMetadataSingularNameUpdate } from 'src/engine/metadata-modules/flat-object-metadata/utils/recompute-index-after-flat-object-metadata-singular-name-update.util';
|
|
import { recomputeViewFieldIdentifierAfterFlatObjectIdentifierUpdate } from 'src/engine/metadata-modules/flat-object-metadata/utils/recompute-view-field-identifier-after-flat-object-identifier-update.util';
|
|
import { renameRelatedMorphFieldOnObjectNamesUpdate } from 'src/engine/metadata-modules/flat-object-metadata/utils/rename-related-morph-field-on-object-names-update.util';
|
|
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
|
|
import { type UniversalFlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-index-metadata.type';
|
|
import { type UniversalFlatSearchFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-search-field-metadata.type';
|
|
import { type UniversalFlatViewField } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-field.type';
|
|
|
|
export type FlatObjectMetadataUpdateSideEffects = {
|
|
otherObjectFlatFieldMetadatasToUpdate: UniversalFlatFieldMetadata[];
|
|
flatViewFieldsToUpdate: UniversalFlatViewField[];
|
|
flatViewFieldsToCreate: UniversalFlatViewField[];
|
|
flatIndexMetadatasToUpdate: UniversalFlatIndexMetadata[];
|
|
searchFieldMetadatasToCreate: UniversalFlatSearchFieldMetadata[];
|
|
};
|
|
|
|
type HandleFlatObjectMetadataUpdateSideEffectArgs = FromTo<
|
|
FlatObjectMetadata,
|
|
'flatObjectMetadata'
|
|
> &
|
|
Pick<
|
|
AllFlatEntityMaps,
|
|
| 'flatFieldMetadataMaps'
|
|
| 'flatObjectMetadataMaps'
|
|
| 'flatViewFieldMaps'
|
|
| 'flatIndexMaps'
|
|
| 'flatViewMaps'
|
|
| 'flatSearchFieldMetadataMaps'
|
|
>;
|
|
|
|
export const handleFlatObjectMetadataUpdateSideEffect = ({
|
|
flatIndexMaps,
|
|
flatFieldMetadataMaps,
|
|
flatObjectMetadataMaps,
|
|
flatViewFieldMaps,
|
|
flatViewMaps,
|
|
flatSearchFieldMetadataMaps,
|
|
fromFlatObjectMetadata,
|
|
toFlatObjectMetadata,
|
|
}: HandleFlatObjectMetadataUpdateSideEffectArgs): FlatObjectMetadataUpdateSideEffects => {
|
|
const { morphRelatedFlatIndexesToUpdate, morphFlatFieldMetadatasToUpdate } =
|
|
fromFlatObjectMetadata.nameSingular !== toFlatObjectMetadata.nameSingular ||
|
|
fromFlatObjectMetadata.namePlural !== toFlatObjectMetadata.namePlural
|
|
? renameRelatedMorphFieldOnObjectNamesUpdate({
|
|
flatFieldMetadataMaps,
|
|
fromFlatObjectMetadata,
|
|
toFlatObjectMetadata,
|
|
flatObjectMetadataMaps,
|
|
flatIndexMaps,
|
|
})
|
|
: {
|
|
morphRelatedFlatIndexesToUpdate: [],
|
|
morphFlatFieldMetadatasToUpdate: [],
|
|
};
|
|
|
|
const flatIndexMetadatasToUpdate =
|
|
fromFlatObjectMetadata.nameSingular !== toFlatObjectMetadata.nameSingular
|
|
? recomputeIndexAfterFlatObjectMetadataSingularNameUpdate({
|
|
flatFieldMetadataMaps,
|
|
existingFlatObjectMetadata: fromFlatObjectMetadata,
|
|
flatIndexMaps,
|
|
updatedSingularName: toFlatObjectMetadata.nameSingular,
|
|
})
|
|
: [];
|
|
|
|
const { flatViewFieldsToCreate, flatViewFieldsToUpdate } =
|
|
fromFlatObjectMetadata.labelIdentifierFieldMetadataId !==
|
|
toFlatObjectMetadata.labelIdentifierFieldMetadataId &&
|
|
isDefined(toFlatObjectMetadata.labelIdentifierFieldMetadataId) &&
|
|
isDefined(fromFlatObjectMetadata.labelIdentifierFieldMetadataId)
|
|
? recomputeViewFieldIdentifierAfterFlatObjectIdentifierUpdate({
|
|
existingFlatObjectMetadata: fromFlatObjectMetadata,
|
|
flatViewFieldMaps,
|
|
flatViewMaps,
|
|
flatFieldMetadataMaps,
|
|
updatedLabelIdentifierFieldMetadataId:
|
|
toFlatObjectMetadata.labelIdentifierFieldMetadataId,
|
|
})
|
|
: {
|
|
flatViewFieldsToCreate: [],
|
|
flatViewFieldsToUpdate: [],
|
|
};
|
|
|
|
const { searchFieldMetadatasToCreate } =
|
|
computeSearchFieldMetadataToCreateOnLabelIdentifierUpdate({
|
|
fromFlatObjectMetadata,
|
|
toFlatObjectMetadata,
|
|
flatFieldMetadataMaps,
|
|
flatSearchFieldMetadataMaps,
|
|
});
|
|
|
|
return {
|
|
flatIndexMetadatasToUpdate: [
|
|
...morphRelatedFlatIndexesToUpdate,
|
|
...flatIndexMetadatasToUpdate,
|
|
],
|
|
flatViewFieldsToCreate,
|
|
flatViewFieldsToUpdate,
|
|
otherObjectFlatFieldMetadatasToUpdate: morphFlatFieldMetadatasToUpdate,
|
|
searchFieldMetadatasToCreate,
|
|
};
|
|
};
|