Use a common log prefix to make log provenance clearer and improve gr…#257
Open
kiftio wants to merge 5 commits into
Open
Use a common log prefix to make log provenance clearer and improve gr…#257kiftio wants to merge 5 commits into
kiftio wants to merge 5 commits into
Conversation
This file contains hidden or 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
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.
What changes are you making?
checkout_kit).mobile_buy_integration,accelerated_checkouts_app,react_native_sample)All log messages across Android, iOS/Swift, React Native, and Web platforms are now formatted as
[<prefix>:<scope>], where the scope is normalized to snake_case. This replaces the previous inconsistent use of class names (e.g.[ShopifyCheckoutKit],[ShopifyAcceleratedCheckouts]) as log tags.A shared
toSnakeCase/toLogScopeutility is introduced on each platform to handle well-known name mappings (e.g.ShopifyCheckoutKit→checkout_kit,CheckoutECP→ecp) and fall back to automatic snake_case conversion for everything else. On Android, all log calls now use the fixed tagcheckout_kitrather than the caller-supplied tag. On the React Native module, a newlogging.tsmodule centralisesformatLogPrefix. The sample apps follow the same convention under their own prefixes.How to test
[prefix:scope]format in log output.[checkout_kit:<scope>]format for SDK logs and the appropriate sample-app prefix for app-level logs.Before you merge
Important
platforms/swift/README.mdand/orplatforms/android/README.md)Releasing a new Swift version?
ShopifyCheckoutKit.podspecplatforms/swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swiftplatforms/swift/CHANGELOG.mdplatforms/swift/README.md(major version only)Releasing a new Android version?
versionNameinplatforms/android/lib/build.gradleplatforms/android/CHANGELOG.mdplatforms/android/README.mdTip
See the Contributing documentation for the full release process per platform.