froth-webdriverio-framework 7.0.67 → 7.0.68

package/froth_configs/commonhook.js

@@ -134,80 +134,96 @@ const commonHooks = {
 
 
   /* ========== BEFORE SESSION ========== */
-
   beforeSession: async function (config, capabilities, specs) {
-    console.log('==== BEFORE SESSION ====');
-    try {
-      /** 1️⃣ Validate test syntax */
-      let syntaxFailed = false;
-
-      for (const fileUrl of specs) {
-        const filePath = url.fileURLToPath(fileUrl);
-        try {
-          new Function(fs.readFileSync(filePath, 'utf8'));
-        } catch (err) {
-          const msg = `❌ Syntax error in ${path.basename(filePath)}: ${err.message}`;
-          console.error(msg);
-          resultdetails.comments.push(msg);
-          syntaxFailed = true;
-        }
-      }
-
-      if (syntaxFailed) {
-        await failExecution('Syntax validation failed');
-      }
-      /** 2️⃣ BrowserStack capability normalization */
-
-      if (process.env.PLATFORM === 'browserstack' || process.env.PLATFORM === 'browserstacklocal') {
-        /** 🔍 Print raw capabilities first */
-        console.log('🟡 Raw Capabilities (Before):');
-        console.log(JSON.stringify(capabilities, null, 2));
-        const bsOpts = capabilities['bstack:options'] || {};
-        /** 🔍 Print existing BS options */
-        console.log('🟢 Existing bstack:options (Before Modification):');
-        console.log(JSON.stringify(bsOpts, null, 2));
-
-        if (process.env.BS_SESSION_TYPE === 'app-automate') {
-          const appPath = process.env.BROWSERSTACK_APP_PATH;
-          if (!appPath) {
-            await failExecution('BROWSERSTACK_APP_PATH is missing');
-          }
-
-          bsOpts.app = appPath;
-          capabilities['appium:app'] = appPath;
-          console.log('✅ App & media set in before session');
-
-        }
-        /** Media upload */
-        /** 📦 Media upload (from DB → ENV → capabilities) */
-        if (process.env.MEDIA_FILES) {
-          try {
-            const mediaList = JSON.parse(process.env.MEDIA_FILES);
-            console.log("media files are", mediaList)
-            if (Array.isArray(mediaList) && mediaList.length > 0) {
-              bsOpts.uploadMedia = mediaList;
-              console.log('✅ uploadMedia injected:', mediaList);
-            }
-          } catch (err) {
-            console.warn('⚠️ MEDIA_FILES is not valid JSON', err);
-          }
-        }
-        capabilities['bstack:options'] = bsOpts;
-        /** 🔍 Print final BS options */
-        console.log('🔵 Final bstack:options (After Modification):');
-        console.log(JSON.stringify(capabilities['bstack:options'], null, 2));
+    console.log('==== BEFORE SESSION STARTED ====');
 
-      }
-      console.log('🔎 Final capabilities:', JSON.stringify(capabilities, null, 2));
+    try {
+      /** 1️⃣ Validate syntax */
+      await validateTestSyntax(specs);
 
-      // console.log("config details " + JSON.stringify(config))
+      /** 2️⃣ Setup BrowserStack */
+      await setupBrowserStackCapabilities(capabilities);
 
+      console.log('✅ beforeSession completed successfully');
 
     } catch (error) {
-      console.error('🚨 Error in beforeSession:', error);
       console.error('🚨 Error in beforeSession:', error.message);
+      throw error;
     }
   },
+  // beforeSession: async function (config, capabilities, specs) {
+  //   console.log('==== BEFORE SESSION ====');
+  //   try {
+  //     /** 1️⃣ Validate test syntax */
+  //     let syntaxFailed = false;
+
+  //     for (const fileUrl of specs) {
+  //       const filePath = url.fileURLToPath(fileUrl);
+  //       try {
+  //         new Function(fs.readFileSync(filePath, 'utf8'));
+  //       } catch (err) {
+  //         const msg = `❌ Syntax error in ${path.basename(filePath)}: ${err.message}`;
+  //         console.error(msg);
+  //         resultdetails.comments.push(msg);
+  //         syntaxFailed = true;
+  //       }
+  //     }
+
+  //     if (syntaxFailed) {
+  //       await failExecution('Syntax validation failed');
+  //     }
+  //     /** 2️⃣ BrowserStack capability normalization */
+
+  //     if (process.env.PLATFORM === 'browserstack' || process.env.PLATFORM === 'browserstacklocal') {
+  //       /** 🔍 Print raw capabilities first */
+  //       console.log('🟡 Raw Capabilities (Before):');
+  //       console.log(JSON.stringify(capabilities, null, 2));
+  //       const bsOpts = capabilities['bstack:options'] || {};
+  //       /** 🔍 Print existing BS options */
+  //       console.log('🟢 Existing bstack:options (Before Modification):');
+  //       console.log(JSON.stringify(bsOpts, null, 2));
+
+  //       if (process.env.BS_SESSION_TYPE === 'app-automate') {
+  //         const appPath = process.env.BROWSERSTACK_APP_PATH;
+  //         if (!appPath) {
+  //           await failExecution('BROWSERSTACK_APP_PATH is missing');
+  //         }
+
+  //         bsOpts.app = appPath;
+  //         capabilities['appium:app'] = appPath;
+  //         console.log('✅ App & media set in before session');
+
+  //       }
+  //       /** Media upload */
+  //       /** 📦 Media upload (from DB → ENV → capabilities) */
+  //       if (process.env.MEDIA_FILES) {
+  //         try {
+  //           const mediaList = JSON.parse(process.env.MEDIA_FILES);
+  //           console.log("media files are", mediaList)
+  //           if (Array.isArray(mediaList) && mediaList.length > 0) {
+  //             bsOpts.uploadMedia = mediaList;
+  //             console.log('✅ uploadMedia injected:', mediaList);
+  //           }
+  //         } catch (err) {
+  //           console.warn('⚠️ MEDIA_FILES is not valid JSON', err);
+  //         }
+  //       }
+  //       capabilities['bstack:options'] = bsOpts;
+  //       /** 🔍 Print final BS options */
+  //       console.log('🔵 Final bstack:options (After Modification):');
+  //       console.log(JSON.stringify(capabilities['bstack:options'], null, 2));
+
+  //     }
+  //     console.log('🔎 Final capabilities:', JSON.stringify(capabilities, null, 2));
+
+  //     // console.log("config details " + JSON.stringify(config))
+
+
+  //   } catch (error) {
+  //     console.error('🚨 Error in beforeSession:', error);
+  //     console.error('🚨 Error in beforeSession:', error.message);
+  //   }
+  // },
   /* ========== BEFORE SUITE ========== */
   beforeSuite: async (suite) => {
     console.log(`==== BEFORE SUITE: ${suite.title} ====`);
@@ -374,5 +390,97 @@ async function normalizeWdioError(error) {
   return `Automation framework error: ${msg}`;
 }
 
+async function setupBrowserStackCapabilities(capabilities) {
+  if (
+    process.env.PLATFORM !== 'browserstack' &&
+    process.env.PLATFORM !== 'browserstacklocal'
+  ) {
+    return;
+  }
+
+  const bsOpts = capabilities['bstack:options'] || {};
+
+  /** 🔹 Build metadata */
+  bsOpts.buildIdentifier =
+    process.env.BROWSERSTACK_BUILD_NAME || 'local-build';
+
+  bsOpts.buildName =
+    process.env.BROWSERSTACK_BUILD_DISPLAY_NAME ||
+    bsOpts.buildName
+
+
+  bsOpts.projectName = bsOpts.projectName || 'BrowserStack Samples';
+
+  bsOpts.sessionName =
+    process.env.BROWSERSTACK_SESSION_NAME ||
+    'BStack WDIO Appium Session';
+
+  /** 🔹 Device consistency */
+  bsOpts.deviceName = bsOpts.deviceName || capabilities.deviceName;
+  bsOpts.osVersion = bsOpts.osVersion || capabilities.osVersion;
+
+  /** 🔹 Logs */
+  bsOpts.debug = bsOpts.debug ?? true;
+  bsOpts.networkLogs = bsOpts.networkLogs ?? false;
+
+  /** 🔹 Local testing */
+  if (process.env.PLATFORM === 'browserstacklocal') {
+    bsOpts.local = true;
+    bsOpts.localIdentifier =
+      process.env.BROWSERSTACK_LOCAL_IDENTIFIER ||
+      `wdio-${process.pid}`;
+  }
+
+  /** 🔹 App Automate */
+  if (process.env.BS_SESSION_TYPE === 'app-automate') {
+    const appPath = process.env.BROWSERSTACK_APP_PATH;
+
+    if (!appPath) {
+      throw new Error('❌ BROWSERSTACK_APP_PATH is missing');
+    }
+
+    bsOpts.app = appPath;
+    capabilities['appium:app'] = appPath;
+  }
+
+  /** 🔹 Media upload */
+  if (process.env.MEDIA_FILES) {
+    try {
+      const mediaList = JSON.parse(process.env.MEDIA_FILES);
+      if (Array.isArray(mediaList) && mediaList.length > 0) {
+        bsOpts.uploadMedia = mediaList;
+      }
+    } catch (err) {
+      console.warn('⚠️ MEDIA_FILES is not valid JSON', err);
+    }
+  }
+
+  /** 🔹 Re-assign */
+  capabilities['bstack:options'] = bsOpts;
+
+  /** 🔹 Final BS log */
+  console.log('🚀 BrowserStack final options:');
+  console.log(JSON.stringify(bsOpts, null, 2));
+}
+
+async function validateTestSyntax(specs) {
+  let syntaxFailed = false;
+
+  for (const fileUrl of specs) {
+    const filePath = url.fileURLToPath(fileUrl);
+    try {
+      new Function(fs.readFileSync(filePath, 'utf8'));
+    } catch (err) {
+      console.error(
+        `❌ Syntax error in ${path.basename(filePath)}: ${err.message}`
+      );
+      syntaxFailed = true;
+    }
+  }
+
+  if (syntaxFailed) {
+    throw new Error('Syntax validation failed');
+  }
+}
 
 module.exports = commonHooks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "froth-webdriverio-framework",
-  "version": "7.0.67",
+  "version": "7.0.68",
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",