Fine-grained hot reloading configuration for functions and layers to replace global `mountCode` option
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- javascript
- Domínio
- tooling
Direção de pesquisa
Comece revisando o PR #222 relacionado e a configuração custom.localstack.lambda.mountCode existente; em seguida, compare as propriedades hotReload propostas no nível de função e de layer com a configuração Serverless vinculada e a documentação de extensão de esquema. O trabalho estará concluído quando as quatro histórias de usuário listadas forem compatíveis, o comportamento de layer estiver definido e a substituição da opção global obsoleta estiver documentada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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)
- Linguagem predominante
- JavaScript
- Estrelas
- 542
- Forks
- 93
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Inclui um Dockerfile ou arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de localstack/serverless-localstack
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 25/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 42/100
-
aws:apigateway status: backlog
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
localstack/serverless-localstack#270 · 3 reações ·
Todas as issues de localstack/serverless-localstack
Issues semelhantes
-
[DevEx]: Playground specs are excluded from both GUI and CI, so videoPlayground is unreachableAbertadev experience
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
cuttle-cards/cuttle#1413 ·
Mantenedores costumam responder em até 1 dia
-
macOS
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
beyondcode/herd-community#1761 ·
-
More wallpapersAbertaenhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
-
Make a dry lesson funAbertacontent good first issue hacktoberfest
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
vieanderes/understory#19 ·
-
automated issue report
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
lirantal/discoprint#37 ·
Mantenedores costumam responder em até 1 dia