记录每个请求的Apollo服务器GraphQL查询和变量

Question

使用apollo-server 2.2.1或更高版本时，如何为每个请求，查询和变量记录一个日志？

这似乎是一个简单的要求和常见用例，但是文档非常模糊，并且query传递给的对象formatResponse 不再具有queryString和variables属性。

Answer 1

Amit的答案有效（今天），但是恕我直言，它有点不可靠，将来可能无法按预期工作，或者在某些情况下可能无法正常工作。

例如，当我看到它时，我想到的第一件事是：“如果查询无效，那可能不起作用”，事实证明，今天，当查询无效时，它确实可以工作。因为在当前的实现中，上下文是在验证查询之前评估的。但是，这是一个实现细节，将来可能会更改。例如，如果有一天阿波罗团队决定仅在查询被解析和验证之后评估上下文，这将是性能上的胜利？这正是我所期望的:-)

我要说的是，如果您只是想快速记录一些内容以便在您的dev环境中调试某些内容，那么Amit的解决方案绝对是您的理想之选。

但是，如果您要为生产环境注册日志，那么使用该context功能可能不是最好的主意。在这种情况下，我将安装graphql-extensions并将其用于日志记录，例如：

const { print } = require('graphql');

class BasicLogging {
  requestDidStart({queryString, parsedQuery, variables}) {
    const query = queryString || print(parsedQuery);
    console.log(query);
    console.log(variables);
  }

  willSendResponse({graphqlResponse}) {
    console.log(JSON.stringify(graphqlResponse, null, 2));
  }
}

const server = new ApolloServer({
  typeDefs,
  resolvers,
  extensions: [() => new BasicLogging()]
});

编辑：

正如Dan所指出的，graphql-extensions由于它已集成在apollo-server-core软件包中，因此无需安装该软件包。

Answer 2

使用新的 plugins API，您可以使用与 Josep 的答案非常相似的方法，只是您的代码结构略有不同。

const BASIC_LOGGING = {
    requestDidStart(requestContext) {
        console.log("request started");
        console.log(requestContext.request.query);
        console.log(requestContext.request.variables);
        return {
            didEncounterErrors(requestContext) {
                console.log("an error happened in response to query " + requestContext.request.query);
                console.log(requestContext.errors);
            }
        };
    },

    willSendResponse(requestContext) {
        console.log("response sent", requestContext.response);
    }
};


const server = new ApolloServer(
    {
        schema,
        plugins: [BASIC_LOGGING]
    }
)

server.listen(3003, '0.0.0.0').then(({ url }) => {
    console.log(`GraphQL API ready at ${url}`);
});

Answer 3

如果我必须记录查询和变量，我可能会使用apollo-server-express, 而不是apollo-server, 以便我可以在graphql为我记录的中间件之前添加一个单独的快速中间件：

const express = require('express')
const { ApolloServer } = require('apollo-server-express')
const { typeDefs, resolvers } = require('./graphql')

const server = new ApolloServer({ typeDefs, resolvers })
const app = express()

app.use(bodyParser.json())
app.use('/graphql', (req, res, next) => {
  console.log(req.body.query)
  console.log(req.body.variables)
  return next()
})

server.applyMiddleware({ app })

app.listen({ port: 4000}, () => {
  console.log(` Server ready at http://localhost:4000${server.graphqlPath}`)
})

Answer 4

Dan的解决方案主要解决了该问题，但是如果您想不使用express记录日志，则可以在以下示例中显示的上下文中捕获它。

const server = new ApolloServer({
schema,
context: params => () => {
    console.log(params.req.body.query);
    console.log(params.req.body.variables);
}
});