Skip to content

core: rtcstats doesn't send recording and transcribing changes when they happen - #1200

Open
misi-whereby wants to merge 11 commits into
mainfrom
misi/cob-3449-rtcstats-doesnt-send-recording-and
Open

misi-whereby wants to merge 11 commits into
mainfrom
misi/cob-3449-rtcstats-doesnt-send-recording-and

Conversation

@misi-whereby

Copy link
Copy Markdown
Contributor

Description

Summary:
rtcstats doesn't send recording and transcribing changes when they happen

Related Issue:

Testing

Check rtcstats transcribing and recording events

Screenshots/GIFs (if applicable)

Checklist

  • My code follows the project's coding standards.
  • Prefixed the PR title and commit messages with the service or package name
  • I have written unit tests (if applicable).
  • I have updated the documentation (if applicable).
  • By submitting this pull request, I confirm that my contribution is made
    under the terms of the MIT license.

Additional Information

@changeset-bot

changeset-bot Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: d749fe2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@whereby.com/core Patch
@whereby.com/media Minor
@whereby.com/assistant-sdk Patch
@whereby.com/browser-sdk Patch
@whereby.com/react-native-sdk Patch
@whereby.com/audio-denoiser Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@misi-whereby
misi-whereby requested a review from a team November 11, 2026 19:02
@misi-whereby
misi-whereby force-pushed the misi/cob-3449-rtcstats-doesnt-send-recording-and branch 3 times, most recently from 57eeebe to d749fe2 Compare November 13, 2026 08:01
rtcstats connects with the page's path, and the server uses it as the room
name. The server also uses the Origin header for the subdomain, and both in
the stored file name. On a page that isn't the room's page, these are the
page's, and a page can't set the Origin header.

setRoomUrl() takes the room's origin and path: the connection then uses an
empty path, so the page's path isn't sent, and the room's origin and path
are sent in the roomUrl query parameter, for a server that reads it. It's
used from the next connection. Without it, the URL is the same as before.

After requireRoomUrl(), rtcstats doesn't connect while the room's URL isn't
set, so the page's origin and path are never sent.
rtcstats uses the page's path as the room name, and the page's origin for
the subdomain, and both in the stored file name. Core doesn't run on the
room's page, so it gives rtcstats the room's origin and path when the app
starts, and clears them when the app stops. The room URL's query isn't
passed on, as it can hold a room key.
No behaviour change. doRtcAnalyticsCustomEventsInitialize and the action
listener had their own copies of the compare, send and mark logic. Both
now use sendIfChanged, which the next commit also uses from reactors.
clientId, deviceId, externalId, organizationId, signalConnectionStatus,
rtcConnectionStatus and userRole were only sent by
doRtcAnalyticsCustomEventsInitialize, when the RtcManager is initialized.
Later changes, such as a signal disconnect or reconnect, weren't sent
unless another RtcManager was initialized. Each is now also sent when its
value changes.

Values are only sent once the RtcManager is initialized.
doRtcAnalyticsCustomEventsInitialize runs then and sends insightsStats
first, which rtcstats uses to set the session's timestamp. Checking only
that an RtcManager existed wasn't enough: rtcManagerCreated sets the
RtcManager and status "ready" in the same action, before the
initialization. Values that change before it are left unmarked, and the
initialization sends their current value.
Sent when the RtcManager is initialized and whenever the mode changes.
rtcstats reads the userRole event's value from its role property, both
for the stored session info and for insights. It was sent as userRole,
so the role was never recorded.
A value is sent when makeComparable(value), a JSON string for objects,
differs from the last reported value, but the raw value was stored as the
last reported one. For objects and null the two never match, so those
events were sent again on every action that triggers them, even when they
hadn't changed, for example recording on every newClient. Store the
comparable value instead.
The room slice now keeps room.sfuServer from roomJoined, null when the
room has none, with selectRoomSfuServer to read it. It's sent as the
sfuServer event when the RtcManager is initialized and when the server
changes. The rtcstats connection already re-sends the last sfuServer
event after it reconnects.
The screenshare stop had its own entry, localScreenshareStreamStopped, with
the same rtcEventName and a getValue that returned a new function every
time. It never matched the last reported value, so every initialization,
for example when joining a room, sent localScreenshareStream without
tracks: a stop when there was no screenshare at all, and a stop right after
the real tracks while screensharing. It also stored a function in the Redux
state.

localScreenshareStream is now also checked after stopScreenshare, so a stop
is still sent without tracks, and initialization only sends it while there
is a screenshare.
The listener for the rtcstats trigger actions only checked the first value
that listed the action. recording, transcribing and roomSessionId all list
newClient, so only recording was checked, and a transcribing change or a
new room session id that came with newClient wasn't sent.

Every value that lists the action is now checked.
… stop

recording and transcribing were only checked on newClient. A recording
starts when the recorder joins, so that start was sent, but its stop only
at the next join. The captioner joins before live transcription has
started, so a transcription start and stop were only sent when another
participant joined.

recording is now also checked on cloudRecordingStarted and
cloudRecordingStopped, and transcribing on liveTranscriptionStarted and
liveTranscriptionStopped instead of newClient.
@misi-whereby
misi-whereby force-pushed the misi/cob-3449-rtcstats-doesnt-send-recording-and branch from d749fe2 to 337b70a Compare November 17, 2026 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant