Merge pull request #3313 from SeedCompany/notifications

Author: CarsonF

dbschema/migrations/00008-m146fzf.edgeql

@@ -0,0 +1,34 @@
+module default {
+  abstract type Notification extending Mixin::Audited {
+    readAt := .currentRecipient.readAt; 
+    unread := not exists .currentRecipient.readAt;
+    single currentRecipient := assert_single((
+      select .recipients filter .user = global currentUser
+    ));
+    recipients := .<notification[is Notification::Recipient];
+  }
+}
+
+module Notification {
+  type Recipient {
+    required notification: default::Notification {
+      on target delete delete source;
+    };
+    required user: default::User {
+      on target delete delete source;
+    };
+
+    readAt: datetime;
+  }
+
+  type System extending default::Notification {
+    required message: str;
+  }
+  abstract type Comment extending default::Notification {
+    required comment: Comments::Comment {
+      on target delete delete source;
+    };
+  }
+  type CommentViaMention extending Comment;
+  type CommentViaMembership extending Comment;
+}

dbschema/notifications.esdl

@@ -18,6 +18,7 @@ import { FilmModule } from './components/film/film.module';
 import { FundingAccountModule } from './components/funding-account/funding-account.module';
 import { LanguageModule } from './components/language/language.module';
 import { LocationModule } from './components/location/location.module';
+import { SystemNotificationModule } from './components/notification-system/system-notification.module';
 import { NotificationModule } from './components/notifications/notification.module';
 import { OrganizationModule } from './components/organization/organization.module';
 import { PartnerModule } from './components/partner/partner.module';
@@ -91,6 +92,7 @@ if (process.env.NODE_ENV !== 'production') {
     PromptsModule,
     PnpExtractionResultModule,
     NotificationModule,
+    SystemNotificationModule,
   ],
 })
 export class AppModule {}

src/app.module.ts

@@ -1,11 +1,9 @@
 import { CustomScalar, Scalar } from '@nestjs/graphql';
 import { GraphQLError, Kind, ValueNode } from 'graphql';
 
-@Scalar('InlineMarkdown')
-export class InlineMarkdownScalar
-  implements CustomScalar<string, string | null>
-{
-  description = 'A string that holds inline Markdown formatted text';
+@Scalar('Markdown')
+export class MarkdownScalar implements CustomScalar<string, string | null> {
+  description = 'A string that holds Markdown formatted text';
 
   parseLiteral(ast: ValueNode): string | null {
     if (ast.kind !== Kind.STRING) {
@@ -22,3 +20,8 @@ export class InlineMarkdownScalar
     return value;
   }
 }
+
+@Scalar('InlineMarkdown')
+export class InlineMarkdownScalar extends MarkdownScalar {
+  description = 'A string that holds inline Markdown formatted text';
+}

src/common/markdown.scalar.ts

@@ -3,7 +3,7 @@ import { CustomScalar } from '@nestjs/graphql';
 import { GraphQLScalarType } from 'graphql';
 import UploadScalar from 'graphql-upload/GraphQLUpload.mjs';
 import { DateScalar, DateTimeScalar } from './luxon.graphql';
-import { InlineMarkdownScalar } from './markdown.scalar';
+import { InlineMarkdownScalar, MarkdownScalar } from './markdown.scalar';
 import { RichTextScalar } from './rich-text.scalar';
 import { UrlScalar } from './url.field';
 
@@ -16,5 +16,6 @@ export const getRegisteredScalars = (): Scalar[] => [
   RichTextScalar,
   UploadScalar,
   UrlScalar,
+  MarkdownScalar,
   InlineMarkdownScalar,
 ];

src/common/scalars.ts

@@ -10,11 +10,13 @@ import { CommentResolver } from './comment.resolver';
 import { CommentService } from './comment.service';
 import { CommentableResolver } from './commentable.resolver';
 import { CreateCommentResolver } from './create-comment.resolver';
+import { CommentViaMentionNotificationModule } from './mention-notification/comment-via-mention-notification.module';
 
 @Module({
   imports: [
     forwardRef(() => UserModule),
     forwardRef(() => AuthorizationModule),
+    CommentViaMentionNotificationModule,
   ],
   providers: [
     CreateCommentResolver,

src/components/comments/comment.module.ts

@@ -1,4 +1,5 @@
 import { Injectable } from '@nestjs/common';
+import { difference } from 'lodash';
 import {
   ID,
   InvalidIdForTypeException,
@@ -26,6 +27,7 @@ import {
   CreateCommentInput,
   UpdateCommentInput,
 } from './dto';
+import { CommentViaMentionNotificationService } from './mention-notification/comment-via-mention-notification.service';
 
 type CommentableRef = ID | BaseNode | Commentable;
 
@@ -36,6 +38,7 @@ export class CommentService {
     private readonly privileges: Privileges,
     private readonly resources: ResourceLoader,
     private readonly resourcesHost: ResourcesHost,
+    private readonly mentionNotificationService: CommentViaMentionNotificationService,
   ) {}
 
   async create(input: CreateCommentInput, session: Session) {
@@ -45,12 +48,13 @@ export class CommentService {
     );
     perms.verifyCan('create');
 
+    let dto;
     try {
       const result = await this.repo.create(input, session);
       if (!result) {
         throw new ServerException('Failed to create comment');
       }
-      return await this.readOne(result.id, session);
+      dto = await this.repo.readOne(result.id);
     } catch (exception) {
       if (
         input.threadId &&
@@ -64,6 +68,11 @@ export class CommentService {
 
       throw new ServerException('Failed to create comment', exception);
     }
+
+    const mentionees = this.mentionNotificationService.extract(dto);
+    await this.mentionNotificationService.notify(mentionees, dto);
+
+    return this.secureComment(dto, session);
   }
 
   async getPermissionsFromResource(resource: CommentableRef, session: Session) {
@@ -134,7 +143,14 @@ export class CommentService {
     this.privileges.for(session, Comment, object).verifyChanges(changes);
     await this.repo.update(object, changes);
 
-    return await this.readOne(input.id, session);
+    const updated = await this.repo.readOne(object.id);
+
+    const prevMentionees = this.mentionNotificationService.extract(object);
+    const nowMentionees = this.mentionNotificationService.extract(updated);
+    const newMentionees = difference(prevMentionees, nowMentionees);
+    await this.mentionNotificationService.notify(newMentionees, updated);
+
+    return this.secureComment(updated, session);
   }
 
   async delete(id: ID, session: Session): Promise<void> {

src/components/comments/comment.service.ts

@@ -0,0 +1,27 @@
+import { ObjectType } from '@nestjs/graphql';
+import { keys as keysOf } from 'ts-transformer-keys';
+import { SecuredProps } from '~/common';
+import { e } from '~/core/edgedb';
+import { LinkTo, RegisterResource } from '~/core/resources';
+import { Notification } from '../../notifications';
+
+@RegisterResource({ db: e.Notification.CommentViaMention })
+@ObjectType({
+  implements: [Notification],
+})
+export class CommentViaMentionNotification extends Notification {
+  static readonly Props = keysOf<CommentViaMentionNotification>();
+  static readonly SecuredProps =
+    keysOf<SecuredProps<CommentViaMentionNotification>>();
+
+  readonly comment: LinkTo<'Comment'>;
+}
+
+declare module '~/core/resources/map' {
+  interface ResourceMap {
+    CommentMentionedNotification: typeof CommentViaMentionNotification;
+  }
+  interface ResourceDBMap {
+    CommentMentionedNotification: typeof e.Notification.CommentViaMention;
+  }
+}

src/components/comments/mention-notification/comment-via-mention-notification.dto.ts

@@ -0,0 +1,16 @@
+import { Module } from '@nestjs/common';
+import { NotificationModule } from '../../notifications';
+import { CommentViaMentionNotificationResolver } from './comment-via-mention-notification.resolver';
+import { CommentViaMentionNotificationService } from './comment-via-mention-notification.service';
+import { CommentViaMentionNotificationStrategy } from './comment-via-mention-notification.strategy';
+
+@Module({
+  imports: [NotificationModule],
+  providers: [
+    CommentViaMentionNotificationResolver,
+    CommentViaMentionNotificationStrategy,
+    CommentViaMentionNotificationService,
+  ],
+  exports: [CommentViaMentionNotificationService],
+})
+export class CommentViaMentionNotificationModule {}

src/components/comments/mention-notification/comment-via-mention-notification.module.ts

@@ -0,0 +1,16 @@
+import { Parent, ResolveField, Resolver } from '@nestjs/graphql';
+import { Loader, LoaderOf } from '~/core';
+import { CommentLoader } from '../comment.loader';
+import { Comment } from '../dto';
+import { CommentViaMentionNotification as Notification } from './comment-via-mention-notification.dto';
+
+@Resolver(Notification)
+export class CommentViaMentionNotificationResolver {
+  @ResolveField(() => Comment)
+  async comment(
+    @Parent() { comment }: Notification,
+    @Loader(CommentLoader) comments: LoaderOf<CommentLoader>,
+  ) {
+    return await comments.load(comment.id);
+  }
+}