feat: Integrate orchestration data retrieval into test observability and refactor getBuildStartData method (#43)

* 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

* feat: Integrate orchestration data retrieval into test observability and refactor getBuildStartData method

* fix: Correct syntax by adding missing semicolon in testObservability.js

* fix: Update test_orchestration data retrieval to use parent settings

* fix: Enhance feature branch validation in OrchestrationUtils

* fix: Correct base branch retrieval by adjusting symbolic ref path

* fix: Validate repository URL to ensure it is not empty or whitespace

* fix: Enhance feature branch retrieval by adding null and type checks

* fix: eslint fix

Author: harshit-bstack

src/testObservability.js

@@ -8,6 +8,7 @@ const {makeRequest} = require('./utils/requestHelper');
 const CrashReporter = require('./utils/crashReporter');
 const Logger = require('./utils/logger');
 const {API_URL, TAKE_SCREENSHOT_REGEX} = require('./utils/constants');
+const OrchestrationUtils = require('./testorchestration/orchestrationUtils');
 const hooksMap = {};
 
 class TestObservability {
@@ -111,7 +112,8 @@ class TestObservability {
         frameworkName: helper.getFrameworkName(this._testRunner),
         frameworkVersion: helper.getPackageVersion('nightwatch'),
         sdkVersion: helper.getAgentVersion()
-      }
+      },
+      test_orchestration: this.getTestOrchestrationBuildStartData(this._parentSettings)
     };
 
     const config = {
@@ -151,6 +153,11 @@ class TestObservability {
       process.env.BROWSERSTACK_TEST_REPORTING = false;
     }
   }
+  getTestOrchestrationBuildStartData(settings) {
+    const orchestrationUtils = OrchestrationUtils.getInstance(settings);
+ 
+    return orchestrationUtils.getBuildStartData();
+  }
 
   async stopBuildUpstream () {
     if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {

src/testorchestration/orchestrationUtils.js

@@ -2,7 +2,6 @@ const path = require('path');
 const fs = require('fs');
 const {tmpdir} = require('os');
 const Logger = require('../utils/logger');
-const {getHostInfo} = require('../utils/helper');
 const RequestUtils = require('./requestUtils');
 const helper = require('../utils/helper');
 // Constants
@@ -307,12 +306,16 @@ class OrchestrationUtils {
 
     const getFeatureBranch = (name, repoInfo) => {
       // 1. Check in environment variable map
-      if (featureBranchEnvMap[name]) {
-        return featureBranchEnvMap[name];
+      if (featureBranchEnvMap && featureBranchEnvMap[name]) {
+        const val = featureBranchEnvMap[name];
+
+        return typeof val === 'string' ? val.trim() : val;
       }
       // 2. Check in repo_info
-      if (repoInfo.featureBranch) {
-        return repoInfo.featureBranch;
+      if (repoInfo && repoInfo.featureBranch) {
+        const val = repoInfo.featureBranch;
+
+        return typeof val === 'string' ? val.trim() : val;
       }
 
       return null;
@@ -327,7 +330,7 @@ class OrchestrationUtils {
           continue;
         }
 
-        if (!repoInfo.url) {
+        if (!repoInfo.url || String(repoInfo.url).trim() === '') {
           this.logger.warn(`Repository URL is missing for source '${name}': ${JSON.stringify(repoInfo)}`);
           continue;
         }
@@ -348,7 +351,7 @@ class OrchestrationUtils {
         repoInfoCopy.name = name;
         repoInfoCopy.featureBranch = getFeatureBranch(name, repoInfo);
 
-        if (!repoInfoCopy.featureBranch) {
+        if (!repoInfoCopy.featureBranch || repoInfoCopy.featureBranch === '') {
           this.logger.warn(`Feature branch not specified for source '${name}': ${JSON.stringify(repoInfo)}`);
           continue;
         }
@@ -414,7 +417,7 @@ class OrchestrationUtils {
   /**
    * Get build start data
    */
-  getBuildStartData(config) {
+  getBuildStartData() {
     const testOrchestrationData = {};
 
     testOrchestrationData['run_smart_selection'] = {
@@ -442,7 +445,7 @@ class OrchestrationUtils {
         buildRunIdentifier: this.getBuildIdentifier(),
         nodeIndex: parseInt(process.env.BROWSERSTACK_NODE_INDEX || '0', 10),
         totalNodes: parseInt(process.env.BROWSERSTACK_TOTAL_NODE_COUNT || '1', 10),
-        hostInfo: getHostInfo()
+        hostInfo: helper.getHostInfo()
       };
 
       this.logger.debug(`[collectBuildData] Sending build data payload: ${JSON.stringify(payload)}`);

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/origin/', '');
+        return originHeadOutput.replace('refs/remotes/', '');
       }
     } catch (e) {
       // Symbolic ref might not exist