Attach breakoutGroup to all remote and local participants on room_joined, new_client and breakout_group_joined signal events

[richtrwhereby]

Description

Add breakoutGroup to all participants when that data is received from the signal server in room_joined and/or breakout_group_joined events.

Related Issue:
#481 (Add breakoutGroup to all screenshare objects)

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.

[changeset-bot]

🦋 Changeset detected

Latest commit: 392e210

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

This PR includes changesets to release 4 packages

Name	Type
@whereby.com/core	Minor
@whereby.com/media	Patch
@whereby.com/browser-sdk	Patch
@whereby.com/react-native-sdk	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

[richtrwhereby]

/canary

[github-actions]

🚀 The canary releases have been published to npm.

You can test the releases by installing the newly published versions:

yarn add @whereby.com/browser-sdk@0.0.0-canary-20241119150730

yarn add @whereby.com/core@0.0.0-canary-20241119150730

yarn add @whereby.com/media@0.0.0-canary-20241119150730

yarn add @whereby.com/react-native-sdk@0.0.0-canary-20241119150730

[richtrwhereby]

Nice, works well. I've tested and see that the breakout group is set correctly. However there's an inconsistency here:

When there's no breakout active and you join a room with the SDK, the local participant will have breakoutGroup: null in the redux state, but the remote client will have breakoutGroup: "".

If you join a breakout group with the remote client, and then leave again the remote client state will correctly be set to breakoutGroup: null. I don't think this will cause any issues practically, but we should be consistent.

You can add this line in remoteParticipants.ts, in the createRemoteParticipant function to fix it:

export function createRemoteParticipant(client: SignalClient, newJoiner = false): RemoteParticipant {
    const { streams, role, ...rest } = client;

    return {
        ...rest,
        breakoutGroup: client.breakoutGroup || null,
        ...

Thanks this was a good shout and fixed now (force pushed) 🎉

[thyal]

🍰 Nice!