return response.text from shopifyDevFetch

Author: matteodepalo

src/tools/index.test.ts

@@ -156,6 +156,7 @@ describe("searchShopifyDocs", () => {
           callback("text/plain", "content-type");
         },
       },
+      text: async () => "Internal Server Error",
     });
 
     // Call the function directly
@@ -193,9 +194,6 @@ describe("searchShopifyDocs", () => {
       text: async () => "This is not valid JSON",
     });
 
-    // Clear the mocks before the test
-    vi.mocked(console.warn).mockClear();
-
     // Call the function directly
     const result = await searchShopifyDocs("product");
 
@@ -204,9 +202,8 @@ describe("searchShopifyDocs", () => {
     expect(result.formattedText).toBe("This is not valid JSON");
 
     // Verify that console.warn was called with the JSON parsing error
-    expect(console.warn).toHaveBeenCalledTimes(1);
-    expect(vi.mocked(console.warn).mock.calls[0][0]).toContain(
-      "Error parsing JSON response",
+    expect(console.warn).toHaveBeenCalledWith(
+      expect.stringContaining("[shopify-docs] Error parsing JSON response:"),
     );
   });
 
@@ -388,6 +385,7 @@ describe("learn_shopify_api tool behavior", () => {
           headers: {
             forEach: () => {},
           },
+          text: async () => "Internal Server Error",
         });
       }
       return Promise.reject(new Error("Unexpected URL"));

src/tools/index.ts

@@ -19,7 +19,8 @@ const polarisUnifiedEnabled =
  * Helper function to make requests to the Shopify dev server
  * @param path The API path (e.g., "/mcp/search", "/mcp/getting_started")
  * @param options Request options including parameters and headers
- * @returns The fetch response
+ * @returns The response text
+ * @throws Error if the response is not ok
  */
 async function shopifyDevFetch(
   path: string,
@@ -28,7 +29,7 @@ async function shopifyDevFetch(
     headers?: Record<string, string>;
     method?: string;
   },
-): Promise<Response> {
+): Promise<string> {
   const url = new URL(path, SHOPIFY_BASE_URL);
   const instrumentation = instrumentationData();
 
@@ -69,7 +70,11 @@ async function shopifyDevFetch(
     `[shopify-dev] Response status: ${response.status} ${response.statusText}`,
   );
 
-  return response;
+  if (!response.ok) {
+    throw new Error(`HTTP error! status: ${response.status}`);
+  }
+
+  return await response.text();
 }
 
 const GettingStartedAPISchema = z.object({
@@ -102,50 +107,39 @@ const withConversationId = <T extends z.ZodRawShape>(schema: T) => ({
  */
 export async function searchShopifyDocs(
   prompt: string,
-  options?: { max_num_results?: number },
+  max_num_results?: number,
 ) {
   try {
     // Prepare parameters
     const parameters: Record<string, string> = {
       query: prompt,
     };
 
-    if (options?.max_num_results !== undefined) {
-      parameters.max_num_results = String(options.max_num_results);
+    if (max_num_results !== undefined) {
+      parameters.max_num_results = String(max_num_results);
     }
 
-    const response = await shopifyDevFetch("/mcp/search", {
+    const responseText = await shopifyDevFetch("/mcp/search", {
       parameters,
     });
 
-    if (!response.ok) {
-      console.error(`[shopify-docs] HTTP error status: ${response.status}`);
-      return {
-        success: false,
-        formattedText: `HTTP error! status: ${response.status}`,
-      };
-    }
-
-    // Read and process the response
-    const responseText = await response.text();
     console.error(
       `[shopify-docs] Response text (truncated): ${
         responseText.substring(0, 200) +
         (responseText.length > 200 ? "..." : "")
       }`,
     );
 
-    // Parse and format the JSON for human readability
+    // Try to parse and format as JSON, otherwise return raw text
     try {
       const jsonData = JSON.parse(responseText);
       const formattedJson = JSON.stringify(jsonData, null, 2);
-
       return {
         success: true,
         formattedText: formattedJson,
       };
     } catch (e) {
-      // If JSON parsing fails, get the raw text
+      // If JSON parsing fails, return the raw text
       console.warn(`[shopify-docs] Error parsing JSON response: ${e}`);
       return {
         success: true,
@@ -217,9 +211,10 @@ export async function shopifyTools(server: McpServer): Promise<void> {
         ),
     }),
     async (params) => {
-      const result = await searchShopifyDocs(params.prompt, {
-        max_num_results: params.max_num_results,
-      });
+      const result = await searchShopifyDocs(
+        params.prompt,
+        params.max_num_results,
+      );
 
       recordUsage("search_docs_chunks", params, result.formattedText).catch(
         () => {},
@@ -256,14 +251,12 @@ export async function shopifyTools(server: McpServer): Promise<void> {
       async function fetchDocText(path: string): Promise<DocResult> {
         try {
           const appendedPath = path.endsWith(".txt") ? path : `${path}.txt`;
-          const response = await shopifyDevFetch(appendedPath);
-
-          if (!response.ok) {
-            throw new Error(`HTTP error! status: ${response.status}`);
-          }
-
-          const text = await response.text();
-          return { text: `## ${path}\n\n${text}\n\n`, path, success: true };
+          const responseText = await shopifyDevFetch(appendedPath);
+          return {
+            text: `## ${path}\n\n${responseText}\n\n`,
+            path,
+            success: true,
+          };
         } catch (error) {
           console.error(`Error fetching document at ${path}: ${error}`);
           return {
@@ -385,16 +378,10 @@ export async function shopifyTools(server: McpServer): Promise<void> {
       }
 
       try {
-        const response = await shopifyDevFetch("/mcp/getting_started", {
+        const responseText = await shopifyDevFetch("/mcp/getting_started", {
           parameters: { api: params.api },
         });
 
-        if (!response.ok) {
-          throw new Error(`HTTP error! status: ${response.status}`);
-        }
-
-        const responseText = await response.text();
-
         recordUsage("learn_shopify_api", params, responseText).catch(() => {});
 
         // Include the conversation ID in the response
@@ -430,15 +417,8 @@ ${responseText}`;
  */
 async function fetchGettingStartedApis(): Promise<GettingStartedAPI[]> {
   try {
-    const response = await shopifyDevFetch("/mcp/getting_started_apis");
-
-    if (!response.ok) {
-      console.error(`[api-information] HTTP error status: ${response.status}`);
-      throw new Error(`HTTP error! status: ${response.status}`);
-    }
+    const responseText = await shopifyDevFetch("/mcp/getting_started_apis");
 
-    // Read and process the response
-    const responseText = await response.text();
     console.error(
       `[api-information] Response text (truncated): ${
         responseText.substring(0, 200) +