Refactoring ++

Author: tech-sushant

src/tools/appautomate-utils/appium-sdk/config-generator.ts

@@ -1,13 +1,26 @@
 // Configuration utilities for BrowserStack App SDK
-import { APP_DEVICE_CONFIGS, DEFAULT_APP_PATH, createStep } from "./index.js";
+import {
+  APP_DEVICE_CONFIGS,
+  AppSDKSupportedTestingFrameworkEnum,
+  DEFAULT_APP_PATH,
+  createStep,
+} from "./index.js";
 
 export function generateAppBrowserStackYMLInstructions(
   platforms: string[],
   username: string,
   accessKey: string,
   appPath: string = DEFAULT_APP_PATH,
-  testingFramework?: string,
+  testingFramework: string,
 ): string {
+  if (
+    testingFramework === AppSDKSupportedTestingFrameworkEnum.nightwatch ||
+    testingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio
+  ) {
+    return "";
+  }
+
+  // Generate platform and device configurations
   const platformConfigs = platforms
     .map((platform) => {
       const devices =
@@ -25,10 +38,10 @@ export function generateAppBrowserStackYMLInstructions(
     .filter(Boolean)
     .join("\n");
 
+  // Construct YAML content
   const configContent = `\`\`\`yaml
 userName: ${username}
 accessKey: ${accessKey}
-framework: ${testingFramework}
 app: ${appPath}
 platforms:
 ${platformConfigs}
@@ -49,6 +62,7 @@ accessibility: false
 - Set \`browserstackLocal: true\` if you need to test with local/staging servers
 - Adjust \`parallelsPerPlatform\` based on your subscription limits`;
 
+  // Return formatted step for instructions
   return createStep(
     "Update browserstack.yml file with App Automate configuration:",
     `Create or update the browserstack.yml file in your project root with the following content:

src/tools/appautomate-utils/appium-sdk/constants.ts

@@ -60,4 +60,9 @@ export const SETUP_APP_AUTOMATE_SCHEMA = {
     .describe(
       "Path to the mobile app file (.apk for Android, .ipa for iOS). Can be a local file path or a BrowserStack app URL (bs://)",
     ),
+  project: z
+    .string()
+    .optional()
+    .default("BStack-AppAutomate-Suite")
+    .describe("Project name for organizing test runs on BrowserStack."),
 };

src/tools/appautomate-utils/handler.ts renamed to src/tools/appautomate-utils/appium-sdk/handler.ts

@@ -1,19 +1,21 @@
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { BrowserStackConfig } from "../../lib/types.js";
-import { getBrowserStackAuth } from "../../lib/get-auth.js";
+import { BrowserStackConfig } from "../../../lib/types.js";
+import { getBrowserStackAuth } from "../../../lib/get-auth.js";
 import {
   AppSDKSupportedLanguage,
   AppSDKSupportedTestingFramework,
   AppSDKInstruction,
   formatAppInstructionsWithNumbers,
   getAppInstructionsForProjectConfiguration,
   SETUP_APP_AUTOMATE_SCHEMA,
-} from "./appium-sdk/index.js";
+} from "./index.js";
 import {
   getAppSDKPrefixCommand,
   generateAppBrowserStackYMLInstructions,
-} from "./appium-sdk/index.js";
+} from "./index.js";
+import { getAppUploadInstruction } from "./utils.js";
+import logger from "../../../logger.js";
 
 export async function setupAppAutomateHandler(
   rawInput: unknown,
@@ -25,13 +27,24 @@ export async function setupAppAutomateHandler(
 
   const instructions: AppSDKInstruction[] = [];
 
+  // Use variables for all major input properties
+  const testingFramework =
+    input.detectedTestingFramework as AppSDKSupportedTestingFramework;
+  const language = input.detectedLanguage as AppSDKSupportedLanguage;
+  const platforms = (input.desiredPlatforms as string[]) ?? ["android"];
+  const appPath = input.appPath as string;
+  const framework = input.detectedFramework as string;
+
+  logger.info("Generating SDK setup command...");
+  logger.debug(`Input: ${JSON.stringify(input)}`);
+
   // Step 1: Generate SDK setup command
   const sdkCommand = getAppSDKPrefixCommand(
-    input.detectedLanguage as AppSDKSupportedLanguage,
-    input.detectedFramework as string,
+    language,
+    testingFramework,
     username,
     accessKey,
-    input.appPath as string | undefined,
+    appPath,
   );
 
   if (sdkCommand) {
@@ -40,22 +53,34 @@ export async function setupAppAutomateHandler(
 
   // Step 2: Generate browserstack.yml configuration
   const configInstructions = generateAppBrowserStackYMLInstructions(
-    (input.desiredPlatforms as string[]) ?? ["android"],
+    platforms,
     username,
     accessKey,
-    input.appPath as string | undefined,
-    input.detectedTestingFramework as AppSDKSupportedTestingFramework,
+    appPath,
+    testingFramework,
   );
 
   if (configInstructions) {
     instructions.push({ content: configInstructions, type: "config" });
   }
 
-  // Step 3: Generate project configuration and run instructions
+  // Step 3: Generate app upload instruction
+  const appUploadInstruction = await getAppUploadInstruction(
+    appPath,
+    username,
+    accessKey,
+    testingFramework,
+  );
+
+  if (appUploadInstruction) {
+    instructions.push({ content: appUploadInstruction, type: "setup" });
+  }
+
+  // Step 4: Generate project configuration and run instructions
   const projectInstructions = getAppInstructionsForProjectConfiguration(
-    input.detectedFramework as string,
-    input.detectedTestingFramework as AppSDKSupportedTestingFramework,
-    input.detectedLanguage as AppSDKSupportedLanguage,
+    framework,
+    testingFramework,
+    language,
   );
 
   if (projectInstructions) {

src/tools/appautomate-utils/appium-sdk/instructions.ts

@@ -44,7 +44,7 @@ export function getAppInstructionsForProjectConfiguration(
 
 export function getAppSDKPrefixCommand(
   language: AppSDKSupportedLanguage,
-  framework: string,
+  testingFramework: string,
   username: string,
   accessKey: string,
   appPath?: string,
@@ -53,13 +53,13 @@ export function getAppSDKPrefixCommand(
     case "csharp":
       return getCSharpSDKCommand(username, accessKey);
     case "java":
-      return getJavaSDKCommand(framework, username, accessKey, appPath);
+      return getJavaSDKCommand(testingFramework, username, accessKey, appPath);
     case "nodejs":
-      return getNodejsSDKCommand(framework, username, accessKey);
+      return getNodejsSDKCommand(testingFramework, username, accessKey);
     case "python":
-      return getPythonSDKCommand(framework, username, accessKey);
+      return getPythonSDKCommand(testingFramework, username, accessKey);
     case "ruby":
-      return getRubySDKCommand(framework, username, accessKey);
+      return getRubySDKCommand(testingFramework, username, accessKey);
     default:
       return "";
   }

src/tools/appautomate-utils/appium-sdk/languages/java.ts

@@ -1,5 +1,4 @@
 // Java instructions and commands for App SDK utilities
-import logger from "../../../../logger.js";
 import {
   createStep,
   combineInstructions,
@@ -68,19 +67,22 @@ function getMavenCommandForWindows(
   );
 }
 
-// Generates Maven archetype command for Unix-like platforms (macOS/Linux)
 function getMavenCommandForUnix(
-  username: string,
-  accessKey: string,
-  mavenFramework: string,
   framework: string,
+  mavenFramework: string,
 ): string {
-  return `mvn archetype:generate -B -DarchetypeGroupId=${MAVEN_ARCHETYPE_GROUP_ID} \\
--DarchetypeArtifactId=${mavenFramework} -DarchetypeVersion=${MAVEN_ARCHETYPE_VERSION} \\
--DgroupId=${MAVEN_ARCHETYPE_GROUP_ID} -DartifactId=${MAVEN_ARCHETYPE_ARTIFACT_ID} -Dversion=${MAVEN_ARCHETYPE_VERSION} \\
--DBROWSERSTACK_USERNAME="${username}" \\
--DBROWSERSTACK_ACCESS_KEY="${accessKey}" \\
--DBROWSERSTACK_FRAMEWORK="${framework}"`;
+  return (
+    `mvn archetype:generate -B ` +
+    `-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+    `-DarchetypeArtifactId="${mavenFramework}" ` +
+    `-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
+    `-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+    `-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
+    `-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
+    `-DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" ` +
+    `-DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" ` +
+    `-DBROWSERSTACK_FRAMEWORK="${framework}"`
+  );
 }
 
 export function getJavaSDKCommand(
@@ -89,33 +91,21 @@ export function getJavaSDKCommand(
   accessKey: string,
   appPath?: string,
 ): string {
-  logger.info("Generating Java SDK command");
-  const { isWindows = false, getPlatformLabel = () => "Unknown" } =
-    PLATFORM_UTILS || {};
-  if (!PLATFORM_UTILS) {
-    console.warn("PLATFORM_UTILS is undefined. Defaulting platform values.");
-  }
+  const { isWindows = false, getPlatformLabel } = PLATFORM_UTILS || {};
 
   const mavenFramework = getJavaAppFrameworkForMaven(framework);
 
   let mavenCommand: string;
-  logger.info(
-    `Maven command for ${framework} (${getPlatformLabel()}): ${isWindows}`,
-  );
+
   if (isWindows) {
     mavenCommand = getMavenCommandForWindows(framework, mavenFramework);
     if (appPath) {
       mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
     }
   } else {
-    mavenCommand = getMavenCommandForUnix(
-      username,
-      accessKey,
-      mavenFramework,
-      framework,
-    );
+    mavenCommand = getMavenCommandForUnix(framework, mavenFramework);
     if (appPath) {
-      mavenCommand += ` \\\n-DBROWSERSTACK_APP="${appPath}"`;
+      mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
     }
   }
 
@@ -128,7 +118,7 @@ export function getJavaSDKCommand(
 
   const mavenStep = createStep(
     "Install BrowserStack SDK using Maven Archetype for App Automate",
-    `**Maven command for ${framework} (${getPlatformLabel()}):**
+    `Maven command for ${framework} (${getPlatformLabel()}):
 \`\`\`bash
 ${mavenCommand}
 \`\`\`
@@ -137,6 +127,5 @@ Alternative setup for Gradle users:
 ${GRADLE_APP_SETUP_INSTRUCTIONS}`,
   );
 
-  logger.info("Java SDK command generated successfully");
   return combineInstructions(envStep, mavenStep);
 }