fix: issues in tests

Author: michalkvasnicak

packages/frames.js/src/core/composeMiddleware.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/require-await -- we expect promises */
 import { composeMiddleware } from "./composeMiddleware";
 
 describe("composeMiddleware", () => {
@@ -11,7 +12,7 @@ describe("composeMiddleware", () => {
     const context = { a: 1 };
 
     const composedMiddleware = composeMiddleware<typeof context, unknown>([
-      (ctx, next) => {
+      async (ctx, next) => {
         ctx.a = 2;
         return next();
       },

packages/frames.js/src/getAddressForFid.ts

@@ -40,7 +40,7 @@ export async function getAddressForFid<
       throw new Error(
         `Failed to parse response body as JSON because server hub returned response with status "${response.status}" and body "${await response.clone().text()}"`
       );
-    })) as { messages?: Record<string, any>[] };
+    })) as { messages?: Record<string, unknown>[] };
 
   let address: AddressReturnType<Options> | null = null;
 
@@ -55,7 +55,11 @@ export async function getAddressForFid<
     }
   }
 
-  if (!address && fallbackToCustodyAddress) {
+  if (address) {
+    return address;
+  }
+
+  if (fallbackToCustodyAddress) {
     const publicClient = createPublicClient({
       transport: http(),
       chain: optimism,
@@ -69,9 +73,5 @@ export async function getAddressForFid<
     });
   }
 
-  if (!address) {
-    throw new Error(`No address found for fid ${fid}`);
-  }
-
-  return address as AddressReturnType<Options>;
+  return address as unknown as AddressReturnType<Options>;
 }

packages/frames.js/src/getAddressesForFid.ts

@@ -51,7 +51,7 @@ export async function getAddressesForFid({
       throw new Error(
         `Failed to parse response body as JSON because server hub returned response with status "${verificationsResponse.status}" and body "${await verificationsResponse.clone().text()}"`
       );
-    })) as { messages?: Record<string, any>[] };
+    })) as { messages?: Record<string, unknown>[] };
 
   if (messages) {
     const verifiedAddresses = messages

packages/frames.js/src/middleware/farcaster.test.ts

@@ -105,21 +105,21 @@ describe("farcaster middleware", () => {
     await mw(context, next);
     enableNetConnect();
 
-    expect(next).toHaveBeenCalledWith(
-      expect.objectContaining({
-        message: {
-          buttonIndex: 1,
-          castId: {
-            fid: 456,
-            hash: "0x",
-          },
-          connectedAddress: "0x789",
-          inputText: "hello",
-          requesterFid: 123,
-          state: JSON.stringify({ test: true }),
+    expect(next).toHaveBeenCalledWith({
+      clientProtocol: { id: "farcaster", version: "vNext" },
+      message: {
+        buttonIndex: 1,
+        castId: {
+          fid: 456,
+          hash: "0x",
         },
-      })
-    );
+        connectedAddress: "0x89",
+        inputText: "hello",
+        requesterFid: 123,
+        state: JSON.stringify({ test: true }),
+        transactionId: undefined,
+      },
+    });
   });
 
   it("supports custom global typed context", async () => {

packages/frames.js/src/middleware/farcasterHubContext.test.ts

@@ -104,7 +104,8 @@ describe("farcasterHubContext middleware", () => {
 
     expect(next).toHaveBeenCalledWith(
       expect.objectContaining({
-        message: {
+        clientProtocol: { id: "farcaster", version: "vNext" },
+        message: expect.objectContaining({
           buttonIndex: 1,
           castId: {
             fid: 456,
@@ -114,8 +115,8 @@ describe("farcasterHubContext middleware", () => {
           inputText: "hello",
           requesterFid: 123,
           state: JSON.stringify({ test: true }),
-          requestedUserData: expect.anything() as UserDataReturnType,
-        },
+          requesterUserData: expect.anything() as UserDataReturnType,
+        }) as unknown,
       })
     );
   });

packages/frames.js/src/middleware/openframes.test.ts

@@ -290,11 +290,11 @@ describe("openframes middleware", () => {
 
     expect(next).toHaveBeenCalledWith(
       expect.objectContaining({
-        message: {
+        message: expect.objectContaining({
           buttonIndex: 1,
           inputText: "hello",
           state: { test: true },
-        },
+        }) as unknown,
         clientProtocol: {
           id: "xmtp",
           version: "2024-02-09",

packages/frames.js/src/middleware/renderResponse.test.tsx

@@ -21,8 +21,9 @@ jest.mock("@vercel/og", () => {
     arrayBufferMock,
     constructorMock,
     ImageResponse: class {
-      constructor() {
-        constructorMock();
+      constructor(...args: unknown[]) {
+        // @ts-expect-error -- we are mocking the constructor
+        constructorMock(...args);
       }
       arrayBuffer = arrayBufferMock;
     },

packages/frames.js/src/middleware/stateMiddleware.ts

@@ -27,8 +27,12 @@ export function stateMiddleware<
 
       // since we are stringifyng state to JSON in renderResponse middleware, we need to parse decode JSON here
       // so it is easy to use in middleware chain and frames handler
-      if (typeof ctx.message.state === "string") {
+      if (ctx.message.state) {
         try {
+          if (typeof ctx.message.state !== "string") {
+            throw new Error("State is not a string");
+          }
+
           state = JSON.parse(ctx.message.state) as TState;
         } catch (e) {
           // eslint-disable-next-line no-console -- provide feedback

packages/frames.js/src/utils.ts

@@ -131,5 +131,16 @@ export function extractAddressFromJSONMessage(
     return null;
   }
 
-  return bytesToHexString(data.verificationAddAddressBody.address);
+  /**
+   * This is ugly hack but we want to return the address as a string that is expected by the users ( essentially what they see in the response from the hub ).
+   * We could use Buffer.from(data.verificationAddAddressBody.address).toString('base64') here but that results in different base64.
+   * Therefore we return address from source message and not from decoded message.
+   *
+   * For example for value 0x8d25687829d6b85d9e0020b8c89e3ca24de20a89 from API we get 0x8d25687829d6b85d9e0020b8c89e3ca24de20a8w== from Buffer.from(...).toString('base64').
+   * The values are the same if you compare them as Buffer.from(a).equals(Buffer.from(b)).
+   */
+  // @TODO type message properly or handle the return type properly
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- we know the data is there
+  return (message as Record<string, any>).data.verificationAddAddressBody
+    .address as `0x${string}`;
 }