Fix duplicate ParticipantPermissionsChanged updates for the local participant (#1270)

* Fix duplicate ParticipantPermissionsChanged updates for the local participant

also fixed incorrect comments indicating it's only for the local participant

* changeset

Author: davidzhao

.changeset/three-cheetahs-marry.md

@@ -0,0 +1,5 @@
+---
+'livekit-client': patch
+---
+
+Fix duplicate ParticipantPermissionsChanged updates for the local participant

example/sample.ts

@@ -1,5 +1,14 @@
 //@ts-ignore
 import E2EEWorker from '../src/e2ee/worker/e2ee.worker?worker';
+import type {
+  ChatMessage,
+  RoomConnectOptions,
+  RoomOptions,
+  ScalabilityMode,
+  SimulationScenario,
+  VideoCaptureOptions,
+  VideoCodec,
+} from '../src/index';
 import {
   ConnectionQuality,
   ConnectionState,
@@ -15,23 +24,17 @@ import {
   RemoteTrackPublication,
   RemoteVideoTrack,
   Room,
-  RoomConnectOptions,
   RoomEvent,
-  RoomOptions,
   ScreenSharePresets,
   Track,
   TrackPublication,
-  VideoCaptureOptions,
-  VideoCodec,
   VideoPresets,
   VideoQuality,
   createAudioAnalyser,
   setLogLevel,
   supportsAV1,
   supportsVP9,
 } from '../src/index';
-import { ScalabilityMode } from '../src/room/track/options';
-import type { ChatMessage, SimulationScenario } from '../src/room/types';
 import { isSVCCodec } from '../src/room/utils';
 
 const $ = <T extends HTMLElement>(id: string) => document.getElementById(id) as T;

src/room/events.ts

@@ -294,7 +294,7 @@ export enum RoomEvent {
   MediaDevicesError = 'mediaDevicesError',
 
   /**
-   * A participant's permission has changed. Currently only fired on LocalParticipant.
+   * A participant's permission has changed.
    * args: (prevPermissions: [[ParticipantPermission]], participant: [[Participant]])
    */
   ParticipantPermissionsChanged = 'participantPermissionsChanged',
@@ -502,7 +502,7 @@ export enum ParticipantEvent {
   AudioStreamAcquired = 'audioStreamAcquired',
 
   /**
-   * A participant's permission has changed. Currently only fired on LocalParticipant.
+   * A participant's permission has changed.
    * args: (prevPermissions: [[ParticipantPermission]])
    */
   ParticipantPermissionsChanged = 'participantPermissionsChanged',

src/room/participant/Participant.ts

@@ -279,7 +279,8 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
       permissions.canPublishSources.length !== this.permissions.canPublishSources.length ||
       permissions.canPublishSources.some(
         (value, index) => value !== this.permissions?.canPublishSources[index],
-      );
+      ) ||
+      permissions.canSubscribeMetrics !== this.permissions?.canSubscribeMetrics;
     this.permissions = permissions;
 
     if (changed) {