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

Cancel error handling #297

Merged
merged 7 commits into from
Nov 13, 2024
Merged

Cancel error handling #297

merged 7 commits into from
Nov 13, 2024

Conversation

KunJeongPark
Copy link
Collaborator

@KunJeongPark KunJeongPark commented Nov 12, 2024

Summary of changes

  • Provide helper methods to merchants to distinguish cancellation errors from 3DS in cards, PayPal Checkout and vault flows.
  • Our SDK is right now returning CoreSDKError to the users. To discern cancellation errors, users need to check domain and code, which are specified by enum values only at internal level, which is cumbersome.
  • For next beta release, we should consider restructuring errors returned to merchants so they can easily check for types of errors.
  • Demo app changes and unit tests for helper methods
  • Cast errors from urlSessions as NetworkingClientError
  • Modify completion handlers to return CoreSDKError instead of general error

Without helper methods, merchant has to look up our internal Client level Codes and domain to get matching number, string

if let error {
   if error.code.rawValue == 6 && error.domain == "PayPalClientErrorDomain" {
      // handle cancel error
  } else {
    // handle all other errors
  }
}

With helper method:

if let error {
   if PayPalError.isCheckoutCanceled(error) {
     // handle cancel error
   } else {
    // handle all other errors
   }

Checklist

  • Added a changelog entry

Authors

List GitHub usernames for everyone who contributed to this pull request.

@KunJeongPark KunJeongPark requested a review from a team as a code owner November 12, 2024 14:22
@KunJeongPark KunJeongPark merged commit 319894d into v2_beta Nov 13, 2024
5 checks passed
@KunJeongPark KunJeongPark deleted the cancel-error-handling branch November 13, 2024 16:08
KunJeongPark added a commit that referenced this pull request Nov 19, 2024
* Remove MXO (#291)

* Remove MXO

* remove Package.resolved file containing incompatible pinstorage version

* CHANGELOG entry

* Jax feedback and docStrings correction

* Remove PatchOrder for MXO, unused files in demo app

* Remove more classes used exclusively for MXO

* Convert Delegation Pattern to Completion Handler (#293)

* PayPal remove delgation pattern for completion handler function for checkout

* lint error for paypal start

* completion and analytics into notify functions

* paypal vault completion, unit tests

* remove PayPal delegates, references

* Card vault to completion, unit tests

* Card approve to completion, unit tests

* docstrings for approve completion param

* wrap paypal functions in async await

* async await wrapper for CardClient functions

* remove CardDelegate and references

* fix error in notifyCheckoutFailure

* Make error names and messages payPal caps consistent

* changelog entires

* Steven PR feedback: typo in Chagelog

* Simplify Cancel Errors (#296)

* Simplify cancel errors

* CHANGELOG for the cancel errors

* Steven PR feedback: change back CardClientError.canceled to .threeDSecureCanceled

* CHANGELOG update

* Cancel error handling (#297)

* http performRequest returns NetworkingClientErrors

* CardClient helper function for threeDSCancel, demo app cancel, demo app minor fixes

* PayPalClient cancel helper functions and demo app changes

* Steven PR feedback: move static helper functions to error enums

* Rename CardClientError -> CardError, PayPalWebCheckoutError -> PayPalError

* Steven PR feedback: return CoreSDKError in merchant completion handler

* CHANGELOG and analytics typo and fix wrong code in graphql error

* v2 migration guide (#295)

* v2 migration guide

* just cocoapods or SPM

* fix typos

* minor spacing changes

* Update with simplified cancel errors

* Steven PR feedback - diff to render green/red

* include removal of delegate methods in delete block

* update with cardClient threeDSecureCanceled error

* change to threeDSecureCanceled in migration steps

* add comment highlighting cancellation errors

* typo fix

* clarify separating cancel cases in errors

* revert cancel handling instructions

* add changes for cancellation helper methods

* fix typo in PayPalError.isCheckoutCanceled

* Steven PR feedback

* Make PayPalError and CardError Code enum consistent (#298)

* Changelog: move additive changes from breaking section (#299)

* Changelog: move additive changes from breaking section

* remove duplicate line for PayPal cancel errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants