feat: expose comms message size by scene id and type (#6018)

expose comms message size by scene id and type

Author: hugoArregui

browser-interface/packages/shared/comms/adapters/LivekitAdapter.ts

@@ -13,7 +13,6 @@ import {
 import mitt from 'mitt'
 import { trackEvent } from 'shared/analytics/trackEvent'
 import type { ILogger } from 'lib/logger'
-import { incrementCommsMessageSent } from 'shared/session/getPerformanceInfo'
 import type { VoiceHandler } from 'shared/voiceChat/VoiceHandler'
 import { commsLogger } from '../logger'
 import type { ActiveVideoStreams, CommsAdapterEvents, MinimumCommunicationsAdapter, SendHints } from './types'
@@ -94,7 +93,6 @@ export class LivekitAdapter implements MinimumCommunicationsAdapter {
       return
     }
 
-    incrementCommsMessageSent(data.length)
     const state = this.room.state
 
     if (data.length > MAXIMUM_NETWORK_MSG_LENGTH) {

browser-interface/packages/shared/comms/logic/rfc-4-room-connection.ts

@@ -3,6 +3,9 @@ import { CommsEvents, RoomConnection } from '../interface'
 import mitt from 'mitt'
 import { AdapterMessageEvent, MinimumCommunicationsAdapter } from '../adapters/types'
 import { VoiceHandler } from 'shared/voiceChat/VoiceHandler'
+import { incrementCommsMessageSent } from 'shared/session/getPerformanceInfo'
+import { getPositionSpawnPointAndScene } from 'shared/scene-loader/selectors'
+import { store } from 'shared/store/isolatedStore'
 
 /**
  * This class implements Rfc4 on top of a ICommsTransport. The idea behind it is
@@ -111,10 +114,16 @@ export class Rfc4RoomConnection implements RoomConnection {
   }
 
   private async sendMessage(reliable: boolean, topicMessage: proto.Packet) {
-    if (Object.keys(topicMessage).length === 0) {
+    if (Object.keys(topicMessage).length === 0 || !topicMessage.message?.$case) {
       throw new Error('Invalid message')
     }
+
+    const state = store.getState()
+    const sceneData = getPositionSpawnPointAndScene(state)
+
     const bytes = proto.Packet.encode(topicMessage as any).finish()
+    incrementCommsMessageSent(topicMessage.message?.$case, bytes.length, sceneData.sceneId)
+
     if (!this.transport) debugger
     this.transport.send(bytes, { reliable })
   }

browser-interface/packages/shared/session/getPerformanceInfo.ts

@@ -8,6 +8,7 @@ let kernelToRendererMessageCounter = 0
 let rendererToKernelMessageCounter = 0
 let receivedCommsMessagesCounter = 0
 let sentCommsMessagesCounter = 0
+let sentCommsMessages = {}
 let kernelToRendererMessageNativeCounter = 0
 let lastReport = 0
 let commsProtocol = ''
@@ -51,7 +52,14 @@ export function incrementAvatarSceneMessages(value: number) {
   commsPerfObservable.emit('avatar-renderer', { value })
 }
 
-export function incrementCommsMessageSent(_bytes: number) {
+export function incrementCommsMessageSent(type: string, size: number, sceneId?: string) {
+  if (!sceneId) {
+    sceneId = 'no-scene'
+  }
+  const key = `${sceneId}:${type}`
+
+  sentCommsMessages[key] = (sentCommsMessages[key] ?? 0) + size
+
   sentCommsMessagesCounter++
 }
 
@@ -173,6 +181,7 @@ export function getPerformanceInfo(data: {
     rendererToKernelMessageCounter,
     receivedCommsMessagesCounter,
     sentCommsMessagesCounter,
+    sentCommsMessages,
     kernelToRendererMessageNativeCounter,
 
     // reserved
@@ -225,6 +234,7 @@ export function getPerformanceInfo(data: {
   pingResponsePercentages.length = 0
 
   sentCommsMessagesCounter = 0
+  sentCommsMessages = {}
   receivedCommsMessagesCounter = 0
   kernelToRendererMessageCounter = 0
   rendererToKernelMessageCounter = 0