[MOB-22283] Exposing new API for generateDisplayXDM for batching multiple display propositions

[siddique-adobe]

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[spoorthipujariadobe]

Couple of things before I start the PR review:

1. Please provide a description of what is being done in this PR and why
2. CI jobs did not run for this PR. Please have a look to figure out why
3. Why is this PR being raised in your forked repo? Please create it again https://github.com/adobe/aepsdk-optimize-android
4. Please add docs, unit tests and functional tests for the new APIs you have introduced

[spoorthipujariadobe]

There was a public API getProposition . With the way its refactored here, that method no longer exists, making this a breaking change.
We're also making propositionReference public when it was not before

[spoorthipujariadobe]

You will need to do something like this to achieve parity

    @get:JvmName("getPropositionReference")
    @set:JvmName("setPropositionReference")
    internal var propositionReference: SoftReference<OptimizeProposition>? = null
    var proposition = propositionReference?.get()
        private set

[spoorthipujariadobe]

Same comment here
...XDM formatted data for {@code Experience Event OptimizeProposition Interactions} field group from {@code Offer} list.

[siddique-adobe]

done @spoorthipujariadobe

[spoorthipujariadobe]

Objects.requireNonNull would throw a null pointer exception if toUniquePropositionsList returns null, which would cause a RuntimeException and app will crash. Can we handle this gracefully? Either we can throw the exception so the app can handle it or we can do a null check for result of toUniquePropositionsList and fail fast without calling OptimizeUtils.generateInteractionXdm

[siddique-adobe]

updated @spoorthipujariadobe

[spoorthipujariadobe]

The logic here in conjunction with OptimizeUtils.generateInteractionXdm doesn't achieve our goal. You're creating a list of proposition reference for the list of offers passed in. Then in OptimizeUtils.generateInteractionXdm you're adding all the offer ids in the proposition to the display events, rather only the ids of offer list that was passed to the API.
https://github.com/siddique-adobe/aepsdk-optimize-android/pull/3/files#diff-b90c589ff2ce5c066bb12f60a6b2ce62e77b4fede59cbe980f944bd99f45680dR288

[siddique-adobe]

Please review this again, I've fixed the missing logic here @spoorthipujariadobe

[spoorthipujariadobe]

nit: Add @Nullable annotation to the API signature

[spoorthipujariadobe]

Please make sure to add tests in the PR opened against the Optimize repo