feat: Include basic app usage analytics

.env.template

@@ -0,0 +1,2 @@
+GA4_ID=string;
+GA4_SECRET=string;

.github/workflows/release.yml

@@ -59,6 +59,8 @@ jobs:
           APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
           WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GA4_ID: ${{ secrets.GA4_ID }}
+          GA4_SECRET: ${{ secrets.GA4_SECRET }}
 
   windows:
     name: Publish windows app to release

package.json

@@ -90,6 +90,7 @@
     "crypto-browserify": "^3.12.0",
     "csv-parse": "^5.5.6",
     "csv-stringify": "^6.5.0",
+    "electron-google-analytics4": "^1.2.0",
     "electron-log": "^5.1.5",
     "electron-squirrel-startup": "^1.0.1",
     "electron-store": "^9.0.0",
@@ -100,6 +101,8 @@
     "humanize-duration": "^3.32.1",
     "immer": "^10.1.1",
     "ky": "^1.3.0",
+    "md5": "^2.3.0",
+    "node-machine-id": "^1.1.12",
     "os-browserify": "^0.3.0",
     "os-name": "^6.0.0",
     "path-browserify": "^1.0.1",

src/main.js

@@ -8,6 +8,7 @@ import logger from 'electron-log/main';
 import ElectronSquirrelStartup from 'electron-squirrel-startup';
 import * as Sentry from '@sentry/electron/main';
 
+import './services/analytics.js';
 import './services/errors.js';
 import './services/config.js';
 import './services/csv.js';

src/pages/Data.jsx

@@ -30,7 +30,7 @@ export default function Data() {
   const [error, setError] = useState();
   const [validation, setValidation] = useState('idle');
 
-  const onDrop = async (files) => {
+  const onDrop = async (files, _, event) => {
     if (!files) {
       geocodeDispatch({
         type: 'RESET',
@@ -40,6 +40,11 @@ export default function Data() {
       return;
     }
 
+    window.ugrc.trackEvent({
+      category: 'file-selection-type',
+      label: event.type === 'drop' ? 'drag-and-drop' : 'file-dialog',
+    });
+
     const file = files[0];
     setError();
     let stats;

src/pages/Error.jsx

@@ -3,6 +3,10 @@ import * as Sentry from '@sentry/electron/renderer';
 
 export default function Error({ error, children }) {
   Sentry.captureException(error);
+  window.ugrc.trackEvent({
+    category: 'error',
+    label: 'unhandled error',
+  });
 
   return (
     <article>

src/preload.js

@@ -21,4 +21,6 @@ contextBridge.exposeInMainWorld('ugrc', {
   relaunchApp: () => ipcRenderer.send('relaunchApp'),
   openIssue: (content) => ipcRenderer.send('openIssue', content),
   openEmail: (content) => ipcRenderer.send('openEmail', content),
+
+  trackEvent: (content) => ipcRenderer.send('trackEvent', content),
 });

src/services/analytics.js

@@ -0,0 +1,25 @@
+import { ipcMain } from 'electron';
+import machineId from 'node-machine-id';
+import Analytics from 'electron-google-analytics4';
+
+const { machineIdSync } = machineId;
+const id = machineIdSync();
+const visitor = new Analytics(process.env.GA4_ID, process.env.GA4_SECRET, id);
+
+visitor.event({ ec: 'application-open', ea: id, el: process.platform });
+visitor.event({ ec: 'client-version', ea: id, el: process.version });
+
+//* main thread functions
+export const trackEvent = ({ category, action = id, label }) => {
+  visitor.event({
+    ec: category,
+    ea: action,
+    el: label,
+  });
+};
+
+//* renderer events
+ipcMain.on('trackEvent', (_, content) => {
+  console.log(content);
+  trackEvent(content);
+});

src/services/geocode.js

@@ -6,6 +6,7 @@ import log from 'electron-log/main';
 import { parse } from 'csv-parse';
 import { stringify } from 'csv-stringify';
 import ky from 'ky';
+import { trackEvent } from './analytics';
 // import '../../tests/mocks/server';
 
 const __filename = url.fileURLToPath(import.meta.url);
@@ -80,6 +81,7 @@ export const checkApiKey = async (apiKey) => {
 
   const isValid = response.status === 200;
 
+  trackEvent({ category: 'api-key-check', label: isValid });
   console.log({ category: 'api-key-check', label: isValid });
 
   return isValid;
@@ -112,6 +114,9 @@ export const geocode = async (event, { filePath, fields, apiKey, wkid = 26912, s
     },
   };
 
+  trackEvent({ category: 'geocode', label: `${totalRows}, ${md5(filePath)}` });
+  trackEvent({ category: 'wkid', label: wkid });
+
   for await (const record of parser) {
     if (cancelled) {
       log.warn('Geocoding stopping');
@@ -215,6 +220,7 @@ export const geocode = async (event, { filePath, fields, apiKey, wkid = 26912, s
 
     if (failures === fastFailLimit && fastFailLimit === rowsProcessed) {
       cancelGeocode('fail-fast');
+      trackEvent({ category: 'geocoding-cancelled', label: 'fast-fail' });
     }
 
     await coolYourJets();