ShopifyCheckoutKit.Configuration: NSLock guaranteed

[kieran-osgood-shopify]

Problem

Swift 6 is stricter about global/shared mutable state. In Swift 6 language mode, a mutable global like this becomes a concurrency-safety problem:

public var configuration = Configuration()

The compiler treats this as non-isolated shared mutable state: any caller in the process can read or write it, and Swift has no guarantee that those accesses are serialized.

The kind of error we are working toward eliminating is:

  var 'configuration' is not concurrency-safe because it is nonisolated global shared mutable state

This matters for ShopifyCheckoutKit.configuration because it is public process-wide configuration, and it currently also drives side effects like updating OSLogger.shared.logLevel.

Options considered

I considered both making configuration @MainActor or wrapping the configuration inside an actor
Both of these result in suboptimal results, actor would make all reads async/await, @MainActor would result in all reads needing to be MainActor isolated event for background tasks.
This is not ideal for our library code, because reading log levels or constructing user agents, which should be sync and should not cross to the main actor, all then rely on tasks and async/await, it would complicate library code significantly with workarounds for sync to async

What

The "synchronous synchronization" option is an NSLock or Semaphore
Its a bit manual and can result in deadlocks, but essentially we wrap up reading/writing to this value behind an explicit lock.

For this binary single access mutual exclusion NSLock / DispatchSemaphore perform the same, but NSLock ships with a helper withLock to guarantee release around a closure (easy enough to add to semaphore, but no actual benefit).

---

Before you merge

Important

• I've added tests to support my implementation
• I have read and agree with the Contribution Guidelines
• I have read and agree with the Code of Conduct
• I've updated the relevant platform README (platforms/swift/README.md and/or platforms/android/README.md)

---

Releasing a new Swift version?

• I have bumped the version in platforms/swift/ShopifyCheckoutKit.podspec
• I have bumped the version in platforms/swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swift
• I have updated platforms/swift/CHANGELOG.md
• I have updated the SwiftPM/CocoaPods version snippets in platforms/swift/README.md (major version only)

Releasing a new Android version?

• I have bumped the versionName in platforms/android/lib/build.gradle
• I have updated platforms/android/CHANGELOG.md
• I have updated the Gradle/Maven version snippets in platforms/android/README.md

Tip

See the Contributing documentation for the full release process per platform.

[kieran-osgood-shopify]

• Fix Swift 6 test target isolation #91 : 2 dependent PRs (#98 , #99 )
• Align PassKit protocol abstractions with Swift 6 #90
• Isolate wallet controllers to the main actor #89
• #88 Continuation: Make AcceleratedCheckouts.Configuration Sendable #274
• AC Storefront: GraphQL values Sendable #88
• Make generated JSON coding key Sendable #87
• Logger: NSLock guaranteed #86
• ShopifyCheckoutKit.Configuration: NSLock guaranteed #85 👈 (View in Graphite)
• UI: @MainActor isolated #84
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

React Native — Coverage Report

Lines	Statements	Branches	Functions
	91.66% (319/348)	87.86% (181/206)	100% (82/82)

[kieran-osgood-shopify]

Merge activity

• Jun 15, 1:49 PM UTC: @kieran-osgood-shopify merged this pull request with Graphite.