Skip to content

The open alternative to Salesforce, designed for AI.

18.3 KB
Raw Blame
import { UseFilters, UseGuards, UsePipes } from '@nestjs/common';
import {
  Args,
  Context,
  Mutation,
  Parent,
  Query,
  ResolveField,
} from '@nestjs/graphql';
import { isDefined } from 'twenty-shared/utils';

import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import { PreventNestToAutoLogGraphqlErrorsFilter } from 'src/engine/core-modules/graphql/filters/prevent-nest-to-auto-log-graphql-errors.filter';
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
import { I18nContext } from 'src/engine/core-modules/i18n/types/i18n-context.type';
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 { AllowSuspendedWorkspace } from 'src/engine/decorators/auth/allow-suspended-workspace.decorator';
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
import { FieldFilterInput } from 'src/engine/metadata-modules/field-metadata/dtos/field-filter.input';
import { fromFlatObjectMetadataToObjectMetadataDto } from 'src/engine/metadata-modules/flat-object-metadata/utils/from-flat-object-metadata-to-object-metadata-dto.util';
import { IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
import { IndexFilterInput } from 'src/engine/metadata-modules/index-metadata/dtos/index-filter.input';
import { CreateOneObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';
import { DeleteOneObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/delete-object.input';
import { ObjectMetadataDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto';
import {
  ObjectConnectionDTO,
  ObjectFieldsConnectionDTO,
  ObjectIndexMetadatasConnectionDTO,
} from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata-connection.dto';
import {
  OBJECT_FILTER_COLUMN_BY_FILTER_FIELD,
  ObjectFilterInput,
} from 'src/engine/metadata-modules/object-metadata/dtos/object-filter.input';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { ObjectRecordCountDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-record-count.dto';
import { UpdateOneObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/update-object.input';
import { CursorPagingInput } from 'src/engine/metadata-modules/pagination/dtos/cursor-paging.input';
import { type CursorConnection } from 'src/engine/metadata-modules/pagination/dtos/cursor-connection-type.factory';
import { applyMetadataFilterToQueryBuilder } from 'src/engine/metadata-modules/pagination/utils/apply-metadata-filter-to-query-builder.util';
import { findManyWithCursorPagination } from 'src/engine/metadata-modules/pagination/utils/find-many-with-cursor-pagination.util';
import { getEffectiveImageIdentifierFieldMetadataId } from 'src/engine/metadata-modules/object-metadata/utils/get-effective-image-identifier-field-metadata-id.util';
import { MostlyEmptyFieldsService } from 'src/engine/metadata-modules/object-metadata/mostly-empty-fields.service';
import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
import { ObjectRecordCountService } from 'src/engine/metadata-modules/object-metadata/object-record-count.service';
import { objectMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-modules/object-metadata/utils/object-metadata-graphql-api-exception-handler.util';
import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/permissions/utils/permissions-graphql-api-exception.filter';
import { SearchFieldMetadataDTO } from 'src/engine/metadata-modules/search-field-metadata/dtos/search-field-metadata.dto';
import { resolveEffectiveEntityProperty } from 'src/engine/metadata-modules/overrides/utils/resolve-effective-entity-property.util';
import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
import { fromObjectMetadataEntityToObjectMetadataDto } from 'src/engine/metadata-modules/object-metadata/utils/from-object-metadata-entity-to-object-metadata-dto.util';
import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filters/auth-graphql-api-exception.filter';
import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';
import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';
import { OBJECT_METADATA_READ_ACCESS_POLICY } from 'src/engine/metadata-modules/object-metadata/constants/object-metadata-read-access-policy.constant';
import { OBJECT_METADATA_WRITE_ACCESS_POLICY } from 'src/engine/metadata-modules/object-metadata/constants/object-metadata-write-access-policy.constant';
import { AccessPolicyGuard } from 'src/engine/guards/access-policy.guard';
import { type AccessPolicy } from 'src/engine/guards/types/access-policy.type';

const OBJECT_METADATA_RESOLVER_READ_ACCESS_POLICY: AccessPolicy = {
  authPrincipals: {
    userSession: {
      standard: true,
      impersonated: true,
      playground: true,
      workspaceAgnostic: false,
    },
    apiKey: true,
    oauthClient: true,
    application: true,
  },
  requiredPermissionFlags: [],
};

@MetadataResolver(() => ObjectMetadataDTO)
@UsePipes(ResolverValidationPipe)
@UseFilters(
  PreventNestToAutoLogGraphqlErrorsFilter,
  PermissionsGraphqlApiExceptionFilter,
  AuthGraphqlApiExceptionFilter,
)
export class ObjectMetadataResolver {
  constructor(
    private readonly objectMetadataService: ObjectMetadataService,
    private readonly objectRecordCountService: ObjectRecordCountService,
    private readonly mostlyEmptyFieldsService: MostlyEmptyFieldsService,
    private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
    @InjectWorkspaceScopedRepository(ObjectMetadataEntity)
    private readonly objectMetadataRepository: WorkspaceScopedRepository<ObjectMetadataEntity>,
  ) {}

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_RESOLVER_READ_ACCESS_POLICY))
  @Query(() => ObjectConnectionDTO)
  @AllowSuspendedWorkspace()
  async objects(
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
    @Args('paging', {
      type: () => CursorPagingInput,
      defaultValue: { first: 10 },
      description: 'Limit or page results.',
    })
    paging: CursorPagingInput,
    @Args('filter', {
      type: () => ObjectFilterInput,
      defaultValue: {},
      description: 'Specify to filter the records returned.',
    })
    filter: ObjectFilterInput,
  ): Promise<CursorConnection<ObjectMetadataDTO>> {
    const queryBuilder = this.objectMetadataRepository
      .createQueryBuilder('objectMetadata')
      .where('"objectMetadata"."workspaceId" = :workspaceId', { workspaceId });

    applyMetadataFilterToQueryBuilder({
      whereBuilder: queryBuilder,
      alias: 'objectMetadata',
      filter,
      columnByFilterField: OBJECT_FILTER_COLUMN_BY_FILTER_FIELD,
    });

    const connection = await findManyWithCursorPagination({
      queryBuilder,
      alias: 'objectMetadata',
      paging,
    });

    return {
      ...connection,
      edges: connection.edges.map((edge) => ({
        ...edge,
        node: fromObjectMetadataEntityToObjectMetadataDto(edge.node),
      })),
    };
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_RESOLVER_READ_ACCESS_POLICY))
  @Query(() => ObjectMetadataDTO)
  async object(
    @Args('id', {
      type: () => UUIDScalarType,
      description: 'The id of the record to find.',
    })
    id: string,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<ObjectMetadataDTO> {
    const objectMetadata = await this.objectMetadataRepository.findOne(
      workspaceId,
      { where: { id } },
    );

    if (!isDefined(objectMetadata)) {
      throw new NotFoundError(
        `Unable to find ObjectMetadataEntity with id: ${id}`,
      );
    }

    return fromObjectMetadataEntityToObjectMetadataDto(objectMetadata);
  }

  @ResolveField(() => ObjectFieldsConnectionDTO)
  async fields(
    @AuthWorkspace() workspace: WorkspaceEntity,
    @Parent() objectMetadata: Pick<ObjectMetadataDTO, 'id'>,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @Args('paging', {
      type: () => CursorPagingInput,
      defaultValue: { first: 10 },
      description: 'Limit or page results.',
    })
    paging: CursorPagingInput,
    @Args('filter', {
      type: () => FieldFilterInput,
      defaultValue: {},
      description: 'Specify to filter the records returned.',
    })
    filter: FieldFilterInput,
  ): Promise<CursorConnection<FieldMetadataDTO>> {
    return context.loaders.fieldMetadataConnectionLoader.load({
      objectMetadata,
      workspaceId: workspace.id,
      locale: context.req.locale,
      filter,
      paging,
    });
  }

  @ResolveField(() => ObjectIndexMetadatasConnectionDTO)
  async indexMetadatas(
    @AuthWorkspace() workspace: WorkspaceEntity,
    @Parent() objectMetadata: Pick<ObjectMetadataDTO, 'id'>,
    @Context() context: { loaders: IDataloaders },
    @Args('paging', {
      type: () => CursorPagingInput,
      defaultValue: { first: 10 },
      description: 'Limit or page results.',
    })
    paging: CursorPagingInput,
    @Args('filter', {
      type: () => IndexFilterInput,
      defaultValue: {},
      description: 'Specify to filter the records returned.',
    })
    filter: IndexFilterInput,
  ): Promise<CursorConnection<IndexMetadataDTO>> {
    return context.loaders.indexMetadataConnectionLoader.load({
      objectMetadata,
      workspaceId: workspace.id,
      workspaceCustomApplicationId: workspace.workspaceCustomApplicationId,
      filter,
      paging,
    });
  }

  @ResolveField(() => Boolean, {
    deprecationReason: 'Use isUIEditable',
  })
  async isUIReadOnly(
    @Parent() objectMetadata: ObjectMetadataDTO,
  ): Promise<boolean> {
    return !objectMetadata.isUIEditable;
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_READ_ACCESS_POLICY))
  @Query(() => [ObjectRecordCountDTO])
  async objectRecordCounts(
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<ObjectRecordCountDTO[]> {
    return this.objectRecordCountService.getRecordCounts(workspaceId);
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_READ_ACCESS_POLICY))
  @Query(() => [UUIDScalarType])
  async mostlyEmptyFieldMetadataIds(
    @Args('objectMetadataId', { type: () => UUIDScalarType })
    objectMetadataId: string,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string[]> {
    try {
      return await this.mostlyEmptyFieldsService.getMostlyEmptyFieldMetadataIds(
        {
          workspaceId,
          objectMetadataId,
        },
      );
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);

      return [];
    }
  }

  private async resolveStandardOverride(
    objectMetadata: ObjectMetadataDTO,
    labelKey:
      | 'color'
      | 'labelPlural'
      | 'labelSingular'
      | 'description'
      | 'icon',
    context: { loaders: IDataloaders } & I18nContext,
    workspaceId: string,
  ): Promise<string> {
    return resolveEffectiveEntityProperty({
      metadataName: 'objectMetadata',
      baseValue: objectMetadata[labelKey],
      overrides: objectMetadata.overrides,
      property: labelKey,
      i18nContext:
        await this.applicationTranslationCatalogService.buildEffectiveEntityI18nContext(
          {
            applicationId: objectMetadata.applicationId ?? undefined,
            loaders: context.loaders,
            locale: context.req.locale,
            workspaceId,
          },
        ),
    });
  }

  @ResolveField(() => String, { nullable: true })
  async labelPlural(
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string> {
    return this.resolveStandardOverride(
      objectMetadata,
      'labelPlural',
      context,
      workspaceId,
    );
  }

  @ResolveField(() => String, { nullable: true })
  async labelSingular(
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string> {
    return this.resolveStandardOverride(
      objectMetadata,
      'labelSingular',
      context,
      workspaceId,
    );
  }

  @ResolveField(() => String, { nullable: true })
  async description(
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string> {
    return this.resolveStandardOverride(
      objectMetadata,
      'description',
      context,
      workspaceId,
    );
  }

  @ResolveField(() => String, { nullable: true })
  async icon(
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string> {
    return this.resolveStandardOverride(
      objectMetadata,
      'icon',
      context,
      workspaceId,
    );
  }

  @ResolveField(() => String, { nullable: true })
  async color(
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ): Promise<string> {
    return this.resolveStandardOverride(
      objectMetadata,
      'color',
      context,
      workspaceId,
    );
  }

  @ResolveField(() => UUIDScalarType, { nullable: true })
  imageIdentifierFieldMetadataId(
    @Parent() objectMetadata: ObjectMetadataDTO,
  ): string | null {
    return getEffectiveImageIdentifierFieldMetadataId(objectMetadata);
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_WRITE_ACCESS_POLICY))
  @Mutation(() => ObjectMetadataDTO)
  async createOneObject(
    @Args('input') input: CreateOneObjectInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    try {
      const flatobjectMetadata =
        await this.objectMetadataService.createOneObject({
          createObjectInput: input.object,
          workspaceId,
        });

      return fromFlatObjectMetadataToObjectMetadataDto(flatobjectMetadata);
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);
    }
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_WRITE_ACCESS_POLICY))
  @Mutation(() => ObjectMetadataDTO)
  async deleteOneObject(
    @Args('input') deleteObjectInput: DeleteOneObjectInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    try {
      const flatobjectMetadata =
        await this.objectMetadataService.deleteOneObject({
          deleteObjectInput,
          workspaceId,
        });

      return fromFlatObjectMetadataToObjectMetadataDto(flatobjectMetadata);
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);
    }
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_WRITE_ACCESS_POLICY))
  @Mutation(() => ObjectMetadataDTO)
  async updateOneObject(
    @Args('input') updateObjectInput: UpdateOneObjectInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    try {
      const flatobjectMetadata =
        await this.objectMetadataService.updateOneObject({
          updateObjectInput,
          workspaceId,
        });

      return fromFlatObjectMetadataToObjectMetadataDto(flatobjectMetadata);
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);
    }
  }

  @UseGuards(AccessPolicyGuard(OBJECT_METADATA_WRITE_ACCESS_POLICY))
  @Mutation(() => [ObjectMetadataDTO])
  async updateManyObjects(
    @Args('inputs', { type: () => [UpdateOneObjectInput] })
    updateObjectInputs: UpdateOneObjectInput[],
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    try {
      const flatObjectMetadatas =
        await this.objectMetadataService.updateManyObjects({
          updateObjectInputs,
          workspaceId,
        });

      return flatObjectMetadatas.map(fromFlatObjectMetadataToObjectMetadataDto);
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);
    }
  }

  @ResolveField(() => [FieldMetadataDTO], { nullable: false })
  async fieldsList(
    @AuthWorkspace() workspace: WorkspaceEntity,
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders } & I18nContext,
  ): Promise<FieldMetadataDTO[]> {
    try {
      const fieldMetadataItems = await context.loaders.fieldMetadataLoader.load(
        {
          objectMetadata,
          workspaceId: workspace.id,
          locale: context.req.locale,
        },
      );

      return fieldMetadataItems;
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);

      return [];
    }
  }

  @ResolveField(() => [IndexMetadataDTO], { nullable: false })
  async indexMetadataList(
    @AuthWorkspace() workspace: WorkspaceEntity,
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders },
  ): Promise<IndexMetadataDTO[]> {
    try {
      const indexMetadataItems = await context.loaders.indexMetadataLoader.load(
        {
          objectMetadata,
          workspaceId: workspace.id,
        },
      );

      return indexMetadataItems;
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);

      return [];
    }
  }

  @ResolveField(() => [SearchFieldMetadataDTO], { nullable: false })
  async searchFieldMetadataList(
    @AuthWorkspace() workspace: WorkspaceEntity,
    @Parent() objectMetadata: ObjectMetadataDTO,
    @Context() context: { loaders: IDataloaders },
  ): Promise<SearchFieldMetadataDTO[]> {
    try {
      const searchFieldMetadataItems =
        await context.loaders.searchFieldMetadataLoader.load({
          objectMetadata,
          workspaceId: workspace.id,
        });

      return searchFieldMetadataItems;
    } catch (error) {
      objectMetadataGraphqlApiExceptionHandler(error);

      return [];
    }
  }
}