Introduce tl.getNodeMajorVersion (#979)

* Introduce getNodeMajorVersion

* Update tests

* Update version and changelog

* Handle undefined Node version

Author: onetocny

node/CHANGELOG.md

@@ -56,4 +56,8 @@ Backported from ver.`3.4.0`:
 
 ## 4.6.0
 
-- Replaced deprecated "sync-request" lib and Added new Async methods - [#932](https://github.com/microsoft/azure-pipelines-task-lib/pull/932)
+- Replaced deprecated "sync-request" lib and Added new Async methods - [#932](https://github.com/microsoft/azure-pipelines-task-lib/pull/932)
+
+## 4.6.1
+
+- Added `getNodeMajorVersion` [#979](https://github.com/microsoft/azure-pipelines-task-lib/pull/979)

node/Strings/resources.resjson/en-US/resources.resjson

@@ -31,5 +31,6 @@
   "loc.messages.LIB_UseFirstGlobMatch": "Multiple workspace matches. using first.",
   "loc.messages.LIB_MergeTestResultNotSupported": "Merging test results from multiple files to one test run is not supported on this version of build agent for OSX/Linux, each test result file will be published as a separate test run in VSO/TFS.",
   "loc.messages.LIB_PlatformNotSupported": "Platform not supported: %s",
-  "loc.messages.LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s"
+  "loc.messages.LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s",
+  "loc.messages.LIB_UndefinedNodeVersion": "Node version is undefined."
 }

node/lib.json

@@ -32,6 +32,7 @@
     "LIB_UseFirstGlobMatch": "Multiple workspace matches. using first.",
     "LIB_MergeTestResultNotSupported": "Merging test results from multiple files to one test run is not supported on this version of build agent for OSX/Linux, each test result file will be published as a separate test run in VSO/TFS.",
     "LIB_PlatformNotSupported": "Platform not supported: %s",
-    "LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s"
+    "LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s",
+    "LIB_UndefinedNodeVersion": "Node version is undefined."
   } 
 }

node/mock-answer.ts

@@ -14,6 +14,7 @@ export interface TaskLibAnswers {
     find?: { [key: string]: string[] },
     findMatch?: { [key: string]: string[] },
     getPlatform?: { [key: string]: task.Platform },
+    getNodeMajorVersion?: { [key: string]: Number },
     getAgentMode?: { [key: string]: task.AgentHostedMode },
     legacyFindFiles?: { [key: string]: string[] },
     ls?: { [key: string]: string },

node/mock-task.ts

@@ -222,6 +222,10 @@ export function getPlatform(): task.Platform {
     return mock.getResponse('getPlatform', 'getPlatform', module.exports.debug);
 }
 
+export function getNodeMajorVersion(): Number {
+    return mock.getResponse('getNodeMajorVersion', 'getNodeMajorVersion', module.exports.debug);
+}
+
 export function getAgentMode(): task.AgentHostedMode {
     return mock.getResponse('getAgentMode', 'getAgentMode', module.exports.debug);
 }

node/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "4.6.0",
+  "version": "4.6.1",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

node/package.json

@@ -702,6 +702,24 @@ export function getPlatform(): Platform {
     }
 }
 
+/**
+ * Resolves major version of Node.js engine used by the agent.
+ * @returns {Number} Node's major version.
+ */
+export function getNodeMajorVersion(): Number {
+    const version = process?.versions?.node;
+    if (!version) {
+        throw new Error(loc('LIB_UndefinedNodeVersion'));
+    }
+
+    const parts = version.split('.').map(Number);
+    if (parts.length < 1) {
+        return NaN;
+    }
+
+    return parts[0];
+}
+
 /**
  * Return hosted type of Agent
  * @returns {AgentHostedMode}