feat(logging): add new logging category #12759

ashwinkumar6 · 2023-12-27T20:29:22Z

Description of changes

Create new logging category
Add category APIs
- enable
- disable
- flushLogs
- createLogger
Add provider cloudwatch APIs
- enable
- disable
- getProvider
Add provider console APIs
- enable
- disable
- getProvider
Add placeholder unit tests for all APIs

Description of how you validated changes

verified apis are visible

import { 
  enable,
  disable,
  flushLogs,
  createLogger
} from "aws-amplify/logging";
import {
  getProvider as getConsoleProvider,
  enable as enableConsole,
  disable as disableConsole,
} from "aws-amplify/logging/console";
import {
  getProvider as getCloudWatchProvider,
  enable as enableCloudwatch,
  disable as disableCloudwatch,
} from "aws-amplify/logging/cloudwatch";

PR description included
yarn test passes
Tests are changed or added

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

…ify-js into central-logger-addcategory

.github/dependency-review/dependecy-review-config.yml

HuiSF · 2023-12-28T20:07:24Z

packages/logger/index.js

If the logger package is not expected to be published as CDN bundle, please remove Webpack related settings.

thanks, removed webpack related settings.

packages/logger/tsconfig.json

packages/logger/package.json

Co-authored-by: Hui Zhao <10602282+HuiSF@users.noreply.github.com>

…to central-logger-addcategory

jimblanc

Some comments, but overall looks good!

packages/logger/build.js

packages/logger/index.js

packages/logger/package.json

jimblanc · 2024-01-03T15:49:00Z

packages/logger/package.json

+		"tslib": "^2.5.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.0.0"


Not required yet, but at some point before merge we'll need to update this to the version that will contain the new logger utils (across all packages)

Ahhhh yes got it, all packages having peerDependencies on core would need to update to use the latest core version. This to make sure they have access to latest logger that's implemented in core

Removing this for now, will add it back when required.
EDIT: added back (reference)

Co-authored-by: Jim Blanchard <jim.l.blanchard@gmail.com>

jimblanc · 2024-01-04T17:51:32Z

packages/logger/package.json

-	"peerDependencies": {
-		"@aws-amplify/core": "^6.0.0"
-	},


IMO we should leave this in place for our pre-publish script to update it during testing and so that we don't forget to update when we bump the other packages

makes sense, added back

cshfang · 2024-01-03T18:48:41Z

packages/logger/tsconfig.build.json

@@ -0,0 +1,5 @@
+{


Is there any reason this package still needs a separate build configuration, or can it just share the same tsconfig.json like most of our packages do now?

I think this will be unified in the eslint migration, so we can keep it. wdyt

It depends on the timing of that vs this I think? If this feature branch is merged after that migration then it will be missed by the migration right?

good point, adding a todo to make sure this is tracked

packages/logger/src/providers/cloudwatch/index.ts

packages/logger/__tests__/providers/cloudwatch/apis/getCloudWatchProvider.test.ts

packages/logger/console/package.json

packages/logger/jest.config.js

…rovider

packages/aws-amplify/package.json

…packages

HuiSF · 2024-01-09T22:09:00Z

packages/logging/src/apis/createLogger.ts

+// SPDX-License-Identifier: Apache-2.0
+
+// TODO: pending implementation
+export const createLogger = (): void => {};


nit/suggestion: could define the actual return type here, and leave the implementation throw new Error('API has not been implemented.'), this would be more continuous.

that's a good point. We'll be wiring up all these PRs once the other Providers PR gets merged.
So we should shortly be replacing all these. If anything's pending will add the throw new Error('API has not been implemented.') wdyt

feat(logger): add new logger category

d29d081

ashwinkumar6 requested review from a team as code owners December 27, 2023 20:29

ashwinkumar6 changed the base branch from main to central-logger December 27, 2023 20:29

ashwinkumar6 force-pushed the central-logger-addcategory branch from a20b949 to f3967b7 Compare December 27, 2023 21:09

feat(logger): init unit tests

d42e148

ashwinkumar6 force-pushed the central-logger-addcategory branch from f3967b7 to d42e148 Compare December 27, 2023 21:56

Ashwin Kumar added 2 commits December 27, 2023 17:40

feat(ci): allow 0BSD license

e6ee513

Merge branch 'add-dep-review-license' of github.com:ashwinkumar6/ampl…

2c88525

…ify-js into central-logger-addcategory

ashwinkumar6 commented Dec 27, 2023

View reviewed changes

.github/dependency-review/dependecy-review-config.yml Outdated Show resolved Hide resolved

ashwinkumar6 requested review from jimblanc and HuiSF December 27, 2023 23:54

ashwinkumar6 mentioned this pull request Dec 28, 2023

feat(logger): add console, cloudWatch providers #12735

Closed

HuiSF reviewed Dec 28, 2023

View reviewed changes

ashwinkumar6 and others added 5 commits December 28, 2023 15:55

Update packages/logger/tsconfig.json

ff99f86

Co-authored-by: Hui Zhao <10602282+HuiSF@users.noreply.github.com>

Update packages/logger/package.json

eda958d

Co-authored-by: Hui Zhao <10602282+HuiSF@users.noreply.github.com>

fix(logger): set package version to 1.0.0

adcb59c

fix(logger): remove webpack settings

8a97e9d

fix(logger): add export tests

a71c9e4

ashwinkumar6 requested a review from HuiSF December 28, 2023 22:02

Ashwin Kumar added 3 commits January 2, 2024 12:16

feat(ci): remove 0BSD license

62577fb

Merge branch 'central-logger' of github.com:aws-amplify/amplify-js in…

4ac2ab6

…to central-logger-addcategory

Merge branch 'central-logger' of github.com:aws-amplify/amplify-js in…

9d287fa

…to central-logger-addcategory

jimblanc reviewed Jan 3, 2024

View reviewed changes

ashwinkumar6 and others added 3 commits January 4, 2024 10:37

Update packages/logger/package.json

e2243f7

Co-authored-by: Jim Blanchard <jim.l.blanchard@gmail.com>

Update packages/logger/package.json

edbe138

Co-authored-by: Jim Blanchard <jim.l.blanchard@gmail.com>

address feedback

b2e59c1

ashwinkumar6 requested a review from jimblanc January 4, 2024 17:08

jimblanc reviewed Jan 4, 2024

View reviewed changes

fix: add core peerDep to logger

ce4e3d3

jimblanc approved these changes Jan 4, 2024

View reviewed changes

cshfang reviewed Jan 4, 2024

View reviewed changes

Ashwin Kumar added 2 commits January 5, 2024 13:53

fix:rename apis generateLogger, getConsoleProvider, andgetCloudWatchP…

e31f2d2

…rovider

fix: add index file inside provideName/apis

81753ce

ashwinkumar6 changed the title ~~feat(logger): add new logger category~~ feat(logging): add new logging category Jan 5, 2024

ashwinkumar6 force-pushed the central-logger-addcategory branch from 5a69717 to ed38a6e Compare January 5, 2024 22:55

fix: rename category logger to logging

dc7b7f2

ashwinkumar6 force-pushed the central-logger-addcategory branch from ed38a6e to dc7b7f2 Compare January 6, 2024 01:33

ashwinkumar6 requested review from jimblanc and cshfang January 6, 2024 01:34

Ashwin Kumar added 3 commits January 5, 2024 17:39

fix: code cleanup

48a88f8

chore: add jest coverage

3cb9ef5

resolve conflicts from main

ffb02c8

ashwinkumar6 commented Jan 6, 2024

View reviewed changes

packages/aws-amplify/package.json Outdated Show resolved Hide resolved

ashwinkumar6 and others added 2 commits January 5, 2024 18:13

Update packages/aws-amplify/package.json

26f45d8

chore: update @aws-amplify/logging to use same core version as other …

af062e3

…packages

cshfang approved these changes Jan 8, 2024

View reviewed changes

HuiSF approved these changes Jan 9, 2024

View reviewed changes

ashwinkumar6 merged commit 1d26ca8 into aws-amplify:central-logger Jan 10, 2024
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(logging): add new logging category #12759

feat(logging): add new logging category #12759

ashwinkumar6 commented Dec 27, 2023 •

edited

HuiSF Dec 28, 2023

ashwinkumar6 Dec 28, 2023

jimblanc left a comment

jimblanc Jan 3, 2024

ashwinkumar6 Jan 4, 2024 •

edited

ashwinkumar6 Jan 4, 2024 •

edited

jimblanc Jan 4, 2024

ashwinkumar6 Jan 4, 2024

cshfang Jan 3, 2024

ashwinkumar6 Jan 5, 2024 •

edited

cshfang Jan 8, 2024

ashwinkumar6 Jan 10, 2024

HuiSF Jan 9, 2024

ashwinkumar6 Jan 10, 2024

feat(logging): add new logging category #12759

feat(logging): add new logging category #12759

Conversation

ashwinkumar6 commented Dec 27, 2023 • edited

Description of changes

Description of how you validated changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimblanc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashwinkumar6 Jan 4, 2024 • edited

Choose a reason for hiding this comment

ashwinkumar6 Jan 4, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashwinkumar6 Jan 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashwinkumar6 commented Dec 27, 2023 •

edited

ashwinkumar6 Jan 4, 2024 •

edited

ashwinkumar6 Jan 4, 2024 •

edited

ashwinkumar6 Jan 5, 2024 •

edited