serverless-space
My General SFF (Serverless for front-end).
Online GraphQL Studio
- With CDN: https://sls.pa-ca.me/nest/graphql
- Without CDN:
- Apollo Studio: https://studio.apollographql.com/graph/Serverless-Space/explorer?variant=current
- GraphCDN: https://graphcdn.pa-ca.me/
Why
How
基于 AWS 构建 BFF 的架构说明 - Jeff Tian的文章 - 知乎
AWS Console
- url: https://console.aws.amazon.com/lambda/home?region=us-east-1#/functions
- root user login: jie.tian@live.cn
Local development
node_modules/.bin/serverless create -t aws-nodejs
node_modules/.bin/serverless config credentials --provider aws --key <key> --secret <secret>
node_modules/.bin/serverless deploy
curl https://jqp5j170i6.execute-api.us-east-1.amazonaws.com/dev/users/create
curl https://jqp5j170i6.execute-api.us-east-1.amazonaws.com/dev/api/
curl https://jqp5j170i6.execute-api.us-east-1.amazonaws.com/dev/nest/cats
curl https://jqp5j170i6.execute-api.us-east-1.amazonaws.com/dev/nest/graphqlAbout adding new dependencies 添加新的依赖
Due to the size limit of AWS Lambda, this project uses layers for node_modules. So when we need to add new dependencies to the project, besides the normal yarn add xxx, we need to also manually add the dependency to the layers/nodejs/package.json.
因为 AWS Lambda 限制了代码包的大小，在不压缩的情况下不可以超过 68 M；又限制了单个层，在不压缩的情况下不能超过 250 M 。所以这个项目使用了多个 layers 来存放依赖。所以当我们需要添加新的依赖时，如果在后面想将它添加到 layer 中，那么，就需要去对应的 layer 目录下，手动安装该依赖，并且显式指定其版本，以避免出现一些意料之外的问题。
同时，当更新 package.json 里的包时，也需要在对应的 layer 目录下升级。但是这样有一些麻烦，不过好在有一些相关的命令来稍微简化该工作，举例来说，我们升级了一些 package.json 里的包，这时可以通过以下命令来升级 layers/nodejs/package.json 里的包：
git diff package.json > patch_file
patch p1 layers/nodejs/package.json patch_file
rm patch_fileRun gatsby locally
yarn build && PORT=3000 node --experimental-modules dist/src/gatsby.jsRun all offline
yarn offline
open http://localhost:3000/dev/gatsby/graphql?query=%23%20Welcome%20to%20GraphiQL%0A%23%0A%23%20GraphiQL%20is%20an%20in-browser%20tool%20for%20writing%2C%20validating%2C%20and%0A%23%20testing%20GraphQL%20queries.%0A%23%0A%23%20Type%20queries%20into%20this%20side%20of%20the%20screen%2C%20and%20you%20will%20see%20intelligent%0A%23%20typeaheads%20aware%20of%20the%20current%20GraphQL%20type%20schema%20and%20live%20syntax%20and%0A%23%20validation%20errors%20highlighted%20within%20the%20text.%0A%23%0A%23%20GraphQL%20queries%20typically%20start%20with%20a%20%22%7B%22%20character.%20Lines%20that%20start%0A%23%20with%20a%20%23%20are%20ignored.%0A%23%0A%23%20An%20example%20GraphQL%20query%20might%20look%20like%3A%0A%23%0A%23%20%20%20%20%20%7B%0A%23%20%20%20%20%20%20%20field(arg%3A%20%22value%22)%20%7B%0A%23%20%20%20%20%20%20%20%20%20subField%0A%23%20%20%20%20%20%20%20%7D%0A%23%20%20%20%20%20%7D%0A%23%0A%23%20Keyboard%20shortcuts%3A%0A%23%0A%23%20%20Prettify%20Query%3A%20%20Shift-Ctrl-P%20(or%20press%20the%20prettify%20button%20above)%0A%23%0A%23%20%20%20%20%20Merge%20Query%3A%20%20Shift-Ctrl-M%20(or%20press%20the%20merge%20button%20above)%0A%23%0A%23%20%20%20%20%20%20%20Run%20Query%3A%20%20Ctrl-Enter%20(or%20press%20the%20play%20button%20above)%0A%23%0A%23%20%20%20Auto%20Complete%3A%20%20Ctrl-Space%20(or%20just%20start%20typing)%0A%23%0A%0A%0A%7B%0A%20%20allNPMScript%20%7B%0A%20%20%20%20nodes%20%7B%0A%20%20%20%20%20%20name%0A%20%20%20%20%7D%0A%20%20%7D%0A%7DDeploy
From local machine
Due to package size limitation, we have to run the following command to deploy: https://stackoverflow.com/a/69176517/769900
rm -rf node_modules && npm i --production
npm install -g serverless
npm install -g serverless-plugin-names
yarn pre-deploy
# check size of node_modules, if size > 250M, then need to clean some unnecessary dependencies to reduce the size
du -h -d 0 layers/nodejs/node_modules | sort -h
yarn deploy-from-localFrom GitHub Action
Every push will trigger auto deploy by GitHub action if tests pass.
Contributions
All kinds of contributions are welcome!
IDEs tips
Webstorm
Shortcut keys
- Press
Ctrl+Mto jump to the matching brace.
Star History
中文说明
这是我利用 AWS 免费资源构建一个 SFF 的实验场地，用于验证一些 Serverless 的想法。AWS 一共有 200 多个服务，目前这里使用的仅仅是一些 VPC 之外的服务^[除了 VPC 之外的服务，还在调用微信接口时将 Lambda 绑定到了 VPC 固定的 IP 地址，以通过微信服务的白名单校验，参见：《通过关联 VPC 让 AWS lambda 拥有固定出口 IP 地址 - Jeff Tian的文章 - 知乎》]。
架构图
客户端浏览器请求一个托管在 Amazon S3 或者其他静态托管服务上的静态网页，当网页中存在需要调用后端 API 的情况时，会通过 AWS API Gateway 对请求进行身份验证与授权，并调用 Lambda 函数与 DynamoDB 进行通信。通过 API Gateway 的缓存功能，可以有效减少 Lambda 函数的调用次数，从而减少后端负载，并在出现服务重复性请求时减少延迟。
API Gateway 还将日志发送给 Amazon CloudWatch。API Gateway 可以针对 API 中的每个阶段或针对每个方法向 CloudWatch 发送日志。日志记录的详细程度（错误或信息），以及是否应记录完整的请求和响应数据都可以进行配置。
API Gateway 可以发送到 CloudWatch 的详细指标如下：
- API 调用的数量
- 延迟
- 集成延迟
- HTTP 400 或者 500 错误
还可以激活访问日志记录，以记录谁访问过 API，以及是如何访问的。
Cloud Formation
使用 serverless.yml 定义了一些资源，通过 serverless framework 生成了 Cloud Formation 模板，可以在 AWS 控制台中 查看。
网关 API 映射
API Gateway 可以将请求映射到 Lambda 函数，这样就可以通过 API Gateway 来调用 Lambda 函数。
API Dashboard
API Gateway 可以生成一个仪表盘来展示 API 的调用情况。
监控
还可以通过 https://console.serverless.com/jefftian/metrics/awsLambda?globalScope=awsLambda&globalTimeFrame=30d 查看更多详情。
自定义域名
API Gateway 可以绑定自定义域名：
目前一共建立了两个 API 网关，分别是 dev 和 stg。使用了 sls.pa-ca.me 这个域名，并且将 /dev 映射到 dev 环境，将 / 映射到了 stg 的 API 网关。
目前最方便切换环境的方式是通过修改自定义域名的 API 映射。不过，观察到这里的修改到最终生效是一段时间的延迟的，所以，要确保修改后，等待一段时间再进行测试。
Redis 缓存
本项目使用了 Redis 作为缓存，使用了 ioredis 包来访问 Redis。Redis 服务使用了 Upstash 的免费版，已经使用几年的时间，看起来非常稳定。
开发
创建好 module 以及 resolver 之后，使用以下命令生成 Schema：
yarn offline💵 了解更多
欢迎来知乎向我咨询！
