Aws appsync websocket transport

README.md

@@ -34,7 +34,12 @@ The complete documentation for GQL can be found at
 
 The main features of GQL are:
 
-* Execute GraphQL queries using [different protocols](https://gql.readthedocs.io/en/latest/transports/index.html) (http, websockets, ...)
+* Execute GraphQL queries using [different protocols](https://gql.readthedocs.io/en/latest/transports/index.html):
+  * http
+  * websockets:
+    * apollo or graphql-ws protocol
+    * Phoenix channels
+    * AWS AppSync realtime protocol (experimental)
 * Possibility to [validate the queries locally](https://gql.readthedocs.io/en/latest/usage/validation.html) using a GraphQL schema provided locally or fetched from the backend using an instrospection query
 * Supports GraphQL queries, mutations and [subscriptions](https://gql.readthedocs.io/en/latest/usage/subscriptions.html)
 * Supports [sync or async usage](https://gql.readthedocs.io/en/latest/async/index.html), [allowing concurrent requests](https://gql.readthedocs.io/en/latest/advanced/async_advanced_usage.html#async-advanced-usage)

docs/code_examples/appsync/mutation_api_key.py

@@ -0,0 +1,54 @@
+import asyncio
+import os
+import sys
+from urllib.parse import urlparse
+
+from gql import Client, gql
+from gql.transport.aiohttp import AIOHTTPTransport
+from gql.transport.appsync_auth import AppSyncApiKeyAuthentication
+
+# Uncomment the following lines to enable debug output
+# import logging
+# logging.basicConfig(level=logging.DEBUG)
+
+
+async def main():
+
+    # Should look like:
+    # https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.REGION.amazonaws.com/graphql
+    url = os.environ.get("AWS_GRAPHQL_API_ENDPOINT")
+    api_key = os.environ.get("AWS_GRAPHQL_API_KEY")
+
+    if url is None or api_key is None:
+        print("Missing environment variables")
+        sys.exit()
+
+    # Extract host from url
+    host = str(urlparse(url).netloc)
+
+    auth = AppSyncApiKeyAuthentication(host=host, api_key=api_key)
+
+    transport = AIOHTTPTransport(url=url, auth=auth)
+
+    async with Client(
+        transport=transport, fetch_schema_from_transport=False,
+    ) as session:
+
+        query = gql(
+            """
+mutation createMessage($message: String!) {
+  createMessage(input: {message: $message}) {
+    id
+    message
+    createdAt
+  }
+}"""
+        )
+
+        variable_values = {"message": "Hello world!"}
+
+        result = await session.execute(query, variable_values=variable_values)
+        print(result)
+
+
+asyncio.run(main())

docs/code_examples/appsync/mutation_iam.py

@@ -0,0 +1,53 @@
+import asyncio
+import os
+import sys
+from urllib.parse import urlparse
+
+from gql import Client, gql
+from gql.transport.aiohttp import AIOHTTPTransport
+from gql.transport.appsync_auth import AppSyncIAMAuthentication
+
+# Uncomment the following lines to enable debug output
+# import logging
+# logging.basicConfig(level=logging.DEBUG)
+
+
+async def main():
+
+    # Should look like:
+    # https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.REGION.amazonaws.com/graphql
+    url = os.environ.get("AWS_GRAPHQL_API_ENDPOINT")
+
+    if url is None:
+        print("Missing environment variables")
+        sys.exit()
+
+    # Extract host from url
+    host = str(urlparse(url).netloc)
+
+    auth = AppSyncIAMAuthentication(host=host)
+
+    transport = AIOHTTPTransport(url=url, auth=auth)
+
+    async with Client(
+        transport=transport, fetch_schema_from_transport=False,
+    ) as session:
+
+        query = gql(
+            """
+mutation createMessage($message: String!) {
+  createMessage(input: {message: $message}) {
+    id
+    message
+    createdAt
+  }
+}"""
+        )
+
+        variable_values = {"message": "Hello world!"}
+
+        result = await session.execute(query, variable_values=variable_values)
+        print(result)
+
+
+asyncio.run(main())

docs/code_examples/appsync/subscription_api_key.py

@@ -0,0 +1,53 @@
+import asyncio
+import os
+import sys
+from urllib.parse import urlparse
+
+from gql import Client, gql
+from gql.transport.appsync_auth import AppSyncApiKeyAuthentication
+from gql.transport.appsync_websockets import AppSyncWebsocketsTransport
+
+# Uncomment the following lines to enable debug output
+# import logging
+# logging.basicConfig(level=logging.DEBUG)
+
+
+async def main():
+
+    # Should look like:
+    # https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.REGION.amazonaws.com/graphql
+    url = os.environ.get("AWS_GRAPHQL_API_ENDPOINT")
+    api_key = os.environ.get("AWS_GRAPHQL_API_KEY")
+
+    if url is None or api_key is None:
+        print("Missing environment variables")
+        sys.exit()
+
+    # Extract host from url
+    host = str(urlparse(url).netloc)
+
+    print(f"Host: {host}")
+
+    auth = AppSyncApiKeyAuthentication(host=host, api_key=api_key)
+
+    transport = AppSyncWebsocketsTransport(url=url, auth=auth)
+
+    async with Client(transport=transport) as session:
+
+        subscription = gql(
+            """
+subscription onCreateMessage {
+  onCreateMessage {
+    message
+  }
+}
+"""
+        )
+
+        print("Waiting for messages...")
+
+        async for result in session.subscribe(subscription):
+            print(result)
+
+
+asyncio.run(main())

docs/code_examples/appsync/subscription_iam.py

@@ -0,0 +1,44 @@
+import asyncio
+import os
+import sys
+
+from gql import Client, gql
+from gql.transport.appsync_websockets import AppSyncWebsocketsTransport
+
+# Uncomment the following lines to enable debug output
+# import logging
+# logging.basicConfig(level=logging.DEBUG)
+
+
+async def main():
+
+    # Should look like:
+    # https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.REGION.amazonaws.com/graphql
+    url = os.environ.get("AWS_GRAPHQL_API_ENDPOINT")
+
+    if url is None:
+        print("Missing environment variables")
+        sys.exit()
+
+    # Using implicit auth (IAM)
+    transport = AppSyncWebsocketsTransport(url=url)
+
+    async with Client(transport=transport) as session:
+
+        subscription = gql(
+            """
+subscription onCreateMessage {
+  onCreateMessage {
+    message
+  }
+}
+"""
+        )
+
+        print("Waiting for messages...")
+
+        async for result in session.subscribe(subscription):
+            print(result)
+
+
+asyncio.run(main())

docs/intro.rst

@@ -35,19 +35,23 @@ which needs the :code:`aiohttp` dependency, then you can install GQL with::
 
     pip install --pre gql[aiohttp]
 
-The corresponding between extra dependencies required and the GQL transports is:
-
-+-------------------+----------------------------------------------------------------+
-| Extra dependency  | Transports                                                     |
-+===================+================================================================+
-| aiohttp           | :ref:`AIOHTTPTransport <aiohttp_transport>`                    |
-+-------------------+----------------------------------------------------------------+
-| websockets        | :ref:`WebsocketsTransport <websockets_transport>`              |
-|                   |                                                                |
-|                   | :ref:`PhoenixChannelWebsocketsTransport <phoenix_transport>`   |
-+-------------------+----------------------------------------------------------------+
-| requests          | :ref:`RequestsHTTPTransport <requests_transport>`              |
-+-------------------+----------------------------------------------------------------+
+The corresponding between extra dependencies required and the GQL classes is:
+
++---------------------+----------------------------------------------------------------+
+| Extra dependencies  | Classes                                                        |
++=====================+================================================================+
+| aiohttp             | :ref:`AIOHTTPTransport <aiohttp_transport>`                    |
++---------------------+----------------------------------------------------------------+
+| websockets          | :ref:`WebsocketsTransport <websockets_transport>`              |
+|                     |                                                                |
+|                     | :ref:`PhoenixChannelWebsocketsTransport <phoenix_transport>`   |
+|                     |                                                                |
+|                     | :ref:`AppSyncWebsocketsTransport <appsync_transport>`          |
++---------------------+----------------------------------------------------------------+
+| requests            | :ref:`RequestsHTTPTransport <requests_transport>`              |
++---------------------+----------------------------------------------------------------+
+| botocore            | :ref:`AppSyncIAMAuthentication <appsync_iam_auth>`             |
++---------------------+----------------------------------------------------------------+
 
 .. note::
 

docs/modules/gql.rst

@@ -20,6 +20,13 @@ Sub-Packages
 
    client
    transport
+   transport_aiohttp
+   transport_appsync_auth
+   transport_appsync_websockets
    transport_exceptions
+   transport_phoenix_channel_websockets
+   transport_requests
+   transport_websockets
+   transport_websockets_base
    dsl
    utilities

docs/modules/transport.rst

@@ -5,14 +5,6 @@ gql.transport
 
 .. autoclass:: gql.transport.transport.Transport
 
-.. autoclass:: gql.transport.local_schema.LocalSchemaTransport
-
-.. autoclass:: gql.transport.requests.RequestsHTTPTransport
-
 .. autoclass:: gql.transport.async_transport.AsyncTransport
 
-.. autoclass:: gql.transport.aiohttp.AIOHTTPTransport
-
-.. autoclass:: gql.transport.websockets.WebsocketsTransport
-
-.. autoclass:: gql.transport.phoenix_channel_websockets.PhoenixChannelWebsocketsTransport
+.. autoclass:: gql.transport.local_schema.LocalSchemaTransport

docs/modules/transport_aiohttp.rst

@@ -0,0 +1,7 @@
+gql.transport.aiohttp
+=====================
+
+.. currentmodule:: gql.transport.aiohttp
+
+.. automodule:: gql.transport.aiohttp
+    :member-order: bysource

docs/modules/transport_appsync_auth.rst

@@ -0,0 +1,7 @@
+gql.transport.appsync_auth
+==========================
+
+.. currentmodule:: gql.transport.appsync_auth
+
+.. automodule:: gql.transport.appsync_auth
+    :member-order: bysource

docs/modules/transport_appsync_websockets.rst

@@ -0,0 +1,7 @@
+gql.transport.appsync_websockets
+================================
+
+.. currentmodule:: gql.transport.appsync_websockets
+
+.. automodule:: gql.transport.appsync_websockets
+    :member-order: bysource

docs/modules/transport_phoenix_channel_websockets.rst

@@ -0,0 +1,7 @@
+gql.transport.phoenix_channel_websockets
+========================================
+
+.. currentmodule:: gql.transport.phoenix_channel_websockets
+
+.. automodule:: gql.transport.phoenix_channel_websockets
+    :member-order: bysource

docs/modules/transport_requests.rst

@@ -0,0 +1,7 @@
+gql.transport.requests
+======================
+
+.. currentmodule:: gql.transport.requests
+
+.. automodule:: gql.transport.requests
+    :member-order: bysource

docs/modules/transport_websockets.rst

@@ -0,0 +1,7 @@
+gql.transport.websockets
+========================
+
+.. currentmodule:: gql.transport.websockets
+
+.. automodule:: gql.transport.websockets
+    :member-order: bysource

docs/modules/transport_websockets_base.rst

@@ -0,0 +1,7 @@
+gql.transport.websockets_base
+=============================
+
+.. currentmodule:: gql.transport.websockets_base
+
+.. automodule:: gql.transport.websockets_base
+    :member-order: bysource