Merge pull request #4386 from FlowFuse/4381-invites-posthog

Track server-side invitation events with PostHog

Author: Steve-Mcl

forge/db/controllers/Invitation.js

@@ -128,6 +128,14 @@ module.exports = {
             invitor,
             role
         })
+
+        // record acceptance in product analytics tool
+        app.product.capture(invitedUser.email, '$ff-invite-accepted', {
+            'accepted-at': new Date().toISOString(),
+            'invite-id': invitation.hashid
+        }, {
+            team: invitation.team.hashid
+        })
     },
 
     rejectInvitation: async (app, invitation, user) => {

forge/forge.js

@@ -16,6 +16,7 @@ const housekeeper = require('./housekeeper')
 const license = require('./licensing')
 const notifications = require('./notifications')
 const postoffice = require('./postoffice')
+const product = require('./product')
 const routes = require('./routes')
 const settings = require('./settings')
 const { finishSetup } = require('./setup')
@@ -438,6 +439,8 @@ module.exports = async (options = {}) => {
         // Post Office : handles email
         await server.register(postoffice)
         await server.register(notifications)
+        // Product service handles reporting to PostHog
+        await server.register(product, runtimeConfig.telemetry.frontend?.posthog)
         // Comms : real-time communication broker
         await server.register(comms)
         // Containers:

forge/product/index.js

@@ -0,0 +1,28 @@
+const fp = require('fastify-plugin')
+const { PostHog } = require('posthog-node')
+
+module.exports = fp(async function (app, _opts) {
+    let client
+    if (_opts && _opts.apikey) {
+        const apiHost = _opts?.apiurl || 'https://app.posthog.com'
+        const apiKey = _opts?.apikey
+        const options = {
+            host: apiHost
+        }
+
+        client = new PostHog(apiKey, options)
+    }
+
+    function capture (distinctId, event, properties, groups) {
+        if (client) {
+            if (!properties) {
+                properties = {}
+            }
+            client.capture({ distinctId, event, properties, groups })
+        }
+    }
+
+    app.decorate('product', {
+        capture
+    })
+}, { name: 'app.product' })

forge/routes/ui/index.js

@@ -43,6 +43,7 @@ module.exports = async function (app) {
             }
 
             if (telemetry.frontend.posthog?.apikey) {
+                // add to frontend
                 const apihost = telemetry.frontend.posthog.apiurl || 'https://app.posthog.com'
                 const apikey = telemetry.frontend.posthog.apikey
                 const options = {

frontend/src/api/user.js

@@ -104,12 +104,6 @@ const getTeamInvitations = async () => {
 }
 const acceptTeamInvitation = async (invitationId, teamId) => {
     return client.patch('/api/v1/user/invitations/' + invitationId).then(res => {
-        product.capture('$ff-invite-accepted', {
-            'invite-id': invitationId,
-            'accepted-at': (new Date()).toISOString()
-        }, {
-            team: teamId
-        })
         return res.data
     })
 }

package-lock.json

@@ -95,6 +95,7 @@
         "pg": "^8.11.3",
         "pino": "^8.15.1",
         "pino-pretty": "^10.0.0",
+        "posthog-node": "^4.2.0",
         "qrcode": "^1.5.3",
         "random-words": "~2.0.0",
         "semver": "~7.6.0",