Skip to content

Commit 07c2ceb

Browse files
committed
test: remove n-mask-logger
n-mask-logger has been fully removed from the FT's tech estate which means we can safely remove it from the compatibility tests. I've left the equivalent Reliability Kit logs in so that we don't lose compatibility in future, however there's no need to run mask logger as well.
1 parent 32c7e11 commit 07c2ceb

File tree

5 files changed

+7
-107
lines changed

5 files changed

+7
-107
lines changed

package-lock.json

Lines changed: 0 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/logger/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
},
3232
"devDependencies": {
3333
"@financial-times/n-logger": "^10.3.0",
34-
"@financial-times/n-mask-logger": "^7.2.0",
3534
"@types/events": "^3.0.3",
3635
"@types/lodash.clonedeep": "^4.5.9"
3736
}

packages/logger/test/end-to-end/compatibility-test-cases.js

Lines changed: 7 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -194,15 +194,7 @@ module.exports = [
194194
// Reliability kit does not send the `message` as an empty string
195195
// if one is not present – it explicitly sets it to `null`.
196196
expectedOutput: {
197-
nextMaskLogger: {
198-
level: 'info',
199-
name: 'L. Ogger',
200-
age: 32,
201-
email: '*****',
202-
password: '*****',
203-
role: 'Developer',
204-
message: ''
205-
},
197+
// n-mask-logger test case removed - it's not in use anywhere
206198
reliabilityKitMaskLogger: {
207199
level: 'info',
208200
name: 'L. Ogger',
@@ -234,16 +226,7 @@ module.exports = [
234226
// Reliability kit does not send the `message` as an empty string
235227
// if one is not present – it explicitly sets it to `null`.
236228
expectedOutput: {
237-
nextMaskLogger: {
238-
level: 'info',
239-
foo: 'bar',
240-
inner: {
241-
some: 'field',
242-
deep: { password: '*****' },
243-
email: '*****'
244-
},
245-
message: ''
246-
},
229+
// n-mask-logger test case removed - it's not in use anywhere
247230
reliabilityKitMaskLogger: {
248231
level: 'info',
249232
foo: 'bar',
@@ -264,10 +247,7 @@ module.exports = [
264247
args: ['Oh look password = 123abc']
265248
},
266249
expectedOutput: {
267-
nextMaskLogger: {
268-
level: 'info',
269-
message: 'Oh look password = *****'
270-
},
250+
// n-mask-logger test case removed - it's not in use anywhere
271251
reliabilityKitMaskLogger: {
272252
level: 'info',
273253
message: 'Oh look password = *****'
@@ -602,21 +582,7 @@ module.exports = [
602582
]
603583
},
604584
expectedOutput: {
605-
nextMaskLogger: {
606-
level: 'info',
607-
message: 'Test message',
608-
list: [
609-
{
610-
email: '*****',
611-
subList: [
612-
{
613-
postcode: '*****'
614-
}
615-
]
616-
},
617-
'password = *****'
618-
]
619-
},
585+
// n-mask-logger test case removed - it's not in use anywhere
620586
reliabilityKitMaskLogger: {
621587
level: 'info',
622588
message: 'Test message',
@@ -652,15 +618,7 @@ module.exports = [
652618
// properties only. Reliability Kit also doesn't deal with errors found in
653619
// other properties, this is for backwards compatibility with n-logger.
654620
expectedOutput: {
655-
nextMaskLogger: {
656-
level: 'info',
657-
message: 'password = *****',
658-
name: 'Error',
659-
nestedError: {
660-
message: 'email = *****',
661-
name: 'Error'
662-
}
663-
},
621+
// n-mask-logger test case removed - it's not in use anywhere
664622
reliabilityKitMaskLogger: {
665623
level: 'info',
666624
message: null,
@@ -884,13 +842,7 @@ module.exports = [
884842
]
885843
},
886844
expectedOutput: {
887-
nextMaskLogger: {
888-
level: 'info',
889-
message: 'updateProfile',
890-
result: 'success',
891-
userId: 'abc123',
892-
apiEnv: 'PROD'
893-
},
845+
// n-mask-logger test case removed - it's not in use anywhere
894846
reliabilityKitMaskLogger: {
895847
level: 'info',
896848
message: 'updateProfile',
@@ -927,23 +879,7 @@ module.exports = [
927879
]
928880
},
929881
expectedOutput: {
930-
nextMaskLogger: {
931-
level: 'error',
932-
message: 'editBillingDetails',
933-
error: {
934-
url: '/example',
935-
status: 500,
936-
method: 'post',
937-
responseBody: {
938-
user: {
939-
email: '*****'
940-
}
941-
},
942-
headers: {
943-
'X-Request-Id': '123'
944-
}
945-
}
946-
},
882+
// n-mask-logger test case removed - it's not in use anywhere
947883
reliabilityKitMaskLogger: {
948884
level: 'error',
949885
message: 'editBillingDetails',

packages/logger/test/end-to-end/compatibility.spec.js

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,6 @@ describe('@dotcom-reliability-kit/logger vs @financial-times/n-logger', () => {
3636
});
3737
}
3838

39-
if (expectedOutput.nextMaskLogger) {
40-
it('outputs the expected n-mask-logger logs', () => {
41-
const log = findLogWithPropertyValue(
42-
logs,
43-
'_logger',
44-
'nextMaskLogger'
45-
);
46-
expect(log).toBeTruthy();
47-
const cleanLog = cleanLogForTesting(log);
48-
expect(cleanLog).toEqual(expectedOutput.nextMaskLogger);
49-
});
50-
}
51-
5239
if (expectedOutput.reliabilityKit) {
5340
it('outputs the expected reliability-kit logs', () => {
5441
const log = findLogWithPropertyValue(

packages/logger/test/end-to-end/scripts/run-loggers-with-test-case.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@ process.env.SPLUNK_LOG_LEVEL = 'silly';
88
process.env.LOG_DISABLE_PRETTIFIER = 'true';
99

1010
const nLogger = require('@financial-times/n-logger').default;
11-
const MaskLogger = require('@financial-times/n-mask-logger');
1211
const reliabilityKitLogger = require('../../../lib');
1312
const testCases = require('../compatibility-test-cases');
1413

15-
const nMaskLogger = new MaskLogger();
1614
const reliabilityKitMaskLogger = new reliabilityKitLogger.Logger({
1715
transforms: [reliabilityKitLogger.transforms.legacyMask()]
1816
});
@@ -36,11 +34,6 @@ if (reliabilityKitLogger[method]) {
3634
reliabilityKitLogger[method](...args, { _logger: 'reliabilityKit' });
3735
}
3836

39-
// Run n-mask-logger
40-
if (nMaskLogger[method]) {
41-
nMaskLogger[method](...args, { _logger: 'nextMaskLogger' });
42-
}
43-
4437
// Run reliability kit masked logger
4538
if (reliabilityKitMaskLogger[method]) {
4639
reliabilityKitMaskLogger[method](...args, {

0 commit comments

Comments
 (0)