Changed `Logger` to use `os_log` by NachoSoto · Pull Request #2608 · RevenueCat/purchases-ios

NachoSoto · 2023-06-08T21:37:12Z

Fixes SDK-3173.

Motivation

os_log (and the new Logger.log) is the canonical way of logging in Apple platforms, replacing the old NSLog. This was made even more useful with the updates to log printing in Xcode 15.
Additionally, this allows us in the future to log OSLogMessage (using OSLogInterpolation), and therefore being able to mark certain parts of logs as privacy: .private.

Changes:

Introduced LogMessage to ensure every logged message has a category
Created LoggerStore to abstract os.Logger creation
Changed Logger to use os.Logger if available (defaulting to the old NSLog otherwise)
Updated tests to always use LogMessage instances (same as Refactor: extracted all log strings #2600)

With these new categories, log provide extra context. Example

[storeKit] DEBUG: 😻 Store products request received response
[storeKit] DEBUG: ℹ️ Store products request finished
[offering] DEBUG: 😻 Offerings updated from network.
[offering] DEBUG: 😻 Offerings updated from network.
[network] DEBUG: ℹ️ API request completed: GET /v1/product_entitlement_mapping (200)
[offline_entitlements] DEBUG: ℹ️ ProductEntitlementMapping cache updated from network.
[network] DEBUG: ℹ️ GetProductEntitlementMappingOperation: Finished
[network] DEBUG: ℹ️ Serial request done: GET product_entitlement_mapping, 0 requests left in the queue
[network] DEBUG: ℹ️ GetCustomerInfoOperation: Started
[network] DEBUG: ℹ️ There are no requests currently running, starting request GET subscribers/$RCAnonymousID%3A7f0e7d8de70745ada839e66a66ec2d86
[network] DEBUG: ℹ️ API request started: GET /v1/subscribers/$RCAnonymousID:7f0e7d8de70745ada839e66a66ec2d86
[network] DEBUG: ℹ️ API request completed: GET /v1/subscribers/$RCAnonymousID:7f0e7d8de70745ada839e66a66ec2d86 (201)
[customer] VERBOSE: Updating CustomerInfo '$RCAnonymousID:7f0e7d8de70745ada839e66a66ec2d86' request date: 2023-06-13 21:33:34 +0000
[customer] DEBUG: ℹ️ Sending latest CustomerInfo to delegate.
[customer] DEBUG: 😻 CustomerInfo updated from network.
[eligibility] DEBUG: ℹ️ Detected active subscriptions changed. Clearing trial or intro eligibility cache.

These also look much better on Xcode 15:

And even allow users to filter out specific categories:

codecov · 2023-06-14T19:35:52Z

Codecov Report

Merging #2608 (b4f3c99) into main (1b2f7f9) will increase coverage by 0.05%.
The diff coverage is 85.55%.

@@            Coverage Diff             @@
##             main    #2608      +/-   ##
==========================================
+ Coverage   86.31%   86.36%   +0.05%     
==========================================
  Files         207      207              
  Lines       14540    14611      +71     
==========================================
+ Hits        12550    12619      +69     
- Misses       1990     1992       +2

Impacted Files	Coverage Δ
Sources/Purchasing/Purchases/Purchases.swift	`75.95% <0.00%> (-0.89%)`	⬇️
...urces/LocalReceiptParsing/Helpers/LoggerType.swift	`78.46% <92.59%> (+9.23%)`	⬆️
Sources/Logging/Logger.swift	`94.30% <97.29%> (+0.19%)`	⬆️
...s/LocalReceiptParsing/Helpers/ReceiptStrings.swift	`84.28% <100.00%> (+0.22%)`	⬆️
Sources/Logging/Strings/AttributionStrings.swift	`86.27% <100.00%> (+0.13%)`	⬆️
Sources/Logging/Strings/BackendErrorStrings.swift	`60.00% <100.00%> (+2.85%)`	⬆️
Sources/Logging/Strings/CodableStrings.swift	`87.50% <100.00%> (+0.40%)`	⬆️
Sources/Logging/Strings/ConfigureStrings.swift	`86.36% <100.00%> (+0.12%)`	⬆️
Sources/Logging/Strings/CustomerInfoStrings.swift	`90.00% <100.00%> (+0.20%)`	⬆️
Sources/Logging/Strings/DiagnosticsStrings.swift	`100.00% <100.00%> (ø)`
... and 9 more

... and 5 files with indirect coverage changes

Fixes SDK-3173.

NachoSoto · 2023-06-15T17:49:14Z

+                "\(level.description, privacy: .public)\(fileContext, privacy: .public): \(message, privacy: .public)"
+            )
+    } else {
+        NSLog("%@", "[\(framework)] - \(level.description)\(fileContext): \(message)")


Codecov only looks at iOS 16: this is still used before iOS 14.0

aboedo

❤️

@NachoSoto

**This is an automatic release.** ### Bugfixes * `PurchasesOrchestrator`: update `CustomerInfoManager` cache after processing transactions (#2676) via NachoSoto (@NachoSoto) * `ErrorResponse`: drastically improved error messages, no more "unknown error"s (#2660) via NachoSoto (@NachoSoto) * `PaywallExtensions`: post purchases with `Offering` identifier (#2645) via NachoSoto (@NachoSoto) * Support `product_plan_identifier` for purchased subscriptions from `Google Play` (#2654) via Josh Holtz (@joshdholtz) ### Performance Improvements * `copy(with: VerificationResult)`: optimization to avoid copies (#2639) via NachoSoto (@NachoSoto) ### Other Changes * `ETagManager`: refactored e-tag creation and tests (#2671) via NachoSoto (@NachoSoto) * `getPromotionalOffer`: return `ErrorCode.ineligibleError` if receipt is not found (#2678) via NachoSoto (@NachoSoto) * `TimingUtil`: removed slow purchase logs (#2677) via NachoSoto (@NachoSoto) * `CI`: changed `Codecov` to `informational` (#2670) via NachoSoto (@NachoSoto) * `LoadShedderIntegrationTests`: verify requests are actually handled by load shedder (#2663) via NachoSoto (@NachoSoto) * `ETagManager.httpResultFromCacheOrBackend`: return response headers (#2666) via NachoSoto (@NachoSoto) * `Integration Tests`: added tests to verify 304 behavior (#2659) via NachoSoto (@NachoSoto) * `HTTPClient`: disable `URLSession` cache (#2668) via NachoSoto (@NachoSoto) * Documented `HTTPStatusCode.isSuccessfullySynced` (#2661) via NachoSoto (@NachoSoto) * `NetworkError.signatureVerificationFailed`: added status code to error `userInfo` (#2657) via NachoSoto (@NachoSoto) * `HTTPClient`: improved log for failed requests (#2669) via NachoSoto (@NachoSoto) * `ETagManager`: added new verbose logs (#2656) via NachoSoto (@NachoSoto) * `Signature Verification`: added test-only log for debugging invalid signatures (#2658) via NachoSoto (@NachoSoto) * Fixed `HTTPResponse.description` (#2664) via NachoSoto (@NachoSoto) * Changed `Logger` to use `os_log` (#2608) via NachoSoto (@NachoSoto) * `MainThreadMonitor`: increased threshold (#2662) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay`: display `receiptURL` (#2652) via NachoSoto (@NachoSoto) * `PurchaseTester`: added ability to display `debugRevenueCatOverlay` (#2653) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay`: ability to close on `macOS`/`Catalyst` (#2649) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay`: added support for `macOS` (#2648) via NachoSoto (@NachoSoto) * `LoadShedderIntegrationTests`: enable signature verification (#2655) via NachoSoto (@NachoSoto) * `ImageSnapshot`: fixed Xcode 15 compilation (#2651) via NachoSoto (@NachoSoto) * `OfferingsManager`: don't clear offerings cache timestamp when request fails (#2359) via NachoSoto (@NachoSoto) * `StoreKitObserverModeIntegrationTests`: added test for posting renewals (#2590) via NachoSoto (@NachoSoto) * Always initialize `StoreKit2TransactionListener` even on SK1 mode (#2612) via NachoSoto (@NachoSoto) * `ErrorUtils.missingReceiptFileError`: added receipt URL `userInfo` context (#2650) via NachoSoto (@NachoSoto) * Added `.xcprivacy` for Xcode 15 (#2619) via NachoSoto (@NachoSoto) * `Trusted Entitlements`: added debug log with `ResponseVerificationMode` (#2647) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay`: simplified title (#2641) via NachoSoto (@NachoSoto) * Simplified `Purchases.updateAllCachesIfNeeded` (#2626) via NachoSoto (@NachoSoto) * `HTTPResponseTests`: fixed disabled test (#2643) via NachoSoto (@NachoSoto) * Add `InternalDangerousSettings.forceSignatureFailures` (#2635) via NachoSoto (@NachoSoto) * `IntegrationTests`: explicit `StoreKit 1` mode (#2636) via NachoSoto (@NachoSoto) * `Signing`: removed API for loading key from a file (#2638) via NachoSoto (@NachoSoto)

`Purchases.verboseLogHandler` changed in #2608 with the introduction of a new `internalLogHandler`. Restoring the log handler doing `Purchases.verboseLogHandler = Purchases.verboseLogHandler` now loses the message category. We didn't have test coverage for `Purchases.logHandler` either which this adds as well. This also fixes tests in RevenueCat/purchases-hybrid-common#435

NachoSoto added the refactor label Jun 8, 2023

NachoSoto requested a review from a team June 8, 2023 21:37

NachoSoto changed the title ~~Changed Logger to use os_log~~ [WIP] Changed Logger to use os_log Jun 8, 2023

NachoSoto force-pushed the os-log branch 3 times, most recently from 883a6c1 to 33b21a5 Compare June 13, 2023 20:57

NachoSoto changed the title ~~[WIP] Changed Logger to use os_log~~ Changed Logger to use os_log Jun 13, 2023

NachoSoto marked this pull request as ready for review June 13, 2023 20:57

NachoSoto force-pushed the os-log branch from 611f038 to 985f5ca Compare June 13, 2023 21:11

NachoSoto added 10 commits June 15, 2023 08:13

Changed Logger to use os_log

63f7293

Fixes SDK-3173.

Removed TODOs

59010e4

Lint

eeca1ac

Docs

8ef1362

Fixed availability

abcfd88

Moved file

3e60b9a

Fixed integration tests

8e1d6e4

Improved category name

17f7d3c

Fixed name

4b087c1

Revert branch change

b4f3c99

NachoSoto force-pushed the os-log branch from d1e8691 to b4f3c99 Compare June 15, 2023 15:13

NachoSoto commented Jun 15, 2023

View reviewed changes

aboedo approved these changes Jun 15, 2023

View reviewed changes

NachoSoto merged commit 7f875ae into main Jun 15, 2023

NachoSoto deleted the os-log branch June 15, 2023 22:13

RCGitBot mentioned this pull request Jun 21, 2023

[AUTOMATIC] Release/4.22.1 #2684

Merged

NachoSoto mentioned this pull request Jun 23, 2023

Purchases.restoreLogHandler #2699

Merged

NachoSoto mentioned this pull request Oct 6, 2023

Use public and private parameters in console logs #3286

Open

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changed `Logger` to use `os_log`#2608

Changed `Logger` to use `os_log`#2608
NachoSoto merged 10 commits into
mainfrom
os-log

NachoSoto commented Jun 8, 2023 •

edited

Loading

Uh oh!

codecov Bot commented Jun 14, 2023 •

edited

Loading

Uh oh!

NachoSoto Jun 15, 2023

Uh oh!

aboedo left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

NachoSoto commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes:

Uh oh!

codecov Bot commented Jun 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

NachoSoto Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

aboedo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NachoSoto commented Jun 8, 2023 •

edited

Loading

codecov Bot commented Jun 14, 2023 •

edited

Loading