Fine-grained hot reloading configuration for functions and layers to replace global `mountCode` option
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- javascript
- 領域
- tooling
研究方向
先檢視相關的 PR #222 和現有的 custom.localstack.lambda.mountCode 設定，然後將提議的函式層級和 layer 層級 hotReload 屬性與連結的 Serverless 設定及 schema-extension 文件進行比較。四個列出的使用者故事皆受到支援、layer 行為已定義，且已記錄已棄用全域選項的替代方案，即表示完成。
由索引模型根據 Issue 內容生成。
描述
The current hot reloading configuration mountCode has many limitations (e.g., global config, no layer support). An improved configuration API and documentation could make hot reloading more powerful and easier to use with the Serverless Framework.
Related Issues/PRs
- https://github.com/localstack/serverless-localstack/pull/222
- https://github.com/localstack/serverless-localstack/issues/129
- https://github.com/localstack/serverless-localstack/issues/216
Challenges
mountCode: trueis a global option but currently does not support hot-reloading of layers (new feature in LocalStack 2.0).- Hot reloading (currently) only works with at most one layer per function. Hence, if we intend to apply mountCode to layers as well, it fails if there is any function with more than one layer in the serverless.yml
mountCodeis bad terminology because the current implementation does not do any mounting anymore but rather copies ZIP files (https://docs.localstack.cloud/user-guide/tools/lambda-tools/hot-reloading/).hotReloadwould be a better name- We need to consider the scope of hot reloading because not everyone wants to enable hot reloading globally. Selectively enabling hot reloading for single functions or layers under development would be helpful.
mountCode: trueuses the current directory (assumed to be project directory) as default hot reload path or accepts relative paths (e.g., ./functions). This might lead to many unnecessary and slow reloads.
Background
- Serverless documentation on how to provide custom plugin configuration options: https://www.serverless.com/framework/docs/guides/plugins/custom-configuration
- It is possible to add custom function-level properties using "Function properties via defineFunctionProperties" via defineFunctionProperties
- There is no well-defined mechanism to add layer-level properties. It might be possible to do manually using
addPropertiesToSchemato add something likedefineLayerProperties?! Might need to relax provider schema by allowing additional properties like for functions.patternProperties here https://github.com/serverless/serverless/blob/ed15cb27aee68954c93d875da96274914943ad71/lib/classes/config-schema-handler/index.js#L335 - There is some API to extend configuration: https://www.serverless.com/framework/docs/guides/plugins/extending-configuration
- There is no well-defined mechanism to add layer-level properties. It might be possible to do manually using
- Serverless v3 comes with breaking changes regarding plugin variable resolving (e.g., comes with stricter validation): https://www.serverless.com/framework/docs/guides/upgrading-v3#new-variable-resolver-engine
User Stories
Enable hot reloading for:
- Single function code
- Single function code + single layer
- Single layer
- Two functions sharing the same hot-reloaded layer
These cases are supported by LocalStack but not by the serverless-localstack plugin.
Possible API
service: myService
plugins:
- serverless-localstack
custom:
localstack:
# DEPRECATED global config
# lambda:
# mountCode: true
stages:
- local
host: http://127.0.0.1
provider:
name: aws
region: us-east-1
runtime: python3.9
# OPTIONAL provider-scoped config here (would need to think about function vs. layers scope)
# https://www.serverless.com/framework/docs/providers/aws/guide/layers
layers:
layerOne:
path: layerOne
hotReload: true
# https://www.serverless.com/framework/docs/providers/aws/guide/functions
functions:
hello:
handler: handler.handler
hotReload: true
layers:
- !Ref LayerOneLambdaLayer
Considerations
- Hot reloading for layers is configured per layer (rather than per layer usage) and applies to all functions using the layer
- LocalStack (currently) support at most one layer in total when using hot reloading for a layer. This makes it difficult to apply hot reloading globally for layers.
- Should we consider supporting ZIP files for hot reloading such that we can re-use build steps from tools such as Serverless, Gradle, etc rather than adding extra steps to unzip these archives (Java Gradle example).
Alternatives to create layers with Serverless
Based on https://www.tutorialspoint.com/serverless/serverless_layer_creation.htm
- Creating python-requirements layer
- Using an existing layer from another function in the same region
- Non-requirements/ generic layers (example: https://www.serverless.com/blog/publish-aws-lambda-layers-serverless-framework)
- 主要語言
- JavaScript
- 星號
- 541
- 分支
- 93
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
localstack/serverless-localstack 的其他 Issue
-
難度 1/5 1 小時以內 新手友好度 25/100
-
難度 3/5 1-2 天 新手友好度 58/100
-
難度 3/5 1-2 天 新手友好度 45/100
-
難度 4/5 3-5 天 新手友好度 42/100
-
aws:apigateway status: backlog
難度 4/5 3-5 天 新手友好度 35/100
localstack/serverless-localstack#270 · 3 個 reaction ·
查看 localstack/serverless-localstack 的全部 Issue
相似的 Issue
-
bug user-priority/P2
難度 2/5 1-3 小時 新手友好度 62/100
維護者通常 1 天內回覆
-
bug confirmed perf
難度 2/5 1-3 小時 新手友好度 72/100
videojs/video.js#9400 · 1 則留言 ·
維護者通常 1 天內回覆
-
agent/scanner bug hive/hosted-available-lke648397-260827-5n31
難度 2/5 1-3 小時 新手友好度 75/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
rescript-lang/rescript#8765 ·
維護者通常 1 天內回覆
-
feedback simulation workshop
難度 2/5 1-3 小時 新手友好度 62/100
githubnext/gh-aw-workshop#4417 ·
維護者通常 1 天內回覆