fix: Add test suites for analytics files using vitest and msw

Author: gregfromstl

packages/thirdweb/src/analytics/track/connect.test.ts

@@ -0,0 +1,78 @@
+import { describe, it, expect, beforeAll, afterAll, afterEach } from "vitest";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { trackConnect } from "./connect.js";
+import type { ThirdwebClient } from "../../client/client.js";
+
+const server = setupServer(
+  http.post("https://c.thirdweb.com/event", () => {
+    return HttpResponse.json({});
+  }),
+);
+
+describe("trackConnect", () => {
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("should send a POST request with correct data", async () => {
+    const mockClient: ThirdwebClient = {
+      clientId: "test-client-id",
+      secretKey: undefined,
+    };
+
+    let requestBody: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", async (handler) => {
+        requestBody = await handler.request.json();
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackConnect({
+      client: mockClient,
+      walletType: "metamask",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+    });
+
+    expect(requestBody).toEqual({
+      source: "connectWallet",
+      action: "connect",
+      walletType: "metamask",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+    });
+  });
+
+  it("should send a POST request with correct headers", async () => {
+    const mockClient: ThirdwebClient = {
+      clientId: "test-client-id",
+      secretKey: undefined,
+    };
+
+    let requestHeaders: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", (handler) => {
+        requestHeaders = handler.request.headers;
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackConnect({
+      client: mockClient,
+      ecosystem: {
+        id: "ecosystem.test-ecosystem-id",
+        partnerId: "test-partner-id",
+      },
+      walletType: "metamask",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+    });
+
+    expect(requestHeaders.get("x-client-id")).toEqual("test-client-id");
+    expect(requestHeaders.get("x-ecosystem-id")).toEqual(
+      "ecosystem.test-ecosystem-id",
+    );
+    expect(requestHeaders.get("x-ecosystem-partner-id")).toEqual(
+      "test-partner-id",
+    );
+  });
+});

packages/thirdweb/src/analytics/track/connect.ts

@@ -1,19 +1,25 @@
+import type { Ecosystem } from "src/wallets/in-app/core/wallet/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
 import { track } from "./index.js";
 
 /**
  * @internal
  */
-export function trackConnect(args: {
+export async function trackConnect(args: {
   client: ThirdwebClient;
+  ecosystem?: Ecosystem;
   walletType: string;
   walletAddress: string;
 }) {
-  const { client, walletType, walletAddress } = args;
-  track(client, {
-    source: "connectWallet",
-    action: "connect",
-    walletType,
-    walletAddress,
+  const { client, ecosystem, walletType, walletAddress } = args;
+  return track({
+    client,
+    ecosystem,
+    data: {
+      source: "connectWallet",
+      action: "connect",
+      walletType,
+      walletAddress,
+    },
   });
 }

packages/thirdweb/src/analytics/track/index.ts

@@ -1,3 +1,4 @@
+import type { Ecosystem } from "src/wallets/in-app/core/wallet/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
 import { getClientFetch } from "../../utils/fetch.js";
 import { stringify } from "../../utils/json.js";
@@ -7,15 +8,23 @@ const ANALYTICS_ENDPOINT = "https://c.thirdweb.com/event";
 /**
  * @internal
  */
-export function track(client: ThirdwebClient, data: object) {
-  const fetch = getClientFetch(client);
+export async function track({
+  client,
+  ecosystem,
+  data,
+}: {
+  client: ThirdwebClient;
+  ecosystem?: Ecosystem;
+  data: object;
+}) {
+  const fetch = getClientFetch(client, ecosystem);
   const event = {
     source: "sdk",
     ...data,
   };
 
-  fetch(ANALYTICS_ENDPOINT, {
+  return fetch(ANALYTICS_ENDPOINT, {
     method: "POST",
     body: stringify(event),
-  }).catch(() => {});
+  }).catch(() => { });
 }

packages/thirdweb/src/analytics/track/pay.test.ts

@@ -0,0 +1,98 @@
+import { describe, it, expect, beforeAll, afterAll, afterEach } from "vitest";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { trackPayEvent } from "./pay.js";
+import type { ThirdwebClient } from "../../client/client.js";
+
+const server = setupServer(
+  http.post("https://c.thirdweb.com/event", () => {
+    return HttpResponse.json({});
+  }),
+);
+
+describe("trackPayEvent", () => {
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("should send a POST request with correct data", async () => {
+    const mockClient: ThirdwebClient = {
+      clientId: "test-client-id",
+      secretKey: undefined,
+    };
+
+    let requestBody: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", async (handler) => {
+        requestBody = await handler.request.json();
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackPayEvent({
+      client: mockClient,
+      event: "test-event",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "io.metamask",
+      fromToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      fromAmount: "1000000",
+      toToken: "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+      toAmount: "1000000",
+      chainId: 1,
+      dstChainId: 137,
+    });
+
+    expect(requestBody).toEqual({
+      source: "pay",
+      action: "test-event",
+      clientId: "test-client-id",
+      chainId: 1,
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "io.metamask",
+      tokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      amountWei: "1000000",
+      dstTokenAddress: "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+      dstChainId: 1,
+    });
+  });
+
+  it("should send a POST request with correct headers", async () => {
+    const mockClient: ThirdwebClient = {
+      clientId: "test-client-id",
+      secretKey: undefined,
+    };
+
+    let requestHeaders: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", (handler) => {
+        requestHeaders = handler.request.headers;
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackPayEvent({
+      client: mockClient,
+      ecosystem: {
+        id: "ecosystem.test-ecosystem-id",
+        partnerId: "test-partner-id",
+      },
+      event: "test-event",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "io.metamask",
+      fromToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      fromAmount: "1000000",
+      toToken: "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+      toAmount: "1000000",
+      chainId: 1,
+      dstChainId: 137,
+    });
+
+    expect(requestHeaders.get("x-client-id")).toEqual("test-client-id");
+    expect(requestHeaders.get("x-ecosystem-id")).toEqual(
+      "ecosystem.test-ecosystem-id",
+    );
+    expect(requestHeaders.get("x-ecosystem-partner-id")).toEqual(
+      "test-partner-id",
+    );
+  });
+});

packages/thirdweb/src/analytics/track/pay.ts

@@ -1,11 +1,13 @@
+import type { Ecosystem } from "src/wallets/in-app/core/wallet/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
 import { track } from "./index.js";
 
 /**
  * @internal
  */
-export function trackPayEvent(args: {
+export async function trackPayEvent(args: {
   client: ThirdwebClient;
+  ecosystem?: Ecosystem;
   event: string;
   walletAddress?: string;
   walletType?: string;
@@ -16,16 +18,20 @@ export function trackPayEvent(args: {
   chainId?: number;
   dstChainId?: number;
 }) {
-  track(args.client, {
-    source: "pay",
-    action: args.event,
-    clientId: args.client.clientId,
-    chainId: args.chainId,
-    walletAddress: args.walletAddress,
-    walletType: args.walletType,
-    tokenAddress: args.fromToken,
-    amountWei: args.fromAmount,
-    dstTokenAddress: args.toToken,
-    dstChainId: args.chainId,
+  return track({
+    client: args.client,
+    ecosystem: args.ecosystem,
+    data: {
+      source: "pay",
+      action: args.event,
+      clientId: args.client.clientId,
+      chainId: args.chainId,
+      walletAddress: args.walletAddress,
+      walletType: args.walletType,
+      tokenAddress: args.fromToken,
+      amountWei: args.fromAmount,
+      dstTokenAddress: args.toToken,
+      dstChainId: args.chainId,
+    },
   });
 }

packages/thirdweb/src/analytics/track/siwe.ts

@@ -0,0 +1,63 @@
+import type { ThirdwebClient } from "../../client/client.js";
+import { stringify } from "../../utils/json.js";
+import { track } from "./index.js";
+
+type SiweEvent = {
+  client: ThirdwebClient;
+  walletAddress?: string;
+  walletType?: string;
+  chainId?: number;
+  error?: {
+    message: string;
+    code: string;
+  };
+};
+
+type SiweSuccessEvent = SiweEvent & {
+  error?: undefined;
+};
+
+/**
+ * @internal
+ */
+export function trackLogin(event: SiweSuccessEvent) {
+  trackSiweEvent({
+    ...event,
+    type: "login:success",
+  });
+}
+
+type SiweErrorEvent = SiweEvent & {
+  error: {
+    message: string;
+    code: string;
+  };
+};
+
+/**
+ * @internal
+ */
+export function trackLoginError(event: SiweErrorEvent) {
+  trackSiweEvent({
+    ...event,
+    type: "login:error",
+  });
+}
+
+/**
+ * @internal
+ */
+function trackSiweEvent(
+  event: SiweEvent & {
+    type: "login:success" | "login:error";
+  },
+) {
+  track(event.client, {
+    action: event.type,
+    clientId: event.client.clientId,
+    chainId: event.chainId,
+    walletAddress: event.walletAddress,
+    walletType: event.walletType,
+    errorCode: stringify(event.error),
+  });
+}