@@ -9,7 +9,8 @@ function testImmutableContext() {
99 selectSenders : ( ) => [ ] ,
1010 } ;
1111 test ( "should not modify context in log() calls" , ( ) => {
12- const logger = new Logger ( strategy ) ;
12+ const logger = new Logger ( strategy ) ;
13+ logger . side = 'test' ;
1314 const originalContext = { } ;
1415 const context = { ...originalContext } ;
1516
@@ -29,7 +30,7 @@ function testImmutableContext() {
2930
3031function testMessageContext ( ) {
3132 let result ;
32- const referenceContext = { a : "A" } ;
33+ const referenceContext = ( ) => ( { a : "A" } ) ;
3334 const sender = new class {
3435 send ( level , message , context ) {
3536 result = { level, message, context } ;
@@ -41,73 +42,117 @@ function testMessageContext() {
4142 selectSenders : ( ) => [ sender ] ,
4243 } ;
4344
44- const DETAILS_KEY = "message_details" ;
45-
46- test ( `should add the message argument to ${ DETAILS_KEY } , ( ) => {
45+ /**
46+ * log(..., { a: 1 }) should ...
47+ *
48+ * - log { message_details: { a: 1} }.
49+ */
50+ test ( `should add the message argument to ${ Logger . KEY_DETAILS } , ( ) => {
4751 const logger = new Logger ( strategy ) ;
4852 result = null ;
49- logger . log ( LogLevel . DEBUG , "some message" , referenceContext ) ;
53+ logger . log ( LogLevel . DEBUG , "some message" , referenceContext ( ) ) ;
5054
51- const actual = result . context [ DETAILS_KEY ] . a ;
55+ const actual = result . context [ Logger . KEY_DETAILS ] . a ;
5256 const expected = "A" ;
5357 // Message details is set
5458 expect ( actual ) . toBe ( expected ) ;
5559 } ) ;
5660
57- test ( `should merge contents of existing ${ DETAILS_KEY } , ( ) => {
61+ /**
62+ * log(..., { a: 1 }) should ...
63+ *
64+ * - NOT log { a: 1 }.
65+ */
66+ test ( "should not add the message arguments to context root" , ( ) => {
5867 const logger = new Logger ( strategy ) ;
5968 result = null ;
60- const originalContext = Object . assign ( { [ DETAILS_KEY ] : { foo : "bar" } } , referenceContext ) ;
61- logger . log ( LogLevel . DEBUG , "some message" , originalContext ) ;
69+ logger . log ( LogLevel . DEBUG , "some message" , referenceContext ( ) ) ;
6270
63- const actual = result . context [ DETAILS_KEY ] ;
64-
65- // Original top-level key should be in top [DETAILS_KEY].
66- const expectedReference = "A" ;
67- expect ( actual ) . toHaveProperty ( "a" ) ;
68- expect ( actual . a ) . toBe ( expectedReference ) ;
69-
70- // Key nested in original message_detail should also in top [DETAILS_KEY].
71- const expectedNested = "bar" ;
72- expect ( actual ) . toHaveProperty ( "foo" ) ;
73- expect ( actual . foo ) . toBe ( expectedNested ) ;
71+ const actual = result . context . hasOwnProperty ( "a" ) ;
72+ const expected = false ;
73+ // Message details is set
74+ expect ( actual ) . toBe ( expected ) ;
7475 } ) ;
7576
76- test ( `should not merge existing ${ DETAILS_KEY } , ( ) => {
77+ /**
78+ * log(..., { a: "A", message_details: { foo: "bar" } }) should...
79+ *
80+ * - log { message_details: { a: "A", message_details: { foo: "bar" } } },
81+ * unlike the message_details merging it did until 0.1.18 included.
82+ */
83+ test ( `should not merge contents of existing ${ Logger . KEY_DETAILS } , ( ) => {
7784 const logger = new Logger ( strategy ) ;
7885 result = null ;
79- const originalContext = Object . assign ( { [ DETAILS_KEY ] : { foo : "bar" } } , referenceContext ) ;
86+ const originalContext = Object . assign ( { [ Logger . KEY_DETAILS ] : { foo : "bar" } } , referenceContext ( ) ) ;
8087 logger . log ( LogLevel . DEBUG , "some message" , originalContext ) ;
8188
82- // Message+_details should not contain a nested [DETAILS_KEY].
83- const actual = result . context [ DETAILS_KEY ] ;
84- expect ( actual ) . not . toHaveProperty ( DETAILS_KEY ) ;
89+ const actual = result . context ;
90+ expect ( actual ) . not . toHaveProperty ( "a" ) ;
91+ expect ( actual ) . not . toHaveProperty ( "foo" ) ;
92+ expect ( actual ) . toHaveProperty ( Logger . KEY_DETAILS ) ;
93+
94+ // Original top-level keys should still be in top [KEY_DETAILS].
95+ const actualDetails = actual [ Logger . KEY_DETAILS ] ;
96+ expect ( actualDetails ) . toHaveProperty ( "a" , "A" ) ;
97+ expect ( actualDetails ) . toHaveProperty ( Logger . KEY_DETAILS ) ;
98+ expect ( actualDetails ) . not . toHaveProperty ( "foo" ) ;
99+
100+ // Key nested in original message_detail should remain in place.
101+ const actualNested = actualDetails [ Logger . KEY_DETAILS ] ;
102+ expect ( actualNested ) . not . toHaveProperty ( "a" , "A" ) ;
103+ expect ( actualNested ) . not . toHaveProperty ( Logger . KEY_DETAILS ) ;
104+ expect ( actualNested ) . toHaveProperty ( "foo" , 'bar' ) ;
85105 } ) ;
86106
87- test ( `should keep the latest keys when merging existing ${ DETAILS_KEY } , ( ) => {
107+ /**
108+ * log(..., { a: "A", message_details: { a: "A" } }) should...
109+ *
110+ * - log { message_details: { a: "A", message_details: { a: "A" } } },
111+ * unlike the message_details merging it did until 0.1.18 included.
112+ */
113+ test ( `should not merge existing ${ Logger . KEY_DETAILS } , ( ) => {
88114 const logger = new Logger ( strategy ) ;
89115 result = null ;
90- const originalContext = Object . assign ( referenceContext , { [ DETAILS_KEY ] : { a : "B " } } ) ;
116+ const originalContext = Object . assign ( { [ Logger . KEY_DETAILS ] : { a : "A " } } , referenceContext ( ) ) ;
91117 logger . log ( LogLevel . DEBUG , "some message" , originalContext ) ;
92118
93- // [DETAILS_KEY] should contain the newly added value for key "a", not the
94- // one present in the initial [DETAILS_KEY].
95- const actual = result . context [ DETAILS_KEY ] ;
96- const expected = "A" ;
97- // Message details is set
98- expect ( actual ) . toHaveProperty ( "a" ) ;
99- expect ( actual . a ) . toBe ( expected ) ;
119+ // Message_details should only contain a nested [KEY_DETAILS].
120+ const actual = result . context ;
121+ const keys = Object . keys ( actual ) . sort ( ) ;
122+ expect ( keys . length ) . toBe ( 3 ) ;
123+ expect ( keys ) . toEqual ( [ Logger . KEY_DETAILS , Logger . KEY_SOURCE , Logger . KEY_TS ] ) ;
124+ expect ( actual ) . toHaveProperty ( Logger . KEY_DETAILS ) ;
125+
126+ // Original top-level keys should still be in top [KEY_DETAILS].
127+ const actualDetails = actual [ Logger . KEY_DETAILS ] ;
128+ expect ( Object . keys ( actualDetails ) . length ) . toBe ( 2 ) ;
129+ expect ( actualDetails ) . toHaveProperty ( "a" , "A" ) ;
130+ expect ( actualDetails ) . toHaveProperty ( Logger . KEY_DETAILS ) ;
131+
132+ // Key nested in original message_detail should remain in place.
133+ const actualNested = actualDetails [ Logger . KEY_DETAILS ] ;
134+ expect ( Object . keys ( actualNested ) . length ) . toBe ( 1 ) ;
135+ expect ( actualNested ) . toHaveProperty ( "a" , "A" ) ;
100136 } ) ;
101137
102- test ( "should not add the message arguments to context root" , ( ) => {
138+ /**
139+ * log(..., { a: "A", message_details: { a: "B" } }) should ...
140+ *
141+ * - log { message_details: { a: "A", message_details: { a: "B" } } }.
142+ */
143+ test ( `should not merge keys within ${ Logger . KEY_DETAILS } , ( ) => {
103144 const logger = new Logger ( strategy ) ;
104145 result = null ;
105- logger . log ( LogLevel . DEBUG , "some message" , referenceContext ) ;
146+ const originalContext = Object . assign ( { [ Logger . KEY_DETAILS ] : { a : "B" } } , referenceContext ( ) ) ;
147+ logger . log ( LogLevel . DEBUG , "some message" , originalContext ) ;
106148
107- const actual = result . context . hasOwnProperty ( "a" ) ;
108- const expected = false ;
109- // Message details is set
110- expect ( actual ) . toBe ( expected ) ;
149+ // [KEY_DETAILS] should contain the newly added value for key "a", not the
150+ // one present in the initial [KEY_DETAILS].
151+ const actual = result . context [ Logger . KEY_DETAILS ] ;
152+ const expected = "A" ;
153+ // Message details is set.
154+ expect ( actual ) . toHaveProperty ( "a" ) ;
155+ expect ( actual . a ) . toBe ( expected ) ;
111156 } ) ;
112157}
113158
@@ -303,7 +348,9 @@ function testProcessors() {
303348 class TimeWarp extends ProcessorBase {
304349 // Let's do the time warp again.
305350 process ( context ) {
306- context . timestamp = { log : + new Date ( "1978-11-19 05:00:00" ) } ;
351+ context [ Logger . KEY_TS ] = {
352+ test : { log : + new Date ( "1978-11-19 05:00:00" ) } ,
353+ } ;
307354 context . hostname = "remote" ;
308355 return context ;
309356 }
@@ -317,6 +364,7 @@ function testProcessors() {
317364 selectSenders : ( ) => [ this . sender ] ,
318365 } ;
319366 this . logger = new Logger ( this . strategy ) ;
367+ this . logger . side = 'test' ;
320368 } ) ;
321369
322370 test ( "processors should be able to modify the content of ordinary existing keys" , ( ) => {
@@ -368,8 +416,8 @@ function testProcessors() {
368416 expect ( this . sender . logs . length ) . toBe ( 1 ) ;
369417 const [ , , context ] = this . sender . logs . pop ( ) ;
370418 expect ( context ) . toHaveProperty ( "hostname" , "local" ) ;
371- expect ( context ) . toHaveProperty ( "timestamp. log" ) ;
372- const lag = ts - context . timestamp . log ;
419+ expect ( context ) . toHaveProperty ( ` ${ Logger . KEY_TS } . ${ this . logger . side } . log` ) ;
420+ const lag = ts - context [ Logger . KEY_TS ] [ this . logger . side ] . log ;
373421 expect ( lag ) . toBeGreaterThanOrEqual ( 0 ) ;
374422 // No sane machine should take more than 100 msec to return from log() with
375423 // such a fast sending configuration.
@@ -384,8 +432,8 @@ function testProcessors() {
384432 expect ( this . sender . logs . length ) . toBe ( 1 ) ;
385433 const [ , , context ] = this . sender . logs . pop ( ) ;
386434 expect ( context ) . toHaveProperty ( "hostname" , "remote" ) ;
387- expect ( context ) . toHaveProperty ( "timestamp. log" ) ;
388- const lag = ts - context . timestamp . log ;
435+ expect ( context ) . toHaveProperty ( ` ${ Logger . KEY_TS } . ${ this . logger . side } . log` ) ;
436+ const lag = ts - context [ Logger . KEY_TS ] [ this . logger . side ] . log ;
389437 expect ( lag ) . toBeGreaterThanOrEqual ( 0 ) ;
390438 // No sane machine should take more than 100 msec to return from log() with
391439 // such a fast sending configuration. The TimeWarp processor attempts to
0 commit comments