[SDK] Fix caching issue with headless UI when custom resolvers are used

.changeset/fluffy-pets-tie.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Fix caching issues for headless component; improve code coverage

packages/thirdweb/src/react/web/ui/prebuilt/Chain/icon.tsx

@@ -4,6 +4,7 @@ import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
 import type { JSX } from "react";
 import { getChainMetadata } from "../../../../../chains/utils.js";
 import type { ThirdwebClient } from "../../../../../client/client.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { resolveScheme } from "../../../../../utils/ipfs.js";
 import { useChainContext } from "./provider.js";
 
@@ -121,7 +122,18 @@ export function ChainIcon({
 }: ChainIconProps) {
   const { chain } = useChainContext();
   const iconQuery = useQuery({
-    queryKey: ["_internal_chain_icon_", chain.id] as const,
+    queryKey: [
+      "_internal_chain_icon_",
+      chain.id,
+      {
+        resolver:
+          typeof iconResolver === "string"
+            ? iconResolver
+            : typeof iconResolver === "function"
+              ? getFunctionId(iconResolver)
+              : undefined,
+      },
+    ] as const,
     queryFn: async () => {
       if (typeof iconResolver === "string") {
         return iconResolver;

packages/thirdweb/src/react/web/ui/prebuilt/Chain/name.test.tsx

@@ -2,17 +2,17 @@ import { describe, expect, it } from "vitest";
 import { render, screen, waitFor } from "~test/react-render.js";
 import { ethereum } from "../../../../../chains/chain-definitions/ethereum.js";
 import { defineChain } from "../../../../../chains/utils.js";
-import { ChainName } from "./name.js";
+import { ChainName, fetchChainName } from "./name.js";
 import { ChainProvider } from "./provider.js";
 
 describe.runIf(process.env.TW_SECRET_KEY)("ChainName component", () => {
-  it("should return the correct chain name, if the name exists in the chain object", () => {
+  it("should return the correct chain name, if the name exists in the chain object", async () => {
     render(
       <ChainProvider chain={ethereum}>
         <ChainName />
       </ChainProvider>,
     );
-    waitFor(() =>
+    await waitFor(() =>
       expect(
         screen.getByText("Ethereum", {
           exact: true,
@@ -22,13 +22,13 @@ describe.runIf(process.env.TW_SECRET_KEY)("ChainName component", () => {
     );
   });
 
-  it("should return the correct chain name, if the name is loaded from the server", () => {
+  it("should return the correct chain name, if the name is loaded from the server", async () => {
     render(
       <ChainProvider chain={defineChain(1)}>
         <ChainName />
       </ChainProvider>,
     );
-    waitFor(() =>
+    await waitFor(() =>
       expect(
         screen.getByText("Ethereum Mainnet", {
           exact: true,
@@ -38,13 +38,13 @@ describe.runIf(process.env.TW_SECRET_KEY)("ChainName component", () => {
     );
   });
 
-  it("should return the correct FORMATTED chain name", () => {
+  it("should return the correct FORMATTED chain name", async () => {
     render(
       <ChainProvider chain={ethereum}>
         <ChainName formatFn={(str: string) => `${str}-formatted`} />
       </ChainProvider>,
     );
-    waitFor(() =>
+    await waitFor(() =>
       expect(
         screen.getByText("Ethereum-formatted", {
           exact: true,
@@ -54,14 +54,14 @@ describe.runIf(process.env.TW_SECRET_KEY)("ChainName component", () => {
     );
   });
 
-  it("should fallback properly when fail to resolve chain name", () => {
+  it("should fallback properly when fail to resolve chain name", async () => {
     render(
       <ChainProvider chain={defineChain(-1)}>
         <ChainName fallbackComponent={<span>oops</span>} />
       </ChainProvider>,
     );
 
-    waitFor(() =>
+    await waitFor(() =>
       expect(
         screen.getByText("oops", {
           exact: true,
@@ -70,4 +70,31 @@ describe.runIf(process.env.TW_SECRET_KEY)("ChainName component", () => {
       ).toBeInTheDocument(),
     );
   });
+
+  it("fetchChainName should respect nameResolver as a string", async () => {
+    const res = await fetchChainName({
+      chain: ethereum,
+      nameResolver: "eth_mainnet",
+    });
+    expect(res).toBe("eth_mainnet");
+  });
+
+  it("fetchChainName should respect nameResolver as a non-async function", async () => {
+    const res = await fetchChainName({
+      chain: ethereum,
+      nameResolver: () => "eth_mainnet",
+    });
+    expect(res).toBe("eth_mainnet");
+  });
+
+  it("fetchChainName should respect nameResolver as an async function", async () => {
+    const res = await fetchChainName({
+      chain: ethereum,
+      nameResolver: async () => {
+        await new Promise((resolve) => setTimeout(resolve, 2000));
+        return "eth_mainnet";
+      },
+    });
+    expect(res).toBe("eth_mainnet");
+  });
 });

packages/thirdweb/src/react/web/ui/prebuilt/Chain/name.tsx

@@ -3,7 +3,9 @@
 import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
 import type React from "react";
 import type { JSX } from "react";
+import type { Chain } from "../../../../../chains/types.js";
 import { getChainMetadata } from "../../../../../chains/utils.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { useChainContext } from "./provider.js";
 
 /**
@@ -155,19 +157,19 @@
 }: ChainNameProps) {
   const { chain } = useChainContext();
   const nameQuery = useQuery({
-    queryKey: ["_internal_chain_name_", chain.id] as const,
-    queryFn: async () => {
-      if (typeof nameResolver === "string") {
-        return nameResolver;
-      }
-      if (typeof nameResolver === "function") {
-        return nameResolver();
-      }
-      if (chain.name) {
-        return chain.name;
-      }
-      return getChainMetadata(chain).then((data) => data.name);
-    },
+    queryKey: [
+      "_internal_chain_name_",
+      chain.id,
+      {
+        resolver:
+          typeof nameResolver === "string"
+            ? nameResolver
+            : typeof nameResolver === "function"
+              ? getFunctionId(nameResolver)
+              : undefined,
+      },
+    ] as const,
+    queryFn: async () => fetchChainName({ chain, nameResolver }),
     ...queryOptions,
   });
 
@@ -183,3 +185,23 @@
 
   return <span {...restProps}>{displayValue}</span>;
 }
+
+/**
+ * @internal Exported for tests only
+ */
+export async function fetchChainName(props: {
+  chain: Chain;
+  nameResolver?: string | (() => string) | (() => Promise<string>);
+}) {
+  const { nameResolver, chain } = props;
+  if (typeof nameResolver === "string") {
+    return nameResolver;
+  }
+  if (typeof nameResolver === "function") {
+    return nameResolver();
+  }
+  if (chain.name) {
+    return chain.name;
+  }
+  return getChainMetadata(chain).then((data) => data.name);
+}

packages/thirdweb/src/react/web/ui/prebuilt/NFT/description.tsx

@@ -3,6 +3,7 @@
 import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
 import type { JSX } from "react";
 import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { useNFTContext } from "./provider.js";
 import { getNFTInfo } from "./utils.js";
 
@@ -100,7 +101,7 @@
           typeof descriptionResolver === "string"
             ? descriptionResolver
             : typeof descriptionResolver === "function"
-              ? descriptionResolver.toString()
+              ? getFunctionId(descriptionResolver)
               : undefined,
       },
     ],

packages/thirdweb/src/react/web/ui/prebuilt/NFT/media.tsx

@@ -3,6 +3,7 @@
 import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
 import type { JSX } from "react";
 import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { MediaRenderer } from "../../MediaRenderer/MediaRenderer.js";
 import type { MediaRendererProps } from "../../MediaRenderer/types.js";
 import { useNFTContext } from "./provider.js";
@@ -140,7 +141,7 @@
           typeof mediaResolver === "object"
             ? mediaResolver
             : typeof mediaResolver === "function"
-              ? mediaResolver.toString()
+              ? getFunctionId(mediaResolver)
               : undefined,
       },
     ],

packages/thirdweb/src/react/web/ui/prebuilt/NFT/name.tsx

@@ -3,6 +3,7 @@
 import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
 import type { JSX } from "react";
 import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { useNFTContext } from "./provider.js";
 import { getNFTInfo } from "./utils.js";
 
@@ -102,7 +103,7 @@
           typeof nameResolver === "string"
             ? nameResolver
             : typeof nameResolver === "function"
-              ? nameResolver.toString()
+              ? getFunctionId(nameResolver)
               : undefined,
       },
     ],

packages/thirdweb/src/react/web/ui/prebuilt/Token/icon.tsx

@@ -6,6 +6,7 @@ import { getChainMetadata } from "../../../../../chains/utils.js";
 import { NATIVE_TOKEN_ADDRESS } from "../../../../../constants/addresses.js";
 import { getContract } from "../../../../../contract/contract.js";
 import { getContractMetadata } from "../../../../../extensions/common/read/getContractMetadata.js";
+import { getFunctionId } from "../../../../../utils/function-id.js";
 import { resolveScheme } from "../../../../../utils/ipfs.js";
 import { useTokenContext } from "./provider.js";
 
@@ -117,7 +118,19 @@ export function TokenIcon({
 }: TokenIconProps) {
   const { address, client, chain } = useTokenContext();
   const iconQuery = useQuery({
-    queryKey: ["_internal_token_icon_", chain.id, address] as const,
+    queryKey: [
+      "_internal_token_icon_",
+      chain.id,
+      address,
+      {
+        resolver:
+          typeof iconResolver === "string"
+            ? iconResolver
+            : typeof iconResolver === "function"
+              ? getFunctionId(iconResolver)
+              : undefined,
+      },
+    ] as const,
     queryFn: async () => {
       if (typeof iconResolver === "string") {
         return iconResolver;