From 0f58b4e9981d38f6059fd039c395adb3c2811838 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Mon, 23 Mar 2026 15:44:58 +0100 Subject: [PATCH 01/41] Add: Encodable interface as lowest instance --- .../dbis/cs108/casono/server/network/response/Encodable.java | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java new file mode 100644 index 0000000..af4d231 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java @@ -0,0 +1,5 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +public interface Encodable { + String encode(); +} From eb63f6d39b91b4170e38aacabafde5e732e9dd07 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Mon, 23 Mar 2026 15:45:44 +0100 Subject: [PATCH 02/41] Add: Base classes for all responses --- .../network/response/ErrorResponse.java | 32 +++++++++++++++++++ .../server/network/response/Response.java | 16 ++++++++++ .../network/response/SuccessResponse.java | 23 +++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java new file mode 100644 index 0000000..801667e --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java @@ -0,0 +1,32 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + +public class ErrorResponse extends Response { + private final String code; + private final String message; + + public ErrorResponse( + SessionId sessionId, int requestId, String errorCode, String errorMessage) { + this.sessionId = sessionId; + this.requestId = requestId; + this.code = errorCode; + this.message = errorMessage; + } + + public ErrorResponse(SessionId sessionId, int requestId, String errorCode) { + this.sessionId = sessionId; + this.requestId = requestId; + this.code = errorCode; + this.message = null; + } + + @Override + public String encode() { + if (message != null && !message.isEmpty()) { + return "-ERR CODE=" + code + " MSG=" + message; + } else { + return "-ERR CODE=" + code; + } + } +} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java new file mode 100644 index 0000000..f9c0f20 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java @@ -0,0 +1,16 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + +public abstract class Response implements Encodable { + protected SessionId sessionId; + protected int requestId; + + public SessionId getSessionId() { + return sessionId; + } + + public int getRequestId() { + return requestId; + } +} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java new file mode 100644 index 0000000..e9f9f2d --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java @@ -0,0 +1,23 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + +public abstract class SuccessResponse extends Response { + public SuccessResponse(SessionId sessionId, int requestId) { + this.sessionId = sessionId; + this.requestId = requestId; + } + + public final String encode() { + String payload = payload(); + if (payload.isBlank()) { + return "+OK"; + } else { + return "+OK " + payload; + } + } + + protected String payload() { + return ""; + } +} From bcfbe065321f7861f8f19ee84784469bc3387d1d Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 12:19:25 +0100 Subject: [PATCH 03/41] Add: ResponseNode and implementations to store body of response --- .../casono/server/network/response/ResponseBlock.java | 5 +++++ .../cs108/casono/server/network/response/ResponseNode.java | 3 +++ .../casono/server/network/response/ResponseParameter.java | 7 +++++++ 3 files changed, 15 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java new file mode 100644 index 0000000..868b7ee --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java @@ -0,0 +1,5 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import java.util.List; + +public record ResponseBlock(String tag, List children) implements ResponseNode {} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java new file mode 100644 index 0000000..ea22d0a --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java @@ -0,0 +1,3 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +public interface ResponseNode {} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java new file mode 100644 index 0000000..4d04293 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java @@ -0,0 +1,7 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +public record ResponseParameter(String key, Object value) implements ResponseNode { + public String rawValue() { + return value.toString(); + } +} From e7c9063a5d74523f39722e8d6972462371b13222 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 12:33:36 +0100 Subject: [PATCH 04/41] Remove: Encodable as encode-method is no longer used --- .../dbis/cs108/casono/server/network/response/Encodable.java | 5 ----- .../dbis/cs108/casono/server/network/response/Response.java | 2 +- 2 files changed, 1 insertion(+), 6 deletions(-) delete mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java deleted file mode 100644 index af4d231..0000000 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Encodable.java +++ /dev/null @@ -1,5 +0,0 @@ -package ch.unibas.dmi.dbis.cs108.casono.server.network.response; - -public interface Encodable { - String encode(); -} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java index f9c0f20..c2274ad 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java @@ -2,7 +2,7 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; -public abstract class Response implements Encodable { +public abstract class Response { protected SessionId sessionId; protected int requestId; From 796827cbb4e57860d167ebffce3176affa92f0a7 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 12:52:35 +0100 Subject: [PATCH 05/41] Add: ResponseBody and ResponseBodyBuilder classes for building response body --- .../server/network/response/ResponseBody.java | 19 ++++++++++++++ .../network/response/ResponseBodyBuilder.java | 25 +++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java new file mode 100644 index 0000000..7e75f59 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java @@ -0,0 +1,19 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import java.util.List; + +public class ResponseBody { + private final List nodes; + + ResponseBody(List nodes) { + this.nodes = List.copyOf(nodes); + } + + public static ResponseBodyBuilder builder() { + return new ResponseBodyBuilder(); + } + + public List nodes() { + return nodes; + } +} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java new file mode 100644 index 0000000..e8a8329 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java @@ -0,0 +1,25 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.Consumer; + +public class ResponseBodyBuilder { + private final List nodes = new ArrayList<>(); + + public ResponseBodyBuilder param(String key, Object value) { + nodes.add(new ResponseParameter(key, value)); + return this; + } + + public ResponseBodyBuilder block(String tag, Consumer content) { + ResponseBodyBuilder childBuilder = new ResponseBodyBuilder(); + content.accept(childBuilder); + nodes.add(new ResponseBlock(tag, childBuilder.build().nodes())); + return this; + } + + public ResponseBody build() { + return new ResponseBody(nodes); + } +} From 02c82c4e953fb59084065613a11f84325fe8802f Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 13:11:25 +0100 Subject: [PATCH 06/41] Refactor: Responses to use new ResponseBody --- .../network/response/ErrorResponse.java | 30 +++++-------------- .../server/network/response/Response.java | 17 +++++++++-- .../network/response/SuccessResponse.java | 19 ++++-------- 3 files changed, 28 insertions(+), 38 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java index 801667e..a26244b 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java @@ -3,30 +3,16 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; public class ErrorResponse extends Response { - private final String code; - private final String message; - - public ErrorResponse( - SessionId sessionId, int requestId, String errorCode, String errorMessage) { - this.sessionId = sessionId; - this.requestId = requestId; - this.code = errorCode; - this.message = errorMessage; - } - - public ErrorResponse(SessionId sessionId, int requestId, String errorCode) { - this.sessionId = sessionId; - this.requestId = requestId; - this.code = errorCode; - this.message = null; + public ErrorResponse(SessionId sessionId, int requestId, String errorCode, String errorMessage) { + super(sessionId, requestId, ResponseBody.builder() + .param("CODE", errorCode) + .param("MSG", errorMessage) + .build() + ); } @Override - public String encode() { - if (message != null && !message.isEmpty()) { - return "-ERR CODE=" + code + " MSG=" + message; - } else { - return "-ERR CODE=" + code; - } + public String prefix() { + return "-ERR"; } } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java index c2274ad..b42e7af 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java @@ -3,8 +3,17 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; public abstract class Response { - protected SessionId sessionId; - protected int requestId; + private final SessionId sessionId; + private final int requestId; + private final ResponseBody body; + + protected Response(SessionId sessionId, int requestId, ResponseBody body) { + this.sessionId = sessionId; + this.requestId = requestId; + this.body = body; + } + + public abstract String prefix(); public SessionId getSessionId() { return sessionId; @@ -13,4 +22,8 @@ public abstract class Response { public int getRequestId() { return requestId; } + + public ResponseBody getBody() { + return body; + } } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java index e9f9f2d..dae5308 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java @@ -3,21 +3,12 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; public abstract class SuccessResponse extends Response { - public SuccessResponse(SessionId sessionId, int requestId) { - this.sessionId = sessionId; - this.requestId = requestId; + protected SuccessResponse(SessionId sessionId, int requestId, ResponseBody body) { + super(sessionId, requestId, body); } - public final String encode() { - String payload = payload(); - if (payload.isBlank()) { - return "+OK"; - } else { - return "+OK " + payload; - } - } - - protected String payload() { - return ""; + @Override + public final String prefix() { + return "+OK"; } } From a281f747895311a4aba34ce86e96a1c8444911ad Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 13:39:06 +0100 Subject: [PATCH 07/41] Add: ResponseEncoder to encode Response to PrimitiveResponse --- .../network/response/ResponseEncoder.java | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java new file mode 100644 index 0000000..873ee66 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java @@ -0,0 +1,57 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +public class ResponseEncoder { + private static final String INDENT = "\t"; + private static final String NEWLINE = "\n"; + + public static PrimitiveResponse encode(Response response) { + StringBuilder sb = new StringBuilder(); + sb.append(response.prefix()); + + for (ResponseNode node : response.getBody().nodes()) { + sb.append(NEWLINE); + encodeNode(node, sb, 1); + } + + sb.append(NEWLINE).append("END"); + + return new PrimitiveResponse( + response.getSessionId(), response.getRequestId(), sb.toString()); + } + + private static void encodeNode(ResponseNode node, StringBuilder sb, int depth) { + if (node instanceof ResponseParameter param) { + encodeParameter(param, sb, depth); + } else if (node instanceof ResponseBlock block) { + encodeBlock(block, sb, depth); + } + } + + private static void encodeParameter(ResponseParameter param, StringBuilder sb, int depth) { + sb.append(INDENT.repeat(depth)); + sb.append(param.key()); + sb.append("="); + sb.append(maskIfNeeded(param.value().toString())); + } + + private static void encodeBlock(ResponseBlock block, StringBuilder sb, int depth) { + sb.append(INDENT.repeat(depth)); + sb.append(block.tag()); + + for (ResponseNode child : block.children()) { + sb.append(NEWLINE); + encodeNode(child, sb, depth + 1); + } + + sb.append(NEWLINE); + sb.append(INDENT.repeat(depth)); + sb.append("END"); + } + + private static String maskIfNeeded(String value) { + if (value.contains(" ")) { + return "'" + value + "'"; + } + return value; + } +} From d0b431b65022f849dd7ecb7272ebafed1b7f6dae Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 13:40:34 +0100 Subject: [PATCH 08/41] Fix: Escape single quote when masking string --- .../casono/server/network/response/ResponseEncoder.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java index 873ee66..bc66aad 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java @@ -49,8 +49,9 @@ public class ResponseEncoder { } private static String maskIfNeeded(String value) { - if (value.contains(" ")) { - return "'" + value + "'"; + if (value.contains(" ") || value.contains("'")) { + String escaped = value.replace("'", "\\'"); + return "'" + escaped + "'"; } return value; } From 676216d291ce1e113d4195a5613bb100bef4f1e2 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 13:49:24 +0100 Subject: [PATCH 09/41] Add: ResponseDispatcher for handling response dispatching --- .../network/response/ResponseDispatcher.java | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java new file mode 100644 index 0000000..184cd78 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java @@ -0,0 +1,18 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.Session; +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionManager; + +public class ResponseDispatcher { + private final SessionManager sessionManager; + + public ResponseDispatcher(SessionManager sessionManager) { + this.sessionManager = sessionManager; + } + + public void dispatch(Response response) throws InterruptedException { + PrimitiveResponse primitiveResponse = ResponseEncoder.encode(response); + Session session = sessionManager.getSessionById(response.getSessionId()); + session.getResponseQueue().put(primitiveResponse); + } +} From 696542003fa9535f883c396fab064e5ae3f68d13 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 14:33:46 +0100 Subject: [PATCH 10/41] Add: Detailed JavaDoc documentation for response related components Disclaimer: The docstrings have been written with Copilot but fact-checked by me. --- .../network/response/ErrorResponse.java | 28 ++++++++++--- .../network/response/PrimitiveResponse.java | 7 ++++ .../server/network/response/Response.java | 31 +++++++++++++- .../network/response/ResponseBlock.java | 7 ++++ .../server/network/response/ResponseBody.java | 21 ++++++++++ .../network/response/ResponseBodyBuilder.java | 26 ++++++++++++ .../network/response/ResponseDispatcher.java | 18 +++++++++ .../network/response/ResponseEncoder.java | 40 +++++++++++++++++++ .../server/network/response/ResponseNode.java | 5 +++ .../network/response/ResponseParameter.java | 16 ++++++++ .../network/response/SuccessResponse.java | 20 ++++++++++ 11 files changed, 212 insertions(+), 7 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java index a26244b..602181b 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ErrorResponse.java @@ -2,15 +2,31 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; +/** Response representing an error outcome for a client's request. */ public class ErrorResponse extends Response { - public ErrorResponse(SessionId sessionId, int requestId, String errorCode, String errorMessage) { - super(sessionId, requestId, ResponseBody.builder() - .param("CODE", errorCode) - .param("MSG", errorMessage) - .build() - ); + /** + * Construct an error response with a code and message. + * + * @param sessionId the target session id + * @param requestId the originating request id + * @param errorCode a short error code identifying the failure + * @param errorMessage a human readable error message + */ + public ErrorResponse( + SessionId sessionId, int requestId, String errorCode, String errorMessage) { + super( + sessionId, + requestId, + ResponseBody.builder().param("CODE", errorCode).param("MSG", errorMessage).build()); } + /** + * {@inheritDoc} + * + *

This implementation returns the fixed {@code -ERR} prefix. + * + * @return the {@code -ERR} prefix + */ @Override public String prefix() { return "-ERR"; diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/PrimitiveResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/PrimitiveResponse.java index 38a7422..1ef7a6a 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/PrimitiveResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/PrimitiveResponse.java @@ -2,4 +2,11 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; +/** + * Immutable transport record representing an encoded response ready for delivery to a session. + * + * @param sessionId the target session id + * @param requestId the originating request id + * @param payload the serialized response payload + */ public record PrimitiveResponse(SessionId sessionId, int requestId, String payload) {} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java index b42e7af..8a3cf96 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/Response.java @@ -2,28 +2,57 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; +/** Abstract base class for all server responses sent to clients. */ public abstract class Response { private final SessionId sessionId; private final int requestId; private final ResponseBody body; + /** + * Create a new {@code Response}. + * + * @param sessionId the id of the session this response targets + * @param requestId the request identifier this response corresponds to + * @param body the structured response body + */ protected Response(SessionId sessionId, int requestId, ResponseBody body) { this.sessionId = sessionId; this.requestId = requestId; this.body = body; } + /** + * Returns the protocol prefix for this response (for example {@code "+OK"} or {@code "-ERR"}). + * + * @return the response prefix string used by the encoder + */ public abstract String prefix(); + /** + * Returns the session id that should receive this response. + * + * @return the target {@link SessionId} + */ public SessionId getSessionId() { return sessionId; } + /** + * Returns the request identifier associated with this response. + * + * @return the numeric request id + */ public int getRequestId() { return requestId; } + /** + * Returns the immutable {@link ResponseBody} that carries the structured payload for this + * response. + * + * @return the response body + */ public ResponseBody getBody() { - return body; + return body; } } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java index 868b7ee..075abaf 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBlock.java @@ -2,4 +2,11 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import java.util.List; +/** + * A block node that contains a tag and a list of child {@link ResponseNode} elements. Blocks can be + * nested to build hierarchical response bodies. + * + * @param tag the block tag + * @param children the child nodes contained in this block + */ public record ResponseBlock(String tag, List children) implements ResponseNode {} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java index 7e75f59..8c52ffc 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBody.java @@ -2,17 +2,38 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import java.util.List; +/** + * Immutable container for the structured content of a {@link Response}. + * + *

A {@code ResponseBody} holds an ordered list of {@link ResponseNode} items (parameters and + * blocks). Use {@link #builder()} to construct instances. + */ public class ResponseBody { private final List nodes; + /** + * Package-private constructor used by {@link ResponseBodyBuilder}. + * + * @param nodes the list of response nodes to include in this body + */ ResponseBody(List nodes) { this.nodes = List.copyOf(nodes); } + /** + * Create a new {@link ResponseBodyBuilder} for assembling a response body. + * + * @return a fresh builder instance + */ public static ResponseBodyBuilder builder() { return new ResponseBodyBuilder(); } + /** + * Returns the ordered list of {@link ResponseNode} elements contained in this body. + * + * @return an immutable list of nodes + */ public List nodes() { return nodes; } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java index e8a8329..f6491b0 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseBodyBuilder.java @@ -4,14 +4,35 @@ import java.util.ArrayList; import java.util.List; import java.util.function.Consumer; +/** + * Builder for {@link ResponseBody} instances. + * + *

Provides methods to append parameter nodes and nested blocks and to produce an immutable + * {@link ResponseBody} via {@link #build()}. + */ public class ResponseBodyBuilder { private final List nodes = new ArrayList<>(); + /** + * Add a key/value parameter to the response body under construction. + * + * @param key the parameter name + * @param value the parameter value (will be converted to string when encoded) + * @return this builder for fluent chaining + */ public ResponseBodyBuilder param(String key, Object value) { nodes.add(new ResponseParameter(key, value)); return this; } + /** + * Add a nested block with the given tag. The provided consumer receives a child builder to + * populate the block content. + * + * @param tag the block tag + * @param content consumer that appends child nodes to the block + * @return this builder for fluent chaining + */ public ResponseBodyBuilder block(String tag, Consumer content) { ResponseBodyBuilder childBuilder = new ResponseBodyBuilder(); content.accept(childBuilder); @@ -19,6 +40,11 @@ public class ResponseBodyBuilder { return this; } + /** + * Build an immutable {@link ResponseBody} from the accumulated nodes. + * + * @return a new {@link ResponseBody} + */ public ResponseBody build() { return new ResponseBody(nodes); } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java index 184cd78..57b9181 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseDispatcher.java @@ -3,13 +3,31 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.Session; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionManager; +/** + * Helper that dispatches {@link Response} instances to the corresponding {@link Session} by + * encoding them and enqueuing the resulting {@link PrimitiveResponse} into the session's response + * queue. + */ public class ResponseDispatcher { private final SessionManager sessionManager; + /** + * Create a dispatcher bound to a {@link SessionManager}. + * + * @param sessionManager manager used to resolve sessions + */ public ResponseDispatcher(SessionManager sessionManager) { this.sessionManager = sessionManager; } + /** + * Encode the given {@link Response} and enqueue the resulting {@link PrimitiveResponse} into + * the target session's response queue. + * + * @param response the response to dispatch + * @throws InterruptedException if the thread is interrupted while waiting to enqueue the + * primitive response + */ public void dispatch(Response response) throws InterruptedException { PrimitiveResponse primitiveResponse = ResponseEncoder.encode(response); Session session = sessionManager.getSessionById(response.getSessionId()); diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java index bc66aad..dbe8d12 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseEncoder.java @@ -1,9 +1,20 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; +/** + * Utility responsible for encoding a {@link Response} into a protocol payload string and wrapping + * it into a {@link PrimitiveResponse} suitable for transmission. + */ public class ResponseEncoder { private static final String INDENT = "\t"; private static final String NEWLINE = "\n"; + /** + * Encode a {@link Response} into a {@link PrimitiveResponse} containing the serialized payload + * string. + * + * @param response the response to encode + * @return a {@link PrimitiveResponse} with encoded payload + */ public static PrimitiveResponse encode(Response response) { StringBuilder sb = new StringBuilder(); sb.append(response.prefix()); @@ -19,6 +30,13 @@ public class ResponseEncoder { response.getSessionId(), response.getRequestId(), sb.toString()); } + /** + * Internal helper to encode any {@link ResponseNode}. + * + * @param node node to encode + * @param sb string builder to append to + * @param depth current indentation depth + */ private static void encodeNode(ResponseNode node, StringBuilder sb, int depth) { if (node instanceof ResponseParameter param) { encodeParameter(param, sb, depth); @@ -27,6 +45,13 @@ public class ResponseEncoder { } } + /** + * Encode a {@link ResponseParameter} into the string builder. + * + * @param param the parameter to encode + * @param sb the output builder + * @param depth indentation depth + */ private static void encodeParameter(ResponseParameter param, StringBuilder sb, int depth) { sb.append(INDENT.repeat(depth)); sb.append(param.key()); @@ -34,6 +59,14 @@ public class ResponseEncoder { sb.append(maskIfNeeded(param.value().toString())); } + /** + * Encode a {@link ResponseBlock}, including its children and terminating with an {@code END} + * marker. + * + * @param block the block to encode + * @param sb the output builder + * @param depth current indentation depth + */ private static void encodeBlock(ResponseBlock block, StringBuilder sb, int depth) { sb.append(INDENT.repeat(depth)); sb.append(block.tag()); @@ -48,6 +81,13 @@ public class ResponseEncoder { sb.append("END"); } + /** + * Quote or escape the provided value if it contains whitespace or single quotes so the encoded + * payload remains parseable. + * + * @param value the raw string value + * @return quoted/escaped value + */ private static String maskIfNeeded(String value) { if (value.contains(" ") || value.contains("'")) { String escaped = value.replace("'", "\\'"); diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java index ea22d0a..c3af815 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseNode.java @@ -1,3 +1,8 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; +/** + * Marker interface for elements that may appear in a {@link ResponseBody}. + * + *

Implementations include {@link ResponseParameter} and {@link ResponseBlock}. + */ public interface ResponseNode {} diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java index 4d04293..87f599a 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/ResponseParameter.java @@ -1,6 +1,22 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; +/** + * A parameter node stored in a {@link ResponseBody}. + * + *

Represents a simple key/value pair. Callers can use {@link #rawValue()} to obtain the string + * representation of the stored value. + * + * @param key the parameter name + * @param value the parameter value + */ public record ResponseParameter(String key, Object value) implements ResponseNode { + /** + * Returns the raw string representation of the stored value. This is a convenience wrapper + * around {@code Object#toString()} and may throw {@link NullPointerException} if the stored + * value is {@code null}. + * + * @return the value as string + */ public String rawValue() { return value.toString(); } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java index dae5308..e88913f 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/SuccessResponse.java @@ -2,11 +2,31 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.response; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; +/** + * Abstract {@link Response} specialization indicating a successful outcome. + * + *

Implementations of this class use the {@code +OK} prefix. It provides a protected constructor + * so subclasses can supply the response body content. + */ public abstract class SuccessResponse extends Response { + /** + * Create a successful response with the provided body. + * + * @param sessionId the session id this response targets + * @param requestId the originating request id + * @param body the response body + */ protected SuccessResponse(SessionId sessionId, int requestId, ResponseBody body) { super(sessionId, requestId, body); } + /** + * {@inheritDoc} + * + *

This implementation returns the fixed {@code +OK} prefix. + * + * @return the {@code +OK} prefix + */ @Override public final String prefix() { return "+OK"; From 9766fe52c5e429042a27d1979843af3a25ed6e03 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 14:34:59 +0100 Subject: [PATCH 11/41] Add: OkResponse class as default for successful response with no body --- .../server/network/response/OkResponse.java | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/OkResponse.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/OkResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/OkResponse.java new file mode 100644 index 0000000..a3f26c5 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/response/OkResponse.java @@ -0,0 +1,20 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.response; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + +/** + * A simple success response with an empty body. + * + *

Use this to acknowledge successful requests that do not carry additional payload data. + */ +public class OkResponse extends SuccessResponse { + /** + * Create a minimal successful response (no body content). + * + * @param sessionId the target session id + * @param requestId the originating request id + */ + public OkResponse(SessionId sessionId, int requestId) { + super(sessionId, requestId, ResponseBody.builder().build()); + } +} From 89753a74791409007e4a80da9e3ca3a8b5263fee Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 17:58:21 +0100 Subject: [PATCH 12/41] Add: RequestContext record --- .../cs108/casono/server/network/parser/RequestContext.java | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java new file mode 100644 index 0000000..685407f --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java @@ -0,0 +1,5 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + +public record RequestContext(SessionId sessionId, int requestId) {} From db22f12ed581e5eae3294f08eb7883407e4eff2a Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:00:09 +0100 Subject: [PATCH 13/41] Add: RequestContext field to abstract Request class BREAKING CHANGE: Request is now an abstract class instead of an interface --- .../casono/server/network/parser/Request.java | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/Request.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/Request.java index 4018a31..8b3d70f 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/Request.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/Request.java @@ -1,4 +1,24 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; +import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; + /** Request, produced by the CommandParser */ -public interface Request {} +public abstract class Request { + protected final RequestContext context; + + public Request(RequestContext context) { + this.context = context; + } + + public RequestContext getContext() { + return context; + } + + public SessionId getSessionId() { + return context.sessionId(); + } + + public int getRequestId() { + return context.requestId(); + } +} From f4476ae1e8aec2b6fc6bd22e852760a270a3a035 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:03:26 +0100 Subject: [PATCH 14/41] Add: RawRequest record to contain command and parameters --- .../dbis/cs108/casono/server/network/parser/RawRequest.java | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RawRequest.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RawRequest.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RawRequest.java new file mode 100644 index 0000000..fbbc0e5 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RawRequest.java @@ -0,0 +1,5 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; + +import java.util.List; + +public record RawRequest(String command, List parameters) {} From 34ad8030733a61737b3b21d4eaafb7a677d2aa8a Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:07:20 +0100 Subject: [PATCH 15/41] Refactor: ProtocolParser to accept payload string and return RawRequest Prior it took the RawPacket as an argument and returned an PrimitiveRequest --- .../cs108/casono/server/network/parser/ProtocolParser.java | 7 +++---- .../casono/server/network/sessions/SessionReader.java | 6 +++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/ProtocolParser.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/ProtocolParser.java index acb48a0..8f8b4d4 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/ProtocolParser.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/ProtocolParser.java @@ -1,6 +1,5 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; -import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.RawPacket; import ch.unibas.dmi.dbis.cs108.casono.server.tokenizer.RawToken; import ch.unibas.dmi.dbis.cs108.casono.server.tokenizer.Token; import ch.unibas.dmi.dbis.cs108.casono.server.tokenizer.TokenClassifier; @@ -19,15 +18,15 @@ public class ProtocolParser { * @param packet the RawPacket containing the recieved data * @return created PrimitiveRequest */ - public static PrimitiveRequest parse(RawPacket packet) { - List rawTokens = Tokenizer.tokenize(packet.payload()); + public static RawRequest parse(String payload) { + List rawTokens = Tokenizer.tokenize(payload); List tokens = TokenClassifier.classify(rawTokens); Iterator iterator = tokens.iterator(); String command = readCommand(iterator); List parameters = readParameters(iterator); - return new PrimitiveRequest(packet.requestId(), command, parameters); + return new RawRequest(command, parameters); } /** diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java index 7c2a6c7..c9aa4aa 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java @@ -2,9 +2,9 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; -import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.PrimitiveRequest; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParser; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParserException; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.RawRequest; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.RawPacket; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; import ch.unibas.dmi.dbis.cs108.casono.server.tokenizer.TokenizerException; @@ -36,8 +36,8 @@ public class SessionReader implements Runnable { rawPacket = transport.read(); logger.debug("Recieved: {}", rawPacket); - PrimitiveRequest primitiveRequest = ProtocolParser.parse(rawPacket); - logger.debug("Parsed request to {}", primitiveRequest); + RawRequest rawRequest = ProtocolParser.parse(rawPacket.payload()); + logger.debug("Parsed request to {}", rawRequest); } catch (EOFException e) { logger.info("Client disconnected"); eventBus.publish(new DisconnectEvent(session.getId())); From cdd5de620bd8fd1500bc39562041f25ffc5009a5 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:10:15 +0100 Subject: [PATCH 16/41] Add: Create PrimitiveRequest from RawRequest with RequestContext --- .../casono/server/network/sessions/SessionReader.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java index c9aa4aa..0abe830 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java @@ -2,9 +2,11 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.PrimitiveRequest; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParser; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParserException; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.RawRequest; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.RequestContext; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.RawPacket; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; import ch.unibas.dmi.dbis.cs108.casono.server.tokenizer.TokenizerException; @@ -38,6 +40,12 @@ public class SessionReader implements Runnable { RawRequest rawRequest = ProtocolParser.parse(rawPacket.payload()); logger.debug("Parsed request to {}", rawRequest); + + RequestContext requestContext = + new RequestContext(session.getId(), rawPacket.requestId()); + PrimitiveRequest primitiveRequest = + new PrimitiveRequest( + requestContext, rawRequest.command(), rawRequest.parameters()); } catch (EOFException e) { logger.info("Client disconnected"); eventBus.publish(new DisconnectEvent(session.getId())); From edc1b29884bca41bdf2250c3d28914180481dcaf Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:11:37 +0100 Subject: [PATCH 17/41] Add: PrimitiveRequest takes now RequestContext instead of requestId --- .../cs108/casono/server/network/parser/PrimitiveRequest.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/PrimitiveRequest.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/PrimitiveRequest.java index 4ac06de..4135e47 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/PrimitiveRequest.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/PrimitiveRequest.java @@ -3,4 +3,5 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; import java.util.List; /** Created by the ProtocolParser to allow easy access to the request contents */ -public record PrimitiveRequest(int requestId, String command, List parameters) {} +public record PrimitiveRequest( + RequestContext context, String command, List parameters) {} From d1510ddf8ea2d4288a4d0fbe6d2e437f8633886c Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Tue, 24 Mar 2026 18:12:02 +0100 Subject: [PATCH 18/41] Docs: Write JavaDoc for RequestContext --- .../casono/server/network/parser/RequestContext.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java index 685407f..6881885 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/parser/RequestContext.java @@ -2,4 +2,13 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.parser; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionId; +/** + * Immutable context for a network request. + * + *

Contains the originating session's identifier and the request's id. Later used to create + * response. + * + * @param sessionId the identifier of the session that initiated the request + * @param requestId the request's numeric id within the session + */ public record RequestContext(SessionId sessionId, int requestId) {} From b0d7dc8b3047d9efb5abdc6f8a73f46f71f3e287 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Wed, 25 Mar 2026 13:47:54 +0100 Subject: [PATCH 19/41] Add: CommandParserDispatcher as field to SessionManager --- .../cs108/casono/server/network/sessions/SessionManager.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java index 2ff6e38..c582a67 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java @@ -2,6 +2,7 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; import java.io.IOException; import java.util.Map; @@ -14,12 +15,14 @@ public class SessionManager { private Map sessions; private final EventBus eventBus; private final Logger logger; + private final CommandParserDispatcher dispatcher; /** Constructs a new SessionManager. */ - public SessionManager(EventBus eventBus) { + public SessionManager(EventBus eventBus, CommandParserDispatcher dispatcher) { this.sessions = new ConcurrentHashMap<>(); this.eventBus = eventBus; this.logger = LogManager.getLogger(SessionManager.class); + this.dispatcher = dispatcher; } /** From 6f1b6361bc1ff7fece103573e33cdd3d969e97ee Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Wed, 25 Mar 2026 13:48:30 +0100 Subject: [PATCH 20/41] Add: Create CommandParserDispatcher on startup and pass to SessionManager --- .../ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java index 126b341..9327139 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java @@ -5,6 +5,7 @@ import ch.unibas.dmi.dbis.cs108.casono.server.domain.user.UserRegistry; import ch.unibas.dmi.dbis.cs108.casono.server.network.NetworkManager; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; import ch.unibas.dmi.dbis.cs108.casono.server.network.sessions.SessionManager; import java.time.Duration; import java.util.concurrent.Executors; @@ -26,7 +27,8 @@ public class ServerApp { logger.info("Starting server at port {}", port); EventBus eventBus = new EventBus(); - SessionManager sessionManager = new SessionManager(eventBus); + CommandParserDispatcher dispatcher = new CommandParserDispatcher(); + SessionManager sessionManager = new SessionManager(eventBus, dispatcher); eventBus.subscribe(DisconnectEvent.class, event -> sessionManager.onDisconnect(event)); NetworkManager networkManager = new NetworkManager(port, sessionManager); From 92e4fcb2697fcf8fa9564cf19f8a87db8a7c8968 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Wed, 25 Mar 2026 13:50:35 +0100 Subject: [PATCH 21/41] Add: CommandParserDispatcher field to Session and SessionReader --- .../casono/server/network/sessions/Session.java | 15 ++++++++++++++- .../server/network/sessions/SessionReader.java | 6 ++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java index 0a9be66..6959ed7 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java @@ -1,6 +1,7 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; import ch.unibas.dmi.dbis.cs108.casono.server.network.response.PrimitiveResponse; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; import java.io.IOException; @@ -12,6 +13,7 @@ public class Session { private final SessionId id; private final TransportLayer transport; private final BlockingQueue responseQueue; + private final CommandParserDispatcher dispatcher; private static final int RESPOND_QUEUE_SIZE = 32; /** @@ -21,9 +23,11 @@ public class Session { * @param eventBus the event bus for publishing events * @throws IOException if an I/O error occurs during initialization */ - public Session(TransportLayer transport, EventBus eventBus) { + public Session( + TransportLayer transport, EventBus eventBus, CommandParserDispatcher dispatcher) { this.id = new SessionId(); this.transport = transport; + this.dispatcher = dispatcher; this.responseQueue = new ArrayBlockingQueue<>(RESPOND_QUEUE_SIZE); } @@ -53,4 +57,13 @@ public class Session { public BlockingQueue getResponseQueue() { return responseQueue; } + + /** + * Returns the CommandParserDispatcher of this session + * + * @return the dispatcher to dispatch PrimitiveRequests to for parsing + */ + public CommandParserDispatcher getDispatcher() { + return dispatcher; + } } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java index 0abe830..0b21190 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java @@ -2,10 +2,12 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.PrimitiveRequest; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParser; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.ProtocolParserException; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.RawRequest; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.RequestContext; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.RawPacket; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; @@ -19,12 +21,14 @@ public class SessionReader implements Runnable { private final Session session; private final TransportLayer transport; private final EventBus eventBus; + private final CommandParserDispatcher dispatcher; private final Logger logger; public SessionReader(Session session, EventBus eventBus) { this.session = session; this.transport = session.getTransport(); this.eventBus = eventBus; + this.dispatcher = session.getDispatcher(); this.logger = LogManager.getLogger( SessionReader.class.toString() + "-" + session.getId().value()); @@ -46,6 +50,8 @@ public class SessionReader implements Runnable { PrimitiveRequest primitiveRequest = new PrimitiveRequest( requestContext, rawRequest.command(), rawRequest.parameters()); + + Request request = dispatcher.parse(primitiveRequest); } catch (EOFException e) { logger.info("Client disconnected"); eventBus.publish(new DisconnectEvent(session.getId())); From 4430ddb0f33c2d6766c2fe8f2de5169e6c5978c2 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Wed, 25 Mar 2026 13:50:54 +0100 Subject: [PATCH 22/41] Add: Pass CommandParserDispatcher instance to session upon creation --- .../cs108/casono/server/network/sessions/SessionManager.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java index c582a67..bbf1a14 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java @@ -34,7 +34,7 @@ public class SessionManager { * @return newly created session */ public Session create(TransportLayer transport) { - Session session = new Session(transport, eventBus); + Session session = new Session(transport, eventBus, dispatcher); SessionReader reader = new SessionReader(session, eventBus); SessionWriter writer = new SessionWriter(session); From 085f97b37eb957636fe97ea80f708921a539d16a Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 12:48:16 +0100 Subject: [PATCH 23/41] Rework: Bug report issue templates --- .gitlab/issue_templates/Bug Report.md | 40 ++++++++++++++++++++ .gitlab/issue_templates/bug_report_client.md | 31 --------------- .gitlab/issue_templates/bug_report_server.md | 30 --------------- 3 files changed, 40 insertions(+), 61 deletions(-) create mode 100644 .gitlab/issue_templates/Bug Report.md delete mode 100644 .gitlab/issue_templates/bug_report_client.md delete mode 100644 .gitlab/issue_templates/bug_report_server.md diff --git a/.gitlab/issue_templates/Bug Report.md b/.gitlab/issue_templates/Bug Report.md new file mode 100644 index 0000000..4fcd233 --- /dev/null +++ b/.gitlab/issue_templates/Bug Report.md @@ -0,0 +1,40 @@ +## Bug Report + + +### Environment +- **Branch & Commit:** +- **Operating system:** +- **How was execution started (Gradle task / IDE debug / IDE run):** +- **Java version:** `25` +- **Gradle version**: `9.3.1` + +### Summary + + +### Expected Behavior + + +### Actual Behavior + + +### Steps to Reproduce + + +### Stack Trace / Error Message +``` + +``` + +### Possible Cause / Notes + + +### Checklist +- [ ] I reproduced the problem using the steps above +- [ ] I searched documentation docs for relevant information +- [ ] I added relevant labels + +/label ~bug diff --git a/.gitlab/issue_templates/bug_report_client.md b/.gitlab/issue_templates/bug_report_client.md deleted file mode 100644 index d1b4373..0000000 --- a/.gitlab/issue_templates/bug_report_client.md +++ /dev/null @@ -1,31 +0,0 @@ -## Bug Report - -### Summary - - -### Affected Component - - -### Steps to Reproduce -1. Do this first -2. Then do that next -3. Lastly, see the unexprected error message ... - -### Expected Behavior - - -### Actual Behavior - - -### Stack Trace / Error Message -``` - -``` - -### Possible Cause - - - -/label ~bug - -/label ~client diff --git a/.gitlab/issue_templates/bug_report_server.md b/.gitlab/issue_templates/bug_report_server.md deleted file mode 100644 index 46d7572..0000000 --- a/.gitlab/issue_templates/bug_report_server.md +++ /dev/null @@ -1,30 +0,0 @@ -## Bug Report - -### Summary - - -### Affected Component - - -### Steps to Reproduce -1. Do this first -2. Then do that next -3. Lastly, see the unexprected error message ... - -### Expected Behavior - - -### Actual Behavior - - -### Stack Trace / Error Message -``` - -``` - -### Possible Cause - - -/label ~bug - -/label ~server From c19e3f322957dab8d8317db79565c71d1e410777 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 12:52:59 +0100 Subject: [PATCH 24/41] Rework: Feature request issue templates --- .gitlab/issue_templates/Feature Request.md | 18 +++++++++++++ .../issue_templates/feature_request_client.md | 27 ------------------- .../issue_templates/feature_request_server.md | 27 ------------------- 3 files changed, 18 insertions(+), 54 deletions(-) create mode 100644 .gitlab/issue_templates/Feature Request.md delete mode 100644 .gitlab/issue_templates/feature_request_client.md delete mode 100644 .gitlab/issue_templates/feature_request_server.md diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md new file mode 100644 index 0000000..5a11cf5 --- /dev/null +++ b/.gitlab/issue_templates/Feature Request.md @@ -0,0 +1,18 @@ +## Feature Request + + +### Summary + + +### Required workarround + + +### Description + + +### Checklist +- [ ] I reproduced the problem using the steps above +- [ ] I searched documentation docs for relevant information +- [ ] I added relevant labels + +/label ~enhancement diff --git a/.gitlab/issue_templates/feature_request_client.md b/.gitlab/issue_templates/feature_request_client.md deleted file mode 100644 index c654230..0000000 --- a/.gitlab/issue_templates/feature_request_client.md +++ /dev/null @@ -1,27 +0,0 @@ -## Feature Request - -### Summary - - -### Motivation / Problem - - -### Description - - -### Affected Components - - - -### Acceptance Criteria - -- [ ] -- [ ] -- [ ] - -### Open Questions / Trade-offs - - -/label ~enhancement - -/label ~client diff --git a/.gitlab/issue_templates/feature_request_server.md b/.gitlab/issue_templates/feature_request_server.md deleted file mode 100644 index 38d3377..0000000 --- a/.gitlab/issue_templates/feature_request_server.md +++ /dev/null @@ -1,27 +0,0 @@ -## Feature Request - -### Summary - - -### Motivation / Problem - - -### Description - - -### Affected Components - - - -### Acceptance Criteria - -- [ ] -- [ ] -- [ ] - -### Open Questions / Trade-offs - - -/label ~enhancement - -/label ~server From a772f2ce0174aa4fad8aefdea995ffc0937b86ab Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 12:53:52 +0100 Subject: [PATCH 25/41] Remove: Protocol change issue template as it is now incorporated into the others --- .gitlab/issue_templates/protocol_change.md | 37 ---------------------- 1 file changed, 37 deletions(-) delete mode 100644 .gitlab/issue_templates/protocol_change.md diff --git a/.gitlab/issue_templates/protocol_change.md b/.gitlab/issue_templates/protocol_change.md deleted file mode 100644 index 6c5d5b2..0000000 --- a/.gitlab/issue_templates/protocol_change.md +++ /dev/null @@ -1,37 +0,0 @@ -## Protocol / API Change - -### Summary - - -### Affected Commands / Responses - - -| Command | Response | Type of Change | Description | -|---------|----------|----------------|-------------| -| | | New / Changed / Removed | | - -### New / Changed Syntax -``` - - -``` - -### Affected Implementation Layers - -- [ ] `Session` -- [ ] `User` or `UserRegistry` -- [ ] `Tokenizer` / `RequestTokenClassifier` -- [ ] `ProtocolParser` -- [ ] `CommandParserDispatcher` + corresponding `CommandParser` -- [ ] `CommandHandler` -- [ ] `Response` hierarchy -- [ ] `GameEngine` or `GameState` -- [ ] Client-side (create your own issue and create link) - -### Motivation - - -/label ~protocol From 72ef67c47d01a2c7c28f672081d4db349d555944 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 12:56:54 +0100 Subject: [PATCH 26/41] Rework: Task issue template --- .gitlab/issue_templates/Task.md | 25 +++++++++++++++++++++++++ .gitlab/issue_templates/task_client.md | 25 ------------------------- .gitlab/issue_templates/task_server.md | 25 ------------------------- 3 files changed, 25 insertions(+), 50 deletions(-) create mode 100644 .gitlab/issue_templates/Task.md delete mode 100644 .gitlab/issue_templates/task_client.md delete mode 100644 .gitlab/issue_templates/task_server.md diff --git a/.gitlab/issue_templates/Task.md b/.gitlab/issue_templates/Task.md new file mode 100644 index 0000000..9455ce6 --- /dev/null +++ b/.gitlab/issue_templates/Task.md @@ -0,0 +1,25 @@ +## Task + + +### Summary + + +### Context + + + +### Current Progress +- [ ] +- [ ] +- [ ] + +### Notes + + +### Checklist +- [ ] I reproduced the problem using the steps above +- [ ] I searched documentation docs for relevant information +- [ ] I added relevant labels +- [ ] I linked to other issues or branches that must be completed first + +/label ~task diff --git a/.gitlab/issue_templates/task_client.md b/.gitlab/issue_templates/task_client.md deleted file mode 100644 index f75a1c4..0000000 --- a/.gitlab/issue_templates/task_client.md +++ /dev/null @@ -1,25 +0,0 @@ -## Task - -### Summary - - -### Context - - -### Affected Components - - -### Definition of Done -- [ ] -- [ ] -- [ ] - -### Notes - - -### Checklist -- [ ] Linked to other issues or branches that must be completed first? - -/label ~task - -/label ~client diff --git a/.gitlab/issue_templates/task_server.md b/.gitlab/issue_templates/task_server.md deleted file mode 100644 index e6206d1..0000000 --- a/.gitlab/issue_templates/task_server.md +++ /dev/null @@ -1,25 +0,0 @@ -## Task - -### Summary - - -### Context - - -### Affected Components - - -### Definition of Done -- [ ] -- [ ] -- [ ] - -### Notes - - -### Checklist -- [ ] Linked to other issues or branches that must be completed first? - -/label ~task - -/label ~server From 62489353550cc5e10d9c9d987c2dd7d6d3d41938 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 13:11:36 +0100 Subject: [PATCH 27/41] Add: Whitespaces after environment description of bug report issue template --- .gitlab/issue_templates/Bug Report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitlab/issue_templates/Bug Report.md b/.gitlab/issue_templates/Bug Report.md index 4fcd233..2f04712 100644 --- a/.gitlab/issue_templates/Bug Report.md +++ b/.gitlab/issue_templates/Bug Report.md @@ -2,9 +2,9 @@ ### Environment -- **Branch & Commit:** -- **Operating system:** -- **How was execution started (Gradle task / IDE debug / IDE run):** +- **Branch & Commit:** +- **Operating system:** +- **How was execution started (Gradle task / IDE debug / IDE run):** - **Java version:** `25` - **Gradle version**: `9.3.1` From 9da31ac4dce5a83a272c5535e40d6a4c0749882e Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 13:12:51 +0100 Subject: [PATCH 28/41] Remove: Unnecessary checklist item introduced by copy & pasting from bug report issue template --- .gitlab/issue_templates/Task.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitlab/issue_templates/Task.md b/.gitlab/issue_templates/Task.md index 9455ce6..27761d5 100644 --- a/.gitlab/issue_templates/Task.md +++ b/.gitlab/issue_templates/Task.md @@ -17,8 +17,7 @@ ### Checklist -- [ ] I reproduced the problem using the steps above -- [ ] I searched documentation docs for relevant information +- [ ] I outlined checkpoints describing phases of my work related to this task - [ ] I added relevant labels - [ ] I linked to other issues or branches that must be completed first From 68891815ee8260a242fce8d801ae3749b65ab253 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 14:15:42 +0100 Subject: [PATCH 29/41] Docs: Create CONTRIBUTING.md with guidelines and workflows --- CONTRIBUTING.md | 208 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 208 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..92a520a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,208 @@ +# Contribution Guidelines +This document describes the conventions and workflows everyone must follow to keep the codebase consistent and the collaboration smooth. +If you notice a violation, speak to the person involved respectfully. + +Since this project is part of a course at the University of Basel, the [Code of Conduct](https://www.unibas.ch/de/Universitaet/Administration-Services/Vizerektorat-People-And-Culture/Persoenliche-Integritaet/Code-of-Conduct.html) applies. + + +## Table of Contents +- [Contribution Guidelines](#contribution-guidelines) + - [Table of Contents](#table-of-contents) + - [Issues \& Tasks](#issues--tasks) + - [Creating an issue](#creating-an-issue) + - [During implementation](#during-implementation) + - [Collaborative work](#collaborative-work) + - [Git Workflow](#git-workflow) + - [Creating a branch](#creating-a-branch) + - [Working on a branch](#working-on-a-branch) + - [Commit Messages](#commit-messages) + - [Rules](#rules) + - [Examples](#examples) + - [Code Style](#code-style) + - [Linter](#linter) + - [Formatter](#formatter) + - [General guidelines](#general-guidelines) + - [CI/CD Pipeline](#cicd-pipeline) + - [Before pushing](#before-pushing) + - [Merge Requests](#merge-requests) + - [Opening a MR](#opening-a-mr) + - [Merging](#merging) + - [After merging](#after-merging) + - [Be human](#be-human) + + +## Issues & Tasks +Every piece of work - whether a new feature, a bug fix, or a refactoring - must be tracked as an +Issue or Task in GitLab **before** any implementation begins. + +### Creating an issue +1. Open a new Issue or Task using the **relevant template** provided in the repository. +2. Fill in **all fields** specified by the template thoughtfully and completely. A well-written issue is the single source of truth for the work being done - treat it accordingly. +3. Work through the **checklist** in the template before marking the issue as ready. Do not skip items. + +### During implementation +- If you encounter a problem or an unexpected finding while working on an issue, record it as a **comment** on the issue. This keeps the history intact and visible to the whole team. +- **Do not restructurally edit the original description** to incorporate new information. The description reflects the intent at the time the issue was created; comments document what happened along the way. + +### Collaborative work +- When multiple people are working on the same issue, **prefer issue comments over private messages** for coordination. This keeps the current status, decisions, and open questions + centrally visible and searchable. +- Before starting work that overlaps with an existing issue, check its comment thread first to avoid duplicating effort. + + +## Git Workflow +We use a **feature branch -> main** strategy. The `main` branch is always in a releasable state. + +### Creating a branch +We follow the [**Conventional Branch**](https://conventional-branch.github.io/) specification. Branch names follow this pattern: + +``` +/ +``` + +| Type | When to use | +|------------|--------------------------------------------------| +| `feat` | New feature or capability | +| `fix` | Bug fix | +| `refactor` | Restructuring without behaviour change | +| `test` | Adding or fixing tests | +| `ci` | Pipeline, Gradle, or tooling changes | +| `docs` | Documentation only | + +**Examples:** + +``` +feat/reconnect-command +fix/session-writer-flush +refactor/user-registry-cleanup +docs/contributing +``` + +### Working on a branch +Keep branches short-lived. A branch should represent one cohesive unit of work. + +It is permissible to commit changes within a feature branch that cause the program to become non-functional, but these should be fixed as soon as possible. In any case, the code that is merged into `main` must be functional. + +And most importantly: **Do not commit directly to `main`**. + + +## Commit Messages +We follow the [**Conventional Commits**](https://www.conventionalcommits.org/) specification. Every commit message must have the form: + +``` +: + +[optional body] +``` + +### Rules +The summary line must be **<= 72 characters**, written in the **imperative mood** (e.g. "add", not "added" or "adds"). + +### Examples +``` +Reat: Add RECONNECT command handler + +The handler re-associates an existing User with a new Session after +a connection drop, preserving in-flight state. +``` + +``` +Fix: Flush output stream before closing +``` + +``` +Ci: Tighten Checkstyle failure policy to allow_failure: false +``` + +``` +Refactor: Replace ArrayList with CopyOnWriteArrayList +``` + + +## Code Style +Code formatting is enforced automatically. **Do not submit a MR with formatting violations.** + +### Linter +We use **Checkstyle** as our linter with a custom set of rules tailored to our project. + +Checkstyle runs on every pipeline. Fix all violations locally before pushing: + +```bash +./gradlew checkstyleMain checkstyleTest +``` + + +### Formatter +We use **Spotless** with the **[Google](https://google.github.io/styleguide/javaguide.html) / [AOSP Java style](https://source.android.com/docs/core/architecture/hidl/code-style?hl=en)**: + +- **Indentation:** 4 spaces (no tabs) +- **Line length:** 100 characters +- No decorative blank lines directly after opening braces `{` +- Blank lines are reserved for separating logical sections within a block + +Run the formatter before committing: + +```bash +./gradlew spotlessApply +``` + +Check without applying: + +```bash +./gradlew spotlessCheck +``` + +### General guidelines +- Add **JavaDoc** docstrings to classes, interfaces, records and methods. +- Exercise **clean architecture** +- Prefer **stateless components** +- Use **`record` types** for immutable data carriers. +- Log with **Log4J 2** (`log4j-api`). Use the appropriate level (`DEBUG` for pipeline internals, `INFO` for lifecycle events, `WARN`/`ERROR` for recoverable/unrecoverable problems). + + +## CI/CD Pipeline +The pipeline runs automatically on every push. It has four stages: + +``` +lint > report > build > test +``` + +| Stage | Jobs | +|----------|--------------------------------------------| +| `lint` | Spotless check, Checkstyle | +| `report` | Code Quality JSON conversion (only for mr) | +| `build` | `./gradlew assemble` | +| `test` | `./gradlew test` + JUnit result reporting | + +### Before pushing +Run the full check suite locally to avoid a broken pipeline: + +```bash +./gradlew spotlessCheck checkstyleMain checkstyleTest build test +``` + +A red pipeline blocks merging. Fix failures before creating your merge request. + + +## Merge Requests + +### Opening a MR +- Target branch is always **`main`**. +- Fill in the MR description: what changed and why. Link the relevant issue (with 'Closing #x') if one exists. + +### Merging +A MR can be merged when **all main CI pipeline stages are green** (lint, build, test). + +No explicit peer approval is required, but leaving a note or question in the MR thread for non-trivial changes is encouraged. +If you spot a problem in someone else's open MR, comment - **do not push directly to their branch** and try to fix the issue yourself. + +### After merging +Delete the feature branch after the MR is merged. GitLab can do this automatically via the +"Delete source branch" checkbox in the MR. + + +## Be human +We are all human. +We all forget things or make mistakes sometimes. + +It’s important that we look out for one another and **work together as a team**. From 69a5a94028014847f7d135a7a4aa8f839f4005dc Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:09:33 +0100 Subject: [PATCH 30/41] Add: CommandHandler interface for executing requests --- .../casono/server/network/command/CommandHandler.java | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java new file mode 100644 index 0000000..9c07c56 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java @@ -0,0 +1,7 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.command; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; + +public interface CommandHandler { + void execute(Request request); +} From d9f6838e05e169a516c3157b23c5bacaa6f68f6c Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:20:25 +0100 Subject: [PATCH 31/41] Add: UnknownRequestException class to throw when encountering unknown request type --- .../network/command/UnknownRequestException.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java new file mode 100644 index 0000000..e7889b0 --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java @@ -0,0 +1,14 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.command; + +public class UnknownRequestException extends RuntimeException { + private final String requestName; + + public UnknownRequestException(String message, String requestName) { + this.requestName = requestName; + super(message); + } + + public String getRequestName() { + return requestName; + } +} From fd17b49ed9b7f47e8d2043e355a56805a8722365 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:51:32 +0100 Subject: [PATCH 32/41] Add: CommandRouter to route Request to matching CommandHandler --- .../server/network/command/CommandRouter.java | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java new file mode 100644 index 0000000..186c1fe --- /dev/null +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java @@ -0,0 +1,24 @@ +package ch.unibas.dmi.dbis.cs108.casono.server.network.command; + +import java.util.HashMap; +import java.util.Map; + +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; + +public class CommandRouter { + private final Map, CommandHandler> handlers = new HashMap<>(); + + public void register(Class request, CommandHandler handler) { + handlers.put(request, handler); + } + + public void execute(Request request) { + CommandHandler handler = handlers.get(request.getClass()); + + if (handler == null) { + String requestName = request.getClass().toString(); + throw new UnknownRequestException("Unable to execute request " + requestName + ". Type unknown", requestName); + } + handler.execute(request); + } +} From 20047405416fa34ad97995399adbf09a71d8efa1 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:53:19 +0100 Subject: [PATCH 33/41] Add: CommandHandler interface to be generic --- .../cs108/casono/server/network/command/CommandHandler.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java index 9c07c56..34228c7 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandHandler.java @@ -2,6 +2,6 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.command; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; -public interface CommandHandler { - void execute(Request request); +public interface CommandHandler { + void execute(T request); } From 52c347d233dcab7222f1b3a0bc3f883b9e9b7ff4 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:55:26 +0100 Subject: [PATCH 34/41] Add: Modify CommandRouter to use generic CommandHandler type --- .../casono/server/network/command/CommandRouter.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java index 186c1fe..282c6c9 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java @@ -6,14 +6,16 @@ import java.util.Map; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; public class CommandRouter { - private final Map, CommandHandler> handlers = new HashMap<>(); + private final Map, CommandHandler> handlers = new HashMap<>(); - public void register(Class request, CommandHandler handler) { + public void register(Class request, CommandHandler handler) { handlers.put(request, handler); } + // Safe, because during registration, it's ensured that the provided CommandHandler only receives requests it can handle. + @SuppressWarnings("unchecked") public void execute(Request request) { - CommandHandler handler = handlers.get(request.getClass()); + CommandHandler handler = (CommandHandler) handlers.get(request.getClass()); if (handler == null) { String requestName = request.getClass().toString(); From a520f69f3e9bd277e2a0884b84a7c355d712d39a Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:56:22 +0100 Subject: [PATCH 35/41] Fix: Ensure matching type at compile-time --- .../dbis/cs108/casono/server/network/command/CommandRouter.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java index 282c6c9..0dafc58 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java @@ -8,7 +8,7 @@ import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; public class CommandRouter { private final Map, CommandHandler> handlers = new HashMap<>(); - public void register(Class request, CommandHandler handler) { + public void register(Class request, CommandHandler handler) { handlers.put(request, handler); } From d25f533ee9b13ff86253307e7cbd17bb38270ec7 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:57:00 +0100 Subject: [PATCH 36/41] Add: Integrate CommandRouter into SessionManager for request routing --- .../casono/server/network/sessions/SessionManager.java | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java index bbf1a14..a33e7b0 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java @@ -1,5 +1,6 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; +import ch.unibas.dmi.dbis.cs108.casono.server.network.command.CommandRouter; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; @@ -16,13 +17,15 @@ public class SessionManager { private final EventBus eventBus; private final Logger logger; private final CommandParserDispatcher dispatcher; + private final CommandRouter router; /** Constructs a new SessionManager. */ - public SessionManager(EventBus eventBus, CommandParserDispatcher dispatcher) { + public SessionManager(EventBus eventBus, CommandParserDispatcher dispatcher, CommandRouter router) { this.sessions = new ConcurrentHashMap<>(); this.eventBus = eventBus; this.logger = LogManager.getLogger(SessionManager.class); this.dispatcher = dispatcher; + this.router = router; } /** @@ -34,7 +37,7 @@ public class SessionManager { * @return newly created session */ public Session create(TransportLayer transport) { - Session session = new Session(transport, eventBus, dispatcher); + Session session = new Session(transport, eventBus, dispatcher, router); SessionReader reader = new SessionReader(session, eventBus); SessionWriter writer = new SessionWriter(session); From 628e86a964a62b2ba9c280857603b3703c691206 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:58:25 +0100 Subject: [PATCH 37/41] Add: Pass CommandRouter to Session and SessionReader --- .../cs108/casono/server/network/sessions/Session.java | 9 ++++++++- .../casono/server/network/sessions/SessionReader.java | 6 ++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java index 6959ed7..0c5027b 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java @@ -1,5 +1,6 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; +import ch.unibas.dmi.dbis.cs108.casono.server.network.command.CommandRouter; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; import ch.unibas.dmi.dbis.cs108.casono.server.network.response.PrimitiveResponse; @@ -14,6 +15,7 @@ public class Session { private final TransportLayer transport; private final BlockingQueue responseQueue; private final CommandParserDispatcher dispatcher; + private final CommandRouter router; private static final int RESPOND_QUEUE_SIZE = 32; /** @@ -24,10 +26,11 @@ public class Session { * @throws IOException if an I/O error occurs during initialization */ public Session( - TransportLayer transport, EventBus eventBus, CommandParserDispatcher dispatcher) { + TransportLayer transport, EventBus eventBus, CommandParserDispatcher dispatcher, CommandRouter router) { this.id = new SessionId(); this.transport = transport; this.dispatcher = dispatcher; + this.router = router; this.responseQueue = new ArrayBlockingQueue<>(RESPOND_QUEUE_SIZE); } @@ -66,4 +69,8 @@ public class Session { public CommandParserDispatcher getDispatcher() { return dispatcher; } + + public CommandRouter getRouter() { + return router; + } } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java index 0b21190..8ba5c62 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java @@ -1,5 +1,6 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.sessions; +import ch.unibas.dmi.dbis.cs108.casono.server.network.command.CommandRouter; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; @@ -22,6 +23,7 @@ public class SessionReader implements Runnable { private final TransportLayer transport; private final EventBus eventBus; private final CommandParserDispatcher dispatcher; + private final CommandRouter router; private final Logger logger; public SessionReader(Session session, EventBus eventBus) { @@ -29,6 +31,7 @@ public class SessionReader implements Runnable { this.transport = session.getTransport(); this.eventBus = eventBus; this.dispatcher = session.getDispatcher(); + this.router = session.getRouter(); this.logger = LogManager.getLogger( SessionReader.class.toString() + "-" + session.getId().value()); @@ -50,8 +53,11 @@ public class SessionReader implements Runnable { PrimitiveRequest primitiveRequest = new PrimitiveRequest( requestContext, rawRequest.command(), rawRequest.parameters()); + logger.debug("Converted to {}", primitiveRequest); Request request = dispatcher.parse(primitiveRequest); + + router.execute(request); } catch (EOFException e) { logger.info("Client disconnected"); eventBus.publish(new DisconnectEvent(session.getId())); From 9a6ad9f1bb2b857c083c0cc015494e2daaf41d28 Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 17:59:41 +0100 Subject: [PATCH 38/41] Add: Create CommandRouter at server startup and pass to SessionManager --- .../ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java index 9327139..b9e6679 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java @@ -3,6 +3,8 @@ package ch.unibas.dmi.dbis.cs108.casono.server; import ch.unibas.dmi.dbis.cs108.casono.server.domain.user.UserCleanupJob; import ch.unibas.dmi.dbis.cs108.casono.server.domain.user.UserRegistry; import ch.unibas.dmi.dbis.cs108.casono.server.network.NetworkManager; +import ch.unibas.dmi.dbis.cs108.casono.server.network.command.CommandRouter; +import ch.unibas.dmi.dbis.cs108.casono.server.network.command.TestCommandHandler; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; @@ -28,7 +30,9 @@ public class ServerApp { EventBus eventBus = new EventBus(); CommandParserDispatcher dispatcher = new CommandParserDispatcher(); - SessionManager sessionManager = new SessionManager(eventBus, dispatcher); + CommandRouter router = new CommandRouter(); + + SessionManager sessionManager = new SessionManager(eventBus, dispatcher, router); eventBus.subscribe(DisconnectEvent.class, event -> sessionManager.onDisconnect(event)); NetworkManager networkManager = new NetworkManager(port, sessionManager); From a9ffb4daeb19dc2f1f60bca63c1b8e27a7759a5a Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 18:01:57 +0100 Subject: [PATCH 39/41] Style: Apply formatting by Spotless --- .../dmi/dbis/cs108/casono/server/ServerApp.java | 1 - .../casono/server/network/command/CommandRouter.java | 12 +++++++----- .../casono/server/network/sessions/Session.java | 5 ++++- .../server/network/sessions/SessionManager.java | 3 ++- .../server/network/sessions/SessionReader.java | 2 +- 5 files changed, 14 insertions(+), 9 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java index b9e6679..2391450 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/ServerApp.java @@ -4,7 +4,6 @@ import ch.unibas.dmi.dbis.cs108.casono.server.domain.user.UserCleanupJob; import ch.unibas.dmi.dbis.cs108.casono.server.domain.user.UserRegistry; import ch.unibas.dmi.dbis.cs108.casono.server.network.NetworkManager; import ch.unibas.dmi.dbis.cs108.casono.server.network.command.CommandRouter; -import ch.unibas.dmi.dbis.cs108.casono.server.network.command.TestCommandHandler; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.DisconnectEvent; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.CommandParserDispatcher; diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java index 0dafc58..0badeff 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/CommandRouter.java @@ -1,10 +1,9 @@ package ch.unibas.dmi.dbis.cs108.casono.server.network.command; +import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; import java.util.HashMap; import java.util.Map; -import ch.unibas.dmi.dbis.cs108.casono.server.network.parser.Request; - public class CommandRouter { private final Map, CommandHandler> handlers = new HashMap<>(); @@ -12,14 +11,17 @@ public class CommandRouter { handlers.put(request, handler); } - // Safe, because during registration, it's ensured that the provided CommandHandler only receives requests it can handle. + // Safe, because during registration, it's ensured that the provided CommandHandler only + // receives requests it can handle. @SuppressWarnings("unchecked") public void execute(Request request) { - CommandHandler handler = (CommandHandler) handlers.get(request.getClass()); + CommandHandler handler = + (CommandHandler) handlers.get(request.getClass()); if (handler == null) { String requestName = request.getClass().toString(); - throw new UnknownRequestException("Unable to execute request " + requestName + ". Type unknown", requestName); + throw new UnknownRequestException( + "Unable to execute request " + requestName + ". Type unknown", requestName); } handler.execute(request); } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java index 0c5027b..d6e2094 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/Session.java @@ -26,7 +26,10 @@ public class Session { * @throws IOException if an I/O error occurs during initialization */ public Session( - TransportLayer transport, EventBus eventBus, CommandParserDispatcher dispatcher, CommandRouter router) { + TransportLayer transport, + EventBus eventBus, + CommandParserDispatcher dispatcher, + CommandRouter router) { this.id = new SessionId(); this.transport = transport; this.dispatcher = dispatcher; diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java index a33e7b0..65a97a3 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java @@ -20,7 +20,8 @@ public class SessionManager { private final CommandRouter router; /** Constructs a new SessionManager. */ - public SessionManager(EventBus eventBus, CommandParserDispatcher dispatcher, CommandRouter router) { + public SessionManager( + EventBus eventBus, CommandParserDispatcher dispatcher, CommandRouter router) { this.sessions = new ConcurrentHashMap<>(); this.eventBus = eventBus; this.logger = LogManager.getLogger(SessionManager.class); diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java index 8ba5c62..cd74de9 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionReader.java @@ -56,7 +56,7 @@ public class SessionReader implements Runnable { logger.debug("Converted to {}", primitiveRequest); Request request = dispatcher.parse(primitiveRequest); - + router.execute(request); } catch (EOFException e) { logger.info("Client disconnected"); From 8ed1bab0671e3101025d46d4d10153ca770c1aee Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 18:09:07 +0100 Subject: [PATCH 40/41] Style: Put call to superclass constructor before variable assignment in UnknownRequestException constructor --- .../casono/server/network/command/UnknownRequestException.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java index e7889b0..60c7fa3 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/command/UnknownRequestException.java @@ -4,8 +4,8 @@ public class UnknownRequestException extends RuntimeException { private final String requestName; public UnknownRequestException(String message, String requestName) { - this.requestName = requestName; super(message); + this.requestName = requestName; } public String getRequestName() { From 58d06fad39f68de12c6034ac1c7b8388ef52219c Mon Sep 17 00:00:00 2001 From: Lars Simon Winzer Date: Thu, 26 Mar 2026 18:10:32 +0100 Subject: [PATCH 41/41] Style: Line length in SessionManager --- .../server/network/sessions/SessionManager.java | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java index 65a97a3..b3d52a6 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/network/sessions/SessionManager.java @@ -42,12 +42,14 @@ public class SessionManager { SessionReader reader = new SessionReader(session, eventBus); SessionWriter writer = new SessionWriter(session); - Thread readerThread = Thread.ofVirtual() - .name("session-" + session.getId().value() + "-reader") - .unstarted(reader); - Thread writerThread = Thread.ofVirtual() - .name("session-" + session.getId().value() + "-writer") - .unstarted(writer); + Thread readerThread = + Thread.ofVirtual() + .name("session-" + session.getId().value() + "-reader") + .unstarted(reader); + Thread writerThread = + Thread.ofVirtual() + .name("session-" + session.getId().value() + "-writer") + .unstarted(writer); sessions.put(session.getId(), new SessionHandle(session, readerThread, writerThread)); readerThread.start();