Merge pull request #144 from rsocket/graphql

Graphql

Author: jell-o-fishi

CHANGELOG.rst

@@ -1,6 +1,10 @@
 Changelog
 ---------
 
+v0.4.13
+=======
+- GraphQL basic support (See examples/graphql)
+
 v0.4.12
 =======
 - Fixed fragmentation for fire and forget

README.md

@@ -25,6 +25,7 @@ You may also install using some **extras**:
 | cli         | Command line                        |
 | optimized   | Frame parse/serialize optimizations |
 | cloudevents | CloudEvents integration             |
+| graphql     | GraphQL integration                 |
 
 ```shell
 pip install rsocket[reactivex]

docs/conf.py

@@ -24,7 +24,7 @@
 author = 'jellofishi@pm.me'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.12'
+release = '0.4.13'
 
 # -- General configuration ---------------------------------------------------
 

examples/graphql/__init__.py

@@ -0,0 +1,57 @@
+import asyncio
+import logging
+import sys
+from pathlib import Path
+
+from gql import gql, Client
+
+from rsocket.extensions.mimetypes import WellKnownMimeTypes
+from rsocket.graphql.rsocket_transport import RSocketTransport
+from rsocket.helpers import single_transport_provider
+from rsocket.rsocket_client import RSocketClient
+from rsocket.transports.tcp import TransportTCP
+
+
+async def main(server_port: int):
+    connection = await asyncio.open_connection('localhost', server_port)
+
+    async with RSocketClient(single_transport_provider(TransportTCP(*connection)),
+                             metadata_encoding=WellKnownMimeTypes.MESSAGE_RSOCKET_COMPOSITE_METADATA) as client:
+        with (Path(__file__).parent / 'rsocket.graphqls').open() as fd:
+            schema = fd.read()
+
+        graphql = Client(
+            schema=schema,
+            transport=RSocketTransport(client),
+        )
+
+        await greeting(graphql)
+
+        await subscription(graphql)
+
+
+async def subscription(graphql: Client):
+    async for response in graphql.subscribe_async(
+            document=gql("""
+                subscription {
+                    greetings {message}
+                }
+                """),
+            get_execution_result=True):
+        print(response.data)
+
+
+async def greeting(graphql: Client):
+    response = await graphql.execute_async(
+        gql("""query { greeting { message } }"""),
+        get_execution_result=True)
+
+    assert response.data['greeting']['message'] == 'Hello world'
+
+    print(response.data)
+
+
+if __name__ == '__main__':
+    port = sys.argv[1] if len(sys.argv) > 1 else 9191
+    logging.basicConfig(level=logging.DEBUG)
+    asyncio.run(main(port))

examples/graphql/client_graphql.py

@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

examples/graphql/java/.gitignore

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>3.1.4</version>
+		<relativePath/> <!-- lookup parent from repository -->
+	</parent>
+	<groupId>com.example</groupId>
+	<artifactId>demo</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<name>demo</name>
+	<description>Demo project for Spring Boot</description>
+	<properties>
+		<java.version>17</java.version>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-graphql</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-rsocket</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>io.projectreactor</groupId>
+			<artifactId>reactor-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.graphql</groupId>
+			<artifactId>spring-graphql-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>

examples/graphql/java/pom.xml

@@ -0,0 +1,48 @@
+package com.example.demo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.graphql.data.method.annotation.QueryMapping;
+import org.springframework.graphql.data.method.annotation.SubscriptionMapping;
+import org.springframework.stereotype.Controller;
+import reactor.core.publisher.Flux;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.function.Supplier;
+import java.util.stream.Stream;
+
+@SpringBootApplication
+public class DemoApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(DemoApplication.class, args);
+    }
+
+}
+
+
+@Controller
+class GreetingsController {
+    @SubscriptionMapping
+    Flux<Greeting> greetings() {
+        return Flux.fromStream(Stream.generate(
+                        new Supplier<Greeting>() {
+                            @Override
+                            public Greeting get() {
+                                return new Greeting("Hello world @" + Instant.now() + "!");
+                            }
+                        }
+                )).delayElements(Duration.ofSeconds(1))
+                .take(10);
+    }
+
+    @QueryMapping
+    Greeting greeting() {
+        return new Greeting("Hello world");
+    }
+}
+
+record Greeting(String message) {
+
+}

examples/graphql/java/src/main/java/com/example/demo/DemoApplication.java

@@ -0,0 +1,3 @@
+spring.rsocket.server.port=9191
+spring.graphql.rsocket.mapping=graphql
+server.port=0

examples/graphql/java/src/main/resources/application.properties

@@ -0,0 +1,11 @@
+type Query {
+    greeting: Greeting
+}
+
+type Subscription {
+    greetings: Greeting
+}
+
+type Greeting {
+    message: String
+}

examples/graphql/java/src/main/resources/graphql/rsocket.graphqls

@@ -0,0 +1,13 @@
+package com.example.demo;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class DemoApplicationTests {
+
+	@Test
+	void contextLoads() {
+	}
+
+}

examples/graphql/java/src/test/java/com/example/demo/DemoApplicationTests.java

@@ -0,0 +1,11 @@
+type Query {
+    greeting: Greeting
+}
+
+type Subscription {
+    greetings: Greeting
+}
+
+type Greeting {
+    message: String
+}

examples/graphql/rsocket.graphqls

@@ -0,0 +1,118 @@
+from graphql.type.definition import (
+    GraphQLArgument,
+    GraphQLField,
+    GraphQLNonNull,
+    GraphQLObjectType,
+)
+from graphql.type.scalars import GraphQLString
+from graphql.type.schema import GraphQLSchema
+
+
+def resolve_raises(*_):
+    raise Exception("Throws!")
+
+
+EchoType = GraphQLObjectType(
+    name="Echo",
+    fields={
+        "message": GraphQLField(
+            type_=GraphQLString,
+            description="The message echoed back",
+        )
+    },
+    description="The result of an echo request",
+)
+
+GreetingType = GraphQLObjectType(
+    name="Greeting",
+    fields={
+        "message": GraphQLField(
+            type_=GraphQLString,
+            description="The message echoed back",
+        )
+    },
+    description="The result of an echo request",
+)
+
+# Sync schema
+QueryRootType = GraphQLObjectType(
+    name="QueryRoot",
+    fields={
+        "thrower": GraphQLField(
+            GraphQLNonNull(GraphQLString),
+            resolve=resolve_raises,
+        ),
+        "request": GraphQLField(
+            GraphQLNonNull(GraphQLString),
+            resolve=lambda obj, info, *args: info.context["request"].query.get("q"),
+        ),
+        "context": GraphQLField(
+            GraphQLObjectType(
+                name="context",
+                fields={
+                    "session": GraphQLField(GraphQLString),
+                    "request": GraphQLField(
+                        GraphQLNonNull(GraphQLString),
+                        resolve=lambda obj, info: info.context["request"],
+                    ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
+                },
+            ),
+            resolve=lambda obj, info: info.context,
+        ),
+        "test": GraphQLField(
+            type_=GraphQLString,
+            args={"who": GraphQLArgument(GraphQLString)},
+            resolve=lambda obj, info, who=None: "Hello %s" % (who or "World"),
+        ),
+    },
+)
+
+
+async def resolve_greeting(_obj, info):
+    return "hello world"
+
+
+async def resolve_echo(_obj, info, input):
+    return {'message': input}
+
+
+async def resolve_multiple_greetings(_obj, info):
+    for index, greeting in enumerate(['Hello', 'Hi', 'Yo']):
+        yield {'message': greeting}
+
+
+AsyncQueryType = GraphQLObjectType(
+    "AsyncQueryType",
+    {
+        "greeting": GraphQLField(
+            GraphQLString,
+            resolve=resolve_greeting),
+        "echo": GraphQLField(
+            EchoType,
+            args={"input": GraphQLArgument(GraphQLString)},
+            resolve=resolve_echo)
+    }
+)
+
+MutationRootType = GraphQLObjectType(
+    name="MutationRoot",
+    fields={
+        "writeTest": GraphQLField(
+            type_=QueryRootType, resolve=lambda *args: QueryRootType
+        )
+    },
+)
+
+SubscriptionsRootType = GraphQLObjectType(
+    name="SubscriptionsRoot",
+    fields={
+        "multipleGreetings": GraphQLField(
+            type_=GreetingType, subscribe=resolve_multiple_greetings
+        )
+    }
+)
+
+AsyncSchema = GraphQLSchema(AsyncQueryType, subscription=SubscriptionsRootType)