将 Apollo 服务器调试为 AWS Lambda 函数

Posted

技术标签:

【中文标题】将 Apollo 服务器调试为 AWS Lambda 函数【英文标题】:Debug Apollo Server as AWS Lambda Function 【发布时间】:2020-03-09 13:24:36 【问题描述】:

我按照 Apollo Server 的说明部署为 AWS lambda。 https://www.apollographql.com/docs/apollo-server/deployment/lambda/ 使用了无服务器框架,它在 East-2 区域运行良好。

我扩展了示例以使用 PostGres DB 进行查询(我使用了 npm sequalize 包)。当我作为 ApolloServer 和本地 postresql DB 运行时,可以很好地使用相同的代码。我这样做是为了让它也可以切换到 apollo-server-lambda。我有一个 if 语句,它根据它是否是 lambda 来更改与 DB 的连接。

我遇到的问题是未命中数据库的查询可以正常工作。但是对 DB 的 graphql 查询返回:


  "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 函数的正确方法。因为日志返回:


  "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)



【问题讨论】:

您的数据库实例是否在 vpc 中配置? @RishikeshDarandale 是的,它具有默认 VPC。这就是我需要更多培训的地方。由于我还没有了解 vpc 安全组,以及如何/是否在同一个 VPC 上获取 lambda 函数,以及 Public 如何影响这一点。 (我知道理论,但不知道 AWS 的细节)。 好的,我为 lambda 设置了安全组和子网以访问 PostGreSQL 数据库。但是现在我从 PG 收到 3D000 错误,这意味着 DB 不存在。但是我可以在 RDS 中看到它,并且我提供了连接的名称。 @RishikeshDarandale 我想我对调试过程很满意。所以我分叉了一个新线程来确定数据库连接:***.com/questions/58919590/… 【参考方案1】:

调试 lambda 函数很难!如果日志是通过 CloudWatch 配置的,您可以尝试挖掘日志,但这并不总是为您提供可行的堆栈跟踪,而且很难找到您正在寻找的确切调用。

您是否尝试过使用无服务器框架仪表板进行部署?这将有助于为您提供完整的堆栈跟踪以及您的日志。您只需在应用程序根目录中运行serverless 命令即可开始使用。

更多信息请见here

完全披露 - 我在无服务器框架上为无服务器公司工作。

【讨论】:

我喜欢仪表板中的内容。但是我没有从 console.log() 语句中看到任何内容。我已经包含了基本的 Apollo server.js(不是数据库或模式)。我应该做些什么来查看日志吗?我已将几乎所有权限都放在角色中。 有趣!函数是否被调用?每次调用都包含函数生成的完整日志。如果没有堆栈跟踪,并且调用不包括您的日志语句 - 是否有可能没有达到您的服务器逻辑? 非数据库查询工作正常(你好)数据库查询失败,因为我似乎无法连接到 RDS 数据库(我想调试的,因为相同的语法适用于本地 postgresql )。 Apollo 调度到“查询解析器”,我已将该文件添加到问题中。 好吧,我现在将控制台日志语句从条目移动到 lambda 函数(处理程序)并将它们放入“apollo 解析器”中,然后我会在仪表板中看到日志。再次感谢您的好产品!顺便说一句,使用部署功能选项,可能需要 8 分钟。 Amazon AWS VSCODE 插件要快得多。 太棒了!我很高兴你喜欢它。我不确定您所说的 the deploy function option 是什么意思,以及它与 VSCode 插件的关系。你能扩展一下吗?【参考方案2】:

适用于部署无服务器应用程序并在访问其 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',
    ,
);

查看此链接: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 文件夹(参见tsconfig.json 中的outDir),然后运行serverless deploy

package.json


  ...
  "main": "dist/server.js",
  "scripts": 
    ...
    "deploy": "rimraf dist && npx tsc && serverless deploy",
  ,
  ...


注意:您需要全局安装 rimraf 才能使脚本正常工作 (npm install -g rimraf)

【讨论】:

以上是关于将 Apollo 服务器调试为 AWS Lambda 函数的主要内容,如果未能解决你的问题,请参考以下文章

AWS 云中带有订阅的 Apollo GraphQL 服务器

使用 AWS Lambda 部署 Apollo 服务器时出错

无服务器框架+ AWS + Lambda + DynamoDB + GraphQL + Apollo Server =无法使POST请求工作

无服务器框架 + AWS + Lambda + DynamoDB + GraphQL + Apollo Server = 无法使 POST 请求工作

带有 apollo-angular 客户端的 Aws-appsync 订阅

如何调试 Apollo GraphQL 服务器上的内存泄漏?