feat: consume offering #491

M-Fitzke · 2023-08-22T06:54:27Z

Pull Request

Implements the workflow for consuming an offering (asset, policy, contract definition) as stated in #182. Adds an API endpoint for consuming an offering with a single API call.
Will start a contract negotiation and once that is finisehd it will start a data transfer.

How Has This Been Tested?

All new classes are tested via Unit Testing, in addition to this there is an integration test covering the whole consumption process.

Linked Issue(s)

Part of #182 .

Checklist

* Add missing annotations * Align class names * Add null checks

…ensions into feat/182-consume-offering feat: merge latest upstream changes

… map

…sferProcessOutputDto

# Conflicts: # extensions/wrapper/wrapper-common-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/CriterionDto.java # extensions/wrapper/wrapper/build.gradle.kts # extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/WrapperExtension.java # extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/WrapperExtensionContextBuilder.java # extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/ContractDefinitionRequestDto.java # extensions/wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/usecase/services/OfferingService.java # extensions/wrapper/wrapper/src/test/java/de/sovity/edc/ext/wrapper/api/usecase/services/OfferingServiceTest.java # extensions/wrapper/wrapper/src/test/resources/usecase/contract-offer-valid.json # gradle.properties # settings.gradle.kts

…rns and problem reporting

richardtreier · 2023-09-12T06:19:36Z

...common-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/AtomicConstraintDto.java

-import lombok.RequiredArgsConstructor;
-import lombok.Setter;
-import lombok.ToString;
+import lombok.*;


convention: no asterisk imports (requires fix in intellij settings)

richardtreier · 2023-09-12T06:21:08Z

...apper-common-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/ExpressionDto.java

@@ -15,6 +15,7 @@

 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
+import lombok.Builder;


unused import?

richardtreier · 2023-09-12T06:22:27Z

extensions/wrapper/wrapper/build.gradle.kts

+    doLast {
+        println(sourceSets["main"].runtimeClasspath.asPath)
+    }
+}


This seems to be for local debugging only, right?

richardtreier · 2023-09-12T06:24:00Z

...ommon-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/ContractAgreementDto.java

+    private String id;
+    private String providerId;
+    private String consumerId;
+    private long contractSigningDate;


convention: API should use real date classes, e.g. OffsetDateTime

richardtreier · 2023-09-12T06:26:48Z

.../wrapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/WrapperExtensionContextBuilder.java

+        transformerRegistry.register(new PermissionToPermissionDtoTransformer());
+        transformerRegistry.register(new PolicyToPolicyDtoTransformer());
+        transformerRegistry.register(new ContractAgreementToContractAgreementDtoTransformer());
+        transformerRegistry.register(new DataRequestToDataRequestDtoTransformer());
+        transformerRegistry.register(new ContractNegotiationToContractNegotiationOutputDtoTransformer());
+        transformerRegistry.register(new TransferProcessToTransferProcessOutputDtoTransformer());
+        var consumptionService = new ConsumptionService(contractNegotiationService, transferProcessService,
+                contractNegotiationStore, transferProcessStore, transformerRegistry, policyMappingService);
+
+        negotiationObservable.registerListener(new ContractNegotiationConsumptionListener(consumptionService));


As long as we can we should try to avoid using the transformer registry to allow to see the code flow, calling functions depending on what's necessary, rather than registering global resources / mappings.

violates clean code / YAGNI

richardtreier · 2023-09-12T06:40:34Z

.../wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/ConsumptionOutputDto.java

+    private String id;
+
+    /** The input that was used to start this process. */
+    private ConsumptionInputDto input;


Is this required?

richardtreier · 2023-09-12T06:41:58Z

.../src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/ContractNegotiationOutputDto.java

+@Getter
+public class ContractNegotiationOutputDto {
+    private String id;
+    private String state;


String state, what information does this encode?

richardtreier · 2023-09-12T06:42:14Z

.../src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/ContractNegotiationOutputDto.java

+    private String counterPartyId;
+    private String counterPartyAddress;
+    private String protocol;
+    private ContractAgreementDto contractAgreement;


should this be unnested?

richardtreier · 2023-09-12T06:42:44Z

...rapper/wrapper/src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/DataRequestDto.java

+ * A DTO Class for DataRequests
+ *
+ * @author Haydar Qarawlus
+ */


what does this class do?

richardtreier · 2023-09-12T06:43:09Z

...pper/src/main/java/de/sovity/edc/ext/wrapper/api/usecase/model/TransferProcessOutputDto.java

+    private String state;
+    private DataRequestDto dataRequest;
+    private Map<String, String> contentDataAddress;
+    private Map<String, String> privateProperties = new HashMap<>();


should we really output the data address and private properties here?

richardtreier · 2023-09-12T06:58:20Z

In general, I'd recommend taking a look once more at these topics:

Consistent documentation of API models with @Schema
Use of the transformer registry only on Core EDC to Core EDC type mappings.
Another general look at the API model itself regarding nesting. 1-to-1 cardinality object shouldn't be nested unless there's a very good reason for it.
Our mapping for the UiPolicyDto (PolicyMapper) and the UiAsset (AssetMapper, type-safe UiAsset #512, WIP) will be implemented soon. Maybe we can re-use the UI models for the Use Case API as the mapping really was non-trivial, and we could profit both from the simplified policy creation and the type-safe asset creation

richardtreier · 2023-12-05T12:46:51Z

closed the PR, the general API model of the Use Case API is still on a MS8-State. Using EDC 0 we'll create a new simplified Use Case API that also re-uses the classes UiAsset, UiPolicy.

timdah and others added 30 commits June 28, 2023 17:16

feat(wrapper): create offer upgrade to edc 0.1.2

58a84a3

feat: Init consume api

002043e

feat: add additional DTOs

08ee8c4

feat: add PermissionTransformer

4669f7f

chore: add transformers for contract negotiation

dcb4f3e

feat(wrapper): consume offering transformer

4b9c3c1

feat(wrapper): consume api endpoints

9b1fd74

fix: handle null values and support Jackson deserialization

32b6854

test: add integration test for consume

64328c3

chore: validate consumption input

97afad3

test: add unit test for ConsumptionService

6ad1e31

chore: clean-up

7477ef7

* Add missing annotations * Align class names * Add null checks

test: update integration test to include create offering

20cd327

chore: log output transformation error

9eb4ac4

chore: remove unneeded properties from integration test

c3ffe1c

chore: use own policy model for consumption input

da66276

feat: added wrapper:api:usecase:transformer test sekeltons

d16b97d

chore: use map instead of DataAddress for input

ced411b

chore: throw exception when output transformation fails

22add04

docs: add Javadoc for ConsumptionService

b36056e

Merge branch 'feat/182-consume-offering' of github.com:sovity/edc-ext…

235ab2f

…ensions into feat/182-consume-offering feat: merge latest upstream changes

feat: configured mockito in PolicyToPolicyDTOTransformer test

52d8fa2

feat: extended transformer tests

ac0e2ca

feat: extended transformer tests with verifies and more checks

692aee6

fix: fixed ContractNegotiationToContractOutputDtoTransformerTest verify

0f43280

feat: set random UUID string for ConsumptionProcess ConsumptionDto in…

03cc818

… map

chore: remove todo annotation

6accae2

feat: add errorDetail fields to ContractNegotiationOutputDto and Tran…

b1d2c3d

…sferProcessOutputDto

feat: add illegal expression test for Permission Transformer

9356e35

timdah and others added 8 commits August 14, 2023 13:29

fix: new asset api

b0bd4cc

fix: missing test dependencies

f08dfd0

ref: revert unnecessary move of asset entry dto

f82a748

chore: clean up and test fix

55885ea

feat: add negative transformer tests for internal transform null retu…

ac0e7fe

…rns and problem reporting

feat: updated transformer tests

876e4f0

test: update UseCaseResourceIntegrationTest

a7a9b7f

Merge branch 'main' into feat/182-consume-offering

7c14547

ronjaquensel requested a review from richardtreier September 5, 2023 07:03

richardtreier reviewed Sep 12, 2023

View reviewed changes

richardtreier closed this Dec 5, 2023

tmberthold deleted the feat/182-consume-offering branch May 16, 2024 10:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: consume offering #491

feat: consume offering #491

M-Fitzke commented Aug 22, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier Sep 12, 2023

richardtreier commented Sep 12, 2023 •

edited

Loading

richardtreier commented Dec 5, 2023

feat: consume offering #491

feat: consume offering #491

Conversation

M-Fitzke commented Aug 22, 2023

Pull Request

How Has This Been Tested?

Linked Issue(s)

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richardtreier commented Sep 12, 2023 • edited Loading

richardtreier commented Dec 5, 2023

richardtreier commented Sep 12, 2023 •

edited

Loading