Skip to content

Commit c3c12c6

Browse files
committed
Revert "feat(logger): add context decorator functionality (#13)"
This reverts commit 18f1097.
1 parent 18f1097 commit c3c12c6

13 files changed

+11
-163
lines changed

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"scripts": {
88
"commit": "commit",
99
"lerna-ci": "lerna exec -- npm ci",
10-
"lerna-test": "lerna exec -- npm run test",
10+
"lerna-test": "lerna exec -- jest --coverage --detectOpenHandles",
1111
"lerna-build": "lerna exec -- tsc",
1212
"lerna-lint": "lerna exec -- eslint \"./{src,tests}/**/*.ts\"",
1313
"lerna-format": "lerna exec -- eslint --fix \"./{src,tests}/**/*.ts\"",

packages/logger/README.md

-47
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ logger.error('This is an ERROR log');
5050

5151
### Capturing Lambda context info
5252

53-
Without decorators:
54-
5553
```typescript
5654
// Environment variables set for the Lambda
5755
process.env.LOG_LEVEL = 'WARN';
@@ -109,51 +107,6 @@ const lambdaHandler: Handler = async (event, context) => {
109107
</details>
110108

111109

112-
With decorators:
113-
114-
```typescript
115-
// Environment variables set for the Lambda
116-
process.env.LOG_LEVEL = 'INFO';
117-
process.env.POWERTOOLS_SERVICE_NAME = 'hello-world';
118-
119-
const logger = new Logger();
120-
121-
class Lambda implements LambdaInterface {
122-
123-
@logger.injectLambdaContext()
124-
public handler<TEvent, TResult>(_event: TEvent, _context: Context, _callback: Callback<TResult>): void | Promise<TResult> {
125-
126-
logger.info('This is an INFO log with some context');
127-
128-
}
129-
130-
}
131-
132-
new Lambda().handler(dummyEvent, dummyContext, () => console.log('Lambda invoked!'));
133-
134-
```
135-
136-
<details>
137-
<summary>Click to expand and see the logs outputs</summary>
138-
139-
```bash
140-
141-
{
142-
aws_request_id: 'c6af9ac6-7b61-11e6-9a41-93e8deadbeef',
143-
lambda_function_arn: 'arn:aws:lambda:eu-central-1:123456789012:function:Example',
144-
lambda_function_memory_size: 128,
145-
lambda_function_name: 'foo-bar-function',
146-
level: 'INFO',
147-
message: 'This is an INFO log with some context',
148-
service: 'hello-world',
149-
timestamp: '2021-03-17T08:25:41.198Z',
150-
xray_trace_id: 'abcdef123456abcdef123456abcdef123456'
151-
}
152-
153-
```
154-
</details>
155-
156-
157110
### Appending additional keys
158111

159112
```typescript

packages/logger/examples/child-logger.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ const lambdaHandler: Handler = async () => {
3030

3131
};
3232

33-
lambdaHandler(dummyEvent, dummyContext, () => console.log('Lambda invoked!'));
33+
lambdaHandler(dummyEvent, dummyContext, () => {});

packages/logger/examples/hello-world-with-context-decorators.ts

-28
This file was deleted.

packages/logger/examples/sample-rate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ const lambdaHandler: Handler = async () => {
3030

3131
};
3232

33-
lambdaHandler(dummyEvent, dummyContext, () => console.log('lambda invoked!'));
33+
lambdaHandler(dummyEvent, dummyContext, () => console.log('Lambda invoked!'));

packages/logger/jest.config.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ module.exports = {
2222
],
2323
'coverageThreshold': {
2424
'global': {
25-
'statements': 100,
26-
'branches': 100,
27-
'functions': 100,
28-
'lines': 100,
25+
'statements': 70,
26+
'branches': 60,
27+
'functions': 70,
28+
'lines': 70,
2929
},
3030
},
3131
'coverageReporters': [

packages/logger/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"scripts": {
1010
"commit": "commit",
11-
"test": "jest --detectOpenHandles",
11+
"test": "jest --coverage --detectOpenHandles",
1212
"watch": "jest --watch",
1313
"build": "tsc",
1414
"lint": "eslint \"./{src,tests}/**/*.ts\"",

packages/logger/src/lambda/LambdaInterface.ts

-9
This file was deleted.

packages/logger/src/lambda/index.ts

-1
This file was deleted.

packages/logger/tests/unit/Logger.test.ts

+1-67
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
21
import { Logger } from '../../src';
32
import { populateEnvironmentVariables } from '../helpers';
43

@@ -56,13 +55,8 @@ describe('Logger', () => {
5655

5756
logger.error('foo');
5857
logger.error('foo', { bar: 'baz' });
59-
logger.error({ bar: 'baz', message: 'foo' });
6058

61-
const error = new Error('Something happened!');
62-
error.stack = 'A custom stack trace';
63-
logger.error('foo', { bar: 'baz' }, error);
64-
65-
expect(console.log).toBeCalledTimes(4);
59+
expect(console.log).toBeCalledTimes(2);
6660
expect(console.log).toHaveBeenNthCalledWith(1, {
6761
message: 'foo',
6862
service: 'hello-world',
@@ -78,27 +72,6 @@ describe('Logger', () => {
7872
timestamp: '2016-06-20T12:08:10.000Z',
7973
xray_trace_id: 'abcdef123456abcdef123456abcdef123456'
8074
});
81-
expect(console.log).toHaveBeenNthCalledWith(3, {
82-
bar: 'baz',
83-
message: 'foo',
84-
service: 'hello-world',
85-
level: 'ERROR',
86-
timestamp: '2016-06-20T12:08:10.000Z',
87-
xray_trace_id: 'abcdef123456abcdef123456abcdef123456'
88-
});
89-
expect(console.log).toHaveBeenNthCalledWith(4, {
90-
bar: 'baz',
91-
error: {
92-
message: 'Something happened!',
93-
name: 'Error',
94-
stack: 'A custom stack trace',
95-
},
96-
message: 'foo',
97-
service: 'hello-world',
98-
level: 'ERROR',
99-
timestamp: '2016-06-20T12:08:10.000Z',
100-
xray_trace_id: 'abcdef123456abcdef123456abcdef123456'
101-
});
10275
});
10376

10477
test('should return a valid DEBUG log', () => {
@@ -152,44 +125,5 @@ describe('Logger', () => {
152125

153126
});
154127

155-
test('should return a valid INFO log with context enabled', () => {
156-
157-
const logger = new Logger({
158-
isContextEnabled: true
159-
});
160-
logger.addContext(dummyContext);
161-
162-
logger.info('foo');
163-
logger.info( { message: 'foo', bar: 'baz' });
164-
165-
expect(console.log).toBeCalledTimes(2);
166-
expect(console.log).toHaveBeenNthCalledWith(1, {
167-
'aws_request_id': 'c6af9ac6-7b61-11e6-9a41-93e8deadbeef',
168-
'cold_start': true,
169-
'lambda_function_arn': 'arn:aws:lambda:eu-central-1:123456789012:function:Example',
170-
'lambda_function_memory_size': 128,
171-
'lambda_function_name': 'foo-bar-function',
172-
'level': 'INFO',
173-
'message': 'foo',
174-
'service': 'hello-world',
175-
'timestamp': '2016-06-20T12:08:10.000Z',
176-
'xray_trace_id': 'abcdef123456abcdef123456abcdef123456'
177-
});
178-
expect(console.log).toHaveBeenNthCalledWith(2, {
179-
'aws_request_id': 'c6af9ac6-7b61-11e6-9a41-93e8deadbeef',
180-
'bar': 'baz',
181-
'cold_start': true,
182-
'lambda_function_arn': 'arn:aws:lambda:eu-central-1:123456789012:function:Example',
183-
'lambda_function_memory_size': 128,
184-
'lambda_function_name': 'foo-bar-function',
185-
'level': 'INFO',
186-
'message': 'foo',
187-
'service': 'hello-world',
188-
'timestamp': '2016-06-20T12:08:10.000Z',
189-
'xray_trace_id': 'abcdef123456abcdef123456abcdef123456'
190-
});
191-
192-
});
193-
194128
});
195129

packages/logger/tsconfig.json

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"compilerOptions": {
3-
"experimentalDecorators": true,
43
"noImplicitAny": true,
54
"target": "ES2020",
65
"module": "commonjs",

packages/logger/types/Log.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ type LogLevelInfo = 'INFO';
33
type LogLevelWarn = 'WARN';
44
type LogLevelError = 'ERROR';
55

6-
type LogLevel = LogLevelDebug | LogLevelInfo | LogLevelWarn | LogLevelError | string;
6+
type LogLevel = LogLevelDebug | LogLevelInfo | LogLevelWarn | LogLevelError;
77

88
type LogLevelThresholds = {
99
[key in LogLevel]: number;

packages/logger/types/formats/PowertoolLog.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { LogAttributes, LogLevel } from '..';
1+
import { LogAttributes, LogLevel } from '../Log';
22

33
type PowertoolLog = LogAttributes & {
44

0 commit comments

Comments
 (0)