From c34afdb4bdd834ea833016d0da795532c41b21b7 Mon Sep 17 00:00:00 2001
From: James Salter <iteration@gmail.com>
Date: Wed, 21 Jul 2021 18:35:25 +0100
Subject: [PATCH] Refactor platform properties loading

---
 src/Lifecycle.ts                         | 10 +++++++++-
 src/PosthogAnalytics.ts                  | 17 +++++++++++++++++
 src/components/structures/MatrixChat.tsx | 14 ++++++++++----
 3 files changed, 36 insertions(+), 5 deletions(-)

diff --git a/src/Lifecycle.ts b/src/Lifecycle.ts
index 8536f808ff..c27c774cd7 100644
--- a/src/Lifecycle.ts
+++ b/src/Lifecycle.ts
@@ -48,7 +48,7 @@ import { Jitsi } from "./widgets/Jitsi";
 import { SSO_HOMESERVER_URL_KEY, SSO_ID_SERVER_URL_KEY, SSO_IDP_ID_KEY } from "./BasePlatform";
 import ThreepidInviteStore from "./stores/ThreepidInviteStore";
 import CountlyAnalytics from "./CountlyAnalytics";
-import { getAnalytics } from "./PosthogAnalytics";
+import { Anonymity, getAnalytics, getPlatformProperties } from "./PosthogAnalytics";
 import CallHandler from './CallHandler';
 import LifecycleCustomisations from "./customisations/Lifecycle";
 import ErrorDialog from "./components/views/dialogs/ErrorDialog";
@@ -574,6 +574,14 @@ async function doSetLoggedIn(
         await abortLogin();
     }
 
+    if (SettingsStore.getValue("analyticsOptIn")) {
+        const analytics = getAnalytics();
+        analytics.setAnonymity(Anonymity.Pseudonymous);
+        await analytics.identifyUser(credentials.userId);
+    } else {
+        getAnalytics().setAnonymity(Anonymity.Anonymous);
+    }
+
     Analytics.setLoggedIn(credentials.guest, credentials.homeserverUrl);
 
     MatrixClientPeg.replaceUsingCreds(credentials);
diff --git a/src/PosthogAnalytics.ts b/src/PosthogAnalytics.ts
index 8ebeff3565..9c167f5464 100644
--- a/src/PosthogAnalytics.ts
+++ b/src/PosthogAnalytics.ts
@@ -1,4 +1,5 @@
 import posthog, { PostHog } from 'posthog-js';
+import PlatformPeg from './PlatformPeg';
 import SdkConfig from './SdkConfig';
 
 interface IEvent {
@@ -226,6 +227,22 @@ export class PosthogAnalytics {
     }
 }
 
+export async function getPlatformProperties() {
+    const platform = PlatformPeg.get();
+    let appVersion;
+    try {
+        appVersion = await platform.getAppVersion();
+    } catch (e) {
+        // this happens if no version is set i.e. in dev
+        appVersion = "unknown";
+    }
+
+    return {
+        appVersion,
+        appPlatform: platform.getHumanReadableName(),
+    };
+}
+
 export function getAnalytics(): PosthogAnalytics {
     return PosthogAnalytics.instance();
 }
diff --git a/src/components/structures/MatrixChat.tsx b/src/components/structures/MatrixChat.tsx
index b29ede409b..513200520f 100644
--- a/src/components/structures/MatrixChat.tsx
+++ b/src/components/structures/MatrixChat.tsx
@@ -107,7 +107,7 @@ import UIStore, { UI_EVENTS } from "../../stores/UIStore";
 import SoftLogout from './auth/SoftLogout';
 import { makeRoomPermalink } from "../../utils/permalinks/Permalinks";
 import { copyPlaintext } from "../../utils/strings";
-import { Anonymity, getAnalytics, IPageChange } from '../../PosthogAnalytics';
+import { Anonymity, getAnalytics, getPlatformProperties } from '../../PosthogAnalytics';
 
 /** constants for MatrixChat.state.view */
 export enum Views {
@@ -388,7 +388,11 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
         if (SettingsStore.getValue("analyticsOptIn")) {
             Analytics.enable();
         }
-        getAnalytics().init(SettingsStore.getValue("analyticsOptIn") ? Anonymity.Pseudonymous : Anonymity.Anonymous);
+
+        const analytics = getAnalytics();
+        analytics.init(SettingsStore.getValue("analyticsOptIn") ? Anonymity.Pseudonymous : Anonymity.Anonymous);
+        getPlatformProperties().then((properties) => analytics.registerSuperProperties(properties));
+
         CountlyAnalytics.instance.enable(/* anonymous = */ true);
     }
 
@@ -501,8 +505,6 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             } else if (SettingsStore.getValue("analyticsOptIn")) {
                 CountlyAnalytics.instance.enable(/* anonymous = */ false);
             }
-            getAnalytics().setAnonymity(SettingsStore.getValue("analyticsOptIn") ?
-                Anonymity.Pseudonymous: Anonymity.Anonymous);
         });
         // Note we don't catch errors from this: we catch everything within
         // loadSession as there's logic there to ask the user if they want
@@ -828,6 +830,10 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
                     CountlyAnalytics.instance.enable(/* anonymous = */ false);
                 }
                 getAnalytics().setAnonymity(Anonymity.Pseudonymous);
+                // TODO: this is an async call and we're not waiting for it to complete -
+                // so potentially an event could be fired prior to it completing and would be
+                // missing the user identification.
+                getAnalytics().identifyUser(MatrixClientPeg.get().getUserId());
                 break;
             case 'reject_cookies':
                 SettingsStore.setValue("analyticsOptIn", null, SettingLevel.DEVICE, false);