fix: Only return Datasets with valid Offers (#1066)

(cherry picked from commit e7f8a57)

CHANGELOG.md

@@ -13,6 +13,8 @@ please see [changelog_updates.md](docs/dev/changelog_updates.md).
 
 #### Minor Changes
 
+- Only return `Datasets` with valid `Offers` ([#1065](https://github.com/sovity/edc-ce/issues/1065))
+
 #### Patch Changes
 
 - Fix issues with the Create Data Offer Endpoint ([PR#1055](https://github.com/sovity/edc-ce/pull/1055))

extensions/dataset-bugfix/build.gradle.kts

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ********************************************************************************/
+
+plugins {
+    `java-library`
+}
+
+dependencies {
+    api(libs.edc.coreSpi)
+    api(libs.edc.jsonLdSpi)
+    api(libs.edc.webSpi)
+    api(libs.edc.dspApiConfiguration)
+}

extensions/dataset-bugfix/src/main/java/org/eclipse/tractusx/edc/dataset/fix/DatasetFixExtension.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.eclipse.tractusx.edc.dataset.fix;
+
+import jakarta.json.JsonObject;
+import jakarta.ws.rs.NotFoundException;
+import jakarta.ws.rs.container.ContainerRequestContext;
+import jakarta.ws.rs.container.ContainerResponseContext;
+import jakarta.ws.rs.container.ContainerResponseFilter;
+import org.eclipse.edc.protocol.dsp.api.configuration.DspApiConfiguration;
+import org.eclipse.edc.runtime.metamodel.annotation.Inject;
+import org.eclipse.edc.spi.system.ServiceExtension;
+import org.eclipse.edc.spi.system.ServiceExtensionContext;
+import org.eclipse.edc.web.spi.WebService;
+
+import static jakarta.ws.rs.HttpMethod.GET;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
+import static org.eclipse.edc.jsonld.spi.PropertyAndTypeNames.DCAT_DATASET_TYPE;
+import static org.eclipse.edc.jsonld.spi.PropertyAndTypeNames.ODRL_POLICY_ATTRIBUTE;
+
+public class DatasetFixExtension implements ServiceExtension {
+
+
+    @Inject
+    private DspApiConfiguration apiConfiguration;
+
+    @Inject
+    private WebService webService;
+
+    @Override
+    public void initialize(ServiceExtensionContext context) {
+        webService.registerResource(apiConfiguration.getContextAlias(), new DatasetFilter());
+    }
+
+    private static class DatasetFilter implements ContainerResponseFilter {
+
+        private static final String GET_DATASETS_PATH = "catalog/datasets/";
+
+        @Override
+        public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) {
+            if (requestContext.getUriInfo().getPath().contains(GET_DATASETS_PATH) && requestContext.getMethod().equals(GET)) {
+                if (responseContext.getEntity() instanceof JsonObject jsonObject) {
+                    if (jsonObject.getString(TYPE).equals(DCAT_DATASET_TYPE) &&
+                            jsonObject.containsKey(ODRL_POLICY_ATTRIBUTE) &&
+                            jsonObject.getJsonArray(ODRL_POLICY_ATTRIBUTE).isEmpty()
+                    ) {
+                        throw new NotFoundException();
+                    }
+                }
+            }
+        }
+    }
+}

extensions/dataset-bugfix/src/main/resources/META-INF/services/org.eclipse.edc.spi.system.ServiceExtension

@@ -0,0 +1,20 @@
+#################################################################################
+#  Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+#  See the NOTICE file(s) distributed with this work for additional
+#  information regarding copyright ownership.
+#
+#  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.
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+#################################################################################
+
+org.eclipse.tractusx.edc.dataset.fix.DatasetFixExtension

extensions/sovity-edc-extensions-package/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
     api(project(":extensions:edc-ui-config"))
     api(project(":extensions:last-commit-info"))
     api(project(":extensions:wrapper:wrapper"))
+    api(project(":extensions:dataset-bugfix"))
 }
 
 group = libs.versions.sovityEdcExtensionGroup.get()

gradle/libs.versions.toml

@@ -127,6 +127,7 @@ edc-transferSpi = { module = "org.eclipse.edc:transfer-spi", version.ref = "edc"
 edc-transformCore = { module = "org.eclipse.edc:transform-core", version.ref = "edc" }
 edc-transformSpi = { module = "org.eclipse.edc:transform-spi", version.ref = "edc" }
 edc-vaultFilesystem = { module = "org.eclipse.edc:vault-filesystem", version.ref = "edc" }
+edc-webSpi = { module = "org.eclipse.edc:web-spi", version.ref = "edc" }
 
 findbugs-jsr305 = { module = "com.google.code.findbugs:jsr305", version.ref = "findbugs" }
 

settings.gradle.kts

@@ -6,6 +6,7 @@ include(":extensions:catalog-crawler:catalog-crawler-launcher-base")
 include(":extensions:catalog-crawler:catalog-crawler-e2e-test")
 include(":extensions:contract-termination")
 include(":extensions:database-direct-access")
+include(":extensions:dataset-bugfix")
 include(":extensions:edc-ui-config")
 include(":extensions:last-commit-info")
 include(":extensions:mds-logginghouse-binder")

tests/src/test/java/de/sovity/edc/e2e/DatasetTest.java

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2023 sovity GmbH
+ *
+ *  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:
+ *       sovity GmbH - init
+ *
+ */
+
+package de.sovity.edc.e2e;
+
+import de.sovity.edc.extension.e2e.connector.ConnectorRemote;
+import de.sovity.edc.extension.e2e.connector.config.ConnectorConfig;
+import de.sovity.edc.extension.e2e.extension.Consumer;
+import de.sovity.edc.extension.e2e.extension.E2eTestExtension;
+import de.sovity.edc.extension.e2e.extension.Provider;
+import io.restassured.response.Response;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import java.util.Map;
+import java.util.UUID;
+
+import static de.sovity.edc.extension.e2e.extension.Helpers.defaultE2eTestExtension;
+import static io.restassured.http.ContentType.JSON;
+import static jakarta.json.Json.createObjectBuilder;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.CONTEXT;
+import static org.eclipse.edc.spi.CoreConstants.EDC_NAMESPACE;
+import static org.eclipse.edc.spi.CoreConstants.EDC_PREFIX;
+import static org.hamcrest.Matchers.equalTo;
+
+class DatasetTest {
+
+    @RegisterExtension
+    private static E2eTestExtension e2eTestExtension = defaultE2eTestExtension();
+
+    @Test
+    void canRetrieveOfferedDataset(
+            @Consumer ConnectorRemote consumerConnector,
+            @Provider ConnectorConfig providerConfig,
+            @Provider ConnectorRemote providerConnector) {
+        // arrange
+        var assetId = UUID.randomUUID().toString();
+        providerConnector.createDataOffer(assetId, "http://example.com");
+
+        // act & assert
+        prepareDatasetApiCall(
+                consumerConnector,
+                providerConfig.getProtocolApiUrl(),
+                assetId)
+                .then()
+                .statusCode(200)
+                .body("'edc:description'", equalTo("description"));
+    }
+
+    @Test
+    void canNotRetrieveNotOfferedDataset(
+            @Consumer ConnectorRemote consumerConnector,
+            @Provider ConnectorConfig providerConfig,
+            @Provider ConnectorRemote providerConnector) {
+        // arrange
+        Map<String, Object> dataSource = Map.of(
+                EDC_NAMESPACE + "type", "HttpData",
+                EDC_NAMESPACE + "baseUrl", "http://localhost");
+        var assetId = UUID.randomUUID().toString();
+        providerConnector.createAsset(assetId, dataSource);
+
+        // act & assert
+        prepareDatasetApiCall(
+                consumerConnector,
+                providerConfig.getProtocolApiUrl(),
+                assetId)
+                .then()
+                .statusCode(502);
+    }
+
+    @Test
+    void canNotRetrieveNotOfferedDatasetIfValidOfferAvailable(
+            @Consumer ConnectorRemote consumerConnector,
+            @Provider ConnectorConfig providerConfig,
+            @Provider ConnectorRemote providerConnector) {
+        // arrange
+        Map<String, Object> dataSource = Map.of(
+                EDC_NAMESPACE + "type", "HttpData",
+                EDC_NAMESPACE + "baseUrl", "http://localhost");
+        var notOfferedAssetId = UUID.randomUUID().toString();
+        var offeredAssetId = UUID.randomUUID().toString();
+        providerConnector.createAsset(notOfferedAssetId, dataSource);
+        providerConnector.createDataOffer(offeredAssetId, "http://localhost");
+
+        // act & assert
+        prepareDatasetApiCall(
+                consumerConnector,
+                providerConfig.getProtocolApiUrl(),
+                notOfferedAssetId)
+                .then()
+                .statusCode(502);
+
+        prepareDatasetApiCall(
+                consumerConnector,
+                providerConfig.getProtocolApiUrl(),
+                offeredAssetId)
+                .then()
+                .statusCode(200)
+                .body("'edc:description'", equalTo("description"));
+    }
+
+    private static Response prepareDatasetApiCall(
+            ConnectorRemote consumerConnector,
+            String providerProtocolUrl,
+            String assetId) {
+        var requestBody = createObjectBuilder()
+                .add(CONTEXT, createObjectBuilder().add(EDC_PREFIX, EDC_NAMESPACE))
+                .add(EDC_NAMESPACE + "counterPartyAddress", providerProtocolUrl)
+                .add(EDC_NAMESPACE + "protocol", "dataspace-protocol-http")
+                .add("@id", assetId)
+                .build();
+        return consumerConnector.prepareManagementApiCall()
+                .contentType(JSON)
+                .body(requestBody)
+                .when()
+                .post("/v2/catalog/dataset/request");
+    }
+}