Merge pull request #709 from catenax-ng/feature/#256-add-documentation

feat(irs):[#256] added documentation, fixed problem with parsing authCode
eclipse-tractusx · Jan 11, 2024 · 104bcfb · 104bcfb
2 parents d22e9c2 + 5b47b1a
commit 104bcfb
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 9 deletions.
diff --git a/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc b/docs/src/docs/arc42/cross-cutting/under-the-hood.adoc
@@ -108,3 +108,46 @@ When the EDC Discovery is requested to return the EDC connector endpoint URLs fo
 The time to live for both caches can be configured separately as described in the Administration Guide.
 
 Further information on Discovery Service can be found in the chapter "System scope and context".
+
+=== EDC
+
+EndpointDataReferenceStorage is in-memory local storage that holds records (EndpointDataReferences) by either assetId or contractAgreementId.
+
+When EDC gets EndpointDataReference describing endpoint serving data it uses EndpointDataReferenceStorage and query it by assetId.
+This allows reuse of already existing EndpointDataReference if it is present, valid, and it's token is not expired,
+rather than starting whole new contract negotiation process.
+
+In case token is expired the process is also shortened. We don't have to start new contract negotiation process,
+since we can obtain required contractAgreementId from present authCode. This improves request processing time.
+
+[source, mermaid]
+....
+sequenceDiagram
+    autonumber
+    participant EdcSubmodelClient
+    participant ContractNegotiationService
+    participant EndpointDataReferenceStorage
+    participant EdcCallbackController
+    participant EdcDataPlaneClient
+    EdcSubmodelClient ->> EndpointDataReferenceStorage: Get EDR Token for EDC asset id
+    EndpointDataReferenceStorage ->> EdcSubmodelClient: Return Optional<EDR Token>
+    alt Token is present and not expired
+        EdcSubmodelClient ->> EdcSubmodelClient: Optional.get
+    else
+        alt Token is expired
+            EdcSubmodelClient ->> ContractNegotiationService: Renew EDR Token based on existing Token
+        else Token is not present
+            EdcSubmodelClient ->> ContractNegotiationService: Negotiate new EDR Token
+        end
+        ContractNegotiationService -->> EdcCallbackController: EDC flow
+        EdcCallbackController ->> EndpointDataReferenceStorage: Store EDR token by EDC asset id after EDC callback
+        loop While EDR Token is not present
+            EdcSubmodelClient ->> EndpointDataReferenceStorage: Poll for EDR Token
+        end
+        EndpointDataReferenceStorage ->> EdcSubmodelClient: Return EDR Token
+    end
+    EdcSubmodelClient ->> EdcDataPlaneClient: Get data(EDR Token, Dataplane URL)
+    EdcDataPlaneClient ->> EdcSubmodelClient: Return data
+....
+
+
diff --git a/...-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java b/...-client/src/main/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationService.java
@@ -94,11 +94,12 @@ public NegotiationResponse negotiate(final String providerConnectorUrl, final Ca
                 contractAgreementId = negotiationResponse.getContractAgreementId();
             }
             case EXPIRED -> {
-                final String authKey = resultEndpointDataReferenceStatus.endpointDataReference().getAuthKey();
-                if (authKey == null) {
+                final String authCode = resultEndpointDataReferenceStatus.endpointDataReference().getAuthCode();
+                if (authCode == null) {
                     throw new IllegalStateException("Missing information about AuthKey.");
                 }
-                contractAgreementId = EDRAuthCode.fromAuthCodeToken(authKey).getCid();
+                log.error("AuthCode to be parsed: " + authCode);
+                contractAgreementId = EDRAuthCode.fromAuthCodeToken(authCode).getCid();
                 log.info(
                         "Cached endpoint data reference has expired token. Refreshing token without new contract negotiation for contractAgreementId: {}",
                         Masker.mask(contractAgreementId));

diff --git a/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java b/irs-edc-client/src/main/java/org/eclipse/tractusx/irs/edc/client/EdcSubmodelClientImpl.java
@@ -234,11 +234,11 @@ private static String getStorageId(final EndpointDataReferenceStatus endpointDat
         if (response != null) {
             storageId = response.getContractAgreementId();
         } else {
-            final String authKey = endpointDataReferenceStatus.endpointDataReference().getAuthKey();
-            if (authKey == null) {
-                throw new IllegalStateException("Missing information about AuthKey.");
+            final String authCode = endpointDataReferenceStatus.endpointDataReference().getAuthCode();
+            if (authCode == null) {
+                throw new IllegalStateException("Missing information about AuthCode.");
             }
-            storageId = EDRAuthCode.fromAuthCodeToken(authKey).getCid();
+            storageId = EDRAuthCode.fromAuthCodeToken(authCode).getCid();
         }
         return storageId;
     }

diff --git a/...ent/src/test/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationServiceTest.java b/...ent/src/test/java/org/eclipse/tractusx/irs/edc/client/ContractNegotiationServiceTest.java
@@ -226,11 +226,11 @@ void shouldNotStartNewNegotiationWhenTokenIsExpired()
                 Response.builder().responseId("transferProcessId").build());
         when(edcControlPlaneClient.getTransferProcess(any())).thenReturn(
                 CompletableFuture.completedFuture(TransferProcessResponse.builder().build()));
-        final String encodedAuthKey = "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MDA3NDc0NjMsImRhZCI6IkFXanRhclZySVdtaVE4V1R4VGV2YVhUS1p5SERUZ3pkWG1oMWpkdTR3QUxkTTZVaEgyVHVCOXhhS2Z6TmJQQTZVQVhnVDc2NytPMTgwUXltMGNFdks0NGxzakZQbkROTFQwOEpBOGxvazg0a3hScktFdSswRDZFMmlzTUNPM1Zaa2ZmNDB1U2d6YmJVTDR1djNGNGYxdVp6RnRZT2VvcDdjOUFUc2k1WHhyaGZLdkdDOERrRi9idTBaQmY1US9nMy9xS3QwY0FmcW9TNUxWSlN1SVhKdUk4S2JNSldob2hLZ1NRb2tLMWxNQzVpSVRhbWZ2L0FvZUNXMnB1bkc1R0twM1NTak9Da1hJL3ZXQlRTNWVFTzRpYkwvL1JSZGdJdVp3K2dzcHVVMkFtYm04YzZFQjViQjlPYWhhYjRzRCtnTldDcWFZazZWQ1p4Ty9xaUlKT1RZVGo0b3pDVnovcE5VN0l6R1hBWjNaamtNRWRMbUJVclhDSFRtaU1GeGd5bkxQN2hBVmN5M2NOVGhIb0FtZDI1c2ZwbUdTeHViS1FmSHM2RUNFajByYS9lT001dHNqZ2l5N3JOOUhQT25zWFppL01yMWR1UDE4c0hGQmVLeWFNNkwveFN6TTlCUVplb0Z2TVE5VmlmSm1hMUQ5WklrNUhhTnBmc0RQSElBK0VLL0hGSG1mRWk1TGhoS3lVY3Q2VGpQb0VKa25WamJBSU01VXUzSW1oV3NFdkVLR3lvZXQ0UEhYeHBVWlhQWFdjSjd0dk8zZms3YjczOEVRVEV6Y29KTFdZd0wrRDZac1hJVjd4UzFOOTV4WDlqcU9aUjBuSGsxb3lmT21KUTg5UkpxZy91eE01L3lPcFJUWU01OWJGTzJBRWVDa0UwM0k2aUY0NE1xQU1VVzM4bGk4eDFkY3A0ajQ3Z0lKMlFrWTM5bHI1VXRpbEFzcjVZMkN5Nm5hcVFIeFU2TW1LS0RFdVQrUXdxTFZGYVB5SC9ZM2dTOFpZdlh3TlVOams4S2k4T2JFTTVUY25nUWxVK0Y0dE9BeTQ0bjNPckpWYlhIcVBud1N4L2ZmbTdKdVRnZjRlMVpPcThhdz09IiwiY2lkIjoiT1dZeFlqa3dZelV0TldFNVlTMDBaR1UyTFRoaVpXTXROalprWTJaaVlqTXdPREZtOmNtVm5hWE4wY25rdFlYTnpaWFE9Ok1XWXlZMll5TmpVdE56STROQzAwTnpFNUxXSTNOVGt0TWpSbFpqY3habU13WWpaaSJ9.HDhEMOGVlwOTAFIKCCUzf_twg08K-rQwElNS2foinB9hRM-htLwoXayMtbXdXS4pFevRn1AXhzcxd5ur7gslJdsNohTiwVP0lXRd0cehWMpRKdDiUCLn4lh0A2fFTYpoX4WIXvqldAADxi0qDmZqLTZdSOqkM40t-Fq8esyFMrO_uC6GL8LUQMLML1HV6nqGkqp-VELEoOMTV1-aVQ-OEv0J24epjNyesx448v0yylhS_vxPmay1zeSJgDCwqzSuY5-EkyIfCN1XqbynMZiNtD2FLbAig0KTAL2rN6WMufSWMjgLUU0mhRbd9bWvqs3JKLVzvagQgS3hMTj5a-C2Tw";
+        final String encodedAuthCode = "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MDA3NDc0NjMsImRhZCI6IkFXanRhclZySVdtaVE4V1R4VGV2YVhUS1p5SERUZ3pkWG1oMWpkdTR3QUxkTTZVaEgyVHVCOXhhS2Z6TmJQQTZVQVhnVDc2NytPMTgwUXltMGNFdks0NGxzakZQbkROTFQwOEpBOGxvazg0a3hScktFdSswRDZFMmlzTUNPM1Zaa2ZmNDB1U2d6YmJVTDR1djNGNGYxdVp6RnRZT2VvcDdjOUFUc2k1WHhyaGZLdkdDOERrRi9idTBaQmY1US9nMy9xS3QwY0FmcW9TNUxWSlN1SVhKdUk4S2JNSldob2hLZ1NRb2tLMWxNQzVpSVRhbWZ2L0FvZUNXMnB1bkc1R0twM1NTak9Da1hJL3ZXQlRTNWVFTzRpYkwvL1JSZGdJdVp3K2dzcHVVMkFtYm04YzZFQjViQjlPYWhhYjRzRCtnTldDcWFZazZWQ1p4Ty9xaUlKT1RZVGo0b3pDVnovcE5VN0l6R1hBWjNaamtNRWRMbUJVclhDSFRtaU1GeGd5bkxQN2hBVmN5M2NOVGhIb0FtZDI1c2ZwbUdTeHViS1FmSHM2RUNFajByYS9lT001dHNqZ2l5N3JOOUhQT25zWFppL01yMWR1UDE4c0hGQmVLeWFNNkwveFN6TTlCUVplb0Z2TVE5VmlmSm1hMUQ5WklrNUhhTnBmc0RQSElBK0VLL0hGSG1mRWk1TGhoS3lVY3Q2VGpQb0VKa25WamJBSU01VXUzSW1oV3NFdkVLR3lvZXQ0UEhYeHBVWlhQWFdjSjd0dk8zZms3YjczOEVRVEV6Y29KTFdZd0wrRDZac1hJVjd4UzFOOTV4WDlqcU9aUjBuSGsxb3lmT21KUTg5UkpxZy91eE01L3lPcFJUWU01OWJGTzJBRWVDa0UwM0k2aUY0NE1xQU1VVzM4bGk4eDFkY3A0ajQ3Z0lKMlFrWTM5bHI1VXRpbEFzcjVZMkN5Nm5hcVFIeFU2TW1LS0RFdVQrUXdxTFZGYVB5SC9ZM2dTOFpZdlh3TlVOams4S2k4T2JFTTVUY25nUWxVK0Y0dE9BeTQ0bjNPckpWYlhIcVBud1N4L2ZmbTdKdVRnZjRlMVpPcThhdz09IiwiY2lkIjoiT1dZeFlqa3dZelV0TldFNVlTMDBaR1UyTFRoaVpXTXROalprWTJaaVlqTXdPREZtOmNtVm5hWE4wY25rdFlYTnpaWFE9Ok1XWXlZMll5TmpVdE56STROQzAwTnpFNUxXSTNOVGt0TWpSbFpqY3habU13WWpaaSJ9.HDhEMOGVlwOTAFIKCCUzf_twg08K-rQwElNS2foinB9hRM-htLwoXayMtbXdXS4pFevRn1AXhzcxd5ur7gslJdsNohTiwVP0lXRd0cehWMpRKdDiUCLn4lh0A2fFTYpoX4WIXvqldAADxi0qDmZqLTZdSOqkM40t-Fq8esyFMrO_uC6GL8LUQMLML1HV6nqGkqp-VELEoOMTV1-aVQ-OEv0J24epjNyesx448v0yylhS_vxPmay1zeSJgDCwqzSuY5-EkyIfCN1XqbynMZiNtD2FLbAig0KTAL2rN6WMufSWMjgLUU0mhRbd9bWvqs3JKLVzvagQgS3hMTj5a-C2Tw";
 
         // when
         testee.negotiate(CONNECTOR_URL, catalogItem, new EndpointDataReferenceStatus(
-                EndpointDataReference.Builder.newInstance().authKey(encodedAuthKey).endpoint("").authCode("").build(),
+                EndpointDataReference.Builder.newInstance().authKey("").authCode(encodedAuthCode).endpoint("").build(),
                 EndpointDataReferenceStatus.TokenStatus.EXPIRED));
 
         // then