@codaco/analytics 0.5.0-alpha → 1.0.0-alpha-1

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
-> @codaco/analytics@0.5.0-alpha build /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics
-> tsup src/index.ts --format esm --dts --minify --clean --sourcemap
+> @codaco/analytics@1.0.0-alpha-1 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> tsup src/index.ts --format esm --dts --clean --sourcemap
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
@@ -8,9 +8,9 @@ CLI tsup v7.2.0
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.mjs     1.73 KB
-ESM dist/index.mjs.map 6.35 KB
-ESM ⚡️ Build success in 16ms
+ESM dist/index.mjs     2.05 KB
+ESM dist/index.mjs.map 5.21 KB
+ESM ⚡️ Build success in 11ms
 DTS Build start
-DTS ⚡️ Build success in 733ms
-DTS dist/index.d.mts 1.49 KB
+DTS ⚡️ Build success in 551ms
+DTS dist/index.d.mts 1.64 KB

package/.turbo/turbo-test.log

@@ -0,0 +1,31 @@
+
+> @codaco/analytics@0.6.0-alpha test /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> NODE_OPTIONS=--experimental-vm-modules jest "--watch"
+
+(node:55883) ExperimentalWarning: VM Modules is an experimental feature and might change at any time
+(Use `node --trace-warnings ...` to show where the warning was created)
+FAIL src/index.test.mjs
+  Analytics client package
+    ✕ should be able to create a new client (1 ms)
+
+  ● Analytics client package › should be able to create a new client
+
+    TypeError: Cannot read properties of undefined (reading 'platformUrl')
+
+      50 |   private platformUrl?: string = "https://analytics.networkcanvas.dev";
+      51 |   private installationId: string | null = null;
+    > 52 |
+         | ^
+      53 |   private dispatchQueue: QueueObject<AnalyticsEventOrError>;
+      54 |
+      55 |   private enabled: boolean = true;
+
+      at new s (src/index.ts:52:11)
+      at Object.<anonymous> (src/index.test.mjs:6:20)
+
+Test Suites: 1 failed, 1 total
+Tests:       1 failed, 1 total
+Snapshots:   0 total
+Time:        0.215 s, estimated 1 s
+Ran all test suites related to changed files.
+

package/README.md

@@ -2,40 +2,8 @@
 
 This npm package implements methods and types for sending analytics and errors from Fresco instances to a custom error and analytics microservice.
 
-It exports two methods:
+It exports two functions:
 
-1. trackEvent - sends an event payload to the microservice.
+**createRouteHandler** - A function that creates a NextJs route handler which geolocates requests, and forwards the event payload to the microservice.
 
-```ts
-type EventPayload = {
-  type:
-    | "InterviewCompleted"
-    | "InterviewStarted"
-    | "ProtocolInstalled"
-    | "AppSetup";
-  metadata?: string;
-  timestamp?: string;
-  isocode?: string;
-  installationid: string;
-};
-
-trackEvent(event: EventPayload);
-
-```
-
-2. trackError - sends an error payload to the microservice.
-
-```ts
-type ErrorPayload = {
-  code: number;
-  message: string;
-  details: string;
-  stacktrace: string;
-  installationid: string;
-  timestamp?: string;
-  path: string;
-};
-
-trackError(error: ErrorPayload);
-
-```
+**makeEventTracker** - A function that returns a `trackEvent` function, which attaches timestamp data to an event, and then calls the route handler.

package/dist/index.d.mts

@@ -1,14 +1,14 @@
-import { WebServiceClient } from '@maxmind/geoip2-node';
 import { NextRequest } from 'next/server';
+import { WebServiceClient } from '@maxmind/geoip2-node';
 
 type GeoLocation = {
     countryCode: string;
 };
 type AnalyticsEventBase = {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
+    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error" | string;
 };
 type AnalyticsEvent = AnalyticsEventBase & {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
+    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | string;
     metadata?: Record<string, unknown>;
 };
 type AnalyticsError = AnalyticsEventBase & {
@@ -21,26 +21,23 @@ type AnalyticsError = AnalyticsEventBase & {
     };
 };
 type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
-type DispatchableAnalyticsEvent = AnalyticsEventOrError & {
+type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
+    timestamp: Date;
+};
+type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
     installationId: string;
     geolocation?: GeoLocation;
-    timestamp: Date;
 };
-type AnalyticsClientConfiguration = {
+type RouteHandlerConfiguration = {
+    maxMindAccountId: string;
+    maxMindLicenseKey: string;
     platformUrl?: string;
+    getInstallationId: () => Promise<string>;
+    WebServiceClient: typeof WebServiceClient;
 };
-declare class AnalyticsClient {
-    private platformUrl?;
-    private installationId;
-    private dispatchQueue;
-    private enabled;
-    constructor(configuration: AnalyticsClientConfiguration);
-    createRouteHandler: (maxMindClient: WebServiceClient) => (req: NextRequest) => Promise<Response>;
-    private processEvent;
-    trackEvent(payload: AnalyticsEventOrError): void;
-    setInstallationId(installationId: string): void;
-    disable(): void;
-    get isEnabled(): boolean;
-}
+declare const createRouteHandler: ({ maxMindAccountId, maxMindLicenseKey, platformUrl, getInstallationId, WebServiceClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
+declare const makeEventTracker: ({ endpoint }: {
+    endpoint: string;
+}) => (event: AnalyticsEventOrError) => void;
 
-export { AnalyticsClient, AnalyticsError, AnalyticsEvent, AnalyticsEventBase, AnalyticsEventOrError, DispatchableAnalyticsEvent };
+export { AnalyticsError, AnalyticsEvent, AnalyticsEventBase, AnalyticsEventOrError, AnalyticsEventOrErrorWithTimestamp, DispatchableAnalyticsEvent, createRouteHandler, makeEventTracker };

package/dist/index.mjs

@@ -1,2 +1,83 @@
-import{queue as o}from"async";var s=class{platformUrl="https://analytics.networkcanvas.dev";installationId=null;dispatchQueue;enabled=!0;constructor(e){e.platformUrl&&(this.platformUrl=e.platformUrl),this.dispatchQueue=o(this.processEvent,1),this.dispatchQueue.pause()}createRouteHandler=e=>async r=>{let n=(r.headers.get("x-forwarded-for")??"127.0.0.1").split(",")[0];if(n==="::1")return new Response(null,{status:200});if(!n)return console.error("No IP address provided for geolocation"),new Response(null,{status:500});try{let t=await e.country(n);return new Response(t?.country?.isoCode,{headers:{"Content-Type":"application/json"}})}catch(t){return console.error("Error getting country code",t),new Response(null,{status:500})}};processEvent=async e=>{try{let r=await fetch("api/analytics/geolocate");r.ok||console.error("Geolocation request failed");let n=await r.text(),t={...e,installationId:this.installationId??"",timestamp:new Date,geolocation:{countryCode:n??""}};if(!(await fetch(`${this.platformUrl}/api/event`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(t)})).ok){console.info(`\u{1F6AB} Event "${t.type}" failed to send to analytics microservice.`);return}console.info(`\u{1F680} Event "${t.type}" successfully sent to analytics microservice`)}catch(r){console.error("Error sending event to analytics microservice",r);return}};trackEvent(e){console.info(`\u{1F560} Event ${e.type} queued for dispatch...`),this.dispatchQueue.push(e)}setInstallationId(e){this.enabled&&(this.installationId=e),this.dispatchQueue.resume()}disable(){console.info("\u{1F4C8} Analytics disabled"),this.enabled=!1,this.dispatchQueue.pause()}get isEnabled(){return this.enabled}};export{s as AnalyticsClient};
+// src/utils.ts
+function ensureError(value) {
+  if (!value)
+    return new Error("No value was thrown");
+  if (value instanceof Error)
+    return value;
+  if (value.isPrototypeOf(Error))
+    return value;
+  let stringified = "[Unable to stringify the thrown value]";
+  try {
+    stringified = JSON.stringify(value);
+  } catch {
+  }
+  const error = new Error(
+    `This value was thrown as is, not through an Error: ${stringified}`
+  );
+  return error;
+}
+
+// src/index.ts
+var createRouteHandler = ({
+  maxMindAccountId,
+  maxMindLicenseKey,
+  platformUrl = "https://analytics.networkcanvas.com",
+  getInstallationId,
+  WebServiceClient
+}) => {
+  return async (request) => {
+    const maxMindClient = new WebServiceClient(
+      maxMindAccountId,
+      maxMindLicenseKey,
+      {
+        host: "geolite.info"
+      }
+    );
+    const installationId = await getInstallationId();
+    const event = await request.json();
+    const ip = await fetch("https://api64.ipify.org").then((res) => res.text());
+    const { country } = await maxMindClient.country(ip);
+    const countryCode = country?.isoCode ?? "Unknown";
+    const dispatchableEvent = {
+      ...event,
+      installationId,
+      geolocation: {
+        countryCode
+      }
+    };
+    console.log(dispatchableEvent);
+    void fetch(`${platformUrl}/api/event`, {
+      keepalive: true,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(dispatchableEvent)
+    });
+    return Response.json({
+      message: "This is the API route"
+    });
+  };
+};
+var makeEventTracker = ({ endpoint }) => (event) => {
+  const eventWithTimeStamp = {
+    ...event,
+    timestamp: /* @__PURE__ */ new Date()
+  };
+  fetch(endpoint, {
+    method: "POST",
+    keepalive: true,
+    body: JSON.stringify(eventWithTimeStamp),
+    headers: {
+      "Content-Type": "application/json"
+    }
+  }).catch((e) => {
+    const error = ensureError(e);
+    console.error("Error sending analytics event:", error.message);
+  });
+};
+export {
+  createRouteHandler,
+  makeEventTracker
+};
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { QueueObject, queue } from \"async\";\nimport type { NextRequest } from \"next/server\";\n\ntype GeoLocation = {\n  countryCode: string;\n};\n\nexport type AnalyticsEventBase = {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\"\n    | \"Error\";\n};\n\nexport type AnalyticsEvent = AnalyticsEventBase & {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\";\n  metadata?: Record<string, unknown>;\n};\n\nexport type AnalyticsError = AnalyticsEventBase & {\n  type: \"Error\";\n  error: {\n    message: string;\n    details: string;\n    stacktrace: string;\n    path: string;\n  };\n};\n\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\n\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrError & {\n  installationId: string;\n  geolocation?: GeoLocation;\n  timestamp: Date;\n};\n\ntype AnalyticsClientConfiguration = {\n  platformUrl?: string;\n};\n\nexport class AnalyticsClient {\n  private platformUrl?: string = \"https://analytics.networkcanvas.dev\";\n  private installationId: string | null = null;\n\n  private dispatchQueue: QueueObject<AnalyticsEventOrError>;\n\n  private enabled: boolean = true;\n\n  constructor(configuration: AnalyticsClientConfiguration) {\n    if (configuration.platformUrl) {\n      this.platformUrl = configuration.platformUrl;\n    }\n\n    this.dispatchQueue = queue(this.processEvent, 1);\n    this.dispatchQueue.pause(); // Start the queue paused so we can set the installation ID\n  }\n\n  public createRouteHandler =\n    (maxMindClient: WebServiceClient) =>\n    async (req: NextRequest): Promise<Response> => {\n      const ip = (req.headers.get(\"x-forwarded-for\") ?? \"127.0.0.1\").split(\n        \",\"\n      )[0];\n\n      if (ip === \"::1\") {\n        // This is a localhost request, so we can't geolocate it.\n        return new Response(null, { status: 200 });\n      }\n\n      if (!ip) {\n        console.error(\"No IP address provided for geolocation\");\n        return new Response(null, { status: 500 });\n      }\n\n      try {\n        const response = await maxMindClient.country(ip);\n\n        return new Response(response?.country?.isoCode, {\n          headers: {\n            \"Content-Type\": \"application/json\",\n          },\n        });\n      } catch (error) {\n        // eslint-disable-next-line no-console\n        console.error(\"Error getting country code\", error);\n        return new Response(null, { status: 500 });\n      }\n    };\n\n  private processEvent = async (event: AnalyticsEventOrError) => {\n    // Todo: we need to think about client vs server geolocation. If we want\n    // client, does this get us that? If we want server, we can get it once,\n    // and simply store it.\n    // Todo: use fetchWithZod?\n    try {\n      const response = await fetch(\"api/analytics/geolocate\");\n      if (!response.ok) {\n        console.error(\"Geolocation request failed\");\n      }\n\n      const countryCode: string | null = await response.text();\n\n      const eventWithRequiredProperties: DispatchableAnalyticsEvent = {\n        ...event,\n        installationId: this.installationId ?? \"\",\n        timestamp: new Date(),\n        geolocation: {\n          countryCode: countryCode ?? \"\",\n        },\n      };\n\n      // We could validate against a zod schema here.\n\n      // Send event to microservice.\n\n      const result = await fetch(`${this.platformUrl}/api/event`, {\n        method: \"POST\",\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n        body: JSON.stringify(eventWithRequiredProperties),\n      });\n\n      if (!result.ok) {\n        console.info(\n          `🚫 Event \"${eventWithRequiredProperties.type}\" failed to send to analytics microservice.`\n        );\n        return;\n      }\n\n      console.info(\n        `🚀 Event \"${eventWithRequiredProperties.type}\" successfully sent to analytics microservice`\n      );\n    } catch (error) {\n      console.error(\"Error sending event to analytics microservice\", error);\n      return;\n    }\n  };\n\n  public trackEvent(payload: AnalyticsEventOrError) {\n    console.info(`🕠 Event ${payload.type} queued for dispatch...`);\n    this.dispatchQueue.push(payload);\n  }\n\n  public setInstallationId(installationId: string) {\n    if (this.enabled) {\n      this.installationId = installationId;\n    }\n    this.dispatchQueue.resume();\n  }\n\n  public disable() {\n    console.info(\"📈 Analytics disabled\");\n    this.enabled = false;\n    this.dispatchQueue.pause();\n  }\n\n  get isEnabled() {\n    return this.enabled;\n  }\n}\n"],"mappings":"AACA,OAAsB,SAAAA,MAAa,QA+C5B,IAAMC,EAAN,KAAsB,CACnB,YAAuB,sCACvB,eAAgC,KAEhC,cAEA,QAAmB,GAE3B,YAAYC,EAA6C,CACnDA,EAAc,cAChB,KAAK,YAAcA,EAAc,aAGnC,KAAK,cAAgBF,EAAM,KAAK,aAAc,CAAC,EAC/C,KAAK,cAAc,MAAM,CAC3B,CAEO,mBACJG,GACD,MAAOC,GAAwC,CAC7C,IAAMC,GAAMD,EAAI,QAAQ,IAAI,iBAAiB,GAAK,aAAa,MAC7D,GACF,EAAE,CAAC,EAEH,GAAIC,IAAO,MAET,OAAO,IAAI,SAAS,KAAM,CAAE,OAAQ,GAAI,CAAC,EAG3C,GAAI,CAACA,EACH,eAAQ,MAAM,wCAAwC,EAC/C,IAAI,SAAS,KAAM,CAAE,OAAQ,GAAI,CAAC,EAG3C,GAAI,CACF,IAAMC,EAAW,MAAMH,EAAc,QAAQE,CAAE,EAE/C,OAAO,IAAI,SAASC,GAAU,SAAS,QAAS,CAC9C,QAAS,CACP,eAAgB,kBAClB,CACF,CAAC,CACH,OAASC,EAAO,CAEd,eAAQ,MAAM,6BAA8BA,CAAK,EAC1C,IAAI,SAAS,KAAM,CAAE,OAAQ,GAAI,CAAC,CAC3C,CACF,EAEM,aAAe,MAAOC,GAAiC,CAK7D,GAAI,CACF,IAAMF,EAAW,MAAM,MAAM,yBAAyB,EACjDA,EAAS,IACZ,QAAQ,MAAM,4BAA4B,EAG5C,IAAMG,EAA6B,MAAMH,EAAS,KAAK,EAEjDI,EAA0D,CAC9D,GAAGF,EACH,eAAgB,KAAK,gBAAkB,GACvC,UAAW,IAAI,KACf,YAAa,CACX,YAAaC,GAAe,EAC9B,CACF,EAcA,GAAI,EARW,MAAM,MAAM,GAAG,KAAK,WAAW,aAAc,CAC1D,OAAQ,OACR,QAAS,CACP,eAAgB,kBAClB,EACA,KAAM,KAAK,UAAUC,CAA2B,CAClD,CAAC,GAEW,GAAI,CACd,QAAQ,KACN,oBAAaA,EAA4B,IAAI,6CAC/C,EACA,MACF,CAEA,QAAQ,KACN,oBAAaA,EAA4B,IAAI,+CAC/C,CACF,OAASH,EAAO,CACd,QAAQ,MAAM,gDAAiDA,CAAK,EACpE,MACF,CACF,EAEO,WAAWI,EAAgC,CAChD,QAAQ,KAAK,mBAAYA,EAAQ,IAAI,yBAAyB,EAC9D,KAAK,cAAc,KAAKA,CAAO,CACjC,CAEO,kBAAkBC,EAAwB,CAC3C,KAAK,UACP,KAAK,eAAiBA,GAExB,KAAK,cAAc,OAAO,CAC5B,CAEO,SAAU,CACf,QAAQ,KAAK,8BAAuB,EACpC,KAAK,QAAU,GACf,KAAK,cAAc,MAAM,CAC3B,CAEA,IAAI,WAAY,CACd,OAAO,KAAK,OACd,CACF","names":["queue","AnalyticsClient","configuration","maxMindClient","req","ip","response","error","event","countryCode","eventWithRequiredProperties","payload","installationId"]}
+{"version":3,"sources":["../src/utils.ts","../src/index.ts"],"sourcesContent":["// Helper function that ensures that a value is an Error\nexport function ensureError(value: unknown): Error {\n  if (!value) return new Error(\"No value was thrown\");\n\n  if (value instanceof Error) return value;\n\n  // Test if value inherits from Error\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\n\n  let stringified = \"[Unable to stringify the thrown value]\";\n  try {\n    stringified = JSON.stringify(value);\n  } catch {}\n\n  const error = new Error(\n    `This value was thrown as is, not through an Error: ${stringified}`\n  );\n  return error;\n}\n","import type { NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError } from \"./utils\";\n\ntype GeoLocation = {\n  countryCode: string;\n};\n\nexport type AnalyticsEventBase = {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\"\n    | \"Error\"\n    | string;\n};\n\nexport type AnalyticsEvent = AnalyticsEventBase & {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\"\n    | string;\n  metadata?: Record<string, unknown>;\n};\n\nexport type AnalyticsError = AnalyticsEventBase & {\n  type: \"Error\";\n  error: {\n    message: string;\n    details: string;\n    stacktrace: string;\n    path: string;\n  };\n};\n\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\n\nexport type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\n  timestamp: Date;\n};\n\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {\n  installationId: string;\n  geolocation?: GeoLocation;\n};\n\ntype RouteHandlerConfiguration = {\n  maxMindAccountId: string;\n  maxMindLicenseKey: string;\n  platformUrl?: string;\n  getInstallationId: () => Promise<string>;\n  WebServiceClient: typeof WebServiceClient;\n};\n\nexport const createRouteHandler = ({\n  maxMindAccountId,\n  maxMindLicenseKey,\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  getInstallationId,\n  WebServiceClient,\n}: RouteHandlerConfiguration) => {\n  return async (request: NextRequest) => {\n    const maxMindClient = new WebServiceClient(\n      maxMindAccountId,\n      maxMindLicenseKey,\n      {\n        host: \"geolite.info\",\n      }\n    );\n\n    const installationId = await getInstallationId();\n\n    const event = (await request.json()) as AnalyticsEventOrErrorWithTimestamp;\n\n    const ip = await fetch(\"https://api64.ipify.org\").then((res) => res.text());\n\n    const { country } = await maxMindClient.country(ip);\n    const countryCode = country?.isoCode ?? \"Unknown\";\n\n    const dispatchableEvent: DispatchableAnalyticsEvent = {\n      ...event,\n      installationId,\n      geolocation: {\n        countryCode,\n      },\n    };\n\n    console.log(dispatchableEvent);\n\n    // Forward to microservice\n    void fetch(`${platformUrl}/api/event`, {\n      keepalive: true,\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/json\",\n      },\n      body: JSON.stringify(dispatchableEvent),\n    });\n\n    return Response.json({\n      message: \"This is the API route\",\n    });\n  };\n};\n\nexport const makeEventTracker =\n  ({ endpoint }: { endpoint: string }) =>\n  (event: AnalyticsEventOrError) => {\n    const eventWithTimeStamp = {\n      ...event,\n      timestamp: new Date(),\n    };\n\n    fetch(endpoint, {\n      method: \"POST\",\n      keepalive: true,\n      body: JSON.stringify(eventWithTimeStamp),\n      headers: {\n        \"Content-Type\": \"application/json\",\n      },\n    }).catch((e) => {\n      const error = ensureError(e);\n\n      // eslint-disable-next-line no-console\n      console.error(\"Error sending analytics event:\", error.message);\n    });\n  };\n"],"mappings":";AACO,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,MAAM,cAAc,KAAK;AAAG,WAAO;AAEvC,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,QAAQ;AAAA,EAAC;AAET,QAAM,QAAQ,IAAI;AAAA,IAChB,sDAAsD,WAAW;AAAA,EACnE;AACA,SAAO;AACT;;;ACuCO,IAAM,qBAAqB,CAAC;AAAA,EACjC;AAAA,EACA;AAAA,EACA,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,UAAM,gBAAgB,IAAI;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,QACE,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,iBAAiB,MAAM,kBAAkB;AAE/C,UAAM,QAAS,MAAM,QAAQ,KAAK;AAElC,UAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;AAE1E,UAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,UAAM,cAAc,SAAS,WAAW;AAExC,UAAM,oBAAgD;AAAA,MACpD,GAAG;AAAA,MACH;AAAA,MACA,aAAa;AAAA,QACX;AAAA,MACF;AAAA,IACF;AAEA,YAAQ,IAAI,iBAAiB;AAG7B,SAAK,MAAM,GAAG,WAAW,cAAc;AAAA,MACrC,WAAW;AAAA,MACX,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,MACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,IACxC,CAAC;AAED,WAAO,SAAS,KAAK;AAAA,MACnB,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAEO,IAAM,mBACX,CAAC,EAAE,SAAS,MACZ,CAAC,UAAiC;AAChC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,QAAM,UAAU;AAAA,IACd,QAAQ;AAAA,IACR,WAAW;AAAA,IACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,IACvC,SAAS;AAAA,MACP,gBAAgB;AAAA,IAClB;AAAA,EACF,CAAC,EAAE,MAAM,CAAC,MAAM;AACd,UAAM,QAAQ,YAAY,CAAC;AAG3B,YAAQ,MAAM,kCAAkC,MAAM,OAAO;AAAA,EAC/D,CAAC;AACH;","names":[]}

package/jest.config.js

@@ -0,0 +1,198 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/vc/szx71k5j5sqcmrljl1w44ryddl7zmw/T/jest_pb0330",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/__tests__/**/*.[jt]s?(x)",
+    "**/?(*.)+(spec|test).m[tj]s?(x)"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+module.exports = config;

package/package.json

@@ -1,33 +1,25 @@
 {
   "name": "@codaco/analytics",
-  "version": "0.5.0-alpha",
+  "version": "1.0.0-alpha-1",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "author": "Complex Data Collective <developers@coda.co>",
   "description": "Utilities for tracking analytics and error reporting in Fresco",
-  "dependencies": {
-    "@maxmind/geoip2-node": "^5.0.0",
-    "async": "^3.2.5",
-    "zod-fetch": "^0.1.1"
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap",
+    "lint": "eslint .",
+    "dev": "npm run build -- --watch"
   },
   "peerDependencies": {
-    "next": "14.0.1"
+    "next": "13 || 14"
   },
   "devDependencies": {
-    "@types/async": "^3.2.24",
-    "@types/node": "^20.5.2",
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
-    "react": "^18.2.0",
+    "eslint-config-custom": "workspace:*",
+    "tsconfig": "workspace:*",
     "tsup": "^7.2.0",
-    "typescript": "^5.3.2",
-    "zod": "^3.22.4",
-    "eslint-config-custom": "0.0.0",
-    "tsconfig": "0.0.0"
+    "typescript": "^5.3.2"
   },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --minify --clean --sourcemap",
-    "lint": "eslint .",
-    "dev": "npm run build -- --watch"
+  "dependencies": {
+    "@maxmind/geoip2-node": "^5.0.0"
   }
-}
+}

package/src/index.ts

@@ -1,6 +1,6 @@
-import { WebServiceClient } from "@maxmind/geoip2-node";
-import { QueueObject, queue } from "async";
 import type { NextRequest } from "next/server";
+import { WebServiceClient } from "@maxmind/geoip2-node";
+import { ensureError } from "./utils";
 
 type GeoLocation = {
   countryCode: string;
@@ -12,7 +12,8 @@ export type AnalyticsEventBase = {
     | "InterviewStarted"
     | "ProtocolInstalled"
     | "AppSetup"
-    | "Error";
+    | "Error"
+    | string;
 };
 
 export type AnalyticsEvent = AnalyticsEventBase & {
@@ -20,7 +21,8 @@ export type AnalyticsEvent = AnalyticsEventBase & {
     | "InterviewCompleted"
     | "InterviewStarted"
     | "ProtocolInstalled"
-    | "AppSetup";
+    | "AppSetup"
+    | string;
   metadata?: Record<string, unknown>;
 };
 
@@ -36,134 +38,93 @@ export type AnalyticsError = AnalyticsEventBase & {
 
 export type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
 
-export type DispatchableAnalyticsEvent = AnalyticsEventOrError & {
+export type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
+  timestamp: Date;
+};
+
+export type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
   installationId: string;
   geolocation?: GeoLocation;
-  timestamp: Date;
 };
 
-type AnalyticsClientConfiguration = {
+type RouteHandlerConfiguration = {
+  maxMindAccountId: string;
+  maxMindLicenseKey: string;
   platformUrl?: string;
+  getInstallationId: () => Promise<string>;
+  WebServiceClient: typeof WebServiceClient;
 };
 
-export class AnalyticsClient {
-  private platformUrl?: string = "https://analytics.networkcanvas.dev";
-  private installationId: string | null = null;
-
-  private dispatchQueue: QueueObject<AnalyticsEventOrError>;
-
-  private enabled: boolean = true;
-
-  constructor(configuration: AnalyticsClientConfiguration) {
-    if (configuration.platformUrl) {
-      this.platformUrl = configuration.platformUrl;
-    }
+export const createRouteHandler = ({
+  maxMindAccountId,
+  maxMindLicenseKey,
+  platformUrl = "https://analytics.networkcanvas.com",
+  getInstallationId,
+  WebServiceClient,
+}: RouteHandlerConfiguration) => {
+  return async (request: NextRequest) => {
+    const maxMindClient = new WebServiceClient(
+      maxMindAccountId,
+      maxMindLicenseKey,
+      {
+        host: "geolite.info",
+      }
+    );
 
-    this.dispatchQueue = queue(this.processEvent, 1);
-    this.dispatchQueue.pause(); // Start the queue paused so we can set the installation ID
-  }
+    const installationId = await getInstallationId();
 
-  public createRouteHandler =
-    (maxMindClient: WebServiceClient) =>
-    async (req: NextRequest): Promise<Response> => {
-      const ip = (req.headers.get("x-forwarded-for") ?? "127.0.0.1").split(
-        ","
-      )[0];
+    const event = (await request.json()) as AnalyticsEventOrErrorWithTimestamp;
 
-      if (ip === "::1") {
-        // This is a localhost request, so we can't geolocate it.
-        return new Response(null, { status: 200 });
-      }
+    const ip = await fetch("https://api64.ipify.org").then((res) => res.text());
 
-      if (!ip) {
-        console.error("No IP address provided for geolocation");
-        return new Response(null, { status: 500 });
-      }
+    const { country } = await maxMindClient.country(ip);
+    const countryCode = country?.isoCode ?? "Unknown";
 
-      try {
-        const response = await maxMindClient.country(ip);
-
-        return new Response(response?.country?.isoCode, {
-          headers: {
-            "Content-Type": "application/json",
-          },
-        });
-      } catch (error) {
-        // eslint-disable-next-line no-console
-        console.error("Error getting country code", error);
-        return new Response(null, { status: 500 });
-      }
+    const dispatchableEvent: DispatchableAnalyticsEvent = {
+      ...event,
+      installationId,
+      geolocation: {
+        countryCode,
+      },
     };
 
-  private processEvent = async (event: AnalyticsEventOrError) => {
-    // Todo: we need to think about client vs server geolocation. If we want
-    // client, does this get us that? If we want server, we can get it once,
-    // and simply store it.
-    // Todo: use fetchWithZod?
-    try {
-      const response = await fetch("api/analytics/geolocate");
-      if (!response.ok) {
-        console.error("Geolocation request failed");
-      }
+    console.log(dispatchableEvent);
+
+    // Forward to microservice
+    void fetch(`${platformUrl}/api/event`, {
+      keepalive: true,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(dispatchableEvent),
+    });
+
+    return Response.json({
+      message: "This is the API route",
+    });
+  };
+};
 
-      const countryCode: string | null = await response.text();
-
-      const eventWithRequiredProperties: DispatchableAnalyticsEvent = {
-        ...event,
-        installationId: this.installationId ?? "",
-        timestamp: new Date(),
-        geolocation: {
-          countryCode: countryCode ?? "",
-        },
-      };
-
-      // We could validate against a zod schema here.
-
-      // Send event to microservice.
-
-      const result = await fetch(`${this.platformUrl}/api/event`, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(eventWithRequiredProperties),
-      });
-
-      if (!result.ok) {
-        console.info(
-          `🚫 Event "${eventWithRequiredProperties.type}" failed to send to analytics microservice.`
-        );
-        return;
-      }
+export const makeEventTracker =
+  ({ endpoint }: { endpoint: string }) =>
+  (event: AnalyticsEventOrError) => {
+    const eventWithTimeStamp = {
+      ...event,
+      timestamp: new Date(),
+    };
 
-      console.info(
-        `🚀 Event "${eventWithRequiredProperties.type}" successfully sent to analytics microservice`
-      );
-    } catch (error) {
-      console.error("Error sending event to analytics microservice", error);
-      return;
-    }
+    fetch(endpoint, {
+      method: "POST",
+      keepalive: true,
+      body: JSON.stringify(eventWithTimeStamp),
+      headers: {
+        "Content-Type": "application/json",
+      },
+    }).catch((e) => {
+      const error = ensureError(e);
+
+      // eslint-disable-next-line no-console
+      console.error("Error sending analytics event:", error.message);
+    });
   };
-
-  public trackEvent(payload: AnalyticsEventOrError) {
-    console.info(`🕠 Event ${payload.type} queued for dispatch...`);
-    this.dispatchQueue.push(payload);
-  }
-
-  public setInstallationId(installationId: string) {
-    if (this.enabled) {
-      this.installationId = installationId;
-    }
-    this.dispatchQueue.resume();
-  }
-
-  public disable() {
-    console.info("📈 Analytics disabled");
-    this.enabled = false;
-    this.dispatchQueue.pause();
-  }
-
-  get isEnabled() {
-    return this.enabled;
-  }
-}

package/src/utils.ts

@@ -0,0 +1,19 @@
+// Helper function that ensures that a value is an Error
+export function ensureError(value: unknown): Error {
+  if (!value) return new Error("No value was thrown");
+
+  if (value instanceof Error) return value;
+
+  // Test if value inherits from Error
+  if (value.isPrototypeOf(Error)) return value as Error & typeof value;
+
+  let stringified = "[Unable to stringify the thrown value]";
+  try {
+    stringified = JSON.stringify(value);
+  } catch {}
+
+  const error = new Error(
+    `This value was thrown as is, not through an Error: ${stringified}`
+  );
+  return error;
+}

package/.turbo/turbo-lint.log

@@ -1,5 +0,0 @@
-
-> @codaco/analytics@0.5.0-alpha lint /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics
-> eslint .
-
-Pages directory cannot be found at /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics/pages or /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics/src/pages. If using a custom path, please configure with the `no-html-link-for-pages` rule in your eslint config file.