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

feat: add new ACTOR field type and createdBy standard fields (#6324)

Browse Source 
This pull request introduces a new `FieldMetadataType` called `ACTOR`.
The primary objective of this new type is to add an extra column to the
following objects: `person`, `company`, `opportunity`, `note`, `task`,
and all custom objects.

This composite type contains three properties:

- `source`
    ```typescript
    export enum FieldActorSource {
      EMAIL = 'EMAIL',
      CALENDAR = 'CALENDAR',
      API = 'API',
      IMPORT = 'IMPORT',
      MANUAL = 'MANUAL',
    }
    ```
- `workspaceMemberId`
- This property can be `undefined` in some cases and refers to the
member who created the record.
- `name`
- Serves as a fallback if the `workspaceMember` is deleted and is used
for other source types like `API`.

### Functionality

The pre-hook system has been updated to allow real-time argument
updates. When a record is created, a pre-hook can now compute and update
the arguments accordingly. This enhancement enables the `createdBy`
field to be populated with the correct values based on the
`authContext`.

The `authContext` now includes:
- An optional User entity
- An optional ApiKey entity
- The workspace entity

This provides access to the necessary data for the `createdBy` field.

In the GraphQL API, only the `source` can be specified in the
`createdBy` input. This allows the front-end to specify the source when
creating records from a CSV file.

### Front-End Handling

On the front-end, `orderBy` and `filter` are only applied to the name
property of the `ACTOR` composite type. Currently, we are unable to
apply these operations to the workspace member relation. This means that
if a workspace member changes their first name or last name, there may
be a mismatch because the name will differ from the new one. The name
displayed on the screen is based on the workspace member entity when
available.

### Missing Components

Currently, this PR does not include a `createdBy` value for the `MAIL`
and `CALENDAR` sources. These records are created in a job, and at
present, we only have access to the workspaceId within the job. To
address this, we should use a function similar to
`loadServiceWithContext`, which was recently removed from `TwentyORM`.
This function would allow us to pass the `authContext` to the jobs
without disrupting existing jobs.
Another PR will be created to handle these cases.

### Related Issues

Fixes issue #5155.

### Additional Notes

This PR doesn't include the migrations of the current records and views.
Everything works properly when the database is reset but this part is
still missing for now. We'll add that in another PR.

- There is a minor issue: front-end tests are broken since this commit:
[80c0fc7ff1).

---------

Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Jérémy M
2024-08-03 15:43:31 +02:00
committed by GitHub
parent 9cf08d912a
commit 6432ad39b9
152 changed files with 24425 additions and 14968 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
packages/twenty-server/src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type.ts Normal file
View File

@ -0,0 +1,49 @@
import {
CompositeProperty,
CompositeType,
} from 'src/engine/metadata-modules/field-metadata/interfaces/composite-type.interface';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export enum FieldActorSource {
EMAIL = 'EMAIL',
CALENDAR = 'CALENDAR',
API = 'API',
IMPORT = 'IMPORT',
MANUAL = 'MANUAL',
}
export const actorCompositeType: CompositeType = {
type: FieldMetadataType.ACTOR,
properties: [
{
name: 'source',
type: FieldMetadataType.SELECT,
hidden: false,
isRequired: true,
options: Object.keys(FieldActorSource).map((key, index) => ({
label: `${FieldActorSource[key].toLowerCase()}`,
value: key,
position: index,
})),
} as CompositeProperty<FieldMetadataType.SELECT>,
{
name: 'workspaceMemberId',
type: FieldMetadataType.UUID,
hidden: 'input',
isRequired: false,
},
{
name: 'name',
type: FieldMetadataType.TEXT,
hidden: 'input',
isRequired: true,
},
],
};
export type ActorMetadata = {
source: FieldActorSource;
workspaceMemberId?: string;
name: string;
};

32
packages/twenty-server/src/engine/metadata-modules/field-metadata/composite-types/index.ts
View File

@ -1,24 +1,13 @@
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import { CompositeType } from 'src/engine/metadata-modules/field-metadata/interfaces/composite-type.interface';
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import {
CurrencyMetadata,
currencyCompositeType,
} from 'src/engine/metadata-modules/field-metadata/composite-types/currency.composite-type';
import {
FullNameMetadata,
fullNameCompositeType,
} from 'src/engine/metadata-modules/field-metadata/composite-types/full-name.composite-type';
import {
LinkMetadata,
linkCompositeType,
} from 'src/engine/metadata-modules/field-metadata/composite-types/link.composite-type';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import {
addressCompositeType,
AddressMetadata,
} from 'src/engine/metadata-modules/field-metadata/composite-types/address.composite-type';
import { actorCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
import { addressCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/address.composite-type';
import { currencyCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/currency.composite-type';
import { fullNameCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/full-name.composite-type';
import { linkCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/link.composite-type';
import { linksCompositeType } from 'src/engine/metadata-modules/field-metadata/composite-types/links.composite-type';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export type CompositeFieldsDefinitionFunction = (
fieldMetadata?: FieldMetadataInterface,
@ -33,10 +22,5 @@ export const compositeTypeDefintions = new Map<
[FieldMetadataType.CURRENCY, currencyCompositeType],
[FieldMetadataType.FULL_NAME, fullNameCompositeType],
[FieldMetadataType.ADDRESS, addressCompositeType],
[FieldMetadataType.ACTOR, actorCompositeType],
]);
export type CompositeMetadataTypes =
| AddressMetadata
| CurrencyMetadata
| FullNameMetadata
| LinkMetadata;

17
packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/default-value.input.ts
View File

@ -6,7 +6,9 @@ import {
IsNumber,
IsNumberString,
IsObject,
IsOptional,
IsString,
IsUUID,
Matches,
ValidateIf,
} from 'class-validator';
@ -158,3 +160,18 @@ export class FieldMetadataDefaultValueLinks {
@IsObject()
secondaryLinks: object | null;
}
export class FieldMetadataDefaultActor {
@ValidateIf((_object, value) => value !== null)
@IsString()
source: string;
@ValidateIf((_object, value) => value !== null)
@IsOptional()
@IsUUID()
workspaceMemberId?: string | null;
@ValidateIf((_object, value) => value !== null)
@IsString()
name: string;
}

1
packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.entity.ts
View File

@ -43,6 +43,7 @@ export enum FieldMetadataType {
ADDRESS = 'ADDRESS',
RAW_JSON = 'RAW_JSON',
RICH_TEXT = 'RICH_TEXT',
ACTOR = 'ACTOR',
}
@Entity('fieldMetadata')

7
packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.module.ts
View File

@ -21,6 +21,7 @@ import { WorkspaceMigrationModule } from 'src/engine/metadata-modules/workspace-
import { TwentyORMModule } from 'src/engine/twenty-orm/twenty-orm.module';
import { WorkspaceMigrationRunnerModule } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.module';
import { WorkspaceStatusModule } from 'src/engine/workspace-manager/workspace-status/workspace-manager.module';
import { CreatedByPreQueryHook } from 'src/engine/metadata-modules/field-metadata/query-hooks/created-by.pre-query-hook';
import { FieldMetadataEntity } from './field-metadata.entity';
import { FieldMetadataService } from './field-metadata.service';
@ -42,7 +43,11 @@ import { UpdateFieldInput } from './dtos/update-field.input';
DataSourceModule,
TypeORMModule,
],
services: [IsFieldMetadataDefaultValue, FieldMetadataService],
services: [
IsFieldMetadataDefaultValue,
FieldMetadataService,
CreatedByPreQueryHook,
],
resolvers: [
{
EntityClass: FieldMetadataEntity,

9
packages/twenty-server/src/engine/metadata-modules/field-metadata/interfaces/composite-type.interface.ts
View File

@ -1,12 +1,17 @@
import { FieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-options.interface';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export interface CompositeProperty {
export interface CompositeProperty<
Type extends FieldMetadataType = FieldMetadataType,
> {
name: string;
description?: string;
type: FieldMetadataType;
type: Type;
hidden: 'input' | 'output' | true | false;
isRequired: boolean;
isArray?: boolean;
options?: FieldMetadataOptions<Type>;
}
export interface CompositeType {

2
packages/twenty-server/src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface.ts
View File

@ -1,4 +1,5 @@
import {
FieldMetadataDefaultActor,
FieldMetadataDefaultValueAddress,
FieldMetadataDefaultValueBoolean,
FieldMetadataDefaultValueCurrency,
@ -46,6 +47,7 @@ type FieldMetadataDefaultValueMapping = {
[FieldMetadataType.MULTI_SELECT]: FieldMetadataDefaultValueString;
[FieldMetadataType.RAW_JSON]: FieldMetadataDefaultValueRawJson;
[FieldMetadataType.RICH_TEXT]: FieldMetadataDefaultValueRichText;
[FieldMetadataType.ACTOR]: FieldMetadataDefaultActor;
};
export type FieldMetadataClassValidation =

103
packages/twenty-server/src/engine/metadata-modules/field-metadata/query-hooks/created-by.pre-query-hook.ts Normal file
View File

@ -0,0 +1,103 @@
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { WorkspaceQueryHookInstance } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/interfaces/workspace-query-hook.interface';
import { CreateManyResolverArgs } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolvers-builder.interface';
import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
import {
ActorMetadata,
FieldActorSource,
} from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
type CustomWorkspaceItem = Omit<
CustomWorkspaceEntity,
'createdAt' | 'updatedAt'
> & {
createdAt: string;
updatedAt: string;
};
@WorkspaceQueryHook(`*.createMany`)
export class CreatedByPreQueryHook implements WorkspaceQueryHookInstance {
constructor(
private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
@InjectRepository(FieldMetadataEntity, 'metadata')
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
) {}
async execute(
authContext: AuthContext,
objectName: string,
payload: CreateManyResolverArgs<CustomWorkspaceItem>,
): Promise<CreateManyResolverArgs<CustomWorkspaceItem>> {
let createdBy: ActorMetadata | null = null;
// TODO: Once all objects have it, we can remove this check
const createdByFieldMetadata = await this.fieldMetadataRepository.findOne({
where: {
object: {
nameSingular: objectName,
},
name: 'createdBy',
workspaceId: authContext.workspace.id,
},
});
if (!createdByFieldMetadata) {
return payload;
}
// If user is logged in, we use the workspace member
if (authContext.user) {
const workspaceMemberRepository =
await this.twentyORMGlobalManager.getRepositoryForWorkspace<WorkspaceMemberWorkspaceEntity>(
authContext.workspace.id,
'workspaceMember',
);
const workspaceMember = await workspaceMemberRepository.findOne({
where: {
userId: authContext.user?.id,
},
});
if (!workspaceMember) {
throw new Error(
`Workspace member can't be found for user ${authContext.user.id}`,
);
}
createdBy = {
source: FieldActorSource.MANUAL,
workspaceMemberId: workspaceMember.id,
name: `${workspaceMember.name.firstName} ${workspaceMember.name.lastName}`,
};
}
if (authContext.apiKey) {
createdBy = {
source: FieldActorSource.API,
name: authContext.apiKey.name,
};
}
for (const datum of payload.data) {
// Front-end can fill the source field
if (createdBy && (!datum.createdBy || !datum.createdBy.name)) {
datum.createdBy = {
...createdBy,
source: datum.createdBy?.source ?? createdBy.source,
};
}
}
return payload;
}
}

4
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util.ts
View File

@ -7,12 +7,14 @@ export const isCompositeFieldMetadataType = (
| FieldMetadataType.CURRENCY
| FieldMetadataType.FULL_NAME
| FieldMetadataType.ADDRESS
| FieldMetadataType.LINKS => {
| FieldMetadataType.LINKS
| FieldMetadataType.ACTOR => {
return [
FieldMetadataType.LINK,
FieldMetadataType.CURRENCY,
FieldMetadataType.FULL_NAME,
FieldMetadataType.ADDRESS,
FieldMetadataType.LINKS,
FieldMetadataType.ACTOR,
].includes(type);
};

2
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/validate-default-value-for-type.util.ts
View File

@ -7,6 +7,7 @@ import {
} from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface';
import {
FieldMetadataDefaultActor,
FieldMetadataDefaultValueAddress,
FieldMetadataDefaultValueBoolean,
FieldMetadataDefaultValueCurrency,
@ -51,6 +52,7 @@ export const defaultValueValidatorsMap = {
[FieldMetadataType.RICH_TEXT]: [FieldMetadataDefaultValueString],
[FieldMetadataType.RAW_JSON]: [FieldMetadataDefaultValueRawJson],
[FieldMetadataType.LINKS]: [FieldMetadataDefaultValueLinks],
[FieldMetadataType.ACTOR]: [FieldMetadataDefaultActor],
};
type ValidationResult = {

55
packages/twenty-server/src/engine/metadata-modules/workspace-migration/factories/composite-column-action.factory.ts
View File

@ -47,17 +47,29 @@ export class CompositeColumnActionFactory extends ColumnActionAbstractFactory<Co
const columnActions: WorkspaceMigrationColumnCreate[] = [];
for (const property of compositeType.properties) {
if (property.type === FieldMetadataType.RELATION) {
throw new WorkspaceMigrationException(
`Relation type not supported for composite columns`,
WorkspaceMigrationExceptionCode.INVALID_COMPOSITE_TYPE,
);
}
const columnName = computeCompositeColumnName(fieldMetadata, property);
const defaultValue = fieldMetadata.defaultValue?.[property.name];
const serializedDefaultValue = serializeDefaultValue(defaultValue);
const enumOptions = property.options
? [...property.options.map((option) => option.value)]
: undefined;
columnActions.push({
action: WorkspaceMigrationColumnActionType.CREATE,
columnName,
columnType: fieldMetadataTypeToColumnType(property.type),
enum: enumOptions,
isNullable: fieldMetadata.isNullable || !property.isRequired,
defaultValue: serializedDefaultValue,
isArray: property.isArray,
isArray:
property.type === FieldMetadataType.MULTI_SELECT || property.isArray,
});
}
@ -103,6 +115,16 @@ export class CompositeColumnActionFactory extends ColumnActionAbstractFactory<Co
);
}
if (
alteredProperty.type === FieldMetadataType.RELATION ||
currentProperty.type === FieldMetadataType.RELATION
) {
throw new WorkspaceMigrationException(
`Relation type not supported for composite columns`,
WorkspaceMigrationExceptionCode.INVALID_COMPOSITE_TYPE,
);
}
const currentColumnName = computeCompositeColumnName(
currentFieldMetadata,
currentProperty,
@ -114,26 +136,53 @@ export class CompositeColumnActionFactory extends ColumnActionAbstractFactory<Co
const defaultValue =
alteredFieldMetadata.defaultValue?.[alteredProperty.name];
const serializedDefaultValue = serializeDefaultValue(defaultValue);
const enumOptions = alteredProperty.options
? [
...alteredProperty.options.map((option) => {
const currentOption = currentProperty.options?.find(
(currentOption) => currentOption.id === option.id,
);
// The id is the same, but the value is different, so we need to alter the enum
if (currentOption && currentOption.value !== option.value) {
return {
from: currentOption.value,
to: option.value,
};
}
return option.value;
}),
]
: undefined;
columnActions.push({
action: WorkspaceMigrationColumnActionType.ALTER,
currentColumnDefinition: {
columnName: currentColumnName,
columnType: fieldMetadataTypeToColumnType(currentProperty.type),
enum: currentProperty.options
? [...currentProperty.options.map((option) => option.value)]
: undefined,
isNullable:
currentFieldMetadata.isNullable || !currentProperty.isRequired,
defaultValue: serializeDefaultValue(
currentFieldMetadata.defaultValue?.[currentProperty.name],
),
isArray: currentProperty.isArray,
isArray:
currentProperty.type === FieldMetadataType.MULTI_SELECT ||
currentProperty.isArray,
},
alteredColumnDefinition: {
columnName: alteredColumnName,
columnType: fieldMetadataTypeToColumnType(alteredProperty.type),
enum: enumOptions,
isNullable:
alteredFieldMetadata.isNullable || !alteredProperty.isRequired,
defaultValue: serializedDefaultValue,
isArray: alteredProperty.isArray,
isArray:
alteredProperty.type === FieldMetadataType.MULTI_SELECT ||
alteredProperty.isArray,
},
});
}

1
packages/twenty-server/src/engine/metadata-modules/workspace-migration/workspace-migration.exception.ts
View File

@ -11,4 +11,5 @@ export enum WorkspaceMigrationExceptionCode {
NO_FACTORY_FOUND = 'NO_FACTORY_FOUND',
INVALID_ACTION = 'INVALID_ACTION',
INVALID_FIELD_METADATA = 'INVALID_FIELD_METADATA',
INVALID_COMPOSITE_TYPE = 'INVALID_COMPOSITE_TYPE',
}

1
packages/twenty-server/src/engine/metadata-modules/workspace-migration/workspace-migration.factory.ts
View File

@ -96,6 +96,7 @@ export class WorkspaceMigrationFactory {
{ factory: this.compositeColumnActionFactory },
],
[FieldMetadataType.LINKS, { factory: this.compositeColumnActionFactory }],
[FieldMetadataType.ACTOR, { factory: this.compositeColumnActionFactory }],
]);
}