调试 Apollo 服务器作为 AWS Lambda 函数
Debug Apollo Server as AWS Lambda Function
我按照 Apollo Server 上的说明部署为 AWS lambda。
https://www.apollographql.com/docs/apollo-server/deployment/lambda/
使用无服务器框架,它在区域 east-2 中运行良好。
我扩展了示例以使用 PostGres 数据库进行查询(我使用了 npm sequalize 包)。当我 运行 作为 ApolloServer 和本地 postresql 数据库时,相同的代码可以正常使用。我这样做是为了让它也可以切换到 apollo-server-lambda。我有一个 if 语句,它根据它是否是 lambda 来更改与数据库的连接。
我遇到的问题是未命中数据库的查询工作正常。但是 graphql 查询数据库 return:
{
"error": {
"message": "Internal server error"
}
}
好的,现在我该如何调试 nodejs lambda 函数?
lambda管理控制台确实有测试运行。我重新定义了 hello world 测试以使用它作为测试:
{
"operationName": null,
"variables": {},
"query": "{users {id firstName lastName addressNumber streetName city email createdAt updatedAt }}"
}
但这似乎不是调用 lambda 函数的正确方法。因为日志 returns:
{
"body": "Apollo Server supports only GET/POST requests.",
"statusCode": 405,
"headers": {
"Allow": "GET, POST"
}
}
server.js
const { ApolloServer } = require('apollo-server')
const { ApolloServer: ApolloServerLambda } = require('apollo-server-lambda')
const { typeDefs, resolvers, connect } = require('./schema.js')
// The ApolloServer constructor requires two parameters: your schema
// definition and your set of resolvers.
async function setup(server) {
let { url } = await server.listen()
console.log(` Server ready at ${url}`)
await connect("local")
}
async function awsSetup() {
await connect("aws")
}
if (process.env.USERNAME == 'ysg4206') {
const server = new ApolloServer({ typeDefs, resolvers })
setup(server)
} else {
const server = new ApolloServerLambda({ typeDefs, resolvers })
//awsSetup()
exports.graphqlHandler = server.createHandler({
playground: true,
introspection: true,
cors: {
origin: '*',
credentials: true,
},
context: ({ event, context }) => { return (
{
headers: event.headers,
functionName: context.functionName,
event,
context
})
}
})
}
schema.js
const { gql } = require('apollo-server')
const { DB } = require('./db')
const { GraphQLDateTime } = require('graphql-iso-date')
exports.typeDefs = gql`
scalar DateTime
type User {
id: Int
"English First Name"
firstName: String
lastName: String
addressNumber: Int
streetName: String
city: String
email: String
createdAt: DateTime
updatedAt: DateTime
}
input UserType {
"Hebrew First Name"
firstName: String
lastName: String
addressNumber: Int
streetName: String
city: String
email: String
}
type Query {
users: [User]
findUser(firstName: String): User
hello(reply: String): String
}
type Mutation {
addUser(user: UserType): User!
}
type Subscription {
newUser: User!
}
`
exports.resolvers = {
Query: {
// users: async () => {
// let users = await DB.findAll()
// return users
// },
users: () => DB.findAll(),
findUser: async (_, { firstName }) => {
let who = await DB.findFirst(firstName)
return who
},
hello: (_, { reply }, context) => {
console.log(`hello with reply ${reply}`)
console.log(`context : ${JSON.stringify(reply, null, 4)}`)
return reply
}
},
Mutation: {
addUser: async (_, args) => {
let who = await DB.addUser(args.user)
return who
}
}
}
exports.connect = async function connect(where) {
await DB.dbSetup(where)
await DB.populate()
let users = await DB.findAll()
console.log(users)
}
调试 lambda 函数很难!如果日志是通过 CloudWatch 配置的,您可以尝试挖掘日志,但这并不总能为您提供可行的堆栈跟踪,并且很难找到您正在寻找的确切调用。
您是否尝试过使用无服务器框架仪表板进行部署?这将有助于为您提供完整的堆栈跟踪以及您的日志。您只需 运行 应用程序根目录中的 serverless
命令即可开始。
有更多信息可用here
完全公开 - 我在 Serverless Inc. 工作,负责 Serverless Framework。
对于部署无服务器应用程序并在访问其 AWS 端点时接收 {"message": "Internal server error"}
的任何人
我 运行 一整天都在关注这个问题。我做了一些更改,但我认为它对我的影响是在初始化我的 ApolloServer 时包括上下文:
const server = new ApolloServer({
...serverConfig, // typeDefs and resolvers
context: ({ event, context }) => ({
headers: event.headers,
functionName: context.functionName,
event,
context,
}),
playground: {
endpoint: '/dev/graphql',
},
});
看到这个link:https://www.apollographql.com/docs/apollo-server/deployment/lambda/#getting-request-info
调试时我推荐两件事
- 在 AWS 上检查您的 lambda 函数的 Cloudwatch 日志
- 运行
serverless offline
,转到本地端点并查看是否有任何错误(您需要安装 serverless offline plugin 并将其包含在您的 serverless.yml
)
如果您使用的是 yarn monorepo 和 typescript,还有一些相关的附加信息 -
确保编译和转译打字稿代码。 See this article。我的代码:
yarn add webpack serverless-webpack
yarn add -D webpack-node-externals
webpack.config.js
const path = require('path');
const slsw = require('serverless-webpack');
const nodeExternals = require('webpack-node-externals');
module.exports = {
entry: slsw.lib.entries,
target: 'node',
mode: slsw.lib.webpack.isLocal ? 'development' : 'production',
optimization: {
minimize: false,
},
performance: {
hints: false,
},
devtool: 'nosources-source-map',
externals: [nodeExternals()],
module: {
rules: [
{
test: /\.ts$/,
loader: 'babel-loader',
options: {
presets: [
[
'@babel/preset-env',
{
targets: {
node: true,
},
},
],
'@babel/typescript',
],
},
include: [__dirname],
exclude: /node_modules/,
},
],
},
resolve: {
extensions: ['.ts', '.js'],
},
output: {
libraryTarget: 'commonjs2',
path: path.join(__dirname, '.webpack'),
filename: '[name].js',
},
};
serverless.yml
# serverless.yml
service: apollo-lambda
plugins:
- serverless-webpack
- serverless-offline
custom:
webpack:
webpackConfig: ./webpack.config.js
includeModules: true
provider:
name: aws
runtime: nodejs12.x
functions:
graphql:
# this is formatted as <FILENAME>.<HANDLER>
handler: dist/server.graphqlHandler
environment:
SLS_DEBUG: true
events:
- http:
path: graphql
method: post
cors: true
integration: lambda-proxy
- http:
path: graphql
method: get
cors: true
integration: lambda-proxy
tsconfig.json
{
"compilerOptions": {
"sourceMap": true,
"outDir": "./dist",
"strict": true,
"lib": ["es5"],
"esModuleInterop": true,
"types": ["react", "jest"]
}
}
我还添加了一个名为 deploy
的脚本,它删除了 dist
文件夹,在编译打字稿后重新创建了 dist
文件夹(参见 outDir
in tsconfig.json
), 然后运行 serverless deploy
:
package.json
{
...
"main": "dist/server.js",
"scripts": {
...
"deploy": "rimraf dist && npx tsc && serverless deploy",
},
...
}
注意:您需要全局安装 rimraf
脚本才能运行 (npm install -g rimraf
)
我按照 Apollo Server 上的说明部署为 AWS lambda。 https://www.apollographql.com/docs/apollo-server/deployment/lambda/ 使用无服务器框架,它在区域 east-2 中运行良好。
我扩展了示例以使用 PostGres 数据库进行查询(我使用了 npm sequalize 包)。当我 运行 作为 ApolloServer 和本地 postresql 数据库时,相同的代码可以正常使用。我这样做是为了让它也可以切换到 apollo-server-lambda。我有一个 if 语句,它根据它是否是 lambda 来更改与数据库的连接。
我遇到的问题是未命中数据库的查询工作正常。但是 graphql 查询数据库 return:
{
"error": {
"message": "Internal server error"
}
}
好的,现在我该如何调试 nodejs lambda 函数?
lambda管理控制台确实有测试运行。我重新定义了 hello world 测试以使用它作为测试:
{
"operationName": null,
"variables": {},
"query": "{users {id firstName lastName addressNumber streetName city email createdAt updatedAt }}"
}
但这似乎不是调用 lambda 函数的正确方法。因为日志 returns:
{
"body": "Apollo Server supports only GET/POST requests.",
"statusCode": 405,
"headers": {
"Allow": "GET, POST"
}
}
server.js
const { ApolloServer } = require('apollo-server')
const { ApolloServer: ApolloServerLambda } = require('apollo-server-lambda')
const { typeDefs, resolvers, connect } = require('./schema.js')
// The ApolloServer constructor requires two parameters: your schema
// definition and your set of resolvers.
async function setup(server) {
let { url } = await server.listen()
console.log(` Server ready at ${url}`)
await connect("local")
}
async function awsSetup() {
await connect("aws")
}
if (process.env.USERNAME == 'ysg4206') {
const server = new ApolloServer({ typeDefs, resolvers })
setup(server)
} else {
const server = new ApolloServerLambda({ typeDefs, resolvers })
//awsSetup()
exports.graphqlHandler = server.createHandler({
playground: true,
introspection: true,
cors: {
origin: '*',
credentials: true,
},
context: ({ event, context }) => { return (
{
headers: event.headers,
functionName: context.functionName,
event,
context
})
}
})
}
schema.js
const { gql } = require('apollo-server')
const { DB } = require('./db')
const { GraphQLDateTime } = require('graphql-iso-date')
exports.typeDefs = gql`
scalar DateTime
type User {
id: Int
"English First Name"
firstName: String
lastName: String
addressNumber: Int
streetName: String
city: String
email: String
createdAt: DateTime
updatedAt: DateTime
}
input UserType {
"Hebrew First Name"
firstName: String
lastName: String
addressNumber: Int
streetName: String
city: String
email: String
}
type Query {
users: [User]
findUser(firstName: String): User
hello(reply: String): String
}
type Mutation {
addUser(user: UserType): User!
}
type Subscription {
newUser: User!
}
`
exports.resolvers = {
Query: {
// users: async () => {
// let users = await DB.findAll()
// return users
// },
users: () => DB.findAll(),
findUser: async (_, { firstName }) => {
let who = await DB.findFirst(firstName)
return who
},
hello: (_, { reply }, context) => {
console.log(`hello with reply ${reply}`)
console.log(`context : ${JSON.stringify(reply, null, 4)}`)
return reply
}
},
Mutation: {
addUser: async (_, args) => {
let who = await DB.addUser(args.user)
return who
}
}
}
exports.connect = async function connect(where) {
await DB.dbSetup(where)
await DB.populate()
let users = await DB.findAll()
console.log(users)
}
调试 lambda 函数很难!如果日志是通过 CloudWatch 配置的,您可以尝试挖掘日志,但这并不总能为您提供可行的堆栈跟踪,并且很难找到您正在寻找的确切调用。
您是否尝试过使用无服务器框架仪表板进行部署?这将有助于为您提供完整的堆栈跟踪以及您的日志。您只需 运行 应用程序根目录中的 serverless
命令即可开始。
有更多信息可用here
完全公开 - 我在 Serverless Inc. 工作,负责 Serverless Framework。
对于部署无服务器应用程序并在访问其 AWS 端点时接收 {"message": "Internal server error"}
的任何人
我 运行 一整天都在关注这个问题。我做了一些更改,但我认为它对我的影响是在初始化我的 ApolloServer 时包括上下文:
const server = new ApolloServer({
...serverConfig, // typeDefs and resolvers
context: ({ event, context }) => ({
headers: event.headers,
functionName: context.functionName,
event,
context,
}),
playground: {
endpoint: '/dev/graphql',
},
});
看到这个link:https://www.apollographql.com/docs/apollo-server/deployment/lambda/#getting-request-info
调试时我推荐两件事
- 在 AWS 上检查您的 lambda 函数的 Cloudwatch 日志
- 运行
serverless offline
,转到本地端点并查看是否有任何错误(您需要安装 serverless offline plugin 并将其包含在您的serverless.yml
)
如果您使用的是 yarn monorepo 和 typescript,还有一些相关的附加信息 -
确保编译和转译打字稿代码。 See this article。我的代码:
yarn add webpack serverless-webpack
yarn add -D webpack-node-externals
webpack.config.js
const path = require('path');
const slsw = require('serverless-webpack');
const nodeExternals = require('webpack-node-externals');
module.exports = {
entry: slsw.lib.entries,
target: 'node',
mode: slsw.lib.webpack.isLocal ? 'development' : 'production',
optimization: {
minimize: false,
},
performance: {
hints: false,
},
devtool: 'nosources-source-map',
externals: [nodeExternals()],
module: {
rules: [
{
test: /\.ts$/,
loader: 'babel-loader',
options: {
presets: [
[
'@babel/preset-env',
{
targets: {
node: true,
},
},
],
'@babel/typescript',
],
},
include: [__dirname],
exclude: /node_modules/,
},
],
},
resolve: {
extensions: ['.ts', '.js'],
},
output: {
libraryTarget: 'commonjs2',
path: path.join(__dirname, '.webpack'),
filename: '[name].js',
},
};
serverless.yml
# serverless.yml
service: apollo-lambda
plugins:
- serverless-webpack
- serverless-offline
custom:
webpack:
webpackConfig: ./webpack.config.js
includeModules: true
provider:
name: aws
runtime: nodejs12.x
functions:
graphql:
# this is formatted as <FILENAME>.<HANDLER>
handler: dist/server.graphqlHandler
environment:
SLS_DEBUG: true
events:
- http:
path: graphql
method: post
cors: true
integration: lambda-proxy
- http:
path: graphql
method: get
cors: true
integration: lambda-proxy
tsconfig.json
{
"compilerOptions": {
"sourceMap": true,
"outDir": "./dist",
"strict": true,
"lib": ["es5"],
"esModuleInterop": true,
"types": ["react", "jest"]
}
}
我还添加了一个名为 deploy
的脚本,它删除了 dist
文件夹,在编译打字稿后重新创建了 dist
文件夹(参见 outDir
in tsconfig.json
), 然后运行 serverless deploy
:
package.json
{
...
"main": "dist/server.js",
"scripts": {
...
"deploy": "rimraf dist && npx tsc && serverless deploy",
},
...
}
注意:您需要全局安装 rimraf
脚本才能运行 (npm install -g rimraf
)