Custom shopping cart check API plugin not working for Angular Shop 9.3.1

[gitpm]

Is this a regression?

Yes

Severity

🟠 Major – significantly affects usability

Please provide the branch(es) you discovered this issue in

v93

Environment Details

edge

Please provide a minimal set of steps to reproduce the issue

1. Create a custom shopping cart check in the API according to the official documentation.
   see: https://github.com/OneIdentity/IdentityManager.ApiSdk/blob/v93/doc/05-composition-api-plugins.md

2. Fix the custom shopping cart item check by adding an empty constructor to the Sample CartItemCheck.
   (Annotation if you don't fix it you will get an error during runtime)

add: "public SampleCheck() { } " to the code

public class SampleCheck : ICartItemCheck    { 
        private readonly ICartItemCheckContext _context;  
        public SampleCheck() { }  '<-- add this line !!! 
        public SampleCheck(ICartItemCheckContext context) {  
           ...

=> result; no servor occurs during runtime

3. Modify the SampleCheck- ProcessAsync-Task, in that way that the task always sets the Status to: CheckStatus.Error

internal async Task ProcessAsync(CancellationToken ct = default)        {
             Status = CheckStatus.Error; '<-- set Status to Error, independent from context
   }

public CheckStatus Status { get; set; } = CheckStatus.Pending;

4. Add three products to the shopping cart
5. Goto the shopping cart
6. Perform a check to the shopping cart

Description

The modified SampleCheck: ICartItemCheck was modified to return always CheckStatus: Error;
Hence all(!!!) products should have the CheckStatus: Error

But in UI-Result only one Product has a CheckStatus: Error, where else the other two products are marked with CheckStatus: ok:

Describe what you expected to happen versus what actually happened

As the SampleCheck always returns CheckStatus.Error in this case all three products should be marked to have an "Fehler" in the ui

Relevant logs or console output

Add a screenshot(s) if that helps illustrate the problem

No response

Suggested Fix

No response

Anything else?

The fact that the SampleCheck - class is instantiated without an context is an error in itself, because a SampleCheck - instance without a context cannot decide if the status is error or success and therefore it makes no sense. But exactly this happens. So I assume that is already the error. I assume if you find the codeline where the ICartItemCheck is instantiated without a context you found the bug.

Before submitting...

• I have searched for existing issues that match this one on github and on the community support page
• I have included all necessary details to reproduce this issue

[asattler]

Hi Peter,

thanks for raising this. I didn't notice, even though my project is live with 9.3.1 for 6 months now...
I was able to verify your issue and I also found a possible solution.
The misunderstanding (or better: wrong or imcomplete example in the SDK) is that it's not clear that the ICartCheck.CheckAsync is called for each item in the cart. Which means that with example code:

public Task<IReadOnlyList<ICartItemCheck>> CheckAsync(ICartItemCheckContext context, CancellationToken ct = default)
    {
        // Set up the individual ICartItemCheck object(s) and return them.
        _check = new SampleCheck(context);
        return Task.FromResult<IReadOnlyList<ICartItemCheck>>(new[]
        {
            _check
        });
    }

you're always returning an array with one check to proceed, which seems to overwrite the previous collection.
So instead of doing this, create a list and maintain it.

So my proposed solution is:

public class SampleCartCheck : ICartCheck
{
    private List<SampleCheck> _checks = [];

    // This method is called when a shopping cart must be checked.
    public Task<IReadOnlyList<ICartItemCheck>> CheckAsync(ICartItemCheckContext context, CancellationToken ct = default)
    {
        // Set up the individual ICartItemCheck object(s) and return them.
        _checks.Add(new SampleCheck(context));
        return Task.FromResult<IReadOnlyList<ICartItemCheck>>(_checks);
        
    }

    public Task ProcessAsync(CancellationToken ct = default)
    {
        List<Task> tasks = [];
        foreach(var check in _checks)
        {
            tasks.Add(check.ProcessAsync(ct));
        }
        return Task.WhenAll([.. tasks]);
    }
}

I did a short test and it seems to work.
Feel free to review and use :)

BR

Andreas

[asattler]

My proposed solution doesn't seem to be the 100%. The web results now show multiple results per item...
Seems like I need to invest a little more time. If you find a solution, please share with us @gitpm :)