feat: Add SIWE tracking test suite

Author: gregfromstl

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

@@ -0,0 +1,110 @@
+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:attempt",
+			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:attempt",
+			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

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