Upgrade eslint-plugin-matrix-org to 1.2.1

This upgrade came with a number of new lints that needed to be fixed across the code base. Primarily: explicit return types on functions, and explicit visibility modifiers on class members.

src/otel/OTelCall.ts

@@ -44,7 +44,7 @@ export class OTelCall {
     OTelCallAbstractMediaStreamSpan
   >();
 
-  constructor(
+  public constructor(
     public userId: string,
     public deviceId: string,
     public call: MatrixCall,
@@ -60,7 +60,7 @@ export class OTelCall {
     }
   }
 
-  public dispose() {
+  public dispose(): void {
     this.call.peerConn?.removeEventListener(
       "connectionstatechange",
       this.onCallConnectionStateChanged

src/otel/OTelCallAbstractMediaStreamSpan.ts

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 import opentelemetry, { Span } from "@opentelemetry/api";
 import { TrackStats } from "matrix-js-sdk/src/webrtc/stats/statsReport";
 
@@ -14,8 +30,8 @@ export abstract class OTelCallAbstractMediaStreamSpan {
   public readonly span;
 
   public constructor(
-    readonly oTel: ElementCallOpenTelemetry,
-    readonly callSpan: Span,
+    protected readonly oTel: ElementCallOpenTelemetry,
+    protected readonly callSpan: Span,
     protected readonly type: string
   ) {
     const ctx = opentelemetry.trace.setSpan(
@@ -32,7 +48,7 @@ export abstract class OTelCallAbstractMediaStreamSpan {
     this.span = oTel.tracer.startSpan(this.type, options, ctx);
   }
 
-  protected upsertTrackSpans(tracks: TrackStats[]) {
+  protected upsertTrackSpans(tracks: TrackStats[]): void {
     let prvTracks: TrackId[] = [...this.trackSpans.keys()];
     tracks.forEach((t) => {
       if (!this.trackSpans.has(t.id)) {

src/otel/OTelCallFeedMediaStreamSpan.ts

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 import { Span } from "@opentelemetry/api";
 import {
   CallFeedStats,
@@ -10,9 +26,9 @@ import { OTelCallAbstractMediaStreamSpan } from "./OTelCallAbstractMediaStreamSp
 export class OTelCallFeedMediaStreamSpan extends OTelCallAbstractMediaStreamSpan {
   private readonly prev: { isAudioMuted: boolean; isVideoMuted: boolean };
 
-  constructor(
-    readonly oTel: ElementCallOpenTelemetry,
-    readonly callSpan: Span,
+  public constructor(
+    protected readonly oTel: ElementCallOpenTelemetry,
+    protected readonly callSpan: Span,
     callFeed: CallFeedStats
   ) {
     const postFix =

src/otel/OTelCallMediaStreamTrackSpan.ts

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 import { TrackStats } from "matrix-js-sdk/src/webrtc/stats/statsReport";
 import opentelemetry, { Span } from "@opentelemetry/api";
 
@@ -8,8 +24,8 @@ export class OTelCallMediaStreamTrackSpan {
   private prev: TrackStats;
 
   public constructor(
-    readonly oTel: ElementCallOpenTelemetry,
-    readonly streamSpan: Span,
+    protected readonly oTel: ElementCallOpenTelemetry,
+    protected readonly streamSpan: Span,
     data: TrackStats
   ) {
     const ctx = opentelemetry.trace.setSpan(

src/otel/OTelCallTransceiverMediaStreamSpan.ts

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 import { Span } from "@opentelemetry/api";
 import {
   TrackStats,
@@ -13,9 +29,9 @@ export class OTelCallTransceiverMediaStreamSpan extends OTelCallAbstractMediaStr
     currentDirection: string;
   };
 
-  constructor(
-    readonly oTel: ElementCallOpenTelemetry,
-    readonly callSpan: Span,
+  public constructor(
+    protected readonly oTel: ElementCallOpenTelemetry,
+    protected readonly callSpan: Span,
     stats: TransceiverStats
   ) {
     super(oTel, callSpan, `matrix.call.transceiver.${stats.mid}`);

src/otel/OTelGroupCallMembership.ts

@@ -62,7 +62,7 @@ export class OTelGroupCallMembership {
   };
   private readonly speakingSpans = new Map<RoomMember, Map<string, Span>>();
 
-  constructor(private groupCall: GroupCall, client: MatrixClient) {
+  public constructor(private groupCall: GroupCall, client: MatrixClient) {
     const clientId = client.getUserId();
     if (clientId) {
       this.myUserId = clientId;
@@ -76,14 +76,14 @@ export class OTelGroupCallMembership {
     this.groupCall.on(GroupCallEvent.CallsChanged, this.onCallsChanged);
   }
 
-  dispose() {
+  public dispose(): void {
     this.groupCall.removeListener(
       GroupCallEvent.CallsChanged,
       this.onCallsChanged
     );
   }
 
-  public onJoinCall() {
+  public onJoinCall(): void {
     if (!ElementCallOpenTelemetry.instance) return;
     if (this.callMembershipSpan !== undefined) {
       logger.warn("Call membership span is already started");
@@ -114,7 +114,7 @@ export class OTelGroupCallMembership {
     this.callMembershipSpan?.addEvent("matrix.joinCall");
   }
 
-  public onLeaveCall() {
+  public onLeaveCall(): void {
     if (this.callMembershipSpan === undefined) {
       logger.warn("Call membership span is already ended");
       return;
@@ -127,7 +127,7 @@ export class OTelGroupCallMembership {
     this.groupCallContext = undefined;
   }
 
-  public onUpdateRoomState(event: MatrixEvent) {
+  public onUpdateRoomState(event: MatrixEvent): void {
     if (
       !event ||
       (!event.getType().startsWith("m.call") &&
@@ -142,7 +142,7 @@ export class OTelGroupCallMembership {
     );
   }
 
-  public onCallsChanged = (calls: CallsByUserAndDevice) => {
+  public onCallsChanged(calls: CallsByUserAndDevice): void {
     for (const [userId, userCalls] of calls.entries()) {
       for (const [deviceId, call] of userCalls.entries()) {
         if (!this.callsByCallId.has(call.callId)) {
@@ -179,9 +179,9 @@ export class OTelGroupCallMembership {
         this.callsByCallId.delete(callTrackingInfo.call.callId);
       }
     }
-  };
+  }
 
-  public onCallStateChange(call: MatrixCall, newState: CallState) {
+  public onCallStateChange(call: MatrixCall, newState: CallState): void {
     const callTrackingInfo = this.callsByCallId.get(call.callId);
     if (!callTrackingInfo) {
       logger.error(`Got call state change for unknown call ID ${call.callId}`);
@@ -193,7 +193,7 @@ export class OTelGroupCallMembership {
     });
   }
 
-  public onSendEvent(call: MatrixCall, event: VoipEvent) {
+  public onSendEvent(call: MatrixCall, event: VoipEvent): void {
     const eventType = event.eventType as string;
     if (
       !eventType.startsWith("m.call") &&
@@ -220,7 +220,7 @@ export class OTelGroupCallMembership {
     }
   }
 
-  public onReceivedVoipEvent(event: MatrixEvent) {
+  public onReceivedVoipEvent(event: MatrixEvent): void {
     // These come straight from CallEventHandler so don't have
     // a call already associated (in principle we could receive
     // events for calls we don't know about).
@@ -251,37 +251,41 @@ export class OTelGroupCallMembership {
     });
   }
 
-  public onToggleMicrophoneMuted(newValue: boolean) {
+  public onToggleMicrophoneMuted(newValue: boolean): void {
     this.callMembershipSpan?.addEvent("matrix.toggleMicMuted", {
       "matrix.microphone.muted": newValue,
     });
   }
 
-  public onSetMicrophoneMuted(setMuted: boolean) {
+  public onSetMicrophoneMuted(setMuted: boolean): void {
     this.callMembershipSpan?.addEvent("matrix.setMicMuted", {
       "matrix.microphone.muted": setMuted,
     });
   }
 
-  public onToggleLocalVideoMuted(newValue: boolean) {
+  public onToggleLocalVideoMuted(newValue: boolean): void {
     this.callMembershipSpan?.addEvent("matrix.toggleVidMuted", {
       "matrix.video.muted": newValue,
     });
   }
 
-  public onSetLocalVideoMuted(setMuted: boolean) {
+  public onSetLocalVideoMuted(setMuted: boolean): void {
     this.callMembershipSpan?.addEvent("matrix.setVidMuted", {
       "matrix.video.muted": setMuted,
     });
   }
 
-  public onToggleScreensharing(newValue: boolean) {
+  public onToggleScreensharing(newValue: boolean): void {
     this.callMembershipSpan?.addEvent("matrix.setVidMuted", {
       "matrix.screensharing.enabled": newValue,
     });
   }
 
-  public onSpeaking(member: RoomMember, deviceId: string, speaking: boolean) {
+  public onSpeaking(
+    member: RoomMember,
+    deviceId: string,
+    speaking: boolean
+  ): void {
     if (speaking) {
       // Ensure that there's an audio activity span for this speaker
       let deviceMap = this.speakingSpans.get(member);
@@ -311,7 +315,7 @@ export class OTelGroupCallMembership {
     }
   }
 
-  public onCallError(error: CallError, call: MatrixCall) {
+  public onCallError(error: CallError, call: MatrixCall): void {
     const callTrackingInfo = this.callsByCallId.get(call.callId);
     if (!callTrackingInfo) {
       logger.error(`Got error for unknown call ID ${call.callId}`);
@@ -321,17 +325,19 @@ export class OTelGroupCallMembership {
     callTrackingInfo.span.recordException(error);
   }
 
-  public onGroupCallError(error: GroupCallError) {
+  public onGroupCallError(error: GroupCallError): void {
     this.callMembershipSpan?.recordException(error);
   }
 
-  public onUndecryptableToDevice(event: MatrixEvent) {
+  public onUndecryptableToDevice(event: MatrixEvent): void {
     this.callMembershipSpan?.addEvent("matrix.toDevice.undecryptable", {
       "sender.userId": event.getSender(),
     });
   }
 
-  public onCallFeedStatsReport(report: GroupCallStatsReport<CallFeedReport>) {
+  public onCallFeedStatsReport(
+    report: GroupCallStatsReport<CallFeedReport>
+  ): void {
     if (!ElementCallOpenTelemetry.instance) return;
     let call: OTelCall | undefined;
     const callId = report.report?.callId;
@@ -362,7 +368,7 @@ export class OTelGroupCallMembership {
 
   public onConnectionStatsReport(
     statsReport: GroupCallStatsReport<ConnectionStatsReport>
-  ) {
+  ): void {
     this.buildCallStatsSpan(
       OTelStatsReportType.ConnectionReport,
       statsReport.report
@@ -371,7 +377,7 @@ export class OTelGroupCallMembership {
 
   public onByteSentStatsReport(
     statsReport: GroupCallStatsReport<ByteSentStatsReport>
-  ) {
+  ): void {
     this.buildCallStatsSpan(
       OTelStatsReportType.ByteSentReport,
       statsReport.report
@@ -431,7 +437,7 @@ export class OTelGroupCallMembership {
 
   public onSummaryStatsReport(
     statsReport: GroupCallStatsReport<SummaryStatsReport>
-  ) {
+  ): void {
     if (!ElementCallOpenTelemetry.instance) return;
 
     const type = OTelStatsReportType.SummaryReport;

src/otel/ObjectFlattener.ts

@@ -45,9 +45,9 @@ export class ObjectFlattener {
     return flatObject;
   }
 
-  static flattenSummaryStatsReportObject(
+  public static flattenSummaryStatsReportObject(
     statsReport: GroupCallStatsReport<SummaryStatsReport>
-  ) {
+  ): Attributes {
     const flatObject = {};
     ObjectFlattener.flattenObjectRecursive(
       statsReport.report,

src/otel/otel.ts

@@ -36,7 +36,7 @@ export class ElementCallOpenTelemetry {
   private otlpExporter?: OTLPTraceExporter;
   public readonly rageshakeProcessor?: RageshakeSpanProcessor;
 
-  static globalInit(): void {
+  public static globalInit(): void {
     const config = Config.get();
     // we always enable opentelemetry in general. We only enable the OTLP
     // collector if a URL is defined (and in future if another setting is defined)
@@ -55,11 +55,11 @@ export class ElementCallOpenTelemetry {
     }
   }
 
-  static get instance(): ElementCallOpenTelemetry {
+  public static get instance(): ElementCallOpenTelemetry {
     return sharedInstance;
   }
 
-  constructor(
+  private constructor(
     collectorUrl: string | undefined,
     rageshakeUrl: string | undefined
   ) {