fix: populating projectName from test_observability object (#42)

* feat: Implement Nightwatch Test Orchestration Module

- Added helpers.js for utility functions related to test orchestration.
- Created index.js to serve as the main entry point for the orchestration module.
- Introduced orchestrationUtils.js for managing orchestration settings and operations.
- Developed requestUtils.js for handling API requests to the BrowserStack orchestration API.
- Implemented testOrchestrationHandler.js to manage test orchestration operations.
- Added testOrchestrationIntegration.js for integrating orchestration with Nightwatch.
- Created testOrderingServer.js to handle communication with the BrowserStack server for test ordering.
- Updated requestHelper.js to improve error handling for API requests.

* feat: Enhance test file collection and orchestration logic with improved glob pattern matching

* feat: Refactor test orchestration logic to apply specific feature path for cucumber tests

* feat: Update cucumber feature path for API tests in Nightwatch globals

* feat: Update cucumber feature path handling to use ordered files

* feat: Add framework name to build data payload in OrchestrationUtils

* feat: Remove unused helper functions and debug logs from orchestration files

* feat: Update framework name comment in build data payload and enhance error logging in RequestUtils

* feat: Remove unused orchestration files and refactor helper functions for improved Git metadata handling

* style: eslint update

* feat: Remove framework name from build data payload in OrchestrationUtils

* feat: Enhance build details extraction by adding observability options

* feat: Add test observability options to project and build name retrieval

* feat: Enhance test orchestration by adding observability session check and improve git metadata handling

* feat: Add test observability session check to build data collection in orchestration

* feat: Refactor test orchestration logic to improve readability and maintainability

* feat: Validate smart selection mode in run smart selection settings

* fix: Corrected base branch retrieval by updating the string replacement for origin reference

* refactor: Change log level from info to debug for test orchestration messages

Author: harshit-bstack

nightwatch/globals.js

@@ -9,7 +9,6 @@ const path = require('path');
 const AccessibilityAutomation = require('../src/accessibilityAutomation');
 const eventHelper = require('../src/utils/eventHelper');
 const OrchestrationUtils = require('../src/testorchestration/orchestrationUtils');
-const {type} = require('os');
 const localTunnel = new LocalTunnel();
 const testObservability = new TestObservability();
 const accessibilityAutomation = new AccessibilityAutomation();
@@ -327,83 +326,82 @@ module.exports = {
 
     // Initialize and configure test orchestration
     try {
-      const orchestrationUtils = OrchestrationUtils.getInstance(settings);
-      if (orchestrationUtils && orchestrationUtils.testOrderingEnabled()) {        
-        // Apply test orchestration to reorder test files before execution
-        const TestOrchestrationIntegration = require('../src/testorchestration/testOrchestrationIntegration');
-        const orchestrationIntegration = TestOrchestrationIntegration.getInstance();
-        orchestrationIntegration.configure(settings);
-                
-        // Check if we have test files to reorder from various sources
-        let allTestFiles = [];
-        
-        // Checking either for Feature Path or src_folders, feature path take priority
-        if (helper.isCucumberTestSuite(settings) && settings?.test_runner?.options?.feature_path){
-          Logger.debug('Getting test files from feature_path configuration...');
-          if (Array.isArray(settings.test_runner.options.feature_path)){
-            settings.test_runner.options.feature_path.forEach(featurePath => {
-              const files = helper.collectTestFiles(featurePath, 'feature_path config');
+      if (helper.isTestObservabilitySession()) {        
+        const orchestrationUtils = OrchestrationUtils.getInstance(settings);
+        if (orchestrationUtils && orchestrationUtils.testOrderingEnabled()){
+          // Apply test orchestration to reorder test files before execution
+          const TestOrchestrationIntegration = require('../src/testorchestration/testOrchestrationIntegration');
+          const orchestrationIntegration = TestOrchestrationIntegration.getInstance();
+          orchestrationIntegration.configure(settings);
+                  
+          // Check if we have test files to reorder from various sources
+          let allTestFiles = [];
+          
+          // Checking either for Feature Path or src_folders, feature path take priority
+          if (helper.isCucumberTestSuite(settings) && settings?.test_runner?.options?.feature_path){
+            Logger.debug('Getting test files from feature_path configuration...');
+            if (Array.isArray(settings.test_runner.options.feature_path)){
+              settings.test_runner.options.feature_path.forEach(featurePath => {
+                const files = helper.collectTestFiles(featurePath, 'feature_path config');
+                allTestFiles = allTestFiles.concat(files);
+              });
+            } else if (typeof settings.test_runner.options.feature_path === 'string'){
+              const files = helper.collectTestFiles(settings.test_runner.options.feature_path, 'feature_path config');
+              allTestFiles = allTestFiles.concat(files);
+            }
+          } else if (settings.src_folders && Array.isArray(settings.src_folders) && settings.src_folders.length > 0) {
+            Logger.debug('Getting test files from src_folders configuration...');
+            settings.src_folders.forEach(folder => {
+              const files = helper.collectTestFiles(folder, 'src_folders config');
               allTestFiles = allTestFiles.concat(files);
             });
-          } else if (typeof settings.test_runner.options.feature_path === 'string'){
-            const files = helper.collectTestFiles(settings.test_runner.options.feature_path, 'feature_path config');
-            allTestFiles = allTestFiles.concat(files);
           }
-        } else if (settings.src_folders && Array.isArray(settings.src_folders) && settings.src_folders.length > 0) {
-          Logger.debug('Getting test files from src_folders configuration...');
-          settings.src_folders.forEach(folder => {
-            const files = helper.collectTestFiles(folder, 'src_folders config');
-            allTestFiles = allTestFiles.concat(files);
-          });
-        }
 
-        // Remove duplicates and ensure all paths are relative to cwd
-        allTestFiles = [...new Set(allTestFiles)].map(file => {
-          return path.isAbsolute(file) ? path.relative(process.cwd(), file) : file;
-        });
+          // Remove duplicates and ensure all paths are relative to cwd
+          allTestFiles = [...new Set(allTestFiles)].map(file => {
+            return path.isAbsolute(file) ? path.relative(process.cwd(), file) : file;
+          });
 
 
-        if (allTestFiles.length > 0) {
-          Logger.info(`Applying test orchestration to reorder test files... Found ${allTestFiles.length} test files`);
-          Logger.debug(`Test files: ${JSON.stringify(allTestFiles)}`);
-          
-          // Apply orchestration to get ordered test files (synchronously)
-          try {
-            const orderedFiles = await orchestrationIntegration.applyOrchestration(allTestFiles, settings);
-            if (orderedFiles && orderedFiles.length > 0) {
-              Logger.info(`Test files reordered by orchestration: ${orderedFiles.length} files`);
-
-              Logger.info('Test orchestration recommended order change:');
-              Logger.info(`Original: ${allTestFiles.join(', ')}`);
-              Logger.info(`Optimized: ${orderedFiles.join(', ')}`);
-                                
-              try {
-                if (helper.isCucumberTestSuite(settings) && settings?.test_runner?.options?.feature_path){
-                  // For cucumber, we override the feature_path option with ordered files
-                  settings.test_runner.options['feature_path'] = orderedFiles;
-                } else {
-                  settings.src_folders = orderedFiles;
-                  for (const envName in testEnvSettings) {
-                    testEnvSettings[envName].src_folders = orderedFiles;
-                    testEnvSettings[envName].test_runner.src_folders = orderedFiles;
+          if (allTestFiles.length > 0) {
+            Logger.debug(`Applying test orchestration to reorder test files... Found ${allTestFiles.length} test files`);
+            Logger.debug(`Test files: ${JSON.stringify(allTestFiles)}`);
+            
+            // Apply orchestration to get ordered test files (synchronously)
+            try {
+              const orderedFiles = await orchestrationIntegration.applyOrchestration(allTestFiles, settings);
+              if (orderedFiles && orderedFiles.length > 0) {
+                Logger.info(`Test files reordered by orchestration: ${orderedFiles.length} files`);
+                                  
+                try {
+                  if (helper.isCucumberTestSuite(settings) && settings?.test_runner?.options?.feature_path){
+                    // For cucumber, we override the feature_path option with ordered files
+                    settings.test_runner.options['feature_path'] = orderedFiles;
+                  } else {
+                    settings.src_folders = orderedFiles;
+                    for (const envName in testEnvSettings) {
+                      testEnvSettings[envName].src_folders = orderedFiles;
+                      testEnvSettings[envName].test_runner.src_folders = orderedFiles;
+                    }
+                    if (settings.test_runner && typeof settings.test_runner === 'object' && !Array.isArray(settings.test_runner)) {
+                      settings.test_runner.src_folders = orderedFiles;
+                    }
                   }
-                  if (settings.test_runner && typeof settings.test_runner === 'object' && !Array.isArray(settings.test_runner)) {
-                    settings.test_runner.src_folders = orderedFiles;
-                  }
-                }
-                  
-              } catch (reorderError) {
-                Logger.error(`Runtime reordering failed: ${reorderError.message}`);
-                Logger.info('Falling back to original order for current execution.');
-              } 
-            } else {
-              Logger.info('Split test API called - no reordering available');
+                    
+                } catch (reorderError) {
+                  Logger.error(`Runtime reordering failed: ${reorderError.message}`);
+                  Logger.info('Falling back to original order for current execution.');
+                } 
+              } else {
+                Logger.info('Split test API called - no reordering available');
+              }
+            } catch (error) {
+              Logger.error(`Error applying test orchestration: ${error}`);
             }
-          } catch (error) {
-            Logger.error(`Error applying test orchestration: ${error}`);
+          
+          } else {
+            Logger.debug('No test files found for orchestration - skipping split test API call');
           }
-        } else {
-          Logger.debug('No test files found for orchestration - skipping split test API call');
         }
       }
     } catch (error) {
@@ -434,10 +432,13 @@ module.exports = {
 
     // Collect build data for test orchestration if enabled
     try {
-      const orchestrationUtils = OrchestrationUtils.getInstance();
-      if (orchestrationUtils && orchestrationUtils.testOrderingEnabled()) {
-        Logger.info('Collecting build data for test orchestration...');
-        await orchestrationUtils.collectBuildData(this.settings || {});
+      if (helper.isTestObservabilitySession()) {
+        const orchestrationUtils = OrchestrationUtils.getInstance();
+        if (orchestrationUtils && orchestrationUtils.testOrderingEnabled()){
+
+          Logger.info('Collecting build data for test orchestration...');
+          await orchestrationUtils.collectBuildData(this.settings || {});
+        }
       }
     } catch (error) {
       Logger.error(`Error collecting build data for test orchestration: ${error}`);

src/testorchestration/applyOrchestration.js

@@ -9,7 +9,6 @@ const TestOrchestrationHandler = require('./testOrchestrationHandler');
 async function applyOrchestrationIfEnabled(specs, config) {
   // Initialize orchestration handler
   const orchestrationHandler = TestOrchestrationHandler.getInstance(config);
-  Logger.info('Orchestration handler is initialized');
 
   if (!orchestrationHandler) {
     Logger.warn('Orchestration handler is not initialized. Skipping orchestration.');
@@ -32,13 +31,10 @@ async function applyOrchestrationIfEnabled(specs, config) {
   orchestrationHandler.addToOrderingInstrumentationData('enabled', orchestrationHandler.testOrderingEnabled());
 
   const startTime = performance.now();
-  
-  Logger.info('Test orchestration is enabled. Attempting to reorder test files.');
-  
+    
   // Get the test files from the specs
   const testFiles = specs;
   testOrderingApplied = true;
-  Logger.info(`Test files to be reordered: ${testFiles.join(', ')}`);
 
   // Reorder the test files
   const orderedFiles = await orchestrationHandler.reorderTestFiles(testFiles);

src/testorchestration/orchestrationUtils.js

@@ -67,7 +67,7 @@ class OrchestrationUtils {
     this._setRunSmartSelection(
       runSmartSelectionOpts.enabled || false,
       runSmartSelectionOpts.mode || 'relevantFirst',
-      runSmartSelectionOpts.source || null
+      runSmartSelectionOpts.source
     );
 
     // Extract build details
@@ -98,9 +98,12 @@ class OrchestrationUtils {
    */
   _extractBuildDetails() {
     try {
-      this.buildName = helper.getBuildName(this._settings, this._bstackOptions) || '';
+      const fromProduct = {
+        test_observability: true
+      };
+      this.buildName = helper.getBuildName(this._settings, this._bstackOptions, fromProduct) || '';
 
-      this.projectName = helper.getProjectName(this._settings, this._bstackOptions) || '';
+      this.projectName = helper.getProjectName(this._settings, this._bstackOptions, fromProduct) || '';
 
       this.buildIdentifier = process.env.BROWSERSTACK_BUILD_RUN_IDENTIFIER || '';
 
@@ -217,8 +220,13 @@ class OrchestrationUtils {
   _setRunSmartSelection(enabled, mode, source = null) {
     try {
       this.runSmartSelection = Boolean(enabled);
-      this.smartSelectionMode = mode;
+      if (['relevantFirst', 'relevantOnly'].includes(mode)) {
+        this.smartSelectionMode = mode;
+      } else {
+        this.smartSelectionMode = 'relevantFirst';
+      }
 
+      this.smartSelectionSource = [];
       // Log the configuration for debugging
       this.logger.debug(`Setting runSmartSelection: enabled=${this.runSmartSelection}, mode=${this.smartSelectionMode}`);
 

src/testorchestration/testOrderingServer.js

@@ -25,7 +25,11 @@ class TestOrderingServer {
     if (config && config.desiredCapabilities && config.desiredCapabilities['bstack:options']) {
       this._bstackOptions = config.desiredCapabilities['bstack:options'];
     }
+    this.fromProduct = {
+      test_observability: true
+    };
   }
+ 
 
   /**
    * Initiates the split tests request and stores the response data for polling.
@@ -46,8 +50,8 @@ class TestOrderingServer {
         orchestrationMetadata,
         nodeIndex: parseInt(process.env.BROWSERSTACK_NODE_INDEX || '0'),
         totalNodes: parseInt(process.env.BROWSERSTACK_TOTAL_NODE_COUNT || '1'),
-        projectName: getProjectName(this._settings, this._bstackOptions),
-        buildName: getBuildName(this._settings, this._bstackOptions),
+        projectName: getProjectName(this._settings, this._bstackOptions, this.fromProduct),
+        buildName: getBuildName(this._settings, this._bstackOptions, this.fromProduct),
         buildRunIdentifier: process.env.BROWSERSTACK_BUILD_RUN_IDENTIFIER || '',
         hostInfo: getHostInfo(),
         prDetails

src/utils/helper.js

@@ -1057,7 +1057,7 @@ function getBaseBranch() {
     try {
       const originHeadOutput = execSync('git symbolic-ref refs/remotes/origin/HEAD').toString().trim();
       if (originHeadOutput.startsWith('refs/remotes/origin/')) {
-        return originHeadOutput.replace('refs/remotes/', '');
+        return originHeadOutput.replace('refs/remotes/origin/', '');
       }
     } catch (e) {
       // Symbolic ref might not exist
@@ -1134,7 +1134,11 @@ function getChangedFilesFromCommits(commitHashes) {
  * @param multiRepoSource Array of repository paths for multi-repo setup
  */
 exports.getGitMetadataForAiSelection = (folders = []) => {
+  
   if (folders && folders.length === 0) {
+    return [];
+  }
+  if (folders === null){
     folders = [process.cwd()];
   }