feat(datastore): Dispatch outboxStatus, subscriptionsEstablished, syncQueriesStarted events #721
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // | ||
| // Copyright 2018-2020 Amazon.com, | ||
| // Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
|
|
||
lawmicha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// Used as HubPayload for the `OutboxStatus` | ||
| public struct OutboxStatusEvent { | ||
| /// status of outbox: empty or not | ||
|
There was a problem hiding this comment. " |
||
| public let isEmpty: Bool | ||
|
|
||
| public init(isEmpty: Bool) { | ||
| self.isEmpty = isEmpty | ||
| } | ||
| } | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // | ||
| // Copyright 2018-2020 Amazon.com, | ||
| // Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
|
|
||
| /// Used as HubPayload for the `SyncQueriesStarted` | ||
| public struct SyncQueriesStartedEvent { | ||
| /// list of model names | ||
|
There was a problem hiding this comment. "A list of all model names for which DataStore has started establishing subscriptions" |
||
| public let models: [String] | ||
|
|
||
| public init(models: [String]) { | ||
| self.models = models | ||
| } | ||
| } | ||
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -138,10 +138,12 @@ final class OutgoingMutationQueue: OutgoingMutationQueueBehavior { | |
| mutationEventPublisher: MutationEventPublisher) { | ||
| log.verbose(#function) | ||
| self.api = api | ||
|
|
||
| queryMutationEventsFromStorage(onComplete: { | ||
| self.operationQueue.isSuspended = false | ||
| // State machine notification to ".receivedSubscription" will be handled in `receive(subscription:)` | ||
| mutationEventPublisher.publisher.subscribe(self) | ||
| }) | ||
| } | ||
|
|
||
| // MARK: - Event loop processing | ||
|
|
@@ -187,6 +189,8 @@ final class OutgoingMutationQueue: OutgoingMutationQueueBehavior { | |
| "[SyncMutationToCloudOperation] mutationEvent finished: \(mutationEvent.id); result: \(result)") | ||
| self.processSyncMutationToCloudResult(result, mutationEvent: mutationEvent, api: api) | ||
| } | ||
|
|
||
| dispatchOutboxStatusEvent(isEmpty: false) | ||
| operationQueue.addOperation(syncMutationToCloudOperation) | ||
| stateMachine.notify(action: .enqueuedEvent) | ||
| } | ||
|
|
@@ -241,10 +245,36 @@ final class OutgoingMutationQueue: OutgoingMutationQueueBehavior { | |
| self.log.verbose("mutationEvent deleted successfully") | ||
| } | ||
|
|
||
| self.dispatchOutboxStatusEvent(isEmpty: true) | ||
|
There was a problem hiding this comment. How do you know the outbox is empty here? Shouldn't you be querying the mutation events from storage, or checking the There was a problem hiding this comment. Right, it makes sense. There was a problem hiding this comment. As i understand it, we were emitting outboxStatus events to this logic (this is probably wrong then)
example output There was a problem hiding this comment. or is the expected behavior just a ping of the outbox status? for example There was a problem hiding this comment. @lawmicha the second behavior is the expected one. For reference, this is the JS implementation: It checks the queue |
||
| self.stateMachine.notify(action: .processedEvent) | ||
| } | ||
| } | ||
|
|
||
| private func queryMutationEventsFromStorage(onComplete: @escaping (() -> Void)) { | ||
| let fields = MutationEvent.keys | ||
| let predicate = fields.inProcess == false || fields.inProcess == nil | ||
|
|
||
| storageAdapter.query(MutationEvent.self, | ||
| predicate: predicate, | ||
| sort: nil, | ||
| paginationInput: nil) { result in | ||
| switch result { | ||
| case .success(let events): | ||
| self.dispatchOutboxStatusEvent(isEmpty: events.isEmpty) | ||
| case .failure(let error): | ||
| log.error("Error quering mutation events: \(error)") | ||
|
|
||
| } | ||
| onComplete() | ||
| } | ||
| } | ||
|
|
||
| private func dispatchOutboxStatusEvent(isEmpty: Bool) { | ||
| let outboxStatusEvent = OutboxStatusEvent(isEmpty: isEmpty) | ||
| let outboxStatusEventPayload = HubPayload(eventName: HubPayload.EventName.DataStore.outboxStatus, | ||
| data: outboxStatusEvent) | ||
| Amplify.Hub.dispatch(to: .dataStore, payload: outboxStatusEventPayload) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @available(iOS 13.0, *) | ||
|
|
||
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // | ||
| // Copyright 2018-2020 Amazon.com, | ||
| // Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import XCTest | ||
|
|
||
| import AmplifyPlugins | ||
| import AWSPluginsCore | ||
|
|
||
| @testable import Amplify | ||
| @testable import AmplifyTestCommon | ||
| @testable import AWSDataStoreCategoryPlugin | ||
|
|
||
| @available(iOS 13.0, *) | ||
| class DataStoreHubEventTests: HubEventsIntegrationTestBase { | ||
|
|
||
| /// - Given: | ||
| /// - registered two models from `TestModelRegistration` | ||
| /// - no pending MutationEvents in MutationEvent database | ||
| /// - When: | ||
| /// - DataStore's remote sync engine is initialized | ||
| /// - Then: | ||
| /// - subscriptionEstablished received, payload should be nil | ||
| /// - syncQueriesStarted received, payload should be: {models: ["Post", "Comment"]} | ||
| /// - outboxStatus received, payload should be {isEmpty: true} | ||
| func testDataStoreConfiguredDispatchesHubEvents() throws { | ||
|
|
||
| let subscriptionsEstablishedReceived = expectation(description: "subscriptionsEstablished received") | ||
| let syncQueriesStartedReceived = expectation(description: "syncQueriesStarted received") | ||
| let outboxStatusReceived = expectation(description: "outboxStatus received") | ||
|
|
||
| let hubListener = Amplify.Hub.listen(to: .dataStore) { payload in | ||
| if payload.eventName == HubPayload.EventName.DataStore.subscriptionsEstablished { | ||
| XCTAssertNil(payload.data) | ||
| subscriptionsEstablishedReceived.fulfill() | ||
| } | ||
|
|
||
| if payload.eventName == HubPayload.EventName.DataStore.syncQueriesStarted { | ||
| guard let syncQueriesStartedEvent = payload.data as? SyncQueriesStartedEvent else { | ||
| XCTFail("Failed to cast payload data as SyncQueriesStartedEvent") | ||
| return | ||
| } | ||
| XCTAssertEqual(syncQueriesStartedEvent.models.count, 2) | ||
lawmicha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| syncQueriesStartedReceived.fulfill() | ||
| } | ||
|
|
||
| if payload.eventName == HubPayload.EventName.DataStore.outboxStatus { | ||
| guard let outboxStatusEvent = payload.data as? OutboxStatusEvent else { | ||
| XCTFail("Failed to cast payload data as OutboxStatusEvent") | ||
| return | ||
| } | ||
| XCTAssertTrue(outboxStatusEvent.isEmpty) | ||
| outboxStatusReceived.fulfill() | ||
| } | ||
| } | ||
|
|
||
| guard try HubListenerTestUtilities.waitForListener(with: hubListener, timeout: 5.0) else { | ||
| XCTFail("Listener not registered for hub") | ||
| return | ||
| } | ||
|
|
||
| waitForExpectations(timeout: networkTimeout, handler: nil) | ||
| } | ||
| } | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // | ||
| // Copyright 2018-2020 Amazon.com, | ||
| // Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import XCTest | ||
|
|
||
| import AmplifyPlugins | ||
| import AWSMobileClient | ||
|
|
||
| @testable import Amplify | ||
| @testable import AmplifyTestCommon | ||
| @testable import AWSDataStoreCategoryPlugin | ||
|
|
||
| class HubEventsIntegrationTestBase: XCTestCase { | ||
lawmicha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| static let networkTimeout = TimeInterval(180) | ||
| let networkTimeout = HubEventsIntegrationTestBase.networkTimeout | ||
|
|
||
| override func setUp() { | ||
| super.setUp() | ||
|
|
||
| continueAfterFailure = false | ||
|
|
||
| let bundle = Bundle(for: type(of: self)) | ||
| guard let configFile = bundle.url(forResource: "amplifyconfiguration", withExtension: "json") else { | ||
| XCTFail("Could not get URL for amplifyconfiguration.json from \(bundle)") | ||
| return | ||
| } | ||
|
|
||
| do { | ||
| let configData = try Data(contentsOf: configFile) | ||
| let amplifyConfig = try JSONDecoder().decode(AmplifyConfiguration.self, from: configData) | ||
| try Amplify.add(plugin: AWSAPIPlugin(modelRegistration: TestModelRegistration())) | ||
| try Amplify.add(plugin: AWSDataStorePlugin(modelRegistration: TestModelRegistration())) | ||
| try Amplify.configure(amplifyConfig) | ||
| } catch { | ||
| XCTFail(String(describing: error)) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| override func tearDown() { | ||
| sleep(1) | ||
| print("Amplify reset") | ||
| Amplify.reset() | ||
| } | ||
| } | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarify wording: "Dispatched when: 1) the DataStore starts; 2) each time a local mutation is enqueued into the outbox; 3) each time a local mutation is finished processing."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated