chore(server): getting rid of module-scoped eventBuses - batch #4 - c…

…omments (#3812)

packages/server/modules/cli/commands/download/commit.ts

@@ -46,7 +46,6 @@ import {
   markCommentUpdatedFactory,
   markCommentViewedFactory
 } from '@/modules/comments/repositories/comments'
-import { CommentsEmitter } from '@/modules/comments/events/emitter'
 import {
   addCommentCreatedActivityFactory,
   addReplyAddedActivityFactory
@@ -144,7 +143,7 @@ const command: CommandModule<
       insertComments,
       insertCommentLinks,
       markCommentViewed,
-      commentsEventsEmit: CommentsEmitter.emit,
+      emitEvent: getEventBus().emit,
       addCommentCreatedActivity: addCommentCreatedActivityFactory({
         getViewerResourcesFromLegacyIdentifiers,
         getViewerResourceItemsUngrouped,
@@ -159,7 +158,7 @@ const command: CommandModule<
       insertComments,
       insertCommentLinks,
       markCommentUpdated: markCommentUpdatedFactory({ db: projectDb }),
-      commentsEventsEmit: CommentsEmitter.emit,
+      emitEvent: getEventBus().emit,
       addReplyAddedActivity: addReplyAddedActivityFactory({
         getViewerResourcesForComment: getViewerResourcesForCommentFactory({
           getCommentsResources: getCommentsResourcesFactory({ db: projectDb }),

packages/server/modules/cli/commands/download/project.ts

@@ -27,7 +27,6 @@ import {
   createCommentThreadAndNotifyFactory
 } from '@/modules/comments/services/management'
 import { createBranchAndNotifyFactory } from '@/modules/core/services/branch/management'
-import { CommentsEmitter } from '@/modules/comments/events/emitter'
 import {
   addCommentCreatedActivityFactory,
   addReplyAddedActivityFactory
@@ -170,7 +169,7 @@ const command: CommandModule<
       insertComments,
       insertCommentLinks,
       markCommentViewed,
-      commentsEventsEmit: CommentsEmitter.emit,
+      emitEvent: getEventBus().emit,
       addCommentCreatedActivity: addCommentCreatedActivityFactory({
         getViewerResourcesFromLegacyIdentifiers,
         getViewerResourceItemsUngrouped,
@@ -184,7 +183,7 @@ const command: CommandModule<
       insertComments,
       insertCommentLinks,
       markCommentUpdated: markCommentUpdatedFactory({ db: projectDb }),
-      commentsEventsEmit: CommentsEmitter.emit,
+      emitEvent: getEventBus().emit,
       addReplyAddedActivity: addReplyAddedActivityFactory({
         getViewerResourcesForComment: getViewerResourcesForCommentFactory({
           getCommentsResources: getCommentsResourcesFactory({ db: projectDb }),

packages/server/modules/comments/domain/events.ts

@@ -0,0 +1,16 @@
+import { CommentRecord } from '@/modules/comments/helpers/types'
+
+export const commentEventsNamespace = 'comments' as const
+
+export const CommentEvents = {
+  Created: `${commentEventsNamespace}.created`,
+  Updated: `${commentEventsNamespace}.updated`
+} as const
+
+export type CommentEventsPayloads = {
+  [CommentEvents.Created]: { comment: CommentRecord }
+  [CommentEvents.Updated]: {
+    previousComment: CommentRecord
+    newComment: CommentRecord
+  }
+}

packages/server/modules/comments/graph/resolvers/comments.ts

@@ -81,7 +81,6 @@ import { Resolvers, ResourceType } from '@/modules/core/graph/generated/graphql'
 import { GraphQLContext } from '@/modules/shared/helpers/typeHelper'
 import { CommentRecord } from '@/modules/comments/helpers/types'
 import { db, mainDb } from '@/db/knex'
-import { CommentsEmitter } from '@/modules/comments/events/emitter'
 import { getBlobsFactory } from '@/modules/blobstorage/repositories'
 import { ResourceIdentifier } from '@/modules/comments/domain/types'
 import {
@@ -99,6 +98,7 @@ import { getStreamFactory } from '@/modules/core/repositories/streams'
 import { saveActivityFactory } from '@/modules/activitystream/repositories'
 import { getProjectDbClient } from '@/modules/multiregion/utils/dbSelector'
 import { Knex } from 'knex'
+import { getEventBus } from '@/modules/shared/services/eventBus'
 
 // We can use the main DB for these
 const getStream = getStreamFactory({ db })
@@ -549,7 +549,7 @@ export = {
         insertComments,
         insertCommentLinks,
         markCommentViewed,
-        commentsEventsEmit: CommentsEmitter.emit,
+        emitEvent: getEventBus().emit,
         addCommentCreatedActivity: addCommentCreatedActivityFactory({
           getViewerResourcesFromLegacyIdentifiers,
           getViewerResourceItemsUngrouped,
@@ -587,7 +587,7 @@ export = {
         insertComments,
         insertCommentLinks,
         markCommentUpdated: markCommentUpdatedFactory({ db: projectDb }),
-        commentsEventsEmit: CommentsEmitter.emit,
+        emitEvent: getEventBus().emit,
         addReplyAddedActivity: addReplyAddedActivityFactory({
           getViewerResourcesForComment: getViewerResourcesForCommentFactory({
             getCommentsResources: getCommentsResourcesFactory({ db: projectDb }),
@@ -624,7 +624,7 @@ export = {
         getComment,
         validateInputAttachments,
         updateComment,
-        commentsEventsEmit: CommentsEmitter.emit
+        emitEvent: getEventBus().emit
       })
 
       return await editCommentAndNotify(args.input, ctx.userId!)
@@ -752,7 +752,7 @@ export = {
         insertCommentLinks: insertCommentLinksFactory({ db: projectDb }),
         deleteComment: deleteCommentFactory({ db: projectDb }),
         markCommentViewed: markCommentViewedFactory({ db: projectDb }),
-        commentsEventsEmit: CommentsEmitter.emit
+        emitEvent: getEventBus().emit
       })
       const comment = await createComment({
         userId: context.userId,
@@ -796,7 +796,7 @@ export = {
           getBlobs: getBlobsFactory({ db: projectDb })
         }),
         updateComment: updateCommentFactory({ db: projectDb }),
-        commentsEventsEmit: CommentsEmitter.emit
+        emitEvent: getEventBus().emit
       })
 
       await editComment({ userId: context.userId!, input: args.input, matchUser })
@@ -878,7 +878,7 @@ export = {
         }),
         deleteComment: deleteCommentFactory({ db: projectDb }),
         markCommentUpdated: markCommentUpdatedFactory({ db: projectDb }),
-        commentsEventsEmit: CommentsEmitter.emit
+        emitEvent: getEventBus().emit
       })
       const reply = await createCommentReply({
         authorId: context.userId,

packages/server/modules/comments/index.ts

@@ -2,10 +2,10 @@ import { db } from '@/db/knex'
 import { moduleLogger } from '@/logging/logging'
 import { saveActivityFactory } from '@/modules/activitystream/repositories'
 import { addStreamCommentMentionActivityFactory } from '@/modules/activitystream/services/streamActivity'
-import { CommentsEmitter } from '@/modules/comments/events/emitter'
 import { notifyUsersOnCommentEventsFactory } from '@/modules/comments/services/notifications'
 import { publishNotification } from '@/modules/notifications/services/publication'
 import { Optional, SpeckleModule } from '@/modules/shared/helpers/typeHelper'
+import { getEventBus } from '@/modules/shared/services/eventBus'
 
 let unsubFromEvents: Optional<() => void> = undefined
 
@@ -15,7 +15,7 @@ const commentsModule: SpeckleModule = {
 
     if (isInitial) {
       const notifyUsersOnCommentEvents = notifyUsersOnCommentEventsFactory({
-        commentsEventsListen: CommentsEmitter.listen,
+        eventBus: getEventBus(),
         publish: publishNotification,
         addStreamCommentMentionActivity: addStreamCommentMentionActivityFactory({
           saveActivity: saveActivityFactory({ db })

packages/server/modules/comments/services/commentTextService.ts

@@ -5,13 +5,15 @@ import {
   convertBasicStringToDocument,
   isSerializedTextEditorValueSchema,
   SmartTextEditorValueSchema,
-  isDocEmpty
+  isDocEmpty,
+  documentToBasicString
 } from '@/modules/core/services/richTextEditorService'
 import { isString, uniq } from 'lodash'
 import { InvalidAttachmentsError } from '@/modules/comments/errors'
 import { JSONContent } from '@tiptap/core'
 import { ValidateInputAttachments } from '@/modules/comments/domain/operations'
 import { GetBlobs } from '@/modules/blobstorage/domain/operations'
+import { Nullable } from '@speckle/shared'
 
 const COMMENT_SCHEMA_VERSION = '1.0.0'
 const COMMENT_SCHEMA_TYPE = 'stream_comment'
@@ -76,3 +78,11 @@ export function ensureCommentSchema(
 
   throw new RichTextParseError('Unexpected comment schema format')
 }
+
+export const commentTextToRawString = (
+  text: Nullable<SmartTextEditorValueSchema | string>
+) => {
+  if (!text) return null
+  const schema = ensureCommentSchema(text)
+  return documentToBasicString(schema.doc)
+}

packages/server/modules/comments/services/index.ts

@@ -1,13 +1,11 @@
 import crs from 'crypto-random-string'
 import { ForbiddenError } from '@/modules/shared/errors'
 import { buildCommentTextFromInput } from '@/modules/comments/services/commentTextService'
-import { CommentsEvents, CommentsEventsEmit } from '@/modules/comments/events/emitter'
 import { isNonNullable, Roles } from '@speckle/shared'
 import {
   ResourceIdentifier,
   CommentCreateInput,
-  CommentEditInput,
-  SmartTextEditorValue
+  CommentEditInput
 } from '@/modules/core/graph/generated/graphql'
 import { CommentLinkRecord, CommentRecord } from '@/modules/comments/helpers/types'
 import { SmartTextEditorValueSchema } from '@/modules/core/services/richTextEditorService'
@@ -25,6 +23,9 @@ import {
 } from '@/modules/comments/domain/operations'
 import { ResourceType } from '@/modules/comments/domain/types'
 import { GetStream } from '@/modules/core/domain/streams/operations'
+import { EventBusEmit } from '@/modules/shared/services/eventBus'
+import { CommentEvents } from '@/modules/comments/domain/events'
+import { JSONContent } from '@tiptap/core'
 
 export const streamResourceCheckFactory =
   (deps: {
@@ -54,7 +55,7 @@ export const createCommentFactory =
     insertCommentLinks: InsertCommentLinks
     deleteComment: DeleteComment
     markCommentViewed: MarkCommentViewed
-    commentsEventsEmit: CommentsEventsEmit
+    emitEvent: EventBusEmit
   }) =>
   async ({ userId, input }: { userId: string; input: CommentCreateInput }) => {
     if (input.resources.length < 1)
@@ -115,8 +116,11 @@ export const createCommentFactory =
 
     await deps.markCommentViewed(id, userId) // so we don't self mark a comment as unread the moment it's created
 
-    await deps.commentsEventsEmit(CommentsEvents.Created, {
-      comment: newComment
+    await deps.emitEvent({
+      eventName: CommentEvents.Created,
+      payload: {
+        comment: newComment
+      }
     })
 
     return newComment
@@ -133,7 +137,7 @@ export const createCommentReplyFactory =
     checkStreamResourcesAccess: CheckStreamResourcesAccess
     deleteComment: DeleteComment
     markCommentUpdated: MarkCommentUpdated
-    commentsEventsEmit: CommentsEventsEmit
+    emitEvent: EventBusEmit
   }) =>
   async ({
     authorId,
@@ -146,7 +150,7 @@ export const createCommentReplyFactory =
     authorId: string
     parentCommentId: string
     streamId: string
-    text: SmartTextEditorValue
+    text: JSONContent
     data: CommentRecord['data']
     blobIds: string[]
   }) => {
@@ -184,8 +188,11 @@ export const createCommentReplyFactory =
 
     await deps.markCommentUpdated(parentCommentId)
 
-    await deps.commentsEventsEmit(CommentsEvents.Created, {
-      comment: newComment
+    await deps.emitEvent({
+      eventName: CommentEvents.Created,
+      payload: {
+        comment: newComment
+      }
     })
 
     return newComment
@@ -199,7 +206,7 @@ export const editCommentFactory =
     getComment: GetComment
     validateInputAttachments: ValidateInputAttachments
     updateComment: UpdateComment
-    commentsEventsEmit: CommentsEventsEmit
+    emitEvent: EventBusEmit
   }) =>
   async ({
     userId,
@@ -223,9 +230,12 @@ export const editCommentFactory =
     })
     const updatedComment = await deps.updateComment(input.id, { text: newText })
 
-    await deps.commentsEventsEmit(CommentsEvents.Updated, {
-      previousComment: editedComment,
-      newComment: updatedComment!
+    await deps.emitEvent({
+      eventName: CommentEvents.Updated,
+      payload: {
+        previousComment: editedComment,
+        newComment: updatedComment!
+      }
     })
 
     return updatedComment