More posthog tracking around joining rooms and room search (#7807)

src/dispatcher/actions.ts

@@ -153,12 +153,12 @@ export enum Action {
     UploadCanceled = "upload_canceled",
 
     /**
-     * Fired when requesting to join a room
+     * Fired when requesting to join a room. Should be used with JoinRoomPayload.
      */
     JoinRoom = "join_room",
 
     /**
-     * Fired when successfully joining a room
+     * Fired when successfully joining a room. Should be used with a JoinRoomReadyPayload.
      */
     JoinRoomReady = "join_room_ready",
 
@@ -168,7 +168,7 @@ export enum Action {
     JoinRoomError = "join_room_error",
 
     /**
-     * Inserts content into the active composer. Should be used with ComposerInsertPayload
+     * Inserts content into the active composer. Should be used with ComposerInsertPayload.
      */
     ComposerInsert = "composer_insert",
 

src/dispatcher/payloads/JoinRoomPayload.ts

@@ -0,0 +1,33 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+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 { JoinedRoom as JoinedRoomEvent } from "matrix-analytics-events/types/typescript/JoinedRoom";
+import { IJoinRoomOpts } from "matrix-js-sdk/src/@types/requests";
+
+import { ActionPayload } from "../payloads";
+import { Action } from "../actions";
+
+/* eslint-disable camelcase */
+export interface JoinRoomPayload extends Pick<ActionPayload, "action"> {
+    action: Action.JoinRoom;
+
+    roomId: string;
+    opts?: IJoinRoomOpts;
+
+    // additional parameters for the purpose of metrics & instrumentation
+    metricsTrigger: JoinedRoomEvent["trigger"];
+}
+/* eslint-enable camelcase */

src/dispatcher/payloads/JoinRoomReadyPayload.ts

@@ -0,0 +1,30 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+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 { JoinedRoom as JoinedRoomEvent } from "matrix-analytics-events/types/typescript/JoinedRoom";
+
+import { ActionPayload } from "../payloads";
+import { Action } from "../actions";
+
+/* eslint-disable camelcase */
+export interface JoinRoomReadyPayload extends Pick<ActionPayload, "action"> {
+    action: Action.JoinRoomReady;
+    roomId: string;
+
+    // additional parameters for the purpose of metrics & instrumentation
+    metricsTrigger: JoinedRoomEvent["trigger"];
+}
+/* eslint-enable camelcase */

src/dispatcher/payloads/ViewRoomPayload.ts

@@ -48,7 +48,7 @@ export interface ViewRoomPayload extends Pick<ActionPayload, "action"> {
     deferred_action?: ActionPayload; // Action to fire after MatrixChat handles this ViewRoom action
 
     // additional parameters for the purpose of metrics & instrumentation
-    _trigger: ViewRoomEvent["trigger"];
-    _viaKeyboard?: ViewRoomEvent["viaKeyboard"];
+    metricsTrigger: ViewRoomEvent["trigger"];
+    metricsViaKeyboard?: ViewRoomEvent["viaKeyboard"];
 }
 /* eslint-enable camelcase */