fix: Data race in AWSModelReconciliationQueue (#790)

palpatim · web-flow · commit 29f0babf8352 · 2020-09-30T17:59:39.000-07:00
* chore: Enable thread sanitizer in tests

* fix: Data race in AWSModelReconciliationQueue

* fix: Data races in test code

* chore: Enable threadSanitizer in AWSPluginsCore

* chore: Enable threadSanitizer in API plugin

* chore: Enable threadSanitizer in Auth plugin

* chore: Enable threadSanitizer in Predictions plugin

* chore: Enable threadSanitizer and code coverage in Storage plugin
diff --git a/Amplify.xcodeproj/xcshareddata/xcschemes/AWSPluginsCore.xcscheme b/Amplify.xcodeproj/xcshareddata/xcschemes/AWSPluginsCore.xcscheme
@@ -26,7 +26,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSAPICategoryPlugin.xcscheme b/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSAPICategoryPlugin.xcscheme
@@ -40,7 +40,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/GraphQLWithIAMIntegrationTests.xcscheme b/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/GraphQLWithIAMIntegrationTests.xcscheme
@@ -10,7 +10,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/GraphQLWithUserPoolIntegrationTests.xcscheme b/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/GraphQLWithUserPoolIntegrationTests.xcscheme
@@ -10,7 +10,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/RESTWithIAMIntegrationTests.xcscheme b/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/RESTWithIAMIntegrationTests.xcscheme
@@ -10,7 +10,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/RESTWithUserPoolIntegrationTests.xcscheme b/AmplifyPlugins/API/APICategoryPlugin.xcodeproj/xcshareddata/xcschemes/RESTWithUserPoolIntegrationTests.xcscheme
@@ -10,7 +10,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin.xcodeproj/xcshareddata/xcschemes/AWSCognitoAuthPlugin.xcscheme b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin.xcodeproj/xcshareddata/xcschemes/AWSCognitoAuthPlugin.xcscheme
@@ -40,7 +40,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Sync/SubscriptionSync/ReconcileAndLocalSave/AWSModelReconciliationQueue.swift b/AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Sync/SubscriptionSync/ReconcileAndLocalSave/AWSModelReconciliationQueue.swift
@@ -64,7 +64,7 @@ final class AWSModelReconciliationQueue: ModelReconciliationQueue {
     private let modelName: String
 
     private var incomingEventsSink: AnyCancellable?
-    private var reconcileAndLocalSaveOperationSinks: Set<AnyCancellable?>
+    private var reconcileAndLocalSaveOperationSinks: AtomicValue<Set<AnyCancellable?>>
 
     private let modelReconciliationQueueSubject: PassthroughSubject<ModelReconciliationQueueEvent, DataStoreError>
     var publisher: AnyPublisher<ModelReconciliationQueueEvent, DataStoreError> {
@@ -98,7 +98,7 @@ final class AWSModelReconciliationQueue: ModelReconciliationQueue {
         let resolvedIncomingSubscriptionEvents = incomingSubscriptionEvents ??
             AWSIncomingSubscriptionEventPublisher(modelType: modelType, api: api, auth: auth)
         self.incomingSubscriptionEvents = resolvedIncomingSubscriptionEvents
-        self.reconcileAndLocalSaveOperationSinks = Set<AnyCancellable?>()
+        self.reconcileAndLocalSaveOperationSinks = AtomicValue(initialValue: Set<AnyCancellable?>())
         self.incomingEventsSink = resolvedIncomingSubscriptionEvents
             .publisher
             .sink(receiveCompletion: { [weak self] completion in
@@ -136,14 +136,14 @@ final class AWSModelReconciliationQueue: ModelReconciliationQueue {
         var reconcileAndLocalSaveOperationSink: AnyCancellable?
 
         reconcileAndLocalSaveOperationSink = reconcileOp.publisher.sink(receiveCompletion: { completion in
-            self.reconcileAndLocalSaveOperationSinks.remove(reconcileAndLocalSaveOperationSink)
+            self.reconcileAndLocalSaveOperationSinks.with { $0.remove(reconcileAndLocalSaveOperationSink) }
             if case .failure = completion {
                 self.modelReconciliationQueueSubject.send(completion: completion)
             }
         }, receiveValue: { mutationEvent in
             self.modelReconciliationQueueSubject.send(.mutationEvent(mutationEvent))
         })
-        reconcileAndLocalSaveOperationSinks.insert(reconcileAndLocalSaveOperationSink)
+        reconcileAndLocalSaveOperationSinks.with { $0.insert(reconcileAndLocalSaveOperationSink) }
         reconcileAndSaveQueue.addOperation(reconcileOp)
     }
 
diff --git a/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/TestSupport/Mocks/MockAWSIncomingEventReconciliationQueue.swift b/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/TestSupport/Mocks/MockAWSIncomingEventReconciliationQueue.swift
@@ -24,7 +24,7 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue
         return incomingEventSubject.eraseToAnyPublisher()
     }
 
-    static var lastInstance: MockAWSIncomingEventReconciliationQueue?
+    static var lastInstance = AtomicValue<MockAWSIncomingEventReconciliationQueue?>(initialValue: nil)
     init(modelTypes: [Model.Type],
          api: APICategoryGraphQLBehavior,
          storageAdapter: StorageEngineAdapter,
@@ -34,7 +34,7 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue
     }
 
     func updateLastInstance(instance: MockAWSIncomingEventReconciliationQueue) {
-        MockAWSIncomingEventReconciliationQueue.lastInstance = instance
+        MockAWSIncomingEventReconciliationQueue.lastInstance.set(instance)
     }
 
     func start() {
@@ -50,11 +50,11 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue
     }
 
     static func mockSendCompletion(completion: Subscribers.Completion<DataStoreError>) {
-        lastInstance?.incomingEventSubject.send(completion: completion)
+        lastInstance.get()?.incomingEventSubject.send(completion: completion)
     }
 
     static func mockSend(event: IncomingEventReconciliationQueueEvent) {
-        lastInstance?.incomingEventSubject.send(event)
+        lastInstance.get()?.incomingEventSubject.send(event)
     }
 
     func cancel() {
diff --git a/AmplifyPlugins/DataStore/DataStoreCategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSDataStoreCategoryPlugin.xcscheme b/AmplifyPlugins/DataStore/DataStoreCategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSDataStoreCategoryPlugin.xcscheme
@@ -26,7 +26,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyPlugins/Predictions/PredictionsCategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSPredictionsPlugin.xcscheme b/AmplifyPlugins/Predictions/PredictionsCategoryPlugin.xcodeproj/xcshareddata/xcschemes/AWSPredictionsPlugin.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES"
       codeCoverageEnabled = "YES"
       onlyGenerateCoverageForSpecifiedTargets = "YES">
       <CodeCoverageTargets>
diff --git a/AmplifyPlugins/Predictions/PredictionsCategoryPlugin.xcodeproj/xcshareddata/xcschemes/CoreMLPredictionsPlugin.xcscheme b/AmplifyPlugins/Predictions/PredictionsCategoryPlugin.xcodeproj/xcshareddata/xcschemes/CoreMLPredictionsPlugin.xcscheme
@@ -41,6 +41,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES"
       codeCoverageEnabled = "YES"
       onlyGenerateCoverageForSpecifiedTargets = "YES">
       <CodeCoverageTargets>
diff --git a/AmplifyPlugins/Storage/StoragePlugin.xcodeproj/xcshareddata/xcschemes/AWSS3StoragePlugin.xcscheme b/AmplifyPlugins/Storage/StoragePlugin.xcodeproj/xcshareddata/xcschemes/AWSS3StoragePlugin.xcscheme
@@ -26,7 +26,19 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableThreadSanitizer = "YES"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "B478F5FA2374DBF400C4F92B"
+            BuildableName = "AWSS3StoragePlugin.framework"
+            BlueprintName = "AWSS3StoragePlugin"
+            ReferencedContainer = "container:StoragePlugin.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">
diff --git a/AmplifyTestCommon/Mocks/MessageReporter.swift b/AmplifyTestCommon/Mocks/MessageReporter.swift
@@ -5,12 +5,14 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
+
 class MessageReporter {
     /// Callbacks to be invoked
-    var listeners = [(String) -> Void]()
+    var listeners = AtomicValue<[(String) -> Void]>(initialValue: [])
 
     func notify(_ message: String = #function) {
-        listeners.forEach { $0(message) }
+        listeners.get().forEach { $0(message) }
     }
 
     init() {
diff --git a/AmplifyTestCommon/Mocks/MockAPICategoryPlugin.swift b/AmplifyTestCommon/Mocks/MockAPICategoryPlugin.swift
@@ -24,7 +24,7 @@ class MockAPICategoryPlugin: MessageReporter, APICategoryPlugin {
 
     func reset(onComplete: @escaping BasicClosure) {
         notify("reset")
-        listeners = []
+        listeners.set([])
         onComplete()
     }
 

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue`
`24`	`24`	`return incomingEventSubject.eraseToAnyPublisher()`
`25`	`25`	`}`
`26`	`26`
`27`		`- static var lastInstance: MockAWSIncomingEventReconciliationQueue?`
	`27`	`+ static var lastInstance = AtomicValue<MockAWSIncomingEventReconciliationQueue?>(initialValue: nil)`
`28`	`28`	`init(modelTypes: [Model.Type],`
`29`	`29`	`api: APICategoryGraphQLBehavior,`
`30`	`30`	`storageAdapter: StorageEngineAdapter,`
`@@ -34,7 +34,7 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func updateLastInstance(instance: MockAWSIncomingEventReconciliationQueue) {`
`37`		`- MockAWSIncomingEventReconciliationQueue.lastInstance = instance`
	`37`	`+ MockAWSIncomingEventReconciliationQueue.lastInstance.set(instance)`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`func start() {`
`@@ -50,11 +50,11 @@ class MockAWSIncomingEventReconciliationQueue: IncomingEventReconciliationQueue`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`static func mockSendCompletion(completion: Subscribers.Completion<DataStoreError>) {`
`53`		`- lastInstance?.incomingEventSubject.send(completion: completion)`
	`53`	`+ lastInstance.get()?.incomingEventSubject.send(completion: completion)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`static func mockSend(event: IncomingEventReconciliationQueueEvent) {`
`57`		`- lastInstance?.incomingEventSubject.send(event)`
	`57`	`+ lastInstance.get()?.incomingEventSubject.send(event)`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`func cancel() {`