DownloadSecureFileV1 - added socketTimeout input (#13800) (#13806)

* Added socketTimeout input

* Localization and versions changes

* Reverted changes for common package

* Used updated secure fiels helpers package. Bumped task version

* Updated secure common helpers package version

* Changed version

Co-authored-by: Danny McCormick <[email protected]>

Co-authored-by: Danny McCormick <[email protected]>

Author: Anatoly Bolshakov

Tasks/DownloadSecureFileV1/Strings/resources.resjson/en-US/resources.resjson

@@ -6,5 +6,7 @@
   "loc.input.label.secureFile": "Secure File",
   "loc.input.help.secureFile": "The file name or GUID of the secure file to download to the agent machine. The file will be deleted after the pipeline runs.",
   "loc.input.label.retryCount": "Retry Count",
-  "loc.input.help.retryCount": "Optional number of times to retry downloading a secure file if the download fails."
+  "loc.input.help.retryCount": "Optional number of times to retry downloading a secure file if the download fails.",
+  "loc.input.label.socketTimeout": "Socket Timeout",
+  "loc.input.help.socketTimeout": "Optional timeout for a socket associated with downloading secure file request in ms."
 }

Tasks/DownloadSecureFileV1/package.json

@@ -19,6 +19,6 @@
   "dependencies": {
     "@types/node": "^6.0.0",
     "azure-pipelines-task-lib": "^2.8.0",
-    "azure-pipelines-tasks-securefiles-common": "1.0.0"
+    "azure-pipelines-tasks-securefiles-common": "1.178.0"
   }
 }

Tasks/DownloadSecureFileV1/predownloadsecurefile.ts

@@ -10,12 +10,18 @@ async function run() {
         tl.setResourcePath(path.join(__dirname, 'task.json'));
 
         let retryCount = parseInt(tl.getInput('retryCount'));
+        let socketTimeout = parseInt(tl.getInput('socketTimeout'));
         if (isNaN(retryCount) || retryCount < 0) {
             retryCount = 8;
         }
+
+        if (isNaN(socketTimeout) || socketTimeout < 0) {
+            socketTimeout = undefined;
+        }
+
         // download decrypted contents
         secureFileId = tl.getInput('secureFile', true);
-        secureFileHelpers = new secureFilesCommon.SecureFileHelpers(retryCount);
+        secureFileHelpers = new secureFilesCommon.SecureFileHelpers(retryCount, socketTimeout);
         let secureFilePath: string = await secureFileHelpers.downloadSecureFile(secureFileId);
 
         if (tl.exist(secureFilePath)) {

Tasks/DownloadSecureFileV1/task.json

@@ -14,7 +14,7 @@
     "version": {
         "Major": 1,
         "Minor": 177,
-        "Patch": 0
+        "Patch": 1
     },
     "runsOn": [
         "Agent",
@@ -39,6 +39,14 @@
             "defaultValue": "8",
             "required": "false",
             "helpMarkDown": "Optional number of times to retry downloading a secure file if the download fails."
+        },
+        {
+            "name": "socketTimeout",
+            "type": "string",
+            "label": "Socket Timeout",
+            "defaultValue": "",
+            "required": "false",
+            "helpMarkDown": "Optional timeout for a socket associated with downloading secure file request in ms."
         }
     ],
     "outputVariables": [

Tasks/DownloadSecureFileV1/task.loc.json

@@ -14,7 +14,7 @@
   "version": {
     "Major": 1,
     "Minor": 177,
-    "Patch": 0
+    "Patch": 1
   },
   "runsOn": [
     "Agent",
@@ -39,6 +39,14 @@
       "defaultValue": "8",
       "required": "false",
       "helpMarkDown": "ms-resource:loc.input.help.retryCount"
+    },
+    {
+      "name": "socketTimeout",
+      "type": "string",
+      "label": "ms-resource:loc.input.label.socketTimeout",
+      "defaultValue": "",
+      "required": "false",
+      "helpMarkDown": "ms-resource:loc.input.help.socketTimeout"
     }
   ],
   "outputVariables": [