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.

Sign up for GitHub

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

[Diagnostics] Fix store kit error description tracking #4799

Merged
merged 2 commits into from
Feb 21, 2025
Merged

[Diagnostics] Fix store kit error description tracking #4799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38306a8
[Diagnostics] Fix store kit error description tracking
tonidero Feb 19, 2025
36552ef
Merge branch 'main' into fix-store-kit-error-description-diagnostics-…
tonidero Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Sources/Error Handling/StoreKitErrorHelper.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ enum StoreKitErrorUtils {
return storeKitError.trackingDescription
} else if let storeKitError = underlyingError as? StoreKit.Product.PurchaseError {
return storeKitError.trackingDescription
} else {
return Self.extractStoreKitErrorDescription(from: underlyingError)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case the current underlying error is not a store kit error, we try to get the underlying error for the current error, if it exists. I don't think this should result in an infinite loop, as long as we don't have a circular reference in the underlying errors.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should result in an infinite loop

Yeah, I agree. But still, this scares me a bit. However, I honestly can't think of a way to check this without overcomplicating things a lot 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add a maximum depth or keeping references to the errors as we loop, so we stop if we find one we already iterated on... but yeah might complicatethings a bit and I believe this should be mostly ok at the moment IMO. Other thoughts @RevenueCat/coresdk ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I agree this should be ok for now. We should assume that this won't happen in errors coming from Apple's SDKs. And in our own errors, since they are structs or enums, we're dealing with copies anyways so I think this should not happen either.

}

return nil
}

}
2 changes: 2 additions & 0 deletions Tests/StoreKitUnitTests/ProductsManagerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ class SK2ProductsManagerDiagnosticsTrackingTests: ProductsManagerTests {
expect(params?.storeKitVersion) == .storeKit2
expect(params?.errorMessage).to(beNil())
expect(params?.errorCode).to(beNil())
expect(params?.storeKitErrorDescription).to(beNil())
}

#if swift(>=5.9)
Expand All @@ -222,6 +223,7 @@ class SK2ProductsManagerDiagnosticsTrackingTests: ProductsManagerTests {
expect(params?.storeKitVersion) == .storeKit2
expect(params?.errorMessage) == "Products request error: Unable to Complete Request"
expect(params?.errorCode) == 2
expect(params?.storeKitErrorDescription) == StoreKitError.unknown.trackingDescription
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This failed without adding the new code.

}
#endif

Expand Down