Merge pull request #138 from catenax-ng/main

Add correct BPN handling in graph traversal

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.3.0] - 2023-07-20
+### Changed
+- BPN is now taken from the submodel data while traversing the item graph
+- Tombstone is created if no BPN is available for a child item
+
 ## [3.2.1] - 2023-07-19
 ### Fixed
 - EDC Policies now get validated regardless of the type of constraint.
@@ -282,7 +287,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Unresolved
 - **Select Aspects you need**  You are able to select the needed aspects for which you want to collect the correct endpoint information.
 
-[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.2.1...HEAD
+[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.3.0...HEAD
+[3.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.2.1...3.3.0
 [3.2.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.2.0...3.2.1
 [3.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.1.0...3.2.0
 [3.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/3.0.1...3.1.0

charts/irs-helm/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.3.0] - 2023-07-20
+### Changed
+- Update IRS version to 3.3.0
+
 ## [6.2.1] - 2023-07-19
 ### Changed
 - Update IRS version to 3.2.1

charts/irs-helm/Chart.yaml

@@ -35,12 +35,12 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 6.2.1
+version: 6.3.0
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "3.2.1"
+appVersion: "3.3.0"
 dependencies:
   - name: common
     repository: https://charts.bitnami.com/bitnami

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/AASRecursiveJobHandler.java

@@ -25,6 +25,7 @@
 import java.util.stream.Stream;
 
 import lombok.extern.slf4j.Slf4j;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.connector.job.MultiTransferJob;
 import org.eclipse.tractusx.irs.connector.job.RecursiveJobHandler;
 
@@ -44,7 +45,9 @@ public AASRecursiveJobHandler(final TreeRecursiveLogic logic) {
     public Stream<ItemDataRequest> initiate(final MultiTransferJob job) {
         log.info("Initiating request for job {}", job.getJobIdString());
         final var partId = job.getGlobalAssetId();
-        final var dataRequest = ItemDataRequest.rootNode(partId);
+        final var bpn = job.getJobParameter().getBpn();
+        final var dataRequest = ItemDataRequest.rootNode(
+                PartChainIdentificationKey.builder().globalAssetId(partId).bpn(bpn).build());
         return Stream.of(dataRequest);
     }
 

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/AASTransferProcess.java

@@ -29,6 +29,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.connector.job.TransferProcess;
 
 /**
@@ -40,12 +41,12 @@
 @ToString
 public class AASTransferProcess implements TransferProcess {
 
-    private final List<String> idsToProcess = new ArrayList<>();
+    private final List<PartChainIdentificationKey> idsToProcess = new ArrayList<>();
     @SuppressWarnings("PMD.ShortVariable")
     private String id;
     private Integer depth;
 
-    public void addIdsToProcess(final List<String> childIds) {
+    public void addIdsToProcess(final List<PartChainIdentificationKey> childIds) {
         idsToProcess.addAll(childIds);
     }
 

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/AASTransferProcessManager.java

@@ -34,6 +34,7 @@
 import org.eclipse.tractusx.irs.common.persistence.BlobPersistence;
 import org.eclipse.tractusx.irs.common.persistence.BlobPersistenceException;
 import org.eclipse.tractusx.irs.component.JobParameter;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.connector.job.ResponseStatus;
 import org.eclipse.tractusx.irs.connector.job.TransferInitiateResponse;
 import org.eclipse.tractusx.irs.connector.job.TransferProcessManager;
@@ -80,7 +81,7 @@ private Runnable getRunnable(final ItemDataRequest dataRequest,
         return () -> {
             final AASTransferProcess aasTransferProcess = new AASTransferProcess(processId, dataRequest.getDepth());
 
-            final String itemId = dataRequest.getItemId();
+            final PartChainIdentificationKey itemId = dataRequest.getItemId();
 
             log.info("Starting processing Digital Twin Registry with itemId {}", itemId);
             final ItemContainer itemContainer = abstractDelegate.process(ItemContainer.builder(), jobData,

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/ItemDataRequest.java

@@ -23,6 +23,7 @@
 package org.eclipse.tractusx.irs.aaswrapper.job;
 
 import lombok.Value;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.connector.job.DataRequest;
 
 /**
@@ -31,14 +32,14 @@
 @Value
 public class ItemDataRequest implements DataRequest {
 
-    private final String itemId;
+    private final PartChainIdentificationKey itemId;
     private final Integer depth;
 
-    public static ItemDataRequest rootNode(final String itemId) {
+    public static ItemDataRequest rootNode(final PartChainIdentificationKey itemId) {
         return new ItemDataRequest(itemId, 0);
     }
 
-    public static ItemDataRequest nextDepthNode(final String itemId, final Integer currentDepth) {
+    public static ItemDataRequest nextDepthNode(final PartChainIdentificationKey itemId, final Integer currentDepth) {
         return new ItemDataRequest(itemId, currentDepth + 1);
     }
 }

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/AbstractDelegate.java

@@ -35,6 +35,7 @@
 import org.eclipse.tractusx.irs.aaswrapper.job.AASTransferProcess;
 import org.eclipse.tractusx.irs.aaswrapper.job.ItemContainer;
 import org.eclipse.tractusx.irs.component.JobParameter;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.component.assetadministrationshell.Endpoint;
 import org.eclipse.tractusx.irs.edc.client.EdcSubmodelFacade;
 import org.eclipse.tractusx.irs.edc.client.ItemNotFoundInCatalogException;
@@ -62,7 +63,7 @@ public abstract class AbstractDelegate {
      * and Tombstones (if requests fail).
      */
     public abstract ItemContainer process(ItemContainer.ItemContainerBuilder itemContainerBuilder, JobParameter jobData,
-            AASTransferProcess aasTransferProcess, String itemId);
+            AASTransferProcess aasTransferProcess, PartChainIdentificationKey itemId);
 
     /**
      * Delegates processing to next step if exists or returns filled {@link ItemContainer}
@@ -75,7 +76,8 @@ public abstract ItemContainer process(ItemContainer.ItemContainerBuilder itemCon
      * @return item container with filled data
      */
     protected ItemContainer next(final ItemContainer.ItemContainerBuilder itemContainerBuilder,
-            final JobParameter jobData, final AASTransferProcess aasTransferProcess, final String itemId) {
+            final JobParameter jobData, final AASTransferProcess aasTransferProcess,
+            final PartChainIdentificationKey itemId) {
         if (this.nextStep != null) {
             return this.nextStep.process(itemContainerBuilder, jobData, aasTransferProcess, itemId);
         }
@@ -91,7 +93,11 @@ protected String requestSubmodelAsString(final EdcSubmodelFacade submodelFacade,
         for (final String connectorEndpoint : connectorEndpoints) {
             addSubmodelToList(submodelFacade, endpoint, submodelPayload, connectorEndpoint);
         }
-        return submodelPayload.stream().findFirst().orElseThrow();
+        return submodelPayload.stream()
+                              .findFirst()
+                              .orElseThrow(() -> new EdcClientException(String.format(
+                                      "Called %s connectorEndpoints but did not get any submodels. Connectors: '%s'",
+                                      connectorEndpoints.size(), String.join(", ", connectorEndpoints))));
     }
 
     private void addSubmodelToList(final EdcSubmodelFacade submodelFacade, final Endpoint endpoint,

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/BpdmDelegate.java

@@ -31,6 +31,7 @@
 import org.eclipse.tractusx.irs.bpdm.BpdmFacade;
 import org.eclipse.tractusx.irs.component.Bpn;
 import org.eclipse.tractusx.irs.component.JobParameter;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.component.Tombstone;
 import org.eclipse.tractusx.irs.component.enums.ProcessStep;
 import org.springframework.web.client.RestClientException;
@@ -53,7 +54,7 @@ public BpdmDelegate(final AbstractDelegate nextStep, final BpdmFacade bpdmFacade
 
     @Override
     public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContainerBuilder,
-            final JobParameter jobData, final AASTransferProcess aasTransferProcess, final String itemId) {
+            final JobParameter jobData, final AASTransferProcess aasTransferProcess, final PartChainIdentificationKey itemId) {
 
         if (jobData.isLookupBPNs()) {
             log.debug("BPN Lookup enabled, collecting BPN information");
@@ -65,12 +66,12 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai
             try {
                 itemContainerBuilder.build()
                                     .getBpns()
-                                    .forEach(bpn -> lookupBPN(itemContainerBuilder, itemId, bpn,
+                                    .forEach(bpn -> lookupBPN(itemContainerBuilder, itemId.getGlobalAssetId(), bpn,
                                             requestMetric));
             } catch (final RestClientException e) {
                 log.info("Business Partner endpoint could not be retrieved for Item: {}. Creating Tombstone.", itemId);
                 requestMetric.incrementFailed();
-                itemContainerBuilder.tombstone(Tombstone.from(itemId, null, e, retryCount, ProcessStep.BPDM_REQUEST));
+                itemContainerBuilder.tombstone(Tombstone.from(itemId.getGlobalAssetId(), null, e, retryCount, ProcessStep.BPDM_REQUEST));
             }
         } else {
             log.debug("BPN lookup disabled, no BPN information will be collected.");

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/DigitalTwinDelegate.java

@@ -28,6 +28,7 @@
 import org.eclipse.tractusx.irs.aaswrapper.job.AASTransferProcess;
 import org.eclipse.tractusx.irs.aaswrapper.job.ItemContainer;
 import org.eclipse.tractusx.irs.component.JobParameter;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.component.Tombstone;
 import org.eclipse.tractusx.irs.component.enums.ProcessStep;
 import org.eclipse.tractusx.irs.registryclient.DigitalTwinRegistryKey;
@@ -52,15 +53,15 @@ public DigitalTwinDelegate(final AbstractDelegate nextStep,
 
     @Override
     public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContainerBuilder, final JobParameter jobData,
-            final AASTransferProcess aasTransferProcess, final String itemId) {
+            final AASTransferProcess aasTransferProcess, final PartChainIdentificationKey itemId) {
 
         try {
             itemContainerBuilder.shell(digitalTwinRegistryService.fetchShells(
-                    List.of(new DigitalTwinRegistryKey(itemId, jobData.getBpn()))
+                    List.of(new DigitalTwinRegistryKey(itemId.getGlobalAssetId(), itemId.getBpn()))
             ).stream().findFirst().orElseThrow());
         } catch (final RestClientException | RegistryServiceException e) {
             log.info("Shell Endpoint could not be retrieved for Item: {}. Creating Tombstone.", itemId);
-            itemContainerBuilder.tombstone(Tombstone.from(itemId, null, e, retryCount, ProcessStep.DIGITAL_TWIN_REQUEST));
+            itemContainerBuilder.tombstone(Tombstone.from(itemId.getGlobalAssetId(), null, e, retryCount, ProcessStep.DIGITAL_TWIN_REQUEST));
         }
 
         if (expectedDepthOfTreeIsNotReached(jobData.getDepth(), aasTransferProcess.getDepth())) {

irs-api/src/main/java/org/eclipse/tractusx/irs/aaswrapper/job/delegate/RelationshipDelegate.java

@@ -25,12 +25,12 @@
 import java.util.List;
 
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
 import org.eclipse.tractusx.irs.aaswrapper.job.AASTransferProcess;
 import org.eclipse.tractusx.irs.aaswrapper.job.ItemContainer;
 import org.eclipse.tractusx.irs.component.Bpn;
-import org.eclipse.tractusx.irs.component.GlobalAssetIdentification;
 import org.eclipse.tractusx.irs.component.JobParameter;
-import org.eclipse.tractusx.irs.component.LinkedItem;
+import org.eclipse.tractusx.irs.component.PartChainIdentificationKey;
 import org.eclipse.tractusx.irs.component.Relationship;
 import org.eclipse.tractusx.irs.component.Tombstone;
 import org.eclipse.tractusx.irs.component.assetadministrationshell.Endpoint;
@@ -66,7 +66,8 @@ public RelationshipDelegate(final AbstractDelegate nextStep, final EdcSubmodelFa
 
     @Override
     public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContainerBuilder,
-            final JobParameter jobData, final AASTransferProcess aasTransferProcess, final String itemId) {
+            final JobParameter jobData, final AASTransferProcess aasTransferProcess,
+            final PartChainIdentificationKey itemId) {
 
         final RelationshipAspect relationshipAspect = RelationshipAspect.from(jobData.getBomLifecycle(),
                 jobData.getDirection());
@@ -76,24 +77,34 @@ public ItemContainer process(final ItemContainer.ItemContainerBuilder itemContai
                             .findFirst()
                             .ifPresent(shell -> shell.findRelationshipEndpointAddresses(
                                                              AspectType.fromValue(relationshipAspect.getName()))
-                                                     .forEach(endpoint -> processEndpoint(endpoint, jobData,
-                                                             relationshipAspect, aasTransferProcess,
-                                                             itemContainerBuilder, itemId)));
+                                                     .forEach(endpoint -> processEndpoint(endpoint, relationshipAspect,
+                                                             aasTransferProcess, itemContainerBuilder, itemId)));
 
         return next(itemContainerBuilder, jobData, aasTransferProcess, itemId);
     }
 
-    private void processEndpoint(final Endpoint endpoint, final JobParameter jobData,
-            final RelationshipAspect relationshipAspect, final AASTransferProcess aasTransferProcess,
-            final ItemContainer.ItemContainerBuilder itemContainerBuilder, final String itemId) {
+    private void processEndpoint(final Endpoint endpoint, final RelationshipAspect relationshipAspect,
+            final AASTransferProcess aasTransferProcess, final ItemContainer.ItemContainerBuilder itemContainerBuilder,
+            final PartChainIdentificationKey itemId) {
+
+        if (StringUtils.isBlank(itemId.getBpn())) {
+            log.warn("Could not process item with id {} because no BPN was provided. Creating Tombstone.",
+                    itemId.getGlobalAssetId());
+            itemContainerBuilder.tombstone(
+                    Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(),
+                            "Can't get relationship without a BPN", retryCount, ProcessStep.SUBMODEL_REQUEST));
+            return;
+        }
+
         try {
             final String submodelRawPayload = requestSubmodelAsString(submodelFacade, connectorEndpointsService,
-                    endpoint, jobData.getBpn());
+                    endpoint, itemId.getBpn());
 
             final var relationships = jsonUtil.fromString(submodelRawPayload, relationshipAspect.getSubmodelClazz())
                                               .asRelationships();
 
-            final List<String> idsToProcess = getIdsToProcess(relationships, relationshipAspect.getDirection());
+            final List<PartChainIdentificationKey> idsToProcess = getIdsToProcess(relationships,
+                    relationshipAspect.getDirection());
 
             log.info("Processing Relationships with {} items", idsToProcess.size());
 
@@ -104,39 +115,46 @@ private void processEndpoint(final Endpoint endpoint, final JobParameter jobData
             log.info("Submodel Endpoint could not be retrieved for Endpoint: {}. Creating Tombstone.",
                     endpoint.getProtocolInformation().getHref());
             itemContainerBuilder.tombstone(
-                    Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), e, retryCount,
-                            ProcessStep.SUBMODEL_REQUEST));
+                    Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(), e,
+                            retryCount, ProcessStep.SUBMODEL_REQUEST));
         } catch (final JsonParseException e) {
             log.info("Submodel payload did not match the expected AspectType. Creating Tombstone.");
             itemContainerBuilder.tombstone(
-                    Tombstone.from(itemId, endpoint.getProtocolInformation().getHref(), e, retryCount,
-                            ProcessStep.SUBMODEL_REQUEST));
+                    Tombstone.from(itemId.getGlobalAssetId(), endpoint.getProtocolInformation().getHref(), e,
+                            retryCount, ProcessStep.SUBMODEL_REQUEST));
         }
     }
 
     private static List<Bpn> getBpnsFrom(final List<Relationship> relationships) {
         return relationships.stream().map(Relationship::getBpn).map(Bpn::withManufacturerId).toList();
     }
 
-    private List<String> getIdsToProcess(final List<Relationship> relationships, final Direction direction) {
+    private List<PartChainIdentificationKey> getIdsToProcess(final List<Relationship> relationships,
+            final Direction direction) {
         return switch (direction) {
             case DOWNWARD -> getChildIds(relationships);
             case UPWARD -> getParentIds(relationships);
         };
     }
 
-    private List<String> getParentIds(final List<Relationship> relationships) {
+    private List<PartChainIdentificationKey> getParentIds(final List<Relationship> relationships) {
         return relationships.stream()
-                            .map(Relationship::getCatenaXId)
-                            .map(GlobalAssetIdentification::getGlobalAssetId)
+                            .map(relationship -> PartChainIdentificationKey.builder()
+                                                                           .globalAssetId(relationship.getCatenaXId()
+                                                                                                      .getGlobalAssetId())
+                                                                           .bpn(relationship.getBpn())
+                                                                           .build())
                             .toList();
     }
 
-    private List<String> getChildIds(final List<Relationship> relationships) {
+    private List<PartChainIdentificationKey> getChildIds(final List<Relationship> relationships) {
         return relationships.stream()
-                            .map(Relationship::getLinkedItem)
-                            .map(LinkedItem::getChildCatenaXId)
-                            .map(GlobalAssetIdentification::getGlobalAssetId)
+                            .map(relationship -> PartChainIdentificationKey.builder()
+                                                                           .globalAssetId(relationship.getLinkedItem()
+                                                                                                      .getChildCatenaXId()
+                                                                                                      .getGlobalAssetId())
+                                                                           .bpn(relationship.getBpn())
+                                                                           .build())
                             .toList();
     }
 }