feat: create ViewField model (#961)

* feat: create ViewField model

- Created ViewField prisma model
- Added ViewField server resolvers for findMany/updateOne
- Added getViewFields/updateViewField graphql queries

Closes #849

* chore: update node version in .nvmrc files

server/src/ability/ability.factory.ts

@@ -17,6 +17,7 @@ import {
   PipelineProgress,
   Attachment,
   UserSettings,
+  ViewField,
 } from '@prisma/client';
 
 import { AbilityAction } from './ability.action';
@@ -36,6 +37,7 @@ type SubjectsAbility = Subjects<{
   PipelineProgress: PipelineProgress;
   Attachment: Attachment;
   UserSettings: UserSettings;
+  ViewField: ViewField;
 }>;
 
 export type AppAbility = PureAbility<
@@ -128,6 +130,10 @@ export class AbilityFactory {
       workspaceId: workspace.id,
     });
 
+    // ViewField
+    can(AbilityAction.Read, 'ViewField', { workspaceId: workspace.id });
+    can(AbilityAction.Update, 'ViewField', { workspaceId: workspace.id });
+
     return build();
   }
 }

server/src/ability/ability.module.ts

@@ -94,6 +94,10 @@ import {
   ReadAttachmentAbilityHandler,
   UpdateAttachmentAbilityHandler,
 } from './handlers/attachment.ability-handler';
+import {
+  ReadViewFieldAbilityHandler,
+  UpdateViewFieldAbilityHandler,
+} from './handlers/view-field.ability-handler';
 
 @Global()
 @Module({
@@ -178,6 +182,9 @@ import {
     CreatePipelineProgressAbilityHandler,
     UpdatePipelineProgressAbilityHandler,
     DeletePipelineProgressAbilityHandler,
+    // ViewField
+    ReadViewFieldAbilityHandler,
+    UpdateViewFieldAbilityHandler,
   ],
   exports: [
     AbilityFactory,
@@ -259,6 +266,9 @@ import {
     CreatePipelineProgressAbilityHandler,
     UpdatePipelineProgressAbilityHandler,
     DeletePipelineProgressAbilityHandler,
+    // ViewField
+    ReadViewFieldAbilityHandler,
+    UpdateViewFieldAbilityHandler,
   ],
 })
 export class AbilityModule {}

server/src/ability/handlers/view-field.ability-handler.ts

@@ -0,0 +1,56 @@
+import {
+  ExecutionContext,
+  Injectable,
+  NotFoundException,
+} from '@nestjs/common';
+import { GqlExecutionContext } from '@nestjs/graphql';
+
+import { subject } from '@casl/ability';
+
+import { IAbilityHandler } from 'src/ability/interfaces/ability-handler.interface';
+
+import { AbilityAction } from 'src/ability/ability.action';
+import { AppAbility } from 'src/ability/ability.factory';
+import { relationAbilityChecker } from 'src/ability/ability.util';
+import { ViewFieldWhereInput } from 'src/core/@generated/view-field/view-field-where.input';
+import { PrismaService } from 'src/database/prisma.service';
+import { assert } from 'src/utils/assert';
+
+class ViewFieldArgs {
+  where?: ViewFieldWhereInput;
+  [key: string]: any;
+}
+
+@Injectable()
+export class ReadViewFieldAbilityHandler implements IAbilityHandler {
+  handle(ability: AppAbility) {
+    return ability.can(AbilityAction.Read, 'ViewField');
+  }
+}
+
+@Injectable()
+export class UpdateViewFieldAbilityHandler implements IAbilityHandler {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async handle(ability: AppAbility, context: ExecutionContext) {
+    const gqlContext = GqlExecutionContext.create(context);
+    const args = gqlContext.getArgs<ViewFieldArgs>();
+    const viewField = await this.prismaService.client.viewField.findFirst({
+      where: args.where,
+    });
+    assert(viewField, '', NotFoundException);
+
+    const allowed = await relationAbilityChecker(
+      'ViewField',
+      ability,
+      this.prismaService.client,
+      args,
+    );
+
+    if (!allowed) {
+      return false;
+    }
+
+    return ability.can(AbilityAction.Update, subject('ViewField', viewField));
+  }
+}

server/src/core/core.module.ts

@@ -11,6 +11,7 @@ import { AnalyticsModule } from './analytics/analytics.module';
 import { FileModule } from './file/file.module';
 import { ClientConfigModule } from './client-config/client-config.module';
 import { AttachmentModule } from './attachment/attachment.module';
+import { ViewModule } from './view/view.module';
 
 @Module({
   imports: [
@@ -25,6 +26,7 @@ import { AttachmentModule } from './attachment/attachment.module';
     FileModule,
     ClientConfigModule,
     AttachmentModule,
+    ViewModule,
   ],
   exports: [
     AuthModule,

server/src/core/view/resolvers/view-field.resolver.spec.ts

@@ -0,0 +1,32 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { ViewFieldService } from 'src/core/view/services/view-field.service';
+
+import { ViewFieldResolver } from './view-field.resolver';
+import { AbilityFactory } from 'src/ability/ability.factory';
+
+describe('ViewFieldResolver', () => {
+  let resolver: ViewFieldResolver;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        ViewFieldResolver,
+        {
+          provide: ViewFieldService,
+          useValue: {},
+        },
+        {
+          provide: AbilityFactory,
+          useValue: {},
+        },
+      ],
+    }).compile();
+
+    resolver = module.get<ViewFieldResolver>(ViewFieldResolver);
+  });
+
+  it('should be defined', () => {
+    expect(resolver).toBeDefined();
+  });
+});

server/src/core/view/resolvers/view-field.resolver.ts

@@ -0,0 +1,68 @@
+import { UseGuards } from '@nestjs/common';
+import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
+
+import { accessibleBy } from '@casl/prisma';
+import { Prisma } from '@prisma/client';
+
+import { AppAbility } from 'src/ability/ability.factory';
+import {
+  ReadViewFieldAbilityHandler,
+  UpdateViewFieldAbilityHandler,
+} from 'src/ability/handlers/view-field.ability-handler';
+import { FindManyViewFieldArgs } from 'src/core/@generated/view-field/find-many-view-field.args';
+import { UpdateOneViewFieldArgs } from 'src/core/@generated/view-field/update-one-view-field.args';
+import { ViewField } from 'src/core/@generated/view-field/view-field.model';
+import { ViewFieldService } from 'src/core/view/services/view-field.service';
+import { CheckAbilities } from 'src/decorators/check-abilities.decorator';
+import {
+  PrismaSelect,
+  PrismaSelector,
+} from 'src/decorators/prisma-select.decorator';
+import { UserAbility } from 'src/decorators/user-ability.decorator';
+import { AbilityGuard } from 'src/guards/ability.guard';
+import { JwtAuthGuard } from 'src/guards/jwt.auth.guard';
+
+@UseGuards(JwtAuthGuard)
+@Resolver(() => ViewField)
+export class ViewFieldResolver {
+  constructor(private readonly viewFieldService: ViewFieldService) {}
+
+  @Query(() => [ViewField])
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(ReadViewFieldAbilityHandler)
+  async findManyViewField(
+    @Args() args: FindManyViewFieldArgs,
+    @UserAbility() ability: AppAbility,
+    @PrismaSelector({ modelName: 'ViewField' })
+    prismaSelect: PrismaSelect<'ViewField'>,
+  ): Promise<Partial<ViewField>[]> {
+    return this.viewFieldService.findMany({
+      where: args.where
+        ? {
+            AND: [args.where, accessibleBy(ability).ViewField],
+          }
+        : accessibleBy(ability).ViewField,
+      orderBy: args.orderBy,
+      cursor: args.cursor,
+      take: args.take,
+      skip: args.skip,
+      distinct: args.distinct,
+      select: prismaSelect.value,
+    });
+  }
+
+  @Mutation(() => ViewField)
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(UpdateViewFieldAbilityHandler)
+  async updateOneViewField(
+    @Args() args: UpdateOneViewFieldArgs,
+    @PrismaSelector({ modelName: 'ViewField' })
+    prismaSelect: PrismaSelect<'ViewField'>,
+  ) {
+    return this.viewFieldService.update({
+      where: args.where,
+      data: args.data,
+      select: prismaSelect.value,
+    } as Prisma.ViewFieldUpdateArgs);
+  }
+}

server/src/core/view/services/view-field.service.spec.ts

@@ -0,0 +1,28 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { PrismaService } from 'src/database/prisma.service';
+import { prismaMock } from 'src/database/client-mock/jest-prisma-singleton';
+
+import { ViewFieldService } from './view-field.service';
+
+describe('ViewFieldService', () => {
+  let service: ViewFieldService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        ViewFieldService,
+        {
+          provide: PrismaService,
+          useValue: prismaMock,
+        },
+      ],
+    }).compile();
+
+    service = module.get<ViewFieldService>(ViewFieldService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

server/src/core/view/services/view-field.service.ts

@@ -0,0 +1,39 @@
+import { Injectable } from '@nestjs/common';
+
+import { PrismaService } from 'src/database/prisma.service';
+
+@Injectable()
+export class ViewFieldService {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  // Find
+  findFirst = this.prismaService.client.viewField.findFirst;
+  findFirstOrThrow = this.prismaService.client.viewField.findFirstOrThrow;
+
+  findUnique = this.prismaService.client.viewField.findUnique;
+  findUniqueOrThrow = this.prismaService.client.viewField.findUniqueOrThrow;
+
+  findMany = this.prismaService.client.viewField.findMany;
+
+  // Create
+  create = this.prismaService.client.viewField.create;
+  createMany = this.prismaService.client.viewField.createMany;
+
+  // Update
+  update = this.prismaService.client.viewField.update;
+  upsert = this.prismaService.client.viewField.upsert;
+  updateMany = this.prismaService.client.viewField.updateMany;
+
+  // Delete
+  delete = this.prismaService.client.viewField.delete;
+  deleteMany = this.prismaService.client.viewField.deleteMany;
+
+  // Aggregate
+  aggregate = this.prismaService.client.viewField.aggregate;
+
+  // Count
+  count = this.prismaService.client.viewField.count;
+
+  // GroupBy
+  groupBy = this.prismaService.client.viewField.groupBy;
+}

server/src/core/view/view.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+
+import { ViewFieldService } from './services/view-field.service';
+import { ViewFieldResolver } from './resolvers/view-field.resolver';
+
+@Module({
+  providers: [ViewFieldService, ViewFieldResolver],
+})
+export class ViewModule {}

server/src/database/migrations/20230727124244_add_view_fields_table/migration.sql

@@ -0,0 +1,15 @@
+-- CreateTable
+CREATE TABLE "viewFields" (
+    "id" TEXT NOT NULL,
+    "fieldName" TEXT NOT NULL,
+    "index" INTEGER NOT NULL,
+    "isVisible" BOOLEAN NOT NULL,
+    "objectName" TEXT NOT NULL,
+    "sizeInPx" INTEGER NOT NULL,
+    "workspaceId" TEXT NOT NULL,
+
+    CONSTRAINT "viewFields_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "viewFields" ADD CONSTRAINT "viewFields_workspaceId_fkey" FOREIGN KEY ("workspaceId") REFERENCES "workspaces"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

server/src/database/schema.prisma

@@ -169,6 +169,7 @@ model Workspace {
   pipelines          Pipeline[]
   pipelineStages     PipelineStage[]
   pipelineProgresses PipelineProgress[]
+  viewFields         ViewField[]
 
   /// @TypeGraphQL.omit(input: true, output: true)
   deletedAt DateTime?
@@ -532,3 +533,22 @@ model Attachment {
 
   @@map("attachments")
 }
+
+model ViewField {
+  /// @Validator.IsString()
+  /// @Validator.IsOptional()
+  id String @id @default(uuid())
+
+  fieldName  String
+  index      Int
+  isVisible  Boolean
+  objectName String
+  sizeInPx   Int
+
+  /// @TypeGraphQL.omit(input: true, output: true)
+  workspace   Workspace @relation(fields: [workspaceId], references: [id])
+  /// @TypeGraphQL.omit(input: true, output: true)
+  workspaceId String
+
+  @@map("viewFields")
+}

server/src/utils/prisma-select/model-select-map.ts

@@ -16,4 +16,5 @@ export type ModelSelectMap = {
   PipelineStage: Prisma.PipelineStageSelect;
   PipelineProgress: Prisma.PipelineProgressSelect;
   Attachment: Prisma.AttachmentSelect;
+  ViewField: Prisma.ViewFieldSelect;
 };