feat: persist view filters and sorts on Update View button click (#1290)

* feat: add viewFilters table

Closes #1121

* feat: add Update View button + Create View dropdown

Closes #1124, #1289

* feat: add View Filter resolvers

* feat: persist view filters and sorts on Update View button click

Closes #1123

* refactor: code review

- Rename recoil selectors
- Rename filters `field` property to `key`

server/src/ability/ability.factory.ts

@@ -3,47 +3,49 @@ import { Injectable } from '@nestjs/common';
 import { PureAbility, AbilityBuilder } from '@casl/ability';
 import { createPrismaAbility, PrismaQuery, Subjects } from '@casl/prisma';
 import {
-  Attachment,
   Activity,
-  Company,
+  ActivityTarget,
+  Attachment,
   Comment,
+  Company,
+  Favorite,
   Person,
+  Pipeline,
+  PipelineProgress,
+  PipelineStage,
   RefreshToken,
   User,
-  Workspace,
-  WorkspaceMember,
-  ActivityTarget,
-  Pipeline,
-  PipelineStage,
-  PipelineProgress,
   UserSettings,
   View,
   ViewField,
-  Favorite,
+  ViewFilter,
   ViewSort,
+  Workspace,
+  WorkspaceMember,
 } from '@prisma/client';
 
 import { AbilityAction } from './ability.action';
 
 type SubjectsAbility = Subjects<{
-  User: User;
-  Workspace: Workspace;
-  WorkspaceMember: WorkspaceMember;
-  Company: Company;
-  Person: Person;
-  RefreshToken: RefreshToken;
   Activity: Activity;
-  Comment: Comment;
   ActivityTarget: ActivityTarget;
-  Pipeline: Pipeline;
-  PipelineStage: PipelineStage;
-  PipelineProgress: PipelineProgress;
   Attachment: Attachment;
+  Comment: Comment;
+  Company: Company;
+  Favorite: Favorite;
+  Person: Person;
+  Pipeline: Pipeline;
+  PipelineProgress: PipelineProgress;
+  PipelineStage: PipelineStage;
+  RefreshToken: RefreshToken;
+  User: User;
   UserSettings: UserSettings;
   View: View;
   ViewField: ViewField;
-  Favorite: Favorite;
+  ViewFilter: ViewFilter;
   ViewSort: ViewSort;
+  Workspace: Workspace;
+  WorkspaceMember: WorkspaceMember;
 }>;
 
 export type AppAbility = PureAbility<
@@ -147,10 +149,11 @@ export class AbilityFactory {
     can(AbilityAction.Create, 'ViewField', { workspaceId: workspace.id });
     can(AbilityAction.Update, 'ViewField', { workspaceId: workspace.id });
 
-    //Favorite
-    can(AbilityAction.Read, 'Favorite', { workspaceId: workspace.id });
-    can(AbilityAction.Create, 'Favorite');
-    can(AbilityAction.Delete, 'Favorite', { workspaceId: workspace.id });
+    // ViewFilter
+    can(AbilityAction.Read, 'ViewFilter', { workspaceId: workspace.id });
+    can(AbilityAction.Create, 'ViewFilter', { workspaceId: workspace.id });
+    can(AbilityAction.Update, 'ViewFilter', { workspaceId: workspace.id });
+    can(AbilityAction.Delete, 'ViewFilter', { workspaceId: workspace.id });
 
     // ViewSort
     can(AbilityAction.Read, 'ViewSort', { workspaceId: workspace.id });
@@ -158,6 +161,11 @@ export class AbilityFactory {
     can(AbilityAction.Update, 'ViewSort', { workspaceId: workspace.id });
     can(AbilityAction.Delete, 'ViewSort', { workspaceId: workspace.id });
 
+    // Favorite
+    can(AbilityAction.Read, 'Favorite', { workspaceId: workspace.id });
+    can(AbilityAction.Create, 'Favorite');
+    can(AbilityAction.Delete, 'Favorite', { workspaceId: workspace.id });
+
     return build();
   }
 }

server/src/ability/ability.module.ts

@@ -116,6 +116,12 @@ import {
   UpdateViewAbilityHandler,
   DeleteViewAbilityHandler,
 } from './handlers/view.ability-handler';
+import {
+  CreateViewFilterAbilityHandler,
+  DeleteViewFilterAbilityHandler,
+  ReadViewFilterAbilityHandler,
+  UpdateViewFilterAbilityHandler,
+} from './handlers/view-filter.ability-handler';
 
 @Global()
 @Module({
@@ -213,6 +219,11 @@ import {
     ReadViewFieldAbilityHandler,
     CreateViewFieldAbilityHandler,
     UpdateViewFieldAbilityHandler,
+    // ViewFilter
+    ReadViewFilterAbilityHandler,
+    CreateViewFilterAbilityHandler,
+    UpdateViewFilterAbilityHandler,
+    DeleteViewFilterAbilityHandler,
     // ViewSort
     ReadViewSortAbilityHandler,
     CreateViewSortAbilityHandler,
@@ -312,6 +323,11 @@ import {
     ReadViewFieldAbilityHandler,
     CreateViewFieldAbilityHandler,
     UpdateViewFieldAbilityHandler,
+    // ViewFilter
+    ReadViewFilterAbilityHandler,
+    CreateViewFilterAbilityHandler,
+    UpdateViewFilterAbilityHandler,
+    DeleteViewFilterAbilityHandler,
     // ViewSort
     ReadViewSortAbilityHandler,
     CreateViewSortAbilityHandler,

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

@@ -0,0 +1,122 @@
+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 {
+  convertToWhereInput,
+  relationAbilityChecker,
+} from 'src/ability/ability.util';
+import { PrismaService } from 'src/database/prisma.service';
+import { assert } from 'src/utils/assert';
+import { ViewFilterWhereUniqueInput } from 'src/core/@generated/view-filter/view-filter-where-unique.input';
+import { ViewFilterWhereInput } from 'src/core/@generated/view-filter/view-filter-where.input';
+
+class ViewFilterArgs {
+  where?: ViewFilterWhereInput | ViewFilterWhereUniqueInput;
+  [key: string]: any;
+}
+
+const isViewFilterWhereUniqueInput = (
+  input: ViewFilterWhereInput | ViewFilterWhereUniqueInput,
+): input is ViewFilterWhereUniqueInput => 'viewId_key' in input;
+
+@Injectable()
+export class ReadViewFilterAbilityHandler implements IAbilityHandler {
+  handle(ability: AppAbility) {
+    return ability.can(AbilityAction.Read, 'ViewFilter');
+  }
+}
+
+@Injectable()
+export class CreateViewFilterAbilityHandler implements IAbilityHandler {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async handle(ability: AppAbility, context: ExecutionContext) {
+    const gqlContext = GqlExecutionContext.create(context);
+    const args = gqlContext.getArgs();
+
+    const allowed = await relationAbilityChecker(
+      'ViewFilter',
+      ability,
+      this.prismaService.client,
+      args,
+    );
+
+    if (!allowed) {
+      return false;
+    }
+
+    return ability.can(AbilityAction.Create, 'ViewFilter');
+  }
+}
+
+@Injectable()
+export class UpdateViewFilterAbilityHandler implements IAbilityHandler {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async handle(ability: AppAbility, context: ExecutionContext) {
+    const gqlContext = GqlExecutionContext.create(context);
+    const args = gqlContext.getArgs<ViewFilterArgs>();
+    const viewFilter = await this.prismaService.client.viewFilter.findFirst({
+      where:
+        args.where && isViewFilterWhereUniqueInput(args.where)
+          ? args.where.viewId_key
+          : args.where,
+    });
+    assert(viewFilter, '', NotFoundException);
+
+    const allowed = await relationAbilityChecker(
+      'ViewFilter',
+      ability,
+      this.prismaService.client,
+      args,
+    );
+
+    if (!allowed) {
+      return false;
+    }
+
+    return ability.can(AbilityAction.Update, subject('ViewFilter', viewFilter));
+  }
+}
+
+@Injectable()
+export class DeleteViewFilterAbilityHandler implements IAbilityHandler {
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async handle(ability: AppAbility, context: ExecutionContext) {
+    const gqlContext = GqlExecutionContext.create(context);
+    const args = gqlContext.getArgs<ViewFilterArgs>();
+    const where = convertToWhereInput(
+      args.where && isViewFilterWhereUniqueInput(args.where)
+        ? args.where.viewId_key
+        : args.where,
+    );
+    const viewFilters = await this.prismaService.client.viewFilter.findMany({
+      where,
+    });
+    assert(viewFilters.length, '', NotFoundException);
+
+    for (const viewFilter of viewFilters) {
+      const allowed = ability.can(
+        AbilityAction.Delete,
+        subject('ViewFilter', viewFilter),
+      );
+
+      if (!allowed) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+}

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

@@ -0,0 +1,102 @@
+import { UseGuards } from '@nestjs/common';
+import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
+
+import { accessibleBy } from '@casl/prisma';
+import { Prisma, Workspace } from '@prisma/client';
+
+import { AppAbility } from 'src/ability/ability.factory';
+import {
+  CreateViewFilterAbilityHandler,
+  DeleteViewFilterAbilityHandler,
+  ReadViewFilterAbilityHandler,
+  UpdateViewFilterAbilityHandler,
+} from 'src/ability/handlers/view-filter.ability-handler';
+import { FindManyViewFilterArgs } from 'src/core/@generated/view-filter/find-many-view-filter.args';
+import { ViewFilter } from 'src/core/@generated/view-filter/view-filter.model';
+import { ViewFilterService } from 'src/core/view/services/view-filter.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';
+import { UpdateOneViewFilterArgs } from 'src/core/@generated/view-filter/update-one-view-filter.args';
+import { AuthWorkspace } from 'src/decorators/auth-workspace.decorator';
+import { AffectedRows } from 'src/core/@generated/prisma/affected-rows.output';
+import { DeleteManyViewFilterArgs } from 'src/core/@generated/view-filter/delete-many-view-filter.args';
+import { CreateManyViewFilterArgs } from 'src/core/@generated/view-filter/create-many-view-filter.args';
+
+@UseGuards(JwtAuthGuard)
+@Resolver(() => ViewFilter)
+export class ViewFilterResolver {
+  constructor(private readonly viewFilterService: ViewFilterService) {}
+
+  @Mutation(() => AffectedRows)
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(CreateViewFilterAbilityHandler)
+  async createManyViewFilter(
+    @Args() args: CreateManyViewFilterArgs,
+    @AuthWorkspace() workspace: Workspace,
+  ): Promise<AffectedRows> {
+    return this.viewFilterService.createMany({
+      data: args.data.map((data) => ({
+        ...data,
+        workspaceId: workspace.id,
+      })),
+    });
+  }
+
+  @Query(() => [ViewFilter])
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(ReadViewFilterAbilityHandler)
+  async findManyViewFilter(
+    @Args() args: FindManyViewFilterArgs,
+    @UserAbility() ability: AppAbility,
+    @PrismaSelector({ modelName: 'ViewFilter' })
+    prismaSelect: PrismaSelect<'ViewFilter'>,
+  ): Promise<Partial<ViewFilter>[]> {
+    return this.viewFilterService.findMany({
+      where: args.where
+        ? {
+            AND: [args.where, accessibleBy(ability).ViewFilter],
+          }
+        : accessibleBy(ability).ViewFilter,
+      orderBy: args.orderBy,
+      cursor: args.cursor,
+      take: args.take,
+      skip: args.skip,
+      distinct: args.distinct,
+      select: prismaSelect.value,
+    });
+  }
+
+  @Mutation(() => ViewFilter)
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(UpdateViewFilterAbilityHandler)
+  async updateOneViewFilter(
+    @Args() args: UpdateOneViewFilterArgs,
+    @PrismaSelector({ modelName: 'ViewFilter' })
+    prismaSelect: PrismaSelect<'ViewFilter'>,
+  ): Promise<Partial<ViewFilter>> {
+    return this.viewFilterService.update({
+      data: args.data,
+      where: args.where,
+      select: prismaSelect.value,
+    } as Prisma.ViewFilterUpdateArgs);
+  }
+
+  @Mutation(() => AffectedRows, {
+    nullable: false,
+  })
+  @UseGuards(AbilityGuard)
+  @CheckAbilities(DeleteViewFilterAbilityHandler)
+  async deleteManyViewFilter(
+    @Args() args: DeleteManyViewFilterArgs,
+  ): Promise<AffectedRows> {
+    return this.viewFilterService.deleteMany({
+      where: args.where,
+    });
+  }
+}

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

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

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

@@ -6,14 +6,18 @@ import { ViewSortService } from './services/view-sort.service';
 import { ViewSortResolver } from './resolvers/view-sort.resolver';
 import { ViewService } from './services/view.service';
 import { ViewResolver } from './resolvers/view.resolver';
+import { ViewFilterService } from './services/view-filter.service';
+import { ViewFilterResolver } from './resolvers/view-filter.resolver';
 
 @Module({
   providers: [
     ViewService,
     ViewFieldService,
+    ViewFilterService,
     ViewSortService,
     ViewResolver,
     ViewFieldResolver,
+    ViewFilterResolver,
     ViewSortResolver,
   ],
 })

server/src/core/workspace/services/workspace.service.ts

@@ -112,8 +112,6 @@ export class WorkspaceService {
       activityTarget,
       activity,
       view,
-      viewField,
-      viewSort,
     } = this.prismaService.client;
 
     const activitys = await activity.findMany({
@@ -156,12 +154,6 @@ export class WorkspaceService {
       view.deleteMany({
         where,
       }),
-      viewField.deleteMany({
-        where,
-      }),
-      viewSort.deleteMany({
-        where,
-      }),
       refreshToken.deleteMany({
         where: { userId },
       }),

server/src/database/migrations/20230821142706_add_view_filters_table/migration.sql

@@ -0,0 +1,21 @@
+-- CreateEnum
+CREATE TYPE "ViewFilterOperand" AS ENUM ('Contains', 'DoesNotContain', 'GreaterThan', 'LessThan', 'Is', 'IsNot');
+
+-- CreateTable
+CREATE TABLE "viewFilters" (
+    "displayValue" TEXT NOT NULL,
+    "key" TEXT NOT NULL,
+    "name" TEXT NOT NULL,
+    "operand" "ViewFilterOperand" NOT NULL,
+    "value" TEXT NOT NULL,
+    "viewId" TEXT NOT NULL,
+    "workspaceId" TEXT NOT NULL,
+
+    CONSTRAINT "viewFilters_pkey" PRIMARY KEY ("viewId","key")
+);
+
+-- AddForeignKey
+ALTER TABLE "viewFilters" ADD CONSTRAINT "viewFilters_viewId_fkey" FOREIGN KEY ("viewId") REFERENCES "views"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "viewFilters" ADD CONSTRAINT "viewFilters_workspaceId_fkey" FOREIGN KEY ("workspaceId") REFERENCES "workspaces"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

server/src/database/schema.prisma

@@ -174,6 +174,7 @@ model Workspace {
   pipelineProgresses PipelineProgress[]
   activityTargets    ActivityTarget[]
   viewFields         ViewField[]
+  viewFilters        ViewFilter[]
   views              View[]
   viewSorts          ViewSort[]
 
@@ -582,6 +583,7 @@ model View {
   id String @id @default(uuid())
 
   fields   ViewField[]
+  filters  ViewFilter[]
   name     String
   objectId String
   sorts    ViewSort[]
@@ -596,6 +598,34 @@ model View {
   @@map("views")
 }
 
+enum ViewFilterOperand {
+  Contains
+  DoesNotContain
+  GreaterThan
+  LessThan
+  Is
+  IsNot
+}
+
+model ViewFilter {
+  displayValue String
+  key          String
+  name         String
+  operand      ViewFilterOperand
+  value        String
+
+  view   View   @relation(fields: [viewId], references: [id], onDelete: Cascade)
+  viewId String
+
+  /// @TypeGraphQL.omit(input: true, output: true)
+  workspace   Workspace @relation(fields: [workspaceId], references: [id])
+  /// @TypeGraphQL.omit(input: true, output: true)
+  workspaceId String
+
+  @@id([viewId, key])
+  @@map("viewFilters")
+}
+
 enum ViewSortDirection {
   asc
   desc

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

@@ -18,6 +18,7 @@ export type ModelSelectMap = {
   Attachment: Prisma.AttachmentSelect;
   Favorite: Prisma.FavoriteSelect;
   View: Prisma.ViewSelect;
+  ViewFilter: Prisma.ViewFilterSelect;
   ViewSort: Prisma.ViewSortSelect;
   ViewField: Prisma.ViewFieldSelect;
 };