Add back IntroductoryPrice.introPricePeriodUnit string #319

beylmk · 2022-02-11T23:45:47Z

In https://github.com/RevenueCat/purchases-flutter/pull/270/files#diff-31ad10b1074cdc6e6c82c3cc2ab3221a117afbaaee017193b6b189d7f34bc769R40 we changed periodUnit from a string to a PeriodUnit enum. An issue was opened indicating we released this change without reflecting it in the changelog and did a minor instead of a major.

This fix adds back the string type and deprecates it. We can leave the PeriodUnit enum type since the properties have different names.

Also:

added unit tests to confirm the IntroductoryPrice values are set properly from the original JSON
added a little "api test" method to our current sample app which simply accesses each property, ensuring the types are correct. This issue highlights our need for a full API tester in purchases-flutter, but this is a quicker api test
created a follow-up ticket for eventually removing introPricePeriodUnit, since some of the changes required aren't obviously attributed to the property

We will release a 3.9.4 with this fix.

[sc-13246]

…m. unit test that both are available

shortcut-integration · 2022-02-11T23:45:49Z

This pull request has been linked to Shortcut Story #13246: [Flutter] Release 3.9.4 bringing string version of priceIntroductoryPrice.periodUnit.

beylmk · 2022-02-12T00:41:12Z

lib/models/introductory_price.dart

@@ -19,6 +15,8 @@ enum PeriodUnit {

 /// Contains all the introductory information associated with a [Product]
 class IntroductoryPrice with _$IntroductoryPrice {
+  const IntroductoryPrice._();


needed to add this to enable the custom getter of the PeriodUnit type. see https://github.com/rrousselGit/freezed#custom-getters-and-methods

beylmk · 2022-02-12T00:42:11Z

revenuecat_examples/purchase_tester/lib/main.dart

@@ -127,6 +132,21 @@ class _UpsellScreenState extends State<UpsellScreen> {
      ),
    );
  }
+
+  void apiTestIntroductoryPrice(IntroductoryPrice introPrice) {


i had this here so i could test with a real API response, but maybe it makes more sense for this to be in the unit tests?

i ran the API tester method added here on 3.8.0 and noticed that there was also a name change on the introPrice properties. the properties themselves were prefixed with "introPrice" (i.e. introPriceNumberOfPeriodUnits became numberOfPeriodUnits, see attached screenshot for the names in 3.8.0). i didn't see any callout in our releases since 3.8.0 for this change, though perhaps it was encompassed in some of the downstream changes. i'll do more follow-up on monday, but figured i'd post here in case someone has a quick answer...

I think we need to add all of them back since they are breaking changes right?

yeah i think so. was just confirming i didn't somehow miss these changes somewhere, like in links in changelogs

beylmk · 2022-02-12T01:57:35Z

revenuecat_examples/purchase_tester/lib/main.dart

@@ -127,6 +132,21 @@ class _UpsellScreenState extends State<UpsellScreen> {
      ),
    );
  }
+
+  void apiTestIntroductoryPrice(IntroductoryPrice introPrice) {


i ran the API tester method added here on 3.8.0 and noticed that there was also a name change on the introPrice properties. the properties themselves were prefixed with "introPrice" (i.e. introPriceNumberOfPeriodUnits became numberOfPeriodUnits, see attached screenshot for the names in 3.8.0). i didn't see any callout in our releases since 3.8.0 for this change, though perhaps it was encompassed in some of the downstream changes. i'll do more follow-up on monday, but figured i'd post here in case someone has a quick answer...

beylmk · 2022-02-14T18:22:41Z

lib/models/introductory_price.dart

+    /// String representation of unit for the billing period of the introductory
+    /// price, can be DAY, WEEK, MONTH or YEAR.
+    @Deprecated('Use periodUnit property of type PeriodUnit instead.')
+    @JsonKey(name: 'periodUnit') String introPricePeriodUnit,


couldn't have two properties with same JsonKey, so i pulled the enum out

…ual to the new ones. update apitest method with deprecated props

beylmk · 2022-02-15T21:42:07Z

@vegaro ready for re-review

vegaro · 2022-02-15T22:03:41Z

lib/models/introductory_price.dart

+
+  /// Formatted introductory price of a subscription, including
+  /// its currency sign, such as €3.99.
+  /// @Deprecated('Use priceString instead.')


Suggested change

/// @Deprecated('Use priceString instead.')

@Deprecated('Use priceString instead.')

Maddie Beyl added 7 commits February 11, 2022 13:49

Update json_annotation

3c1cadd

Remove enum from freezed factory in lieu of string, map string to enu…

267507d

…m. unit test that both are available

Add test for enum mapping

b5dbddc

rebuild freezed

6413800

add apitest function

e788301

Remove TODOs now that ticket is created

4272022

fix lint

4ad4493

beylmk force-pushed the add-back-intro-price-string branch from f82cf44 to 4523fd3 Compare February 12, 2022 00:40

beylmk commented Feb 12, 2022

View reviewed changes

fix more lint

001c012

beylmk force-pushed the add-back-intro-price-string branch from 4523fd3 to 001c012 Compare February 12, 2022 00:42

Update comment on periodUnit

68676b8

beylmk requested a review from a team February 12, 2022 02:01

beylmk marked this pull request as ready for review February 14, 2022 18:21

beylmk commented Feb 14, 2022

View reviewed changes

Add back other deprecated properties and add test ensuring they're eq…

7acbd7a

…ual to the new ones. update apitest method with deprecated props

beylmk force-pushed the add-back-intro-price-string branch 2 times, most recently from f256086 to 5f269a3 Compare February 15, 2022 21:34

try ignoring deprecations on whole test file

2380c3e

beylmk force-pushed the add-back-intro-price-string branch from 5f269a3 to 2380c3e Compare February 15, 2022 21:39

vegaro approved these changes Feb 15, 2022

View reviewed changes

un-comment deprecation annotation

2a07ebd

beylmk merged commit 03f4e18 into main Feb 15, 2022

beylmk deleted the add-back-intro-price-string branch February 15, 2022 23:01

vegaro mentioned this pull request Jun 21, 2022

Update to PHC 3.2.0 and clean up of intro price #384

Merged

Jethro87 pushed a commit to Jethro87/purchases-flutter that referenced this pull request Jan 4, 2025

Add back IntroductoryPrice.introPricePeriodUnit string (RevenueCat#319)

0459921

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add back IntroductoryPrice.introPricePeriodUnit string #319

Add back IntroductoryPrice.introPricePeriodUnit string #319

beylmk commented Feb 11, 2022 •

edited

Loading

shortcut-integration bot commented Feb 11, 2022

beylmk Feb 12, 2022

beylmk Feb 12, 2022 •

edited

Loading

beylmk Feb 12, 2022

vegaro Feb 15, 2022

beylmk Feb 15, 2022 •

edited

Loading

beylmk Feb 12, 2022

beylmk Feb 14, 2022

beylmk commented Feb 15, 2022

vegaro Feb 15, 2022

beylmk Feb 15, 2022

	/// @Deprecated('Use priceString instead.')
	@Deprecated('Use priceString instead.')

Add back IntroductoryPrice.introPricePeriodUnit string #319

Add back IntroductoryPrice.introPricePeriodUnit string #319

Conversation

beylmk commented Feb 11, 2022 • edited Loading

shortcut-integration bot commented Feb 11, 2022

beylmk Feb 12, 2022

Choose a reason for hiding this comment

beylmk Feb 12, 2022 • edited Loading

Choose a reason for hiding this comment

beylmk Feb 12, 2022

Choose a reason for hiding this comment

vegaro Feb 15, 2022

Choose a reason for hiding this comment

beylmk Feb 15, 2022 • edited Loading

Choose a reason for hiding this comment

beylmk Feb 12, 2022

Choose a reason for hiding this comment

beylmk Feb 14, 2022

Choose a reason for hiding this comment

beylmk commented Feb 15, 2022

vegaro Feb 15, 2022

Choose a reason for hiding this comment

beylmk Feb 15, 2022

Choose a reason for hiding this comment

beylmk commented Feb 11, 2022 •

edited

Loading

beylmk Feb 12, 2022 •

edited

Loading

beylmk Feb 15, 2022 •

edited

Loading