@azure/web-pubsub 1.0.1-alpha.20220401.1 → 1.1.0-alpha.20220418.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.1 (Unreleased)
+## 1.1.0 (Unreleased)
 
 ### Features Added
 
@@ -10,6 +10,10 @@
 
 ### Other Changes
 
+- Updated our `@azure/core-tracing` dependency to the latest version (1.0.0).
+  - Notable changes include Removal of `@opentelemetry/api` as a transitive dependency and ensuring that the active context is properly propagated.
+  - Customers who would like to continue using OpenTelemetry driven tracing should visit our [OpenTelemetry Instrumentation](https://www.npmjs.com/package/@azure/opentelemetry-instrumentation-azure-sdk) package for instructions.
+
 ## 1.0.0 (2021-11-11)
 
 No changes.

package/dist/index.js

@@ -8,7 +8,6 @@ var coreClient = require('@azure/core-client');
 var coreTracing = require('@azure/core-tracing');
 var jwt = require('jsonwebtoken');
 var logger$1 = require('@azure/logger');
-var url = require('url');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1505,7 +1504,7 @@ class GeneratedClientContext extends coreClient__namespace.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-web-pubsub/1.0.1`;
+        const packageDetails = `azsdk-js-web-pubsub/1.1.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1543,9 +1542,9 @@ class GeneratedClient extends GeneratedClientContext {
 
 // Copyright (c) Microsoft Corporation.
 /** @internal */
-const createSpan = coreTracing.createSpanFunction({
+const tracingClient = coreTracing.createTracingClient({
     namespace: "Microsoft.WebPubSub",
-    packagePrefix: "Azure.Messaging.WebPubSub",
+    packageName: "@azure/web-pubsub",
 });
 
 // Copyright (c) Microsoft Corporation.
@@ -1597,15 +1596,14 @@ class WebPubSubGroupImpl {
      * @param options - Additional options
      */
     async addConnection(connectionId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-addConnection", options);
         let response;
         function onResponse(rawResponse, flatResponse) {
             response = rawResponse;
-            if (updatedOptions.onResponse) {
-                updatedOptions.onResponse(rawResponse, flatResponse);
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
             }
         }
-        try {
+        return tracingClient.withSpan("WebPubSubGroupClient.addConnection", options, async (updatedOptions) => {
             await this.client.webPubSub.addConnectionToGroup(this.hubName, this.groupName, connectionId, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
             if (response.status === 404) {
                 throw new coreRestPipeline.RestError(`Connection id '${connectionId}' doesn't exist`, {
@@ -1614,10 +1612,7 @@ class WebPubSubGroupImpl {
                     response: response,
                 });
             }
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Remove a specific connection from this group
@@ -1626,13 +1621,9 @@ class WebPubSubGroupImpl {
      * @param options - Additional options
      */
     async removeConnection(connectionId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-removeConnection", options);
-        try {
-            await this.client.webPubSub.removeConnectionFromGroup(this.hubName, this.groupName, connectionId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubGroupClient.removeConnection", options, (updatedOptions) => {
+            return this.client.webPubSub.removeConnectionFromGroup(this.hubName, this.groupName, connectionId, updatedOptions);
+        });
     }
     /**
      * Close all connections to this group
@@ -1640,13 +1631,9 @@ class WebPubSubGroupImpl {
      * @param options - Additional options
      */
     async closeAllConnections(options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-closeAllConnections", options);
-        try {
-            return await this.client.webPubSub.closeGroupConnections(this.hubName, this.groupName, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubGroupClient.closeAllConnections", options, (updatedOptions) => {
+            return this.client.webPubSub.closeGroupConnections(this.hubName, this.groupName, updatedOptions);
+        });
     }
     /**
      * Add a user to this group
@@ -1655,13 +1642,9 @@ class WebPubSubGroupImpl {
      * @param options - Additional options
      */
     async addUser(username, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-addUser", options);
-        try {
-            await this.client.webPubSub.addUserToGroup(this.hubName, this.groupName, username, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubGroupClient.addUser", options, (updatedOptions) => {
+            return this.client.webPubSub.addUserToGroup(this.hubName, this.groupName, username, updatedOptions);
+        });
     }
     /**
      * Remove a user from this group
@@ -1670,23 +1653,15 @@ class WebPubSubGroupImpl {
      * @param options - Additional options
      */
     async removeUser(username, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-removeUser", options);
-        try {
-            await this.client.webPubSub.removeUserFromGroup(this.hubName, this.groupName, username, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubGroupClient.removeUser", options, (updatedOptions) => {
+            return this.client.webPubSub.removeUserFromGroup(this.hubName, this.groupName, username, updatedOptions);
+        });
     }
     async sendToAll(message, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-group-sendToAll", options);
-        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
-        try {
-            await this.client.webPubSub.sendToGroup(this.hubName, this.groupName, contentType, payload, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubGroupClient.sendToAll", options, (updatedOptions) => {
+            const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
+            return this.client.webPubSub.sendToGroup(this.hubName, this.groupName, contentType, payload, updatedOptions);
+        });
     }
 }
 
@@ -1743,10 +1718,10 @@ function parseConnectionString(conn) {
         throw new TypeError("connection string missing access key");
     const credential = new coreAuth.AzureKeyCredential(key);
     const port = parsed["port"];
-    const url$1 = new url.URL(endpointPart);
-    url$1.port = port;
-    const endpoint = url$1.toString();
-    url$1.port = "";
+    const url = new URL(endpointPart);
+    url.port = port;
+    const endpoint = url.toString();
+    url.port = "";
     return { credential, endpoint };
 }
 
@@ -1823,34 +1798,22 @@ class WebPubSubServiceClient {
         return new WebPubSubGroupImpl(this.client, this.hubName, groupName);
     }
     async sendToAll(message, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-sendToAll", options);
-        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
-        try {
-            return await this.client.webPubSub.sendToAll(this.hubName, contentType, payload, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.sendToAll", options, (updatedOptions) => {
+            const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
+            return this.client.webPubSub.sendToAll(this.hubName, contentType, payload, updatedOptions);
+        });
     }
     async sendToUser(username, message, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-sendToUser", options);
-        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
-        try {
-            return await this.client.webPubSub.sendToUser(this.hubName, username, contentType, payload, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.sendToUser", options, (updatedOptions) => {
+            const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
+            return this.client.webPubSub.sendToUser(this.hubName, username, contentType, payload, updatedOptions);
+        });
     }
     async sendToConnection(connectionId, message, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-sendToConnection", options);
-        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
-        try {
-            return await this.client.webPubSub.sendToConnection(this.hubName, connectionId, contentType, payload, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.sendToConnection", options, (updatedOptions) => {
+            const { contentType, payload } = getPayloadForMessage(message, updatedOptions);
+            return this.client.webPubSub.sendToConnection(this.hubName, connectionId, contentType, payload, updatedOptions);
+        });
     }
     /**
      * Check if a specific connection is connected to this hub
@@ -1859,15 +1822,14 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async connectionExists(connectionId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-hasConnection", options);
         let response;
         function onResponse(rawResponse, flatResponse) {
             response = rawResponse;
-            if (updatedOptions.onResponse) {
-                updatedOptions.onResponse(rawResponse, flatResponse);
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
             }
         }
-        try {
+        return tracingClient.withSpan("WebPubSubServiceClient.connectionExists", options, async (updatedOptions) => {
             await this.client.webPubSub.connectionExists(this.hubName, connectionId, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
             if (response.status === 200) {
                 return true;
@@ -1883,10 +1845,7 @@ class WebPubSubServiceClient {
                     response: response,
                 });
             }
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Close a specific connection to this hub
@@ -1895,13 +1854,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async closeConnection(connectionId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-closeConnection", options);
-        try {
-            return await this.client.webPubSub.closeConnection(this.hubName, connectionId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.closeConnection", options, (updatedOptions) => {
+            return this.client.webPubSub.closeConnection(this.hubName, connectionId, updatedOptions);
+        });
     }
     /**
      * Close all connections to this hub
@@ -1909,13 +1864,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async closeAllConnections(options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-closeAllConnections", options);
-        try {
-            return await this.client.webPubSub.closeAllConnections(this.hubName, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.closeAllConnections", options, (updatedOptions) => {
+            return this.client.webPubSub.closeAllConnections(this.hubName, updatedOptions);
+        });
     }
     /**
      * Close all connections with the given user id
@@ -1924,13 +1875,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async closeUserConnections(userId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-closeUserConnections", options);
-        try {
-            return await this.client.webPubSub.closeUserConnections(this.hubName, userId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.closeUserConnections", options, (updatedOptions) => {
+            return this.client.webPubSub.closeUserConnections(this.hubName, userId, updatedOptions);
+        });
     }
     /**
      * Remove a specific user from all groups they are joined to
@@ -1938,13 +1885,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async removeUserFromAllGroups(userId, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-removeUserFromAllGroups", options);
-        try {
-            await this.client.webPubSub.removeUserFromAllGroups(this.hubName, userId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.removeUserFromAllGroups", options, (updatedOptions) => {
+            return this.client.webPubSub.removeUserFromAllGroups(this.hubName, userId, updatedOptions);
+        });
     }
     /**
      * Check if a particular group exists (i.e. has active connections).
@@ -1953,15 +1896,14 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async groupExists(groupName, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-hasGroup", options);
         let response;
         function onResponse(rawResponse, flatResponse) {
             response = rawResponse;
-            if (updatedOptions.onResponse) {
-                updatedOptions.onResponse(rawResponse, flatResponse);
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
             }
         }
-        try {
+        return tracingClient.withSpan("WebPubSubServiceClient.groupExists", options, async (updatedOptions) => {
             await this.client.webPubSub.groupExists(this.hubName, groupName, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
             if (response.status === 200) {
                 return true;
@@ -1976,10 +1918,7 @@ class WebPubSubServiceClient {
                     response: response,
                 });
             }
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Check if a particular user is connected to this hub.
@@ -1988,15 +1927,14 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async userExists(username, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-hasUser", options);
         let response;
         function onResponse(rawResponse, flatResponse) {
             response = rawResponse;
-            if (updatedOptions.onResponse) {
-                updatedOptions.onResponse(rawResponse, flatResponse);
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
             }
         }
-        try {
+        return tracingClient.withSpan("WebPubSubServiceClient.userExists", options, async (updatedOptions) => {
             await this.client.webPubSub.userExists(this.hubName, username, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
             if (response.status === 200) {
                 return true;
@@ -2012,10 +1950,7 @@ class WebPubSubServiceClient {
                     response: response,
                 });
             }
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Grant permissions to a connection
@@ -2025,13 +1960,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async grantPermission(connectionId, permission, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-grantPermission", options);
-        try {
-            return await this.client.webPubSub.grantPermission(this.hubName, permission, connectionId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.grantPermission", options, (updatedOptions) => {
+            return this.client.webPubSub.grantPermission(this.hubName, permission, connectionId, updatedOptions);
+        });
     }
     /**
      * Revoke permissions from a connection
@@ -2041,13 +1972,9 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async revokePermission(connectionId, permission, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-revokePermission", options);
-        try {
-            return await this.client.webPubSub.revokePermission(this.hubName, permission, connectionId, updatedOptions);
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("WebPubSubServiceClient.revokePermission", options, (updatedOptions) => {
+            return this.client.webPubSub.revokePermission(this.hubName, permission, connectionId, updatedOptions);
+        });
     }
     /**
      * Check if the connection has the specified permission
@@ -2057,15 +1984,14 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async hasPermission(connectionId, permission, options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-hasPermission", options);
         let response;
         function onResponse(rawResponse, flatResponse) {
             response = rawResponse;
-            if (updatedOptions.onResponse) {
-                updatedOptions.onResponse(rawResponse, flatResponse);
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
             }
         }
-        try {
+        return tracingClient.withSpan("WebPubSubServiceClient.hasPermission", options, async (updatedOptions) => {
             await this.client.webPubSub.checkPermission(this.hubName, permission, connectionId, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
             if (response.status === 200) {
                 return true;
@@ -2081,10 +2007,7 @@ class WebPubSubServiceClient {
                     response: response,
                 });
             }
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Generate a token for a client to connect to the Azure Web PubSub service.
@@ -2092,8 +2015,7 @@ class WebPubSubServiceClient {
      * @param options - Additional options
      */
     async getClientAccessToken(options = {}) {
-        const { span, updatedOptions } = createSpan("WebPubSubServiceClient-hub-generateClientToken", options);
-        try {
+        return tracingClient.withSpan("WebPubSubServiceClient.getClientAccessToken", options, async (updatedOptions) => {
             const endpoint = this.endpoint.endsWith("/") ? this.endpoint : this.endpoint + "/";
             const clientEndpoint = endpoint.replace(/(http)(s?:\/\/)/gi, "ws$2");
             const baseUrl = `${clientEndpoint}client/hubs/${this.hubName}`;
@@ -2123,10 +2045,7 @@ class WebPubSubServiceClient {
                 baseUrl,
                 url: `${baseUrl}?access_token=${token}`,
             };
-        }
-        finally {
-            span.end();
-        }
+        });
     }
 }