Improvements on runtime and JIT logic

ardatan · Oct 9, 2023 · 482d813 · 482d813
1 parent 181f0e4
commit 482d813
Show file tree

Hide file tree

Showing 14 changed files with 233 additions and 80 deletions.
diff --git a/.changeset/grumpy-onions-fold.md b/.changeset/grumpy-onions-fold.md
@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/transform-federation': patch
+---
+
+Remove other directives in scalars just like it is done for objects and other types
diff --git a/.changeset/hot-bugs-hammer.md b/.changeset/hot-bugs-hammer.md
@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/runtime': patch
+---
+
+Simplify the logic and use GraphQL Tools executor
diff --git a/.changeset/many-turkeys-share.md b/.changeset/many-turkeys-share.md
@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/grpc': patch
+---
+
+Add response streams as subscriptions
diff --git a/.changeset/seven-bags-exist.md b/.changeset/seven-bags-exist.md
@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/runtime': patch
+---
+
+Do not cache entire request but only DocumentNode
diff --git a/examples/grpc-example/example-queries/MoviesByCast.subscription.graphql b/examples/grpc-example/example-queries/MoviesByCast.subscription.graphql
@@ -0,0 +1,8 @@
+subscription SearchMoviesByCast {
+  exampleSearchMoviesByCast(input: { castName: "Tom Cruise" }) {
+    name
+    year
+    rating
+    cast
+  }
+}
diff --git a/examples/grpc-example/tests/__snapshots__/grpc.test.ts.snap b/examples/grpc-example/tests/__snapshots__/grpc.test.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-0 1`] = `
+exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-stream-0 1`] = `
 {
   "data": {
     "exampleSearchMoviesByCast": [],
@@ -9,7 +9,7 @@ exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-
 }
 `;
 
-exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-1 1`] = `
+exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-stream-1 1`] = `
 {
   "hasNext": true,
   "incremental": [
@@ -35,7 +35,7 @@ exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-
 }
 `;
 
-exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-2 1`] = `
+exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-stream-2 1`] = `
 {
   "hasNext": true,
   "incremental": [
@@ -61,15 +61,50 @@ exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-
 }
 `;
 
-exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-3 1`] = `
+exports[`gRPC Example should fetch movies by cast as a stream correctly: movies-by-cast-grpc-example-result-stream-3 1`] = `
 {
   "hasNext": false,
 }
 `;
 
+exports[`gRPC Example should fetch movies by cast as a subscription correctly: movies-by-cast-grpc-example-result-subscription-0 1`] = `
+{
+  "data": {
+    "exampleSearchMoviesByCast": {
+      "cast": [
+        "Tom Cruise",
+        "Simon Pegg",
+        "Jeremy Renner",
+      ],
+      "name": "Mission: Impossible Rogue Nation",
+      "rating": 0.9700000286102295,
+      "year": 2015,
+    },
+  },
+}
+`;
+
+exports[`gRPC Example should fetch movies by cast as a subscription correctly: movies-by-cast-grpc-example-result-subscription-1 1`] = `
+{
+  "data": {
+    "exampleSearchMoviesByCast": {
+      "cast": [
+        "Tom Cruise",
+        "Simon Pegg",
+        "Henry Cavill",
+      ],
+      "name": "Mission: Impossible - Fallout",
+      "rating": 0.9300000071525574,
+      "year": 2018,
+    },
+  },
+}
+`;
+
 exports[`gRPC Example should generate correct schema: grpc-schema 1`] = `
 "schema {
   query: Query
+  subscription: Subscription
 }
 
 directive @grpcMethod(rootJsonName: String, objPath: String, methodName: String, responseStream: Boolean) on FIELD_DEFINITION
@@ -166,6 +201,13 @@ enum ConnectivityState {
   SHUTDOWN
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  exampleSearchMoviesByCast(input: SearchByCastRequest_Input): Movie @grpcMethod(rootJsonName: "Root0", objPath: "Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  anotherExampleSearchMoviesByCast(input: SearchByCastRequest_Input): Movie @grpcMethod(rootJsonName: "Root0", objPath: "AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
 

diff --git a/examples/grpc-example/tests/grpc.test.ts b/examples/grpc-example/tests/grpc.test.ts
@@ -36,7 +36,18 @@ describe('gRPC Example', () => {
     const result = await mesh.execute(MoviesByCastStream, undefined);
     let i = 0;
     for await (const item of result as AsyncIterable<any>) {
-      expect(item).toMatchSnapshot(`movies-by-cast-grpc-example-result-${i++}`);
+      expect(item).toMatchSnapshot(`movies-by-cast-grpc-example-result-stream-${i++}`);
+    }
+  });
+  it('should fetch movies by cast as a subscription correctly', async () => {
+    const MoviesByCastSubscription = await readFile(
+      join(__dirname, '../example-queries/MoviesByCast.subscription.graphql'),
+      'utf8',
+    );
+    const result = await mesh.execute(MoviesByCastSubscription, undefined);
+    let i = 0;
+    for await (const item of result as AsyncIterable<any>) {
+      expect(item).toMatchSnapshot(`movies-by-cast-grpc-example-result-subscription-${i++}`);
     }
   });
   afterAll(async () => {

diff --git a/packages/handlers/grpc/src/index.ts b/packages/handlers/grpc/src/index.ts
@@ -419,11 +419,22 @@ export default class GrpcHandler implements MeshHandler {
                   objPath,
                   creds,
                 });
-                field.resolve = this.getFieldResolver({
-                  client,
-                  methodName,
-                  isResponseStream: responseStream,
-                });
+                if (rootType.name === 'Subscription') {
+                  field.subscribe = this.getFieldResolver({
+                    client,
+                    methodName,
+                    isResponseStream: responseStream,
+                  });
+                  field.resolve = function identityFn(root) {
+                    return root;
+                  };
+                } else {
+                  field.resolve = this.getFieldResolver({
+                    client,
+                    methodName,
+                    isResponseStream: responseStream,
+                  });
+                }
                 break;
               }
               case 'grpcConnectivityState': {
@@ -598,26 +609,29 @@ export default class GrpcHandler implements MeshHandler {
       for (const methodName in nested.methods) {
         const method = nested.methods[methodName];
         const rootFieldName = [...pathWithName, methodName].join('_');
+        const fieldConfigTypeFactory = () => {
+          const baseResponseTypePath = method.responseType?.split('.');
+          if (baseResponseTypePath) {
+            const responseTypePath = this.walkToFindTypePath(
+              rootJson,
+              pathWithName,
+              baseResponseTypePath,
+            );
+            return getTypeName(this.schemaComposer, responseTypePath, false);
+          }
+          return 'Void';
+        };
         const fieldConfig: ObjectTypeComposerFieldConfigAsObjectDefinition<any, any> = {
           type: () => {
-            const baseResponseTypePath = method.responseType?.split('.');
-            if (baseResponseTypePath) {
-              const responseTypePath = this.walkToFindTypePath(
-                rootJson,
-                pathWithName,
-                baseResponseTypePath,
-              );
-              let typeName = getTypeName(this.schemaComposer, responseTypePath, false);
-              if (method.responseStream) {
-                typeName = `[${typeName}]`;
-              }
-              return typeName;
+            const typeName = fieldConfigTypeFactory();
+            if (method.responseStream) {
+              return `[${typeName}]`;
             }
-            return 'Void';
+            return typeName;
           },
           description: method.comment,
         };
-        fieldConfig.args = {
+        const fieldConfigArgs = {
           input: () => {
             if (method.requestStream) {
               return 'File';
@@ -635,6 +649,7 @@ export default class GrpcHandler implements MeshHandler {
             return undefined;
           },
         };
+        fieldConfig.args = fieldConfigArgs;
         const methodNameLowerCased = methodName.toLowerCase();
         const prefixQueryMethod = this.config.prefixQueryMethod || QUERY_METHOD_PREFIXES;
         const rootTypeComposer = prefixQueryMethod.some(prefix =>
@@ -659,6 +674,26 @@ export default class GrpcHandler implements MeshHandler {
             ],
           },
         });
+        if (method.responseStream) {
+          this.schemaComposer.Subscription.addFields({
+            [rootFieldName]: {
+              args: fieldConfigArgs,
+              description: method.comment,
+              type: fieldConfigTypeFactory,
+              directives: [
+                {
+                  name: 'grpcMethod',
+                  args: {
+                    rootJsonName,
+                    objPath,
+                    methodName,
+                    responseStream: true,
+                  },
+                },
+              ],
+            },
+          });
+        }
       }
       const connectivityStateFieldName = pathWithName.join('_') + '_connectivityState';
       this.schemaComposer.addDirective(grpcConnectivityStateDirective);

diff --git a/packages/handlers/grpc/test/__snapshots__/handler.spec.ts.snap b/packages/handlers/grpc/test/__snapshots__/handler.spec.ts.snap
@@ -187,6 +187,7 @@ scalar ObjMap"
 exports[`gRPC Handler Interpreting Protos should load the Empty proto 1`] = `
 "schema {
   query: Query
+  subscription: Subscription
 }
 
 directive @enum(value: String) on ENUM_VALUE
@@ -286,6 +287,13 @@ enum ConnectivityState {
   SHUTDOWN
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  io_xtech_Example_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  io_xtech_AnotherExample_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
 
@@ -453,6 +461,7 @@ scalar ObjMap"
 exports[`gRPC Handler Interpreting Protos should load the Movie proto 1`] = `
 "schema {
   query: Query
+  subscription: Subscription
 }
 
 directive @enum(value: String) on ENUM_VALUE
@@ -549,6 +558,13 @@ enum ConnectivityState {
   SHUTDOWN
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  io_xtech_Example_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  io_xtech_AnotherExample_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
 
@@ -661,6 +677,7 @@ scalar ObjMap"
 exports[`gRPC Handler Interpreting Protos should load the Outside proto 1`] = `
 "schema {
   query: Query
+  subscription: Subscription
 }
 
 directive @grpcMethod(rootJsonName: String, objPath: String, methodName: String, responseStream: Boolean) on FIELD_DEFINITION
@@ -767,6 +784,13 @@ input io_xtech_SearchByCastRequest_Input {
   castName: String
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  io_xtech_Example_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  io_xtech_AnotherExample_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
 
@@ -859,6 +883,7 @@ scalar ObjMap"
 exports[`gRPC Handler Interpreting Protos should load the With Underscores proto 1`] = `
 "schema {
   query: Query
+  subscription: Subscription
 }
 
 directive @enum(value: String) on ENUM_VALUE
@@ -955,13 +980,21 @@ enum ConnectivityState {
   SHUTDOWN
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  io_xtech_Example_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  io_xtech_AnotherExample_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
 
 exports[`gRPC Handler Load proto with prefixQueryMethod should load the retrieve-movie.proto 1`] = `
 "schema {
   query: Query
   mutation: Mutation
+  subscription: Subscription
 }
 
 directive @enum(value: String) on ENUM_VALUE
@@ -1069,5 +1102,12 @@ input io_xtech_SearchByCastRequest_Input {
   castName: String
 }
 
+type Subscription {
+  "search movies by the name of the cast"
+  io_xtech_Example_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.Example", methodName: "SearchMoviesByCast", responseStream: true)
+  "search movies by the name of the cast"
+  io_xtech_AnotherExample_SearchMoviesByCast(input: io_xtech_SearchByCastRequest_Input): io_xtech_Movie @grpcMethod(rootJsonName: "Root0", objPath: "io.xtech.AnotherExample", methodName: "SearchMoviesByCast", responseStream: true)
+}
+
 scalar ObjMap"
 `;
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -46,6 +46,7 @@
     "@graphql-mesh/string-interpolation": "^0.5.2",
     "@graphql-tools/batch-delegate": "^9.0.0",
     "@graphql-tools/delegate": "^10.0.0",
+    "@graphql-tools/executor": "^1.2.0",
     "@graphql-tools/wrap": "^10.0.0",
     "@whatwg-node/fetch": "^0.9.0",
     "graphql-jit": "0.8.2"