Add SocketIO support when generate token (Azure#38588)

* add socketio support when generate token

* add documentation

---------

Co-authored-by: chuongnguyen <[email protected]>

Author: cqnguy23

sdk/webpubsub/azure-messaging-webpubsubservice/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.2.2 (Unreleased)
 
 ### Features Added
+- Added support for SocketIO when generating client access token
 
 ### Breaking Changes
 

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/_operations/_patch.py

@@ -96,8 +96,8 @@ def get_client_access_token(self, *, client_protocol: Optional[str] = "Default",
         :keyword groups: Groups that the connection will join when it connects. Default value is None.
         :paramtype groups: list[str]
         :keyword client_protocol: The type of client protocol. Case-insensitive. If not set, it's "Default". For Web
-         PubSub for Socket.IO, only the default value is supported. For Web PubSub, the valid values are
-         'Default' and 'MQTT'. Known values are: "Default" and "MQTT". Default value is "Default".
+         PubSub for Socket.IO, "SocketIO" type is supported. For Web PubSub, the valid values are
+         'Default', 'MQTT'. Known values are: "Default", "MQTT" and "SocketIO". Default value is "Default".
         :paramtype client_type: str
         :returns: JSON response containing the web socket endpoint, the token and a url with the generated access token.
         :rtype: JSON
@@ -124,9 +124,14 @@ def get_client_access_token(self, *, client_protocol: Optional[str] = "Default",
 
         client_endpoint = "ws" + endpoint[4:]
         hub = self._config.hub
-        path = "/clients/mqtt/hubs/" if client_protocol.lower() == "mqtt" else "/client/hubs/"
         # Example URL for Default Client Type: https://<service-name>.webpubsub.azure.com/client/hubs/<hub>
-        # and for MQTT Client Type: https://<service-name>.webpubsub.azure.com/clients/mqtt/hubs/<hub>
+        #                 MQTT Client Type: https://<service-name>.webpubsub.azure.com/clients/mqtt/hubs/<hub>
+        #                 SocketIO Client Type: https://<service-name>.webpubsub.azure.com/clients/socketio/hubs/<hub>
+        path = "/client/hubs/"
+        if client_protocol.lower() == "mqtt":
+            path = "/clients/mqtt/hubs/" 
+        elif client_protocol.lower() == "socketio":
+            path = "/clients/socketio/hubs/"
         client_url = client_endpoint + path + hub
         jwt_headers = kwargs.pop("jwt_headers", {})
         if isinstance(self._config.credential, AzureKeyCredential):

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/aio/_operations/_patch.py

@@ -58,8 +58,8 @@ async def get_client_access_token(  # pylint: disable=arguments-differ
          default value may result in unsupported behavior.
         :paramtype api_version: str
         :keyword client_protocol: The type of client protocol. Case-insensitive. If not set, it's "Default". For Web
-         PubSub for Socket.IO, only the default value is supported. For Web PubSub, the valid values are
-         'Default' and 'MQTT'. Known values are: "Default" and "MQTT". Default value is "Default".
+         PubSub for Socket.IO, "SocketIO" type is supported. For Web PubSub, the valid values are
+         'Default', 'MQTT'. Known values are: "Default", "MQTT" and "SocketIO". Default value is "Default".
         :paramtype client_type: str
         :return: JSON object
         :rtype: JSON
@@ -87,7 +87,11 @@ async def get_client_access_token(  # pylint: disable=arguments-differ
 
         client_endpoint = "ws" + endpoint[4:]
         hub = self._config.hub
-        path = "/clients/mqtt/hubs/" if client_protocol.lower() == "mqtt" else "/client/hubs/"
+        path = "/client/hubs/"
+        if client_protocol.lower() == "mqtt":
+            path = "/clients/mqtt/hubs/" 
+        elif client_protocol.lower() == "socketio":
+            path = "/clients/socketio/hubs/"
         client_url = client_endpoint + path + hub
         if isinstance(self._config.credential, AzureKeyCredential):
             token = get_token_by_key(

sdk/webpubsub/azure-messaging-webpubsubservice/tests/test_jwt.py

@@ -136,3 +136,22 @@ def test_generate_mqtt_token(connection_string, hub, expected_url):
 
     assert len(decoded_token_1) == 3
     assert decoded_token_1['aud'] == expected_url.replace('ws', 'http')
+
+test_cases = [
+    ("Endpoint=http://localhost;Port=8080;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://localhost:8080/clients/socketio/hubs/hub"),
+    ("Endpoint=https://a;AccessKey={};Version=1.0;".format(access_key), "hub", "wss://a/clients/socketio/hubs/hub"),
+    ("Endpoint=http://a;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://a/clients/socketio/hubs/hub")
+]
+@pytest.mark.parametrize("connection_string,hub,expected_url", test_cases)
+def test_generate_socketio_token(connection_string, hub, expected_url):
+    client = WebPubSubServiceClient.from_connection_string(connection_string, hub)
+    url_1 = client.get_client_access_token(client_protocol="SocketIO")['url']
+
+    assert url_1.split("?")[0] == expected_url
+
+    token_1 = urlparse(url_1).query[len("access_token="):]
+
+    decoded_token_1 = _decode_token(client, token_1, path="/clients/socketio/hubs/hub")
+
+    assert len(decoded_token_1) == 3
+    assert decoded_token_1['aud'] == expected_url.replace('ws', 'http')

sdk/webpubsub/azure-messaging-webpubsubservice/tests/test_jwt_async.py

@@ -15,12 +15,12 @@
     from urllib.parse import urlparse
 
 
-def _decode_token(client, token):
+def _decode_token(client, token, path="/client/hubs/hub"):
     return jwt.decode(
         token,
         client._config.credential.key,
         algorithms=["HS256"],
-        audience=f"{client._config.endpoint}/client/hubs/hub"
+        audience=client._config.endpoint + path
     )
 
 
@@ -119,3 +119,42 @@ async def test_pass_in_jwt_headers(connection_string):
     kid = '1234567890'
     token = (await client.get_client_access_token(jwt_headers={"kid":kid }))['token']
     assert jwt.get_unverified_header(token)['kid'] == kid
+
+test_cases = [
+    ("Endpoint=http://localhost;Port=8080;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://localhost:8080/clients/mqtt/hubs/hub"),
+    ("Endpoint=https://a;AccessKey={};Version=1.0;".format(access_key), "hub", "wss://a/clients/mqtt/hubs/hub"),
+    ("Endpoint=http://a;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://a/clients/mqtt/hubs/hub")
+]
+@pytest.mark.parametrize("connection_string,hub,expected_url", test_cases)
+@pytest.mark.asyncio
+async def test_generate_mqtt_token(connection_string, hub, expected_url):
+    client = WebPubSubServiceClient.from_connection_string(connection_string, hub)
+    url_1 = (await client.get_client_access_token(client_protocol="MQTT"))['url']
+    assert url_1.split("?")[0] == expected_url
+
+    token_1 = urlparse(url_1).query[len("access_token="):]
+
+    decoded_token_1 = _decode_token(client, token_1, path="/clients/mqtt/hubs/hub")
+
+    assert len(decoded_token_1) == 3
+    assert decoded_token_1['aud'] == expected_url.replace('ws', 'http')
+
+test_cases = [
+    ("Endpoint=http://localhost;Port=8080;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://localhost:8080/clients/socketio/hubs/hub"),
+    ("Endpoint=https://a;AccessKey={};Version=1.0;".format(access_key), "hub", "wss://a/clients/socketio/hubs/hub"),
+    ("Endpoint=http://a;AccessKey={};Version=1.0;".format(access_key), "hub", "ws://a/clients/socketio/hubs/hub")
+]
+@pytest.mark.parametrize("connection_string,hub,expected_url", test_cases)
+@pytest.mark.asyncio
+async def test_generate_socketio_token(connection_string, hub, expected_url):
+    client = WebPubSubServiceClient.from_connection_string(connection_string, hub)
+    url_1 = (await client.get_client_access_token(client_protocol="SocketIO"))['url']
+
+    assert url_1.split("?")[0] == expected_url
+
+    token_1 = urlparse(url_1).query[len("access_token="):]
+
+    decoded_token_1 = _decode_token(client, token_1, path="/clients/socketio/hubs/hub")
+
+    assert len(decoded_token_1) == 3
+    assert decoded_token_1['aud'] == expected_url.replace('ws', 'http')