Deprecate non-APIClient sources of publishableKey, stripeAccount #1474

yuki-stripe · 2020-01-15T00:04:20Z

Summary

Part 2 of #1469

Preserve Stripe.setDefaultPublishableKey behavior

This is the default value (in the programmatic sense) of publishable key for any new APIClient instance.

Deprecate STPPaymentConfiguration.{publishableKey, stripeAccount}

For legacy reasons, make this a proxy for STPAPIClient.shared.{publishableKey, stripeAccount} if using the singleton.

Remove apiKey private property APIClient
Simplify the APIClient initializers by removing the dependency on PaymentConfiguration. PaymentConfiguration is just another property in APIClient, instead of the sorta-source-of-truth of publishableKey. It defaults to [PaymentConfiguration sharedConfiguration].

Motivation

https://paper.dropbox.com/doc/psyduck-why-iOS-SDK-API-Configuration-LTvIMxj6CBy1Mw4ntaU0l#:uid=989210153385098517970797&h2=Risks

If users ignore the deprecation warnings, the updated behavior of these deprecated properties should result in no change for most (~everyone except for Connect users cloning PMs and direct charging their connected accounts).

Testing

Existing tests still pass.

Stripe/PublicHeaders/STPAPIClient.h

Stripe/STPAPIClient.m

csabol-stripe · 2020-01-17T22:18:19Z

Stripe/STPAPIClient+ApplePay.m

@@ -126,7 +126,7 @@ + (NSDictionary *)parametersForPayment:(PKPayment *)payment {
    payload[@"pk_token"] = paymentString;
    payload[@"card"] = [self addressParamsFromPKContact:payment.billingContact];

-    NSCAssert(!(paymentString.length == 0 && [[Stripe defaultPublishableKey] hasPrefix:@"pk_live"]), @"The pk_token is empty. Using Apple Pay with an iOS Simulator while not in Stripe Test Mode will always fail.");
+    NSCAssert(!(paymentString.length == 0 && [[STPAPIClient sharedClient].publishableKey hasPrefix:@"pk_live"]), @"The pk_token is empty. Using Apple Pay with an iOS Simulator while not in Stripe Test Mode will always fail.");


I think this should still reference [Stripe defaultPublishableKey]`

csabol-stripe · 2020-01-17T22:19:04Z

Stripe/STPAnalyticsClient.m

@@ -410,7 +410,7 @@ + (NSMutableDictionary *)commonPayload {

 + (NSDictionary *)serializeConfiguration:(STPPaymentConfiguration *)configuration {
    NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
-    dictionary[@"publishable_key"] = configuration.publishableKey ?: @"unknown";
+    dictionary[@"publishable_key"] = [STPAPIClient sharedClient].publishableKey ?: @"unknown";


I think this should be [Stripe defulatPublishableKey]

As it stands, STPAPIClient sharedClient is still more likely to be accurate of the two, since if they differ, it means the user set STPAPIClient.sharedClient.publishableKey.

e.g. You could never call Stripe.setDefaultPublishableKey and only set STPAPIClient.sharedClient.publishableKey.

mm, I have the opposite understanding. You should always call stripe.setDefaultPublishableKey and only set STPAPIClient.sharedClient.publishableKey for very specific use cases wher eyou know what you're doing. Otherwise what's the point of Stripe.defaultPublishableKey?

csabol-stripe · 2020-01-17T22:20:11Z

Stripe/STPAPIClient.m

 }

 + (NSString *)defaultPublishableKey {
-    return [STPPaymentConfiguration sharedConfiguration].publishableKey;
+    return _defaultPublishableKey;


I might actually go so far as to make this non-nil (initial value of empty string) so that we can have true null_resettable behavior in STPAPIClient. Thoughts @davidme-stripe ?

It's a bit weird to have that as an explicit default value, because an empty string isn't a valid value. Like, we fire an assertion if you try to set publishableKey to an empty string.

…sharedClient.publishableKey

Usage | Before | After all configuration changes: - PaymentContext configuration. This never worked and there's no use case. | Still doesn't work, still no use case. - CustomerContext configuration. This worked, but there is no use case. | Now, it only works if you set before STPAPIClient.shared is initialized. There's still no use case. - PaymentHandler, APIClient.shared configuration. This worked if you set before STPAPIClient.shared is initialized. | No change.

…f the sorta-source-of-truth of publishableKey.

…tead of deprecating it

…ublishableKey

This reverts commit 314256004a790edd3c35b090c3ed0b0b9506b84e.

…eKey only (this is the status quo behavior).

MIGRATING.md

csabol-stripe · 2020-01-22T23:20:42Z

MIGRATING.md

+For example, if you are a Connect user who stores Payment Methods on your platform, but clones PaymentMethods to a connected count and create direct charges on that connected account ie if:
+
+1. You never set `STPPaymentConfiguration.shared.stripeAccount`
+2. You set `STPAPIClient.shared.stripeAccount`
+
+We recommend you do the following:
+


Maybe rewrite as:

For example, if you only want to use a Connected account for a single transaction, your integration could look like:

That sounds different from the use case described. These users want to use a Connected account for all transactions, if transactions means payments, but they want to retrieve Customers and their PMs on the platform.

okay, as written it was confusing to me but I think you understand the use case better :)

Co-Authored-By: Cameron <36750494+csabol-stripe@users.noreply.github.com>

MIGRATING.md

StripeCore: added support for seeing HTTP response status code as part of StripeServiceError.

yuki-stripe assigned csabol-stripe Jan 15, 2020

csabol-stripe reviewed Jan 16, 2020

View reviewed changes

Stripe/PublicHeaders/STPAPIClient.h Show resolved Hide resolved

Stripe/PublicHeaders/STPAPIClient.h Show resolved Hide resolved

Stripe/STPAPIClient.m Show resolved Hide resolved

yuki-stripe requested a review from csabol-stripe January 17, 2020 19:01

csabol-stripe reviewed Jan 17, 2020

View reviewed changes

yuki-stripe requested a review from csabol-stripe January 21, 2020 22:42

csabol-stripe approved these changes Jan 22, 2020

View reviewed changes

stripe-ci added the approved label Jan 22, 2020

stripe-ci assigned yuki-stripe and unassigned csabol-stripe Jan 22, 2020

yuki-stripe changed the base branch from yuki/customercontext-use-shared-apiclient to master January 22, 2020 01:00

yuki-stripe added 13 commits January 21, 2020 17:12

Unrecommend Stripe.setDefaultPublishableKey in favor of STPAPIClient.…

cca003f

…sharedClient.publishableKey

unrecom

6ef2007

Remove apiKey

33b5b95

PaymentConfiguration is just another property in APIClient, instead o…

881d636

…f the sorta-source-of-truth of publishableKey.

Actually, make Stripe.defaultPublishableKey do the expected thing ins…

0a84d09

…tead of deprecating it

In docstrings, rename STPAPIClient.shared to [STPAPIClient sharedClient]

4f4754b

Make Stripe.defaultPublishableKey the default value of STPAPIClient p…

ca42373

…ublishableKey

Deprecate initWithConfiguration

6cc81c7

Fix buggy default behavior, added test to catch it

98c3484

Make STPAPIClient.publishableKey readonly

db887da

Revert "Make STPAPIClient.publishableKey readonly"

d2af93d

This reverts commit 314256004a790edd3c35b090c3ed0b0b9506b84e.

Stripe.setDefaultPublishableKey sets the default value for publishabl…

79c84f2

…eKey only (this is the status quo behavior).

yuki-stripe force-pushed the yuki/deprecate-initwithconfiguration branch from 4af824b to 79c84f2 Compare January 22, 2020 01:12

stripe-ci removed the approved label Jan 22, 2020

Fix test and add docstring

c5a3a22

csabol-stripe approved these changes Jan 22, 2020

View reviewed changes

stripe-ci added the approved label Jan 22, 2020

Add Changelog, migrating, improve a deprecation string

7ba035f

stripe-ci removed the approved label Jan 22, 2020

csabol-stripe reviewed Jan 22, 2020

View reviewed changes

yuki-stripe and others added 5 commits January 22, 2020 15:26

Update MIGRATING.md

0083f0a

Co-Authored-By: Cameron <36750494+csabol-stripe@users.noreply.github.com>

Update MIGRATING.md

4a04060

Co-Authored-By: Cameron <36750494+csabol-stripe@users.noreply.github.com>

Update MIGRATING.md

1eb6724

Co-Authored-By: Cameron <36750494+csabol-stripe@users.noreply.github.com>

Update MIGRATING.md

7de5123

Co-Authored-By: Cameron <36750494+csabol-stripe@users.noreply.github.com>

Fix typos, grammar

8aeecc6

csabol-stripe reviewed Jan 23, 2020

View reviewed changes

MIGRATING.md Outdated Show resolved Hide resolved

English hard

8463d66

csabol-stripe approved these changes Jan 23, 2020

View reviewed changes

stripe-ci added the approved label Jan 23, 2020

yuki-stripe merged commit d4c7a71 into master Jan 23, 2020

yuki-stripe deleted the yuki/deprecate-initwithconfiguration branch January 23, 2020 18:15

yuki-stripe pushed a commit that referenced this pull request Oct 4, 2022

Merge pull request #1474 from stripe-ios/kg-addstatuscode

2496978

StripeCore: added support for seeing HTTP response status code as part of StripeServiceError.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate non-APIClient sources of publishableKey, stripeAccount #1474

Deprecate non-APIClient sources of publishableKey, stripeAccount #1474

yuki-stripe commented Jan 15, 2020 •

edited

Loading

csabol-stripe Jan 17, 2020

csabol-stripe Jan 17, 2020

yuki-stripe Jan 17, 2020

csabol-stripe Jan 17, 2020

csabol-stripe Jan 17, 2020

yuki-stripe Jan 17, 2020

csabol-stripe Jan 22, 2020

yuki-stripe Jan 22, 2020

csabol-stripe Jan 23, 2020

Deprecate non-APIClient sources of publishableKey, stripeAccount #1474

Deprecate non-APIClient sources of publishableKey, stripeAccount #1474

Conversation

yuki-stripe commented Jan 15, 2020 • edited Loading

Summary

Motivation

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yuki-stripe commented Jan 15, 2020 •

edited

Loading