feat: Add SIWE tracking test suite

Author: gregfromstl

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

@@ -0,0 +1,109 @@
+import { describe, it, expect, beforeAll, afterAll, afterEach } from "vitest";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { trackLogin, trackLoginError } from "./siwe.js";
+import type { ThirdwebClient } from "../../client/client.js";
+
+const server = setupServer(
+  http.post("https://c.thirdweb.com/event", () => {
+    return HttpResponse.json({});
+  }),
+);
+
+describe("SIWE tracking", () => {
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  const mockClient: ThirdwebClient = {
+    clientId: "test-client-id",
+    secretKey: undefined,
+  };
+
+  it("should track successful logins", async () => {
+    let requestBody: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", async (handler) => {
+        requestBody = await handler.request.json();
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackLogin({
+      client: mockClient,
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "metamask",
+      chainId: 1,
+    });
+
+    expect(requestBody).toEqual({
+      source: "sdk",
+      action: "login:success",
+      clientId: "test-client-id",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "metamask",
+      chainId: 1,
+      errorCode: undefined,
+    });
+  });
+
+  it("should track login errors", async () => {
+    let requestBody: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", async (handler) => {
+        requestBody = await handler.request.json();
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackLoginError({
+      client: mockClient,
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "metamask",
+      chainId: 1,
+      error: {
+        message: "Signature verification failed",
+        code: "SIGNATURE_VERIFICATION_FAILED",
+      },
+    });
+
+    expect(requestBody).toEqual({
+      source: "sdk",
+      action: "login:error",
+      clientId: "test-client-id",
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "metamask",
+      chainId: 1,
+      errorCode: '{"message":"Signature verification failed","code":"SIGNATURE_VERIFICATION_FAILED"}',
+    });
+  });
+
+  it("should send a POST request with correct headers", async () => {
+    let requestHeaders: any;
+    server.use(
+      http.post("https://c.thirdweb.com/event", (handler) => {
+        requestHeaders = handler.request.headers;
+        return HttpResponse.json({});
+      }),
+    );
+
+    await trackLogin({
+      client: mockClient,
+      ecosystem: {
+        id: "ecosystem.test-ecosystem-id",
+        partnerId: "test-partner-id",
+      },
+      walletAddress: "0x1234567890123456789012345678901234567890",
+      walletType: "metamask",
+      chainId: 1,
+    });
+
+    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/siwe.ts

@@ -22,8 +22,8 @@ type SiweSuccessEvent = SiweEvent & {
 /**
  * @internal
  */
-export function trackLogin(event: SiweSuccessEvent) {
-  trackSiweEvent({
+export async function trackLogin(event: SiweSuccessEvent) {
+  return trackSiweEvent({
     ...event,
     type: "login:success",
   });
@@ -39,8 +39,8 @@ type SiweErrorEvent = SiweEvent & {
 /**
  * @internal
  */
-export function trackLoginError(event: SiweErrorEvent) {
-  trackSiweEvent({
+export async function trackLoginError(event: SiweErrorEvent) {
+  return trackSiweEvent({
     ...event,
     type: "login:error",
   });
@@ -49,12 +49,12 @@ export function trackLoginError(event: SiweErrorEvent) {
 /**
  * @internal
  */
-function trackSiweEvent(
+async function trackSiweEvent(
   event: SiweEvent & {
     type: "login:success" | "login:error";
   },
 ) {
-  track({
+  return track({
     client: event.client,
     ecosystem: event.ecosystem,
     data: {