implement routingUrl, dont expose internal errors

Author: StarpTech

.env.example

@@ -1,3 +1,4 @@
 DATABASE_URL="postgresql://postgres:changeme@localhost:5440/graphql-registry?schema=public"
 BASIC_AUTH=123,456
-JWT_SECRET=secret
+JWT_SECRET=secret
+PRETTY_PRINT=true

README.md

@@ -39,7 +39,7 @@ Try all endpoints in [insomnia](https://insomnia.rest/run/?label=GraphQL%20Regis
 ## Big Picture
 
 <div align="center">
-  <img src="./docs/usecases.png" alt="graphql-registry" width="800" />
+  <img src="./docs/usecases-01.png" alt="graphql-registry" width="800" />
 </div>
 
 ## Development

benchmark/composed-schema.js

@@ -5,7 +5,7 @@ export let options = {
   vus: 2,
   duration: '10s',
   thresholds: {
-    http_req_duration: ['p(99)<800'], // 99% of requests must complete below 0.8s
+    http_req_duration: ['p(99)<500'], // 99% of requests must complete below 0.5s
   },
 }
 const BASE_URL = `${__ENV.URL}`

docs/api.md

@@ -31,7 +31,7 @@ GET - `/schema/latest?graphName=my_graph` Returns the last registered (time-base
 
 ### Register a schema
 
-POST - `/schema/push` Creates a new graph and schema for a service. If you omit the `version` field the schema is registered as `current` version. `current` always represent the last registered schema that was pushed without a version.
+POST - `/schema/push` Creates a new graph and schema for a service. If you omit the `version` field the schema is registered as `current` version. `current` always represent the last registered schema that was pushed without a version. Optionally, you can pass `routingUrl` field. The URL that your gateway uses to communicate with the service in a [managed federation](https://www.apollographql.com/docs/federation/managed-federation/overview/) architecture.
 
 **Notice:** A schema is normalized before it's stored in the database. Whitespaces are stipped and graphql elements are sorted lexicographically.
 
@@ -44,7 +44,8 @@ POST - `/schema/push` Creates a new graph and schema for a service. If you omit
   "typeDefs": "type Query { hello: String }",
   "graphName": "my_graph",
   "serviceName": "foo",
-  "version": "1" // optional, uses "current" by default
+  "version": "1", // optional, uses "current" by default
+  "routingUrl": "http://products-graphql.svc.cluster.local:4001/graphql" // optional, for managed federation
 }
 ```
 

docs/usecases-01.png

@@ -64,9 +64,9 @@
     "uid": "^2.0.0"
   },
   "dependencies": {
-    "ajv": "6.12.6",
     "@apollo/federation": "^0.25.0",
     "@graphql-inspector/core": "2.5.0",
+    "ajv": "6.12.6",
     "env-schema": "^3.0.1",
     "fastify": "^3.15.1",
     "fastify-basic-auth": "^2.0.0",
@@ -76,7 +76,8 @@
     "fluent-json-schema": "^3.0.0",
     "graphql": "^15.5.0",
     "knex": "^0.95.5",
-    "pg": "^8.6.0"
+    "pg": "^8.6.0",
+    "pino-pretty": "^4.8.0"
   },
   "keywords": [
     "graphql",

docs/usecases.png

@@ -3,17 +3,23 @@ import registryPlugin from './registry'
 import health from './core/health'
 import knexPlugin from './core/knex-plugin'
 import validatorPlugin from './core/validator-plugin'
+import { ErrorResponse } from './core/types'
 
 export interface buildOptions {
   logger?: boolean
   databaseConnectionUrl: string
   basicAuth?: string
+  prettyPrint?: boolean
   jwtSecret?: string
 }
 
 export default function build(opts: buildOptions) {
   const fastify = Fastify({
-    logger: opts.logger,
+    logger: opts.logger
+      ? {
+          prettyPrint: opts.prettyPrint,
+        }
+      : undefined,
   })
 
   // Custom ajv validator
@@ -43,11 +49,15 @@ export default function build(opts: buildOptions) {
       })
       return
     }
-    reply.code(err.statusCode || 500)
-    reply.send({
+    const result: ErrorResponse = {
       success: false,
-      error: err.message,
-    })
+    }
+    // only expose error informations when it was intented for
+    if (err.name === 'FastifyError') {
+      result.error = err.message
+    }
+
+    reply.code(err.statusCode || 500).send(result)
   })
 
   return fastify

package-lock.json

@@ -4,10 +4,12 @@ export default S.object()
   .prop('DATABASE_URL', S.string())
   .prop('BASIC_AUTH', S.string())
   .prop('JWT_SECRET', S.string())
+  .prop('PRETTY_PRINT', S.boolean().default(false))
   .prop('LOGGER', S.boolean().default(true)) as any
 
 export interface AppSchema {
   DATABASE_URL: string
+  PRETTY_PRINT: boolean
   LOGGER: boolean
   BASIC_AUTH: string
   JWT_SECRET: string