Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2025-06-13 20:53:59 +00:00
Code Issues Projects Releases Wiki Activity

(core) Add visitorId to telemetry

Browse Source 
Summary: The visitorId is added to telemetry events from Matomo's cookie, if present.

Test Plan: Manual.

Reviewers: dsagal

Reviewed By: dsagal

Differential Revision: https://phab.getgrist.com/D4132
This commit is contained in:
George Gevoian 2023-12-08 17:03:05 -05:00
parent 1ccad9171e
commit 6b1e98128a
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
app/server/lib/Telemetry.ts
View File

@ -26,6 +26,7 @@ import {hashId} from 'app/server/lib/hashingUtils';
import {LogMethods} from 'app/server/lib/LogMethods';
import {stringParam} from 'app/server/lib/requestUtils';
import {getLogMetaFromDocSession} from 'app/server/lib/serverUtils';
import * as cookie from 'cookie';
import * as express from 'express';
import fetch from 'node-fetch';
import merge = require('lodash/merge');
@ -33,6 +34,16 @@ import pickBy = require('lodash/pickBy');
type RequestOrSession = RequestWithLogin | OptDocSession | null;
interface RequestWithMatomoVisitorId extends RequestWithLogin {
/**
* Extracted from a cookie set by Matomo.
*
* Used by an AWS Lambda (LogsToMatomo_grist) to associate Grist telemetry
* events with Matomo visits.
*/
matomoVisitorId?: string | null;
}
export interface ITelemetry {
start(): Promise<void>;
logEvent(
@ -265,16 +276,21 @@ export class Telemetry implements ITelemetry {
private _logEvent(
requestOrSession: RequestOrSession,
event: TelemetryEvent,
metadata?: TelemetryMetadata
metadata: TelemetryMetadata = {}
) {
const isAnonymousUser = metadata.userId === this._dbManager.getAnonymousUserId();
let isInternalUser: boolean | undefined;
let isTeamSite: boolean | undefined;
let visitorId: string | null | undefined;
if (requestOrSession) {
let email: string | undefined;
let org: string | undefined;
if ('get' in requestOrSession) {
email = requestOrSession.user?.loginEmail;
org = requestOrSession.org;
if (isAnonymousUser) {
visitorId = this._getAndSetMatomoVisitorId(requestOrSession);
}
} else {
email = getDocSessionUser(requestOrSession)?.email;
org = requestOrSession.client?.getOrg() ?? requestOrSession.req?.org;
@ -295,9 +311,25 @@ export class Telemetry implements ITelemetry {
installationId: this._activation!.id,
...(isInternalUser !== undefined ? {isInternalUser} : undefined),
...(isTeamSite !== undefined ? {isTeamSite} : undefined),
...(visitorId ? {visitorId} : undefined),
...(isAnonymousUser ? {userId: undefined} : undefined),
});
}
private _getAndSetMatomoVisitorId(req: RequestWithMatomoVisitorId) {
if (req.matomoVisitorId === undefined) {
const cookies = cookie.parse(req.headers.cookie || '');
const matomoVisitorCookie = Object.entries(cookies)
.find(([key]) => key.startsWith('_pk_id'));
if (matomoVisitorCookie) {
req.matomoVisitorId = (matomoVisitorCookie[1] as string).split('.')[0];
} else {
req.matomoVisitorId = null;
}
}
return req.matomoVisitorId;
}
private async _forwardEvent(
requestOrSession: RequestOrSession,
event: TelemetryEvent,