@azure/core-rest-pipeline 1.4.1-alpha.20220114.1 → 1.5.0

package/CHANGELOG.md

@@ -1,14 +1,16 @@
 # Release History
 
-## 1.4.1 (Unreleased)
+## 1.5.0 (2022-02-03)
 
 ### Features Added
 
-### Breaking Changes
+- Added new phase "Sign" for policies that sign the request for security purposes. [#20129](https://github.com/Azure/azure-sdk-for-js/pull/20129)
 
 ### Bugs Fixed
 
-### Other Changes
+- Updated the HTTP tracing span names to conform to the [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name). [#19838](https://github.com/Azure/azure-sdk-for-js/pull/19838)
+- New HTTP spans will use the `HTTP <VERB>` convention instead of using the URL path.
+- Addressed an issue where policy order might change in cases where there are no policies inside a phase specified by an "afterPhase" constraint. [#20129](https://github.com/Azure/azure-sdk-for-js/pull/20129)
 
 ## 1.4.0 (2022-01-06)
 

package/dist/index.js

@@ -2,9 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var FormData = _interopDefault(require('form-data'));
+var FormData = require('form-data');
 var logger$1 = require('@azure/logger');
 var url = require('url');
 var httpsProxyAgent$1 = require('https-proxy-agent');
@@ -19,9 +17,35 @@ var stream = require('stream');
 var util = require('util');
 var uuid = require('uuid');
 
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var FormData__default = /*#__PURE__*/_interopDefaultLegacy(FormData);
+var os__namespace = /*#__PURE__*/_interopNamespace(os);
+var http__namespace = /*#__PURE__*/_interopNamespace(http);
+var https__namespace = /*#__PURE__*/_interopNamespace(https);
+var zlib__namespace = /*#__PURE__*/_interopNamespace(zlib);
+
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const ValidPhaseNames = new Set(["Deserialize", "Serialize", "Retry"]);
+const ValidPhaseNames = new Set(["Deserialize", "Serialize", "Retry", "Sign"]);
 /**
  * A private implementation of Pipeline.
  * Do not export this class from the package.
@@ -96,6 +120,7 @@ class HttpPipeline {
          * 2. Policies not in a phase
          * 3. Deserialize Phase
          * 4. Retry Phase
+         * 5. Sign Phase
          *
          * Within each phase, policies are executed in the order
          * they were added unless they were specified to execute
@@ -123,14 +148,22 @@ class HttpPipeline {
         const result = [];
         // Track all policies we know about.
         const policyMap = new Map();
+        function createPhase(name) {
+            return {
+                name,
+                policies: new Set(),
+                hasRun: false,
+            };
+        }
         // Track policies for each phase.
-        const serializePhase = new Set();
-        const noPhase = new Set();
-        const deserializePhase = new Set();
-        const retryPhase = new Set();
+        const serializePhase = createPhase("Serialize");
+        const noPhase = createPhase("None");
+        const deserializePhase = createPhase("Deserialize");
+        const retryPhase = createPhase("Retry");
+        const signPhase = createPhase("Sign");
         // a list of phases in order
-        const orderedPhases = [serializePhase, noPhase, deserializePhase, retryPhase];
-        // Small helper function to map phase name to each Set bucket.
+        const orderedPhases = [serializePhase, noPhase, deserializePhase, retryPhase, signPhase];
+        // Small helper function to map phase name to each Phase
         function getPhase(phase) {
             if (phase === "Retry") {
                 return retryPhase;
@@ -141,6 +174,9 @@ class HttpPipeline {
             else if (phase === "Deserialize") {
                 return deserializePhase;
             }
+            else if (phase === "Sign") {
+                return signPhase;
+            }
             else {
                 return noPhase;
             }
@@ -163,7 +199,7 @@ class HttpPipeline {
             }
             policyMap.set(policyName, node);
             const phase = getPhase(options.phase);
-            phase.add(node);
+            phase.policies.add(node);
         }
         // Now that each policy has a node, connect dependency references.
         for (const descriptor of this._policies) {
@@ -197,11 +233,14 @@ class HttpPipeline {
             }
         }
         function walkPhase(phase) {
+            phase.hasRun = true;
             // Sets iterate in insertion order
-            for (const node of phase) {
-                if (node.afterPhase && node.afterPhase.size) {
+            for (const node of phase.policies) {
+                if (node.afterPhase && (!node.afterPhase.hasRun || node.afterPhase.policies.size)) {
                     // If this node is waiting on a phase to complete,
                     // we need to skip it for now.
+                    // Even if the phase is empty, we should wait for it
+                    // to be walked to avoid re-ordering policies.
                     continue;
                 }
                 if (node.dependsOn.size === 0) {
@@ -214,20 +253,16 @@ class HttpPipeline {
                         dependant.dependsOn.delete(node);
                     }
                     policyMap.delete(node.policy.name);
-                    phase.delete(node);
+                    phase.policies.delete(node);
                 }
             }
         }
         function walkPhases() {
-            let noPhaseRan = false;
             for (const phase of orderedPhases) {
                 walkPhase(phase);
-                if (phase === noPhase) {
-                    noPhaseRan = true;
-                }
                 // if the phase isn't complete
-                if (phase.size > 0 && phase !== noPhase) {
-                    if (noPhaseRan === false) {
+                if (phase.policies.size > 0 && phase !== noPhase) {
+                    if (!noPhase.hasRun) {
                         // Try running noPhase to see if that unblocks this phase next tick.
                         // This can happen if a phase that happens before noPhase
                         // is waiting on a noPhase policy to complete.
@@ -239,13 +274,16 @@ class HttpPipeline {
             }
         }
         // Iterate until we've put every node in the result list.
+        let iteration = 0;
         while (policyMap.size > 0) {
+            iteration++;
             const initialResultLength = result.length;
             // Keep walking each phase in order until we can order every node.
             walkPhases();
-            // The result list *should* get at least one larger each time.
+            // The result list *should* get at least one larger each time
+            // after the first full pass.
             // Otherwise, we're going to loop forever.
-            if (result.length <= initialResultLength) {
+            if (result.length <= initialResultLength && iteration > 1) {
                 throw new Error("Cannot satisfy policy dependencies due to requirements cycle.");
             }
         }
@@ -324,7 +362,7 @@ function wwwFormUrlEncode(formData) {
     return urlSearchParams.toString();
 }
 async function prepareFormData(formData, request) {
-    const requestForm = new FormData();
+    const requestForm = new FormData__default["default"]();
     for (const formKey of Object.keys(formData)) {
         const formValue = formData[formKey];
         if (Array.isArray(formValue)) {
@@ -842,12 +880,12 @@ function getHeaderName() {
  */
 function setPlatformSpecificData(map) {
     map.set("Node", process.version);
-    map.set("OS", `(${os.arch()}-${os.type()}-${os.release()})`);
+    map.set("OS", `(${os__namespace.arch()}-${os__namespace.type()}-${os__namespace.release()})`);
 }
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "1.4.1";
+const SDK_VERSION = "1.5.0";
 
 // Copyright (c) Microsoft Corporation.
 function getUserAgentString(telemetryInfo) {
@@ -1555,7 +1593,7 @@ class NodeHttpClient {
             headers: request.headers.toJSON({ preserveCase: true }),
         };
         return new Promise((resolve, reject) => {
-            const req = isInsecure ? http.request(options, resolve) : https.request(options, resolve);
+            const req = isInsecure ? http__namespace.request(options, resolve) : https__namespace.request(options, resolve);
             req.once("error", (err) => {
                 var _a;
                 reject(new RestError(err.message, { code: (_a = err.code) !== null && _a !== void 0 ? _a : RestError.REQUEST_SEND_ERROR, request }));
@@ -1590,7 +1628,7 @@ class NodeHttpClient {
         if (!request.disableKeepAlive) {
             if (isInsecure) {
                 if (!this.httpKeepAliveAgent) {
-                    this.httpKeepAliveAgent = new http.Agent({
+                    this.httpKeepAliveAgent = new http__namespace.Agent({
                         keepAlive: true,
                     });
                 }
@@ -1598,7 +1636,7 @@ class NodeHttpClient {
             }
             else {
                 if (!this.httpsKeepAliveAgent) {
-                    this.httpsKeepAliveAgent = new https.Agent({
+                    this.httpsKeepAliveAgent = new https__namespace.Agent({
                         keepAlive: true,
                     });
                 }
@@ -1606,10 +1644,10 @@ class NodeHttpClient {
             }
         }
         else if (isInsecure) {
-            return http.globalAgent;
+            return http__namespace.globalAgent;
         }
         else {
-            return https.globalAgent;
+            return https__namespace.globalAgent;
         }
     }
 }
@@ -1631,12 +1669,12 @@ function getResponseHeaders(res) {
 function getDecodedResponseStream(stream, headers) {
     const contentEncoding = headers.get("Content-Encoding");
     if (contentEncoding === "gzip") {
-        const unzip = zlib.createGunzip();
+        const unzip = zlib__namespace.createGunzip();
         stream.pipe(unzip);
         return unzip;
     }
     else if (contentEncoding === "deflate") {
-        const inflate = zlib.createInflate();
+        const inflate = zlib__namespace.createInflate();
         stream.pipe(inflate);
         return inflate;
     }