update instructions and error handling

Author: tech-sushant

src/tools/sdk-utils/common/constants.ts

@@ -35,7 +35,7 @@ Process files in STRICT sequential order using tool addPercySnapshotCommands() w
 export const PERCY_SIMULATE_INSTRUCTION = `
 MANDATORY: Aggressive, Accurate Percy Snapshots Integration
 
-Prerequisite: Before making any code changes in the user's repo, switch to a branch named temp-percy (run git init first if the repo is not yet initialized).
+Prerequisite: Before making any code changes in the user's repository, create and switch to a new branch named browserstack-simulation. Stage all changes but do not commit them. If the repository has not been initialized yet, run git init first.
 
 You MUST follow these steps with NO EXCEPTIONS:
 1. Identify 4-5 key test files in the project that are critical for visual testing.
@@ -78,13 +78,13 @@ percy_snapshot(self.driver, "Before Adding to Cart")  # (Do NOT change the snaps
 \`\`\`
 
 STEP 4: Run a second Percy build.
+- Strictly use the same build command you ran for the baseline.
 - The snapshot names must remain the same as in the baseline.
 - The visual change should now appear in the same snapshot as before.
-- Use the same build command you ran for the baseline.
 
 STEP 5: Compare the two Percy builds to see the detected visual difference.
 
-STEP 6: Now ask user if they want to setup percy for full project coverage? If yes, call the "setupPercyVisualTesting" tool to enable complete coverage for the entire project.
+STEP 6: Now ask user if they want to setup percy for full project coverage? If yes, discard all the unstaged changes and call the "setupPercyVisualTesting" tool to enable complete coverage for the entire project.
 
 CONSTRAINTS:
 - Do NOT run any builds until explicitly instructed in the steps.
@@ -100,3 +100,6 @@ VALIDATION CHECKPOINTS (before proceeding to the next step):
 CRITICAL: 
 Do NOT run tests separately or create multiple builds during baseline establishment. The goal is to have exactly TWO builds total: (1) baseline build with all original snapshots, (2) modified build with the same tests but visual changes injected.
 `;
+
+export const PERCY_VERIFICATION_REGEX =
+  /\*\*✅ Verification:\*\*\nPlease verify that you have completed all[\s\S]*?double-check each step and ensure all commands executed successfully\./s;

src/tools/sdk-utils/common/utils.ts

@@ -102,11 +102,12 @@ export function getBootstrapFailedMessage(
   error: unknown,
   context: { config: unknown; percyMode?: string; sdkVersion?: string },
 ): string {
+  const errorMsg = error instanceof Error ? error.message : String(error);
   return `Failed to bootstrap project with BrowserStack SDK.
-Error: ${error}
-Percy Mode: ${context.percyMode ?? "automate"}
-SDK Version: ${context.sdkVersion ?? "N/A"}
-Please open an issue on GitHub if the problem persists.`;
+  Error: ${errorMsg}
+  Percy Mode: ${context.percyMode ?? "N/A"}
+  SDK Version: ${context.sdkVersion ?? "N/A"}
+  Please open an issue on GitHub if the problem persists.`;
 }
 
 export function percyUnsupportedResult(

src/tools/sdk-utils/handler.ts

@@ -21,6 +21,7 @@ import {
   PERCY_SIMULATE_INSTRUCTION,
   PERCY_REPLACE_REGEX,
   PERCY_SIMULATION_DRIVER_INSTRUCTION,
+  PERCY_VERIFICATION_REGEX,
 } from "./common/constants.js";
 
 export async function runTestsOnBrowserStackHandler(
@@ -172,23 +173,27 @@ export async function setUpSimulatePercyChangeHandler(
   config: BrowserStackConfig,
 ): Promise<CallToolResult> {
   try {
-    const percyInstruction = await setUpPercyHandler(rawInput, config);
+    let percyInstruction;
 
+    try {
+      percyInstruction = await setUpPercyHandler(rawInput, config);
+    } catch {
+      throw new Error("Failed to set up Percy");
+    }
+    
     if (percyInstruction.isError) {
       return percyInstruction;
     }
 
     if (Array.isArray(percyInstruction.content)) {
-      percyInstruction.content.forEach((item) => {
-        if (
-          typeof item.text === "string" &&
-          PERCY_REPLACE_REGEX.test(item.text)
-        ) {
-          item.text = item.text.replace(
-            PERCY_REPLACE_REGEX,
-            PERCY_SIMULATE_INSTRUCTION,
-          );
+      percyInstruction.content = percyInstruction.content.map((item) => {
+        if (typeof item.text === "string") {
+          let updatedText = item.text
+            .replace(PERCY_REPLACE_REGEX, PERCY_SIMULATE_INSTRUCTION)
+            .replace(PERCY_VERIFICATION_REGEX, "");
+          return { ...item, text: updatedText };
         }
+        return item;
       });
     }
 

src/tools/sdk-utils/percy-web/fetchPercyToken.ts

@@ -5,41 +5,43 @@ export async function fetchPercyToken(
   authorization: string,
   options: { type?: PercyIntegrationTypeEnum } = {},
 ): Promise<string> {
-  try {
-    const authHeader = `Basic ${Buffer.from(authorization).toString("base64")}`;
-    const baseUrl =
-      "https://api.browserstack.com/api/app_percy/get_project_token";
-    const params = new URLSearchParams({ name: projectName });
-
-    if (options.type) {
-      params.append("type", options.type);
-    }
-
-    const url = `${baseUrl}?${params.toString()}`;
-
-    const response = await fetch(url, {
-      headers: {
-        Authorization: authHeader,
-      },
-    });
-
-    if (!response.ok) {
-      throw new Error(
-        `Failed to fetch Percy token (status: ${response.status})`,
-      );
-    }
-
-    const data = await response.json();
-
-    if (!data?.token || !data?.success) {
-      throw new Error(
-        "Project exists but is likely set up for Automate. Please use a different project name.",
-      );
-    }
-
-    return data.token;
-  } catch (err) {
-    const message = err instanceof Error ? err.message : "Unknown error";
-    throw new Error(`Error retrieving Percy token: ${message}`);
+  const authHeader = `Basic ${Buffer.from(authorization).toString("base64")}`;
+
+  const baseUrl =
+    "https://api.browserstack.com/api/app_percy/get_project_token";
+  const params = new URLSearchParams({ name: projectName });
+
+  if (!projectName) {
+    throw new Error("Project name is required for setting up the Percy");
+  }
+
+  if (options.type) {
+    params.append("type", options.type);
+  }
+
+  const url = `${baseUrl}?${params.toString()}`;
+  
+  return "newtoken";
+
+  const response = await fetch(url, {
+    headers: {
+      Authorization: authHeader,
+    },
+  });
+
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch Percy token (status: ${response.status})`,
+    );
+  }
+
+  const data = await response.json();
+
+  if (!data?.token || !data?.success) {
+    throw new Error(
+      "Project exists but is likely set up for Automate. Please use a different project name.",
+    );
   }
+
+  return data.token;
 }