From 2e111aa13afc18a33bdb32a9398fd555aaac51b6 Mon Sep 17 00:00:00 2001 From: Kharhamel Date: Wed, 15 Sep 2021 11:50:25 +0200 Subject: [PATCH] FEATURE: added posthog as new analytics tool --- deeployer.libsonnet | 3 + front/package.json | 1 + front/src/Administration/AnalyticsClient.ts | 61 +++++++++++++++++++++ front/src/Connexion/ConnectionManager.ts | 6 ++ front/src/Enum/EnvironmentVariable.ts | 2 + front/src/Phaser/Game/GameScene.ts | 4 ++ front/src/Stores/MenuStore.ts | 5 +- front/src/index.ts | 2 +- front/webpack.config.ts | 4 +- front/yarn.lock | 24 ++++++++ 10 files changed, 109 insertions(+), 3 deletions(-) create mode 100644 front/src/Administration/AnalyticsClient.ts diff --git a/deeployer.libsonnet b/deeployer.libsonnet index a2e8970a..75a4de8c 100644 --- a/deeployer.libsonnet +++ b/deeployer.libsonnet @@ -75,6 +75,9 @@ "UPLOADER_URL": "//uploader-"+url, "ADMIN_URL": "//"+url, "JITSI_URL": env.JITSI_URL, + #POSTHOG + "POSTHOG_API_KEY": if namespace == "master" then env.POSTHOG_API_KEY else "", + "POSTHOG_URL": if namespace == "master" then env.POSTHOG_URL else "", "SECRET_JITSI_KEY": env.SECRET_JITSI_KEY, "TURN_SERVER": "turn:coturn.workadventu.re:443,turns:coturn.workadventu.re:443", "JITSI_PRIVATE_MODE": if env.SECRET_JITSI_KEY != '' then "true" else "false", diff --git a/front/package.json b/front/package.json index d60b6fa6..38c0570f 100644 --- a/front/package.json +++ b/front/package.json @@ -49,6 +49,7 @@ "phaser": "^3.54.0", "phaser-animated-tiles": "workadventure/phaser-animated-tiles#da68bbededd605925621dd4f03bd27e69284b254", "phaser3-rex-plugins": "^1.1.42", + "posthog-js": "^1.13.12", "queue-typescript": "^1.0.1", "quill": "1.3.6", "quill-delta-to-html": "^0.12.0", diff --git a/front/src/Administration/AnalyticsClient.ts b/front/src/Administration/AnalyticsClient.ts new file mode 100644 index 00000000..f3cde793 --- /dev/null +++ b/front/src/Administration/AnalyticsClient.ts @@ -0,0 +1,61 @@ +import {POSTHOG_API_KEY, POSTHOG_URL} from "../Enum/EnvironmentVariable"; + +class AnalyticsClient { + + // eslint-disable-next-line @typescript-eslint/no-explicit-any + private posthogPromise: Promise; + + constructor() { + if (POSTHOG_API_KEY && POSTHOG_URL) { + this.posthogPromise = import('posthog-js').then(({default: posthog}) => { + posthog.init(POSTHOG_API_KEY, { api_host: POSTHOG_URL, disable_cookie: true }); + return posthog; + }); + } else { + this.posthogPromise = Promise.reject(); + } + } + + identifyUser(uuid: string) { + this.posthogPromise.then(posthog => { + posthog.identify(uuid, { uuid, wa: true }); + }).catch(); + } + + loggedWithSso() { + this.posthogPromise.then(posthog => { + posthog.capture('wa-logged-sso'); + }).catch(); + } + + loggedWithToken() { + this.posthogPromise.then(posthog => { + posthog.capture('wa-logged-token'); + }).catch(); + } + + enteredRoom(roomId: string) { + this.posthogPromise.then(posthog => { + posthog.capture('$pageView', {roomId}); + }).catch(); + } + + openedMenu() { + this.posthogPromise.then(posthog => { + posthog.capture('wa-opened-menu'); + }).catch(); + } + + launchEmote(emote: string) { + this.posthogPromise.then(posthog => { + posthog.capture('wa-emote-launch', {emote}); + }).catch(); + } + + enteredJitsi(roomName: string, roomId: string) { + this.posthogPromise.then(posthog => { + posthog.capture('wa-entered-jitsi', {roomName, roomId}); + }).catch(); + } +} +export const analyticsClient = new AnalyticsClient(); diff --git a/front/src/Connexion/ConnectionManager.ts b/front/src/Connexion/ConnectionManager.ts index 0dc3493f..0aba0379 100644 --- a/front/src/Connexion/ConnectionManager.ts +++ b/front/src/Connexion/ConnectionManager.ts @@ -9,6 +9,7 @@ import { Room } from "./Room"; import { _ServiceWorker } from "../Network/ServiceWorker"; import { loginSceneVisibleIframeStore } from "../Stores/LoginSceneStore"; import { userIsConnected } from "../Stores/MenuStore"; +import {analyticsClient} from "../Administration/AnalyticsClient"; class ConnectionManager { private localUser!: LocalUser; @@ -93,6 +94,7 @@ class ConnectionManager { this._currentRoom = await Room.createRoom(new URL(localUserStore.getLastRoomUrl())); try { await this.checkAuthUserConnexion(); + analyticsClient.loggedWithSso(); } catch (err) { console.error(err); this.loadOpenIDScreen(); @@ -109,6 +111,7 @@ class ConnectionManager { this.authToken = data.authToken; localUserStore.saveUser(this.localUser); localUserStore.setAuthToken(this.authToken); + analyticsClient.loggedWithToken(); const roomUrl = data.roomUrl; @@ -184,6 +187,9 @@ class ConnectionManager { if (this._currentRoom == undefined) { return Promise.reject(new Error("Invalid URL")); } + if (this.localUser) { + analyticsClient.identifyUser(this.localUser.uuid) + } this.serviceWorker = new _ServiceWorker(); return Promise.resolve(this._currentRoom); diff --git a/front/src/Enum/EnvironmentVariable.ts b/front/src/Enum/EnvironmentVariable.ts index 60678822..e724599c 100644 --- a/front/src/Enum/EnvironmentVariable.ts +++ b/front/src/Enum/EnvironmentVariable.ts @@ -20,6 +20,8 @@ export const DISPLAY_TERMS_OF_USE = process.env.DISPLAY_TERMS_OF_USE == "true"; export const NODE_ENV = process.env.NODE_ENV || "development"; export const CONTACT_URL = process.env.CONTACT_URL || undefined; export const PROFILE_URL = process.env.PROFILE_URL || undefined; +export const POSTHOG_API_KEY: string = process.env.POSTHOG_API_KEY as string || ''; +export const POSTHOG_URL = process.env.POSTHOG_URL || undefined; export const isMobile = (): boolean => window.innerWidth <= 800 || window.innerHeight <= 600; diff --git a/front/src/Phaser/Game/GameScene.ts b/front/src/Phaser/Game/GameScene.ts index ec387b4f..77a3b525 100644 --- a/front/src/Phaser/Game/GameScene.ts +++ b/front/src/Phaser/Game/GameScene.ts @@ -94,6 +94,7 @@ import { layoutManagerActionStore } from "../../Stores/LayoutManagerStore"; import { EmbeddedWebsiteManager } from "./EmbeddedWebsiteManager"; import { GameMapPropertiesListener } from "./GameMapPropertiesListener"; import type { RadialMenuItem } from "../Components/RadialMenu"; +import {analyticsClient} from "../../Administration/AnalyticsClient"; export interface GameSceneInitInterface { initPosition: PointInterface | null; @@ -426,6 +427,7 @@ export class GameScene extends DirtyScene { gameManager.gameSceneIsCreated(this); urlManager.pushRoomIdToUrl(this.room); + analyticsClient.enteredRoom(this.room.id); if (touchScreenManager.supportTouchScreen) { this.pinchManager = new PinchManager(this); @@ -1438,6 +1440,7 @@ ${escapedMessage} }); this.CurrentPlayer.on(requestEmoteEventName, (emoteKey: string) => { this.connection?.emitEmoteEvent(emoteKey); + analyticsClient.launchEmote(emoteKey); }); } catch (err) { if (err instanceof TextureError) { @@ -1805,6 +1808,7 @@ ${escapedMessage} jitsiFactory.start(roomName, this.playerName, jwt, jitsiConfig, jitsiInterfaceConfig, jitsiUrl, jitsiWidth); this.connection?.setSilent(true); mediaManager.hideGameOverlay(); + analyticsClient.enteredJitsi(roomName, this.room.id); //permit to stop jitsi when user close iframe mediaManager.addTriggerCloseJitsiFrameButton("close-jitsi", () => { diff --git a/front/src/Stores/MenuStore.ts b/front/src/Stores/MenuStore.ts index 96e731a9..4a30a4e7 100644 --- a/front/src/Stores/MenuStore.ts +++ b/front/src/Stores/MenuStore.ts @@ -2,11 +2,14 @@ import { get, writable } from "svelte/store"; import Timeout = NodeJS.Timeout; import { userIsAdminStore } from "./GameStore"; import { CONTACT_URL } from "../Enum/EnvironmentVariable"; +import {analyticsClient} from "../Administration/AnalyticsClient"; export const menuIconVisiblilityStore = writable(false); export const menuVisiblilityStore = writable(false); +menuVisiblilityStore.subscribe((value) => { + if (value) analyticsClient.openedMenu(); +}) export const menuInputFocusStore = writable(false); -export const loginUrlStore = writable(false); export const userIsConnected = writable(false); let warningContainerTimeout: Timeout | null = null; diff --git a/front/src/index.ts b/front/src/index.ts index 30f25c6e..9842e65d 100644 --- a/front/src/index.ts +++ b/front/src/index.ts @@ -23,9 +23,9 @@ import { Game } from "./Phaser/Game/Game"; import App from "./Components/App.svelte"; import { HtmlUtils } from "./WebRtc/HtmlUtils"; import WebGLRenderer = Phaser.Renderer.WebGL.WebGLRenderer; +import {analyticsClient} from "./Administration/AnalyticsClient"; const { width, height } = coWebsiteManager.getGameSize(); - const valueGameQuality = localUserStore.getGameQualityValue(); const fps: Phaser.Types.Core.FPSConfig = { /** diff --git a/front/webpack.config.ts b/front/webpack.config.ts index 48db1afa..f2e4e7cc 100644 --- a/front/webpack.config.ts +++ b/front/webpack.config.ts @@ -7,7 +7,7 @@ import MiniCssExtractPlugin from "mini-css-extract-plugin"; import sveltePreprocess from "svelte-preprocess"; import ForkTsCheckerWebpackPlugin from "fork-ts-checker-webpack-plugin"; import NodePolyfillPlugin from "node-polyfill-webpack-plugin"; -import { PROFILE_URL } from "./src/Enum/EnvironmentVariable"; +import {POSTHOG_API_KEY, PROFILE_URL} from "./src/Enum/EnvironmentVariable"; const mode = process.env.NODE_ENV ?? "development"; const buildNpmTypingsForApi = !!process.env.BUILD_TYPINGS; @@ -204,6 +204,8 @@ module.exports = { MAX_USERNAME_LENGTH: 8, MAX_PER_GROUP: 4, DISPLAY_TERMS_OF_USE: false, + POSTHOG_API_KEY: null, + POSTHOG_URL: null, NODE_ENV: mode, }), ], diff --git a/front/yarn.lock b/front/yarn.lock index c4462d98..68cca0cf 100644 --- a/front/yarn.lock +++ b/front/yarn.lock @@ -83,6 +83,11 @@ "@nodelib/fs.scandir" "2.1.4" fastq "^1.6.0" +"@sentry/types@^6.11.0": + version "6.12.0" + resolved "https://registry.yarnpkg.com/@sentry/types/-/types-6.12.0.tgz#b7395688a79403c6df8d8bb8d81deb8222519853" + integrity sha512-urtgLzE4EDMAYQHYdkgC0Ei9QvLajodK1ntg71bGn0Pm84QUpaqpPDfHRU+i6jLeteyC7kWwa5O5W1m/jrjGXA== + "@tsconfig/svelte@^1.0.10": version "1.0.10" resolved "https://registry.yarnpkg.com/@tsconfig/svelte/-/svelte-1.0.10.tgz#30ec7feeee0bdf38b12a50f0686f8a2e7b6b9dc0" @@ -2296,6 +2301,11 @@ faye-websocket@^0.11.3: dependencies: websocket-driver ">=0.5.1" +fflate@^0.4.1: + version "0.4.8" + resolved "https://registry.yarnpkg.com/fflate/-/fflate-0.4.8.tgz#f90b82aefbd8ac174213abb338bd7ef848f0f5ae" + integrity sha512-FJqqoDBR00Mdj9ppamLa/Y7vxm+PRmNWA67N846RvsoYVMKB4q3y/de5PA7gUmRMYK/8CMz2GDZQmCRN1wBcWA== + file-entry-cache@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-6.0.1.tgz#211b2dd9659cb0394b073e7323ac3c933d522027" @@ -4394,6 +4404,15 @@ postcss@^8.2.10: nanoid "^3.1.23" source-map "^0.6.1" +posthog-js@^1.13.12: + version "1.13.12" + resolved "https://registry.yarnpkg.com/posthog-js/-/posthog-js-1.13.12.tgz#b54efcb92de43724c889048135ccaae3dc4b874c" + integrity sha512-MU1I0zSVhdCcnWI8jAZLtbNJmjfg9AnhUDq5dUzNkb0qPXtNz17BekalnNwDMKs0Zlek3UCOVsIpyc85M+VRNA== + dependencies: + "@sentry/types" "^6.11.0" + fflate "^0.4.1" + rrweb-snapshot "^1.1.7" + prelude-ls@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" @@ -4785,6 +4804,11 @@ ripemd160@^2.0.0, ripemd160@^2.0.1: hash-base "^3.0.0" inherits "^2.0.1" +rrweb-snapshot@^1.1.7: + version "1.1.8" + resolved "https://registry.yarnpkg.com/rrweb-snapshot/-/rrweb-snapshot-1.1.8.tgz#57c3a8003a6ebbe4a2e2f5be29e30a47a8b1eb03" + integrity sha512-wi8T9IVobEwlns7U2m8cbPfoihsNAMpTI+UBe4KUjclU2N+vtowD2U1Rq8PleiFTDvcseHvkQDmEIZoZLXFzwg== + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee"