Skip to content

feat(logger): adopted Utility class & updated unit tests #550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Feb 28, 2022
Merged

feat(logger): adopted Utility class & updated unit tests #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5b7c848
feat: adopted Utility class & updated unit tests
dreamorosi Feb 10, 2022
66bb82a
docs: added notice in docs
dreamorosi Feb 17, 2022
0fa811a
WIP
dreamorosi Feb 22, 2022
aaecc99
build: added commons dependency
dreamorosi Feb 24, 2022
747b7f8
deps: fixed lock
dreamorosi Feb 24, 2022
35785ba
rebuilt lock after rebase
dreamorosi Feb 24, 2022
f559043
chore: update commented
dreamorosi Feb 24, 2022
ebf5ef8
set explicit packages order
dreamorosi Feb 25, 2022
6c0aa36
Merge branch 'feat/logger/adopt_utility_common_cold_start' of github.…
dreamorosi Feb 25, 2022
b2df92e
amend lock
dreamorosi Feb 25, 2022
0fe3c5b
run with older
dreamorosi Feb 25, 2022
0dd1031
removed commons from workspace
dreamorosi Feb 25, 2022
4da832f
build: added foreground-scripts flag to CI
dreamorosi Feb 28, 2022
6df3a79
fix: issue with workflows
dreamorosi Feb 28, 2022
7a25c27
fix: lock file
dreamorosi Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/on-merge-to-main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ jobs:
npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
- name: Install monorepo packages
# This installs all the dependencies of ./packages/*
run: npm ci
# See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
run: npm ci --foreground-scripts
- name: Install example packages
# Since we are not managing the cdk examples with npm workspaces we install
# the dependencies in a separate step
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/on-release-prod.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ jobs:
npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
- name: Install monorepo packages
# This installs all the dependencies of ./packages/*
run: npm ci
# See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
run: npm ci --foreground-scripts
- name: Install example packages
# Since we are not managing the cdk examples with npm workspaces we install
# the dependencies in a separate step
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/pr_lint_and_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ jobs:
npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
- name: Install monorepo packages
# This installs all the dependencies of ./packages/*
run: npm ci
# See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
run: npm ci --foreground-scripts
- name: Install example packages
# Since we are not managing the cdk examples with npm workspaces we install
# the dependencies in a separate step
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/run-e2e-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ jobs:
run: npm i -g npm@next-8
- name: Install monorepo packages
# This installs all the dependencies of ./packages/*
run: npm ci
# See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
run: npm ci --foreground-scripts
- name: Install example packages
# Since we are not managing the cdk examples with npm workspaces we install
# the dependencies in a separate step
Expand Down
2 changes: 2 additions & 0 deletions docs/core/logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ For a **complete list** of supported environment variables, refer to [this secti

#### Example using AWS Serverless Application Model (SAM)

The `Logger` utility is instantiated outside of the Lambda handler. In doing this, the same instance can be used across multiple invocations inside the same execution environment. This allows `Metrics` to be aware of things like whether or not a given invocation had a cold start or not.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this paragraph!

Suggestion #1 (minor): I understand what we are trying to achieve with this paragraph, but I don't know if it's entirely clear what is the advantage of reusing the instance on multiple invocation here. The Metrics reference can also be confusing since the Logger has the cold start logic too.

Suggestion #2 (minor): I'd move this text outside of the SAM section as this does not relate to SAM specifically. Maybe it can be formatted as inline block to make it more visible?
https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=warning#inline-blocks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes total sense, I'll open a separate PR after this one is merged as the same "notice" appears also in Tracer & Metrics which have already been merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#604


=== "handler.ts"

```typescript hl_lines="1 4"
Expand Down
Loading