feat!: version 2, the ESM update #2117

dreamorosi · 2024-02-20T21:04:44Z

Description of your changes

This PR includes all the changes for the next major version of Powertools for AWS Lambda (TypeScript).

The changes in the PR support the features described here, however the size of the PR is due to two factors:

this is a long running branch (6+ months)
to allow for ESM+CJS build we had to touch almost all files under packages/* and modify all imports and exports

The PR also includes changes to the docs & related code snippets.

Many of the changes in this branch have been reviewed in isolation when they were merged in the feat/v2 branch.

Related issues, RFCs

Issue number: #1714

Checklist

My changes meet the tenets criteria
I have performed a self-review of my own code
I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my change is effective and works
The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: YES

I have documented the migration process
I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

* Updated formatAttributes for additional parameters and LogItem return type * Updated the unit tests to pass with new formatter * Updated Powertool named objects to Powertools * Updated tests to match new naming consistency * Updated for tests for new naming consistency * Updated formatter for new design decisions * Update Logger for ephemeral attributes * Update bringYourOwnFormatter documentation to match new formatter --------- Co-authored-by: erikayao93 <[email protected]>

…pdate (#1585) * Updated formatAttributes for additional parameters and LogItem return type * Updated the unit tests to pass with new formatter * Updated Powertool named objects to Powertools * Updated tests to match new naming consistency * Updated for tests for new naming consistency * Updated formatter for new design decisions * Update Logger for ephemeral attributes * Update bringYourOwnFormatter documentation to match new formatter * Fixed incorrect return type, renamed variable for consistency

* Updated formatAttributes for additional parameters and LogItem return type * Updated the unit tests to pass with new formatter * Updated Powertool named objects to Powertools * Updated tests to match new naming consistency * Updated for tests for new naming consistency * Updated formatter for new design decisions * Update Logger for ephemeral attributes * Update bringYourOwnFormatter documentation to match new formatter --------- Co-authored-by: erikayao93 <[email protected]>

…pdate (#1585) * Updated formatAttributes for additional parameters and LogItem return type * Updated the unit tests to pass with new formatter * Updated Powertool named objects to Powertools * Updated tests to match new naming consistency * Updated for tests for new naming consistency * Updated formatter for new design decisions * Update Logger for ephemeral attributes * Update bringYourOwnFormatter documentation to match new formatter * Fixed incorrect return type, renamed variable for consistency

…1722) * chore(maintenance): bump dependencies & drop nodejs14x (#1687) * chore: add pre-release script * chore: restore deps * chore: added v2 shim * chore(maintenance): remove logger and tracer helper function * chore: remove imports * chore: fix deps & versions * tests: moved unit tests * tests: move logger tests * chore: added v2 shim * chore: added v2 shim

* feat(logger): add esm build output * fix(Logger): Remove barrel files update references * test(Logger): update jest/ts-jest to use ESM * chore(Logger): remove unused lodash.merge * fix(logger): reinstate lodash.merge * chore(logger): revert TS assertion * chore(logger): revert format changes * chore(logger): update postbuild to remove incremental tsbuildinfo files * fix(logger): correct reference to types output * feat(logging): add middleware export * chore(logger): replace postbuild script with echo statement * feat(logger): add typesVersions property and barrel files to /types * chore(logger): file not used, can be added back if needed * chore(logger): add space back to README * chore(logger): revert space in README

* chore(logger): adapt logger to commons exports * feat(commons): add esmodule support * chore: address sonar findings * chore(commons): exported version * chore: fixed imports in examples * chore(parameters): fixed imports * chore(metrics): fixed imports * chore(tracer): fixed imports * chore(idempotency): fixed imports * chore(commons): test coverage * chore(batch): fix imports

* feat(testing): add esmodule support * chore(all): update imports

* feat(tracer): add esmodule support * chore(docs): update imports

* feat(idempotency): add esmodule support

* docs(maintenance): update mkdocs to support tabs * chore(ci): add parallel test npm script * chore(ci): add jest command * docs(maintenance): add testing page to navbar * docs(maintenance): add contributing info * chore: update roadmap * chore: update release drafter workflow to allow for manual trigger * fix formatting * docs: maintainers handbook * chore: link to new location * fix links * Update docs/maintainers.md Co-authored-by: Alexander Schueren <[email protected]> --------- Co-authored-by: Alexander Schueren <[email protected]>

…he other runtimes (#1744) * test(logger): remove logsSampled field, add default sampleRateValue * test(logger): add tests for sampling debug logs feature * feat(logger): change implementation to make sampling decision at per-function level * refactor(logger): remove redundant createLogger method * refactor(logger): remove getSampleRateValue method * test(logger): improve tests * refactor(logger): return createLogger() back with the detailed comment of the method importance * test(logger): add constructor/custom config/env var priority tests for sampling rate feature, improve description * refactor(logger): address review comments * feat(logger): add refreshSampleRateCalculation method and tests * test(logger): adjust end-to-end tests

* chore(logger): refactor types and interfaces * chore: grouped type files * chore: fix code smell * chore: fix ci * chore: fix ci

heitorlessa · 2024-02-21T19:16:32Z

Aha didn't know the !. By the power of grayskull I'll probably trust these 404 files are fine.

dreamorosi · 2024-02-21T19:30:44Z

I have just run the integration tests on this branch & they are green: https://github.com/aws-powertools/powertools-lambda-typescript/actions/runs/7994389117

By the power of grayskull I'll probably trust these 404 files are fine.

.github/workflows/make-version.yml

docs/index.md

examples/cdk/functions/common/powertools.ts

packages/batch/jest.config.cjs

packages/batch/package.json

packages/batch/src/index.ts

packages/batch/tsconfig.esm.json

packages/batch/tsconfig.json

packages/commons/src/awsSdkUtils.ts

packages/commons/src/samples/resources/events/aws/apigateway-authorizer.json

packages/logger/src/types/Log.ts

tsconfig.json

tsconfig.esm.json

am29d

Only few small questions.

examples/cdk/package.json

package.json

examples/cdk/package.json

sonarqubecloud · 2024-02-27T19:57:56Z

Quality Gate passed

Issues
1 New issue

Measures
0 Security Hotspots
No data about Coverage
8.4% Duplication on New Code

See analysis details on SonarCloud

dreamorosi · 2024-02-27T21:13:49Z

Thanks a lot for the review @am29d, really appreciate you pouring time & effort to go through it.

I have addressed both your comments. Please feel free to start resolving any open conversion that you're aligned with & have no more questions on.

am29d

Incredible work Andrea, thank you for your time, energy and endurance to make V2 possible. Looking forward to finally release it!

erikayao93 and others added 30 commits February 20, 2024 20:19

chore(maintenance): bump dependencies & drop nodejs14x (#1687)

a087819

chore: update release script to mark all utilities as alpha

2ed10ed

chore: restore version to ease conflicts

a0122e3

chore: release version change

e423e8b

chore: release version change

72ec0b6

feat(parameters): add esmodule support (#1736)

3ba9d43

feat(batch): add esmodule support (#1737)

4ee57bd

feat(internal): add esmodule support (#1738)

2ff1026

* feat(testing): add esmodule support * chore(all): update imports

feat(metrics): add esmodule support (#1739)

57e7b67

feat(tracer): add esmodule support (#1741)

793ef7f

* feat(tracer): add esmodule support * chore(docs): update imports

feat(idempotency): add esmodule support (#1743)

7331038

* feat(idempotency): add esmodule support

chore(metrics): fix import

ae75a4a

chore(ci): v2 release line

a0a973b

chore(ci): fix alpha versioning pre-release

3bf0b01

chore(docs): add invisible unicode char to decorator docs (#1755)

2c9433b

chore: remove extra comma

a31c44c

chore(docs): upgrade doc intro

cd226ae

chore(logger): refactor types and interfaces (#1758)

b4568f9

* chore(logger): refactor types and interfaces * chore: grouped type files * chore: fix code smell * chore: fix ci * chore: fix ci

chore(maintenance): bump Middy v4 & run tests (#1760)

138162d

chore(parameters): fix esm bundling

37e13bd

chore(parameters): change declare client param

902a07c

docs: add install steps to batch

93dc33f