houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(data-model): custom-indexes management UI and mutations (#20846)

Browse Source 
## Summary

Brings indexes management into the per-object Settings tab as a section
under Search (no feature flag, advanced mode only). Admins can create /
delete non-unique indexes with the UI; apps can declare indexes in code
with `defineIndex`. Composite-typed fields are now indexable by picking
a specific sub-column (e.g. `Address > City`).

A few related polish items also land here (invite-user dropdown lands on
the Invite tab; standard warning callout above the new-index form).

## What ships

### UI — custom indexes on per-object Settings
- New section directly under Search, wrapped in
`AdvancedSettingsWrapper`.
- Filter dropdown on the search bar toggles system-index visibility
(shown by default since advanced mode).
- **+ Add Index** button (disabled with tooltip once the per-object cap
is reached) navigates to a dedicated `SettingsObjectNewIndex` page
(matches the field-creation pattern, not a modal):
- Field picker mirrors the webhook event-form layout (rows of dropdowns,
implicit trailing empty row).
- Composite fields surface their sub-properties (`Address > City`,
`Currency > Amount`, …).
  - BTREE / GIN type selector.
- Standard warning Callout: "Use indexes sparingly — each one speeds
reads but slows writes."
- Trash icon on `isCustom: true` rows → confirmation modal →
`deleteOneIndex`.

### Server — `createOneIndex` / `deleteOneIndex` mutations
- Gated by `SettingsPermissionGuard(DATA_MODEL)`.
- `IndexMetadataService` wraps the existing migration runner via
`WorkspaceMigrationValidateBuildAndRunService` so the metadata row and
the SQL index land atomically.
- Validation: rejects empty fields, duplicate `(fieldMetadataId,
subFieldName)` pairs, fields not on the object, requires `subFieldName`
for composite parents, forbids `subFieldName` on scalar/relation,
enforces `MAX_CUSTOM_INDEXES_PER_OBJECT = 10`.
- Delete refuses on `isCustom: false` rows so system indexes can't be
removed via this API.
- Dedicated GraphQL exception handler maps each typed error to the right
transport error class.

### Composite sub-field indexing
- Adds `subFieldName: string | null` column to
`IndexFieldMetadataEntity` (fast instance command).
- The flat-entity flow (`UniversalFlatIndexFieldMetadata`,
`FlatIndexFieldMetadata`, `from-universal-flat-index-to-flat-index`,
runner column resolution) all carry `subFieldName` through.
- For composite parents, the runner uses
`computeCompositeColumnName({...}, property)` for the picked sub-column;
for non-composite parents, behavior is unchanged.
- The `'::'` separator encodes `(fieldMetadataId, subFieldName)` for
dedup on the wire; the frontend uses the same separator inside the
Select component's string value.

### Apps can declare indexes in code (`defineIndex`)
- New `IndexManifest` + `IndexFieldManifest` types in
`twenty-shared/application` wired into the `Manifest` type.
- `defineIndex` SDK helper + `IndexConfig`. CLI manifest builder +
extractor recognize `defineIndex` / `ManifestEntityKey.Indexes`.
- Server: `from-index-manifest-to-universal-flat-index` converter
resolves field IDs, validates composite/scalar `subFieldName` rules, and
delegates to `generateFlatIndexMetadataWithNameOrThrow` for the
deterministic name.
- Orchestrator wires the loop after the field-resolution pass;
per-object cap enforced inline against the manifest.
- Cascade on uninstall is automatic — when an app disappears its indexes
drop with it (universal-flat-entity diff handles it).
- Rich-app fixture ships a real `defineIndex` on `PostCard.status`,
exercising the full manifest → install path in CI.

### Closed for now (open later if needed)
- Apps cannot declare `isUnique` indexes — unique constraints stay with
the field-creation flow.
- Apps cannot use a partial-`indexWhereClause` — the UI surface keeps
the framework's hardcoded allowlist.
- UI cannot create unique or partial indexes either; same reasons.

### Cleanups along the way
- Reused the existing `getCompositeSubFieldLabel` +
`COMPOSITE_FIELD_SUB_FIELD_LABELS` (deleted the duplicates I'd created
early in the PR).
- Moved `MAX_CUSTOM_INDEXES_PER_OBJECT` to `twenty-shared/constants`
(single source for FE + BE).
- Replaced inline `isDefined(x) && x !== ''` with `isNonEmptyString`
(from `@sniptt/guards`).
- Hoisted the per-object fields Map + inlined the cap counter into the
indexes orchestrator loop (drops the install scan from O(indexes ×
totalFields) to O(totalFields + indexes)).
- Per design-feedback: page-based create flow (not a modal), filter
dropdown on the SearchInput (not a separate toggle), webhook-style
picker, field icons.

### Unrelated polish that lands here
- "Invite user" link in the multi-workspace dropdown now lands on the
Invite tab directly (`#invite`) instead of the first tab of the members
page.

## Test plan
- [ ] `npx nx typecheck twenty-server / twenty-front / twenty-sdk /
twenty-shared` — passes
- [ ] `npx nx lint:diff-with-main twenty-server / twenty-front` — clean
- [ ] `npx jest index-metadata.service.spec` — green
- [ ] `npx jest from-index-manifest-to-universal-flat-index` — green
(new converter spec, 8 cases)
- [ ] `npx vitest run
src/sdk/define/indexes/__tests__/define-index.spec.ts` (twenty-sdk) —
green (6 cases)
- [ ] `npx vitest run --config vitest.integration.config.ts -t
"rich-app"` — green (rich-app app-dev integration exercises the new
manifest path with the PostCard.status index)
- [ ] Advanced mode → Settings → any object → Settings tab → Indexes
section is visible under Search
- [ ] Create a single-field BTREE index, confirm SQL index exists
(verify via `pg_indexes`)
- [ ] Create a composite-field index (`Address > City`) and confirm the
column is `addressAddressCity`
- [ ] Create an index spanning two columns; column order matches the
picker order
- [ ] Attempt to create an 11th custom index → button is disabled with
tooltip
- [ ] Delete a custom index → confirmation modal → row disappears, PG
index dropped
- [ ] System indexes have no trash icon and are hidden by default
This commit is contained in:
Félix Malfait
2026-05-25 17:47:09 +02:00
committed by GitHub
parent 69d89f8cfc
commit d602f35cbd
98 changed files with 3742 additions and 387 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-apps/fixtures/rich-app/src/indexes/post-card-status.index.ts
+17
View File
@@ -0,0 +1,17 @@
import { defineIndex } from 'twenty-sdk/define';
import {
POST_CARD_UNIVERSAL_IDENTIFIER,
STATUS_FIELD_UNIVERSAL_IDENTIFIER,
} from '../objects/post-card.object';
export default defineIndex({
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff0',
objectUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
fields: [
{
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff1',
fieldUniversalIdentifier: STATUS_FIELD_UNIVERSAL_IDENTIFIER,
},
],
});
packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+24
View File
@@ -523,6 +523,7 @@ type IndexField {
id: UUID!
fieldMetadataId: UUID!
order: Float!
subFieldName: String
createdAt: DateTime!
updatedAt: DateTime!
}
@@ -3209,6 +3210,8 @@ type Mutation {
createOneObject(input: CreateOneObjectInput!): Object!
deleteOneObject(input: DeleteOneObjectInput!): Object!
updateOneObject(input: UpdateOneObjectInput!): Object!
createOneIndex(input: CreateOneIndexInput!): Index!
deleteOneIndex(input: DeleteOneIndexInput!): Index!
createOneAgent(input: CreateAgentInput!): Agent!
updateOneAgent(input: UpdateAgentInput!): Agent!
deleteOneAgent(input: AgentIdInput!): Agent!
@@ -3925,6 +3928,27 @@ input UpdateObjectPayload {
isSearchable: Boolean
}
input CreateOneIndexInput {
"""The custom index to create"""
index: CreateIndexInput!
}
input CreateIndexInput {
objectMetadataId: UUID!
fields: [CreateIndexFieldInput!]!
indexType: IndexType! = BTREE
}
input CreateIndexFieldInput {
fieldMetadataId: UUID!
subFieldName: String
}
input DeleteOneIndexInput {
"""The id of the custom index to delete."""
id: UUID!
}
input CreateAgentInput {
name: String
label: String!
packages/twenty-client-sdk/src/metadata/generated/schema.ts
+18
View File
@@ -386,6 +386,7 @@ export interface IndexField {
id: Scalars['UUID']
fieldMetadataId: Scalars['UUID']
order: Scalars['Float']
subFieldName?: Scalars['String']
createdAt: Scalars['DateTime']
updatedAt: Scalars['DateTime']
__typename: 'IndexField'
@@ -2742,6 +2743,8 @@ export interface Mutation {
createOneObject: Object
deleteOneObject: Object
updateOneObject: Object
createOneIndex: Index
deleteOneIndex: Index
createOneAgent: Agent
updateOneAgent: Agent
deleteOneAgent: Agent
@@ -3257,6 +3260,7 @@ export interface IndexFieldGenqlSelection{
id?: boolean | number
fieldMetadataId?: boolean | number
order?: boolean | number
subFieldName?: boolean | number
createdAt?: boolean | number
updatedAt?: boolean | number
__typename?: boolean | number
@@ -5795,6 +5799,8 @@ export interface MutationGenqlSelection{
createOneObject?: (ObjectGenqlSelection & { __args: {input: CreateOneObjectInput} })
deleteOneObject?: (ObjectGenqlSelection & { __args: {input: DeleteOneObjectInput} })
updateOneObject?: (ObjectGenqlSelection & { __args: {input: UpdateOneObjectInput} })
createOneIndex?: (IndexGenqlSelection & { __args: {input: CreateOneIndexInput} })
deleteOneIndex?: (IndexGenqlSelection & { __args: {input: DeleteOneIndexInput} })
createOneAgent?: (AgentGenqlSelection & { __args: {input: CreateAgentInput} })
updateOneAgent?: (AgentGenqlSelection & { __args: {input: UpdateAgentInput} })
deleteOneAgent?: (AgentGenqlSelection & { __args: {input: AgentIdInput} })
@@ -6126,6 +6132,18 @@ id: Scalars['UUID']}
export interface UpdateObjectPayload {labelSingular?: (Scalars['String'] | null),labelPlural?: (Scalars['String'] | null),nameSingular?: (Scalars['String'] | null),namePlural?: (Scalars['String'] | null),description?: (Scalars['String'] | null),icon?: (Scalars['String'] | null),shortcut?: (Scalars['String'] | null),color?: (Scalars['String'] | null),isActive?: (Scalars['Boolean'] | null),labelIdentifierFieldMetadataId?: (Scalars['UUID'] | null),imageIdentifierFieldMetadataId?: (Scalars['UUID'] | null),isLabelSyncedWithName?: (Scalars['Boolean'] | null),isSearchable?: (Scalars['Boolean'] | null)}
export interface CreateOneIndexInput {
/** The custom index to create */
index: CreateIndexInput}
export interface CreateIndexInput {objectMetadataId: Scalars['UUID'],fields: CreateIndexFieldInput[],indexType: IndexType}
export interface CreateIndexFieldInput {fieldMetadataId: Scalars['UUID'],subFieldName?: (Scalars['String'] | null)}
export interface DeleteOneIndexInput {
/** The id of the custom index to delete. */
id: Scalars['UUID']}
export interface CreateAgentInput {name?: (Scalars['String'] | null),label: Scalars['String'],icon?: (Scalars['String'] | null),description?: (Scalars['String'] | null),prompt: Scalars['String'],modelId: Scalars['String'],roleId?: (Scalars['UUID'] | null),responseFormat?: (Scalars['JSON'] | null),modelConfiguration?: (Scalars['JSON'] | null),evaluationInputs?: (Scalars['String'][] | null)}
export interface UpdateAgentInput {id: Scalars['UUID'],name?: (Scalars['String'] | null),label?: (Scalars['String'] | null),icon?: (Scalars['String'] | null),description?: (Scalars['String'] | null),prompt?: (Scalars['String'] | null),modelId?: (Scalars['String'] | null),roleId?: (Scalars['UUID'] | null),responseFormat?: (Scalars['JSON'] | null),modelConfiguration?: (Scalars['JSON'] | null),evaluationInputs?: (Scalars['String'][] | null)}
packages/twenty-client-sdk/src/metadata/generated/types.ts
+132 -70
View File
@@ -78,8 +78,8 @@ export default {
334,
341,
377,
454,
466
458,
470
],
"types": {
"BillingProductDTO": {
@@ -972,6 +972,9 @@ export default {
"order": [
11
],
"subFieldName": [
1
],
"createdAt": [
4
],
@@ -7491,11 +7494,29 @@ export default {
]
}
],
"createOneIndex": [
46,
{
"input": [
405,
"CreateOneIndexInput!"
]
}
],
"deleteOneIndex": [
46,
{
"input": [
408,
"DeleteOneIndexInput!"
]
}
],
"createOneAgent": [
25,
{
"input": [
405,
409,
"CreateAgentInput!"
]
}
@@ -7504,7 +7525,7 @@ export default {
25,
{
"input": [
406,
410,
"UpdateAgentInput!"
]
}
@@ -7535,7 +7556,7 @@ export default {
29,
{
"createRoleInput": [
407,
411,
"CreateRoleInput!"
]
}
@@ -7544,7 +7565,7 @@ export default {
29,
{
"updateRoleInput": [
408,
412,
"UpdateRoleInput!"
]
}
@@ -7562,7 +7583,7 @@ export default {
16,
{
"upsertObjectPermissionsInput": [
410,
414,
"UpsertObjectPermissionsInput!"
]
}
@@ -7571,7 +7592,7 @@ export default {
27,
{
"upsertPermissionFlagsInput": [
412,
416,
"UpsertPermissionFlagsInput!"
]
}
@@ -7580,7 +7601,7 @@ export default {
26,
{
"upsertFieldPermissionsInput": [
413,
417,
"UpsertFieldPermissionsInput!"
]
}
@@ -7589,7 +7610,7 @@ export default {
229,
{
"input": [
415,
419,
"UpsertRowLevelPermissionPredicatesInput!"
]
}
@@ -7620,7 +7641,7 @@ export default {
274,
{
"input": [
418,
422,
"CreateWebhookInput!"
]
}
@@ -7629,7 +7650,7 @@ export default {
274,
{
"input": [
419,
423,
"UpdateWebhookInput!"
]
}
@@ -7647,7 +7668,7 @@ export default {
43,
{
"input": [
421,
425,
"CreateOneFieldMetadataInput!"
]
}
@@ -7656,7 +7677,7 @@ export default {
43,
{
"input": [
423,
427,
"UpdateOneFieldMetadataInput!"
]
}
@@ -7665,7 +7686,7 @@ export default {
43,
{
"input": [
425,
429,
"DeleteOneFieldInput!"
]
}
@@ -7674,7 +7695,7 @@ export default {
65,
{
"input": [
426,
430,
"CreateViewGroupInput!"
]
}
@@ -7683,7 +7704,7 @@ export default {
65,
{
"inputs": [
426,
430,
"[CreateViewGroupInput!]!"
]
}
@@ -7692,7 +7713,7 @@ export default {
65,
{
"input": [
427,
431,
"UpdateViewGroupInput!"
]
}
@@ -7701,7 +7722,7 @@ export default {
65,
{
"inputs": [
427,
431,
"[UpdateViewGroupInput!]!"
]
}
@@ -7710,7 +7731,7 @@ export default {
65,
{
"input": [
429,
433,
"DeleteViewGroupInput!"
]
}
@@ -7719,7 +7740,7 @@ export default {
65,
{
"input": [
430,
434,
"DestroyViewGroupInput!"
]
}
@@ -7728,7 +7749,7 @@ export default {
315,
{
"input": [
431,
435,
"UpdateMessageFolderInput!"
]
}
@@ -7737,7 +7758,7 @@ export default {
315,
{
"input": [
433,
437,
"UpdateMessageFoldersInput!"
]
}
@@ -7746,7 +7767,7 @@ export default {
306,
{
"input": [
434,
438,
"UpdateMessageChannelInput!"
]
}
@@ -7755,7 +7776,7 @@ export default {
314,
{
"input": [
436,
440,
"CreateEmailGroupChannelInput!"
]
}
@@ -7782,7 +7803,7 @@ export default {
301,
{
"input": [
437,
441,
"UpdateCalendarChannelInput!"
]
}
@@ -7812,7 +7833,7 @@ export default {
1
],
"fileAttachments": [
439,
443,
"[FileAttachmentInput!]"
]
}
@@ -7879,7 +7900,7 @@ export default {
290,
{
"input": [
440,
444,
"CreateSkillInput!"
]
}
@@ -7888,7 +7909,7 @@ export default {
290,
{
"input": [
441,
445,
"UpdateSkillInput!"
]
}
@@ -7946,7 +7967,7 @@ export default {
238,
{
"input": [
442,
446,
"GetAuthorizationUrlForSSOInput!"
]
}
@@ -8200,7 +8221,7 @@ export default {
197,
{
"input": [
443,
447,
"CreateApplicationRegistrationInput!"
]
}
@@ -8209,7 +8230,7 @@ export default {
7,
{
"input": [
444,
448,
"UpdateApplicationRegistrationInput!"
]
}
@@ -8236,7 +8257,7 @@ export default {
5,
{
"input": [
446,
450,
"CreateApplicationRegistrationVariableInput!"
]
}
@@ -8245,7 +8266,7 @@ export default {
5,
{
"input": [
447,
451,
"UpdateApplicationRegistrationVariableInput!"
]
}
@@ -8334,7 +8355,7 @@ export default {
6,
{
"input": [
449,
453,
"UpdateWorkspaceMemberSettingsInput!"
]
}
@@ -8368,7 +8389,7 @@ export default {
75,
{
"data": [
450,
454,
"ActivateWorkspaceInput!"
]
}
@@ -8377,7 +8398,7 @@ export default {
75,
{
"data": [
451,
455,
"UpdateWorkspaceInput!"
]
}
@@ -8392,7 +8413,7 @@ export default {
6,
{
"workspaceMigration": [
452,
456,
"WorkspaceMigrationInput!"
]
}
@@ -8410,7 +8431,7 @@ export default {
220,
{
"input": [
455,
459,
"SetupOIDCSsoInput!"
]
}
@@ -8419,7 +8440,7 @@ export default {
220,
{
"input": [
456,
460,
"SetupSAMLSsoInput!"
]
}
@@ -8428,7 +8449,7 @@ export default {
216,
{
"input": [
457,
461,
"DeleteSsoInput!"
]
}
@@ -8437,7 +8458,7 @@ export default {
217,
{
"input": [
458,
462,
"EditSsoInput!"
]
}
@@ -8468,7 +8489,7 @@ export default {
286,
{
"input": [
459,
463,
"SendEmailInput!"
]
}
@@ -8490,7 +8511,7 @@ export default {
"String!"
],
"connectionParameters": [
461,
465,
"EmailAccountConnectionParameters!"
],
"id": [
@@ -8502,7 +8523,7 @@ export default {
168,
{
"input": [
463,
467,
"UpdateLabPublicFeatureFlagInput!"
]
}
@@ -8584,7 +8605,7 @@ export default {
77,
{
"input": [
464,
468,
"CreateOneAppTokenInput!"
]
}
@@ -8659,7 +8680,7 @@ export default {
"String!"
],
"fileFolder": [
466,
470,
"FileFolder!"
],
"filePath": [
@@ -10012,6 +10033,47 @@ export default {
1
]
},
"CreateOneIndexInput": {
"index": [
406
],
"__typename": [
1
]
},
"CreateIndexInput": {
"objectMetadataId": [
3
],
"fields": [
407
],
"indexType": [
47
],
"__typename": [
1
]
},
"CreateIndexFieldInput": {
"fieldMetadataId": [
3
],
"subFieldName": [
1
],
"__typename": [
1
]
},
"DeleteOneIndexInput": {
"id": [
3
],
"__typename": [
1
]
},
"CreateAgentInput": {
"name": [
1
@@ -10131,7 +10193,7 @@ export default {
},
"UpdateRoleInput": {
"update": [
409
413
],
"id": [
3
@@ -10186,7 +10248,7 @@ export default {
3
],
"objectPermissions": [
411
415
],
"__typename": [
1
@@ -10228,7 +10290,7 @@ export default {
3
],
"fieldPermissions": [
414
418
],
"__typename": [
1
@@ -10259,10 +10321,10 @@ export default {
3
],
"predicates": [
416
420
],
"predicateGroups": [
417
421
],
"__typename": [
1
@@ -10345,7 +10407,7 @@ export default {
3
],
"update": [
420
424
],
"__typename": [
1
@@ -10370,7 +10432,7 @@ export default {
},
"CreateOneFieldMetadataInput": {
"field": [
422
426
],
"__typename": [
1
@@ -10443,7 +10505,7 @@ export default {
3
],
"update": [
424
428
],
"__typename": [
1
@@ -10535,7 +10597,7 @@ export default {
3
],
"update": [
428
432
],
"__typename": [
1
@@ -10579,7 +10641,7 @@ export default {
3
],
"update": [
432
436
],
"__typename": [
1
@@ -10598,7 +10660,7 @@ export default {
3
],
"update": [
432
436
],
"__typename": [
1
@@ -10609,7 +10671,7 @@ export default {
3
],
"update": [
435
439
],
"__typename": [
1
@@ -10654,7 +10716,7 @@ export default {
3
],
"update": [
438
442
],
"__typename": [
1
@@ -10770,7 +10832,7 @@ export default {
1
],
"update": [
445
449
],
"__typename": [
1
@@ -10818,7 +10880,7 @@ export default {
1
],
"update": [
448
452
],
"__typename": [
1
@@ -10936,7 +10998,7 @@ export default {
},
"WorkspaceMigrationInput": {
"actions": [
453
457
],
"__typename": [
1
@@ -10944,7 +11006,7 @@ export default {
},
"WorkspaceMigrationDeleteActionInput": {
"type": [
454
458
],
"metadataName": [
318
@@ -11039,7 +11101,7 @@ export default {
1
],
"files": [
460
464
],
"__typename": [
1
@@ -11058,13 +11120,13 @@ export default {
},
"EmailAccountConnectionParameters": {
"IMAP": [
462
466
],
"SMTP": [
462
466
],
"CALDAV": [
462
466
],
"__typename": [
1
@@ -11103,7 +11165,7 @@ export default {
},
"CreateOneAppTokenInput": {
"appToken": [
465
469
],
"__typename": [
1
@@ -11132,7 +11194,7 @@ export default {
230,
{
"input": [
468,
472,
"LogicFunctionLogsInput!"
]
}
packages/twenty-docs/developers/extend/apps/data/overview.mdx
+46 -1
View File
@@ -44,8 +44,53 @@ A Twenty app's **data layer** is the data your app *adds* to a workspace — the
| **Object** | A new custom record type (e.g. PostCard, Invoice) with its own fields | `defineObject()` |
| **Field** | A column on an object. Standalone fields can extend objects you didn't create (e.g. add `loyaltyTier` to Company) | `defineField()` |
| **Relation** | A bidirectional link between two objects — both sides declared as fields | `defineField()` with `FieldType.RELATION` |
| **Index** | A database index to speed up a recurring query on one of your objects | `defineIndex()` |
The SDK detects these via AST analysis at build time, so file organization is up to you — the convention is `src/objects/` and `src/fields/`. Stable `universalIdentifier` UUIDs tie everything together across deploys.
The SDK detects these via AST analysis at build time, so file organization is up to you — the convention is `src/objects/`, `src/fields/`, and `src/indexes/`. Stable `universalIdentifier` UUIDs tie everything together across deploys.
## Indexes (optional)
Apps can ship indexes alongside their objects to keep recurring queries fast. The most common case is a status or foreign-key column that you read frequently.
```ts src/indexes/post-card-status.index.ts
import { defineIndex } from 'twenty-sdk/define';
import {
POST_CARD_UNIVERSAL_IDENTIFIER,
STATUS_FIELD_UNIVERSAL_IDENTIFIER,
} from '../objects/post-card.object';
export default defineIndex({
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff0',
objectUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
fields: [
{
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff1',
fieldUniversalIdentifier: STATUS_FIELD_UNIVERSAL_IDENTIFIER,
},
],
});
```
### Unique indexes
`defineIndex` accepts `isUnique: true` for both single- and multi-column uniqueness. This is the recommended primitive — `defineField({ isUnique: true })` is deprecated and will be removed in a future release.
```ts
defineIndex({
universalIdentifier: '…',
objectUniversalIdentifier: PERSON_UNIVERSAL_IDENTIFIER,
isUnique: true,
fields: [{ universalIdentifier: '…', fieldUniversalIdentifier: EMAIL_FIELD_UNIVERSAL_IDENTIFIER }],
});
```
### Other constraints
- Partial `WHERE` clauses stay under admin control — apps can't declare them.
- Each object is capped at 10 custom indexes (the framework's own indexes don't count).
Order the `fields` array the way Postgres should use it — leftmost column first, like a phone book. Indexes are not free: every write to the table updates them. Add one only when you have a query that needs it.
<Note>
Looking for **Application Config** or **Roles & Permissions**? Those describe the app itself rather than the data it adds — they live under [Config](/developers/extend/apps/config/overview). Looking for **Connections** (Linear, GitHub, Slack OAuth)? Those exist to be called *from* logic functions and live under [Logic](/developers/extend/apps/logic/connections).
packages/twenty-docs/user-guide/data-model/capabilities/fields.mdx
+4
View File
@@ -101,6 +101,10 @@ Make a field unique to ensure distinct records cannot have the same value. For e
If you get an error when setting uniqueness, check for duplicate values in your data (including deleted records).
## Indexes (Advanced)
Database indexes are managed automatically — adding your own is rarely necessary and easy to get wrong. With Advanced mode on, each object has an **Indexes** section under `Settings → Data Model → <object>` for the cases where you know you need one.
## Field Configuration Best Practices
### Naming Conventions and Limitations
packages/twenty-front/src/generated-metadata/graphql.ts
+60 -10
View File
File diff suppressed because one or more lines are too long
packages/twenty-front/src/modules/app/components/SettingsRoutes.tsx
+12
View File
@@ -381,6 +381,14 @@ const SettingsObjectNewFieldConfigure = lazy(() =>
}),
),
);
const SettingsObjectNewIndex = lazy(() =>
import('~/pages/settings/data-model/new-index/SettingsObjectNewIndex').then(
(module) => ({
default: module.SettingsObjectNewIndex,
}),
),
);
const SettingsObjectFieldEdit = lazy(() =>
import('~/pages/settings/data-model/SettingsObjectFieldEdit').then(
(module) => ({
@@ -742,6 +750,10 @@ export const SettingsRoutes = ({ isAdminPageEnabled }: SettingsRoutesProps) => (
path={SettingsPath.ObjectNewFieldConfigure}
element={<SettingsObjectNewFieldConfigure />}
/>
<Route
path={SettingsPath.ObjectNewIndex}
element={<SettingsObjectNewIndex />}
/>
<Route
path={SettingsPath.ObjectFieldEdit}
element={<SettingsObjectFieldEdit />}
packages/twenty-front/src/modules/object-metadata/graphql/fragment.ts
+1
View File
@@ -37,6 +37,7 @@ export const OBJECT_METADATA_FRAGMENT = gql`
indexFieldMetadataList {
id
fieldMetadataId
subFieldName
createdAt
updatedAt
order
packages/twenty-front/src/modules/object-metadata/graphql/mutations.ts
+32
View File
@@ -260,3 +260,35 @@ export const DELETE_ONE_FIELD_METADATA_ITEM = gql`
}
}
`;
export const CREATE_ONE_INDEX_METADATA_ITEM = gql`
mutation CreateOneIndexMetadataItem($input: CreateOneIndexInput!) {
createOneIndex(input: $input) {
id
name
indexType
isUnique
isCustom
indexWhereClause
createdAt
updatedAt
indexFieldMetadataList {
id
fieldMetadataId
subFieldName
createdAt
updatedAt
order
}
}
}
`;
export const DELETE_ONE_INDEX_METADATA_ITEM = gql`
mutation DeleteOneIndexMetadataItem($idToDelete: UUID!) {
deleteOneIndex(input: { id: $idToDelete }) {
id
name
}
}
`;
packages/twenty-front/src/modules/object-metadata/hooks/useCreateOneIndexMetadataItem.ts
+91
View File
@@ -0,0 +1,91 @@
import { useMutation } from '@apollo/client/react';
import { CombinedGraphQLErrors } from '@apollo/client/errors';
import { t } from '@lingui/core/macro';
import { isDefined } from 'twenty-shared/utils';
import { CrudOperationType } from 'twenty-shared/types';
import { useMetadataErrorHandler } from '@/metadata-error-handler/hooks/useMetadataErrorHandler';
import { useUpdateMetadataStoreDraft } from '@/metadata-store/hooks/useUpdateMetadataStoreDraft';
import { type FlatIndexMetadataItem } from '@/metadata-store/types/FlatIndexMetadataItem';
import { type IndexFieldMetadataItem } from '@/object-metadata/types/IndexFieldMetadataItem';
import { type MetadataRequestResult } from '@/object-metadata/types/MetadataRequestResult.type';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import {
type CreateIndexInput,
CreateOneIndexMetadataItemDocument,
} from '~/generated-metadata/graphql';
export const useCreateOneIndexMetadataItem = () => {
const [createOneIndexMetadataItemMutation] = useMutation(
CreateOneIndexMetadataItemDocument,
);
const { handleMetadataError } = useMetadataErrorHandler();
const { enqueueErrorSnackBar } = useSnackBar();
const { addToDraft, applyChanges } = useUpdateMetadataStoreDraft();
const createOneIndexMetadataItem = async (
input: CreateIndexInput,
): Promise<
MetadataRequestResult<
Awaited<ReturnType<typeof createOneIndexMetadataItemMutation>>
>
> => {
try {
const response = await createOneIndexMetadataItemMutation({
variables: {
input: {
index: input,
},
},
});
const createdIndex = response.data?.createOneIndex;
if (isDefined(createdIndex)) {
const { __typename, indexFieldMetadataList, ...indexData } =
createdIndex;
const indexFieldMetadatas: IndexFieldMetadataItem[] =
indexFieldMetadataList.map(
({ __typename: _, ...rest }) => rest as IndexFieldMetadataItem,
);
addToDraft({
key: 'indexMetadataItems',
items: [
{
...indexData,
indexFieldMetadatas,
objectMetadataId: input.objectMetadataId,
} as FlatIndexMetadataItem,
],
});
applyChanges();
}
return {
status: 'successful',
response,
};
} catch (error) {
if (CombinedGraphQLErrors.is(error)) {
handleMetadataError(error, {
primaryMetadataName: 'index',
operationType: CrudOperationType.CREATE,
});
} else {
enqueueErrorSnackBar({ message: t`An error occurred.` });
}
return {
status: 'failed',
error,
};
}
};
return {
createOneIndexMetadataItem,
};
};
packages/twenty-front/src/modules/object-metadata/hooks/useDeleteOneIndexMetadataItem.ts
+64
View File
@@ -0,0 +1,64 @@
import { useMutation } from '@apollo/client/react';
import { CombinedGraphQLErrors } from '@apollo/client/errors';
import { t } from '@lingui/core/macro';
import { CrudOperationType } from 'twenty-shared/types';
import { useMetadataErrorHandler } from '@/metadata-error-handler/hooks/useMetadataErrorHandler';
import { useUpdateMetadataStoreDraft } from '@/metadata-store/hooks/useUpdateMetadataStoreDraft';
import { type MetadataRequestResult } from '@/object-metadata/types/MetadataRequestResult.type';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import { DeleteOneIndexMetadataItemDocument } from '~/generated-metadata/graphql';
export const useDeleteOneIndexMetadataItem = () => {
const [deleteOneIndexMetadataItemMutation] = useMutation(
DeleteOneIndexMetadataItemDocument,
);
const { handleMetadataError } = useMetadataErrorHandler();
const { enqueueErrorSnackBar } = useSnackBar();
const { removeFromDraft, applyChanges } = useUpdateMetadataStoreDraft();
const deleteOneIndexMetadataItem = async ({
idToDelete,
}: {
idToDelete: string;
}): Promise<
MetadataRequestResult<
Awaited<ReturnType<typeof deleteOneIndexMetadataItemMutation>>
>
> => {
try {
const response = await deleteOneIndexMetadataItemMutation({
variables: {
idToDelete,
},
});
removeFromDraft({ key: 'indexMetadataItems', itemIds: [idToDelete] });
applyChanges();
return {
status: 'successful',
response,
};
} catch (error) {
if (CombinedGraphQLErrors.is(error)) {
handleMetadataError(error, {
primaryMetadataName: 'index',
operationType: CrudOperationType.DELETE,
});
} else {
enqueueErrorSnackBar({ message: t`An error occurred.` });
}
return {
status: 'failed',
error,
};
}
};
return {
deleteOneIndexMetadataItem,
};
};
packages/twenty-front/src/modules/settings/data-model/indexes/forms/components/SettingsObjectIndexFieldsForm.tsx
+136
View File
@@ -0,0 +1,136 @@
import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { buildIndexableSelectOptions } from '@/settings/data-model/indexes/utils/buildIndexableSelectOptions';
import { decodeIndexableOptionValue } from '@/settings/data-model/indexes/utils/decodeIndexableOptionValue';
import { encodeIndexableOptionValue } from '@/settings/data-model/indexes/utils/encodeIndexableOptionValue';
import { Select } from '@/ui/input/components/Select';
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { useMemo } from 'react';
import { Controller, useFormContext } from 'react-hook-form';
import { IconTrash, useIcons } from 'twenty-ui/display';
import { IconButton, type SelectOption } from 'twenty-ui/input';
import { themeCssVariables } from 'twenty-ui/theme-constants';
import { type SettingsObjectNewIndexFormValues } from '~/pages/settings/data-model/new-index/SettingsObjectNewIndexFormValues';
type SettingsObjectIndexFieldsFormProps = {
indexableFields: FieldMetadataItem[];
};
const StyledFieldRow = styled.div`
align-items: center;
display: flex;
gap: ${themeCssVariables.spacing[2]};
margin-bottom: ${themeCssVariables.spacing[2]};
`;
const StyledSelectWrapper = styled.div`
flex: 1;
min-width: 0;
`;
const StyledPlaceholder = styled.div`
height: ${themeCssVariables.spacing[8]};
width: ${themeCssVariables.spacing[8]};
`;
export const SettingsObjectIndexFieldsForm = ({
indexableFields,
}: SettingsObjectIndexFieldsFormProps) => {
const { t } = useLingui();
const { getIcon } = useIcons();
const { control } = useFormContext<SettingsObjectNewIndexFormValues>();
const allOptions = useMemo(
() => buildIndexableSelectOptions({ indexableFields, getIcon }),
[indexableFields, getIcon],
);
const emptyFieldOption: SelectOption<string> = {
label: t`Select a field`,
value: '',
};
return (
<Controller
name="fields"
control={control}
render={({ field: { value, onChange } }) => {
const rows: (
| SettingsObjectNewIndexFormValues['fields'][number]
| null
)[] = [...value, null];
const pickedValues = value.map((entry) =>
encodeIndexableOptionValue(entry.fieldMetadataId, entry.subFieldName),
);
const handleSelect = (rowIndex: number, newOptionValue: string) => {
if (newOptionValue === '') return;
const next = [...value];
const decoded = decodeIndexableOptionValue(newOptionValue);
if (rowIndex < value.length) {
next[rowIndex] = decoded;
} else {
next.push(decoded);
}
onChange(next);
};
const handleRemove = (rowIndex: number) => {
onChange(value.filter((_, index) => index !== rowIndex));
};
return (
<>
{rows.map((entry, rowIndex) => {
const currentValue = entry
? encodeIndexableOptionValue(
entry.fieldMetadataId,
entry.subFieldName,
)
: '';
const availableOptions = allOptions.filter(
(option) =>
option.value === currentValue ||
!pickedValues.includes(option.value),
);
const isEmptyRow = entry === null;
return (
<StyledFieldRow key={`${rowIndex}-${currentValue || 'empty'}`}>
<StyledSelectWrapper>
<Select
dropdownId={`settings-object-new-index-field-${rowIndex}`}
value={currentValue}
options={availableOptions}
emptyOption={emptyFieldOption}
onChange={(newValue) => handleSelect(rowIndex, newValue)}
fullWidth
withSearchInput
/>
</StyledSelectWrapper>
{isEmptyRow ? (
<StyledPlaceholder />
) : (
<IconButton
Icon={IconTrash}
variant="tertiary"
size="medium"
onClick={() => handleRemove(rowIndex)}
ariaLabel={t`Remove field`}
/>
)}
</StyledFieldRow>
);
})}
</>
);
}}
/>
);
};
packages/twenty-front/src/modules/settings/data-model/indexes/forms/components/SettingsObjectIndexOptionsForm.tsx
+57
View File
@@ -0,0 +1,57 @@
import { Select } from '@/ui/input/components/Select';
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { Controller, useFormContext } from 'react-hook-form';
import { themeCssVariables } from 'twenty-ui/theme-constants';
import { IndexType } from '~/generated-metadata/graphql';
import { type SettingsObjectNewIndexFormValues } from '~/pages/settings/data-model/new-index/SettingsObjectNewIndexFormValues';
const StyledContent = styled.div`
display: flex;
flex-direction: column;
gap: ${themeCssVariables.spacing[4]};
`;
const StyledFieldLabel = styled.div`
color: ${themeCssVariables.font.color.light};
font-size: ${themeCssVariables.font.size.xs};
font-weight: ${themeCssVariables.font.weight.semiBold};
margin-bottom: ${themeCssVariables.spacing[1]};
`;
export const SettingsObjectIndexOptionsForm = () => {
const { t } = useLingui();
const { control } = useFormContext<SettingsObjectNewIndexFormValues>();
const indexTypeOptions = [
{
value: IndexType.BTREE,
label: t`BTREE (default, good for sorting and equality)`,
},
{
value: IndexType.GIN,
label: t`GIN (full-text search and JSONB)`,
},
];
return (
<StyledContent>
<div>
<StyledFieldLabel>{t`Type`}</StyledFieldLabel>
<Controller
name="indexType"
control={control}
render={({ field: { value, onChange } }) => (
<Select
dropdownId="settings-object-new-index-type"
value={value}
options={indexTypeOptions}
onChange={onChange}
fullWidth
/>
)}
/>
</div>
</StyledContent>
);
};
packages/twenty-front/src/modules/settings/data-model/indexes/utils/buildIndexableSelectOptions.ts
+47
View File
@@ -0,0 +1,47 @@
import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { type IconComponent } from 'twenty-ui/display';
import { type SelectOption } from 'twenty-ui/input';
import { compositeTypeDefinitions } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { type FieldMetadataType } from '~/generated-metadata/graphql';
import { getCompositeSubFieldLabel } from '@/object-record/object-filter-dropdown/utils/getCompositeSubFieldLabel';
import { encodeIndexableOptionValue } from '@/settings/data-model/indexes/utils/encodeIndexableOptionValue';
import { type CompositeFieldSubFieldName } from '@/settings/data-model/types/CompositeFieldSubFieldName';
import { type CompositeFieldType } from '@/settings/data-model/types/CompositeFieldType';
export const buildIndexableSelectOptions = ({
indexableFields,
getIcon,
}: {
indexableFields: FieldMetadataItem[];
getIcon: (icon?: string | null) => IconComponent | undefined;
}): SelectOption<string>[] => {
const sortedFields = [...indexableFields].sort((a, b) =>
a.label.localeCompare(b.label),
);
return sortedFields.flatMap<SelectOption<string>>((field) => {
const compositeType = compositeTypeDefinitions.get(
field.type as FieldMetadataType,
);
if (isDefined(compositeType)) {
// Composite parent — emit one option per sub-property. The parent
// itself is NOT selectable because the SQL index requires picking a
// specific column.
return compositeType.properties.map<SelectOption<string>>((property) => ({
Icon: getIcon(field.icon),
label: `${field.label} > ${getCompositeSubFieldLabel(field.type as CompositeFieldType, property.name as CompositeFieldSubFieldName)}`,
value: encodeIndexableOptionValue(field.id, property.name),
}));
}
return [
{
Icon: getIcon(field.icon),
label: field.label,
value: encodeIndexableOptionValue(field.id, null),
},
];
});
};
packages/twenty-front/src/modules/settings/data-model/indexes/utils/decodeIndexableOptionValue.ts
+15
View File
@@ -0,0 +1,15 @@
import { isNonEmptyString } from '@sniptt/guards';
import { INDEXABLE_OPTION_SEPARATOR } from '@/settings/data-model/indexes/utils/indexableOptionSeparator';
export const decodeIndexableOptionValue = (
value: string,
): { fieldMetadataId: string; subFieldName: string | null } => {
const [fieldMetadataId, subFieldName] = value.split(
INDEXABLE_OPTION_SEPARATOR,
);
return {
fieldMetadataId,
subFieldName: isNonEmptyString(subFieldName) ? subFieldName : null,
};
};
packages/twenty-front/src/modules/settings/data-model/indexes/utils/encodeIndexableOptionValue.ts
+10
View File
@@ -0,0 +1,10 @@
import { isNonEmptyString } from '@sniptt/guards';
import { INDEXABLE_OPTION_SEPARATOR } from '@/settings/data-model/indexes/utils/indexableOptionSeparator';
export const encodeIndexableOptionValue = (
fieldMetadataId: string,
subFieldName: string | null,
): string =>
isNonEmptyString(subFieldName)
? `${fieldMetadataId}${INDEXABLE_OPTION_SEPARATOR}${subFieldName}`
: fieldMetadataId;
packages/twenty-front/src/modules/settings/data-model/indexes/utils/indexableOptionSeparator.ts
+5
View File
@@ -0,0 +1,5 @@
// The Select component takes string values. We encode (fieldMetadataId,
// subFieldName) as `${id}` for scalar fields and `${id}::${subFieldName}` for
// composite sub-fields. Stable, easy to parse, no collisions because UUIDs
// don't contain `::`.
export const INDEXABLE_OPTION_SEPARATOR = '::';
packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/ObjectIndexes.tsx
-21
View File
@@ -1,21 +0,0 @@
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { t } from '@lingui/core/macro';
import { H2Title } from 'twenty-ui/display';
import { Section } from 'twenty-ui/layout';
import { SettingsObjectIndexTable } from '~/pages/settings/data-model/SettingsObjectIndexTable';
type ObjectIndexesProps = {
objectMetadataItem: EnrichedObjectMetadataItem;
};
export const ObjectIndexes = ({ objectMetadataItem }: ObjectIndexesProps) => {
return (
<Section>
<H2Title
title={t`Indexes`}
description={t`Advanced feature to improve the performance of queries and to enforce unicity constraints.`}
/>
<SettingsObjectIndexTable objectMetadataItem={objectMetadataItem} />
</Section>
);
};
packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/ObjectSettings.tsx
+15
View File
@@ -6,6 +6,7 @@ import { isDDLLockedState } from '@/client-config/states/isDDLLockedState';
import { isObjectMetadataReadOnly } from '@/object-record/read-only/utils/isObjectMetadataReadOnly';
import { AdvancedSettingsWrapper } from '@/settings/components/AdvancedSettingsWrapper';
import { SettingsUpdateDataModelObjectAboutForm } from '@/settings/data-model/object-details/components/SettingsUpdateDataModelObjectAboutForm';
import { SettingsObjectIndexesSection } from '@/settings/data-model/object-details/components/tabs/SettingsObjectIndexesSection';
import { SettingsObjectSearchSection } from '@/settings/data-model/object-details/components/tabs/SettingsObjectSearchSection';
import { SettingsDataModelObjectSettingsFormCard } from '@/settings/data-model/objects/forms/components/SettingsDataModelObjectSettingsFormCard';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
@@ -135,6 +136,20 @@ export const ObjectSettings = ({
</Section>
</StyledFormSectionContainer>
</AdvancedSettingsWrapper>
<AdvancedSettingsWrapper>
<StyledFormSectionContainer>
<Section>
<H2Title
title={t`Indexes`}
description={t`Speed up reads on the fields you filter or sort by most. Each index also slows down writes and uses disk space, so add them with intent.`}
/>
<SettingsObjectIndexesSection
objectMetadataItem={objectMetadataItem}
isReadOnly={isReadOnly}
/>
</Section>
</StyledFormSectionContainer>
</AdvancedSettingsWrapper>
{!isReadOnly && (
<StyledFormSectionContainer>
<Section>
packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectIndexesSection.tsx
+209
View File
@@ -0,0 +1,209 @@
import { useDeleteOneIndexMetadataItem } from '@/object-metadata/hooks/useDeleteOneIndexMetadataItem';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import { Dropdown } from '@/ui/layout/dropdown/components/Dropdown';
import { DropdownContent } from '@/ui/layout/dropdown/components/DropdownContent';
import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer';
import { ConfirmationModal } from '@/ui/layout/modal/components/ConfirmationModal';
import { useModal } from '@/ui/layout/modal/hooks/useModal';
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { type ReactNode, useMemo, useState } from 'react';
import { IconEyeOff, IconPlus } from 'twenty-ui/display';
import { Button, SearchInput } from 'twenty-ui/input';
import { MenuItemToggle, UndecoratedLink } from 'twenty-ui/navigation';
import { themeCssVariables } from 'twenty-ui/theme-constants';
import { SettingsPath } from 'twenty-shared/types';
import { isNonEmptyString } from '@sniptt/guards';
import { getSettingsPath, isDefined } from 'twenty-shared/utils';
import { normalizeSearchText } from '~/utils/normalizeSearchText';
import { MAX_CUSTOM_INDEXES_PER_OBJECT } from 'twenty-shared/constants';
import { SettingsObjectIndexTable } from '~/pages/settings/data-model/SettingsObjectIndexTable';
import { type SettingsObjectIndexesTableItem } from '~/pages/settings/data-model/types/SettingsObjectIndexesTableItem';
import { getCompositeSubFieldLabel } from '@/object-record/object-filter-dropdown/utils/getCompositeSubFieldLabel';
import { type CompositeFieldSubFieldName } from '@/settings/data-model/types/CompositeFieldSubFieldName';
import { type CompositeFieldType } from '@/settings/data-model/types/CompositeFieldType';
type SettingsObjectIndexesSectionProps = {
objectMetadataItem: EnrichedObjectMetadataItem;
isReadOnly: boolean;
};
const StyledContent = styled.div`
display: flex;
flex-direction: column;
gap: ${themeCssVariables.spacing[3]};
`;
const StyledButtonContainer = styled.div`
display: flex;
justify-content: flex-end;
padding-top: ${themeCssVariables.spacing[2]};
`;
const DELETE_INDEX_MODAL_ID = 'delete-index-modal';
const HIDE_SYSTEM_INDEXES_DROPDOWN_ID =
'settings-object-indexes-filter-dropdown';
export const SettingsObjectIndexesSection = ({
objectMetadataItem,
isReadOnly,
}: SettingsObjectIndexesSectionProps) => {
const { t } = useLingui();
const { openModal, closeModal } = useModal();
const { enqueueSuccessSnackBar } = useSnackBar();
const { deleteOneIndexMetadataItem } = useDeleteOneIndexMetadataItem();
const [searchTerm, setSearchTerm] = useState('');
const [hideSystemIndexes, setHideSystemIndexes] = useState(false);
const [pendingDelete, setPendingDelete] =
useState<SettingsObjectIndexesTableItem | null>(null);
const [isDeleting, setIsDeleting] = useState(false);
const tableItems = useMemo<SettingsObjectIndexesTableItem[]>(() => {
const fieldsById = new Map(
objectMetadataItem.fields.map((field) => [field.id, field]),
);
return objectMetadataItem.indexMetadatas.map((indexMetadataItem) => ({
id: indexMetadataItem.id,
name: indexMetadataItem.name,
isUnique: indexMetadataItem.isUnique,
isCustom: indexMetadataItem.isCustom ?? false,
indexType: indexMetadataItem.indexType,
indexWhereClause: indexMetadataItem.indexWhereClause,
indexFields:
indexMetadataItem.indexFieldMetadatas
?.map((indexField) => {
const fieldMetadataItem = fieldsById.get(
indexField.fieldMetadataId,
);
if (!isDefined(fieldMetadataItem)) return undefined;
if (isNonEmptyString(indexField.subFieldName)) {
return `${fieldMetadataItem.label} > ${getCompositeSubFieldLabel(
fieldMetadataItem.type as CompositeFieldType,
indexField.subFieldName as CompositeFieldSubFieldName,
)}`;
}
return fieldMetadataItem.label;
})
.filter((label): label is string => Boolean(label))
.join(', ') ?? '',
}));
}, [objectMetadataItem.indexMetadatas, objectMetadataItem.fields]);
const filteredItems = useMemo(() => {
const searchNormalized = normalizeSearchText(searchTerm);
return tableItems
.filter((item) => (hideSystemIndexes ? item.isCustom : true))
.filter((item) =>
searchNormalized.length === 0
? true
: normalizeSearchText(item.indexFields).includes(searchNormalized) ||
normalizeSearchText(item.indexType).includes(searchNormalized),
);
}, [tableItems, searchTerm, hideSystemIndexes]);
const customIndexCount = tableItems.filter((item) => item.isCustom).length;
const reachedCap = customIndexCount >= MAX_CUSTOM_INDEXES_PER_OBJECT;
const canCreate = !isReadOnly && !reachedCap;
const handleRequestDelete = (item: SettingsObjectIndexesTableItem) => {
setPendingDelete(item);
openModal(DELETE_INDEX_MODAL_ID);
};
const handleConfirmDelete = async () => {
if (pendingDelete === null) return;
setIsDeleting(true);
const result = await deleteOneIndexMetadataItem({
idToDelete: pendingDelete.id,
});
setIsDeleting(false);
closeModal(DELETE_INDEX_MODAL_ID);
if (result.status === 'successful') {
enqueueSuccessSnackBar({ message: t`Index deleted` });
setPendingDelete(null);
}
};
return (
<StyledContent>
<SearchInput
placeholder={t`Search an index...`}
value={searchTerm}
onChange={setSearchTerm}
filterDropdown={(filterButton: ReactNode) => (
<Dropdown
dropdownId={HIDE_SYSTEM_INDEXES_DROPDOWN_ID}
dropdownPlacement="bottom-end"
dropdownOffset={{ x: 0, y: 8 }}
clickableComponent={filterButton}
dropdownComponents={
<DropdownContent>
<DropdownMenuItemsContainer>
<MenuItemToggle
LeftIcon={IconEyeOff}
onToggleChange={() =>
setHideSystemIndexes(!hideSystemIndexes)
}
toggled={hideSystemIndexes}
text={t`Hide system indexes`}
toggleSize="small"
/>
</DropdownMenuItemsContainer>
</DropdownContent>
}
/>
)}
/>
<SettingsObjectIndexTable
items={filteredItems}
isReadOnly={isReadOnly}
onDeleteIndex={handleRequestDelete}
/>
{!isReadOnly && (
<StyledButtonContainer>
{canCreate ? (
<UndecoratedLink
to={getSettingsPath(SettingsPath.ObjectNewIndex, {
objectNamePlural: objectMetadataItem.namePlural,
})}
>
<Button
Icon={IconPlus}
title={t`Add Index`}
size="small"
variant="secondary"
/>
</UndecoratedLink>
) : (
<Button
Icon={IconPlus}
title={t`Add Index`}
size="small"
variant="secondary"
disabled
/>
)}
</StyledButtonContainer>
)}
<ConfirmationModal
modalInstanceId={DELETE_INDEX_MODAL_ID}
title={t`Delete this index?`}
subtitle={t`Queries that relied on it will fall back to a sequential scan. You can recreate it later.`}
confirmButtonText={t`Delete`}
onConfirmClick={handleConfirmDelete}
onClose={() => setPendingDelete(null)}
loading={isDeleting}
/>
</StyledContent>
);
};
packages/twenty-front/src/modules/settings/data-model/object-details/components/tabs/SettingsObjectSearchSection.tsx
+2 -2
View File
@@ -135,8 +135,8 @@ export const SettingsObjectSearchSection = ({
<Card rounded>
<SettingsOptionCardContentToggle
Icon={IconEye}
title={t`Include in default search`}
description={t`If disabled, use advanced search filters to find these records`}
title={t`Global search`}
description={t`Show this object's records in the command menu (⌘K).`}
checked={isSearchable}
advancedMode
onChange={handleToggleSearchable}
packages/twenty-front/src/modules/settings/data-model/object-details/states/settingsObjectIndexesFamilyState.ts
-14
View File
@@ -1,14 +0,0 @@
import { type IndexMetadataItem } from '@/object-metadata/types/IndexMetadataItem';
import { createAtomFamilyState } from '@/ui/utilities/state/jotai/utils/createAtomFamilyState';
export type SortedIndexByTableFamilyStateKey = {
objectMetadataItemId: string;
};
export const settingsObjectIndexesFamilyState = createAtomFamilyState<
IndexMetadataItem[] | null,
SortedIndexByTableFamilyStateKey
>({
key: 'settingsObjectIndexesFamilyState',
defaultValue: null,
});
packages/twenty-front/src/modules/ui/navigation/navigation-drawer/components/MultiWorkspaceDropdown/internal/MultiWorkspaceDropdownDefaultComponents.tsx
+1 -1
View File
@@ -217,7 +217,7 @@ export const MultiWorkspaceDropdownDefaultComponents = () => {
onClick={() => setMultiWorkspaceDropdown('themes')}
/>
<UndecoratedLink
to={getSettingsPath(SettingsPath.WorkspaceMembersPage)}
to={`${getSettingsPath(SettingsPath.WorkspaceMembersPage)}#invite`}
onClick={() => {
closeDropdown(MULTI_WORKSPACE_DROPDOWN_ID);
}}
packages/twenty-front/src/pages/settings/data-model/SettingsObjectDetailPage.tsx
+1 -29
View File
@@ -1,18 +1,15 @@
import { useContext, useEffect, useState } from 'react';
import { useEffect, useState } from 'react';
import { useParams } from 'react-router-dom';
import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { ObjectFields } from '@/settings/data-model/object-details/components/tabs/ObjectFields';
import { ObjectIndexes } from '@/settings/data-model/object-details/components/tabs/ObjectIndexes';
import { ObjectLayout } from '@/settings/data-model/object-details/components/tabs/ObjectLayout';
import { ObjectSettings } from '@/settings/data-model/object-details/components/tabs/ObjectSettings';
import { SubMenuTopBarContainer } from '@/ui/layout/page/components/SubMenuTopBarContainer';
import { TabList } from '@/ui/layout/tab-list/components/TabList';
import { isAdvancedModeEnabledState } from '@/ui/navigation/navigation-drawer/states/isAdvancedModeEnabledState';
import { useAtomState } from '@/ui/utilities/state/jotai/hooks/useAtomState';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useIsFeatureEnabled } from '@/workspace/hooks/useIsFeatureEnabled';
import { styled } from '@linaria/react';
import {
AppPath,
@@ -28,17 +25,13 @@ import { useLingui } from '@lingui/react/macro';
import { getAppPath, getSettingsPath, isDefined } from 'twenty-shared/utils';
import {
IconArrowUpRight,
IconCodeCircle,
IconLayout,
IconListDetails,
IconPlus,
IconPoint,
IconSettings,
} from 'twenty-ui/display';
import { Button } from 'twenty-ui/input';
import { UndecoratedLink } from 'twenty-ui/navigation';
import { ThemeContext } from 'twenty-ui/theme-constants';
import { FeatureFlagKey } from '~/generated-metadata/graphql';
import { useNavigateApp } from '~/hooks/useNavigateApp';
import { SETTINGS_OBJECT_DETAIL_TABS } from '~/pages/settings/data-model/constants/SettingsObjectDetailTabs';
import { updatedObjectNamePluralState } from '~/pages/settings/data-model/states/updatedObjectNamePluralState';
@@ -50,7 +43,6 @@ const StyledContentContainer = styled.div`
`;
export const SettingsObjectDetailPage = () => {
const { theme } = useContext(ThemeContext);
const navigateApp = useNavigateApp();
const { t } = useLingui();
const { objectNamePlural = '' } = useParams();
@@ -77,11 +69,6 @@ export const SettingsObjectDetailPage = () => {
SETTINGS_OBJECT_DETAIL_TABS.COMPONENT_INSTANCE_ID,
);
const isAdvancedModeEnabled = useAtomStateValue(isAdvancedModeEnabledState);
const isUniqueIndexesEnabled = useIsFeatureEnabled(
FeatureFlagKey.IS_UNIQUE_INDEXES_ENABLED,
);
const [isDeleting, setIsDeleting] = useState(false);
useEffect(() => {
@@ -123,19 +110,6 @@ export const SettingsObjectDetailPage = () => {
objectMetadataItem.isRemote ||
objectMetadataItem.nameSingular === CoreObjectNameSingular.Dashboard,
},
{
id: SETTINGS_OBJECT_DETAIL_TABS.TABS_IDS.INDEXES,
title: t`Indexes`,
Icon: IconCodeCircle,
hide: !isAdvancedModeEnabled || !isUniqueIndexesEnabled,
pill: (
<IconPoint
size={12}
color={theme.color.yellow}
fill={theme.color.yellow}
/>
),
},
];
const renderActiveTabContent = () => {
@@ -152,8 +126,6 @@ export const SettingsObjectDetailPage = () => {
);
case SETTINGS_OBJECT_DETAIL_TABS.TABS_IDS.LAYOUT:
return <ObjectLayout objectMetadataItem={objectMetadataItem} />;
case SETTINGS_OBJECT_DETAIL_TABS.TABS_IDS.INDEXES:
return <ObjectIndexes objectMetadataItem={objectMetadataItem} />;
default:
return <></>;
}
packages/twenty-front/src/pages/settings/data-model/SettingsObjectIndexTable.tsx
+94 -129
View File
@@ -1,7 +1,6 @@
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { settingsObjectIndexesFamilyState } from '@/settings/data-model/object-details/states/settingsObjectIndexesFamilyState';
import { SortableTableHeader } from '@/ui/layout/table/components/SortableTableHeader';
import { Table } from '@/ui/layout/table/components/Table';
import { TableBody } from '@/ui/layout/table/components/TableBody';
import { TableCell } from '@/ui/layout/table/components/TableCell';
import { TableHeader } from '@/ui/layout/table/components/TableHeader';
import { TableRow } from '@/ui/layout/table/components/TableRow';
@@ -10,155 +9,121 @@ import { type TableMetadata } from '@/ui/layout/table/types/TableMetadata';
import { styled } from '@linaria/react';
import { msg } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
import { isNonEmptyArray } from '@sniptt/guards';
import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';
import { useSetAtomFamilyState } from '@/ui/utilities/state/jotai/hooks/useSetAtomFamilyState';
import { useEffect, useMemo, useState } from 'react';
import { IconSquareKey } from 'twenty-ui/display';
import { SearchInput } from 'twenty-ui/input';
import { IconSquareKey, IconTrash } from 'twenty-ui/display';
import { LightIconButton } from 'twenty-ui/input';
import { themeCssVariables } from 'twenty-ui/theme-constants';
import { type SettingsObjectIndexesTableItem } from '~/pages/settings/data-model/types/SettingsObjectIndexesTableItem';
import { normalizeSearchText } from '~/utils/normalizeSearchText';
const OBJECT_INDEX_TABLE_ROW_GRID_TEMPLATE_COLUMNS = '350px 70px 80px';
const OBJECT_INDEX_TABLE_GRID_TEMPLATE_COLUMNS = '1fr 70px 80px 32px';
const StyledSearchInputContainer = styled.div`
padding-bottom: ${themeCssVariables.spacing[2]};
width: 100%;
const StyledTableContainer = styled.div`
border-bottom: 1px solid ${themeCssVariables.border.color.light};
margin-top: ${themeCssVariables.spacing[3]};
`;
const StyledActionCell = styled(TableCell)`
justify-content: flex-end;
padding-right: 0;
`;
const StyledEmpty = styled.div`
color: ${themeCssVariables.font.color.light};
font-size: ${themeCssVariables.font.size.md};
padding: ${themeCssVariables.spacing[3]};
text-align: center;
`;
const TABLE_FIELDS: TableMetadata<SettingsObjectIndexesTableItem>['fields'] = [
{
fieldLabel: msg`Fields`,
fieldName: 'indexFields',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`Unique`,
FieldIcon: IconSquareKey,
fieldName: 'isUnique',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`Type`,
fieldName: 'indexType',
fieldType: 'string',
align: 'right',
},
];
const TABLE_METADATA: TableMetadata<SettingsObjectIndexesTableItem> = {
tableId: 'settingsObjectIndexes',
fields: TABLE_FIELDS,
initialSort: {
fieldName: 'indexFields',
orderBy: 'AscNullsLast',
},
};
export type SettingsObjectIndexTableProps = {
objectMetadataItem: EnrichedObjectMetadataItem;
items: SettingsObjectIndexesTableItem[];
isReadOnly: boolean;
onDeleteIndex: (item: SettingsObjectIndexesTableItem) => void;
};
export const SettingsObjectIndexTable = ({
objectMetadataItem,
items,
isReadOnly,
onDeleteIndex,
}: SettingsObjectIndexTableProps) => {
const { t } = useLingui();
const [searchTerm, setSearchTerm] = useState('');
const tableMetadata: TableMetadata<SettingsObjectIndexesTableItem> = {
tableId: 'settingsObjectIndexs',
fields: [
{
fieldLabel: msg`Fields`,
fieldName: 'indexFields',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`Unique`,
FieldIcon: IconSquareKey,
fieldName: 'isUnique',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`Type`,
fieldName: 'indexType',
fieldType: 'string',
align: 'right',
},
],
initialSort: {
fieldName: 'name',
orderBy: 'AscNullsLast',
},
};
const settingsObjectIndexes = useAtomFamilyStateValue(
settingsObjectIndexesFamilyState,
{ objectMetadataItemId: objectMetadataItem.id },
);
const setSettingsObjectIndexes = useSetAtomFamilyState(
settingsObjectIndexesFamilyState,
{ objectMetadataItemId: objectMetadataItem.id },
);
useEffect(() => {
setSettingsObjectIndexes(objectMetadataItem.indexMetadatas);
}, [objectMetadataItem, setSettingsObjectIndexes]);
const objectSettingsDetailItems = useMemo(() => {
return (
settingsObjectIndexes?.map((indexMetadataItem) => {
return {
name: indexMetadataItem.name,
isUnique: indexMetadataItem.isUnique,
indexType: indexMetadataItem.indexType,
indexFields: indexMetadataItem.indexFieldMetadatas
?.map((indexField) => {
const fieldMetadataItem = objectMetadataItem.fields.find(
(field) => field.id === indexField.fieldMetadataId,
);
return fieldMetadataItem?.label;
})
.join(', '),
};
}) ?? []
);
}, [settingsObjectIndexes, objectMetadataItem]);
const sortedActiveObjectSettingsDetailItems = useSortedArray(
objectSettingsDetailItems,
tableMetadata,
);
const filteredActiveItems = useMemo(
() =>
sortedActiveObjectSettingsDetailItems.filter((item) => {
const searchNormalized = normalizeSearchText(searchTerm);
return (
normalizeSearchText(item.name).includes(searchNormalized) ||
normalizeSearchText(item.indexType).includes(searchNormalized)
);
}),
[sortedActiveObjectSettingsDetailItems, searchTerm],
);
const sortedItems = useSortedArray(items, TABLE_METADATA);
return (
<>
<StyledSearchInputContainer>
<SearchInput
placeholder={t`Search an index...`}
value={searchTerm}
onChange={setSearchTerm}
/>
</StyledSearchInputContainer>
<StyledTableContainer>
<Table>
<TableRow
gridTemplateColumns={OBJECT_INDEX_TABLE_ROW_GRID_TEMPLATE_COLUMNS}
gridTemplateColumns={OBJECT_INDEX_TABLE_GRID_TEMPLATE_COLUMNS}
>
{tableMetadata.fields.map((item) => (
{TABLE_METADATA.fields.map((tableField) => (
<SortableTableHeader
key={item.fieldName}
fieldName={item.fieldName}
label={t(item.fieldLabel)}
Icon={item.FieldIcon}
tableId={tableMetadata.tableId}
initialSort={tableMetadata.initialSort}
key={tableField.fieldName}
fieldName={tableField.fieldName}
label={t(tableField.fieldLabel)}
Icon={tableField.FieldIcon}
tableId={TABLE_METADATA.tableId}
initialSort={TABLE_METADATA.initialSort}
/>
))}
<TableHeader></TableHeader>
</TableRow>
{isNonEmptyArray(filteredActiveItems) &&
filteredActiveItems.map((objectSettingsIndex) => (
<TableRow
gridTemplateColumns={OBJECT_INDEX_TABLE_ROW_GRID_TEMPLATE_COLUMNS}
key={objectSettingsIndex.name}
>
<TableCell>{objectSettingsIndex.indexFields}</TableCell>
<TableCell>
{objectSettingsIndex.isUnique ? (
<IconSquareKey size={14} />
) : (
''
)}
</TableCell>
<TableCell>{objectSettingsIndex.indexType}</TableCell>
</TableRow>
))}
<TableBody>
{sortedItems.length === 0 ? (
<StyledEmpty>{t`No indexes match your filters.`}</StyledEmpty>
) : (
sortedItems.map((item) => (
<TableRow
gridTemplateColumns={OBJECT_INDEX_TABLE_GRID_TEMPLATE_COLUMNS}
key={item.id}
>
<TableCell>{item.indexFields}</TableCell>
<TableCell>
{item.isUnique ? <IconSquareKey size={14} /> : ''}
</TableCell>
<TableCell>{item.indexType}</TableCell>
<StyledActionCell>
{item.isCustom && !isReadOnly && (
<LightIconButton
Icon={IconTrash}
accent="tertiary"
onClick={() => onDeleteIndex(item)}
/>
)}
</StyledActionCell>
</TableRow>
))
)}
</TableBody>
</Table>
</>
</StyledTableContainer>
);
};
packages/twenty-front/src/pages/settings/data-model/constants/SettingsObjectDetailTabs.ts
-1
View File
@@ -4,6 +4,5 @@ export const SETTINGS_OBJECT_DETAIL_TABS = {
FIELDS: 'fields',
SETTINGS: 'settings',
LAYOUT: 'layout',
INDEXES: 'indexes',
},
} as const;
packages/twenty-front/src/pages/settings/data-model/new-index/SettingsObjectNewIndex.tsx
+175
View File
@@ -0,0 +1,175 @@
import { isDDLLockedState } from '@/client-config/states/isDDLLockedState';
import { useCreateOneIndexMetadataItem } from '@/object-metadata/hooks/useCreateOneIndexMetadataItem';
import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { SEARCH_VECTOR_FIELD_NAME } from '@/object-record/constants/SearchVectorFieldName';
import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtons/SaveAndCancelButtons';
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
import { SettingsObjectIndexFieldsForm } from '@/settings/data-model/indexes/forms/components/SettingsObjectIndexFieldsForm';
import { SettingsObjectIndexOptionsForm } from '@/settings/data-model/indexes/forms/components/SettingsObjectIndexOptionsForm';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import { SubMenuTopBarContainer } from '@/ui/layout/page/components/SubMenuTopBarContainer';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { zodResolver } from '@hookform/resolvers/zod';
import { useLingui } from '@lingui/react/macro';
import { useEffect, useMemo } from 'react';
import { FormProvider, useForm } from 'react-hook-form';
import { useParams } from 'react-router-dom';
import { AppPath, RelationType, SettingsPath } from 'twenty-shared/types';
import { getSettingsPath, isDefined } from 'twenty-shared/utils';
import { Callout, H2Title, IconAlertTriangle } from 'twenty-ui/display';
import { Section } from 'twenty-ui/layout';
import { IndexType } from '~/generated-metadata/graphql';
import { useNavigateApp } from '~/hooks/useNavigateApp';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
import { MAX_CUSTOM_INDEXES_PER_OBJECT } from 'twenty-shared/constants';
import {
settingsObjectNewIndexFormSchema,
type SettingsObjectNewIndexFormValues,
} from '~/pages/settings/data-model/new-index/SettingsObjectNewIndexFormValues';
const isFieldIndexable = (field: FieldMetadataItem): boolean => {
if (field.name === SEARCH_VECTOR_FIELD_NAME) return false;
if (field.isSystem === true) return false;
if (field.isActive !== true) return false;
// Only MANY_TO_ONE relations have a join column on this side; ONE_TO_MANY
// and MANY_TO_MANY have nothing concrete to index.
const relationType =
field.relation?.type ?? field.morphRelations?.[0]?.type ?? null;
if (isDefined(relationType) && relationType !== RelationType.MANY_TO_ONE) {
return false;
}
return true;
};
export const SettingsObjectNewIndex = () => {
const { t } = useLingui();
const navigateApp = useNavigateApp();
const navigate = useNavigateSettings();
const { objectNamePlural = '' } = useParams();
const { enqueueSuccessSnackBar } = useSnackBar();
const { findObjectMetadataItemByNamePlural } =
useFilteredObjectMetadataItems();
const activeObjectMetadataItem =
findObjectMetadataItemByNamePlural(objectNamePlural);
const { createOneIndexMetadataItem } = useCreateOneIndexMetadataItem();
const formConfig = useForm<SettingsObjectNewIndexFormValues>({
mode: 'onTouched',
resolver: zodResolver(settingsObjectNewIndexFormSchema),
defaultValues: {
fields: [],
indexType: IndexType.BTREE,
},
});
useEffect(() => {
if (!isDefined(activeObjectMetadataItem)) {
navigateApp(AppPath.NotFound);
}
}, [activeObjectMetadataItem, navigateApp]);
const isDDLLocked = useAtomStateValue(isDDLLockedState);
const indexableFields = useMemo(
() =>
(activeObjectMetadataItem?.fields ?? [])
.filter(isFieldIndexable)
.sort((a, b) => a.label.localeCompare(b.label)),
[activeObjectMetadataItem?.fields],
);
if (!isDefined(activeObjectMetadataItem)) return null;
const customIndexCount = activeObjectMetadataItem.indexMetadatas.filter(
(indexMetadata) => indexMetadata.isCustom,
).length;
const reachedCap = customIndexCount >= MAX_CUSTOM_INDEXES_PER_OBJECT;
const { isValid, isSubmitting } = formConfig.formState;
const canSave = isValid && !isSubmitting && !isDDLLocked && !reachedCap;
const handleSave = async (formValues: SettingsObjectNewIndexFormValues) => {
const result = await createOneIndexMetadataItem({
objectMetadataId: activeObjectMetadataItem.id,
fields: formValues.fields.map((entry) => ({
fieldMetadataId: entry.fieldMetadataId,
subFieldName: entry.subFieldName,
})),
indexType: formValues.indexType,
});
if (result.status === 'successful') {
enqueueSuccessSnackBar({ message: t`Index created` });
navigate(SettingsPath.ObjectDetail, { objectNamePlural });
}
};
return (
<FormProvider // oxlint-disable-next-line react/jsx-props-no-spreading
{...formConfig}
>
<SubMenuTopBarContainer
title={t`New Index`}
links={[
{
children: t`Workspace`,
href: getSettingsPath(SettingsPath.Workspace),
},
{
children: t`Objects`,
href: getSettingsPath(SettingsPath.Objects),
},
{
children: activeObjectMetadataItem.labelPlural,
href: getSettingsPath(SettingsPath.ObjectDetail, {
objectNamePlural,
}),
},
{ children: t`New Index` },
]}
actionButton={
<SaveAndCancelButtons
isLoading={isSubmitting}
isSaveDisabled={!canSave}
isCancelDisabled={isSubmitting}
onCancel={() =>
navigate(SettingsPath.ObjectDetail, { objectNamePlural })
}
onSave={formConfig.handleSubmit(handleSave)}
/>
}
>
<SettingsPageContainer>
<Section>
<Callout
variant="warning"
Icon={IconAlertTriangle}
title={t`Use indexes sparingly`}
description={t`Each index speeds up reads on the fields it covers, but slows down every insert and update, and uses disk space. Only add an index when you know which queries it serves.`}
/>
</Section>
<Section>
<H2Title
title={t`Fields`}
description={t`Pick one or more fields. The order you select them in becomes the column order in the index — important for composite queries. For composite fields like Address, pick the specific sub-column to index.`}
/>
<SettingsObjectIndexFieldsForm indexableFields={indexableFields} />
</Section>
<Section>
<H2Title
title={t`Options`}
description={t`Pick the index type. BTREE covers most queries; GIN is for full-text and JSONB.`}
/>
<SettingsObjectIndexOptionsForm />
</Section>
</SettingsPageContainer>
</SubMenuTopBarContainer>
</FormProvider>
);
};
packages/twenty-front/src/pages/settings/data-model/new-index/SettingsObjectNewIndexFormValues.ts
+18
View File
@@ -0,0 +1,18 @@
import { z } from 'zod';
import { IndexType } from '~/generated-metadata/graphql';
export const settingsObjectNewIndexFormSchema = z.object({
fields: z
.array(
z.object({
fieldMetadataId: z.string().uuid(),
subFieldName: z.string().nullable(),
}),
)
.min(1),
indexType: z.nativeEnum(IndexType),
});
export type SettingsObjectNewIndexFormValues = z.infer<
typeof settingsObjectNewIndexFormSchema
>;
packages/twenty-front/src/pages/settings/data-model/types/SettingsObjectIndexesTableItem.ts
+2
View File
@@ -1,9 +1,11 @@
import { type IndexType } from '~/generated-metadata/graphql';
export type SettingsObjectIndexesTableItem = {
id: string;
name: string;
indexType: IndexType;
isUnique: boolean;
isCustom: boolean;
indexWhereClause?: string | null;
indexFields: string;
};
packages/twenty-sdk/src/cli/__tests__/apps/minimal-app/__integration__/app-dev/expected-manifest.ts
+1
View File
@@ -19,6 +19,7 @@ export const EXPECTED_MANIFEST: Manifest = {
skills: [],
agents: [],
publicAssets: [],
indexes: [],
fields: [
{
name: 'targetMyNote',
packages/twenty-sdk/src/cli/__tests__/apps/rich-app/__integration__/app-dev/expected-manifest.ts
+13
View File
@@ -121,6 +121,19 @@ export const EXPECTED_MANIFEST: Manifest = {
},
],
indexes: [
{
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff0',
objectUniversalIdentifier: '54b589ca-eeed-4950-a176-358418b85c05',
fields: [
{
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff1',
fieldUniversalIdentifier: '87b675b8-dd8c-4448-b4ca-20e5a2234a1e',
},
],
},
],
fields: [
// Reverse relation fields for rootNote (5 fields)
{
packages/twenty-sdk/src/cli/utilities/build/common/plugins/__tests__/__snapshots__/stub-twenty-sdk-define.plugin.spec.ts.snap
+1
View File
@@ -37,6 +37,7 @@ exports[`stub-twenty-sdk-define plugin > matches the recorded export partition 1
"defineConnectionProvider",
"defineField",
"defineFrontComponent",
"defineIndex",
"defineLogicFunction",
"defineNavigationMenuItem",
"defineObject",
packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-build.ts
+22
View File
@@ -16,6 +16,7 @@ import { type FrontComponentConfig } from '@/sdk/define/front-component/front-co
import { type PostInstallLogicFunctionConfig } from '@/sdk/define/logic-functions/post-install-logic-function-config';
import { type PreInstallLogicFunctionConfig } from '@/sdk/define/logic-functions/pre-install-logic-function-config';
import { type ObjectConfig } from '@/sdk/define/objects/object-config';
import { type IndexConfig } from '@/sdk/define/indexes/index-config';
import { type PageLayoutConfig } from '@/sdk/define/page-layouts/page-layout-config';
import { type PageLayoutTabConfig } from '@/sdk/define/page-layouts/page-layout-tab-config';
import { type RoleConfig } from '@/sdk/define/roles/role-config';
@@ -32,6 +33,7 @@ import {
type ConnectionProviderManifest,
type FieldManifest,
type FrontComponentManifest,
type IndexManifest,
type LogicFunctionManifest,
type Manifest,
type NavigationMenuItemManifest,
@@ -82,6 +84,7 @@ export const buildManifest = async (
let applicationConfig: ApplicationConfig | undefined;
const objects: ObjectManifest[] = [];
const fields: FieldManifest[] = [];
const indexes: IndexManifest[] = [];
const roles: RoleManifest[] = [];
const skills: SkillManifest[] = [];
const agents: AgentManifest[] = [];
@@ -102,6 +105,7 @@ export const buildManifest = async (
const applicationFilePaths: string[] = [];
const objectsFilePaths: string[] = [];
const fieldsFilePaths: string[] = [];
const indexesFilePaths: string[] = [];
const rolesFilePaths: string[] = [];
const skillsFilePaths: string[] = [];
const agentsFilePaths: string[] = [];
@@ -402,6 +406,22 @@ export const buildManifest = async (
pageLayoutsFilePaths.push(relativePath);
break;
}
case ManifestEntityKey.Indexes: {
const extract = await extractManifestFromFile<IndexConfig>({
appPath,
filePath,
});
const indexManifest: IndexManifest = {
...extract.config,
};
indexes.push(indexManifest);
errors.push(...extract.errors);
warnings.push(...(extract.warnings ?? []));
indexesFilePaths.push(relativePath);
break;
}
case ManifestEntityKey.PageLayoutTabs: {
const extract = await extractManifestFromFile<PageLayoutTabConfig>({
appPath,
@@ -526,6 +546,7 @@ export const buildManifest = async (
application,
objects: objects.sort(byId),
fields: fields.sort(byId),
indexes: indexes.sort(byId),
roles: roles.sort(byId),
skills: skills.sort(byId),
agents: agents.sort(byId),
@@ -544,6 +565,7 @@ export const buildManifest = async (
application: applicationFilePaths,
objects: objectsFilePaths,
fields: fieldsFilePaths,
indexes: indexesFilePaths,
roles: rolesFilePaths,
skills: skillsFilePaths,
agents: agentsFilePaths,
packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-extract-config.ts
+3
View File
@@ -4,6 +4,7 @@ export enum TargetFunction {
DefineApplication = 'defineApplication',
DefineApplicationRole = 'defineApplicationRole',
DefineField = 'defineField',
DefineIndex = 'defineIndex',
DefineLogicFunction = 'defineLogicFunction',
DefinePostInstallLogicFunction = 'definePostInstallLogicFunction',
DefinePreInstallLogicFunction = 'definePreInstallLogicFunction',
@@ -23,6 +24,7 @@ export enum TargetFunction {
export enum ManifestEntityKey {
Application = 'application',
Fields = 'fields',
Indexes = 'indexes',
LogicFunctions = 'logicFunctions',
Objects = 'objects',
Roles = 'roles',
@@ -47,6 +49,7 @@ export const TARGET_FUNCTION_TO_ENTITY_KEY_MAPPING: Record<
[TargetFunction.DefineApplication]: ManifestEntityKey.Application,
[TargetFunction.DefineApplicationRole]: ManifestEntityKey.Roles,
[TargetFunction.DefineField]: ManifestEntityKey.Fields,
[TargetFunction.DefineIndex]: ManifestEntityKey.Indexes,
[TargetFunction.DefineLogicFunction]: ManifestEntityKey.LogicFunctions,
[TargetFunction.DefinePostInstallLogicFunction]:
ManifestEntityKey.LogicFunctions,
packages/twenty-sdk/src/sdk/define/common/types/define-entity.type.ts
+2
View File
@@ -1,6 +1,7 @@
import { type ApplicationConfig } from '@/sdk/define/application/application-config';
import { type CommandMenuItemConfig } from '@/sdk/define/command-menu-items/command-menu-item-config';
import { type FrontComponentConfig } from '@/sdk/define/front-component/front-component-config';
import { type IndexConfig } from '@/sdk/define/indexes/index-config';
import { type LogicFunctionConfig } from '@/sdk/define/logic-functions/logic-function-config';
import { type ObjectConfig } from '@/sdk/define/objects/object-config';
import { type PageLayoutConfig } from '@/sdk/define/page-layouts/page-layout-config';
@@ -29,6 +30,7 @@ export type DefinableEntity =
| ObjectConfig
| FieldManifest
| FrontComponentConfig
| IndexConfig
| LogicFunctionConfig
| PostInstallLogicFunctionConfig
| PreInstallLogicFunctionConfig
packages/twenty-sdk/src/sdk/define/index.ts
+7
View File
@@ -37,6 +37,13 @@ export type {
FrontComponentType,
} from '@/sdk/define/front-component/front-component-config';
export { defineIndex } from '@/sdk/define/indexes/define-index';
export type { IndexConfig } from '@/sdk/define/indexes/index-config';
export type {
IndexFieldManifest,
IndexManifest,
} from 'twenty-shared/application';
export { defineLogicFunction } from '@/sdk/define/logic-functions/define-logic-function';
export { definePostInstallLogicFunction } from '@/sdk/define/logic-functions/define-post-install-logic-function';
export { definePreInstallLogicFunction } from '@/sdk/define/logic-functions/define-pre-install-logic-function';
packages/twenty-sdk/src/sdk/define/indexes/__tests__/define-index.spec.ts
+96
View File
@@ -0,0 +1,96 @@
import { describe, expect, it } from 'vitest';
import { defineIndex } from '@/sdk/define';
const baseValidConfig = {
universalIdentifier: '4f1b9f9f-1111-2222-3333-444444444444',
objectUniversalIdentifier: '4f1b9f9f-aaaa-bbbb-cccc-dddddddddddd',
indexType: 'BTREE' as const,
fields: [
{
universalIdentifier: '4f1b9f9f-1111-1111-1111-111111111111',
fieldUniversalIdentifier: '4f1b9f9f-eeee-ffff-0000-111111111111',
},
],
};
describe('defineIndex', () => {
it('returns success for a valid config', () => {
const result = defineIndex(baseValidConfig);
expect(result.success).toBe(true);
expect(result.errors).toEqual([]);
});
it('reports a missing universalIdentifier', () => {
const result = defineIndex({ ...baseValidConfig, universalIdentifier: '' });
expect(result.success).toBe(false);
expect(result.errors).toContain('Index must have a universalIdentifier');
});
it('rejects a whitespace-only universalIdentifier', () => {
const result = defineIndex({
...baseValidConfig,
universalIdentifier: ' ',
});
expect(result.success).toBe(false);
expect(result.errors).toContain('Index must have a universalIdentifier');
});
it('reports a missing objectUniversalIdentifier', () => {
const result = defineIndex({
...baseValidConfig,
objectUniversalIdentifier: '',
});
expect(result.success).toBe(false);
expect(result.errors).toContain(
'Index must reference an objectUniversalIdentifier',
);
});
it('reports an empty fields list', () => {
const result = defineIndex({ ...baseValidConfig, fields: [] });
expect(result.success).toBe(false);
expect(result.errors).toContain('Index must have at least one field');
});
it('rejects duplicate (fieldUniversalIdentifier, subFieldName) pairs', () => {
const result = defineIndex({
...baseValidConfig,
fields: [
{
universalIdentifier: '4f1b9f9f-1111-1111-1111-111111111111',
fieldUniversalIdentifier: '4f1b9f9f-eeee-ffff-0000-111111111111',
},
{
universalIdentifier: '4f1b9f9f-1111-1111-1111-222222222222',
fieldUniversalIdentifier: '4f1b9f9f-eeee-ffff-0000-111111111111',
},
],
});
expect(result.success).toBe(false);
expect(result.errors).toContain('Index lists the same column twice');
});
it('reports a missing fieldUniversalIdentifier on an entry', () => {
const result = defineIndex({
...baseValidConfig,
fields: [
{
universalIdentifier: '4f1b9f9f-1111-1111-1111-111111111111',
fieldUniversalIdentifier: '',
},
],
});
expect(result.success).toBe(false);
expect(result.errors).toContain(
'IndexField must reference a fieldUniversalIdentifier',
);
});
});
packages/twenty-sdk/src/sdk/define/indexes/define-index.ts
+44
View File
@@ -0,0 +1,44 @@
import { isNonEmptyArray } from 'twenty-shared/utils';
import { type DefineEntity } from '@/sdk/define/common/types/define-entity.type';
import { createValidationResult } from '@/sdk/define/common/utils/create-validation-result';
import { type IndexConfig } from '@/sdk/define/indexes/index-config';
const hasTrimmedContent = (value: string | undefined | null): boolean =>
typeof value === 'string' && value.trim().length > 0;
export const defineIndex: DefineEntity<IndexConfig> = (config) => {
const errors: string[] = [];
if (!hasTrimmedContent(config.universalIdentifier)) {
errors.push('Index must have a universalIdentifier');
}
if (!hasTrimmedContent(config.objectUniversalIdentifier)) {
errors.push('Index must reference an objectUniversalIdentifier');
}
if (!isNonEmptyArray(config.fields)) {
errors.push('Index must have at least one field');
} else {
for (const indexField of config.fields) {
if (!hasTrimmedContent(indexField.universalIdentifier)) {
errors.push('IndexField must have a universalIdentifier');
}
if (!hasTrimmedContent(indexField.fieldUniversalIdentifier)) {
errors.push('IndexField must reference a fieldUniversalIdentifier');
}
}
const dedupKeys = config.fields.map(
(entry) =>
`${entry.fieldUniversalIdentifier}::${entry.subFieldName ?? ''}`,
);
if (new Set(dedupKeys).size !== dedupKeys.length) {
errors.push('Index lists the same column twice');
}
}
return createValidationResult({ config, errors });
};
packages/twenty-sdk/src/sdk/define/indexes/index-config.ts
+3
View File
@@ -0,0 +1,3 @@
import { type IndexManifest } from 'twenty-shared/application';
export type IndexConfig = IndexManifest;
packages/twenty-server/src/database/commands/upgrade-version-command/2-8/2-8-instance-command-fast-1798200000000-add-sub-field-name-to-index-field-metadata.ts
+22
View File
@@ -0,0 +1,22 @@
import { QueryRunner } from 'typeorm';
import { RegisteredInstanceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-instance-command.decorator';
import { FastInstanceCommand } from 'src/engine/core-modules/upgrade/interfaces/fast-instance-command.interface';
@RegisteredInstanceCommand('2.8.0', 1798200000000)
export class AddSubFieldNameToIndexFieldMetadataFastInstanceCommand
implements FastInstanceCommand
{
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."indexFieldMetadata"
ADD COLUMN IF NOT EXISTS "subFieldName" text`,
);
}
public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."indexFieldMetadata" DROP COLUMN IF EXISTS "subFieldName"`,
);
}
}
packages/twenty-server/src/database/commands/upgrade-version-command/2-8/2-8-instance-command-fast-1798300000000-drop-field-metadata-is-unique-column.ts
+24
View File
@@ -0,0 +1,24 @@
import { QueryRunner } from 'typeorm';
import { RegisteredInstanceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-instance-command.decorator';
import { FastInstanceCommand } from 'src/engine/core-modules/upgrade/interfaces/fast-instance-command.interface';
// IndexMetadata is now the single source of truth for field-level
// uniqueness; the column on FieldMetadata is redundant and unread.
@RegisteredInstanceCommand('2.8.0', 1798300000000)
export class DropFieldMetadataIsUniqueColumnFastInstanceCommand
implements FastInstanceCommand
{
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."fieldMetadata" DROP COLUMN IF EXISTS "isUnique"`,
);
}
public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."fieldMetadata"
ADD COLUMN IF NOT EXISTS "isUnique" boolean DEFAULT false`,
);
}
}
packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
+4
View File
@@ -53,6 +53,8 @@ import { DropPostgresCredentialsTableFastInstanceCommand } from 'src/database/co
import { AddRelationTargetFieldMetadataIdToViewFilterFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-6/2-6-instance-command-fast-1798000005000-add-relation-target-field-metadata-id-to-view-filter';
import { AddChannelSyncStageIndexesFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-6/2-6-instance-command-fast-1798000010000-add-channel-sync-stage-indexes';
import { FinalizeRolePermissionFlagCutoverFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-7/2-7-instance-command-fast-1779600000000-finalize-role-permission-flag-cutover';
import { AddSubFieldNameToIndexFieldMetadataFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-8/2-8-instance-command-fast-1798200000000-add-sub-field-name-to-index-field-metadata';
import { DropFieldMetadataIsUniqueColumnFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-8/2-8-instance-command-fast-1798300000000-drop-field-metadata-is-unique-column';
export const INSTANCE_COMMANDS = [
AddViewFieldGroupIdIndexOnViewFieldFastInstanceCommand,
@@ -108,4 +110,6 @@ export const INSTANCE_COMMANDS = [
AddRelationTargetFieldMetadataIdToViewFilterFastInstanceCommand,
AddChannelSyncStageIndexesFastInstanceCommand,
FinalizeRolePermissionFlagCutoverFastInstanceCommand,
AddSubFieldNameToIndexFieldMetadataFastInstanceCommand,
DropFieldMetadataIsUniqueColumnFastInstanceCommand,
];
packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/__tests__/from-index-manifest-to-universal-flat-index.util.spec.ts
+280
View File
@@ -0,0 +1,280 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { fromIndexManifestToUniversalFlatIndex } from 'src/engine/core-modules/application/application-manifest/converters/from-index-manifest-to-universal-flat-index.util';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
import { type UniversalFlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-object-metadata.type';
describe('fromIndexManifestToUniversalFlatIndex', () => {
const now = '2026-01-01T00:00:00.000Z';
const applicationUniversalIdentifier = 'app-uuid-1';
const flatObjectMetadata = {
universalIdentifier: 'obj-uuid-1',
nameSingular: 'company',
isCustom: false,
} as UniversalFlatObjectMetadata;
const scalarField = {
universalIdentifier: 'field-uuid-scalar',
name: 'industry',
type: FieldMetadataType.TEXT,
} as UniversalFlatFieldMetadata;
const compositeField = {
universalIdentifier: 'field-uuid-address',
name: 'address',
type: FieldMetadataType.ADDRESS,
} as UniversalFlatFieldMetadata;
const baseManifest = {
universalIdentifier: 'idx-uuid-1',
objectUniversalIdentifier: 'obj-uuid-1',
indexType: 'BTREE' as const,
};
it('builds a flat index from a scalar field', () => {
const result = fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: scalarField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
});
expect(result.universalIdentifier).toBe('idx-uuid-1');
expect(result.applicationUniversalIdentifier).toBe(
applicationUniversalIdentifier,
);
expect(result.indexType).toBe(IndexType.BTREE);
expect(result.isUnique).toBe(false);
expect(result.indexWhereClause).toBeNull();
expect(result.isCustom).toBe(false);
expect(result.universalFlatIndexFieldMetadatas).toHaveLength(1);
expect(result.universalFlatIndexFieldMetadatas[0]).toMatchObject({
order: 0,
subFieldName: null,
fieldMetadataUniversalIdentifier: scalarField.universalIdentifier,
indexMetadataUniversalIdentifier: 'idx-uuid-1',
});
expect(result.name).toMatch(/^IDX_/);
});
it('builds a flat index from a composite field with subFieldName', () => {
const result = fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: compositeField.universalIdentifier,
subFieldName: 'addressCity',
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [compositeField],
applicationUniversalIdentifier,
now,
});
expect(result.universalFlatIndexFieldMetadatas[0].subFieldName).toBe(
'addressCity',
);
});
it('forwards isUnique from the manifest', () => {
const result = fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
isUnique: true,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: scalarField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
});
expect(result.isUnique).toBe(true);
});
it('throws when a composite field is referenced without a subFieldName', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: compositeField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [compositeField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/requires a subFieldName/);
});
it('throws when a scalar field is given a subFieldName', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: scalarField.universalIdentifier,
subFieldName: 'something',
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/is not composite/);
});
it('throws when a composite sub-field is unknown', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: compositeField.universalIdentifier,
subFieldName: 'unknownSubField',
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [compositeField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/not found on composite field/);
});
it('throws when a referenced field does not exist on the object', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: 'missing-field-uuid',
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/references unknown field/);
});
it('throws when the same (field, subFieldName) pair appears twice', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: scalarField.universalIdentifier,
},
{
universalIdentifier: 'field-entry-2',
fieldUniversalIdentifier: scalarField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/same column twice/);
});
it('throws when GIN is requested on a scalar (non-GIN-compatible) field', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
indexType: 'GIN',
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: scalarField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [scalarField],
applicationUniversalIdentifier,
now,
}),
).toThrow(/GIN index does not support/);
});
it('accepts GIN on a TS_VECTOR field', () => {
const tsVectorField = {
universalIdentifier: 'field-uuid-tsvector',
name: 'searchVector',
type: FieldMetadataType.TS_VECTOR,
} as UniversalFlatFieldMetadata;
const result = fromIndexManifestToUniversalFlatIndex({
indexManifest: {
...baseManifest,
indexType: 'GIN',
fields: [
{
universalIdentifier: 'field-entry-1',
fieldUniversalIdentifier: tsVectorField.universalIdentifier,
},
],
},
flatObjectMetadata,
objectFlatFieldMetadatas: [tsVectorField],
applicationUniversalIdentifier,
now,
});
expect(result.indexType).toBe(IndexType.GIN);
});
it('throws when fields is empty', () => {
expect(() =>
fromIndexManifestToUniversalFlatIndex({
indexManifest: { ...baseManifest, fields: [] },
flatObjectMetadata,
objectFlatFieldMetadatas: [],
applicationUniversalIdentifier,
now,
}),
).toThrow(/at least one field/);
});
});
packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/from-index-manifest-to-universal-flat-index.util.ts
+135
View File
@@ -0,0 +1,135 @@
import { isNonEmptyString } from '@sniptt/guards';
import { type IndexManifest } from 'twenty-shared/application';
import {
compositeTypeDefinitions,
type FieldMetadataType,
} from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
import { generateFlatIndexMetadataWithNameOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/generate-flat-index.util';
import { validateIndexTypeAgainstFieldsOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/validate-index-type-against-fields.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 UniversalFlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-object-metadata.type';
export const fromIndexManifestToUniversalFlatIndex = ({
indexManifest,
flatObjectMetadata,
objectFlatFieldMetadatas,
applicationUniversalIdentifier,
now,
}: {
indexManifest: IndexManifest;
flatObjectMetadata: UniversalFlatObjectMetadata;
objectFlatFieldMetadatas: UniversalFlatFieldMetadata[];
applicationUniversalIdentifier: string;
now: string;
}): UniversalFlatIndexMetadata => {
if (indexManifest.fields.length === 0) {
throw new Error(
`Index "${indexManifest.universalIdentifier}" must reference at least one field`,
);
}
const dedupKeys = indexManifest.fields.map(
(entry) => `${entry.fieldUniversalIdentifier}::${entry.subFieldName ?? ''}`,
);
if (new Set(dedupKeys).size !== dedupKeys.length) {
throw new Error(
`Index "${indexManifest.universalIdentifier}" lists the same column twice`,
);
}
const resolvedIndexType = (indexManifest.indexType ?? 'BTREE') as IndexType;
const resolvedFieldsForValidation: Array<{
type: FieldMetadataType;
name: string;
label: string;
subFieldName: string | null;
}> = [];
const universalFlatIndexFieldMetadatas = indexManifest.fields.map(
(entry, order) => {
const flatField = objectFlatFieldMetadatas.find(
(candidate) =>
candidate.universalIdentifier === entry.fieldUniversalIdentifier,
);
if (!isDefined(flatField)) {
throw new Error(
`Index "${indexManifest.universalIdentifier}" references unknown field ${entry.fieldUniversalIdentifier} on object ${flatObjectMetadata.universalIdentifier}`,
);
}
const isComposite = isCompositeFieldMetadataType(flatField.type);
if (isComposite) {
if (!isNonEmptyString(entry.subFieldName)) {
throw new Error(
`Composite field "${flatField.name}" requires a subFieldName in index "${indexManifest.universalIdentifier}"`,
);
}
const property = compositeTypeDefinitions
.get(flatField.type)
?.properties.find(
(compositeProperty) =>
compositeProperty.name === entry.subFieldName,
);
if (!isDefined(property)) {
throw new Error(
`Sub-field "${entry.subFieldName}" not found on composite field "${flatField.name}" in index "${indexManifest.universalIdentifier}"`,
);
}
} else if (isNonEmptyString(entry.subFieldName)) {
throw new Error(
`Field "${flatField.name}" is not composite — subFieldName must be omitted in index "${indexManifest.universalIdentifier}"`,
);
}
const subFieldName = isComposite ? (entry.subFieldName ?? null) : null;
resolvedFieldsForValidation.push({
type: flatField.type,
name: flatField.name,
label: flatField.label,
subFieldName,
});
return {
createdAt: now,
updatedAt: now,
order,
subFieldName,
fieldMetadataUniversalIdentifier: flatField.universalIdentifier,
indexMetadataUniversalIdentifier: indexManifest.universalIdentifier,
};
},
);
validateIndexTypeAgainstFieldsOrThrow({
indexType: resolvedIndexType,
fields: resolvedFieldsForValidation,
});
return generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata,
objectFlatFieldMetadatas,
flatIndex: {
createdAt: now,
updatedAt: now,
universalIdentifier: indexManifest.universalIdentifier,
applicationUniversalIdentifier,
objectMetadataUniversalIdentifier: flatObjectMetadata.universalIdentifier,
indexType: resolvedIndexType,
indexWhereClause: null,
isCustom: false,
isUnique: indexManifest.isUnique ?? false,
universalFlatIndexFieldMetadatas,
},
});
};
packages/twenty-server/src/engine/core-modules/application/application-manifest/utils/compute-application-manifest-all-universal-flat-entity-maps.util.ts
+72
View File
@@ -1,4 +1,5 @@
import { type Manifest } from 'twenty-shared/application';
import { MAX_CUSTOM_INDEXES_PER_OBJECT } from 'twenty-shared/constants';
import { FieldMetadataType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
@@ -10,6 +11,7 @@ import { fromConnectionProviderManifestToUniversalFlatConnectionProvider } from
import { fromFieldManifestToUniversalFlatFieldMetadata } from 'src/engine/core-modules/application/application-manifest/converters/from-field-manifest-to-universal-flat-field-metadata.util';
import { fromFieldPermissionManifestToUniversalFlatFieldPermission } from 'src/engine/core-modules/application/application-manifest/converters/from-field-permission-manifest-to-universal-flat-field-permission.util';
import { fromFrontComponentManifestToUniversalFlatFrontComponent } from 'src/engine/core-modules/application/application-manifest/converters/from-front-component-manifest-to-universal-flat-front-component.util';
import { fromIndexManifestToUniversalFlatIndex } from 'src/engine/core-modules/application/application-manifest/converters/from-index-manifest-to-universal-flat-index.util';
import { fromLogicFunctionManifestToUniversalFlatLogicFunction } from 'src/engine/core-modules/application/application-manifest/converters/from-logic-function-manifest-to-universal-flat-logic-function.util';
import { fromNavigationMenuItemManifestToUniversalFlatNavigationMenuItem } from 'src/engine/core-modules/application/application-manifest/converters/from-navigation-menu-item-manifest-to-universal-flat-navigation-menu-item.util';
import { fromObjectManifestToUniversalFlatObjectMetadata } from 'src/engine/core-modules/application/application-manifest/converters/from-object-manifest-to-universal-flat-object-metadata.util';
@@ -32,6 +34,7 @@ import { type FlatApplication } from 'src/engine/core-modules/application/types/
import { fromAgentManifestToUniversalFlatAgent } from 'src/engine/core-modules/application/utils/from-agent-manifest-to-universal-flat-agent.util';
import { createEmptyAllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-all-flat-entity-maps.constant';
import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
import { addUniversalFlatEntityToUniversalFlatEntityMapsThroughMutationOrThrow } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/utils/add-universal-flat-entity-to-universal-flat-entity-maps-through-mutation-or-throw.util';
export const computeApplicationManifestAllUniversalFlatEntityMaps = ({
@@ -135,6 +138,75 @@ export const computeApplicationManifestAllUniversalFlatEntityMaps = ({
}
}
const indexCountByObjectUniversalIdentifier = new Map<string, number>();
const fieldsByObjectUniversalIdentifier = new Map<
string,
UniversalFlatFieldMetadata[]
>();
for (const flatField of Object.values(
allUniversalFlatEntityMaps.flatFieldMetadataMaps.byUniversalIdentifier,
)) {
if (!isDefined(flatField)) continue;
const bucket =
fieldsByObjectUniversalIdentifier.get(
flatField.objectMetadataUniversalIdentifier,
) ?? [];
if (bucket.length === 0) {
fieldsByObjectUniversalIdentifier.set(
flatField.objectMetadataUniversalIdentifier,
bucket,
);
}
bucket.push(flatField);
}
for (const indexManifest of manifest.indexes ?? []) {
const flatObjectMetadata =
allUniversalFlatEntityMaps.flatObjectMetadataMaps.byUniversalIdentifier[
indexManifest.objectUniversalIdentifier
];
if (!isDefined(flatObjectMetadata)) {
throw new Error(
`Index "${indexManifest.universalIdentifier}" references unknown object ${indexManifest.objectUniversalIdentifier}`,
);
}
const nextCount =
(indexCountByObjectUniversalIdentifier.get(
indexManifest.objectUniversalIdentifier,
) ?? 0) + 1;
if (nextCount > MAX_CUSTOM_INDEXES_PER_OBJECT) {
throw new Error(
`Application declares more than ${MAX_CUSTOM_INDEXES_PER_OBJECT} indexes on object ${indexManifest.objectUniversalIdentifier}`,
);
}
indexCountByObjectUniversalIdentifier.set(
indexManifest.objectUniversalIdentifier,
nextCount,
);
addUniversalFlatEntityToUniversalFlatEntityMapsThroughMutationOrThrow({
universalFlatEntity: fromIndexManifestToUniversalFlatIndex({
indexManifest,
flatObjectMetadata,
objectFlatFieldMetadatas:
fieldsByObjectUniversalIdentifier.get(
flatObjectMetadata.universalIdentifier,
) ?? [],
applicationUniversalIdentifier,
now,
}),
universalFlatEntityMapsToMutate: allUniversalFlatEntityMaps.flatIndexMaps,
});
}
for (const logicFunctionManifest of manifest.logicFunctions) {
addUniversalFlatEntityToUniversalFlatEntityMapsThroughMutationOrThrow({
universalFlatEntity:
packages/twenty-server/src/engine/dataloaders/dataloader.service.ts
+5 -4
View File
@@ -411,19 +411,20 @@ export class DataloaderService {
return [];
}
return indexMetadataEntity.flatIndexFieldMetadatas.map(
(indexFieldMetadata) => {
return [...indexMetadataEntity.flatIndexFieldMetadatas]
.sort((a, b) => a.order - b.order)
.map((indexFieldMetadata) => {
return {
id: indexFieldMetadata.id,
fieldMetadataId: indexFieldMetadata.fieldMetadataId,
subFieldName: indexFieldMetadata.subFieldName ?? undefined,
order: indexFieldMetadata.order,
createdAt: new Date(indexFieldMetadata.createdAt),
updatedAt: new Date(indexFieldMetadata.updatedAt),
indexMetadataId,
workspaceId,
};
},
);
});
},
);
});
packages/twenty-server/src/engine/metadata-modules/field-metadata/controllers/field-metadata.controller.ts
+26 -2
View File
@@ -45,6 +45,8 @@ import {
import { FieldMetadataRestApiExceptionFilter } from 'src/engine/metadata-modules/field-metadata/filters/field-metadata-rest-api-exception.filter';
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/services/field-metadata.service';
import { fromFieldMetadataEntityToFieldMetadataDto } from 'src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-field-metadata-dto.util';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { computeUniqueFieldMetadataIdsFromFlatIndexMaps } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-flat-index-maps.util';
import {
toLegacyFieldMetadataCreateResponse,
toLegacyFieldMetadataDeleteResponse,
@@ -72,8 +74,20 @@ export class FieldMetadataController {
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
private readonly fieldMetadataService: FieldMetadataService,
private readonly featureFlagService: FeatureFlagService,
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
) {}
private async loadUniqueFieldMetadataIds(
workspaceId: string,
): Promise<ReadonlySet<string>> {
const { flatIndexMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{ workspaceId, flatMapsKeys: ['flatIndexMaps'] },
);
return computeUniqueFieldMetadataIdsFromFlatIndexMaps(flatIndexMaps);
}
@Get()
async findMany(
@Req() request: AuthenticatedRequest,
@@ -87,12 +101,17 @@ export class FieldMetadataController {
endingBefore: parseEndingBeforeRestRequest(request),
});
const uniqueFieldMetadataIds =
await this.loadUniqueFieldMetadataIds(workspaceId);
const result: {
data: FieldMetadataDTO[];
pageInfo: RestCursorPageInfo;
totalCount: number;
} = {
data: items.map(fromFieldMetadataEntityToFieldMetadataDto),
data: items.map((item) =>
fromFieldMetadataEntityToFieldMetadataDto(item, uniqueFieldMetadataIds),
),
pageInfo,
totalCount,
};
@@ -118,7 +137,12 @@ export class FieldMetadataController {
);
}
const result = fromFieldMetadataEntityToFieldMetadataDto(field);
const uniqueFieldMetadataIds =
await this.loadUniqueFieldMetadataIds(workspaceId);
const result = fromFieldMetadataEntityToFieldMetadataDto(
field,
uniqueFieldMetadataIds,
);
return (await this.isNewMetadataFormat(workspaceId))
? result
packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.entity.ts
+5 -2
View File
@@ -122,8 +122,11 @@ export class FieldMetadataEntity<
@Column({ nullable: true, default: true, type: 'boolean' })
isNullable: boolean | null;
// Is this really nullable ?
@Column({ nullable: true, default: false, type: 'boolean' })
// Derived at flat-entity cache build time from the existence of a
// single-field UNIQUE IndexMetadata covering this field — never persisted
// on this entity. Kept on the type so flat-entity consumers continue to
// read field.isUnique without per-call derivation; the PG column was
// dropped by 1798300000000-drop-field-metadata-is-unique-column.ts.
isUnique: boolean | null;
@Column({ default: false })
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/field-metadata-graphql-api-exception-handler.util.ts
+1 -1
View File
@@ -16,7 +16,7 @@ import { workspaceMigrationBuilderGraphqlApiExceptionHandler } from 'src/engine/
export const fieldMetadataGraphqlApiExceptionHandler = (error: Error) => {
if (error instanceof WorkspaceMigrationBuilderException) {
workspaceMigrationBuilderGraphqlApiExceptionHandler(error);
return workspaceMigrationBuilderGraphqlApiExceptionHandler(error);
}
if (error instanceof InvalidMetadataException) {
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-field-metadata-dto.util.ts
+6 -1
View File
@@ -1,8 +1,13 @@
import { type FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
// isUnique is derived from IndexMetadata rather than stored on the field
// entity; callers that need an accurate value (e.g. the REST controller)
// pass the precomputed Set<fieldMetadataId>. Callers in pure-entity
// contexts that don't care about uniqueness can omit it.
export const fromFieldMetadataEntityToFieldMetadataDto = (
entity: FieldMetadataEntity,
uniqueFieldMetadataIds?: ReadonlySet<string>,
): FieldMetadataDTO => ({
id: entity.id,
universalIdentifier: entity.universalIdentifier,
@@ -18,7 +23,7 @@ export const fromFieldMetadataEntityToFieldMetadataDto = (
isSystem: entity.isSystem,
isUIReadOnly: entity.isUIReadOnly,
isNullable: entity.isNullable ?? false,
isUnique: entity.isUnique ?? false,
isUnique: uniqueFieldMetadataIds?.has(entity.id) ?? false,
defaultValue: entity.defaultValue ?? undefined,
options: entity.options ?? undefined,
settings: entity.settings ?? undefined,
packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
+6
View File
@@ -61,6 +61,12 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
toStringify: false,
universalProperty: undefined,
},
// isUnique is derived from IndexMetadata at cache build time and is
// not a column on the fieldMetadata table. It stays in
// propertiesToCompare so per-type validators see the proposed
// change (e.g. rejecting unique on FILES), but the field-metadata
// runner drops it before issuing the SQL UPDATE — the actual state
// change rides on the side-effect index create/delete.
isUnique: {
toCompare: true,
toStringify: false,
packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/__tests__/__snapshots__/morph-relation-from-create-field-input-to-flat-field-metadatas-to-create.spec.ts.snap
+2
View File
@@ -276,6 +276,7 @@ exports[`fromCreateFieldInputToFlatFieldMetadatasToCreate MORPH_RELATION test su
"fieldMetadataUniversalIdentifier": Any<String>,
"indexMetadataUniversalIdentifier": Any<String>,
"order": 0,
"subFieldName": null,
"updatedAt": Any<String>,
},
],
@@ -297,6 +298,7 @@ exports[`fromCreateFieldInputToFlatFieldMetadatasToCreate MORPH_RELATION test su
"fieldMetadataUniversalIdentifier": Any<String>,
"indexMetadataUniversalIdentifier": Any<String>,
"order": 0,
"subFieldName": null,
"updatedAt": Any<String>,
},
],
packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/services/workspace-flat-field-metadata-map-cache.service.ts
+17 -1
View File
@@ -11,6 +11,8 @@ import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-enti
import { FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { fromFieldMetadataEntityToFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-field-metadata-entity-to-flat-field-metadata.util';
import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
import { computeUniqueFieldMetadataIdsFromIndexEntities } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-index-entities.util';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
@@ -30,6 +32,8 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
constructor(
@InjectRepository(FieldMetadataEntity)
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
@InjectRepository(IndexMetadataEntity)
private readonly indexMetadataRepository: Repository<IndexMetadataEntity>,
@InjectRepository(ObjectMetadataEntity)
private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
@InjectRepository(ApplicationEntity)
@@ -53,6 +57,7 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
): Promise<FlatEntityMaps<FlatFieldMetadata>> {
const [
fieldMetadatas,
indexMetadatas,
objectMetadatas,
applications,
viewFields,
@@ -64,6 +69,11 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
where: { workspaceId },
withDeleted: true,
}),
this.indexMetadataRepository.find({
where: { workspaceId, isUnique: true },
relations: ['indexFieldMetadatas'],
withDeleted: true,
}),
this.objectMetadataRepository.find({
where: { workspaceId },
select: ['id', 'universalIdentifier'],
@@ -145,6 +155,9 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
const applicationIdToUniversalIdentifierMap =
createIdToUniversalIdentifierMap(applications);
const uniqueFieldMetadataIds =
computeUniqueFieldMetadataIdsFromIndexEntities(indexMetadatas);
const flatFieldMetadataMaps = createEmptyFlatEntityMaps();
for (const fieldMetadataEntity of fieldMetadatas) {
@@ -169,7 +182,10 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
});
addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
flatEntity: flatFieldMetadata,
flatEntity: {
...flatFieldMetadata,
isUnique: uniqueFieldMetadataIds.has(fieldMetadataEntity.id),
},
flatEntityMapsToMutate: flatFieldMetadataMaps,
});
}
packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/generate-index-for-flat-field-metadata.util.ts
+1
View File
@@ -30,6 +30,7 @@ export const generateIndexForFlatFieldMetadata = ({
flatFieldMetadata.universalIdentifier,
indexMetadataUniversalIdentifier,
order: 0,
subFieldName: null,
updatedAt: createdAt,
},
],
packages/twenty-server/src/engine/metadata-modules/flat-index-metadata/utils/from-flat-index-metadata-to-index-metadata-dto.util.ts
+19
View File
@@ -0,0 +1,19 @@
import { type FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import { type IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
export const fromFlatIndexMetadataToIndexMetadataDto = (
flatIndexMetadata: FlatIndexMetadata,
): IndexMetadataDTO => {
return {
id: flatIndexMetadata.id,
name: flatIndexMetadata.name,
isCustom: flatIndexMetadata.isCustom,
isUnique: flatIndexMetadata.isUnique,
indexWhereClause: flatIndexMetadata.indexWhereClause ?? undefined,
indexType: flatIndexMetadata.indexType,
objectMetadataId: flatIndexMetadata.objectMetadataId,
workspaceId: flatIndexMetadata.workspaceId,
createdAt: new Date(flatIndexMetadata.createdAt),
updatedAt: new Date(flatIndexMetadata.updatedAt),
};
};
packages/twenty-server/src/engine/metadata-modules/flat-index-metadata/utils/from-index-metadata-entity-to-flat-index-metadata.util.ts
+1
View File
@@ -78,6 +78,7 @@ export const fromIndexMetadataEntityToFlatIndexMetadata = ({
return {
order: indexFieldMetadata.order,
subFieldName: indexFieldMetadata.subFieldName,
createdAt: indexFieldMetadata.createdAt.toISOString(),
updatedAt: indexFieldMetadata.updatedAt.toISOString(),
indexMetadataUniversalIdentifier:
packages/twenty-server/src/engine/metadata-modules/index-metadata/dtos/create-index-field.input.ts
+19
View File
@@ -0,0 +1,19 @@
import { Field, InputType } from '@nestjs/graphql';
import { IsOptional, IsString, IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@InputType()
export class CreateIndexFieldInput {
@IsUUID()
@Field(() => UUIDScalarType)
fieldMetadataId!: string;
// Composite sub-property name (e.g. 'addressCity'). Required for composite
// parents, must be absent for scalar/relation parents.
@IsOptional()
@IsString()
@Field({ nullable: true })
subFieldName?: string;
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/dtos/create-index.input.ts
+38
View File
@@ -0,0 +1,38 @@
import { Field, InputType } from '@nestjs/graphql';
import { Type } from 'class-transformer';
import {
ArrayMinSize,
ArrayNotEmpty,
IsArray,
IsEnum,
IsUUID,
ValidateNested,
} from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { CreateIndexFieldInput } from 'src/engine/metadata-modules/index-metadata/dtos/create-index-field.input';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
@InputType()
export class CreateIndexInput {
@IsUUID()
@Field(() => UUIDScalarType)
objectMetadataId!: string;
// Order matters: Postgres uses the leading column first.
@IsArray()
@ArrayNotEmpty()
@ArrayMinSize(1)
@Type(() => CreateIndexFieldInput)
@ValidateNested({ each: true })
@Field(() => [CreateIndexFieldInput])
fields!: CreateIndexFieldInput[];
@IsEnum(IndexType)
@Field(() => IndexType, { defaultValue: IndexType.BTREE })
indexType!: IndexType;
// indexWhereClause is not exposed: the validator only allows a hardcoded
// allowlist, so a free-text field on the user-facing API would mislead.
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/dtos/create-one-index.input.ts
+16
View File
@@ -0,0 +1,16 @@
import { Field, InputType } from '@nestjs/graphql';
import { Type } from 'class-transformer';
import { ValidateNested } from 'class-validator';
import { CreateIndexInput } from 'src/engine/metadata-modules/index-metadata/dtos/create-index.input';
@InputType()
export class CreateOneIndexInput {
@Type(() => CreateIndexInput)
@ValidateNested()
@Field(() => CreateIndexInput, {
description: 'The custom index to create',
})
index!: CreateIndexInput;
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/dtos/delete-index.input.ts
+15
View File
@@ -0,0 +1,15 @@
import { InputType } from '@nestjs/graphql';
import { IDField } from '@ptc-org/nestjs-query-graphql';
import { IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@InputType()
export class DeleteOneIndexInput {
@IDField(() => UUIDScalarType, {
description: 'The id of the custom index to delete.',
})
@IsUUID()
id!: string;
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/dtos/index-field-metadata.dto.ts
+13 -1
View File
@@ -7,7 +7,14 @@ import {
QueryOptions,
Relation,
} from '@ptc-org/nestjs-query-graphql';
import { IsDateString, IsNotEmpty, IsNumber, IsUUID } from 'class-validator';
import {
IsDateString,
IsNotEmpty,
IsNumber,
IsOptional,
IsString,
IsUUID,
} from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
@@ -50,6 +57,11 @@ export class IndexFieldMetadataDTO {
@Field()
order: number;
@IsOptional()
@IsString()
@Field({ nullable: true })
subFieldName?: string;
@IsDateString()
@Field()
createdAt: Date;
packages/twenty-server/src/engine/metadata-modules/index-metadata/index-field-metadata.entity.ts
+6
View File
@@ -57,6 +57,12 @@ export class IndexFieldMetadataEntity implements Required<IndexFieldMetadataEnti
@Column({ nullable: false })
order: number;
// Null for scalar/relation fields. Set to the composite sub-property name
// (e.g. 'addressCity') when the index targets a single column of a
// composite-type parent.
@Column({ type: 'text', nullable: true })
subFieldName: string | null;
@CreateDateColumn({ type: 'timestamptz' })
createdAt: Date;
packages/twenty-server/src/engine/metadata-modules/index-metadata/index-field-metadata.exception.ts
+9
View File
@@ -20,4 +20,13 @@ export enum IndexMetadataExceptionCode {
INDEX_CREATION_FAILED = 'INDEX_CREATION_FAILED',
INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD = 'INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD',
INDEX_NOT_SUPPORTED_FOR_MORH_RELATION_FIELD_AND_RELATION_FIELD = 'INDEX_NOT_SUPPORTED_FOR_MORH_RELATION_FIELD_AND_RELATION_FIELD',
CUSTOM_INDEX_LIMIT_REACHED = 'CUSTOM_INDEX_LIMIT_REACHED',
CANNOT_DELETE_SYSTEM_INDEX = 'CANNOT_DELETE_SYSTEM_INDEX',
INDEX_FIELDS_REQUIRED = 'INDEX_FIELDS_REQUIRED',
DUPLICATE_INDEX_FIELDS = 'DUPLICATE_INDEX_FIELDS',
INDEX_OBJECT_NOT_FOUND = 'INDEX_OBJECT_NOT_FOUND',
INDEX_FIELD_NOT_FOUND_ON_OBJECT = 'INDEX_FIELD_NOT_FOUND_ON_OBJECT',
INDEX_NOT_FOUND = 'INDEX_NOT_FOUND',
INDEX_TYPE_NOT_SUPPORTED_FOR_FIELD_TYPE = 'INDEX_TYPE_NOT_SUPPORTED_FOR_FIELD_TYPE',
DUPLICATE_UNIQUE_INDEX = 'DUPLICATE_UNIQUE_INDEX',
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/index-metadata.module.ts
+11 -2
View File
@@ -5,16 +5,25 @@ import { SortDirection } from '@ptc-org/nestjs-query-core';
import { NestjsQueryGraphQLModule } from '@ptc-org/nestjs-query-graphql';
import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
import { IndexFieldMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-field-metadata.entity';
import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
import { IndexMetadataResolver } from 'src/engine/metadata-modules/index-metadata/index-metadata.resolver';
import { IndexMetadataService } from 'src/engine/metadata-modules/index-metadata/services/index-metadata.service';
import { ObjectMetadataGraphqlApiExceptionInterceptor } from 'src/engine/metadata-modules/object-metadata/interceptors/object-metadata-graphql-api-exception.interceptor';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace-migration/workspace-migration.module';
@Module({
imports: [
TypeOrmModule.forFeature([IndexMetadataEntity]),
ApplicationModule,
PermissionsModule,
WorkspaceMigrationModule,
WorkspaceManyOrAllFlatEntityMapsCacheModule,
NestjsQueryGraphQLModule.forFeature({
imports: [
NestjsQueryTypeOrmModule.forFeature([
@@ -43,7 +52,7 @@ import { ObjectMetadataGraphqlApiExceptionInterceptor } from 'src/engine/metadat
],
}),
],
providers: [IndexMetadataResolver],
exports: [],
providers: [IndexMetadataResolver, IndexMetadataService],
exports: [IndexMetadataService],
})
export class IndexMetadataModule {}
packages/twenty-server/src/engine/metadata-modules/index-metadata/index-metadata.resolver.ts
+47 -1
View File
@@ -1,5 +1,7 @@
import { UseFilters, UseGuards, UsePipes } from '@nestjs/common';
import { Context, Parent, ResolveField } from '@nestjs/graphql';
import { Args, Context, Mutation, Parent, ResolveField } from '@nestjs/graphql';
import { PermissionFlagType } from 'twenty-shared/constants';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { PreventNestToAutoLogGraphqlErrorsFilter } from 'src/engine/core-modules/graphql/filters/prevent-nest-to-auto-log-graphql-errors.filter';
@@ -7,9 +9,15 @@ import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/re
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { type IDataloaders } from 'src/engine/dataloaders/dataloader.interface';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { fromFlatIndexMetadataToIndexMetadataDto } from 'src/engine/metadata-modules/flat-index-metadata/utils/from-flat-index-metadata-to-index-metadata-dto.util';
import { CreateOneIndexInput } from 'src/engine/metadata-modules/index-metadata/dtos/create-one-index.input';
import { DeleteOneIndexInput } from 'src/engine/metadata-modules/index-metadata/dtos/delete-index.input';
import { IndexFieldMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-field-metadata.dto';
import { IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
import { IndexMetadataService } from 'src/engine/metadata-modules/index-metadata/services/index-metadata.service';
import { indexMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-modules/index-metadata/utils/index-metadata-graphql-api-exception-handler.util';
import { objectMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-modules/object-metadata/utils/object-metadata-graphql-api-exception-handler.util';
import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-graphql-api-exception.filter';
@@ -21,6 +29,8 @@ import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/metadata-module
PermissionsGraphqlApiExceptionFilter,
)
export class IndexMetadataResolver {
constructor(private readonly indexMetadataService: IndexMetadataService) {}
@ResolveField(() => [IndexFieldMetadataDTO], { nullable: false })
async indexFieldMetadataList(
@AuthWorkspace() workspace: WorkspaceEntity,
@@ -42,4 +52,40 @@ export class IndexMetadataResolver {
return [];
}
}
@UseGuards(SettingsPermissionGuard(PermissionFlagType.DATA_MODEL))
@Mutation(() => IndexMetadataDTO)
async createOneIndex(
@Args('input') input: CreateOneIndexInput,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
): Promise<IndexMetadataDTO> {
try {
const flatIndexMetadata = await this.indexMetadataService.createOne({
createIndexInput: input.index,
workspaceId,
});
return fromFlatIndexMetadataToIndexMetadataDto(flatIndexMetadata);
} catch (error) {
return indexMetadataGraphqlApiExceptionHandler(error);
}
}
@UseGuards(SettingsPermissionGuard(PermissionFlagType.DATA_MODEL))
@Mutation(() => IndexMetadataDTO)
async deleteOneIndex(
@Args('input') input: DeleteOneIndexInput,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
): Promise<IndexMetadataDTO> {
try {
const flatIndexMetadata = await this.indexMetadataService.deleteOne({
id: input.id,
workspaceId,
});
return fromFlatIndexMetadataToIndexMetadataDto(flatIndexMetadata);
} catch (error) {
return indexMetadataGraphqlApiExceptionHandler(error);
}
}
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/services/__tests__/index-metadata.service.spec.ts
+450
View File
@@ -0,0 +1,450 @@
import { Test, type TestingModule } from '@nestjs/testing';
import { FieldMetadataType } from 'twenty-shared/types';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { getFlatIndexMetadataMock } from 'src/engine/metadata-modules/flat-index-metadata/__mocks__/get-flat-index-metadata.mock';
import { MAX_CUSTOM_INDEXES_PER_OBJECT } from 'twenty-shared/constants';
import {
IndexMetadataException,
IndexMetadataExceptionCode,
} from 'src/engine/metadata-modules/index-metadata/index-field-metadata.exception';
import { IndexMetadataService } from 'src/engine/metadata-modules/index-metadata/services/index-metadata.service';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
const WORKSPACE_ID = 'workspace-id';
const OBJECT_ID = 'object-id';
const OBJECT_UNIVERSAL_ID = 'object-universal-id';
const APPLICATION_UNIVERSAL_ID = 'app-universal-id';
const buildFlatObjectMetadataMaps = () => {
const maps = createEmptyFlatEntityMaps() as ReturnType<
typeof createEmptyFlatEntityMaps
> & {
byUniversalIdentifier: Record<string, unknown>;
universalIdentifierById: Record<string, string>;
};
maps.byUniversalIdentifier = {
[OBJECT_UNIVERSAL_ID]: {
id: OBJECT_ID,
universalIdentifier: OBJECT_UNIVERSAL_ID,
nameSingular: 'company',
isCustom: false,
},
};
maps.universalIdentifierById = { [OBJECT_ID]: OBJECT_UNIVERSAL_ID };
return maps;
};
const buildFlatFieldMetadataMaps = (
fields: {
id: string;
universalIdentifier: string;
name: string;
type?: FieldMetadataType;
}[],
) => {
const maps = createEmptyFlatEntityMaps() as ReturnType<
typeof createEmptyFlatEntityMaps
> & {
byUniversalIdentifier: Record<string, unknown>;
universalIdentifierById: Record<string, string>;
};
for (const field of fields) {
maps.byUniversalIdentifier[field.universalIdentifier] = {
id: field.id,
universalIdentifier: field.universalIdentifier,
name: field.name,
label: field.name,
type: field.type ?? FieldMetadataType.TEXT,
objectMetadataId: OBJECT_ID,
isUnique: false,
isCustom: true,
isActive: true,
isSystem: false,
isNullable: true,
};
maps.universalIdentifierById[field.id] = field.universalIdentifier;
}
return maps;
};
const buildFlatIndexMaps = (
indexes: Array<{
id: string;
universalIdentifier: string;
isCustom: boolean;
}>,
) => {
const maps = createEmptyFlatEntityMaps() as ReturnType<
typeof createEmptyFlatEntityMaps
> & {
byUniversalIdentifier: Record<string, unknown>;
universalIdentifierById: Record<string, string>;
};
for (const index of indexes) {
maps.byUniversalIdentifier[index.universalIdentifier] =
getFlatIndexMetadataMock({
id: index.id,
universalIdentifier: index.universalIdentifier,
objectMetadataId: OBJECT_ID,
objectMetadataUniversalIdentifier: OBJECT_UNIVERSAL_ID,
applicationUniversalIdentifier: APPLICATION_UNIVERSAL_ID,
isCustom: index.isCustom,
});
maps.universalIdentifierById[index.id] = index.universalIdentifier;
}
return maps;
};
describe('IndexMetadataService', () => {
let service: IndexMetadataService;
let cacheService: jest.Mocked<WorkspaceManyOrAllFlatEntityMapsCacheService>;
let migrationService: jest.Mocked<WorkspaceMigrationValidateBuildAndRunService>;
let applicationService: jest.Mocked<ApplicationService>;
const setupCacheReturn = ({
fieldIds = [],
customIndexCount = 0,
}: {
fieldIds?: {
id: string;
universalIdentifier: string;
name: string;
type?: FieldMetadataType;
}[];
customIndexCount?: number;
} = {}) => {
const indexes = Array.from({ length: customIndexCount }).map((_, i) => ({
id: `idx-${i}`,
universalIdentifier: `idx-universal-${i}`,
isCustom: true,
}));
cacheService.getOrRecomputeManyOrAllFlatEntityMaps.mockResolvedValue({
flatObjectMetadataMaps: buildFlatObjectMetadataMaps(),
flatFieldMetadataMaps: buildFlatFieldMetadataMaps(fieldIds),
flatIndexMaps: buildFlatIndexMaps(indexes),
// oxlint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
};
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
IndexMetadataService,
{
provide: WorkspaceManyOrAllFlatEntityMapsCacheService,
useValue: {
getOrRecomputeManyOrAllFlatEntityMaps: jest.fn(),
invalidateFlatEntityMaps: jest.fn(),
},
},
{
provide: WorkspaceMigrationValidateBuildAndRunService,
useValue: {
validateBuildAndRunWorkspaceMigration: jest
.fn()
.mockResolvedValue({ status: 'success' }),
},
},
{
provide: ApplicationService,
useValue: {
findWorkspaceTwentyStandardAndCustomApplicationOrThrow: jest
.fn()
.mockResolvedValue({
workspaceCustomFlatApplication: {
universalIdentifier: APPLICATION_UNIVERSAL_ID,
},
}),
},
},
],
}).compile();
service = module.get(IndexMetadataService);
cacheService = module.get(WorkspaceManyOrAllFlatEntityMapsCacheService);
migrationService = module.get(WorkspaceMigrationValidateBuildAndRunService);
applicationService = module.get(ApplicationService);
});
describe('createOne validation', () => {
it('rejects empty fields', async () => {
setupCacheReturn();
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_FIELDS_REQUIRED,
});
});
it('rejects duplicate (fieldMetadataId + subFieldName) pairs', async () => {
setupCacheReturn();
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [
{ fieldMetadataId: 'field-1' },
{ fieldMetadataId: 'field-1' },
],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.DUPLICATE_INDEX_FIELDS,
});
});
it('rejects when object does not exist', async () => {
setupCacheReturn();
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: 'unknown-object',
fields: [{ fieldMetadataId: 'field-1' }],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_OBJECT_NOT_FOUND,
});
});
it('rejects composite-type fields without subFieldName', async () => {
setupCacheReturn({
fieldIds: [
{
id: 'field-currency',
universalIdentifier: 'field-currency-universal',
name: 'annualRecurringRevenue',
type: FieldMetadataType.CURRENCY,
},
],
});
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [{ fieldMetadataId: 'field-currency' }],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
});
expect(
migrationService.validateBuildAndRunWorkspaceMigration,
).not.toHaveBeenCalled();
});
it('rejects composite-type fields with an unknown subFieldName', async () => {
setupCacheReturn({
fieldIds: [
{
id: 'field-currency',
universalIdentifier: 'field-currency-universal',
name: 'annualRecurringRevenue',
type: FieldMetadataType.CURRENCY,
},
],
});
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [
{
fieldMetadataId: 'field-currency',
subFieldName: 'notARealProp',
},
],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
});
});
it('rejects subFieldName on a scalar field', async () => {
setupCacheReturn({
fieldIds: [
{
id: 'field-text',
universalIdentifier: 'field-text-universal',
name: 'someText',
type: FieldMetadataType.TEXT,
},
],
});
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [
{ fieldMetadataId: 'field-text', subFieldName: 'whatever' },
],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
});
});
it('rejects when a field does not belong to the object', async () => {
setupCacheReturn();
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [{ fieldMetadataId: 'unknown-field' }],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_FIELD_NOT_FOUND_ON_OBJECT,
});
});
it('rejects when custom index count is at the cap', async () => {
setupCacheReturn({
fieldIds: [
{
id: 'field-1',
universalIdentifier: 'field-1-universal',
name: 'someColumn',
},
],
customIndexCount: MAX_CUSTOM_INDEXES_PER_OBJECT,
});
await expect(
service.createOne({
workspaceId: WORKSPACE_ID,
createIndexInput: {
objectMetadataId: OBJECT_ID,
fields: [{ fieldMetadataId: 'field-1' }],
indexType: IndexType.BTREE,
},
}),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.CUSTOM_INDEX_LIMIT_REACHED,
});
expect(
applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow,
).not.toHaveBeenCalled();
});
});
describe('deleteOne validation', () => {
it('throws INDEX_NOT_FOUND (not the generic flat-entity error) for an unknown id', async () => {
cacheService.getOrRecomputeManyOrAllFlatEntityMaps.mockResolvedValue({
flatIndexMaps: buildFlatIndexMaps([]),
// oxlint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
await expect(
service.deleteOne({ id: 'unknown-idx', workspaceId: WORKSPACE_ID }),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.INDEX_NOT_FOUND,
});
expect(
migrationService.validateBuildAndRunWorkspaceMigration,
).not.toHaveBeenCalled();
});
it('refuses to delete a system index', async () => {
cacheService.getOrRecomputeManyOrAllFlatEntityMaps.mockResolvedValue({
flatIndexMaps: buildFlatIndexMaps([
{
id: 'system-idx',
universalIdentifier: 'system-idx-universal',
isCustom: false,
},
]),
// oxlint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
await expect(
service.deleteOne({ id: 'system-idx', workspaceId: WORKSPACE_ID }),
).rejects.toMatchObject({
code: IndexMetadataExceptionCode.CANNOT_DELETE_SYSTEM_INDEX,
});
expect(
migrationService.validateBuildAndRunWorkspaceMigration,
).not.toHaveBeenCalled();
});
it('runs the migration when deleting a custom index', async () => {
cacheService.getOrRecomputeManyOrAllFlatEntityMaps.mockResolvedValue({
flatIndexMaps: buildFlatIndexMaps([
{
id: 'custom-idx',
universalIdentifier: 'custom-idx-universal',
isCustom: true,
},
]),
// oxlint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
await service.deleteOne({
id: 'custom-idx',
workspaceId: WORKSPACE_ID,
});
expect(
migrationService.validateBuildAndRunWorkspaceMigration,
).toHaveBeenCalledTimes(1);
const call =
migrationService.validateBuildAndRunWorkspaceMigration.mock.calls[0][0];
expect(
call.allFlatEntityOperationByMetadataName.index?.flatEntityToDelete,
).toHaveLength(1);
});
});
it('IndexMetadataException can be thrown', () => {
expect(
new IndexMetadataException(
'msg',
IndexMetadataExceptionCode.INDEX_NOT_FOUND,
),
).toBeInstanceOf(IndexMetadataException);
});
});
packages/twenty-server/src/engine/metadata-modules/index-metadata/services/index-metadata.service.ts
+385
View File
@@ -0,0 +1,385 @@
import { Injectable } from '@nestjs/common';
import { msg } from '@lingui/core/macro';
import { compositeTypeDefinitions, RelationType } from 'twenty-shared/types';
import { isNonEmptyString } from '@sniptt/guards';
import { isDefined } from 'twenty-shared/utils';
import { v4 } from 'uuid';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import { isMorphOrRelationFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
import { findFlatEntityByUniversalIdentifier } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-universal-identifier.util';
import { type FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import { MAX_CUSTOM_INDEXES_PER_OBJECT } from 'twenty-shared/constants';
import { type CreateIndexInput } from 'src/engine/metadata-modules/index-metadata/dtos/create-index.input';
import {
IndexMetadataException,
IndexMetadataExceptionCode,
} from 'src/engine/metadata-modules/index-metadata/index-field-metadata.exception';
import { generateFlatIndexMetadataWithNameOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/generate-flat-index.util';
import { validateIndexTypeAgainstFieldsOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/validate-index-type-against-fields.util';
import { validateNoDuplicateUniqueIndexOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/validate-no-duplicate-unique-index.util';
import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
@Injectable()
export class IndexMetadataService {
constructor(
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
private readonly applicationService: ApplicationService,
) {}
async createOne({
createIndexInput,
workspaceId,
}: {
createIndexInput: CreateIndexInput;
workspaceId: string;
}): Promise<FlatIndexMetadata> {
const { fields: fieldInputs } = createIndexInput;
if (fieldInputs.length === 0) {
throw new IndexMetadataException(
'At least one field is required to create an index',
IndexMetadataExceptionCode.INDEX_FIELDS_REQUIRED,
{
userFriendlyMessage: msg`Pick at least one field for the index.`,
},
);
}
// Duplicate check considers (fieldMetadataId, subFieldName) pair so the
// user CAN pick "Address > City" and "Address > Postcode" in the same
// composite index, but not the exact same column twice.
const dedupKeys = fieldInputs.map(
(input) => `${input.fieldMetadataId}::${input.subFieldName ?? ''}`,
);
if (new Set(dedupKeys).size !== dedupKeys.length) {
throw new IndexMetadataException(
'Duplicate field+sub-field in index field list',
IndexMetadataExceptionCode.DUPLICATE_INDEX_FIELDS,
{
userFriendlyMessage: msg`The same column cannot appear twice in an index.`,
},
);
}
const {
flatObjectMetadataMaps: existingFlatObjectMetadataMaps,
flatFieldMetadataMaps: existingFlatFieldMetadataMaps,
flatIndexMaps: existingFlatIndexMaps,
} = await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: [
'flatObjectMetadataMaps',
'flatFieldMetadataMaps',
'flatIndexMaps',
],
},
);
const flatObjectMetadata = findFlatEntityByIdInFlatEntityMaps({
flatEntityMaps: existingFlatObjectMetadataMaps,
flatEntityId: createIndexInput.objectMetadataId,
});
if (!isDefined(flatObjectMetadata)) {
throw new IndexMetadataException(
`Object metadata ${createIndexInput.objectMetadataId} not found`,
IndexMetadataExceptionCode.INDEX_OBJECT_NOT_FOUND,
{
userFriendlyMessage: msg`Could not find the object for this index.`,
},
);
}
// Resolve each input to a flat field + validated subFieldName (or null
// for scalar/relation parents).
const resolvedInputs = fieldInputs.map((input) => {
const flatField = findFlatEntityByIdInFlatEntityMaps({
flatEntityMaps: existingFlatFieldMetadataMaps,
flatEntityId: input.fieldMetadataId,
});
if (
!isDefined(flatField) ||
flatField.objectMetadataId !== createIndexInput.objectMetadataId
) {
throw new IndexMetadataException(
`Field ${input.fieldMetadataId} not found on object ${createIndexInput.objectMetadataId}`,
IndexMetadataExceptionCode.INDEX_FIELD_NOT_FOUND_ON_OBJECT,
{
userFriendlyMessage: msg`One of the selected fields does not belong to this object.`,
},
);
}
if (
isMorphOrRelationFlatFieldMetadata(flatField) &&
flatField.settings?.relationType !== RelationType.MANY_TO_ONE
) {
throw new IndexMetadataException(
`Field ${flatField.name} is a non-MANY_TO_ONE relation and has no join column to index`,
IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_MORH_RELATION_FIELD_AND_RELATION_FIELD,
{
userFriendlyMessage: msg`"${flatField.label}" is a one-to-many relation and can't be indexed directly. Index the foreign-key side instead.`,
},
);
}
const isComposite = isCompositeFieldMetadataType(flatField.type);
if (isComposite) {
if (!isNonEmptyString(input.subFieldName)) {
throw new IndexMetadataException(
`Composite field ${flatField.name} requires a sub-field selection`,
IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
{
userFriendlyMessage: msg`Pick a specific sub-field of "${flatField.label}" — composite fields can't be indexed as a whole.`,
},
);
}
const compositeType = compositeTypeDefinitions.get(flatField.type);
const knownProperty = compositeType?.properties.find(
(property) => property.name === input.subFieldName,
);
if (!isDefined(knownProperty)) {
throw new IndexMetadataException(
`Unknown sub-field ${input.subFieldName} on composite field ${flatField.name}`,
IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
{
userFriendlyMessage: msg`"${input.subFieldName}" is not a valid sub-field of "${flatField.label}".`,
},
);
}
} else if (isNonEmptyString(input.subFieldName)) {
// Scalar / relation parent — sub-field doesn't apply.
throw new IndexMetadataException(
`Field ${flatField.name} is not composite — subFieldName must not be set`,
IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD,
{
userFriendlyMessage: msg`"${flatField.label}" is not a composite field — remove the sub-field selection.`,
},
);
}
return {
flatField,
subFieldName: isComposite ? (input.subFieldName ?? null) : null,
};
});
const objectFlatFieldMetadatas = resolvedInputs.map(
({ flatField }) => flatField,
);
validateIndexTypeAgainstFieldsOrThrow({
indexType: createIndexInput.indexType,
fields: resolvedInputs.map(({ flatField, subFieldName }) => ({
type: flatField.type,
name: flatField.name,
label: flatField.label,
subFieldName,
})),
});
validateNoDuplicateUniqueIndexOrThrow({
proposed: {
isUnique: false,
fields: resolvedInputs.map(({ flatField, subFieldName }) => ({
fieldMetadataId: flatField.id,
subFieldName,
})),
},
existingFlatIndexMaps,
objectMetadataId: createIndexInput.objectMetadataId,
});
const existingCustomIndexCount = Object.values(
existingFlatIndexMaps.byUniversalIdentifier,
)
.filter(isDefined)
.filter(
(flatIndex) =>
flatIndex.objectMetadataId === createIndexInput.objectMetadataId &&
flatIndex.isCustom,
).length;
if (existingCustomIndexCount >= MAX_CUSTOM_INDEXES_PER_OBJECT) {
throw new IndexMetadataException(
`Custom index limit of ${MAX_CUSTOM_INDEXES_PER_OBJECT} reached for object ${createIndexInput.objectMetadataId}`,
IndexMetadataExceptionCode.CUSTOM_INDEX_LIMIT_REACHED,
{
userFriendlyMessage: msg`You can have at most ${MAX_CUSTOM_INDEXES_PER_OBJECT} custom indexes per object. Delete one before creating a new one.`,
},
);
}
const { workspaceCustomFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
{ workspaceId },
);
const indexMetadataUniversalIdentifier = v4();
const createdAt = new Date().toISOString();
const universalFlatIndexMetadata = generateFlatIndexMetadataWithNameOrThrow(
{
flatObjectMetadata,
objectFlatFieldMetadatas,
flatIndex: {
createdAt,
updatedAt: createdAt,
indexType: createIndexInput.indexType,
// WHERE clause is system-only — see CreateIndexInput for rationale.
indexWhereClause: null,
isCustom: true,
isUnique: false,
objectMetadataUniversalIdentifier:
flatObjectMetadata.universalIdentifier,
universalIdentifier: indexMetadataUniversalIdentifier,
applicationUniversalIdentifier:
workspaceCustomFlatApplication.universalIdentifier,
universalFlatIndexFieldMetadatas: resolvedInputs.map(
({ flatField, subFieldName }, order) => ({
createdAt,
updatedAt: createdAt,
order,
subFieldName,
fieldMetadataUniversalIdentifier: flatField.universalIdentifier,
indexMetadataUniversalIdentifier,
}),
),
},
},
);
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
index: {
flatEntityToCreate: [universalFlatIndexMetadata],
flatEntityToDelete: [],
flatEntityToUpdate: [],
},
},
workspaceId,
applicationUniversalIdentifier:
workspaceCustomFlatApplication.universalIdentifier,
},
);
if (validateAndBuildResult.status === 'fail') {
throw new WorkspaceMigrationBuilderException(
validateAndBuildResult,
'Validation errors occurred while creating index',
);
}
const { flatIndexMaps: recomputedFlatIndexMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatIndexMaps'],
},
);
const createdFlatIndexMetadata = findFlatEntityByUniversalIdentifier({
universalIdentifier: indexMetadataUniversalIdentifier,
flatEntityMaps: recomputedFlatIndexMaps,
});
if (!isDefined(createdFlatIndexMetadata)) {
throw new IndexMetadataException(
`Index ${indexMetadataUniversalIdentifier} was created but is missing from the recomputed cache`,
IndexMetadataExceptionCode.INDEX_CREATION_FAILED,
);
}
return createdFlatIndexMetadata;
}
async deleteOne({
id,
workspaceId,
}: {
id: string;
workspaceId: string;
}): Promise<FlatIndexMetadata> {
const { flatIndexMaps: existingFlatIndexMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatIndexMaps'],
},
);
const flatIndexToDelete = findFlatEntityByIdInFlatEntityMaps({
flatEntityMaps: existingFlatIndexMaps,
flatEntityId: id,
});
// Map "no such index" to a domain-specific error so the GraphQL handler
// can return a NotFoundError instead of leaking a FlatEntityMapsException.
if (!isDefined(flatIndexToDelete)) {
throw new IndexMetadataException(
`Index ${id} not found`,
IndexMetadataExceptionCode.INDEX_NOT_FOUND,
{
userFriendlyMessage: msg`This index does not exist or has already been deleted.`,
},
);
}
// Protect system indexes — they back uniqueness constraints, FK lookups,
// and search performance. Dropping one corrupts the data model.
if (!flatIndexToDelete.isCustom) {
throw new IndexMetadataException(
`Index ${id} is a system index and cannot be deleted`,
IndexMetadataExceptionCode.CANNOT_DELETE_SYSTEM_INDEX,
{
userFriendlyMessage: msg`System indexes are required for Twenty to work and cannot be deleted.`,
},
);
}
const { workspaceCustomFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
{ workspaceId },
);
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
index: {
flatEntityToCreate: [],
flatEntityToDelete: [flatIndexToDelete],
flatEntityToUpdate: [],
},
},
workspaceId,
applicationUniversalIdentifier:
workspaceCustomFlatApplication.universalIdentifier,
},
);
if (validateAndBuildResult.status === 'fail') {
throw new WorkspaceMigrationBuilderException(
validateAndBuildResult,
'Validation errors occurred while deleting index',
);
}
return flatIndexToDelete;
}
}
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/__tests__/__snapshots__/generate-flat-index.util.spec.ts.snap
+11
View File
@@ -0,0 +1,11 @@
// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
exports[`generateFlatIndexMetadataWithNameOrThrow pins names for representative standard-index shapes 1`] = `
{
"manyToOneJoin": "IDX_f719a95179070eac397ba18dc70",
"partialUnique": "IDX_UNIQUE_10f41e6e837c3c40fa07ca9d76f",
"scalarNonUnique": "IDX_f6529884d22eaf60dd0bfc9f831",
"scalarUnique": "IDX_UNIQUE_2a32339058d0b6910b0834ddf81",
"searchVectorGin": "IDX_fb1f4905546cfc6d70a971c76f7",
}
`;
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/__tests__/generate-flat-index.util.spec.ts
+148
View File
@@ -0,0 +1,148 @@
import { FieldMetadataType, RelationType } from 'twenty-shared/types';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
import { generateFlatIndexMetadataWithNameOrThrow } from 'src/engine/metadata-modules/index-metadata/utils/generate-flat-index.util';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
import { type UniversalFlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-object-metadata.type';
// Pin the deterministic index names produced by the shared engine for
// canonical input shapes. Any future engine refactor that perturbs a hash
// trips here locally instead of after a workspace migration starts failing
// on a customer install.
describe('generateFlatIndexMetadataWithNameOrThrow', () => {
const now = '2026-05-25T00:00:00.000Z';
const companyObject = {
universalIdentifier: 'obj-company',
nameSingular: 'company',
isCustom: false,
} as UniversalFlatObjectMetadata;
const scalarUniqueField = {
universalIdentifier: 'field-domain',
name: 'domainName',
type: FieldMetadataType.TEXT,
isUnique: true,
} as UniversalFlatFieldMetadata;
const scalarNonUniqueField = {
universalIdentifier: 'field-employees',
name: 'employees',
type: FieldMetadataType.NUMBER,
isUnique: false,
} as UniversalFlatFieldMetadata;
const tsVectorField = {
universalIdentifier: 'field-search',
name: 'searchVector',
type: FieldMetadataType.TS_VECTOR,
isUnique: false,
} as UniversalFlatFieldMetadata;
const manyToOneRelationField = {
universalIdentifier: 'field-account-owner',
name: 'accountOwner',
type: FieldMetadataType.RELATION,
isUnique: false,
universalSettings: { relationType: RelationType.MANY_TO_ONE },
} as unknown as UniversalFlatFieldMetadata;
const buildIndex = (overrides: {
universalIdentifier: string;
isUnique: boolean;
indexType: IndexType;
fieldIds: string[];
indexWhereClause?: string | null;
}) => ({
createdAt: now,
updatedAt: now,
universalIdentifier: overrides.universalIdentifier,
applicationUniversalIdentifier: 'app-standard',
objectMetadataUniversalIdentifier: companyObject.universalIdentifier,
indexType: overrides.indexType,
indexWhereClause: overrides.indexWhereClause ?? null,
isCustom: false,
isUnique: overrides.isUnique,
universalFlatIndexFieldMetadatas: overrides.fieldIds.map((id, order) => ({
createdAt: now,
updatedAt: now,
order,
subFieldName: null,
fieldMetadataUniversalIdentifier: id,
indexMetadataUniversalIdentifier: overrides.universalIdentifier,
})),
});
it('pins names for representative standard-index shapes', () => {
const fields = [
scalarUniqueField,
scalarNonUniqueField,
tsVectorField,
manyToOneRelationField,
];
const scalarUnique = generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata: companyObject,
objectFlatFieldMetadatas: fields,
flatIndex: buildIndex({
universalIdentifier: 'idx-scalar-unique',
isUnique: true,
indexType: IndexType.BTREE,
fieldIds: [scalarUniqueField.universalIdentifier],
}),
});
const scalarNonUnique = generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata: companyObject,
objectFlatFieldMetadatas: fields,
flatIndex: buildIndex({
universalIdentifier: 'idx-scalar-non-unique',
isUnique: false,
indexType: IndexType.BTREE,
fieldIds: [scalarNonUniqueField.universalIdentifier],
}),
});
const searchVectorGin = generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata: companyObject,
objectFlatFieldMetadatas: fields,
flatIndex: buildIndex({
universalIdentifier: 'idx-search-vector',
isUnique: false,
indexType: IndexType.GIN,
fieldIds: [tsVectorField.universalIdentifier],
}),
});
const manyToOneJoin = generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata: companyObject,
objectFlatFieldMetadatas: fields,
flatIndex: buildIndex({
universalIdentifier: 'idx-account-owner',
isUnique: false,
indexType: IndexType.BTREE,
fieldIds: [manyToOneRelationField.universalIdentifier],
}),
});
const partialUnique = generateFlatIndexMetadataWithNameOrThrow({
flatObjectMetadata: companyObject,
objectFlatFieldMetadatas: fields,
flatIndex: buildIndex({
universalIdentifier: 'idx-scalar-unique-partial',
isUnique: true,
indexType: IndexType.BTREE,
fieldIds: [scalarUniqueField.universalIdentifier],
indexWhereClause: '"deletedAt" IS NULL',
}),
});
expect({
scalarUnique: scalarUnique.name,
scalarNonUnique: scalarNonUnique.name,
searchVectorGin: searchVectorGin.name,
manyToOneJoin: manyToOneJoin.name,
partialUnique: partialUnique.name,
}).toMatchSnapshot();
});
});
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-flat-index-maps.util.ts
+12
View File
@@ -0,0 +1,12 @@
import { isDefined } from 'twenty-shared/utils';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import { computeUniqueFieldMetadataIdsFromIndexes } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-indexes.util';
export const computeUniqueFieldMetadataIdsFromFlatIndexMaps = (
flatIndexMaps: FlatEntityMaps<FlatIndexMetadata>,
): Set<string> =>
computeUniqueFieldMetadataIdsFromIndexes(
Object.values(flatIndexMaps.byUniversalIdentifier).filter(isDefined),
);
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-index-entities.util.ts
+6
View File
@@ -0,0 +1,6 @@
import { type IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
import { computeUniqueFieldMetadataIdsFromIndexes } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-indexes.util';
export const computeUniqueFieldMetadataIdsFromIndexEntities = (
indexEntities: ReadonlyArray<IndexMetadataEntity>,
): Set<string> => computeUniqueFieldMetadataIdsFromIndexes(indexEntities);
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-indexes.util.ts
+33
View File
@@ -0,0 +1,33 @@
type IndexLike = {
isUnique: boolean;
flatIndexFieldMetadatas?: Array<{
fieldMetadataId: string;
subFieldName: string | null;
}>;
indexFieldMetadatas?: Array<{
fieldMetadataId: string;
subFieldName: string | null;
}>;
};
// A field is "unique" iff there exists a UNIQUE IndexMetadata whose single
// member is exactly that field (no composite sub-field). Centralized so the
// cache builder, REST controller, and any future consumer agree on the rule.
export const computeUniqueFieldMetadataIdsFromIndexes = (
indexes: ReadonlyArray<IndexLike>,
): Set<string> => {
const set = new Set<string>();
for (const index of indexes) {
if (!index.isUnique) continue;
const fields = index.flatIndexFieldMetadatas ?? index.indexFieldMetadatas;
if (fields?.length !== 1) continue;
if (fields[0].subFieldName !== null) continue;
set.add(fields[0].fieldMetadataId);
}
return set;
};
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/generate-deterministic-index-name-v2.ts
+9
View File
@@ -10,11 +10,16 @@ type GenerateDeterministicIndexNameArgs = {
>;
isUnique?: boolean;
orderedIndexColumnNames: string[];
// Include the WHERE clause in the hash so a partial index on the same
// columns doesn't collide with the non-partial one (Postgres lets them
// coexist; the unique-name constraint must not block that).
indexWhereClause?: string | null;
};
export const generateDeterministicIndexNameV2 = ({
orderedIndexColumnNames,
flatObjectMetadata,
isUnique = false,
indexWhereClause,
}: GenerateDeterministicIndexNameArgs): string => {
const hash = createHash('sha256');
@@ -27,5 +32,9 @@ export const generateDeterministicIndexNameV2 = ({
hash.update(column);
});
if (indexWhereClause) {
hash.update(indexWhereClause);
}
return `IDX_${isUnique ? 'UNIQUE_' : ''}${hash.digest('hex').slice(0, 27)}`;
};
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/generate-flat-index.util.ts
+41 -15
View File
@@ -1,11 +1,13 @@
import { RelationType } from 'twenty-shared/types';
import { compositeTypeDefinitions, RelationType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { computeCompositeColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
import { computeMorphOrRelationFieldJoinColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-morph-or-relation-field-join-column-name.util';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { computeMorphOrRelationFieldJoinColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-morph-or-relation-field-join-column-name.util';
import { isMorphOrRelationUniversalFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
import { generateDeterministicIndexNameV2 } from 'src/engine/metadata-modules/index-metadata/utils/generate-deterministic-index-name-v2';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
@@ -17,12 +19,13 @@ export type GenerateFlatIndexArgs = {
objectFlatFieldMetadatas: UniversalFlatFieldMetadata[];
flatIndex: Omit<UniversalFlatIndexMetadata, 'name'>;
};
export const generateFlatIndexMetadataWithNameOrThrow = ({
flatObjectMetadata,
objectFlatFieldMetadatas,
flatIndex,
}: GenerateFlatIndexArgs): UniversalFlatIndexMetadata => {
const orderedFlatFields = flatIndex.universalFlatIndexFieldMetadatas
const orderedIndexColumnNames = flatIndex.universalFlatIndexFieldMetadatas
.sort((a, b) => a.order - b.order)
.map((flatIndexField) => {
const relatedFlatFieldMetadata = objectFlatFieldMetadatas.find(
@@ -38,36 +41,59 @@ export const generateFlatIndexMetadataWithNameOrThrow = ({
);
}
// Composite parent with an explicit sub-field → single sub-column.
// Composite parent without sub-field falls through to the legacy
// scalar branch below, which produces a deterministic name based on
// the parent name (the runner handles the multi-column SQL expansion
// via isIncludedInUniqueConstraint).
if (
isCompositeFieldMetadataType(relatedFlatFieldMetadata.type) &&
isDefined(flatIndexField.subFieldName)
) {
const property = compositeTypeDefinitions
.get(relatedFlatFieldMetadata.type)
?.properties.find(
(compositeProperty) =>
compositeProperty.name === flatIndexField.subFieldName,
);
if (!isDefined(property)) {
throw new FlatEntityMapsException(
`Composite sub-field "${flatIndexField.subFieldName}" not found on ${relatedFlatFieldMetadata.name}`,
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
return computeCompositeColumnName(
{
name: relatedFlatFieldMetadata.name,
type: relatedFlatFieldMetadata.type,
},
property,
);
}
const isManyToOneRelation =
isMorphOrRelationUniversalFlatFieldMetadata(relatedFlatFieldMetadata) &&
relatedFlatFieldMetadata.universalSettings?.relationType ===
RelationType.MANY_TO_ONE;
const name = isManyToOneRelation
return isManyToOneRelation
? computeMorphOrRelationFieldJoinColumnName({
name: relatedFlatFieldMetadata.name,
})
: relatedFlatFieldMetadata.name;
return {
name,
isUnique: relatedFlatFieldMetadata.isUnique,
};
});
const isUnique = orderedFlatFields.some((flatField) => flatField.isUnique);
const orderedIndexColumnNames = orderedFlatFields.map(
(flatField) => flatField.name,
);
const name = generateDeterministicIndexNameV2({
flatObjectMetadata,
orderedIndexColumnNames,
isUnique,
isUnique: flatIndex.isUnique,
indexWhereClause: flatIndex.indexWhereClause,
});
return {
...flatIndex,
name,
isUnique,
};
};
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/index-metadata-graphql-api-exception-handler.util.ts
+48
View File
@@ -0,0 +1,48 @@
import { assertUnreachable } from 'twenty-shared/utils';
import {
ConflictError,
ForbiddenError,
InternalServerError,
NotFoundError,
UserInputError,
} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import {
IndexMetadataException,
IndexMetadataExceptionCode,
} from 'src/engine/metadata-modules/index-metadata/index-field-metadata.exception';
import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
import { workspaceMigrationBuilderGraphqlApiExceptionHandler } from 'src/engine/workspace-manager/workspace-migration/interceptors/utils/workspace-migration-builder-graphql-api-exception-handler.util';
export const indexMetadataGraphqlApiExceptionHandler = (error: Error) => {
if (error instanceof WorkspaceMigrationBuilderException) {
return workspaceMigrationBuilderGraphqlApiExceptionHandler(error);
}
if (error instanceof IndexMetadataException) {
switch (error.code) {
case IndexMetadataExceptionCode.INDEX_OBJECT_NOT_FOUND:
case IndexMetadataExceptionCode.INDEX_NOT_FOUND:
throw new NotFoundError(error);
case IndexMetadataExceptionCode.INDEX_FIELDS_REQUIRED:
case IndexMetadataExceptionCode.DUPLICATE_INDEX_FIELDS:
case IndexMetadataExceptionCode.INDEX_FIELD_NOT_FOUND_ON_OBJECT:
case IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_COMPOSITE_FIELD:
case IndexMetadataExceptionCode.INDEX_NOT_SUPPORTED_FOR_MORH_RELATION_FIELD_AND_RELATION_FIELD:
case IndexMetadataExceptionCode.INDEX_TYPE_NOT_SUPPORTED_FOR_FIELD_TYPE:
case IndexMetadataExceptionCode.DUPLICATE_UNIQUE_INDEX:
throw new UserInputError(error);
case IndexMetadataExceptionCode.CANNOT_DELETE_SYSTEM_INDEX:
throw new ForbiddenError(error);
case IndexMetadataExceptionCode.CUSTOM_INDEX_LIMIT_REACHED:
throw new ConflictError(error);
case IndexMetadataExceptionCode.INDEX_CREATION_FAILED:
throw new InternalServerError(error);
default: {
return assertUnreachable(error.code);
}
}
}
throw error;
};
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/validate-index-type-against-fields.util.ts
+54
View File
@@ -0,0 +1,54 @@
import { msg } from '@lingui/core/macro';
import { GIN_COMPATIBLE_FIELD_TYPES } from 'twenty-shared/constants';
import { type FieldMetadataType } from 'twenty-shared/types';
import {
IndexMetadataException,
IndexMetadataExceptionCode,
} from 'src/engine/metadata-modules/index-metadata/index-field-metadata.exception';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
type IndexFieldForValidation = {
type: FieldMetadataType;
name: string;
label: string;
subFieldName: string | null;
};
// GIN requires an operator class for each column. Postgres ships a default
// opclass only for jsonb (RAW_JSON), text[]/varchar[] (ARRAY, MULTI_SELECT),
// and tsvector (TS_VECTOR). Composite parents resolve to scalar text/numeric
// sub-columns, none of which have a default GIN opclass.
export const validateIndexTypeAgainstFieldsOrThrow = ({
indexType,
fields,
}: {
indexType: IndexType;
fields: IndexFieldForValidation[];
}): void => {
if (indexType !== IndexType.GIN) {
return;
}
for (const field of fields) {
if (field.subFieldName !== null) {
throw new IndexMetadataException(
`GIN index does not support composite sub-property ${field.name}.${field.subFieldName}`,
IndexMetadataExceptionCode.INDEX_TYPE_NOT_SUPPORTED_FOR_FIELD_TYPE,
{
userFriendlyMessage: msg`GIN indexes work on multi-select, array, JSON, and search-vector columns. "${field.label}" sub-properties don't qualify.`,
},
);
}
if (!GIN_COMPATIBLE_FIELD_TYPES.has(field.type)) {
throw new IndexMetadataException(
`GIN index does not support field ${field.name} of type ${field.type}`,
IndexMetadataExceptionCode.INDEX_TYPE_NOT_SUPPORTED_FOR_FIELD_TYPE,
{
userFriendlyMessage: msg`GIN indexes work on multi-select, array, JSON, and search-vector columns. "${field.label}" doesn't qualify.`,
},
);
}
}
};
packages/twenty-server/src/engine/metadata-modules/index-metadata/utils/validate-no-duplicate-unique-index.util.ts
+63
View File
@@ -0,0 +1,63 @@
import { msg } from '@lingui/core/macro';
import { isDefined } from 'twenty-shared/utils';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import {
IndexMetadataException,
IndexMetadataExceptionCode,
} from 'src/engine/metadata-modules/index-metadata/index-field-metadata.exception';
type ProposedUniqueIndex = {
isUnique: boolean;
fields: Array<{ fieldMetadataId: string; subFieldName: string | null }>;
};
// Field-level uniqueness is now expressed exclusively as a single-field
// UNIQUE IndexMetadata. Two unique indexes on the same single (field,
// subFieldName) pair are redundant and waste write throughput, so reject.
export const validateNoDuplicateUniqueIndexOrThrow = ({
proposed,
existingFlatIndexMaps,
objectMetadataId,
ignoreIndexId,
}: {
proposed: ProposedUniqueIndex;
existingFlatIndexMaps: FlatEntityMaps<FlatIndexMetadata>;
objectMetadataId: string;
ignoreIndexId?: string;
}): void => {
if (!proposed.isUnique || proposed.fields.length !== 1) {
return;
}
const [proposedField] = proposed.fields;
const duplicate = Object.values(
existingFlatIndexMaps.byUniversalIdentifier,
).find((flatIndex) => {
if (!isDefined(flatIndex)) return false;
if (flatIndex.id === ignoreIndexId) return false;
if (!flatIndex.isUnique) return false;
if (flatIndex.objectMetadataId !== objectMetadataId) return false;
if (flatIndex.flatIndexFieldMetadatas.length !== 1) return false;
const existingField = flatIndex.flatIndexFieldMetadatas[0];
return (
existingField.fieldMetadataId === proposedField.fieldMetadataId &&
(existingField.subFieldName ?? null) ===
(proposedField.subFieldName ?? null)
);
});
if (isDefined(duplicate)) {
throw new IndexMetadataException(
`A UNIQUE index already covers this column (${duplicate.name})`,
IndexMetadataExceptionCode.DUPLICATE_UNIQUE_INDEX,
{
userFriendlyMessage: msg`This column is already marked as unique. Toggle the field's "Unique" off first if you want to manage the constraint here.`,
},
);
}
};
packages/twenty-server/src/engine/metadata-modules/object-metadata/controllers/object-metadata.controller.ts
+68 -18
View File
@@ -36,6 +36,8 @@ import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.g
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { fromFieldMetadataEntityToFieldMetadataDto } from 'src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-field-metadata-dto.util';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { computeUniqueFieldMetadataIdsFromFlatIndexMaps } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-flat-index-maps.util';
import { fromFlatObjectMetadataToObjectMetadataDto } from 'src/engine/metadata-modules/flat-object-metadata/utils/from-flat-object-metadata-to-object-metadata-dto.util';
import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';
import { type ObjectMetadataWithFieldsDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata-with-fields.dto';
@@ -76,8 +78,20 @@ export class ObjectMetadataController {
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
private readonly objectMetadataService: ObjectMetadataService,
private readonly featureFlagService: FeatureFlagService,
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
) {}
private async loadUniqueFieldMetadataIds(
workspaceId: string,
): Promise<ReadonlySet<string>> {
const { flatIndexMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{ workspaceId, flatMapsKeys: ['flatIndexMaps'] },
);
return computeUniqueFieldMetadataIdsFromFlatIndexMaps(flatIndexMaps);
}
@Get()
async findMany(
@Req() request: AuthenticatedRequest,
@@ -91,13 +105,20 @@ export class ObjectMetadataController {
endingBefore: parseEndingBeforeRestRequest(request),
});
const fields = await this.findFieldsForObjectIds(
workspaceId,
items.map((object) => object.id),
);
const [fields, uniqueFieldMetadataIds] = await Promise.all([
this.findFieldsForObjectIds(
workspaceId,
items.map((object) => object.id),
),
this.loadUniqueFieldMetadataIds(workspaceId),
]);
const data = items.map((object) =>
this.toObjectWithFieldsDto(object, fields.get(object.id) ?? []),
this.toObjectWithFieldsDto(
object,
fields.get(object.id) ?? [],
uniqueFieldMetadataIds,
),
);
const result: {
@@ -127,11 +148,18 @@ export class ObjectMetadataController {
);
}
const fields = await this.fieldMetadataRepository.find({
where: { objectMetadataId: object.id, workspaceId },
});
const [fields, uniqueFieldMetadataIds] = await Promise.all([
this.fieldMetadataRepository.find({
where: { objectMetadataId: object.id, workspaceId },
}),
this.loadUniqueFieldMetadataIds(workspaceId),
]);
const result = this.toObjectWithFieldsDto(object, fields);
const result = this.toObjectWithFieldsDto(
object,
fields,
uniqueFieldMetadataIds,
);
return (await this.isNewMetadataFormat(workspaceId))
? result
@@ -148,13 +176,21 @@ export class ObjectMetadataController {
workspaceId,
});
const fields = await this.fieldMetadataRepository.find({
where: { objectMetadataId: flatObject.id, workspaceId },
});
const [fields, uniqueFieldMetadataIds] = await Promise.all([
this.fieldMetadataRepository.find({
where: { objectMetadataId: flatObject.id, workspaceId },
}),
this.loadUniqueFieldMetadataIds(workspaceId),
]);
const result: ObjectMetadataWithFieldsDTO = {
...fromFlatObjectMetadataToObjectMetadataDto(flatObject),
fields: fields.map(fromFieldMetadataEntityToFieldMetadataDto),
fields: fields.map((field) =>
fromFieldMetadataEntityToFieldMetadataDto(
field,
uniqueFieldMetadataIds,
),
),
};
return (await this.isNewMetadataFormat(workspaceId))
@@ -211,13 +247,21 @@ export class ObjectMetadataController {
workspaceId,
});
const fields = await this.fieldMetadataRepository.find({
where: { objectMetadataId: flatObject.id, workspaceId },
});
const [fields, uniqueFieldMetadataIds] = await Promise.all([
this.fieldMetadataRepository.find({
where: { objectMetadataId: flatObject.id, workspaceId },
}),
this.loadUniqueFieldMetadataIds(workspaceId),
]);
const result: ObjectMetadataWithFieldsDTO = {
...fromFlatObjectMetadataToObjectMetadataDto(flatObject),
fields: fields.map(fromFieldMetadataEntityToFieldMetadataDto),
fields: fields.map((field) =>
fromFieldMetadataEntityToFieldMetadataDto(
field,
uniqueFieldMetadataIds,
),
),
};
return (await this.isNewMetadataFormat(workspaceId))
@@ -262,10 +306,16 @@ export class ObjectMetadataController {
private toObjectWithFieldsDto(
object: ObjectMetadataEntity,
fields: FieldMetadataEntity[],
uniqueFieldMetadataIds: ReadonlySet<string>,
): ObjectMetadataWithFieldsDTO {
return {
...fromObjectMetadataEntityToObjectMetadataDto(object),
fields: fields.map(fromFieldMetadataEntityToFieldMetadataDto),
fields: fields.map((field) =>
fromFieldMetadataEntityToFieldMetadataDto(
field,
uniqueFieldMetadataIds,
),
),
};
}
}
packages/twenty-server/src/engine/metadata-modules/object-metadata/utils/build-default-index-for-custom-object.util.ts
+1
View File
@@ -31,6 +31,7 @@ export const buildDefaultIndexesForCustomObject = ({
indexMetadataUniversalIdentifier:
tsFlatVectorIndexUniversalIdentifier,
order: 0,
subFieldName: null,
updatedAt: createdAt.toISOString(),
},
],
packages/twenty-server/src/engine/metadata-modules/object-metadata/utils/object-metadata-graphql-api-exception-handler.util.ts
+1 -1
View File
@@ -17,7 +17,7 @@ import { workspaceMigrationBuilderGraphqlApiExceptionHandler } from 'src/engine/
export const objectMetadataGraphqlApiExceptionHandler = (error: Error) => {
if (error instanceof WorkspaceMigrationBuilderException) {
workspaceMigrationBuilderGraphqlApiExceptionHandler(error);
return workspaceMigrationBuilderGraphqlApiExceptionHandler(error);
}
if (error instanceof InvalidMetadataException) {
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/types/workspace-schema-column-definition.type.ts
-1
View File
@@ -4,7 +4,6 @@ export type WorkspaceSchemaColumnDefinition = {
isNullable?: boolean;
default?: string | number | boolean | null;
isPrimary?: boolean;
isUnique?: boolean;
isArray?: boolean;
asExpression?: string;
generatedType?: 'STORED' | 'VIRTUAL';
packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/index/create-standard-index-flat-metadata.util.ts
+2
View File
@@ -108,6 +108,7 @@ export const createStandardIndexFlatMetadata = <
) => ({
createdAt: now,
order: index,
subFieldName: null,
updatedAt: now,
fieldMetadataUniversalIdentifier,
indexMetadataUniversalIdentifier:
@@ -130,6 +131,7 @@ export const createStandardIndexFlatMetadata = <
id: v4(),
indexMetadataId: indexId,
order: index,
subFieldName: null,
updatedAt: now,
workspaceId,
}),
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-index-metadata-validator.service.ts
+13 -4
View File
@@ -4,6 +4,7 @@ import { msg, t } from '@lingui/core/macro';
import { ALL_METADATA_NAME } from 'twenty-shared/metadata';
import {
FieldMetadataType,
RelationType,
compositeTypeDefinitions,
} from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
@@ -11,6 +12,7 @@ import { isDefined } from 'twenty-shared/utils';
import { FlatEntityMapsExceptionCode } from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { findFlatEntityByUniversalIdentifier } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-universal-identifier.util';
import { isCompositeUniversalFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-composite-flat-field-metadata.util';
import { isMorphOrRelationUniversalFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
import { IndexExceptionCode } from 'src/engine/metadata-modules/flat-index-metadata/exceptions/index-exception-code';
import { FailedFlatEntityValidation } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/types/failed-flat-entity-validation.type';
import { getEmptyFlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/utils/get-flat-entity-validation-error.util';
@@ -184,11 +186,18 @@ export class FlatIndexValidatorService {
(property) => property.isIncludedInUniqueConstraint,
);
// MORPH_RELATION resolves to multiple join columns and can't
// satisfy a single-column UNIQUE constraint. RELATION is only
// accepted as MANY_TO_ONE: that side owns a single join column
// (UUID) which Postgres can uniquely index.
const isUnindexableRelation =
isMorphOrRelationUniversalFlatFieldMetadata(relatedFlatField) &&
(relatedFlatField.type === FieldMetadataType.MORPH_RELATION ||
relatedFlatField.universalSettings?.relationType !==
RelationType.MANY_TO_ONE);
if (
[
FieldMetadataType.MORPH_RELATION,
FieldMetadataType.RELATION,
].includes(relatedFlatField.type) ||
isUnindexableRelation ||
isCompositeFieldWithNonIncludedUniqueConstraint
) {
const fieldType = relatedFlatField.type;
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/update-field-action-handler.service.ts
+15 -1
View File
@@ -138,7 +138,21 @@ export class UpdateFieldActionHandlerService extends WorkspaceMigrationRunnerAct
const { entityId, update } = flatAction;
await fieldMetadataRepository.update({ id: entityId, workspaceId }, update);
// isUnique is derived from IndexMetadata at cache build time and has
// no underlying column on fieldMetadata. It travels in the update
// payload only so per-type validators (e.g. FILES rejection) can run
// — the actual state change is handled by the side-effect index
// create/delete in handleIndexChangesDuringFieldUpdate.
const { isUnique: _droppedIsUnique, ...persistedUpdate } = update;
if (Object.keys(persistedUpdate).length === 0) {
return;
}
await fieldMetadataRepository.update(
{ id: entityId, workspaceId },
persistedUpdate,
);
}
async executeForWorkspaceSchema(
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/utils/from-universal-flat-index-to-flat-index.util.ts
+1
View File
@@ -59,6 +59,7 @@ export const fromUniversalFlatIndexToFlatIndex = ({
indexMetadataId,
fieldMetadataId: fieldMetadata.id,
order: universalFlatIndexFieldMetadata.order,
subFieldName: universalFlatIndexFieldMetadata.subFieldName,
createdAt: now,
updatedAt: now,
workspaceId,
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/utils/index-action-handler.utils.ts
+64 -40
View File
@@ -28,57 +28,81 @@ export const computeFlatIndexFieldColumnNames = ({
flatIndexFieldMetadatas: FlatIndexFieldMetadata[];
flatFieldMetadataMaps: MetadataFlatEntityMaps<'fieldMetadata'>;
}): string[] => {
return flatIndexFieldMetadatas.flatMap(({ fieldMetadataId }) => {
const flatFieldMetadata = findFlatEntityByIdInFlatEntityMapsOrThrow({
flatEntityId: fieldMetadataId,
flatEntityMaps: flatFieldMetadataMaps,
});
return flatIndexFieldMetadatas.flatMap(
({ fieldMetadataId, subFieldName }) => {
const flatFieldMetadata = findFlatEntityByIdInFlatEntityMapsOrThrow({
flatEntityId: fieldMetadataId,
flatEntityMaps: flatFieldMetadataMaps,
});
if (!isDefined(flatFieldMetadata)) {
throw new FlatEntityMapsException(
'Index field related field metadata not found',
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
if (isMorphOrRelationFlatFieldMetadata(flatFieldMetadata)) {
if (
flatFieldMetadata.settings?.relationType !== RelationType.MANY_TO_ONE
) {
if (!isDefined(flatFieldMetadata)) {
throw new FlatEntityMapsException(
'Cannot index a relation field that has no join column',
'Index field related field metadata not found',
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
return computeMorphOrRelationFieldJoinColumnName({
name: flatFieldMetadata.name,
});
}
if (isMorphOrRelationFlatFieldMetadata(flatFieldMetadata)) {
if (
flatFieldMetadata.settings?.relationType !== RelationType.MANY_TO_ONE
) {
throw new FlatEntityMapsException(
'Cannot index a relation field that has no join column',
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
if (isCompositeFieldMetadataType(flatFieldMetadata.type)) {
const compositeType = compositeTypeDefinitions.get(
flatFieldMetadata.type,
);
return computeMorphOrRelationFieldJoinColumnName({
name: flatFieldMetadata.name,
});
}
if (!compositeType) {
throw new FlatEntityMapsException(
'Composite type not found',
FlatEntityMapsExceptionCode.INTERNAL_SERVER_ERROR,
if (isCompositeFieldMetadataType(flatFieldMetadata.type)) {
const compositeType = compositeTypeDefinitions.get(
flatFieldMetadata.type,
);
if (!compositeType) {
throw new FlatEntityMapsException(
'Composite type not found',
FlatEntityMapsExceptionCode.INTERNAL_SERVER_ERROR,
);
}
if (isDefined(subFieldName)) {
const property = compositeType.properties.find(
(compositeProperty) => compositeProperty.name === subFieldName,
);
if (!isDefined(property)) {
throw new FlatEntityMapsException(
`Composite sub-field "${subFieldName}" not found on ${flatFieldMetadata.name}`,
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
return [
computeCompositeColumnName(
{ name: flatFieldMetadata.name, type: flatFieldMetadata.type },
property,
),
];
}
// System indexes (no subFieldName) project the composite parent onto
// every property flagged isIncludedInUniqueConstraint.
const uniqueCompositeProperties = compositeType.properties.filter(
(property) => property.isIncludedInUniqueConstraint,
);
return uniqueCompositeProperties.map((subField) =>
computeCompositeColumnName(flatFieldMetadata.name, subField),
);
}
const uniqueCompositeProperties = compositeType.properties.filter(
(property) => property.isIncludedInUniqueConstraint,
);
return uniqueCompositeProperties.map((subField) =>
computeCompositeColumnName(flatFieldMetadata.name, subField),
);
}
return flatFieldMetadata.name;
});
return flatFieldMetadata.name;
},
);
};
export const deleteIndexMetadata = async ({
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/__tests__/generate-column-definitions.util.spec.ts
-10
View File
@@ -59,7 +59,6 @@ describe('Generate Column Definitions', () => {
isArray: false,
isNullable: true,
isPrimary: false,
isUnique: false,
default: 'NULL',
});
});
@@ -104,7 +103,6 @@ describe('Generate Column Definitions', () => {
isArray: true,
isNullable: true,
isPrimary: false,
isUnique: false,
default: 'NULL',
});
});
@@ -157,7 +155,6 @@ describe('Generate Column Definitions', () => {
type: 'uuid',
isNullable: true,
isPrimary: false,
isUnique: false,
default: null,
isArray: false,
});
@@ -199,7 +196,6 @@ describe('Generate Column Definitions', () => {
columns.forEach((column) => {
expect(column.isNullable).toBe(true);
expect(column.isPrimary).toBe(false);
expect(column.isUnique).toBe(false);
expect(column.default).toBe('NULL');
});
});
@@ -233,7 +229,6 @@ describe('Generate Column Definitions', () => {
type: 'numeric',
isNullable: true,
isPrimary: false,
isUnique: false,
default: "'100000000'::numeric",
});
@@ -242,7 +237,6 @@ describe('Generate Column Definitions', () => {
type: 'text',
isNullable: true,
isPrimary: false,
isUnique: false,
default: "'USD'::text",
});
});
@@ -354,7 +348,6 @@ describe('Generate Column Definitions', () => {
type: 'text',
isNullable: true,
isPrimary: false,
isUnique: false,
default: 'NULL',
isArray: false,
},
@@ -382,7 +375,6 @@ describe('Generate Column Definitions', () => {
type: 'boolean',
isNullable: true,
isPrimary: false,
isUnique: false,
default: "'true'::boolean",
isArray: false,
},
@@ -411,7 +403,6 @@ describe('Generate Column Definitions', () => {
type: 'text',
isNullable: true,
isPrimary: false,
isUnique: false,
default: 'NULL',
isArray: false,
},
@@ -438,7 +429,6 @@ describe('Generate Column Definitions', () => {
type: 'uuid',
isNullable: true,
isPrimary: false,
isUnique: false,
default: 'NULL',
isArray: false,
},
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/generate-column-definitions.util.ts
-4
View File
@@ -89,7 +89,6 @@ export const generateCompositeColumnDefinition = ({
: columnType,
isNullable:
parentFlatFieldMetadata.isNullable || !compositeProperty.isRequired,
isUnique: parentFlatFieldMetadata.isUnique ?? false,
default: serializedDefaultValue,
isArray: isArrayFlag,
isPrimary: false,
@@ -108,7 +107,6 @@ const generateTsVectorColumnDefinition = (
type: fieldMetadataTypeToColumnType(flatFieldMetadata.type),
isNullable: true,
isArray: false,
isUnique: false,
default: null,
asExpression: flatFieldMetadata.settings?.asExpression ?? undefined,
generatedType: flatFieldMetadata.settings?.generatedType ?? undefined,
@@ -134,7 +132,6 @@ const generateRelationColumnDefinition = (
type: fieldMetadataTypeToColumnType(FieldMetadataType.UUID),
isNullable: true,
isArray: false,
isUnique: false,
default: null,
isPrimary: false,
};
@@ -171,7 +168,6 @@ const generateColumnDefinition = ({
isArray:
flatFieldMetadata.type === FieldMetadataType.ARRAY ||
flatFieldMetadata.type === FieldMetadataType.MULTI_SELECT,
isUnique: flatFieldMetadata.isUnique ?? false,
default: serializedDefaultValue,
isPrimary: flatFieldMetadata.name === 'id',
};
packages/twenty-shared/src/application/fieldManifestType.ts
+6
View File
@@ -22,6 +22,12 @@ export type RegularFieldManifest<
options?: FieldMetadataOptions<T>;
universalSettings?: FieldMetadataUniversalSettings<T>;
isNullable?: boolean;
/**
* @deprecated Use defineIndex({ isUnique: true, fields: [...] }) instead.
* Indexes are the SDK primitive for uniqueness — they support both single-
* and multi-column unique constraints with a single, consistent API. This
* field still works but will be removed in a future release.
*/
isUnique?: boolean;
objectUniversalIdentifier: string;
};
packages/twenty-shared/src/application/index.ts
+2
View File
@@ -36,6 +36,8 @@ export type {
CommandMenuItemManifest,
FrontComponentManifest,
} from './frontComponentManifestType';
export type { IndexFieldManifest } from './indexFieldManifestType';
export type { IndexManifest } from './indexManifestType';
export type {
LogicFunctionManifest,
CronTriggerSettings,
packages/twenty-shared/src/application/indexFieldManifestType.ts
+6
View File
@@ -0,0 +1,6 @@
import { type SyncableEntityOptions } from '@/application/syncableEntityOptionsType';
export type IndexFieldManifest = SyncableEntityOptions & {
fieldUniversalIdentifier: string;
subFieldName?: string;
};
packages/twenty-shared/src/application/indexManifestType.ts
+9
View File
@@ -0,0 +1,9 @@
import { type IndexFieldManifest } from '@/application/indexFieldManifestType';
import { type SyncableEntityOptions } from '@/application/syncableEntityOptionsType';
export type IndexManifest = SyncableEntityOptions & {
objectUniversalIdentifier: string;
indexType?: 'BTREE' | 'GIN';
isUnique?: boolean;
fields: IndexFieldManifest[];
};
packages/twenty-shared/src/application/manifestType.ts
+2
View File
@@ -7,6 +7,7 @@ import {
type CommandMenuItemManifest,
type FrontComponentManifest,
} from './frontComponentManifestType';
import { type IndexManifest } from './indexManifestType';
import { type LogicFunctionManifest } from './logicFunctionManifestType';
import { type NavigationMenuItemManifest } from './navigationMenuItemManifestType';
import { type ObjectManifest } from './objectManifestType';
@@ -22,6 +23,7 @@ export type Manifest = {
application: ApplicationManifest;
objects: ObjectManifest[];
fields: FieldManifest[];
indexes?: IndexManifest[];
logicFunctions: LogicFunctionManifest[];
frontComponents: FrontComponentManifest[];
roles: RoleManifest[];
packages/twenty-shared/src/constants/GinCompatibleFieldTypes.ts
+8
View File
@@ -0,0 +1,8 @@
import { FieldMetadataType } from '../types/FieldMetadataType';
export const GIN_COMPATIBLE_FIELD_TYPES = new Set<FieldMetadataType>([
FieldMetadataType.TS_VECTOR,
FieldMetadataType.ARRAY,
FieldMetadataType.MULTI_SELECT,
FieldMetadataType.RAW_JSON,
]);
packages/twenty-shared/src/constants/MaxCustomIndexesPerObject.ts
+1
View File
@@ -0,0 +1 @@
export const MAX_CUSTOM_INDEXES_PER_OBJECT = 10;
packages/twenty-shared/src/constants/index.ts
+2
View File
@@ -33,9 +33,11 @@ export { FIELD_FOR_TOTAL_COUNT_AGGREGATE_OPERATION } from './FieldForTotalCountA
export { MAX_OPTIONS_TO_DISPLAY } from './FieldMetadataMaxOptionsToDisplay';
export { FIELD_RESTRICTED_ADDITIONAL_PERMISSIONS_REQUIRED } from './FieldRestrictedAdditionalPermissionsRequired';
export { FILES_FIELD_MAX_NUMBER_OF_VALUES } from './FilesFieldMaxNumberOfValues';
export { GIN_COMPATIBLE_FIELD_TYPES } from './GinCompatibleFieldTypes';
export { GROUP_BY_DATE_GRANULARITY_THAT_REQUIRE_TIME_ZONE } from './GroupByDateGranularityThatRequireTimeZone';
export { IANA_TIME_ZONES } from './IanaTimeZones';
export { LABEL_IDENTIFIER_FIELD_METADATA_TYPES } from './LabelIdentifierFieldMetadataTypes';
export { MAX_CUSTOM_INDEXES_PER_OBJECT } from './MaxCustomIndexesPerObject';
export { MAX_EMAIL_RECIPIENTS } from './MaxEmailRecipients';
export { MULTI_ITEM_FIELD_DEFAULT_MAX_VALUES } from './MultiItemFieldDefaultMaxValues';
export { MULTI_ITEM_FIELD_MIN_MAX_VALUES } from './MultiItemFieldMinMaxValues';
packages/twenty-shared/src/types/SettingsPath.ts
+1
View File
@@ -18,6 +18,7 @@ export enum SettingsPath {
ObjectDetail = 'objects/:objectNamePlural',
ObjectNewFieldSelect = 'objects/:objectNamePlural/new-field/select',
ObjectNewFieldConfigure = 'objects/:objectNamePlural/new-field/configure',
ObjectNewIndex = 'objects/:objectNamePlural/new-index',
ObjectFieldEdit = 'objects/:objectNamePlural/:fieldName',
NewObject = 'objects/new',
WorkspaceMembersPage = 'members',