feat: Move protocol setting from transformers to controllers (#2996)

* Pull up protocol setting; align and simplify controllers * Move up protocol and align controllers * Checkstyle fixes
eclipse-edc · May 14, 2023 · a7b21bb · a7b21bb
1 parent 2ba041d
commit a7b21bb
Show file tree

Hide file tree

Showing 39 changed files with 600 additions and 256 deletions.
diff --git a/...og-api/src/main/java/org/eclipse/edc/protocol/dsp/catalog/api/DspCatalogApiExtension.java b/...og-api/src/main/java/org/eclipse/edc/protocol/dsp/catalog/api/DspCatalogApiExtension.java
@@ -19,7 +19,7 @@
 import org.eclipse.edc.connector.spi.catalog.CatalogProtocolService;
 import org.eclipse.edc.jsonld.spi.JsonLd;
 import org.eclipse.edc.protocol.dsp.api.configuration.DspApiConfiguration;
-import org.eclipse.edc.protocol.dsp.catalog.api.controller.CatalogController;
+import org.eclipse.edc.protocol.dsp.catalog.api.controller.DspCatalogApiController;
 import org.eclipse.edc.runtime.metamodel.annotation.Extension;
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.spi.iam.IdentityService;
@@ -66,7 +66,7 @@ public String name() {
     public void initialize(ServiceExtensionContext context) {
         var mapper = typeManager.getMapper(JSON_LD);
         var dspCallbackAddress = apiConfiguration.getDspCallbackAddress();
-        var catalogController = new CatalogController(context.getMonitor(), mapper, identityService, transformerRegistry, dspCallbackAddress, service, jsonLdService);
+        var catalogController = new DspCatalogApiController(context.getMonitor(), mapper, identityService, transformerRegistry, dspCallbackAddress, service, jsonLdService);
         webService.registerResource(apiConfiguration.getContextAlias(), catalogController);
 
         dataServiceRegistry.register(DataService.Builder.newInstance()

diff --git a/...log/api/controller/CatalogController.java → ...i/controller/DspCatalogApiController.java b/...log/api/controller/CatalogController.java → ...i/controller/DspCatalogApiController.java
@@ -38,10 +38,11 @@
 
 import static jakarta.ws.rs.core.HttpHeaders.AUTHORIZATION;
 import static java.lang.String.format;
+import static org.eclipse.edc.jsonld.spi.TypeUtil.isOfExpectedType;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.BASE_PATH;
 import static org.eclipse.edc.protocol.dsp.catalog.api.CatalogApiPaths.CATALOG_REQUEST;
 import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
-import static org.eclipse.edc.protocol.dsp.transform.util.TypeUtil.isOfExpectedType;
+import static org.eclipse.edc.protocol.dsp.spi.types.HttpMessageProtocol.DATASPACE_PROTOCOL_HTTP;
 import static org.eclipse.edc.web.spi.exception.ServiceResultHandler.exceptionMapper;
 
 /**
@@ -50,8 +51,8 @@
 @Consumes({ MediaType.APPLICATION_JSON })
 @Produces({ MediaType.APPLICATION_JSON })
 @Path(BASE_PATH)
-public class CatalogController {
-    
+public class DspCatalogApiController {
+
     private final Monitor monitor;
     private final ObjectMapper mapper;
     private final IdentityService identityService;
@@ -60,9 +61,9 @@ public class CatalogController {
     private final CatalogProtocolService service;
     private final JsonLd jsonLdService;
 
-    public CatalogController(Monitor monitor, ObjectMapper mapper, IdentityService identityService,
-                             TypeTransformerRegistry transformerRegistry, String dspCallbackAddress,
-                             CatalogProtocolService service, JsonLd jsonLdService) {
+    public DspCatalogApiController(Monitor monitor, ObjectMapper mapper, IdentityService identityService,
+                                   TypeTransformerRegistry transformerRegistry, String dspCallbackAddress,
+                                   CatalogProtocolService service, JsonLd jsonLdService) {
         this.monitor = monitor;
         this.mapper = mapper;
         this.identityService = identityService;
@@ -76,7 +77,7 @@ public CatalogController(Monitor monitor, ObjectMapper mapper, IdentityService i
     @Path(CATALOG_REQUEST)
     public Map<String, Object> getCatalog(JsonObject jsonObject, @HeaderParam(AUTHORIZATION) String token) {
         monitor.debug(() -> "DSP: Incoming catalog request.");
-        
+
         var tokenRepresentation = TokenRepresentation.Builder.newInstance()
                 .token(token)
                 .build();
@@ -96,6 +97,9 @@ public Map<String, Object> getCatalog(JsonObject jsonObject, @HeaderParam(AUTHOR
         var message = transformerRegistry.transform(expandedJson, CatalogRequestMessage.class)
                 .orElseThrow(failure -> new InvalidRequestException(format("Request body was malformed: %s", failure.getFailureDetail())));
 
+        // set protocol
+        message.setProtocol(DATASPACE_PROTOCOL_HTTP);
+
         var catalog = service.getCatalog(message, claimToken)
                 .orElseThrow(exceptionMapper(Catalog.class));
 
@@ -106,6 +110,7 @@ public Map<String, Object> getCatalog(JsonObject jsonObject, @HeaderParam(AUTHOR
         if (compacted.failed()) {
             throw new InvalidRequestException(compacted.getFailureDetail());
         }
+        //noinspection unchecked
         return mapper.convertValue(compacted.getContent(), Map.class);
     }
 

diff --git a/...ler/CatalogControllerIntegrationTest.java → ...pCatalogApiControllerIntegrationTest.java b/...ler/CatalogControllerIntegrationTest.java → ...pCatalogApiControllerIntegrationTest.java
@@ -53,7 +53,7 @@
 
 @ApiTest
 @ExtendWith(EdcExtension.class)
-class CatalogControllerIntegrationTest {
+class DspCatalogApiControllerIntegrationTest {
 
     private final int dspApiPort = getFreePort();
     private final String dspApiPath = "/api/v1/dsp";

diff --git a/...api/controller/CatalogControllerTest.java → ...ntroller/DspCatalogApiControllerTest.java b/...api/controller/CatalogControllerTest.java → ...ntroller/DspCatalogApiControllerTest.java
@@ -49,6 +49,7 @@
 import static org.eclipse.edc.jsonld.spi.Namespaces.ODRL_PREFIX;
 import static org.eclipse.edc.jsonld.spi.Namespaces.ODRL_SCHEMA;
 import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_CATALOG_REQUEST_TYPE;
+import static org.eclipse.edc.protocol.dsp.spi.types.HttpMessageProtocol.DATASPACE_PROTOCOL_HTTP;
 import static org.eclipse.edc.service.spi.result.ServiceResult.badRequest;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
@@ -57,7 +58,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-class CatalogControllerTest {
+class DspCatalogApiControllerTest {
 
     private final Monitor monitor = mock(Monitor.class);
     private final ObjectMapper mapper = mock(ObjectMapper.class);
@@ -69,7 +70,7 @@ class CatalogControllerTest {
     private final JsonLd jsonLdService = new TitaniumJsonLd(mock(Monitor.class));
     private JsonObject request;
     private CatalogRequestMessage requestMessage;
-    private CatalogController controller;
+    private DspCatalogApiController controller;
 
     private static ClaimToken createToken() {
         return ClaimToken.Builder.newInstance().build();
@@ -81,7 +82,7 @@ void setUp() {
         jsonLdService.registerNamespace(DCT_PREFIX, DCT_SCHEMA);
         jsonLdService.registerNamespace(ODRL_PREFIX, ODRL_SCHEMA);
         jsonLdService.registerNamespace(DSPACE_PREFIX, DSPACE_SCHEMA);
-        controller = new CatalogController(monitor, mapper, identityService, transformerRegistry, callbackAddress, service, jsonLdService);
+        controller = new DspCatalogApiController(monitor, mapper, identityService, transformerRegistry, callbackAddress, service, jsonLdService);
 
         request = Json.createObjectBuilder()
                 .add(TYPE, DSPACE_CATALOG_REQUEST_TYPE)
@@ -107,6 +108,9 @@ void getCatalog_returnCatalog() {
 
         assertThat(response).isEqualTo(responseMap);
         verify(service).getCatalog(requestMessage, token);
+
+        // verify that the message protocol was set to the DSP protocol by the controller
+        assertThat(requestMessage.getProtocol()).isEqualTo(DATASPACE_PROTOCOL_HTTP);
     }
 
     @Test

diff --git a/...e/edc/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformer.java b/...e/edc/protocol/dsp/catalog/transform/to/JsonObjectToCatalogRequestMessageTransformer.java
@@ -27,32 +27,30 @@
 
 import static java.lang.String.format;
 import static org.eclipse.edc.protocol.dsp.catalog.transform.DspCatalogPropertyAndTypeNames.DSPACE_FILTER_PROPERTY;
-import static org.eclipse.edc.protocol.dsp.spi.types.HttpMessageProtocol.DATASPACE_PROTOCOL_HTTP;
 
 /**
  * Transforms a {@link JsonObject} in JSON-LD expanded form to a {@link CatalogRequestMessage}.
  */
 public class JsonObjectToCatalogRequestMessageTransformer extends AbstractJsonLdTransformer<JsonObject, CatalogRequestMessage> {
-    
+
     private final ObjectMapper mapper;
-    
+
     public JsonObjectToCatalogRequestMessageTransformer(ObjectMapper mapper) {
         super(JsonObject.class, CatalogRequestMessage.class);
         this.mapper = mapper;
     }
-    
+
     @Override
     public @Nullable CatalogRequestMessage transform(@NotNull JsonObject object, @NotNull TransformerContext context) {
         var builder = CatalogRequestMessage.Builder.newInstance();
-        builder.protocol(DATASPACE_PROTOCOL_HTTP);
-
+
         if (object.get(DSPACE_FILTER_PROPERTY) != null) {
             builder.querySpec(transformQuerySpec(object.get(DSPACE_FILTER_PROPERTY), context));
         }
-        
+
         return builder.build();
     }
-    
+
     private QuerySpec transformQuerySpec(JsonValue value, TransformerContext context) {
         if (value instanceof JsonObject) {
             return mapper.convertValue(value, QuerySpec.class);

diff --git a/data-protocols/dsp/dsp-negotiation/dsp-negotiation-api/build.gradle.kts b/data-protocols/dsp/dsp-negotiation/dsp-negotiation-api/build.gradle.kts
@@ -19,8 +19,9 @@ plugins {
 
 dependencies {
     api(project(":data-protocols:dsp:dsp-api-configuration"))
+
+    // TODO remove this dependency by moving type constants to another module
     api(project(":data-protocols:dsp:dsp-negotiation:dsp-negotiation-transform"))
-    api(project(":data-protocols:dsp:dsp-transform"))
 
     api(project(":spi:common:core-spi"))
     api(project(":spi:control-plane:control-plane-spi"))
@@ -32,4 +33,4 @@ dependencies {
     testImplementation(project(":core:common:junit"))
     testImplementation(testFixtures(project(":extensions:common:http:jersey-core")))
     testImplementation(libs.restAssured)
-}
+}
diff --git a/...rc/main/java/org/eclipse/edc/protocol/dsp/negotiation/api/DspNegotiationApiExtension.java b/...rc/main/java/org/eclipse/edc/protocol/dsp/negotiation/api/DspNegotiationApiExtension.java
@@ -17,7 +17,7 @@
 import org.eclipse.edc.connector.spi.contractnegotiation.ContractNegotiationProtocolService;
 import org.eclipse.edc.jsonld.spi.JsonLd;
 import org.eclipse.edc.protocol.dsp.api.configuration.DspApiConfiguration;
-import org.eclipse.edc.protocol.dsp.negotiation.api.controller.DspNegotiationController;
+import org.eclipse.edc.protocol.dsp.negotiation.api.controller.DspNegotiationApiController;
 import org.eclipse.edc.runtime.metamodel.annotation.Extension;
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.spi.iam.IdentityService;
@@ -71,7 +71,7 @@ public void initialize(ServiceExtensionContext context) {
         var callbackAddress = apiConfiguration.getDspCallbackAddress();
         var objectMapper = typeManager.getMapper(JSON_LD);
 
-        var controller = new DspNegotiationController(callbackAddress, identityService, transformerRegistry, protocolService, jsonLdService, objectMapper, monitor);
+        var controller = new DspNegotiationApiController(callbackAddress, identityService, transformerRegistry, protocolService, jsonLdService, objectMapper, monitor);
 
         webService.registerResource(apiConfiguration.getContextAlias(), controller);
     }