Improve sandbox detector for macOS apps #3549

MarkVillacampa · 2024-01-02T16:33:26Z

Checking for the presence of Xcode/DerivedData in the receipt path was failing for TestFlight builds or if the .app bundle generated by Xcode was moved from the folder.

Additionally, checking for MASReceipt/receipt seems less robust than simply using compiler directives.

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift

NachoSoto

Awesome thanks for doing this!

NachoSoto · 2024-01-03T12:09:43Z

Sources/Misc/SandboxEnvironmentDetector.swift

+    /// - https://github.com/objective-see/ProcInfo/blob/master/procInfo/Signing.m#L184-L247
+    /// - https://gist.github.com/lukaskubanek/cbfcab29c0c93e0e9e0a16ab09586996#gistcomment-3993808
+    #if os(macOS) || targetEnvironment(macCatalyst)
+    var isMacAppStore: Bool {


This could be static

And should be private. Maybe move it to an extension?

NachoSoto · 2024-01-03T12:10:06Z

Sources/Misc/SandboxEnvironmentDetector.swift

+        var code: SecStaticCode?
+        status = SecStaticCodeCreateWithPath(Bundle.main.bundleURL as CFURL, [], &code)
+
+        guard status == noErr, let code = code else { return false }


Should we log the error?

NachoSoto · 2024-01-03T12:10:19Z

Sources/Misc/SandboxEnvironmentDetector.swift

+    /// it checked the common name but was changed to an extension check to make it more
+    /// future-proof.
+    ///
+    /// For more information, see the following references:


NachoSoto · 2024-01-03T12:11:44Z

Sources/Misc/SandboxEnvironmentDetector.swift

+            &requirement
+        )
+
+        guard status == noErr, let requirement = requirement else { return false }


Let's log a warning here too?

NachoSoto · 2024-01-03T12:12:02Z

Sources/Misc/SandboxEnvironmentDetector.swift

-            return path.contains("Xcode/DerivedData")
-        } else {
+        #if os(macOS) || targetEnvironment(macCatalyst)
+            return !isMacAppStore


Suggested change

return !isMacAppStore

return !Self.isMacAppStore

MarkVillacampa · 2024-01-03T15:07:18Z

Sources/LocalReceiptParsing/BasicTypes/AppleReceipt.swift

+        case xcode = "Xcode"
+
+        /// Unknown environment
+        case unknown = "Unknown"


In theory, there might also be ProductionVPP and ProductionVPPSandbox for Apple's Volume Purchase Program, but I believe those apps cannot have in-app purchases anyway.

MarkVillacampa · 2024-01-03T15:08:38Z

Sources/LocalReceiptParsing/BasicTypes/AppleReceipt.swift

+    }
+
+    /// The receipt's environment.
+    public let environment: Environment?


Making it optional since the value is not publicly documented by Apple as a receipt field and could be changed. It's also not required for us since we can fall back to the bundle signature method.

MarkVillacampa · 2024-01-03T15:10:09Z

Sources/LocalReceiptParsing/ReceiptParser-only-files/PurchasesReceiptParser+Fetching.swift

-            throw Error.failedToLoadLocalReceipt(error)
-        }
-    }
-


Moved these to the main package while keeping them private.

They were here as convenience for this package because it doesn't have a receipt fetcher.

MarkVillacampa · 2024-01-03T15:12:25Z

Sources/Misc/SystemInfo.swift

        return self.sandboxEnvironmentDetector.isSandbox
+    }()


Caching the result since the sandbox detector is a bit more CPU-intensive, and does not change.

I was worried this was suddenly a lot less efficient, but:

It's macOS only

It's cached 👏🏻

MarkVillacampa · 2024-01-03T15:26:42Z

Sources/Misc/SandboxEnvironmentDetector.swift

@@ -40,12 +44,19 @@ final class BundleSandboxEnvironmentDetector: SandboxEnvironmentDetector {
            return false


I'd argue if appStoreReceiptUR is nil then we are in sandbox environment, so this should be true?

I have not been able to find a case where appStoreReceiptURL is nil tho. The URL is always returned, but then the file does not exist in some cases.

codecov · 2024-01-03T23:41:59Z

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (793f4ab) 86.04% compared to head (2a6b726) 85.97%.

❗ Current head 2a6b726 differs from pull request most recent head fbc3a1f. Consider uploading reports for the commit fbc3a1f to get more accurate results

Files	Patch %	Lines
...rces/LocalReceiptParsing/LocalReceiptFetcher.swift	60.00%	2 Missing ⚠️
...s/LocalReceiptParsing/Helpers/ReceiptStrings.swift	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3549      +/-   ##
==========================================
- Coverage   86.04%   85.97%   -0.07%     
==========================================
  Files         241      242       +1     
  Lines       17586    17616      +30     
==========================================
+ Hits        15131    15145      +14     
- Misses       2455     2471      +16

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

NachoSoto · 2024-01-04T05:43:09Z

Sources/LocalReceiptParsing/BasicTypes/AppleReceipt.swift

@@ -18,6 +18,24 @@ import Foundation
 /// - Seealso: [the official documentation](https://rev.cat/apple-receipt-fields).
 public struct AppleReceipt: Equatable {

+    /// The server environment a receipt belongs to.
+    public enum Environment: String {


Maybe move this to an extension like we do in other types?
That makes it easier to see the type properties at a glance without the extra noise of other type definitions.

Sources/LocalReceiptParsing/Builders/AppleReceiptBuilder.swift

NachoSoto · 2024-01-04T05:55:32Z

Sources/LocalReceiptParsing/Helpers/ReceiptStrings.swift

@@ -39,6 +39,7 @@ enum ReceiptStrings {
    case receipt_retrying_mechanism_not_available
    case local_receipt_missing_purchase(AppleReceipt, forProductIdentifier: String)
    case retrying_receipt_fetch_after(sleepDuration: TimeInterval)
+    case validating_bundle_signature


Suggested change

case validating_bundle_signature

case error_validating_bundle_signature

NachoSoto · 2024-01-04T05:56:25Z

Sources/LocalReceiptParsing/PurchasesReceiptParser.swift

+
+internal extension PurchasesReceiptParser {
+
+    func fetchAndParseLocalReceipt(


Let's not add this here, we already have ReceiptFetcher for this

NachoSoto · 2024-01-04T05:57:14Z

Sources/LocalReceiptParsing/ReceiptParser-only-files/PurchasesReceiptParser+Fetching.swift

-            throw Error.failedToLoadLocalReceipt(error)
-        }
-    }
-


They were here as convenience for this package because it doesn't have a receipt fetcher.

NachoSoto · 2024-01-04T06:11:58Z

Sources/Misc/SandboxEnvironmentDetector.swift

-    init(bundle: Bundle = .main, isRunningInSimulator: Bool = SystemInfo.isRunningInSimulator) {
+    init(bundle: Bundle = .main,
+         isRunningInSimulator: Bool = SystemInfo.isRunningInSimulator,
+         receiptParser: PurchasesReceiptParser = PurchasesReceiptParser.default) {


What do you think of injecting a protocol type so we don't tie this to receipt parser or fetcher (and make it easier to test)?

NachoSoto · 2024-01-04T06:12:26Z

Sources/Misc/SandboxEnvironmentDetector.swift

+        #endif
+    }
+
+    var isProductionReceipt: Bool {


This can be private?

Maybe move it to the extension below?

NachoSoto · 2024-01-04T06:12:37Z

Sources/Misc/SandboxEnvironmentDetector.swift

-            return path.contains("Xcode/DerivedData")
-        } else {
+        #if os(macOS) || targetEnvironment(macCatalyst)
+            return !isProductionReceipt || !Self.isMacAppStore


Suggested change

return !isProductionReceipt || !Self.isMacAppStore

return !self.isProductionReceipt || !Self.isMacAppStore

NachoSoto · 2024-01-04T06:14:52Z

Sources/Misc/SystemInfo.swift

        return self.sandboxEnvironmentDetector.isSandbox
+    }()


I was worried this was suddenly a lot less efficient, but:

It's macOS only

It's cached 👏🏻

NachoSoto · 2024-01-04T06:16:02Z

Sources/Misc/SandboxEnvironmentDetector.swift

-        if isMASReceipt {
-            return path.contains("Xcode/DerivedData")
-        } else {
+        #if os(macOS) || targetEnvironment(macCatalyst)


Feel free to do it on a separate PR (maybe pointing to the macOS tests branch), but this could really use tests. I'm afraid that if we don't add them now we'll forget.

MarkVillacampa · 2024-01-08T15:38:07Z

Sources/LocalReceiptParsing/LocalReceiptFetcher.swift

+    func fetchAndParseLocalReceipt() throws -> AppleReceipt
+}
+
+internal final class LocalReceiptFetcher: LocalReceiptFetcherType {


ReceiptFetcher depends on StoreKitRequestFetcher and SystemInfo (which would create a circular dependency BundleSandboxEnvironmentDetector).

So instead of adding these methods as an extension to PurchasesReceiptParser, I've created LocalReceiptFetcher as a simplified version of ReceiptFetcher, with an accompanying protocol so it can be tested.

Ideally we would be able to use ReceiptFetcher but the dependencies make it hard :/ any other suggestion to simplify this?

Yeah that's why we had this. In the future we'll be able to share code using the package visibility.

MarkVillacampa · 2024-01-08T15:40:00Z

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift

+    }
+
+    func testIsSandboxIfReceiptParsingFailsAndBundleSignatureIsNotMacAppStore() throws {
+        try AvailabilityChecks.skipIfNotMacOS()


Added some tests for macOS, which do not currently run so I cannot properly test them. Once the macOS tests PR is ready I'll make sure to fix any errors if tests don't pass.

NachoSoto

This looks great 👍🏻 The only thing left is the unknown / nil. Do you still think we need optional?

NachoSoto · 2024-01-08T15:56:25Z

Sources/LocalReceiptParsing/LocalReceiptFetcher.swift


 import Foundation

-public extension PurchasesReceiptParser {
+internal protocol LocalReceiptFetcherType: Sendable {
+    func fetchAndParseLocalReceipt() throws -> AppleReceipt


Style guide: spacing around this

NachoSoto · 2024-01-08T15:56:57Z

Sources/LocalReceiptParsing/LocalReceiptFetcher.swift

+                                                  receiptParser: .default
+                                                )


Symmetry with opening ()

Suggested change

receiptParser: .default

)

receiptParser: .default)

NachoSoto · 2024-01-08T16:01:02Z

Sources/Misc/SandboxEnvironmentDetector.swift

+
+private extension BundleSandboxEnvironmentDetector {
+
+    var isProductionReceipt: Bool {


Maybe move this inside of the #if os(macOS) check too? It's potentially very inefficient for mobile devices, so that way we make sure we don't use it there.

NachoSoto · 2024-01-08T16:02:09Z

Tests/TestingApps/PurchaseTesterSwiftUI/Shared/Views/LocalReceiptView.swift

@@ -84,6 +84,7 @@ private struct ReceiptDataView: View {
    init(receipt: AppleReceipt) {
        self.init(
            values: [
+                .init("Environment", (receipt.environment ?? .unknown).rawValue),


Case in point :P we don't need optional + unknown

Made it non-optional, with .unknown as default, and overridden by whatever comes in the receipt :D

NachoSoto · 2024-01-08T16:02:16Z

Tests/UnitTests/LocalReceiptParsing/Builders/AppleReceiptBuilderTests.swift

@@ -108,8 +109,21 @@ class AppleReceiptBuilderTests: TestCase {
        }
    }

+    func testBuildDoesntThrowIfEnvironmentIsMissing() {


NachoSoto · 2024-01-08T16:03:14Z

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift

@@ -16,46 +16,96 @@ import XCTest

 @testable import RevenueCat

+final class MockLocalReceiptFetcher: LocalReceiptFetcherType {


This can be private. Can you move it to the bottom of the file, since it's just an implementation detail? That way the first thing in the file is the actual tests.

NachoSoto · 2024-01-08T16:03:27Z

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift

+            throw PurchasesReceiptParser.Error.receiptParsingError
+        }
+        return mockReceipt
+    }


Suggested change

}

}

NachoSoto · 2024-01-08T16:03:39Z

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift

+        if failReceiptParsing {
+            throw PurchasesReceiptParser.Error.receiptParsingError
+        }
+        return mockReceipt


Suggested change

return mockReceipt

return self.mockReceipt

NachoSoto · 2024-01-08T16:04:37Z

Sources/LocalReceiptParsing/LocalReceiptFetcher.swift

+    func fetchAndParseLocalReceipt() throws -> AppleReceipt
+}
+
+internal final class LocalReceiptFetcher: LocalReceiptFetcherType {


Yeah that's why we had this. In the future we'll be able to share code using the package visibility.

NachoSoto

🎉

Sources/Misc/SandboxEnvironmentDetector.swift

Co-authored-by: NachoSoto <NachoSoto@users.noreply.github.com>

@NachoSoto

**This is an automatic release.** ### RevenueCatUI * `Paywalls`: remove unscrollable spacing in Template 5 (#3562) via NachoSoto (@NachoSoto) * `Paywalls`: improve template 5 checkmark icon (#3559) via NachoSoto (@NachoSoto) ### Bugfixes * Improve sandbox detector for macOS apps (#3549) via Mark Villacampa (@MarkVillacampa) ### Other Changes * `Paywalls`: new `PaywallViewControllerDelegate.paywallViewController(_:didChangeSizeTo:)` (#3563) via Cesar de la Vega (@vegaro) * `Tests`: running tests on `macOS` (#3533) via NachoSoto (@NachoSoto) * `Integration Tests`: split into separate jobs (#3560) via NachoSoto (@NachoSoto)

Follow up to #3533 and #3549.

MarkVillacampa added the pr:fix A bug fix label Jan 2, 2024

MarkVillacampa requested a review from NachoSoto January 2, 2024 16:33

MarkVillacampa commented Jan 2, 2024

View reviewed changes

Tests/UnitTests/Misc/SandboxEnvironmentDetectorTests.swift Show resolved Hide resolved

NachoSoto reviewed Jan 3, 2024

View reviewed changes

MarkVillacampa commented Jan 3, 2024

View reviewed changes

NachoSoto reviewed Jan 4, 2024

View reviewed changes

MarkVillacampa force-pushed the sandbox-detector-mac branch from 5379cc6 to 897e432 Compare January 8, 2024 14:24

MarkVillacampa commented Jan 8, 2024

View reviewed changes

NachoSoto reviewed Jan 8, 2024

View reviewed changes

MarkVillacampa added 11 commits January 9, 2024 11:31

Improve sandbox detector for macOS apps

236b905

remove tests

e344a36

Parse environment from the receipt

1c5bce6

Use receipt environment to check sandbox environment on mac apps.

9734d78

Fix tests

d499fcf

Add error messages

732e9d0

Make receipt environment optional and fix tests

199cae3

fix test

c2f22f8

lint: improve error naming, code nesting and visibility

f0524b6

Add LocalReceiptFetcher as a simplified ReceiptFetcher

45c66fe

update pbxproj

7f027a9

MarkVillacampa force-pushed the sandbox-detector-mac branch from 7b473d1 to 7f027a9 Compare January 9, 2024 10:31

MarkVillacampa added 3 commits January 9, 2024 11:42

fix tests

2032d4d

Lint

bf59430

make receipt environment non-optional

2a6b726

NachoSoto approved these changes Jan 9, 2024

View reviewed changes

Sources/Misc/SandboxEnvironmentDetector.swift Outdated Show resolved Hide resolved

Update Sources/Misc/SandboxEnvironmentDetector.swift

fbc3a1f

Co-authored-by: NachoSoto <NachoSoto@users.noreply.github.com>

MarkVillacampa enabled auto-merge (squash) January 9, 2024 16:32

MarkVillacampa merged commit 84806ad into main Jan 9, 2024
23 checks passed

MarkVillacampa deleted the sandbox-detector-mac branch January 9, 2024 18:12

RCGitBot mentioned this pull request Jan 10, 2024

[AUTOMATIC] Release/4.31.8 #3565

Merged

NachoSoto added a commit that referenced this pull request Jan 10, 2024

SandboxEnvironmentDetector: more tests for macOS

a6629bb

Follow up to #3533 and #3549.

NachoSoto mentioned this pull request Jan 10, 2024

SandboxEnvironmentDetector: more tests for macOS #3568

Merged

		@@ -40,12 +44,19 @@ final class BundleSandboxEnvironmentDetector: SandboxEnvironmentDetector {
		return false

	case validating_bundle_signature
	case error_validating_bundle_signature


		internal extension PurchasesReceiptParser {

		func fetchAndParseLocalReceipt(

	return !isProductionReceipt \|\| !Self.isMacAppStore
	return !self.isProductionReceipt \|\| !Self.isMacAppStore


		private extension BundleSandboxEnvironmentDetector {

		var isProductionReceipt: Bool {

		@@ -16,46 +16,96 @@ import XCTest

		@testable import RevenueCat

		final class MockLocalReceiptFetcher: LocalReceiptFetcherType {

Improve sandbox detector for macOS apps #3549

Improve sandbox detector for macOS apps #3549

Conversation

MarkVillacampa commented Jan 2, 2024

NachoSoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MarkVillacampa Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

MarkVillacampa Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 3, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NachoSoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NachoSoto left a comment

Choose a reason for hiding this comment

MarkVillacampa Jan 3, 2024 •

edited

Loading

MarkVillacampa Jan 3, 2024 •

edited

Loading

codecov bot commented Jan 3, 2024 •

edited

Loading