Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support JSON serialization with System.Text.Json #2971

Closed
wants to merge 1 commit into from

Conversation

hootanht
Copy link

Fixes #2495

Add support for JSON serialization with System.Text.Json.

  • Add JsonSerializer interface and implement NewtonsoftJsonSerializer and SystemTextJsonSerializer classes in src/Stripe.net/Infrastructure/JsonSerializer.cs.
  • Update StripeEntity class in src/Stripe.net/Entities/_base/StripeEntity.cs to use the JsonSerializer interface for ToJson and FromJson methods.
  • Replace Newtonsoft.Json attributes with System.Text.Json attributes in src/Stripe.net/Entities/Customers/Customer.cs, src/Stripe.net/Entities/_common/Address.cs, src/Stripe.net/Entities/_common/AddressJapan.cs, src/Stripe.net/Entities/_common/Shipping.cs, src/Stripe.net/Entities/AccountLinks/AccountLink.cs, and src/Stripe.net/Entities/Accounts/Account.cs.
  • Add conditional compilation to use appropriate attributes based on the selected JSON serializer in the above files.

Fixes stripe#2495

Add support for JSON serialization with System.Text.Json.

* Add `JsonSerializer` interface and implement `NewtonsoftJsonSerializer` and `SystemTextJsonSerializer` classes in `src/Stripe.net/Infrastructure/JsonSerializer.cs`.
* Update `StripeEntity` class in `src/Stripe.net/Entities/_base/StripeEntity.cs` to use the `JsonSerializer` interface for `ToJson` and `FromJson` methods.
* Replace `Newtonsoft.Json` attributes with `System.Text.Json` attributes in `src/Stripe.net/Entities/Customers/Customer.cs`, `src/Stripe.net/Entities/_common/Address.cs`, `src/Stripe.net/Entities/_common/AddressJapan.cs`, `src/Stripe.net/Entities/_common/Shipping.cs`, `src/Stripe.net/Entities/AccountLinks/AccountLink.cs`, and `src/Stripe.net/Entities/Accounts/Account.cs`.
* Add conditional compilation to use appropriate attributes based on the selected JSON serializer in the above files.
@CLAassistant
Copy link

CLAassistant commented Sep 13, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@jar-stripe
Copy link
Contributor

@hootanht Thank you submitting this PR! Supporting System.Text.Json as an alternative to Newtonsoft is on our to-do list for this quarter, and I'd love to work with you on getting this landed. We have a code generator that is responsible for generating some 500-odd files that I definitely don't want to ask you to manually update, and I want to be able to include this in such a way that one SDK will be compatible with users of both Newtonsoft and System.Text.Json. Let me review your changes and see how we can incorporate them into our code generation infrastructure, make sure it won't break existing users, and then I'll plan to push updates right back to this branch/PR. Sound good?

@hootanht
Copy link
Author

hootanht commented Oct 8, 2024

@hootanht Thank you submitting this PR! Supporting System.Text.Json as an alternative to Newtonsoft is on our to-do list for this quarter, and I'd love to work with you on getting this landed. We have a code generator that is responsible for generating some 500-odd files that I definitely don't want to ask you to manually update, and I want to be able to include this in such a way that one SDK will be compatible with users of both Newtonsoft and System.Text.Json. Let me review your changes and see how we can incorporate them into our code generation infrastructure, make sure it won't break existing users, and then I'll plan to push updates right back to this branch/PR. Sound good?

Awesome 👌

@jar-stripe
Copy link
Contributor

Hi @hootanht ! Just a quick update here; I'm actually considering a more pared down approach here, to reduce the blast zone of a change while still solving the original ticket. I left a comment over on the issue: #2495 (comment), mind giving it a read and chiming in there? Thanks!

@hootanht
Copy link
Author

Thanks a lot

@hootanht hootanht closed this Nov 11, 2024
@jar-stripe
Copy link
Contributor

Sure thing! And if that doesn't completely work for your use case we can definitely revisit this here. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support JSON serialization with System.Text.Json
4 participants