feat: add support for multiple protocol webooks

eclipse-edc · Jan 16, 2025 · c913962 · c913962
1 parent 9697382
commit c913962
Show file tree

Hide file tree

Showing 32 changed files with 804 additions and 599 deletions.
diff --git a/...on/connector-core/src/main/java/org/eclipse/edc/connector/core/CoreServicesExtension.java b/...on/connector-core/src/main/java/org/eclipse/edc/connector/core/CoreServicesExtension.java
@@ -20,6 +20,7 @@
 import org.eclipse.edc.connector.core.event.EventExecutorServiceContainer;
 import org.eclipse.edc.connector.core.event.EventRouterImpl;
 import org.eclipse.edc.connector.core.message.RemoteMessageDispatcherRegistryImpl;
+import org.eclipse.edc.connector.core.protocol.ProtocolWebhookRegistryImpl;
 import org.eclipse.edc.connector.core.validator.DataAddressValidatorRegistryImpl;
 import org.eclipse.edc.connector.core.validator.JsonObjectValidatorRegistryImpl;
 import org.eclipse.edc.http.client.ControlApiHttpClientImpl;
@@ -42,6 +43,7 @@
 import org.eclipse.edc.spi.command.CommandHandlerRegistry;
 import org.eclipse.edc.spi.event.EventRouter;
 import org.eclipse.edc.spi.message.RemoteMessageDispatcherRegistry;
+import org.eclipse.edc.spi.protocol.ProtocolWebhookRegistry;
 import org.eclipse.edc.spi.query.CriterionOperatorRegistry;
 import org.eclipse.edc.spi.system.Hostname;
 import org.eclipse.edc.spi.system.ServiceExtension;
@@ -61,11 +63,8 @@ public class CoreServicesExtension implements ServiceExtension {
 
     @Setting(description = "The name of the claim key used to determine the participant identity", defaultValue = DEFAULT_IDENTITY_CLAIM_KEY)
     public static final String EDC_AGENT_IDENTITY_KEY = "edc.agent.identity.key";
-
-    private static final String DEFAULT_EDC_HOSTNAME = "localhost";
-
     public static final String EDC_HOSTNAME = "edc.hostname";
-
+    private static final String DEFAULT_EDC_HOSTNAME = "localhost";
     @Setting(description = "Connector hostname, which e.g. is used in referer urls", defaultValue = DEFAULT_EDC_HOSTNAME, key = EDC_HOSTNAME, warnOnMissingConfig = true)
     public static String hostname;
 
@@ -173,6 +172,11 @@ public CriterionOperatorRegistry criterionOperatorRegistry() {
     public ControlApiHttpClient controlApiHttpClient() {
         return new ControlApiHttpClientImpl(edcHttpClient, controlClientAuthenticationProvider);
     }
+
+    @Provider
+    public ProtocolWebhookRegistry protocolWebhookRegistry() {
+        return new ProtocolWebhookRegistryImpl();
+    }
 
 }
 
diff --git a/...re/src/main/java/org/eclipse/edc/connector/core/protocol/ProtocolWebhookRegistryImpl.java b/...re/src/main/java/org/eclipse/edc/connector/core/protocol/ProtocolWebhookRegistryImpl.java
@@ -0,0 +1,36 @@
+/*
+ *  Copyright (c) 2025 Metaform Systems, Inc.
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Metaform Systems, Inc. - initial API and implementation
+ *
+ */
+
+package org.eclipse.edc.connector.core.protocol;
+
+import org.eclipse.edc.spi.protocol.ProtocolWebhook;
+import org.eclipse.edc.spi.protocol.ProtocolWebhookRegistry;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class ProtocolWebhookRegistryImpl implements ProtocolWebhookRegistry {
+    private final Map<String, ProtocolWebhook> webhooks = new HashMap<>();
+
+    @Override
+    public void registerWebhook(String protocol, ProtocolWebhook webhook) {
+        webhooks.put(protocol, webhook);
+    }
+
+    @Override
+    public @Nullable ProtocolWebhook resolve(String protocol) {
+        return webhooks.get(protocol);
+    }
+}
diff --git a/...a/org/eclipse/edc/connector/controlplane/services/catalog/CatalogProtocolServiceImpl.java b/...a/org/eclipse/edc/connector/controlplane/services/catalog/CatalogProtocolServiceImpl.java
@@ -55,8 +55,8 @@ public CatalogProtocolServiceImpl(DatasetResolver datasetResolver,
     public ServiceResult<Catalog> getCatalog(CatalogRequestMessage message, TokenRepresentation tokenRepresentation) {
         return transactionContext.execute(() -> protocolTokenValidator.verify(tokenRepresentation, RequestCatalogPolicyContext::new, message)
                 .map(agent -> {
-                    try (var datasets = datasetResolver.query(agent, message.getQuerySpec())) {
-                        var dataServices = dataServiceRegistry.getDataServices();
+                    try (var datasets = datasetResolver.query(agent, message.getQuerySpec(), message.getProtocol())) {
+                        var dataServices = dataServiceRegistry.getDataServices(message.getProtocol());
 
                         return Catalog.Builder.newInstance()
                                 .dataServices(dataServices)
@@ -69,9 +69,9 @@ public ServiceResult<Catalog> getCatalog(CatalogRequestMessage message, TokenRep
     }
 
     @Override
-    public @NotNull ServiceResult<Dataset> getDataset(String datasetId, TokenRepresentation tokenRepresentation) {
+    public @NotNull ServiceResult<Dataset> getDataset(String datasetId, TokenRepresentation tokenRepresentation, String protocol) {
         return transactionContext.execute(() -> protocolTokenValidator.verify(tokenRepresentation, RequestCatalogPolicyContext::new)
-                .map(agent -> datasetResolver.getById(agent, datasetId))
+                .map(agent -> datasetResolver.getById(agent, datasetId, protocol))
                 .compose(dataset -> {
                     if (dataset == null) {
                         return ServiceResult.notFound(format("Dataset %s does not exist", datasetId));

diff --git a/...g/eclipse/edc/connector/controlplane/services/catalog/CatalogProtocolServiceImplTest.java b/...g/eclipse/edc/connector/controlplane/services/catalog/CatalogProtocolServiceImplTest.java
@@ -87,8 +87,8 @@ void shouldReturnCatalogWithConnectorDataServiceAndItsDataset() {
             var dataService = DataService.Builder.newInstance().build();
 
             when(protocolTokenValidator.verify(eq(tokenRepresentation), any(), eq(message))).thenReturn(ServiceResult.success(participantAgent));
-            when(dataServiceRegistry.getDataServices()).thenReturn(List.of(dataService));
-            when(datasetResolver.query(any(), any())).thenReturn(Stream.of(createDataset()));
+            when(dataServiceRegistry.getDataServices(any())).thenReturn(List.of(dataService));
+            when(datasetResolver.query(any(), any(), any())).thenReturn(Stream.of(createDataset()));
 
             var result = service.getCatalog(message, tokenRepresentation);
 
@@ -97,7 +97,7 @@ void shouldReturnCatalogWithConnectorDataServiceAndItsDataset() {
                 assertThat(catalog.getDatasets()).hasSize(1);
                 assertThat(catalog.getParticipantId()).isEqualTo("participantId");
             });
-            verify(datasetResolver).query(eq(participantAgent), eq(querySpec));
+            verify(datasetResolver).query(eq(participantAgent), eq(querySpec), eq("protocol"));
             verify(transactionContext).execute(any(TransactionContext.ResultTransactionBlock.class));
         }
 
@@ -125,12 +125,12 @@ void shouldReturnDataset() {
             var dataset = createDataset();
 
             when(protocolTokenValidator.verify(eq(tokenRepresentation), any())).thenReturn(ServiceResult.success(participantAgent));
-            when(datasetResolver.getById(any(), any())).thenReturn(dataset);
+            when(datasetResolver.getById(any(), any(), any())).thenReturn(dataset);
 
-            var result = service.getDataset("datasetId", tokenRepresentation);
+            var result = service.getDataset("datasetId", tokenRepresentation, "protocol");
 
             assertThat(result).isSucceeded().isEqualTo(dataset);
-            verify(datasetResolver).getById(participantAgent, "datasetId");
+            verify(datasetResolver).getById(participantAgent, "datasetId", "protocol");
             verify(transactionContext).execute(any(TransactionContext.ResultTransactionBlock.class));
         }
 
@@ -140,9 +140,9 @@ void shouldFail_whenDatasetIsNull() {
             var tokenRepresentation = createTokenRepresentation();
 
             when(protocolTokenValidator.verify(eq(tokenRepresentation), any())).thenReturn(ServiceResult.success(participantAgent));
-            when(datasetResolver.getById(any(), any())).thenReturn(null);
+            when(datasetResolver.getById(any(), any(), any())).thenReturn(null);
 
-            var result = service.getDataset("datasetId", tokenRepresentation);
+            var result = service.getDataset("datasetId", tokenRepresentation, "protocol");
 
             assertThat(result).isFailed().extracting(ServiceFailure::getReason).isEqualTo(NOT_FOUND);
         }
@@ -153,7 +153,7 @@ void shouldFail_whenTokenValidationFails() {
 
             when(protocolTokenValidator.verify(eq(tokenRepresentation), any())).thenReturn(ServiceResult.unauthorized("unauthorized"));
 
-            var result = service.getDataset("datasetId", tokenRepresentation);
+            var result = service.getDataset("datasetId", tokenRepresentation, "protocol");
 
             assertThat(result).isFailed().extracting(ServiceFailure::getReason).isEqualTo(UNAUTHORIZED);
         }

diff --git a/...edc/connector/controlplane/services/transferprocess/TransferProcessEventDispatchTest.java b/...edc/connector/controlplane/services/transferprocess/TransferProcessEventDispatchTest.java
@@ -51,11 +51,12 @@
 import org.eclipse.edc.spi.iam.TokenRepresentation;
 import org.eclipse.edc.spi.message.RemoteMessageDispatcher;
 import org.eclipse.edc.spi.message.RemoteMessageDispatcherRegistry;
-import org.eclipse.edc.spi.protocol.ProtocolWebhook;
+import org.eclipse.edc.spi.protocol.ProtocolWebhookRegistry;
 import org.eclipse.edc.spi.response.StatusResult;
 import org.eclipse.edc.spi.result.Result;
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.jetbrains.annotations.NotNull;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.mockito.ArgumentCaptor;
@@ -84,6 +85,8 @@
 public class TransferProcessEventDispatchTest {
 
     public static final Duration TIMEOUT = Duration.ofSeconds(30);
+    private static final ProtocolWebhookRegistry protocolWebhookRegistry = mock(ProtocolWebhookRegistry.class);
+
     @RegisterExtension
     static final RuntimeExtension RUNTIME = new RuntimePerClassExtension()
             .setConfiguration(Map.of(
@@ -93,13 +96,20 @@ public class TransferProcessEventDispatchTest {
             .registerServiceMock(TransferWaitStrategy.class, () -> 1)
             .registerServiceMock(EventExecutorServiceContainer.class, new EventExecutorServiceContainer(newSingleThreadExecutor()))
             .registerServiceMock(IdentityService.class, mock())
-            .registerServiceMock(ProtocolWebhook.class, () -> "http://dummy")
+            .registerServiceMock(ProtocolWebhookRegistry.class, protocolWebhookRegistry)
             .registerServiceMock(PolicyArchive.class, mock())
             .registerServiceMock(ContractNegotiationStore.class, mock())
             .registerServiceMock(ParticipantAgentService.class, mock())
             .registerServiceMock(DataPlaneClientFactory.class, mock());
+
     private final EventSubscriber eventSubscriber = mock();
 
+    @BeforeEach
+    void setup() {
+        // setup
+        when(protocolWebhookRegistry.resolve(any())).thenReturn(() -> "http://dummy");
+    }
+
     @Test
     void shouldDispatchEventsOnTransferProcessStateChanges(TransferProcessService service,
                                                            TransferProcessProtocolService protocolService,

diff --git a/...src/main/java/org/eclipse/edc/connector/controlplane/catalog/DataServiceRegistryImpl.java b/...src/main/java/org/eclipse/edc/connector/controlplane/catalog/DataServiceRegistryImpl.java
@@ -19,19 +19,21 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 public class DataServiceRegistryImpl implements DataServiceRegistry {
 
-    private final List<DataService> dataServices = new ArrayList<>();
+    private final Map<String, List<DataService>> dataServices = new ConcurrentHashMap<>();
 
     @Override
-    public void register(DataService dataService) {
-        dataServices.add(dataService);
+    public void register(String protocol, DataService dataService) {
+        dataServices.computeIfAbsent(protocol, k -> new ArrayList<>()).add(dataService);
     }
 
     @Override
-    public List<DataService> getDataServices() {
-        return dataServices;
+    public List<DataService> getDataServices(String protocol) {
+        return dataServices.computeIfAbsent(protocol, k -> new ArrayList<>());
     }
 
 }
diff --git a/...log/src/main/java/org/eclipse/edc/connector/controlplane/catalog/DatasetResolverImpl.java b/...log/src/main/java/org/eclipse/edc/connector/controlplane/catalog/DatasetResolverImpl.java
@@ -63,32 +63,32 @@ public DatasetResolverImpl(ContractDefinitionResolver contractDefinitionResolver
 
     @Override
     @NotNull
-    public Stream<Dataset> query(ParticipantAgent agent, QuerySpec querySpec) {
+    public Stream<Dataset> query(ParticipantAgent agent, QuerySpec querySpec, String protocol) {
         var resolved = contractDefinitionResolver.resolveFor(agent);
         var contractDefinitions = resolved.contractDefinitions();
         if (contractDefinitions.isEmpty()) {
             return Stream.empty();
         }
-        
+
         var assetsQuery = QuerySpec.Builder.newInstance().offset(0).limit(MAX_VALUE).filter(querySpec.getFilterExpression()).build();
         return assetIndex.queryAssets(assetsQuery)
-                .map(asset -> toDataset(contractDefinitions, asset, resolved.policies()))
+                .map(asset -> toDataset(contractDefinitions, asset, resolved.policies(), protocol))
                 .filter(Dataset::hasOffers)
                 .skip(querySpec.getOffset())
                 .limit(querySpec.getLimit());
     }
 
     @Override
-    public Dataset getById(ParticipantAgent agent, String id) {
+    public Dataset getById(ParticipantAgent agent, String id, String protocol) {
         var resolved = contractDefinitionResolver.resolveFor(agent);
         var contractDefinitions = resolved.contractDefinitions();
         if (contractDefinitions.isEmpty()) {
             return null;
         }
-        
+
         return Optional.of(id)
                 .map(assetIndex::findById)
-                .map(asset -> toDataset(contractDefinitions, asset, resolved.policies()))
+                .map(asset -> toDataset(contractDefinitions, asset, resolved.policies(), protocol))
                 .filter(Dataset::hasOffers)
                 .orElse(null);
     }
@@ -106,9 +106,9 @@ public Dataset getById(ParticipantAgent agent, String id) {
                         .build());
     }
 
-    private Dataset toDataset(List<ContractDefinition> contractDefinitions, Asset asset, Map<String, Policy> policies) {
+    private Dataset toDataset(List<ContractDefinition> contractDefinitions, Asset asset, Map<String, Policy> policies, String protocol) {
 
-        var distributions = distributionResolver.getDistributions(asset);
+        var distributions = distributionResolver.getDistributions(protocol, asset);
         var datasetBuilder = buildDataset(asset)
                 .id(asset.getId())
                 .distributions(distributions)

diff --git a/...main/java/org/eclipse/edc/connector/controlplane/catalog/DefaultDistributionResolver.java b/...main/java/org/eclipse/edc/connector/controlplane/catalog/DefaultDistributionResolver.java
@@ -36,7 +36,7 @@ public DefaultDistributionResolver(DataServiceRegistry dataServiceRegistry, Data
     }
 
     @Override
-    public List<Distribution> getDistributions(Asset asset) {
+    public List<Distribution> getDistributions(String protocol, Asset asset) {
         if (asset.isCatalog()) {
             return List.of(Distribution.Builder.newInstance()
                     .format(asset.getDataAddress().getType())
@@ -45,12 +45,12 @@ public List<Distribution> getDistributions(Asset asset) {
                             .build())
                     .build());
         }
-        return dataFlowManager.transferTypesFor(asset).stream().map(this::createDistribution).toList();
+        return dataFlowManager.transferTypesFor(asset).stream().map((format) -> createDistribution(protocol, format)).toList();
     }
 
-    private Distribution createDistribution(String format) {
+    private Distribution createDistribution(String protocol, String format) {
         var builder = Distribution.Builder.newInstance().format(format);
-        dataServiceRegistry.getDataServices().forEach(builder::dataService);
+        dataServiceRegistry.getDataServices(protocol).forEach(builder::dataService);
         return builder.build();
     }
 }
diff --git a/...test/java/org/eclipse/edc/connector/controlplane/catalog/DataServiceRegistryImplTest.java b/...test/java/org/eclipse/edc/connector/controlplane/catalog/DataServiceRegistryImplTest.java
@@ -27,10 +27,24 @@ class DataServiceRegistryImplTest {
     void shouldReturnRegisteredDataService() {
         var dataService = DataService.Builder.newInstance().build();
 
-        registry.register(dataService);
-        var dataServices = registry.getDataServices();
+        var protocol = "protocol";
+
+        registry.register(protocol, dataService);
+        var dataServices = registry.getDataServices(protocol);
 
         assertThat(dataServices).containsExactly(dataService);
     }
 
+    @Test
+    void shouldReturnEmptyDataServices() {
+        var dataService = DataService.Builder.newInstance().build();
+
+        var protocol = "protocol";
+
+        registry.register(protocol, dataService);
+        var dataServices = registry.getDataServices("unknownProtocol");
+
+        assertThat(dataServices).isEmpty();
+    }
+
 }
diff --git a/...va/org/eclipse/edc/connector/controlplane/catalog/DatasetResolverImplIntegrationTest.java b/...va/org/eclipse/edc/connector/controlplane/catalog/DatasetResolverImplIntegrationTest.java
@@ -102,7 +102,7 @@ void shouldLimitResult_withHeterogeneousChunks() {
         var to = 50;
         var querySpec = QuerySpec.Builder.newInstance().range(new Range(from, to)).build();
 
-        var datasets = resolver.query(createAgent(), querySpec);
+        var datasets = resolver.query(createAgent(), querySpec, "protocol");
 
         assertThat(datasets).hasSize(to - from);
     }
@@ -126,7 +126,7 @@ void should_return_offers_subset_when_across_multiple_contract_definitions(int f
         when(contractDefinitionResolver.resolveFor(isA(ParticipantAgent.class))).thenReturn(new ResolvedContractDefinitions(List.of(contractDefinition1, contractDefinition2)));
         var querySpec = QuerySpec.Builder.newInstance().range(new Range(from, to)).build();
 
-        var datasets = resolver.query(createAgent(), querySpec);
+        var datasets = resolver.query(createAgent(), querySpec, "protocol");
 
         assertThat(datasets).hasSize(min(requestedRange, maximumRange));
     }
@@ -149,7 +149,7 @@ void shouldLimitResult_insufficientAssets() {
         var querySpec = QuerySpec.Builder.newInstance().range(new Range(from, to)).build();
 
         // 4 definitions, 10 assets each = 40 offers total -> offset 20 ==> result = 20
-        var dataset = resolver.query(createAgent(), querySpec);
+        var dataset = resolver.query(createAgent(), querySpec, "protocol");
 
         assertThat(dataset).hasSize(4);
     }
@@ -163,7 +163,7 @@ void shouldLimitResult_pageOffsetLargerThanNumAssets() {
         var to = 50;
         var querySpec = QuerySpec.Builder.newInstance().range(new Range(from, to)).build();
         // 2 definitions, 10 assets each = 20 offers total -> offset of 25 is outside
-        var datasets = resolver.query(createAgent(), querySpec);
+        var datasets = resolver.query(createAgent(), querySpec, "protocol");
 
         assertThat(datasets).isEmpty();
     }