@pbvision/cloud-run-service 0.0.30 → 0.0.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/cloud-run-service",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "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'
@@ -21,7 +21,6 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
     super(fastify, req, reply)
     this.__analyticsEvents = []
     this.__analyticsUserProfileUpdates = {} // uid to $set/$set_once to changes
-    this.__analyticsSent = false
   }
 
   async postCommit (respData) {
@@ -30,15 +29,21 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
     return super.postCommit(respData)
   }
 
-  logAnalyticsEvent (mixpanelUserId, eventName, inputProperties, deviceId = null) {
-    assert(this.__analyticsSent === false)
+  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)
     })
@@ -60,14 +65,13 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
   }
 
   async sendAnalyticsEvents () {
-    // istanbul ignore if
-    if (this.__analyticsSent) {
-      return
-    }
-    this.__analyticsSent = true
+    const events = this.__analyticsEvents
+    this.__analyticsEvents = []
+    const userProfileUpdates = this.__analyticsUserProfileUpdates
+    this.__analyticsUserProfileUpdates = {}
 
     const promises = []
-    if (this.__analyticsEvents.length) {
+    if (events.length) {
       const uaData = {}
       const parser = new UAParser(this.req.headers['user-agent'])
       const browser = parser.getBrowser()
@@ -92,7 +96,7 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
         }
       }
 
-      for (const x of this.__analyticsEvents) {
+      for (const x of events) {
         Object.assign(x.properties, uaData)
       }
       // send all the events in one Mixpanel API call
@@ -100,12 +104,12 @@ export class DatabaseAPIWithAnalytics extends DatabaseAPI {
         method: 'POST',
         url: 'https://api.mixpanel.com/track',
         headers: { accept: 'text/plain' },
-        body: this.__analyticsEvents
+        body: events
       }))
     }
     const sent = []
-    for (const type of Object.keys(this.__analyticsUserProfileUpdates)) {
-      const updatesByUser = this.__analyticsUserProfileUpdates[type]
+    for (const type of Object.keys(userProfileUpdates)) {
+      const updatesByUser = userProfileUpdates[type]
       const body = []
       for (const uid of Object.keys(updatesByUser)) {
         const updates = updatesByUser[uid]

package/src/placeholder.js

@@ -54,12 +54,18 @@ export class TestAnalyticsAPI extends DatabaseAPIWithAnalytics {
   async computeResponse () {
     // istanbul ignore next
     assert(isUnitTesting || isLocalhost)
-    const { eventCalls, profileUpdates } = this.req.body
+    const { eventCalls, profileUpdates, moreEventCalls } = this.req.body
     for (const x of (eventCalls ?? [])) {
       this.logAnalyticsEvent(...x)
     }
     for (const x of (profileUpdates ?? [])) {
       this.updateAnalyticsUserProfile(...x)
     }
+    if (moreEventCalls) {
+      await this.sendAnalyticsEvents()
+      for (const x of moreEventCalls) {
+        this.logAnalyticsEvent(...x)
+      }
+    }
   }
 }

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'
@@ -63,6 +65,39 @@ class AnalyticsTest extends AppTest {
     }).expect(expRespCode)
   }
 
+  async testSendInBatches () {
+    await this.app.post('/analytics')
+      .send({
+        eventCalls: [
+          ['xyz', 'some event', { cool: 1, hi: 'world' }]
+        ],
+        moreEventCalls: [
+          ['xyz', 'another event', { x: 2 }]
+        ]
+      }).expect(200)
+    const calls = this.fetchMock.mock.calls
+    expect(calls.length).toBe(2)
+    const actualBody = JSON.parse(calls[0][1].body)
+    expect(actualBody).toEqual([{
+      event: 'some event',
+      properties: expect.objectContaining({
+        cool: 1,
+        hi: 'world',
+        $user_id: 'xyz',
+        token: mixpanelToken
+      })
+    }])
+    const actualBody2 = JSON.parse(calls[1][1].body)
+    expect(actualBody2).toEqual([{
+      event: 'another event',
+      properties: expect.objectContaining({
+        x: 2,
+        $user_id: 'xyz',
+        token: mixpanelToken
+      })
+    }])
+  }
+
   async testDeviceId () {
     await this.app.post('/analytics')
       .send({
@@ -106,6 +141,47 @@ class AnalyticsTest extends AppTest {
     }])
   }
 
+  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
+      })
+    }])
+  }
+
   async testUserAgent () {
     await this.sendBasicEvent('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36')
     const calls = this.fetchMock.mock.calls