Update version to 1.9.0

Add trace object with id field to meta object
Update doc

Author: devslm

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.9.0] - 2022-11-07
+### Added:
+  - Trace object with id field to meta object
+
 ## [1.8.0] - 2022-11-01
 ### Added:
   - Error links object support

README.md

@@ -16,7 +16,7 @@ Add dependency to your project:
 <dependency>
     <groupId>com.slm-dev</groupId>
     <artifactId>jsonapi-simple</artifactId>
-    <version>1.8.0</version>
+    <version>1.9.0</version>
 </dependency>
 ```
 
@@ -578,3 +578,48 @@ public class Test {
   }
 }
 ```
+
+Example response with trace id (trace id can be string or UUID):
+```java
+// Pseudo code
+public class Test {
+    public Response<Void> main() {
+        return Response.<Void, Void>builder()
+            .data(
+                TestDto.builder()
+                    .id(UUID.randomUUID())
+                    .name("Test string")
+                    .createDate(LocalDateTime.now(ZoneOffset.UTC))
+                    .build()
+            ).metaTrace(new Meta.Trace(UUID.randomUUID()))
+            .build();
+    }
+}
+```
+```json
+{
+    "data": {
+        "type":"test-object",
+        "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
+        "attributes": {
+            "name":"Test string",
+            "createDate":"2019-10-08T18:46:53.40297"
+        },
+        "links": {
+            "self": "/test-object/7a543e90-2961-480e-b1c4-51249bf0c566"
+        }
+    },
+    "meta": {
+        "api": {
+            "version":"1"
+        },
+        "page": {
+            "maxSize":25,
+            "total":1
+        },
+        "trace": {
+            "id": "1a443e90-6961-480e-b1c4-51249bf0c566"
+        }
+    }
+}
+```

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.slm-dev</groupId>
 	<artifactId>jsonapi-simple</artifactId>
-	<version>1.8.0</version>
+	<version>1.9.0</version>
 	<name>jsonapi-simple</name>
 	<description>Simple implementation of the JSON:API specification</description>
 	<url>https://slm-dev.com/jsonapi-simple/</url>

src/main/java/com/slmdev/jsonapi/simple/response/Meta.java

@@ -16,14 +16,15 @@ public class Meta {
     private Api api;
     private Page page;
     private WebSocket webSocket;
+    private Trace trace;
 
     @Data
     @AllArgsConstructor
     @JsonInclude(JsonInclude.Include.NON_NULL)
     public static class Page {
         @ApiModelProperty(value = "Page size", required = true)
         private int maxSize;
-        @ApiModelProperty(value = "Totatl number data objects", required = true)
+        @ApiModelProperty(value = "Total number data objects", required = true)
         private long total;
         @ApiModelProperty("Link to the previous page if exist")
         private String prev;
@@ -36,6 +37,26 @@ public static class Page {
     @AllArgsConstructor
     @JsonInclude(JsonInclude.Include.NON_NULL)
     public static class WebSocket {
+        @ApiModelProperty("Websocket session id")
         private UUID sessionId;
     }
+
+    @Data
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class Trace {
+        public Trace() {
+
+        }
+
+        public Trace(final String id) {
+            this.id = id;
+        }
+
+        public Trace(final UUID id) {
+            this.id = id.toString();
+        }
+
+        @ApiModelProperty("Trace id (any string identifier, ie request id)")
+        private String id;
+    }
 }

src/main/java/com/slmdev/jsonapi/simple/response/Response.java

@@ -81,6 +81,7 @@ public ResponseBuilder() {
             this.meta = new Meta(
                 new Api(DEFAULT_API_VERSION),
                 new Meta.Page(DEFAULT_MAX_PAGE_SIZE, -1, null, null),
+                null,
                 null
             );
         }
@@ -519,6 +520,16 @@ public ResponseBuilder<T, V> metaWebSocket(final @NonNull Meta.WebSocket metaWeb
             return this;
         }
 
+        /**
+         * @param trace trace specific meta information
+         * @return self link
+         */
+        public ResponseBuilder<T, V> metaTrace(final @NonNull Meta.Trace trace) {
+            meta.setTrace(trace);
+
+            return this;
+        }
+
         /**
          * Build response.
          *

src/test/java/com/slmdev/jsonapi/simple/response/ResponseTest.java

@@ -289,16 +289,52 @@ public void shouldReturnResponseWithManuallyDataTypeAndIdAndValidInvokesOrderFor
 		assertThat(response.getData().getAttributes().get("key"), is(List.of("value")));
 	}
 
+	@Test
+	public void shouldReturnResponseWithTraceIdAsString() {
+		final String id = UUID.randomUUID().toString();
+		final String traceId = UUID.randomUUID().toString();
+		final Response<Data<Map<String, List<String>>>> response = Response.<Data<Map<String, List<String>>>, Map<String, List<String>>>builder()
+			.jsonApiId(id)
+			.jsonApiType("custom-data-type")
+			.data(Map.of("key", List.of("value")))
+			.metaTrace(new Meta.Trace(traceId))
+			.build();
+
+		assertThat(response.getData().getId(), is(id));
+		assertThat(response.getData().getType(), is("custom-data-type"));
+		assertThat(response.getData().getAttributes().get("key"), is(List.of("value")));
+
+		assertThat(response.getMeta().getApi().getVersion(), is("1"));
+		assertThat(response.getMeta().getTrace().getId(), is(traceId));
+	}
+
+	@Test
+	public void shouldReturnResponseWithTraceIdAsUuid() {
+		final String id = UUID.randomUUID().toString();
+		final UUID traceId = UUID.randomUUID();
+		final Response<Data<Map<String, List<String>>>> response = Response.<Data<Map<String, List<String>>>, Map<String, List<String>>>builder()
+			.jsonApiId(id)
+			.jsonApiType("custom-data-type")
+			.data(Map.of("key", List.of("value")))
+			.metaTrace(new Meta.Trace(traceId))
+			.build();
+
+		assertThat(response.getData().getId(), is(id));
+		assertThat(response.getData().getType(), is("custom-data-type"));
+		assertThat(response.getData().getAttributes().get("key"), is(List.of("value")));
+
+		assertThat(response.getMeta().getApi().getVersion(), is("1"));
+		assertThat(response.getMeta().getTrace().getId(), is(traceId.toString()));
+	}
+
 	@Test
 	public void shouldThrowExceptionWithManuallyDataTypeAndInValidInvokesOrder() {
 		Assertions.assertThrows(
 			RuntimeException.class,
-			() -> {
-				Response.<Data<Map<String, String>>, Map<String, String>>builder()
-					.data(Map.of("key", "value"))
-					.jsonApiType("custom-data-type")
-					.build();
-			}
+			() -> Response.<Data<Map<String, String>>, Map<String, String>>builder()
+				.data(Map.of("key", "value"))
+				.jsonApiType("custom-data-type")
+				.build()
 		);
 	}
 
@@ -412,6 +448,39 @@ public void shouldParseJsonResponseWithErrors() {
 		assertThat(response.getErrors().get(0).getSource().getParameter(), is("name"));
 	}
 
+	@Test
+	@SneakyThrows
+	public void shouldParseJsonResponseWithMetaTrace() {
+		final String traceId = UUID.randomUUID().toString();
+		final String data = "{\n" +
+			"    \"errors\": [\n" +
+			"        {\n" +
+			"            \"code\": \"400\",\n" +
+			"            \"source\": {\n" +
+			"                \"parameter\": \"name\"\n" +
+			"            }\n" +
+			"        }\n" +
+			"    ],\n" +
+			"    \"meta\": {\n" +
+			"        \"api\": {\n" +
+			"            \"version\": \"1\"\n" +
+			"        },\n" +
+			"        \"trace\": {\n" +
+			"            \"id\": \"" + traceId + "\"\n" +
+			"        }\n" +
+			"    }\n" +
+			"}";
+		final TypeReference<Response<List<Data<Map<String, Object>>>>> type = new TypeReference<>() {};
+		final Response<List<Data<Map<String, Object>>>> response = new ObjectMapper().readValue(data, type);
+
+		assertThat(response.getErrors().size(), is(1));
+		assertThat(response.getErrors().get(0).getCode(), is("400"));
+		assertThat(response.getErrors().get(0).getSource().getParameter(), is("name"));
+
+		assertThat(response.getMeta().getApi().getVersion(), is("1"));
+		assertThat(response.getMeta().getTrace().getId(), is(traceId));
+	}
+
 	private TestDto buildTestDto1() {
 		return new TestDto()
 			.setId(TEST_DTO_1_ID)