[DATA_SOV] Creation of CatlogOffers for notifications at runtime

[mkanal]

As admin
I want CatalogOffers for notifications are created at runtime
so that CatalogOffers for notifications are using always the current policy defined for the receiver BPNL

Hints / Details

• https://app.swaggerhub.com/apis/eclipse-tractusx-bot/tractusx-edc/0.5.3#/

Test-Scenario:

1. TXa and TXb have the same policy, notification sending works without problems
2. TXb creates a new policy that points to the own BPN of TXb
3. The catalog offers for negotiations are updated for TXb
4. TXa is no longer able to send notifications to TXb, since the offer from TXb does not match the default policy of TXa
5. TXb is still able to send notifications to TXa
6. TXa also creates a policy that matches the new policy of TXb
7. TXa is now able to send notifications again to TXb

Acceptance Criteria

• CatalogOffer for notifications are always created or updated when notification to be sent on latest policy for BPNL or default policy
• GIVEN notification to be sent WHEN no policy defined for receiver BPNL THEN Notification CatalogOffer is created with default policy
• GIVEN notification to be sent WHEN policy defined for receiver BPNL THEN Notification CatalogOffer is created with policy defined for receiver BPNL
• Removing the logic for creatiom of notification CatalogOffers at app startup
• Dynamic creation of CatlogOffers for notifications in runtime with corresponding policies

Notification-Flow

Company BMW (BPNL0000BMW) sends notification to ZF (BPNL0000ZF)

sequenceDiagram
%%{init: {'theme': 'dark', 'themeVariables': { 'fontSize': '15px'}}}%%
autonumber

actor Superior
participant Trace_X_FE as "Trace-X"
participant Trace_X as "Trace-X BMW"
participant EDC_S as "EDC Supplier"
participant  PolicyStore

Superior ->> Trace_X_FE: Send notification
Trace_X_FE ->> Trace_X : Send notification
Trace_X ->> EDC_S : Get Notification CatalogOffer of EDC_S
EDC_S -->> Trace_X : return CatalogOffer
Trace_X -->> PolicyStore : Get Policy for BPNL or default policy
Trace_X -->> Trace_X: check Policy of CatalogOffer with Policy from PolicyStore
alt valid
Trace_X ->> EDC_S : negotiateContract
EDC_S -->> Trace_X: contract negotation successful
Trace_X ->> EDC_S :  send notification
EDC_S --> Trace_X: ok
else
Trace_X -> Trace_X : create tombstone
Trace_X -->> Trace_X_FE : show  policy mismatch
Trace_X_FE -->> Superior : show  policy mismatch
end

Loading

Company Superior BMW edits policy (not default)

sequenceDiagram
    %%{init: {'theme': 'dark', 'themeVariables': { 'fontSize': '15px'}}}%%
    autonumber

    actor Superior
    participant Trace_X
    participant PolicyStore
    participant EDC


    Superior ->> Trace_X: Edit an existing policy
    Superior ->> Trace_X: Check whether the policy is linked to a published notification CatlogOffer.
    alt true
        Trace_X -->> EDC : Update notification DataOffers to new policy (PUT /v2/contractdefinitions)
        EDC -->> Trace_X : ok
        Trace_X ->> PolicyStore : save policy
        PolicyStore -->> Trace_X : ok
        Trace_X -->> Superior : policy saved
    else false
        Trace_X ->> PolicyStore : edit policy
        PolicyStore -->> Trace_X : ok
        Trace_X -->> Superior : policy saved
    end

Loading

Company SuperiorBMW deletes policy (not default)

sequenceDiagram
    %%{init: {'theme': 'dark', 'themeVariables': { 'fontSize': '15px'}}}%%
    autonumber

    actor Superior
    participant Trace_X
    participant PolicyStore
    participant EDC


    Superior ->> Trace_X: Delete an existing policy
    Superior ->> Trace_X: Check whether the policy is linked to a notification .
    alt true
       Trace_X -->> EDC : Delete outdated DataOffer in EDC
        EDC -->> Trace_X : ok
        Trace_X -->> EDC : Update  DataOffer to defaul policy in EDC (PUT /v2/contractdefinitions)
        EDC -->> Trace_X : ok
        Trace_X ->> PolicyStore : delete policy
        PolicyStore -->> Trace_X : ok
        Trace_X -->> Superior : policy delete
    else false
        Trace_X ->> PolicyStore : delete policy
        PolicyStore -->> Trace_X : ok
        Trace_X -->> Superior : policy deleted
    end

Loading

Out of Scope

• ...

[ds-lcapellino]

Things to consider / findings after this story:

• on a clean environment, the default policy is created on startup. If we add a new policy with a BPN that doesn't match the own policy, the default policy is deleted and only the new policy with another BPN is shown. This does not cause any updated on the catalog offers.
• Trace-X currently does not care about the BPN in the policy. For example, if you create a policy for BPNX, and want to send a notification to BPNX, all policies in the policy store are checked and the first matching will be taken.
• we can create multiple policies for a BPN. How should this be handled? We implemented the following for updating notification offers: If a second policy is created for the own BPN, the newest policy for the own BPN will be used for updating notification offers

[ds-crehm]

Replicated the test scenario successfully on e2e.
After creating a policy for TX-B, TX-A -> TX-B notifications were not possible anymore but the other way still worked.
After creating the same policy for TX-A, sending the notification worked:

Ready for review.

[mkanal]

LGFM. PO acceptance in behalf of @jzbmw.
Data sov clear