@codaco/analytics 1.0.0-alpha-1 → 2.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @codaco/analytics@1.0.0-alpha-1 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> @codaco/analytics@2.0.0 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
 > tsup src/index.ts --format esm --dts --clean --sourcemap
 
 CLI Building entry: src/index.ts
@@ -8,9 +8,9 @@ CLI tsup v7.2.0
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.mjs     2.05 KB
-ESM dist/index.mjs.map 5.21 KB
-ESM ⚡️ Build success in 11ms
+ESM dist/index.mjs     4.06 KB
+ESM dist/index.mjs.map 8.47 KB
+ESM ⚡️ Build success in 123ms
 DTS Build start
-DTS ⚡️ Build success in 551ms
-DTS dist/index.d.mts 1.64 KB
+DTS ⚡️ Build success in 776ms
+DTS dist/index.d.mts 1.48 KB

package/dist/index.d.mts

@@ -5,10 +5,10 @@ type GeoLocation = {
     countryCode: string;
 };
 type AnalyticsEventBase = {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error" | string;
+    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
 };
 type AnalyticsEvent = AnalyticsEventBase & {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | string;
+    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
     metadata?: Record<string, unknown>;
 };
 type AnalyticsError = AnalyticsEventBase & {
@@ -29,15 +29,11 @@ type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
     geolocation?: GeoLocation;
 };
 type RouteHandlerConfiguration = {
-    maxMindAccountId: string;
-    maxMindLicenseKey: string;
     platformUrl?: string;
-    getInstallationId: () => Promise<string>;
-    WebServiceClient: typeof WebServiceClient;
+    installationId: string;
+    maxMindClient: WebServiceClient;
 };
-declare const createRouteHandler: ({ maxMindAccountId, maxMindLicenseKey, platformUrl, getInstallationId, WebServiceClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
-declare const makeEventTracker: ({ endpoint }: {
-    endpoint: string;
-}) => (event: AnalyticsEventOrError) => void;
+declare const createRouteHandler: ({ platformUrl, installationId, maxMindClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
+declare const makeEventTracker: (endpoint?: string) => (event: AnalyticsEventOrError) => Promise<void>;
 
 export { AnalyticsError, AnalyticsEvent, AnalyticsEventBase, AnalyticsEventOrError, AnalyticsEventOrErrorWithTimestamp, DispatchableAnalyticsEvent, createRouteHandler, makeEventTracker };

package/dist/index.mjs

@@ -16,65 +16,128 @@ function ensureError(value) {
   );
   return error;
 }
+function getBaseUrl() {
+  if (typeof window !== "undefined")
+    return "";
+  if (process.env.VERCEL_URL)
+    return `https://${process.env.VERCEL_URL}`;
+  if (process.env.NEXT_PUBLIC_URL)
+    return process.env.NEXT_PUBLIC_URL;
+  return `http://127.0.0.1:3000`;
+}
 
 // src/index.ts
 var createRouteHandler = ({
-  maxMindAccountId,
-  maxMindLicenseKey,
   platformUrl = "https://analytics.networkcanvas.com",
-  getInstallationId,
-  WebServiceClient
+  installationId,
+  maxMindClient
 }) => {
   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
+    try {
+      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
+        }
+      };
+      const response = await fetch(`${platformUrl}/api/event`, {
+        keepalive: true,
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(dispatchableEvent)
+      });
+      if (!response.ok) {
+        if (response.status === 404) {
+          console.error(
+            `Analytics platform not found. Please specify a valid platform URL.`
+          );
+        } else if (response.status === 500) {
+          console.error(
+            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`
+          );
+        } else {
+          console.error(
+            `General error when forwarding event: ${response.statusText}`
+          );
+        }
+        return new Response(
+          JSON.stringify({ error: "Internal Server Error" }),
+          {
+            status: 500,
+            headers: {
+              "Content-Type": "application/json"
+            }
+          }
+        );
       }
-    };
-    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"
-    });
+      console.info(`\u{1F680} Analytics event forwarded successfully.`);
+      console.info(JSON.stringify(dispatchableEvent, null, 2));
+      return new Response(
+        JSON.stringify({ message: "Event forwarded successfully" }),
+        {
+          status: 200,
+          headers: {
+            "Content-Type": "application/json"
+          }
+        }
+      );
+    } catch (e) {
+      const error = ensureError(e);
+      console.error("Error in route handler:", error);
+      return new Response(JSON.stringify({ error: "Internal Server Error" }), {
+        status: 500,
+        headers: {
+          "Content-Type": "application/json"
+        }
+      });
+    }
   };
 };
-var makeEventTracker = ({ endpoint }) => (event) => {
+var makeEventTracker = (endpoint = "/api/analytics") => async (event) => {
+  const endpointWithHost = getBaseUrl() + endpoint;
   const eventWithTimeStamp = {
     ...event,
     timestamp: /* @__PURE__ */ new Date()
   };
-  fetch(endpoint, {
-    method: "POST",
-    keepalive: true,
-    body: JSON.stringify(eventWithTimeStamp),
-    headers: {
-      "Content-Type": "application/json"
+  try {
+    const response = await fetch(endpointWithHost, {
+      method: "POST",
+      keepalive: true,
+      body: JSON.stringify(eventWithTimeStamp),
+      headers: {
+        "Content-Type": "application/json"
+      }
+    });
+    if (!response.ok) {
+      if (response.status === 404) {
+        console.error(
+          `Analytics endpoint not found, did you forget to add the route?`
+        );
+        return;
+      }
+      if (response.status === 500) {
+        console.error(
+          `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
+        );
+        return;
+      }
+      console.error(
+        `General error sending analytics event: ${response.statusText}`
+      );
     }
-  }).catch((e) => {
+  } catch (e) {
     const error = ensureError(e);
-    console.error("Error sending analytics event:", error.message);
-  });
+    console.error("Internal error with analytics:", error.message);
+  }
 };
 export {
   createRouteHandler,

package/dist/index.mjs.map

@@ -1 +1 @@
-{"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":[]}
+{"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\nexport function getBaseUrl() {\n  if (typeof window !== \"undefined\")\n    // browser should use relative path\n    return \"\";\n\n  if (process.env.VERCEL_URL)\n    // reference for vercel.com\n    return `https://${process.env.VERCEL_URL}`;\n\n  if (process.env.NEXT_PUBLIC_URL)\n    // Manually set deployment URL from env\n    return process.env.NEXT_PUBLIC_URL;\n\n  // assume localhost\n  return `http://127.0.0.1:3000`;\n}\n","import type { NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError, getBaseUrl } 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};\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 AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\n  timestamp: Date;\n};\n\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {\n  installationId: string;\n  geolocation?: GeoLocation;\n};\n\ntype RouteHandlerConfiguration = {\n  platformUrl?: string;\n  installationId: string;\n  maxMindClient: WebServiceClient;\n};\n\nexport const createRouteHandler = ({\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  installationId,\n  maxMindClient,\n}: RouteHandlerConfiguration) => {\n  return async (request: NextRequest) => {\n    try {\n      const event =\n        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;\n\n      const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\n        res.text()\n      );\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      // Forward to microservice\n      const response = await 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      if (!response.ok) {\n        if (response.status === 404) {\n          console.error(\n            `Analytics platform not found. Please specify a valid platform URL.`\n          );\n        } else if (response.status === 500) {\n          console.error(\n            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`\n          );\n        } else {\n          console.error(\n            `General error when forwarding event: ${response.statusText}`\n          );\n        }\n\n        return new Response(\n          JSON.stringify({ error: \"Internal Server Error\" }),\n          {\n            status: 500,\n            headers: {\n              \"Content-Type\": \"application/json\",\n            },\n          }\n        );\n      }\n\n      console.info(`🚀 Analytics event forwarded successfully.`);\n      console.info(JSON.stringify(dispatchableEvent, null, 2));\n\n      return new Response(\n        JSON.stringify({ message: \"Event forwarded successfully\" }),\n        {\n          status: 200,\n          headers: {\n            \"Content-Type\": \"application/json\",\n          },\n        }\n      );\n    } catch (e) {\n      const error = ensureError(e);\n      console.error(\"Error in route handler:\", error);\n\n      // Return an appropriate error response\n      return new Response(JSON.stringify({ error: \"Internal Server Error\" }), {\n        status: 500,\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n      });\n    }\n  };\n};\n\nexport const makeEventTracker =\n  (endpoint: string = \"/api/analytics\") =>\n  async (event: AnalyticsEventOrError) => {\n    const endpointWithHost = getBaseUrl() + endpoint;\n\n    const eventWithTimeStamp = {\n      ...event,\n      timestamp: new Date(),\n    };\n\n    try {\n      const response = await fetch(endpointWithHost, {\n        method: \"POST\",\n        keepalive: true,\n        body: JSON.stringify(eventWithTimeStamp),\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n      });\n\n      if (!response.ok) {\n        if (response.status === 404) {\n          console.error(\n            `Analytics endpoint not found, did you forget to add the route?`\n          );\n          return;\n        }\n\n        if (response.status === 500) {\n          console.error(\n            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`\n          );\n          return;\n        }\n\n        console.error(\n          `General error sending analytics event: ${response.statusText}`\n        );\n      }\n    } catch (e) {\n      const error = ensureError(e);\n\n      console.error(\"Internal error with analytics:\", 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;AAEO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW;AAEpB,WAAO;AAET,MAAI,QAAQ,IAAI;AAEd,WAAO,WAAW,QAAQ,IAAI,UAAU;AAE1C,MAAI,QAAQ,IAAI;AAEd,WAAO,QAAQ,IAAI;AAGrB,SAAO;AACT;;;ACkBO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,QACH,MAAM,QAAQ,KAAK;AAEtB,YAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,QAAK,CAAC,QACtD,IAAI,KAAK;AAAA,MACX;AAEA,YAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,YAAM,cAAc,SAAS,WAAW;AAExC,YAAM,oBAAgD;AAAA,QACpD,GAAG;AAAA,QACH;AAAA,QACA,aAAa;AAAA,UACX;AAAA,QACF;AAAA,MACF;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACvD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,MACxC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF,WAAW,SAAS,WAAW,KAAK;AAClC,kBAAQ;AAAA,YACN,sEAAsE,SAAS,UAAU;AAAA,UAC3F;AAAA,QACF,OAAO;AACL,kBAAQ;AAAA,YACN,wCAAwC,SAAS,UAAU;AAAA,UAC7D;AAAA,QACF;AAEA,eAAO,IAAI;AAAA,UACT,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC;AAAA,UACjD;AAAA,YACE,QAAQ;AAAA,YACR,SAAS;AAAA,cACP,gBAAgB;AAAA,YAClB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,cAAQ,KAAK,mDAA4C;AACzD,cAAQ,KAAK,KAAK,UAAU,mBAAmB,MAAM,CAAC,CAAC;AAEvD,aAAO,IAAI;AAAA,QACT,KAAK,UAAU,EAAE,SAAS,+BAA+B,CAAC;AAAA,QAC1D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,MAAM,2BAA2B,KAAK;AAG9C,aAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC,GAAG;AAAA,QACtE,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,IAAM,mBACX,CAAC,WAAmB,qBACpB,OAAO,UAAiC;AACtC,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,kBAAkB;AAAA,MAC7C,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN;AAAA,QACF;AACA;AAAA,MACF;AAEA,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN,uDAAuD,SAAS,UAAU;AAAA,QAC5E;AACA;AAAA,MACF;AAEA,cAAQ;AAAA,QACN,0CAA0C,SAAS,UAAU;AAAA,MAC/D;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAE3B,YAAQ,MAAM,kCAAkC,MAAM,OAAO;AAAA,EAC/D;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codaco/analytics",
-  "version": "1.0.0-alpha-1",
+  "version": "2.0.0",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "author": "Complex Data Collective <developers@coda.co>",
@@ -11,7 +11,8 @@
     "dev": "npm run build -- --watch"
   },
   "peerDependencies": {
-    "next": "13 || 14"
+    "next": "13 || 14",
+    "@maxmind/geoip2-node": "^5.0.0"
   },
   "devDependencies": {
     "eslint-config-custom": "workspace:*",
@@ -19,7 +20,5 @@
     "tsup": "^7.2.0",
     "typescript": "^5.3.2"
   },
-  "dependencies": {
-    "@maxmind/geoip2-node": "^5.0.0"
-  }
+  "dependencies": {}
 }

package/src/index.ts

@@ -1,6 +1,6 @@
 import type { NextRequest } from "next/server";
 import { WebServiceClient } from "@maxmind/geoip2-node";
-import { ensureError } from "./utils";
+import { ensureError, getBaseUrl } from "./utils";
 
 type GeoLocation = {
   countryCode: string;
@@ -12,8 +12,7 @@ export type AnalyticsEventBase = {
     | "InterviewStarted"
     | "ProtocolInstalled"
     | "AppSetup"
-    | "Error"
-    | string;
+    | "Error";
 };
 
 export type AnalyticsEvent = AnalyticsEventBase & {
@@ -21,8 +20,7 @@ export type AnalyticsEvent = AnalyticsEventBase & {
     | "InterviewCompleted"
     | "InterviewStarted"
     | "ProtocolInstalled"
-    | "AppSetup"
-    | string;
+    | "AppSetup";
   metadata?: Record<string, unknown>;
 };
 
@@ -48,83 +46,141 @@ export type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
 };
 
 type RouteHandlerConfiguration = {
-  maxMindAccountId: string;
-  maxMindLicenseKey: string;
   platformUrl?: string;
-  getInstallationId: () => Promise<string>;
-  WebServiceClient: typeof WebServiceClient;
+  installationId: string;
+  maxMindClient: WebServiceClient;
 };
 
 export const createRouteHandler = ({
-  maxMindAccountId,
-  maxMindLicenseKey,
   platformUrl = "https://analytics.networkcanvas.com",
-  getInstallationId,
-  WebServiceClient,
+  installationId,
+  maxMindClient,
 }: RouteHandlerConfiguration) => {
   return async (request: NextRequest) => {
-    const maxMindClient = new WebServiceClient(
-      maxMindAccountId,
-      maxMindLicenseKey,
-      {
-        host: "geolite.info",
+    try {
+      const event =
+        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;
+
+      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: DispatchableAnalyticsEvent = {
+        ...event,
+        installationId,
+        geolocation: {
+          countryCode,
+        },
+      };
+
+      // Forward to microservice
+      const response = await fetch(`${platformUrl}/api/event`, {
+        keepalive: true,
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(dispatchableEvent),
+      });
+
+      if (!response.ok) {
+        if (response.status === 404) {
+          console.error(
+            `Analytics platform not found. Please specify a valid platform URL.`
+          );
+        } else if (response.status === 500) {
+          console.error(
+            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`
+          );
+        } else {
+          console.error(
+            `General error when forwarding event: ${response.statusText}`
+          );
+        }
+
+        return new Response(
+          JSON.stringify({ error: "Internal Server Error" }),
+          {
+            status: 500,
+            headers: {
+              "Content-Type": "application/json",
+            },
+          }
+        );
       }
-    );
-
-    const installationId = await getInstallationId();
-
-    const event = (await request.json()) as AnalyticsEventOrErrorWithTimestamp;
-
-    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: DispatchableAnalyticsEvent = {
-      ...event,
-      installationId,
-      geolocation: {
-        countryCode,
-      },
-    };
-
-    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",
-    });
+      console.info(`🚀 Analytics event forwarded successfully.`);
+      console.info(JSON.stringify(dispatchableEvent, null, 2));
+
+      return new Response(
+        JSON.stringify({ message: "Event forwarded successfully" }),
+        {
+          status: 200,
+          headers: {
+            "Content-Type": "application/json",
+          },
+        }
+      );
+    } catch (e) {
+      const error = ensureError(e);
+      console.error("Error in route handler:", error);
+
+      // Return an appropriate error response
+      return new Response(JSON.stringify({ error: "Internal Server Error" }), {
+        status: 500,
+        headers: {
+          "Content-Type": "application/json",
+        },
+      });
+    }
   };
 };
 
 export const makeEventTracker =
-  ({ endpoint }: { endpoint: string }) =>
-  (event: AnalyticsEventOrError) => {
+  (endpoint: string = "/api/analytics") =>
+  async (event: AnalyticsEventOrError) => {
+    const endpointWithHost = getBaseUrl() + endpoint;
+
     const eventWithTimeStamp = {
       ...event,
       timestamp: new Date(),
     };
 
-    fetch(endpoint, {
-      method: "POST",
-      keepalive: true,
-      body: JSON.stringify(eventWithTimeStamp),
-      headers: {
-        "Content-Type": "application/json",
-      },
-    }).catch((e) => {
+    try {
+      const response = await fetch(endpointWithHost, {
+        method: "POST",
+        keepalive: true,
+        body: JSON.stringify(eventWithTimeStamp),
+        headers: {
+          "Content-Type": "application/json",
+        },
+      });
+
+      if (!response.ok) {
+        if (response.status === 404) {
+          console.error(
+            `Analytics endpoint not found, did you forget to add the route?`
+          );
+          return;
+        }
+
+        if (response.status === 500) {
+          console.error(
+            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
+          );
+          return;
+        }
+
+        console.error(
+          `General error sending analytics event: ${response.statusText}`
+        );
+      }
+    } catch (e) {
       const error = ensureError(e);
 
-      // eslint-disable-next-line no-console
-      console.error("Error sending analytics event:", error.message);
-    });
+      console.error("Internal error with analytics:", error.message);
+    }
   };

package/src/utils.ts

@@ -17,3 +17,20 @@ export function ensureError(value: unknown): Error {
   );
   return error;
 }
+
+export function getBaseUrl() {
+  if (typeof window !== "undefined")
+    // browser should use relative path
+    return "";
+
+  if (process.env.VERCEL_URL)
+    // reference for vercel.com
+    return `https://${process.env.VERCEL_URL}`;
+
+  if (process.env.NEXT_PUBLIC_URL)
+    // Manually set deployment URL from env
+    return process.env.NEXT_PUBLIC_URL;
+
+  // assume localhost
+  return `http://127.0.0.1:3000`;
+}