Refactoring and testing added for Websocket solution.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

README.md

@@ -14,6 +14,18 @@ SPDX-License-Identifier: Apache-2.0
 
 Service to validate SCL Files.
 
+## Rest and Websockets versions
+
+The validation can be done using both Rest and Websockets as transportation technic.
+
+| Method    | URL                                                                   |
+|-----------|-----------------------------------------------------------------------|
+| Rest      | http(s)://**server-address**/compas-scl-validator/validate/v1/{type}  |
+| Websocket | ws(s)://**server-address**/compas-scl-validator/validate-ws/v1/{type} |
+
+In CoMPAS OpenSCD there is a switch in the setting to indicate if websockets needs to be used. The logic will
+automatically determine the URL to be used.
+
 ## Development
 
 For the RiseClipse implementation of the validator parts of the RiseClipse project are being used. Currently, these

app/pom.xml

@@ -65,6 +65,10 @@ SPDX-License-Identifier: Apache-2.0
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-resteasy-jaxb</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-mutiny</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-vertx</artifactId>

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/SclValidatorResource.java

@@ -4,10 +4,13 @@
 package org.lfenergy.compas.scl.validator.rest.v1;
 
 import io.quarkus.security.Authenticated;
+import io.smallrye.mutiny.Uni;
+import io.vertx.mutiny.core.eventbus.EventBus;
+import io.vertx.mutiny.core.eventbus.Message;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
+import org.lfenergy.compas.scl.validator.rest.v1.event.SclValidatorEventRequest;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateRequest;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateResponse;
-import org.lfenergy.compas.scl.validator.service.SclValidatorService;
 
 import javax.enterprise.context.RequestScoped;
 import javax.inject.Inject;
@@ -21,20 +24,21 @@
 @RequestScoped
 @Path("/validate/v1/{" + TYPE_PATH_PARAM + "}")
 public class SclValidatorResource {
-    private final SclValidatorService sclValidatorService;
+    private final EventBus eventBus;
 
     @Inject
-    public SclValidatorResource(SclValidatorService compasCimMappingService) {
-        this.sclValidatorService = compasCimMappingService;
+    public SclValidatorResource(EventBus eventBus) {
+        this.eventBus = eventBus;
     }
 
     @POST
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
-    public SclValidateResponse validateSCL(@PathParam(TYPE_PATH_PARAM) SclFileType type,
-                                           @Valid SclValidateRequest request) {
-        var response = new SclValidateResponse();
-        response.setValidationErrorList(sclValidatorService.validate(type, request.getSclData()));
-        return response;
+    public Uni<SclValidateResponse> validateSCL(@PathParam(TYPE_PATH_PARAM) SclFileType type,
+                                                @Valid SclValidateRequest request) {
+        return eventBus.<SclValidateResponse>request(
+                        "validate-rest",
+                        new SclValidatorEventRequest(type, request.getSclData()))
+                .onItem().transform(Message::body);
     }
 }

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/AsyncWebsocketResource.java renamed to app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/SclValidatorServerEndpoint.java

@@ -6,17 +6,18 @@
 import io.quarkus.security.Authenticated;
 import io.vertx.mutiny.core.eventbus.EventBus;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
-import org.lfenergy.compas.scl.validator.rest.v1.event.AsyncWebsocketEventRequest;
+import org.lfenergy.compas.scl.validator.rest.v1.event.SclValidatorEventRequest;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateRequest;
-import org.lfenergy.compas.scl.validator.rest.v1.websocket.AsyncWebsocketRequestDecoder;
-import org.lfenergy.compas.scl.validator.rest.v1.websocket.AsyncWebsocketResponseEncoder;
+import org.lfenergy.compas.scl.validator.rest.v1.websocket.SclValidateRequestDecoder;
+import org.lfenergy.compas.scl.validator.rest.v1.websocket.SclValidateResponseEncoder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 import javax.websocket.OnError;
 import javax.websocket.OnMessage;
+import javax.websocket.OnOpen;
 import javax.websocket.Session;
 import javax.websocket.server.PathParam;
 import javax.websocket.server.ServerEndpoint;
@@ -27,16 +28,21 @@
 @Authenticated
 @ApplicationScoped
 @ServerEndpoint(value = "/compas-scl-validator/validate-ws/v1/{" + TYPE_PATH_PARAM + "}",
-        decoders = AsyncWebsocketRequestDecoder.class,
-        encoders = AsyncWebsocketResponseEncoder.class)
-public class AsyncWebsocketResource {
-    private static final Logger LOGGER = LoggerFactory.getLogger(AsyncWebsocketResource.class);
+        decoders = SclValidateRequestDecoder.class,
+        encoders = SclValidateResponseEncoder.class)
+public class SclValidatorServerEndpoint {
+    private static final Logger LOGGER = LoggerFactory.getLogger(SclValidatorServerEndpoint.class);
 
-    private final EventBus bus;
+    private final EventBus eventBus;
 
     @Inject
-    public AsyncWebsocketResource(EventBus bus) {
-        this.bus = bus;
+    public SclValidatorServerEndpoint(EventBus eventBus) {
+        this.eventBus = eventBus;
+    }
+
+    @OnOpen
+    public void onOpen(Session session, @PathParam(TYPE_PATH_PARAM) String type) {
+        LOGGER.debug("Starting session {} for type {}.", session.getId(), type);
     }
 
     @OnError
@@ -48,7 +54,7 @@ public void onError(Session session, @PathParam(TYPE_PATH_PARAM) String type, Th
     @OnMessage
     public void validateSCL(Session session, SclValidateRequest request, @PathParam(TYPE_PATH_PARAM) String type) {
         LOGGER.info("Message from session {} for type {}.", session.getId(), type);
-        bus.send("validate-ws", new AsyncWebsocketEventRequest(
+        eventBus.send("validate-ws", new SclValidatorEventRequest(
                 session, SclFileType.valueOf(type), request.getSclData()));
     }
 }

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/event/AsyncWebsocketEventHandler.java renamed to app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/event/SclValidatorEventHandler.java

@@ -4,29 +4,40 @@
 package org.lfenergy.compas.scl.validator.rest.v1.event;
 
 import io.quarkus.vertx.ConsumeEvent;
+import io.smallrye.mutiny.Uni;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateResponse;
 import org.lfenergy.compas.scl.validator.service.SclValidatorService;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 import java.io.IOException;
 
+/**
+ * Event Handler used by the Websockets implementation to execute the validation asynchronized.
+ */
 @ApplicationScoped
-public class AsyncWebsocketEventHandler {
+public class SclValidatorEventHandler {
     private final SclValidatorService sclValidatorService;
 
     @Inject
-    public AsyncWebsocketEventHandler(SclValidatorService sclValidatorService) {
+    public SclValidatorEventHandler(SclValidatorService sclValidatorService) {
         this.sclValidatorService = sclValidatorService;
     }
 
     @ConsumeEvent(value = "validate-ws", blocking = true)
-    public void validateEvent(AsyncWebsocketEventRequest request) throws IOException {
+    public void validateWebsocketsEvent(SclValidatorEventRequest request) throws IOException {
         var response = new SclValidateResponse();
         response.setValidationErrorList(sclValidatorService.validate(request.getType(), request.getSclData()));
 
         var session = request.getSession();
         session.getAsyncRemote().sendObject(response);
         session.close();
     }
+
+    @ConsumeEvent(value = "validate-rest", blocking = true)
+    public Uni<SclValidateResponse> validateRestEvent(SclValidatorEventRequest request) {
+        var response = new SclValidateResponse();
+        response.setValidationErrorList(sclValidatorService.validate(request.getType(), request.getSclData()));
+        return Uni.createFrom().item(response);
+    }
 }

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/event/AsyncWebsocketEventRequest.java renamed to app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/event/SclValidatorEventRequest.java

@@ -7,12 +7,16 @@
 
 import javax.websocket.Session;
 
-public class AsyncWebsocketEventRequest {
-    private final Session session;
+public class SclValidatorEventRequest {
+    private Session session;
     private final SclFileType type;
     private final String sclData;
 
-    public AsyncWebsocketEventRequest(Session session, SclFileType type, String sclData) {
+    public SclValidatorEventRequest(SclFileType type, String sclData) {
+        this(null, type, sclData);
+    }
+
+    public SclValidatorEventRequest(Session session, SclFileType type, String sclData) {
         this.session = session;
         this.type = type;
         this.sclData = sclData;