Version 2

[willfarrell]

See /docs/CHAGNELOG.md & /docs/UPGRADE.md on release/2.x for what has changed.

TODO / Ideas

• init commit: Version 2-alpha #587
• security and performance best practice by default
• Node v14, maybe v12, drop v10 (will use conditional chaining)
• async/await core/middlewares (This will break existing middlewares) Remove support for callbacks and simplify codebase #356
• AWS SDK v3 Full ESM Support #584
  • Update paginated requests to use generators
• Unify middleware options
  • context manipulation
  • FIPS 140-2 support - https://aws.amazon.com/compliance/fips/
  • role assume (sts)
  • caching
  • enforse TLS connections https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/enforcing-tls.html
• allow ssm to pull > 10 keys (if possible)
• update avj to support draft-2019-09
• Review and Update error handling
• optimize dependency inclusion

If anyone has comments, suggestions, or must-have features. Please post them here.

Documentation

• update options for each middleware
• detailed upgrade guide with why
• detailed changelog
• typescript section
• example showing chaining between middleware that use internal
• Examples showing middleware ordering (apigw, s3, sqs, sns, edge)
• Profiler documentation (includes clinicjs)
• bundling details - provide .yarnclean for middy and deps w/ ref to https://github.com/93v/starve
• serverless config recommendations
• lambda env for activating experimental flags - https://nodejs.org/api/cli.html#cli_node_options_options
• update logo to svg
• AppoloClient common pattern [@middy/http-cors] Still getting a cors error when combined with ApolloClient #527
• final proof read
• update deprecation notice on older versions
• updated code of conduct to v2

Missing / Blocked

• Node.js v14 support on AWS Lambda Expected 2021-04-30
  • will transpile down to v12, not a blocker
• TypeScript Definitions
• Profile running code & micro optimmize
  • validator: 60ms setup time (draft-2019), 50ms (draft-07) Reduce code size by optionally refactoring errors into a function ajv-validator/ajv#1098
• publish with cjs & mjs https://github.com/gfmio/typescript-esm-cjs-hybrid-example
• ability to mock out middy with nock https://github.com/matt-sanders/middy-nock-error
• License check
• update website? no
• code review (core,util, ssm) by @lmammino
• util stay in core or move to own package?
  • update code and docs to reflect decision
  • resolve chicken & egg problem with util in middleware
• merge to main branch

Testing

• 100% test coverage
• FIPS 140-2 endpoints @willfarrell
• RDS @willfarrell
• Secrets Manager Secrets Manager middleware #151 add secrets-manager middleware #228
• SQS feat: add sqs-batch middleware #471
• SSM @willfarrell
• STS #569 Allow fetching parameters from a different account via STS #570
• webpack
• rollup

Dependencies

• aws-sdk/clients/rds missing promise() pattern Support .promise() pattern for RDS.Signer.getAuthToken aws/aws-sdk-js#3595
• ajv
  • ajv: optimize initialization Reduce code size by optionally refactoring errors into a function ajv-validator/ajv#1098
  • ajv-errors with i18n support Question: Multi-Language Custom Errors ajv-validator/ajv-errors#81
  • json-schema-traverse: Only publish required files epoberezkin/json-schema-traverse#34 Add files field to reduce package size #6 epoberezkin/json-schema-traverse#8
• busyboy
  • dicer: Only publish required files mscdex/dicer#21
• http-errors
  • setprototypeof: Only publish required files wesleytodd/setprototypeof#17
• json-mask: Only publish required files nemtsov/json-mask#125
• qs: Only publish required files ljharb/qs#389

Observations

• core npm size 38.4kb -> 12.8kb
• cold start times decrease by up to 20%

[baileytincher]

Can we rename the generics in the core declarations file? https://github.com/willfarrell/middy/blob/c5464931349a81bad412c52588a1245acb88b39e/packages/core/index.d.ts#L28

Instead of T, R, C we can go to something more descriptive like TEvent, TContext, TCallback?

Would this break backwards compatibility with anything? (I don't think it would)

[willfarrell]

v2 is going to be a breaking change. I think this is a great opportunity to make the names more descriptive.

[willfarrell]

After some reflection and discussion with others, I've decided to roll back to using aws-sdk v2 over v3. v3 just isn't as mature as it should be as flagged by the issues above. I'm confident AWS will address these open issues, but there is no guarantee they will in the near term.

[willfarrell]

The profiler has been removed as a requirement for v2 alpha. Opening up for discussion on the best approach #599