Add `currentOffering(forPlacement: String)` to `Offerings` by guido732 · Pull Request #3707 · RevenueCat/purchases-ios

guido732 · 2024-02-22T19:42:16Z

Motivation

New function to get Offering by a placement identifier

Description

New currentOffering(forPlacement: String): Offering? method on Offerings

Added demo button for this in purchase tester app

// Example usage
if let offering = offerings.currentOffering(forPlacement: "onboarding") {
  showPaywall(offering)
}

Logic flow

If a placement identifier explicitly exists within the placements.offeringIdsByPlacement dictionary, the method attempts to fetch the corresponding Offering without resorting to a fallback
- Example: when there is a nil / null value for a placement, we don't want to use the fallback
If the placement identifier does not exist, the method then attempts to fetch a fallback offering defined by placements.fallbackOfferingId

New placements object in offerings response

{
    // other offerings stuff
    "placements": {
        "fallback_offering_id": "offering_a", // can be null
        "offering_ids_by_placement": {
            "onboarding_start": null,
            "onboarding_end": "offering_b",
        }
  }
}

joshdholtz · 2024-02-27T15:48:14Z

+        let returnOffering: Offering?
+        if let explicitOfferingId: String? = placements.offeringIdsByPlacement[placementIdentifier] {
+            // Don't use fallback since placement id was explicity set in the dictionary
+            returnOffering = explicitOfferingId.flatMap { self.all[$0] }
+        } else {
+            // Use fallback since the placement didn't exist
+            returnOffering =  placements.fallbackOfferingId.flatMap { self.all[$0]}
+        }


placements.offeringIdsByPlacement[placementIdentifier] returns at Offering?? because placements.offeringIdsByPlacement is a [String: String?]

The result of could be an explicit nil value. In that case, we don't want to use the fallback offering.

If placements.offeringIdsByPlacement[placementIdentifier] is not found and goes into the else, it means no key was found and we should use the fallback offering.

tonidero

Have a meeting, will continue reviewing after

tonidero · 2024-02-27T15:57:07Z

+            return Package(identifier: pkg.identifier,
+                           packageType: pkg.packageType,
+                           storeProduct: pkg.storeProduct,
+                           presentedOfferingContext: newContext


Nitpick but should we have an internal copy constructor from package so we can create a new package with a new context without having to pass all the parameters again?

tonidero

Some non-blocking comments. Looks good!

aboedo

looking great, left a couple of questions

aboedo · 2024-02-27T20:06:08Z

+    @objc(getCurrentOfferingForPlacement:)
+    func getCurrentOffering(forPlacement placementIdentifier: String) -> Offering? {


is it more swift-style to make this (for placement placementIdentifier: String) instead?
so the callsite is

getCurrentOffering(for: "HomePageBanner")

instead of

getCurrentOffering(forPlacement: "HomePageBanner")

or even

currentOffering(for: "HomePageBanner")

we've historically reserved verbs like get or fetch as ways to indicate that it'll issue some work like network requests

aboedo · 2024-02-27T20:14:19Z

 @objc(RCPresentedOfferingContext) public final class PresentedOfferingContext: NSObject {

-    /// The identifier of the ``Offering`` containing this Package.
+    /// The identifier of the ``Offering`` containing this ``Package``.


I'm late to the game here, but... what do I do with this class as a developer? Is it so I can use it for analytics?
The docstring for the class doesn't really provide any context on it

@aboedo Oops, missed this comment from yesterday! This is mainly for internal usage. Instead of passing offeringIdentifier from get offerings to post receipt, this objects gets passed around instead. It holds offering identifier, placement information, and targeting information.

…uct + fix tests

…forPlacement:)

…uld skip placement argument

@joshdholtz

…urrentoffering-to-offerings` - ios-13 (#3728) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - ios-12 (#3727) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - ios-14 (#3726) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - ios-16 (#3725) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - ios-17 (#3724) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - ios-15 (#3723) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@joshdholtz

…urrentoffering-to-offerings` - macos (#3722) Requested by @joshdholtz for [guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings](https://github.com/RevenueCat/purchases-ios/tree/guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings)

@vegaro

**This is an automatic release.** ### New Features * Paywalls: add `updateWithDisplayCloseButton` to `PaywallViewController` (#3708) via Cesar de la Vega (@vegaro) * New `syncAttributesAndOfferingsIfNeeded` method (#3709) via Burdock (@lburdock) * Add targeting to `PresentedOfferingContext` (#3730) via Josh Holtz (@joshdholtz) * Add `currentOffering(forPlacement: String)` to `Offerings` (#3707) via Guido Torres (@guido732) * New `Package.presentedOfferingContext` (#3712) via Josh Holtz (@joshdholtz) ### Bugfixes * Mark methods with StaticString for appUserID as deprecated (#3739) via Mark Villacampa (@MarkVillacampa) ### Other Changes * [EXTERNAL] Spelling typo fix to comment (#3713) via @vdeaugustine (#3740) via Mark Villacampa (@MarkVillacampa) --------- Co-authored-by: Josh Holtz <me@joshholtz.com>

guido732 requested a review from joshdholtz February 22, 2024 19:42

guido732 self-assigned this Feb 22, 2024

guido732 added the pr:feat A new feature label Feb 22, 2024

joshdholtz changed the title ~~Guido/fia 2856 rework ios add getcurrentoffering to offerings~~ Add getCurrentOffering(forPlacement: String) to Offerings Feb 23, 2024

joshdholtz force-pushed the guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings branch from 860e177 to d744585 Compare February 23, 2024 18:03

joshdholtz changed the base branch from 5.0-dev to new-presented-offering-context February 23, 2024 18:03

joshdholtz requested review from a team February 27, 2024 15:41

joshdholtz reviewed Feb 27, 2024

View reviewed changes

tonidero reviewed Feb 27, 2024

View reviewed changes

joshdholtz force-pushed the guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings branch from 207e09d to 25762bf Compare February 27, 2024 16:54

tonidero approved these changes Feb 27, 2024

View reviewed changes

Comment thread Sources/Support/PaywallExtensions.swift

Comment thread Tests/APITesters/ObjCAPITester/ObjCAPITester/RCPresentedOfferingContextAPI.m

Comment thread Tests/UnitTests/Purchasing/OfferingsManagerTests.swift Outdated

aboedo reviewed Feb 27, 2024

View reviewed changes

joshdholtz mentioned this pull request Feb 28, 2024

Add targeting to PresentedOfferingContext #3730

Merged

Base automatically changed from new-presented-offering-context to main February 28, 2024 19:53

Guido Torres and others added 15 commits February 28, 2024 13:57

include current offering ids by placement object in the Offerings str…

b19a9af

…uct + fix tests

docs docs docs

ed8895a

adds tests

2ba6ba7

add APITesters tests

93ffbde

rename parameter for getCurrentOffering(for:) to getCurrentOffering()…

0c95edf

…forPlacement:)

Refactor structure + func to new data structure

422cbc2

WIP: adds context for placementIdentifier

64b9802

Fix StoreKit view extension compile error for presented offering context

687d4b3

WIP update methods to return placement + update test purchase app

5a208a9

fix tests

4d1f107

fix more tests :()

afd340b

upload obj c test

fbebf2b

Fixed some lint

89ddaac

Fix compile error in backend tests

5ccb6b9

Fix API tester

cf36d01

joshdholtz and others added 16 commits February 28, 2024 13:57

One more api tester fix

cf30753

This should pass

7e2f47b

This is it

e7828ca

Some fixes from PR review

cda6a23

Passing PresentedOfferingContext further

2d6262c

Added a conveince initializer fo PresentedOfferingContext so Obj-c co…

c282c1c

…uld skip placement argument

Replaced some empty placements with nil

f9ee234

Empty commit to branch snapshot updates from

cfd5da7

Add new backend post receipt test for presented offering context

fd3427c

joshdholtz force-pushed the guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings branch from 04abfe4 to 3eb9898 Compare February 28, 2024 20:01

Rename getCurrentOffering to currentOffering

24d2c01

joshdholtz changed the title ~~Add getCurrentOffering(forPlacement: String) to Offerings~~ Add currentOffering(forPlacement: String) to Offerings Feb 28, 2024

joshdholtz merged commit 61d66bb into main Feb 28, 2024

joshdholtz deleted the guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings branch February 28, 2024 21:11

This was referenced Mar 4, 2024

[AUTOMATIC] Release/4.38.0 #3742

Closed

[AUTOMATIC] Release/4.38.0 #3745

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `currentOffering(forPlacement: String)` to `Offerings`#3707

Add `currentOffering(forPlacement: String)` to `Offerings`#3707
joshdholtz merged 32 commits into
mainfrom
guido/fia-2856-rework-ios-add-getcurrentoffering-to-offerings

guido732 commented Feb 22, 2024 •

edited by joshdholtz

Loading

Uh oh!

joshdholtz Feb 27, 2024

Uh oh!

tonidero left a comment

Uh oh!

Uh oh!

tonidero Feb 27, 2024

Uh oh!

Uh oh!

Uh oh!

tonidero left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aboedo left a comment

Uh oh!

aboedo Feb 27, 2024

Uh oh!

aboedo Feb 27, 2024

Uh oh!

aboedo Feb 27, 2024

Uh oh!

joshdholtz Feb 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		@objc(getCurrentOfferingForPlacement:)
		func getCurrentOffering(forPlacement placementIdentifier: String) -> Offering? {

Uh oh!

Conversation

guido732 commented Feb 22, 2024 • edited by joshdholtz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Description

Logic flow

New placements object in offerings response

Uh oh!

joshdholtz Feb 27, 2024

Choose a reason for hiding this comment

Uh oh!

tonidero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tonidero Feb 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tonidero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aboedo left a comment

Choose a reason for hiding this comment

Uh oh!

aboedo Feb 27, 2024

Choose a reason for hiding this comment

Uh oh!

aboedo Feb 27, 2024

Choose a reason for hiding this comment

Uh oh!

aboedo Feb 27, 2024

Choose a reason for hiding this comment

Uh oh!

joshdholtz Feb 28, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

guido732 commented Feb 22, 2024 •

edited by joshdholtz

Loading