Better string enums #1675
Merged
Better string enums #1675
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ob-stripe
force-pushed
the
ob-string-enums
branch
from
4136fb6 to
1f3f135
Compare
There was a problem hiding this comment.
Nice! This looks super clean to me — and thanks for the detailed PR description explaining why.
Left one minor comment, but looks good to me otherwise.
ptal @ob-stripe
ob-stripe
force-pushed
the
ob-string-enums
branch
from
1f3f135 to
63c4a28
Compare
ob-stripe
force-pushed
the
ob-string-enums
branch
from
63c4a28 to
499601c
Compare
ob-stripe
force-pushed
the
ob-string-enums
branch
from
499601c to
4eb15b9
Compare
|
Added comments, ptal @brandur-stripe |
brandur-stripe
approved these changes
Jul 5, 2019
ghost
mentioned this pull request
ob-stripe
added a commit
that referenced
this pull request
Jul 18, 2019
remi-stripe
pushed a commit
that referenced
this pull request
Jul 19, 2019
remi-stripe
pushed a commit
that referenced
this pull request
Aug 12, 2019
ob-stripe
added a commit
that referenced
this pull request
Aug 16, 2019
ob-stripe
added a commit
that referenced
this pull request
Sep 30, 2019
ob-stripe
added a commit
that referenced
this pull request
Oct 7, 2019
ob-stripe
added a commit
that referenced
this pull request
Oct 8, 2019
ob-stripe
added a commit
that referenced
this pull request
Oct 9, 2019
* Better string enums (#1675) * Init options with default parameter values (#1699) * Remove multiple deprecated features (#1713) Many features were marked as obsolete and are now being removed: * AccountBalance on Customer, use Balance instead * Billing on Subscription/Invoice/SubscriptionSchedule, use CollectionMethod instead * TaxInfo and TaxInfoVerification on Customer, use TaxId instead * AllowedSourceTypes on PaymentIntent, use PaymentMethodTypes instead * Start on Subscription, use StartDate instead * ApplicationFee on Charge, use ApplicationFeeAmount instead * Date when listing Invoices, use Created instead * OperatorAccount on all Terminal APIs * Remove all Expand* fields (#1715) * Use properl SetupIntent class * Removed Id and FileId suffixes to stay as close to the API as possible. (#1738) * Add a test to ensure that JSON names match property names (#1744) * A few more renames (#1739) * Remove dead code for service expansions (#1751) * Bump Stylecop.Analyzers to latest version (#1752) * Bump SourceLink and create symbol package (#1755) * Fix all classes not inheriting from the generic version of StripeEntity * Add a wholesome test to ensure proper JSON converters are applied (#1761) * Remove more deprecated stuff (#1802) * Remove more Id/FileId suffixes (#1803) * One more rename (#1805) * Fix ExternalAccountUpdateOptions (#1806) * Rename AccountOpener to Representative and move to latest API version * Enable test for JSON<->property name consistency (#1804)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
r? @brandur-stripe
cc @stripe/api-libraries
Right now we're using regular
enums for a few special values, likePlanTierUpTo.Inf.The issue with this approach is that
enumare really integers, but in our case it's not desirable to have a conversion betweenenumandint. This is especially true forPlanTierUpTo, becausePlanTierOptions.UpTois defined asAnyOf<long?, PlanTierUpTo?>. If for some reason thePlanTierUpTois implicitly or explicitly converted tolong, then the value will be accepted and sent as an int instead of a string in the request, leading to unexpected results (cf. #1674).This PR shows a possible solution: stop using
enums and instead use regular classes with a private constructor and the possible values as static properties. This is technically a breaking change because of the type change, but the impact on users should be very minimal because the syntax doesn't change: you can still usePlanTierUpTo.Infjust like before.