Update logging example to show additional Apollo and HTTP request information (#9649)

Co-authored-by: Daniel Cousens <[email protected]>

Author: dcousens

examples/logging/keystone.ts

@@ -1,6 +1,19 @@
 import { config } from '@keystone-6/core'
-import { lists } from './schema'
+import { createHash } from 'node:crypto'
+import pino_ from 'pino-http'
+
 import type { TypeInfo } from '.keystone/types'
+import { lists } from './schema'
+
+function sha256(q: string) {
+  return createHash('sha256').update(q).digest('hex')
+}
+
+const pino = pino_({
+  // genReqId: (req, res) => req.headers["cf-ray"] ?? '',
+  // genReqId: (req, res) => req.headers["x-amzn-trace-id"] ?? '',
+  // genReqId: (req, res) => req.headers["x-request-id"] ?? '',
+})
 
 export default config<TypeInfo>({
   db: {
@@ -10,22 +23,44 @@ export default config<TypeInfo>({
     // WARNING: this is only needed for our monorepo examples, dont do this
     prismaClientPath: 'node_modules/myprisma',
   },
+  server: {
+    extendExpressApp(app) {
+      app.use(pino)
+    },
+  },
   graphql: {
     apolloConfig: {
-      formatError(formattedError, error) {
+      formatError(formattedError, __error) {
         // you can customise the error returned to the client
         return formattedError
       },
       plugins: [
         {
-          async requestDidStart(requestContext) {
-            console.log(
-              'graphql operation',
-              requestContext.request.operationName ?? '(unnamed operation)'
-            )
+          async requestDidStart() {
+            const start = Date.now()
+
             return {
-              async didEncounterErrors(requestContext) {
-                console.error(...requestContext.errors)
+              async willSendResponse(requestContext) {
+                pino.logger.info(
+                  {
+                    req: requestContext.contextValue.req
+                      ? { id: requestContext.contextValue.req?.id }
+                      : undefined,
+                    responseTime: Date.now() - start,
+                    graphql: {
+                      type: requestContext.operation?.operation,
+                      name: requestContext.request.operationName,
+                      hash: sha256(requestContext.request.query ?? ''),
+                      // query: requestContext.request.query, // WARNING: may be verbose
+                      errors:
+                        requestContext.errors?.map(e => ({
+                          path: e.path,
+                          message: e.message,
+                        })) || undefined,
+                    },
+                  },
+                  'graphql query completed'
+                )
               },
             }
           },

examples/logging/package.json

@@ -12,7 +12,8 @@
   },
   "dependencies": {
     "@keystone-6/core": "^6.5.1",
-    "@prisma/client": "6.5.0"
+    "@prisma/client": "6.5.0",
+    "pino-http": "^10.5.0"
   },
   "devDependencies": {
     "prisma": "6.5.0",