feat(@whook/example): add GraphQL server

nfroidure · Mar 27, 2020 · 3f957d9 · 3f957d9
1 parent cac0452
commit 3f957d9
Show file tree

Hide file tree

Showing 13 changed files with 406 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap b/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap
diff --git a/packages/whook-example/package.json b/packages/whook-example/package.json
@@ -78,7 +78,10 @@
     "@whook/cors": "^3.1.3",
     "@whook/http-router": "^3.1.3",
     "@whook/swagger-ui": "^3.1.3",
+    "@whook/graphql": "^3.1.3",
+    "@whook/graphiql": "^3.1.3",
     "@whook/whook": "^3.1.3",
+    "apollo-server-core": "^2.11.0",
     "common-services": "^7.0.0",
     "ecstatic": "^4.1.2",
     "http-auth-utils": "^2.3.0",

diff --git a/packages/whook-example/src/__snapshots__/cli.test.ts.snap b/packages/whook-example/src/__snapshots__/cli.test.ts.snap
@@ -29,6 +29,9 @@ Object {
 - printEnv: A command printing every env values
 
 
+# Provided by \\"@whook/graphql\\": none
+
+
 # Provided by \\"@whook/cli\\": 6 commands
 - config: A simple program that returns the queryed config value
 - create: A command helping to create new Whook files easily

diff --git a/packages/whook-example/src/__snapshots__/index.test.ts.snap b/packages/whook-example/src/__snapshots__/index.test.ts.snap
diff --git a/packages/whook-example/src/config/common/config.ts b/packages/whook-example/src/config/common/config.ts
@@ -5,6 +5,8 @@ import { WhookConfigs } from '@whook/whook';
 import { AuthenticationConfig } from '../../services/authentication';
 import { APIConfig } from '../../services/API';
 import { DEFAULT_ERRORS_DESCRIPTORS } from '@whook/http-router';
+import { WhookGraphQLConfig } from '@whook/graphql';
+import { WhookGraphIQLConfig } from '@whook/graphiql';
 
 const packageConf = require('../../../package');
 const DEBUG_NODE_ENVS = ['test', 'development', 'staging'];
@@ -15,6 +17,8 @@ export type AppConfigs = WhookConfigs &
   WhookAuthorizationConfig &
   WhookSwaggerUIConfig &
   CORSConfig &
+  WhookGraphQLConfig &
+  WhookGraphIQLConfig &
   APIConfig;
 
 const CONFIG: AppConfigs = {
@@ -53,6 +57,10 @@ const CONFIG: AppConfigs = {
     ].join(','),
     Vary: 'Origin',
   },
+  GRAPHIQL: {
+    path: '/graphiql',
+    defaultQuery: '{ hello }',
+  },
 };
 
 export default CONFIG;
diff --git a/packages/whook-example/src/config/development/config.ts b/packages/whook-example/src/config/development/config.ts
@@ -2,6 +2,7 @@ import COMMON_CONFIG, { AppConfigs } from '../common/config';
 
 const CONFIG: AppConfigs = {
   ...COMMON_CONFIG,
+  DEV_ACCESS_MECHANISM: 'Fake',
   DEV_ACCESS_TOKEN: 'admin|1|1',
   DEFAULT_MECHANISM: 'Fake',
   // This allows you to map service names depending on

diff --git a/packages/whook-example/src/handlers/getGraphQL.ts b/packages/whook-example/src/handlers/getGraphQL.ts
@@ -0,0 +1,21 @@
+import {
+  initGetGraphQL,
+  getGraphQLDefinition as baseDefinition,
+} from '@whook/graphql';
+
+// Add authentication to the base getGraphQL endpoints that
+// would otherwise be public per default
+export const definition = {
+  ...baseDefinition,
+  operation: {
+    ...baseDefinition.operation,
+
+    security: [
+      {
+        bearerAuth: ['admin'],
+      },
+    ],
+  },
+};
+
+export default initGetGraphQL;
diff --git a/packages/whook-example/src/handlers/postGraphQL.ts b/packages/whook-example/src/handlers/postGraphQL.ts
@@ -0,0 +1,21 @@
+import {
+  initPostGraphQL,
+  postGraphQLDefinition as baseDefinition,
+} from '@whook/graphql';
+
+// Add authentication to the base postGraphQL endpoints that
+// would otherwise be public per default
+export const definition = {
+  ...baseDefinition,
+  operation: {
+    ...baseDefinition.operation,
+
+    security: [
+      {
+        bearerAuth: ['admin'],
+      },
+    ],
+  },
+};
+
+export default initPostGraphQL;
diff --git a/packages/whook-example/src/index.ts b/packages/whook-example/src/index.ts
@@ -8,6 +8,9 @@ import {
 } from '@whook/whook';
 import initHTTPRouter from '@whook/http-router';
 import wrapHTTPRouterWithSwaggerUI from '@whook/swagger-ui';
+import wrapHTTPRouterWithGraphIQL from '@whook/graphiql';
+import { initGraphQL, WhookGraphQLFragmentService } from '@whook/graphql';
+import { gql } from 'apollo-server-core';
 
 // Per convention a Whook server main file must export
 //  the following 3 functions to be composable:
@@ -34,7 +37,9 @@ export async function prepareServer<S = Services>(
   // Add here any logic bounded to the server only
   // For example, here we add a Swagger UI page for
   // development purpose
-  $.register(wrapHTTPRouterWithSwaggerUI(initHTTPRouter));
+  $.register(
+    wrapHTTPRouterWithGraphIQL(wrapHTTPRouterWithSwaggerUI(initHTTPRouter)),
+  );
 
   return await prepareBaseServer(injectedNames, $);
 }
@@ -70,7 +75,29 @@ export async function prepareEnvironment(
   $.register(constant('TRANSACTIONS', {}));
 
   // Setup your own whook plugins or avoid whook defaults by leaving it empty
-  $.register(constant('WHOOK_PLUGINS', ['@whook/cli', '@whook/whook']));
+  $.register(
+    constant('WHOOK_PLUGINS', ['@whook/graphql', '@whook/cli', '@whook/whook']),
+  );
+
+  // Declare the GraphQL schema fragments
+  const helloFragment: WhookGraphQLFragmentService = {
+    typeDefs: gql`
+      type Query {
+        hello: String
+      }
+      schema {
+        query: Query
+      }
+    `,
+    resolvers: {
+      Query: {
+        hello: () => 'Hello world!',
+      },
+    },
+  };
+
+  $.register(initGraphQL);
+  $.register(constant('graphQLFragments', [helloFragment]));
 
   return $;
 }
diff --git a/packages/whook-example/src/services/API.ts b/packages/whook-example/src/services/API.ts
@@ -3,6 +3,7 @@ import { augmentAPIWithCORS } from '@whook/cors';
 import { WhookConfig, WhookAPIDefinitions, noop } from '@whook/whook';
 import { LogService } from 'common-services';
 import { OpenAPIV3 } from 'openapi-types';
+import { getGraphQLDefinition, postGraphQLDefinition } from '@whook/graphql';
 
 export type APIEnv = {
   DEV_MODE?: string;

diff --git a/packages/whook-example/src/services/__snapshots__/API.test.ts.snap b/packages/whook-example/src/services/__snapshots__/API.test.ts.snap
@@ -5,17 +5,21 @@ exports[`API should always have the same amount of basic authenticated endpoints
 exports[`API should always have the same amount of bearer authenticated endpoints 1`] = `
 Array [
   "get /diag",
+  "get /graphql",
   "get /openAPI",
+  "post /graphql",
 ]
 `;
 
 exports[`API should always have the same amount of endpoints 1`] = `
 Array [
   "get /delay",
   "get /diag",
+  "get /graphql",
   "get /openAPI",
   "get /ping",
   "get /time",
+  "post /graphql",
   "put /echo",
 ]
 `;
@@ -28,6 +32,7 @@ Array [
   "options /delay",
   "options /diag",
   "options /echo",
+  "options /graphql",
   "options /openAPI",
   "options /ping",
   "options /time",
@@ -45,9 +50,11 @@ exports[`API should always have the same amount of publicly documented endpoints
 Array [
   "get /delay",
   "get /diag",
+  "get /graphql",
   "get /openAPI",
   "get /ping",
   "get /time",
+  "post /graphql",
   "put /echo",
 ]
 `;
@@ -278,6 +285,163 @@ Object {
           ],
         },
       },
+      "/graphql": Object {
+        "get": Object {
+          "operationId": "getGraphQL",
+          "parameters": Array [
+            Object {
+              "description": "The GraphQL query",
+              "in": "query",
+              "name": "query",
+              "required": true,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+            Object {
+              "description": "The GraphQL variables",
+              "in": "query",
+              "name": "variables",
+              "required": false,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+            Object {
+              "description": "The GraphQL operation name",
+              "in": "query",
+              "name": "operationName",
+              "required": false,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+          ],
+          "responses": Object {
+            "200": Object {
+              "content": Object {
+                "application/json": Object {
+                  "schema": Object {
+                    "additionalProperties": true,
+                    "type": "object",
+                  },
+                },
+              },
+              "description": "Successfully ran the GraphQL query",
+            },
+          },
+          "security": Array [
+            Object {
+              "bearerAuth": Array [
+                "admin",
+              ],
+            },
+          ],
+          "summary": "Graphql endpoint",
+          "tags": Array [
+            "graphql",
+          ],
+        },
+        "options": Object {
+          "operationId": "optionsWithCORS",
+          "parameters": Array [
+            Object {
+              "description": "The GraphQL query",
+              "in": "query",
+              "name": "query",
+              "required": false,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+            Object {
+              "description": "The GraphQL variables",
+              "in": "query",
+              "name": "variables",
+              "required": false,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+            Object {
+              "description": "The GraphQL operation name",
+              "in": "query",
+              "name": "operationName",
+              "required": false,
+              "schema": Object {
+                "type": "string",
+              },
+            },
+            Object {
+              "in": "query",
+              "name": "access_token",
+              "schema": Object {
+                "type": "string",
+              },
+            },
+          ],
+          "responses": Object {
+            "200": Object {
+              "description": "CORS sent.",
+            },
+          },
+          "summary": "Enable OPTIONS for CORS",
+          "tags": Array [
+            "CORS",
+          ],
+          "x-whook": Object {
+            "private": true,
+            "sourceOperationId": "getGraphQL",
+            "suffix": "CORS",
+            "type": "http",
+          },
+        },
+        "post": Object {
+          "operationId": "postGraphQL",
+          "parameters": Array [],
+          "requestBody": Object {
+            "content": Object {
+              "application/json": Object {
+                "schema": Object {
+                  "additionalProperties": true,
+                  "properties": Object {
+                    "query": Object {
+                      "type": "string",
+                    },
+                  },
+                  "type": "object",
+                },
+              },
+            },
+            "description": "The GraphQL query",
+            "required": false,
+          },
+          "responses": Object {
+            "200": Object {
+              "content": Object {
+                "application/json": Object {
+                  "schema": Object {
+                    "additionalProperties": true,
+                    "type": "object",
+                  },
+                },
+              },
+              "description": "Successfully ran the GraphQL query",
+            },
+          },
+          "security": Array [
+            Object {
+              "bearerAuth": Array [
+                "admin",
+              ],
+            },
+          ],
+          "summary": "Graphql endpoint",
+          "tags": Array [
+            "graphql",
+          ],
+        },
+      },
       "/openAPI": Object {
         "get": Object {
           "operationId": "getOpenAPI",

diff --git a/packages/whook-graphql/src/index.test.ts b/packages/whook-graphql/src/index.test.ts
@@ -191,7 +191,10 @@ describe('GraphQL server', () => {
     );
     $.register(
       constant('GRAPHQL_SERVER_OPTIONS', {
-        context,
+        context: async ({ operation, requestContext }) => ({
+          operationId: operation.operationId,
+          authenticationData: requestContext.authenticationData,
+        }),
       }),
     );