feat: mercurius-logging first release (#1)

* feat: basic impl

* add: test

* add: docs

* feat: prependAlias

Author: Eomm

.eslintrc

@@ -0,0 +1 @@
+{"extends": "standard"}

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: ci
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+
+jobs:
+  test:
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    with:
+      lint: true

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+.vscode/
+package-lock.json

README.md

@@ -1,2 +1,132 @@
 # mercurius-logging
-Log the GraphQL details
+
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![ci](https://github.com/Eomm/mercurius-logging/actions/workflows/ci.yml/badge.svg)](https://github.com/Eomm/mercurius-logging/actions/workflows/ci.yml)
+
+This plugin add a Log with all the GraphQL details you need.
+
+## The issue
+
+By default, Fastify logs a simple request that shows always the same `url`:
+
+```json
+{
+  "level": 30,
+  "time": 1660395516356,
+  "pid": 83316,
+  "hostname": "eomm",
+  "name": "gateway",
+  "reqId": "req-1",
+  "req": {
+    "method": "POST",
+    "url": "/graphql",
+    "hostname": "localhost:60767",
+    "remoteAddress": "127.0.0.1",
+    "remotePort": 60769
+  },
+  "msg": "incoming request"
+}
+```
+
+This output does not let you know which queries or mutations are being executed,
+unless you print or inspect the GQL payload.
+
+This plugin adds this log output to your application:
+
+```json
+{
+  "level": 30,
+  "time": 1660395516406,
+  "pid": 83316,
+  "hostname": "eomm",
+  "name": "gateway",
+  "reqId": "req-1",
+  "graphql": {
+    "queries": [
+      "myTeam",
+      "myTeam"
+    ]
+  }
+}
+```
+
+When the request contains some mutations:
+
+```json
+{
+  "level": 30,
+  "time": 1660395516406,
+  "pid": 83316,
+  "hostname": "eomm",
+  "name": "gateway",
+  "reqId": "req-1",
+  "graphql": {
+    "mutations": [
+      "resetCounter"
+    ]
+  }
+}
+```
+
+## Install
+
+```
+npm install mercurius-logging
+```
+
+## Usage
+
+```js
+const Fastify = require('fastify')
+const mercurius = require('mercurius')
+const mercuriusLogging = require('mercurius-logging')
+
+const app = Fastify({
+  logger: true,
+  disableRequestLogging: true
+})
+t.teardown(app.close.bind(app))
+
+app.register(mercurius, {
+  schema: yourSchema,
+  resolvers: yourResolvers
+})
+app.register(mercuriusLogging)
+```
+
+## Options
+
+You can customize the output of the plugin by passing an options object:
+
+```js
+app.register(mercuriusLogging, {
+  logLevel: 'debug', // default: 'info'
+  prependAlias: true, // default: false
+})
+```
+
+### logLevel
+
+The log level of the plugin. Note that the `request` logger is used, so you will get the additional
+[request data](https://www.fastify.io/docs/latest/Reference/Logging/#usage) such as the `reqId`.
+
+### prependAlias
+
+Queries and mutations may have an alias. If you want to append the alias to the log, set this option to `true`.
+You will get the following output:
+
+```json
+{
+  "level": 30,
+  "graphql": {
+    "queries": [
+      "firstQuery:myTeam",
+      "secondQuery:myTeam"
+    ]
+  }
+}
+```
+
+## License
+
+Copyright [Manuel Spigolon](https://github.com/Eomm), Licensed under [MIT](./LICENSE).

index.js

@@ -0,0 +1,48 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+
+function mercuriusLogging (app, opts, next) {
+  const options = Object.assign({}, {
+    logLevel: 'info',
+    prependAlias: false
+  }, opts)
+
+  app.graphql.addHook('preExecution', logGraphQLDetails.bind(null, options))
+  next()
+}
+
+function logGraphQLDetails (opts, schema, document, context) {
+  const queryOps = readOps(document, 'query', opts)
+  const mutationOps = readOps(document, 'mutation', opts)
+
+  context.reply.request.log[opts.logLevel]({
+    graphql: {
+      queries: queryOps.length > 0 ? queryOps : undefined,
+      mutations: mutationOps.length > 0 ? mutationOps : undefined
+    }
+  })
+}
+
+function readOps (document, operation, opts) {
+  return document.definitions
+    .filter(d => d.kind === 'OperationDefinition' && d.operation === operation)
+    .flatMap(d => d.selectionSet.selections)
+    .map(selectionSet => {
+      const opName = selectionSet.name.value
+
+      if (opts.prependAlias && selectionSet.alias) {
+        return selectionSet.alias.value + ':' + opName
+      }
+
+      return opName
+    })
+}
+
+module.exports = fp(mercuriusLogging,
+  {
+    name: 'mercurius-logging',
+    fastify: '4.x',
+    dependencies: ['mercurius']
+  }
+)

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "mercurius-logging",
+  "version": "0.0.0",
+  "description": "Log the GraphQL details",
+  "main": "index.js",
+  "scripts": {
+    "lint": "standard",
+    "lint:fix": "standard --fix",
+    "test": "npm run lint && npm run test:unit",
+    "test:unit": "tap test/**/*.test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Eomm/mercurius-logging.git"
+  },
+  "keywords": [],
+  "author": "Manuel Spigolon <behemoth89@gmail.com> (https://github.com/Eomm)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Eomm/mercurius-logging/issues"
+  },
+  "homepage": "https://github.com/Eomm/mercurius-logging#readme",
+  "devDependencies": {
+    "fastify": "^4.4.0",
+    "mercurius": "^10.1.0",
+    "split2": "^4.1.0",
+    "standard": "^17.0.0",
+    "tap": "^16.3.0"
+  },
+  "dependencies": {
+    "fastify-plugin": "^4.2.0"
+  }
+}