Skip to content

Commit 69b6693

Browse files
hermannmhermannm
committed
Update example event IDs
1 parent 53c32e9 commit 69b6693

File tree

12 files changed

+43
-43
lines changed

12 files changed

+43
-43
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ import kotlinx.serialization.Serializable
6161
data class Event(val id: Long, val type: String)
6262

6363
fun example() {
64-
val event = Event(id = 1001, type = "ORDER_UPDATED")
64+
val event = Event(id = 1000, type = "ORDER_UPDATED")
6565

6666
log.info {
6767
field("event", event)
@@ -80,7 +80,7 @@ a more structured manner than if you were to just use string concatenation.
8080
{
8181
"message": "Processing event",
8282
"event": {
83-
"id": 1001,
83+
"id": 1000,
8484
"type": "ORDER_UPDATED"
8585
},
8686
// ...timestamp etc.

‎integration-tests/jul/src/test/kotlin/dev/hermannm/devlog/integrationtest/jul/JulLoggerTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class JulLoggerTest {
2020
fun log() {
2121
@Serializable data class Event(val id: Long, val type: String)
2222

23-
val event = Event(id = 1001, type = "ORDER_UPDATED")
23+
val event = Event(id = 1000, type = "ORDER_UPDATED")
2424

2525
// java.util.logging logger outputs to stderr by default
2626
val output = captureStderr {
@@ -44,7 +44,7 @@ class JulLoggerTest {
4444
output.substring(indexOfPackageName).removeSuffix("\n") shouldBe
4545
"""
4646
dev.hermannm.devlog.integrationtest.jul.JulLoggerTest log
47-
INFO: Test [event={"id":1001,"type":"ORDER_UPDATED"}]
47+
INFO: Test [event={"id":1000,"type":"ORDER_UPDATED"}]
4848
"""
4949
.trimIndent()
5050
}

‎integration-tests/log4j/src/test/kotlin/dev/hermannm/devlog/integrationtest/log4j/Log4jLoggerTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class Log4jLoggerTest {
1717
fun log() {
1818
@Serializable data class Event(val id: Long, val type: String)
1919

20-
val event = Event(id = 1001, type = "ORDER_UPDATED")
20+
val event = Event(id = 1000, type = "ORDER_UPDATED")
2121

2222
val output = captureStdout {
2323
withLoggingContext(rawJsonField("contextField", """{"test":true}""")) {
@@ -29,7 +29,7 @@ class Log4jLoggerTest {
2929
}
3030

3131
output shouldContain """"log.level":"INFO""""
32-
output shouldContain """"message":"Test [event={\"id\":1001,\"type\":\"ORDER_UPDATED\"}]""""
32+
output shouldContain """"message":"Test [event={\"id\":1000,\"type\":\"ORDER_UPDATED\"}]""""
3333

3434
// When using Logback with logstash-logback-encoder, we provide a JsonContextFieldWriter
3535
// for writing objects in withLoggingContext as actual JSON. But we don't have any equivalent

‎integration-tests/logback/src/test/kotlin/dev/hermannm/devlog/integrationtest/logback/LogbackLoggerTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class LogbackLoggerTest {
2121

2222
@Serializable data class Event(val id: Long, val type: String)
2323

24-
val event = Event(id = 1001, type = "ORDER_UPDATED")
24+
val event = Event(id = 1000, type = "ORDER_UPDATED")
2525

2626
val log = getLogger()
2727

@@ -36,7 +36,7 @@ class LogbackLoggerTest {
3636

3737
output shouldContain """"level":"INFO""""
3838
output shouldContain """"message":"Test""""
39-
output shouldContain """"event":{"id":1001,"type":"ORDER_UPDATED"}"""
39+
output shouldContain """"event":{"id":1000,"type":"ORDER_UPDATED"}"""
4040
output shouldContain """"contextField":{"test":true}"""
4141
}
4242

‎src/commonMain/kotlin/dev/hermannm/devlog/LogBuilder.kt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ internal constructor(
6565
* private val log = getLogger()
6666
*
6767
* fun example() {
68-
* val event = Event(id = 1001, type = EventType.ORDER_PLACED)
68+
* val event = Event(id = 1000, type = EventType.ORDER_PLACED)
6969
*
7070
* log.info {
7171
* field("event", event)
@@ -87,7 +87,7 @@ internal constructor(
8787
* {
8888
* "message": "Processing event",
8989
* "event": {
90-
* "id": 1001,
90+
* "id": 1000,
9191
* "type": "ORDER_PLACED"
9292
* },
9393
* // ...timestamp etc.
@@ -183,7 +183,7 @@ internal constructor(
183183
* private val log = getLogger()
184184
*
185185
* fun example() {
186-
* val event = Event(id = 1001, type = EventType.ORDER_PLACED)
186+
* val event = Event(id = 1000, type = EventType.ORDER_PLACED)
187187
*
188188
* log.info {
189189
* field("event", event)
@@ -205,7 +205,7 @@ internal constructor(
205205
* {
206206
* "message": "Processing event",
207207
* "event": {
208-
* "id": 1001,
208+
* "id": 1000,
209209
* "type": "ORDER_PLACED"
210210
* },
211211
* // ...timestamp etc.
@@ -262,7 +262,7 @@ internal constructor(
262262
* private val log = getLogger()
263263
*
264264
* fun example() {
265-
* val eventJson = """{"id":1001,"type":"ORDER_PLACED"}"""
265+
* val eventJson = """{"id":1000,"type":"ORDER_PLACED"}"""
266266
*
267267
* log.info {
268268
* rawJsonField("event", eventJson)
@@ -275,7 +275,7 @@ internal constructor(
275275
* ```json
276276
* {
277277
* "message": "Processing event",
278-
* "event": {"id":1001,"type":"ORDER_PLACED"},
278+
* "event": {"id":1000,"type":"ORDER_PLACED"},
279279
* // ...timestamp etc.
280280
* }
281281
* ```

‎src/commonMain/kotlin/dev/hermannm/devlog/LogField.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ public fun <ValueT : Any> field(
218218
* private val log = getLogger()
219219
*
220220
* fun example() {
221-
* val eventJson = """{"id":1001,"type":"ORDER_PLACED"}"""
221+
* val eventJson = """{"id":1000,"type":"ORDER_PLACED"}"""
222222
*
223223
* withLoggingContext(rawJsonField("event", eventJson)) {
224224
* log.debug { "Started processing event" }
@@ -230,8 +230,8 @@ public fun <ValueT : Any> field(
230230
*
231231
* This gives the following output (using `logstash-logback-encoder`):
232232
* ```json
233-
* {"message":"Started processing event","event":{"id":1001,"type":"ORDER_PLACED"},/* ...timestamp etc. */}
234-
* {"message":"Finished processing event","event":{"id":1001,"type":"ORDER_PLACED"},/* ...timestamp etc. */}
233+
* {"message":"Started processing event","event":{"id":1000,"type":"ORDER_PLACED"},/* ...timestamp etc. */}
234+
* {"message":"Finished processing event","event":{"id":1000,"type":"ORDER_PLACED"},/* ...timestamp etc. */}
235235
* ```
236236
*
237237
* @param validJson Set this true if you are 100% sure that [json] is valid JSON, and you want to

‎src/commonTest/kotlin/dev/hermannm/devlog/ExceptionWithLoggingContextTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ internal class ExceptionWithLoggingContextTest {
246246

247247
@Test
248248
fun `serializable object field works on ExceptionWithLoggingContext`() {
249-
val event = Event(id = 1001, type = EventType.ORDER_PLACED)
249+
val event = Event(id = 1000, type = EventType.ORDER_PLACED)
250250

251251
val output = captureLogOutput {
252252
log.error(
@@ -258,7 +258,7 @@ internal class ExceptionWithLoggingContextTest {
258258

259259
output.logFields shouldBe
260260
"""
261-
"event":{"id":1001,"type":"ORDER_PLACED"}
261+
"event":{"id":1000,"type":"ORDER_PLACED"}
262262
"""
263263
.trimIndent()
264264
}

‎src/commonTest/kotlin/dev/hermannm/devlog/LogFieldTest.kt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ internal class LogFieldTest {
104104
@Test
105105
fun `log field with Serializable object`() {
106106
parameterizedTest(LogFieldTestCase.entries) { test ->
107-
val event = Event(id = 1001, type = EventType.ORDER_PLACED)
107+
val event = Event(id = 1000, type = EventType.ORDER_PLACED)
108108

109109
val output = captureLogOutput {
110110
log.info {
@@ -115,7 +115,7 @@ internal class LogFieldTest {
115115

116116
output.logFields shouldBe
117117
"""
118-
"event":{"id":1001,"type":"ORDER_PLACED"}
118+
"event":{"id":1000,"type":"ORDER_PLACED"}
119119
"""
120120
.trimIndent()
121121
}
@@ -277,12 +277,12 @@ internal class LogFieldTest {
277277
}
278278

279279
val output = captureLogOutput {
280-
genericLogFunction(Event(id = 1001, type = EventType.ORDER_PLACED), Event.serializer())
280+
genericLogFunction(Event(id = 1000, type = EventType.ORDER_PLACED), Event.serializer())
281281
}
282282

283283
output.logFields shouldBe
284284
"""
285-
"object":{"id":1001,"type":"ORDER_PLACED"}
285+
"object":{"id":1000,"type":"ORDER_PLACED"}
286286
"""
287287
.trimIndent()
288288
}
@@ -293,7 +293,7 @@ internal class LogFieldTest {
293293
parameterizedTest(LogFieldTestCase.entries) { test ->
294294
data class NonSerializableEvent(val id: Long, val type: String)
295295

296-
val event = NonSerializableEvent(id = 1001, type = "ORDER_UPDATED")
296+
val event = NonSerializableEvent(id = 1000, type = "ORDER_UPDATED")
297297

298298
val output = captureLogOutput {
299299
log.info {
@@ -304,7 +304,7 @@ internal class LogFieldTest {
304304

305305
output.logFields shouldBe
306306
"""
307-
"event":"NonSerializableEvent(id=1001, type=ORDER_UPDATED)"
307+
"event":"NonSerializableEvent(id=1000, type=ORDER_UPDATED)"
308308
"""
309309
.trimIndent()
310310
}
@@ -353,7 +353,7 @@ internal class LogFieldTest {
353353
@Test
354354
fun `raw JSON field works for valid JSON`() {
355355
parameterizedTest(RawJsonTestCase.entries) { test ->
356-
val eventJson = """{"id":1001,"type":"ORDER_UPDATED"}"""
356+
val eventJson = """{"id":1000,"type":"ORDER_UPDATED"}"""
357357

358358
// The above JSON should work both for validJson = true and validJson = false
359359
for (assumeValidJson in listOf(true, false)) {
@@ -426,7 +426,7 @@ internal class LogFieldTest {
426426
val jsonWithNewlines =
427427
"""
428428
{
429-
"id": 1001,
429+
"id": 1000,
430430
"type": "ORDER_UPDATED"
431431
}
432432
"""
@@ -441,7 +441,7 @@ internal class LogFieldTest {
441441

442442
output.logFields shouldBe
443443
"""
444-
"event":{"id":1001,"type":"ORDER_UPDATED"}
444+
"event":{"id":1000,"type":"ORDER_UPDATED"}
445445
"""
446446
.trimIndent()
447447
}
@@ -557,16 +557,16 @@ internal class LogFieldTest {
557557
stringField.toString() shouldBe "key=value"
558558
stringField.toString() shouldBe stringField2.toString()
559559

560-
val objectField = field("key", Event(id = 1001, type = EventType.ORDER_PLACED))
560+
val objectField = field("key", Event(id = 1000, type = EventType.ORDER_PLACED))
561561

562562
stringField.equals(objectField).shouldBeFalse()
563563
stringField.hashCode() shouldNotBe objectField.hashCode()
564564

565-
val objectAsStringField = field("key", """{"id":1001,"type":"ORDER_PLACED"}""")
565+
val objectAsStringField = field("key", """{"id":1000,"type":"ORDER_PLACED"}""")
566566

567567
objectField.equals(objectAsStringField).shouldBeTrue()
568568
objectField.hashCode() shouldBe objectAsStringField.hashCode()
569-
objectField.toString() shouldBe """key={"id":1001,"type":"ORDER_PLACED"}"""
569+
objectField.toString() shouldBe """key={"id":1000,"type":"ORDER_PLACED"}"""
570570
objectField.toString() shouldBe objectAsStringField.toString()
571571
}
572572
}

‎src/commonTest/kotlin/dev/hermannm/devlog/LoggerTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ internal data class LoggerTestCase(
4040
),
4141
LogField(
4242
key = LoggerTest.TestInput.FIELD_KEY_2,
43-
value = """{"id":1001,"type":"ORDER_PLACED"}""",
43+
value = """{"id":1000,"type":"ORDER_PLACED"}""",
4444
isJson = true,
4545
),
4646
),
@@ -72,7 +72,7 @@ internal class LoggerTest {
7272
const val FIELD_KEY_1: String = "key1"
7373
const val FIELD_VALUE_1: String = "value1"
7474
const val FIELD_KEY_2: String = "key2"
75-
val FIELD_VALUE_2: Event = Event(id = 1001, type = EventType.ORDER_PLACED)
75+
val FIELD_VALUE_2: Event = Event(id = 1000, type = EventType.ORDER_PLACED)
7676
val CAUSE: Throwable? = Exception("Something went wrong")
7777
}
7878

‎src/commonTest/kotlin/dev/hermannm/devlog/LoggingContextTest.kt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ internal class LoggingContextTest {
5454
fun `rawJsonField works with logging context`() {
5555
val output = captureLogOutput {
5656
withLoggingContext(
57-
rawJsonField("event", """{"id":1001,"type":"ORDER_UPDATED"}"""),
57+
rawJsonField("event", """{"id":1000,"type":"ORDER_UPDATED"}"""),
5858
) {
5959
log.info { "Test" }
6060
}
@@ -65,7 +65,7 @@ internal class LoggingContextTest {
6565
"event" to
6666
JsonObject(
6767
mapOf(
68-
"id" to JsonPrimitive(1001),
68+
"id" to JsonPrimitive(1000),
6969
"type" to JsonPrimitive("ORDER_UPDATED"),
7070
),
7171
),
@@ -310,8 +310,8 @@ internal class LoggingContextTest {
310310

311311
@Test
312312
fun `nested logging context restores previous context fields on exit`() {
313-
val event1 = Event(id = 1001, type = EventType.ORDER_PLACED)
314-
val event2 = Event(id = 1002, type = EventType.ORDER_UPDATED)
313+
val event1 = Event(id = 1000, type = EventType.ORDER_PLACED)
314+
val event2 = Event(id = 1001, type = EventType.ORDER_UPDATED)
315315

316316
withLoggingContext(
317317
field("event", event1),
@@ -321,7 +321,7 @@ internal class LoggingContextTest {
321321
) {
322322
val parentContext =
323323
mapOf(
324-
"event" to """{"id":1001,"type":"ORDER_PLACED"}""",
324+
"event" to """{"id":1000,"type":"ORDER_PLACED"}""",
325325
"stringField" to "parentValue",
326326
"parentOnlyField" to "value1",
327327
"fieldThatIsStringInParentButJsonInChild" to "stringValue",
@@ -336,7 +336,7 @@ internal class LoggingContextTest {
336336
) {
337337
loggingContextShouldContainExactly(
338338
mapOf(
339-
"event" to """{"id":1002,"type":"ORDER_UPDATED"}""",
339+
"event" to """{"id":1001,"type":"ORDER_UPDATED"}""",
340340
"stringField" to "childValue",
341341
"parentOnlyField" to "value1",
342342
"childOnlyField" to "value2",

0 commit comments

Comments
 (0)