[core-http] Fix the error inconsistency of requestOptions.timeout - n…

…ode vs browser (#7159) * fix the timeout inconsistency of requestOptions.timeout * document the error * added changelog * update changelog * Update sdk/core/core-http/lib/webResource.ts Co-Authored-By: Ramya Rao <[email protected]> * Update sdk/core/core-http/CHANGELOG.md Co-Authored-By: Ramya Rao <[email protected]> Co-authored-by: Ramya Rao <[email protected]>
AzureSDKAutomation · Feb 4, 2020 · e8860be · e8860be
1 parent 084c40f
commit e8860be
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 11 deletions.
diff --git a/sdk/core/core-http/CHANGELOG.md b/sdk/core/core-http/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## 1.0.4 (Unreleased)
 
+- When an operation times out based on the `timeout` configured in the `OperationRequestOptions`, it gets terminated with an error. In this update, the error that is thrown in browser for such cases is updated to match what is thrown in node i.e an `AbortError` is thrown instead of the previous `RestError`. [PR #7159](https://github.com/Azure/azure-sdk-for-js/pull/7159)
 - Fixed an issue where `error.code` and `error.message` are not assigned for `StorageError` instances. ([PR #7107](https://github.com/Azure/azure-sdk-for-js/pull/7107))
 
 ## 1.0.3 (2020-01-02)

diff --git a/sdk/core/core-http/lib/webResource.ts b/sdk/core/core-http/lib/webResource.ts
@@ -503,6 +503,7 @@ export interface RequestOptionsBase {
 
   /**
    * The number of milliseconds a request can take before automatically being terminated.
+   * If the request is terminated, an `AbortError` is thrown.
    */
   timeout?: number;
 

diff --git a/sdk/core/core-http/lib/xhrHttpClient.ts b/sdk/core/core-http/lib/xhrHttpClient.ts
@@ -161,15 +161,7 @@ function rejectOnTerminalEvent(
       )
     )
   );
-  xhr.addEventListener("abort", () => reject(new AbortError("The operation was aborted.")));
-  xhr.addEventListener("timeout", () =>
-    reject(
-      new RestError(
-        `timeout of ${xhr.timeout}ms exceeded`,
-        RestError.REQUEST_SEND_ERROR,
-        undefined,
-        request
-      )
-    )
-  );
+  const abortError = new AbortError("The operation was aborted.");
+  xhr.addEventListener("abort", () => reject(abortError));
+  xhr.addEventListener("timeout", () => reject(abortError));
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -503,6 +503,7 @@ export interface RequestOptionsBase { @@
       /**
        * The number of milliseconds a request can take before automatically being terminated.
+       * If the request is terminated, an `AbortError` is thrown.
        */
       timeout?: number;
@@ Expand Down @@