platform/services/analytics-collector/pod-analytics-collector/src/supportWsClient.ts

//
// Copyright © 2024 Hardcore Engineering Inc.
//
// Licensed under the Eclipse Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may
// obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//

import core, {
  generateId,
  getWorkspaceId,
  RateLimiter,
  Ref,
  systemAccountEmail,
  toWorkspaceString,
  TxOperations,
  WorkspaceId,
  Tx,
  Doc,
  TxUpdateDoc,
  TxProcessor
} from '@hcengineering/core'
import chunter, { Channel, ChatMessage } from '@hcengineering/chunter'
import contact, { Person } from '@hcengineering/contact'
import {
  createGeneralOnboardingChannel,
  getOrCreateOnboardingChannel
} from '@hcengineering/server-analytics-collector-resources'
import analyticsCollector, { AnalyticEvent, OnboardingChannel } from '@hcengineering/analytics-collector'
import { generateToken } from '@hcengineering/server-token'

import { eventToMarkup, getOnboardingMessage } from './format'
import { WorkspaceClient } from './workspaceClient'
import { getWorkspaceInfo } from './account'
import { Action, MessageActions, OnboardingMessage } from './types'
import { WorkspaceInfo } from '@hcengineering/account'
import { Collection } from 'mongodb'

export class SupportWsClient extends WorkspaceClient {
  channelIdByKey = new Map<string, Ref<OnboardingChannel>>()

  rate = new RateLimiter(1)

  generalChannel: Channel | undefined = undefined

  async initClient (): Promise<TxOperations> {
    const client = await super.initClient()

    this.generalChannel = await createGeneralOnboardingChannel(this.ctx, client)
    if (this.client != null) {
      this.client.notify = (...txes) => {
        this.handleTx(client, ...txes)
      }
    }

    return client
  }

  private handleTx (client: TxOperations, ...txes: Tx[]): void {
    for (const tx of txes) {
      const etx = TxProcessor.extractTx(tx)
      switch (etx._class) {
        case core.class.TxUpdateDoc: {
          this.txUpdateDoc(client, tx as TxUpdateDoc<Doc>)
          break
        }
      }
    }
  }

  private txUpdateDoc (client: TxOperations, tx: TxUpdateDoc<Doc>): void {
    const hierarchy = client.getHierarchy()

    if (
      hierarchy.isDerived(tx.objectClass, chunter.class.Channel) &&
      tx.objectId === analyticsCollector.space.GeneralOnboardingChannel
    ) {
      if (this.generalChannel == null) {
        return
      }
      this.generalChannel = TxProcessor.updateDoc2Doc(this.generalChannel, tx as TxUpdateDoc<Channel>)
    }
  }

  private async getOrCreateOnboardingChannel (
    client: TxOperations,
    workspace: string,
    email: string,
    person: Person
  ): Promise<{
      channelId: Ref<OnboardingChannel> | undefined
      isCreated: boolean
      workspace?: WorkspaceInfo
    }> {
    const key = `${email}-${workspace}`

    if (this.channelIdByKey.has(key)) {
      return {
        channelId: this.channelIdByKey.get(key),
        isCreated: false
      }
    }

    const info = await getWorkspaceInfo(generateToken(systemAccountEmail, getWorkspaceId(workspace)))

    if (info === undefined) {
      this.ctx.error('Failed to get workspace info', { workspace })
      return {
        channelId: undefined,
        isCreated: false
      }
    }

    const [channel, isCreated] = await getOrCreateOnboardingChannel(
      this.ctx,
      client,
      email,
      {
        workspaceId: workspace,
        workspaceName: info?.workspaceName ?? '',
        workspaceUrl: info?.workspaceUrl ?? ''
      },
      person
    )

    if (channel !== undefined) {
      this.channelIdByKey.set(key, channel)
    }

    return {
      channelId: channel,
      isCreated,
      workspace: info
    }
  }

  async handleAcceptAction (
    action: Action,
    email: string,
    onboardingMessages: Collection<OnboardingMessage>
  ): Promise<void> {
    if (action.channelId !== analyticsCollector.space.GeneralOnboardingChannel) {
      return
    }
    const client = await this.opClient
    const account = await client.getModel().findOne(contact.class.PersonAccount, { email })

    if (account === undefined) {
      return
    }

    if (this.generalChannel === undefined) {
      return
    }

    if (!this.generalChannel.members.includes(account._id)) {
      return
    }

    const message = (await onboardingMessages.findOne({ messageId: action.messageId })) ?? undefined

    if (message === undefined) {
      return
    }

    await client.updateDoc(analyticsCollector.class.OnboardingChannel, core.space.Space, message.channelId, {
      $push: { members: account._id }
    })

    await onboardingMessages.deleteOne({ messageId: action.messageId })
    await client.removeCollection(
      chunter.class.InlineButton,
      analyticsCollector.space.GeneralOnboardingChannel,
      action._id,
      action.messageId,
      chunter.class.ChatMessage,
      'inlineButtons'
    )
  }

  async processAction (action: Action, email: string, onboardingMessages: Collection<OnboardingMessage>): Promise<void> {
    switch (action.name) {
      case MessageActions.Accept:
        await this.handleAcceptAction(action, email, onboardingMessages)
        break
      default:
    }
  }

  async processEvents (
    events: AnalyticEvent[],
    email: string,
    workspace: WorkspaceId,
    person: Person,
    onboardingMessages: Collection<OnboardingMessage>
  ): Promise<void> {
    const client = await this.opClient
    const op = client.apply(generateId(), 'processEvents')
    const wsString = toWorkspaceString(workspace)
    const {
      channelId,
      isCreated,
      workspace: workspaceInfo
    } = await this.getOrCreateOnboardingChannel(op, wsString, email, person)

    if (channelId === undefined) {
      return
    }

    if (isCreated) {
      const messageId = generateId<ChatMessage>()
      await op.addCollection(
        chunter.class.ChatMessage,
        analyticsCollector.space.GeneralOnboardingChannel,
        analyticsCollector.space.GeneralOnboardingChannel,
        chunter.class.Channel,
        'messages',
        { message: getOnboardingMessage(email, workspaceInfo?.workspaceUrl ?? wsString, person.name) },
        messageId
      )

      await op.addCollection(
        chunter.class.InlineButton,
        analyticsCollector.space.GeneralOnboardingChannel,
        messageId,
        chunter.class.ChatMessage,
        'inlineButtons',
        {
          name: MessageActions.Accept,
          title: 'Accept',
          action: analyticsCollector.function.AnalyticsCollectorInlineAction
        }
      )

      await onboardingMessages.insertOne({ messageId, channelId })
    }

    const hierarchy = client.getHierarchy()

    for (const event of events) {
      const markup = await eventToMarkup(event, hierarchy)

      if (markup === undefined) {
        continue
      }

      await op.addCollection(
        chunter.class.ChatMessage,
        channelId,
        channelId,
        chunter.class.Channel,
        'messages',
        { message: markup },
        undefined,
        event.timestamp
      )
    }

    await op.commit()
  }

  async pushEvents (
    events: AnalyticEvent[],
    email: string,
    workspace: WorkspaceId,
    person: Person,
    onboardingMessages: Collection<OnboardingMessage>
  ): Promise<void> {
    const wsString = toWorkspaceString(workspace)
    const channelKey = `${email}-${wsString}`

    if (this.channelIdByKey.has(channelKey)) {
      await this.processEvents(events, email, workspace, person, onboardingMessages)
    } else {
      // If we dont have OnboardingChannel we should call it sync to prevent multiple channels for the same user and workspace
      await this.rate.add(async () => {
        await this.processEvents(events, email, workspace, person, onboardingMessages)
      })
    }
  }
}