Added retry logic to the cp() method (#707)

Co-authored-by: sdobrodeev <[email protected]>
microsoft · Feb 12, 2021 · 0d334a3 · 0d334a3
1 parent f844a24
commit 0d334a3
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 14 deletions.
diff --git a/node/Strings/resources.resjson/en-US/resources.resjson b/node/Strings/resources.resjson/en-US/resources.resjson
@@ -30,5 +30,6 @@
   "loc.messages.LIB_OperationFailed": "Failed %s: %s",
   "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_PlatformNotSupported": "Platform not supported: %s",
+  "loc.messages.LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s"
 }
diff --git a/node/docs/azure-pipelines-task-lib.md b/node/docs/azure-pipelines-task-lib.md
@@ -777,6 +777,7 @@ source | string | source path
 dest | string | destination path
 options | string | string \-r, \-f or \-rf for recursive and force 
 continueOnError | boolean | optional. whether to continue on error
+retryCount | number | optional. Retry count to copy the file. It might help to resolve intermittent issues e.g. with UNC target paths on a remote host.
 
 <br/>
 <div id="taskmv">

diff --git a/node/lib.json b/node/lib.json
@@ -31,6 +31,7 @@
     "LIB_OperationFailed": "Failed %s: %s",
     "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_PlatformNotSupported": "Platform not supported: %s",
+    "LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s"
   } 
 }
diff --git a/node/package-lock.json b/node/package-lock.json
diff --git a/node/package.json b/node/package.json
@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "2.12.1",
+  "version": "2.12.2",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

diff --git a/node/task.ts b/node/task.ts
@@ -560,8 +560,8 @@ export interface FsOptions {
 }
 
 export function writeFile(file: string, data: string | Buffer, options?: string | FsOptions) {
-    if(typeof(options) === 'string'){
-        fs.writeFileSync(file, data, {encoding: options});
+    if (typeof (options) === 'string') {
+        fs.writeFileSync(file, data, { encoding: options });
     }
     else {
         fs.writeFileSync(file, data, options);
@@ -744,16 +744,33 @@ export function ls(options: string, paths: string[]): string[] {
  * @param     dest       destination path
  * @param     options    string -r, -f or -rf for recursive and force 
  * @param     continueOnError optional. whether to continue on error
+ * @param     retryCount optional. Retry count to copy the file. It might help to resolve intermittent issues e.g. with UNC target paths on a remote host.
  */
-export function cp(source: string, dest: string, options?: string, continueOnError?: boolean): void {
-    if (options) {
-        shell.cp(options, source, dest);
-    }
-    else {
-        shell.cp(source, dest);
+export function cp(source: string, dest: string, options?: string, continueOnError?: boolean, retryCount: number = 0): void {
+    while (retryCount >= 0) {
+        if (options) {
+            shell.cp(options, source, dest);
+        }
+        else {
+            shell.cp(source, dest);
+        }
+        try {
+            _checkShell('cp', false);
+            break;
+        } catch (e) {
+            if (retryCount <= 0) {
+                if (continueOnError) {
+                    warning(e);
+                    break;
+                } else {
+                    throw e;
+                }
+            } else {
+                console.log(loc('LIB_CopyFileFailed', retryCount));
+                retryCount--;
+            }
+        }
     }
-
-    _checkShell('cp', continueOnError);
 }
 
 /**