Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ECO-4818] Introducing syncInProgress/syncInProgress_nosync pair #1931

Merged
merged 2 commits into from
Jun 13, 2024
Merged

[ECO-4818] Introducing syncInProgress/syncInProgress_nosync pair #1931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d06857a
Introducing `syncInProgress`/`syncInProgress_nosync` pair to properly…
maratal Jun 9, 2024
28f22fd
Removed redundant callback parameter.
maratal Jun 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Source/ARTRealtimeChannel.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,10 +899,10 @@ - (void)internalAttach:(ARTCallback)callback withParams:(ARTAttachRequestParams
const ARTState state = params.reason ? ARTStateError : ARTStateOk;
ARTChannelStateChangeParams *const stateChangeParams = [[ARTChannelStateChangeParams alloc] initWithState:state errorInfo:params.reason storeErrorInfo:NO retryAttempt:params.retryAttempt];
[self performTransitionToState:ARTRealtimeChannelAttaching withParams:stateChangeParams];
[self attachAfterChecks:callback];
[self attachAfterChecks];
}

- (void)attachAfterChecks:(ARTCallback)callback {
- (void)attachAfterChecks {
ARTProtocolMessage *attachMessage = [[ARTProtocolMessage alloc] init];
attachMessage.action = ARTProtocolMessageAttach;
attachMessage.channel = self.name;
Expand Down Expand Up @@ -1026,7 +1026,7 @@ - (void)detachAfterChecks:(ARTCallback)callback {
}];
}

if (self.presence.syncInProgress) {
if (self.presence.syncInProgress_nosync) {
[self.presence failsSync:[ARTErrorInfo createWithCode:ARTErrorChannelOperationFailed message:@"channel is being DETACHED"]];
}
}
Expand Down
16 changes: 12 additions & 4 deletions Source/ARTRealtimePresence.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ - (void)get:(ARTRealtimePresenceQuery *)query callback:(ARTPresenceMessagesCallb
callback(nil, error);
return;
}
const BOOL syncInProgress = self.syncInProgress;
const BOOL syncInProgress = self.syncInProgress_nosync;
if (syncInProgress && query.waitForSync) {
ARTLogDebug(self.logger, @"R:%p C:%p (%@) sync is in progress, waiting until the presence members is synchronized", self->_realtime, self->_channel, self->_channel.name);
[self onceSyncEnds:^(NSArray<ARTPresenceMessage *> *members) {
Expand Down Expand Up @@ -748,7 +748,7 @@ - (void)onMessage:(ARTProtocolMessage *)message {
}

- (void)onSync:(ARTProtocolMessage *)message {
if (!self.syncInProgress) {
if (!self.syncInProgress_nosync) {
[self startSync];
}
else {
Expand Down Expand Up @@ -838,7 +838,7 @@ - (void)processMember:(ARTPresenceMessage *)message {
memberUpdated = [self addMember:messageCopy];
break;
case ARTPresenceLeave:
if (self.syncInProgress) {
if (self.syncInProgress_nosync) {
messageCopy.action = ARTPresenceAbsent; // RTP2f
memberUpdated = [self addMember:messageCopy];
} else {
Expand Down Expand Up @@ -974,10 +974,18 @@ - (void)onceSyncFails:(ARTCallback)callback {
[_syncEventEmitter once:[ARTEvent newWithPresenceSyncState:ARTPresenceSyncFailed] callback:callback];
}

- (BOOL)syncInProgress {
- (BOOL)syncInProgress_nosync {
return _syncState == ARTPresenceSyncStarted;
}

- (BOOL)syncInProgress {
__block BOOL ret;
dispatch_sync(_queue, ^{
ret = [self syncInProgress_nosync];
});
return ret;
}

@end

#pragma mark - ARTEvent
Expand Down
1 change: 1 addition & 0 deletions Source/PrivateHeaders/Ably/ARTRealtimePresence+Private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithChannel:(ARTRealtimeChannelInternal *)channel logger:(ARTInternalLog *)logger;
- (void)_unsubscribe;
- (BOOL)syncComplete_nosync;
- (BOOL)syncInProgress_nosync;
maratal marked this conversation as resolved.
Show resolved Hide resolved

- (void)failPendingPresence:(ARTStatus *)status;
- (void)broadcast:(ARTPresenceMessage *)pm;
Expand Down
4 changes: 2 additions & 2 deletions Test/Tests/RealtimeClientPresenceTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1698,7 +1698,7 @@ class RealtimeClientPresenceTests: XCTestCase {
return protocolMessage
}
channel.internal.presence.testSuite_injectIntoMethod(after: #selector(ARTRealtimePresenceInternal.endSync)) {
XCTAssertFalse(channel.internal.presence.syncInProgress)
XCTAssertFalse(channel.internal.presence.syncInProgress_nosync())
XCTAssertEqual(channel.internal.presence.members.count, 19)
XCTAssertEqual(channel.internal.presence.members.filter { _, presence in presence.clientId == "user10" && presence.action == .present }.count, 1) // LEAVE for user10 is ignored, because it's timestamped before SYNC
XCTAssertEqual(channel.internal.presence.members.filter { _, presence in presence.clientId == "user12" && presence.action == .present }.count, 0) // LEAVE for user12 is not ignored, because it's timestamped after SYNC
Expand Down Expand Up @@ -1757,7 +1757,7 @@ class RealtimeClientPresenceTests: XCTestCase {
waitUntil(timeout: testTimeout) { done in
let partialDone = AblyTests.splitDone(2, done: done)
channel.internal.presence.testSuite_injectIntoMethod(after: #selector(ARTRealtimePresenceInternal.endSync)) {
XCTAssertFalse(channel.internal.presence.syncInProgress)
XCTAssertFalse(channel.internal.presence.syncInProgress_nosync())
partialDone()
}
channel.attach { error in
Expand Down
Loading