@signalwire/core/src/memberPosition/workers.ts

Shared code for the SignalWire JS SDK

import { fork } from '@redux-saga/core/effects'
import {
  InternalMemberUpdatedEventNames,
  InternalVideoMemberEntity,
  MapToPubSubShape,
  sagaEffects,
  SagaIterator,
  SDKActions,
  SDKWorker,
  SDKWorkerParams,
  stripNamespacePrefix,
  VideoMemberJoinedEventParams,
  VideoMemberUpdatedEvent,
  VideoMemberUpdatedEventParams,
  VideoPosition,
  VideoRoomSubscribedEventParams,
} from '..'

/**
 * These workers are shared between the realtime-api and the browser SDKs (Video and CallFabric)
 * For the Realtime-API: we pass the dispatcher function since we emit RoomSessionMember instance
 * For the Video SDK: we use the default dispatcher function since we emit whatever we get from the server
 * For the CF SDK: we pass the dispatcher function to map "id" into "member_id".
 */

const defaultDispatcher = function* (
  type: string,
  payload: any,
  instance?: any
) {
  const event = stripNamespacePrefix(type)
  instance.emit(event, payload)
}

function* memberPositionLayoutChangedWorker(options: any) {
  const {
    action,
    memberList,
    instance,
    dispatcher = defaultDispatcher,
  } = options
  const layers = action.payload.layout.layers
  const processedMembers: Record<string, boolean> = {}

  layers.forEach((layer: any) => {
    const memberId = layer.member_id
    if (!memberId) {
      return
    }

    const memberEventParams = memberList.get(memberId)

    if (
      memberEventParams &&
      layer.position !== memberEventParams.member?.current_position
    ) {
      mutateMemberCurrentPosition({
        memberList,
        memberId,
        currentPosition: layer.position,
      })
      processedMembers[memberId] = true
    } else {
      // Values marked as false won't be put to `pubSubChannel`
      processedMembers[memberId] = false
    }
  })

  for (const [memberId, payload] of memberList) {
    if (processedMembers[memberId]) {
      yield dispatcher?.('video.member.updated', payload, instance)

      /**
       * `undefined` means that we couldn't find the
       * `memberId` inside the `layout.layers` array, which
       * implies that the user should now be off-canvas
       */
    } else if (processedMembers[memberId] === undefined) {
      const updatedMemberEventParams = mutateMemberCurrentPosition({
        memberList,
        memberId,
        currentPosition: 'off-canvas',
      })

      if (!updatedMemberEventParams) {
        return
      }

      yield dispatcher?.(
        'video.member.updated',
        updatedMemberEventParams,
        instance
      )
    }
  }
}

export function* memberUpdatedWorker({
  action,
  memberList,
  instance,
  dispatcher = defaultDispatcher,
}: Omit<SDKWorkerParams<any>, 'runSaga'> & {
  memberList: MemberEventParamsList
  action: MapToPubSubShape<VideoMemberUpdatedEvent>
}) {
  const memberId = action.payload.member.id
  const updatedMemberEventParams = mutateMemberCurrentPosition({
    memberList,
    memberId,
    currentPosition: memberList.get(memberId)?.member?.current_position,
  })

  if (!updatedMemberEventParams) {
    return
  }

  const {
    member: { updated = [] },
  } = action.payload

  const memberUpdatedPayload = {
    ...updatedMemberEventParams,
    member: {
      ...updatedMemberEventParams.member,
      ...action.payload.member,
    },
  }
  /** member.updated event is the only one updating the memberList payload */
  memberList.set(memberId, memberUpdatedPayload)

  for (const key of updated) {
    const type = `${action.type}.${key}` as InternalMemberUpdatedEventNames
    yield dispatcher?.(type, memberUpdatedPayload, instance)
  }

  yield dispatcher?.(action.type, memberUpdatedPayload, instance)
}

export const memberPositionWorker: SDKWorker<any> =
  function* memberPositionWorker({
    instance,
    channels,
    initialState,
    getSession,
    instanceMap,
    dispatcher = defaultDispatcher,
  }): SagaIterator {
    if (!initialState) {
      return
    }

    const { swEventChannel } = channels
    let memberList = initializeMemberList(initialState)

    const addToMemberList = (
      payload: VideoMemberJoinedEventParams | VideoMemberUpdatedEventParams
    ) => {
      /**
       * Add to memberList for both `member.joined` and `member.updated`
       * note: changes made for audience users.
       */
      if (!memberList.has(payload.member.id)) {
        memberList.set(payload.member.id, payload)
      }
    }

    while (true) {
      const action: SDKActions = yield sagaEffects.take(
        swEventChannel,
        (action: SDKActions) => {
          const istargetEvent =
            action.type === 'video.member.joined' ||
            action.type === 'video.member.updated' ||
            action.type === 'video.member.left' ||
            action.type === 'video.layout.changed'

          return istargetEvent
        }
      )

      switch (action.type) {
        case 'video.member.joined': {
          addToMemberList(action.payload)
          break
        }
        case 'video.member.updated': {
          addToMemberList(action.payload)
          yield fork(memberUpdatedWorker, {
            action,
            channels,
            memberList,
            instance,
            getSession,
            instanceMap,
            dispatcher,
          })
          break
        }
        case 'video.member.left': {
          const member = action.payload.member
          memberList.delete(member.id)
          break
        }
        case 'video.layout.changed': {
          yield fork(memberPositionLayoutChangedWorker, {
            action,
            channels,
            memberList,
            instance,
            dispatcher,
          })
          break
        }
      }
    }
  }

type MemberEventParamsList = Map<
  string,
  {
    room_id: string
    room_session_id: string
    member: InternalVideoMemberEntity
  }
>

/** Add the current_position param to the member object */
const mutateMemberCurrentPosition = ({
  memberList,
  memberId,
  currentPosition,
}: {
  memberList: MemberEventParamsList
  memberId: string
  currentPosition?: VideoPosition
}) => {
  const memberEventParams = memberList.get(memberId)

  if (!memberEventParams) {
    return

    // This is to avoid setting an undefined property
  } else if (!currentPosition) {
    return memberEventParams
  }

  const updatedMemberEventParams = {
    ...memberEventParams,
    member: {
      ...memberEventParams?.member,
      current_position: currentPosition,
    },
  }
  memberList.set(memberId, updatedMemberEventParams)

  return updatedMemberEventParams
}

const initializeMemberList = (payload: VideoRoomSubscribedEventParams) => {
  const members = payload.room_session.members
  const memberList: MemberEventParamsList = new Map()

  members.forEach((member) => {
    const memberId = member.id
    const roomSessionId =
      payload.room_session.id || payload.room_session.room_session_id
    memberList.set(memberId, {
      room_id: payload.room_session.room_id,
      room_session_id: roomSessionId,
      member,
    })
  })

  return memberList
}