@pbvision/cloud-run-service 0.0.31 → 0.0.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/cloud-run-service",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "fastify-firestore-service Web Framework on Cloud Run",
   "license": "Apache-2.0",
   "type": "module",

package/src/analytics.js

@@ -1,5 +1,5 @@
 import assert from 'node:assert'
-import { randomUUID } from 'node:crypto'
+import crypto, { randomUUID } from 'node:crypto'
 
 import { DatabaseAPI, EXCEPTIONS } from '@pbvision/fastify-firestore-service'
 import UAParser from 'ua-parser-js'
@@ -29,14 +29,21 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
     return super.postCommit(respData)
   }
 
-  logAnalyticsEvent (mixpanelUserId, eventName, inputProperties, deviceId = null) {
+  logAnalyticsEvent (mixpanelUserId, eventName, inputProperties = {}, deviceId = null, insertId = null) {
+    if (insertId) {
+      // insert id must be <= 36 chars & only have alphanumeric & hyphen chars
+      insertId = crypto.createHash('md5').update(insertId).digest('hex')
+    } else {
+      insertId = randomUUID()
+    }
+
     this.__analyticsEvents.push({
       event: eventName,
       properties: addSenderId(mixpanelUserId, {
         ...inputProperties,
         token: mixpanelToken,
         time: new Date().getTime(),
-        $insert_id: randomUUID(),
+        $insert_id: insertId,
         ip: this.req.ip
       }, deviceId)
     })
@@ -140,12 +147,19 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
 
 function addSenderId (mixpanelUserId, properties, deviceId) {
   if (mixpanelUserId.startsWith('$device:')) {
-    properties.$device_id = mixpanelUserId
+    properties.distinct_id = mixpanelUserId
+    properties.$device_id = mixpanelUserId.substring(8)
   } else {
-    properties.$user_id = mixpanelUserId
+    properties.distinct_id = properties.$user_id = mixpanelUserId
     if (deviceId) {
-      properties.$device_id = deviceId
+      // istanbul ignore else
+      if (deviceId.startsWith('$device')) {
+        properties.$device_id = deviceId.substring(8)
+      } else {
+        properties.$device_id = deviceId
+      }
     }
   }
+  properties.distinct_id = mixpanelUserId
   return properties
 }

package/test/unit-test-analytics.js

@@ -1,3 +1,5 @@
+import crypto from 'node:crypto'
+
 import { mixpanelToken } from '../src/analytics.js'
 
 import { AppTest, runTests } from './base-test.js'
@@ -111,7 +113,8 @@ class AnalyticsTest extends AppTest {
       properties: expect.objectContaining({
         cool: 1,
         hi: 'world',
-        $device_id: '$device:xyz',
+        distinct_id: '$device:xyz',
+        $device_id: 'xyz',
         token: mixpanelToken
       })
     }])
@@ -133,7 +136,49 @@ class AnalyticsTest extends AppTest {
         cool: 1,
         hi: 'world',
         $user_id: 'some uid',
-        $device_id: '$device:xyz',
+        distinct_id: 'some uid',
+        $device_id: 'xyz',
+        token: mixpanelToken
+      })
+    }])
+  }
+
+  async testCustomInsertionId () {
+    await this.app.post('/analytics')
+      .send({
+        eventCalls: [
+          ['some uid', 'some event', { cool: 1, hi: 'world' }, null, 'xx']
+        ]
+      }).expect(200)
+    const calls = this.fetchMock.mock.calls
+    expect(calls.length).toBe(1)
+    const actualBody = JSON.parse(calls[0][1].body)
+    expect(actualBody).toEqual([{
+      event: 'some event',
+      properties: expect.objectContaining({
+        cool: 1,
+        hi: 'world',
+        $user_id: 'some uid',
+        token: mixpanelToken,
+        $insert_id: crypto.createHash('md5').update('xx').digest('hex')
+      })
+    }])
+  }
+
+  async testOmittingEventProperties () {
+    await this.app.post('/analytics')
+      .send({
+        eventCalls: [
+          ['some uid', 'some event']
+        ]
+      }).expect(200)
+    const calls = this.fetchMock.mock.calls
+    expect(calls.length).toBe(1)
+    const actualBody = JSON.parse(calls[0][1].body)
+    expect(actualBody).toEqual([{
+      event: 'some event',
+      properties: expect.objectContaining({
+        $user_id: 'some uid',
         token: mixpanelToken
       })
     }])