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-5040] Channel presence now is exposed publicly as protocol #1995

Merged
merged 1 commit into from
Nov 8, 2024
Merged

[ECO-5040] Channel presence now is exposed publicly as protocol #1995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions Source/ARTRealtimeChannel.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ - (ARTErrorInfo *)errorReason {
return _internal.errorReason;
}

- (ARTRealtimePresence *)presence {
return [[ARTRealtimePresence alloc] initWithInternal:_internal.presence queuedDealloc:_dealloc];
- (id<ARTRealtimePresenceProtocol>)presence {
return [[ARTRealtimePresence alloc] initWithInternal:_internal.internalPresence queuedDealloc:_dealloc];
}

#if TARGET_OS_IPHONE
Expand Down Expand Up @@ -224,7 +224,7 @@ - (void)setOptions:(ARTRealtimeChannelOptions *_Nullable)options callback:(nulla
@end

@interface ARTRealtimeChannelInternal () {
ARTRealtimePresenceInternal *_realtimePresence;
ARTRealtimePresenceInternal *_internalPresence;
maratal marked this conversation as resolved.
Show resolved Hide resolved
#if TARGET_OS_IPHONE
ARTPushChannelInternal *_pushChannel;
#endif
Expand Down Expand Up @@ -263,7 +263,7 @@ - (instancetype)initWithRealtime:(ARTRealtimeInternal *)realtime andName:(NSStri
_restChannel = [_realtime.rest.channels _getChannel:self.name options:options addPrefix:true];
_state = ARTRealtimeChannelInitialized;
_attachSerial = nil;
_realtimePresence = [[ARTRealtimePresenceInternal alloc] initWithChannel:self logger:self.logger];
_internalPresence = [[ARTRealtimePresenceInternal alloc] initWithChannel:self logger:self.logger];
_statesEventEmitter = [[ARTPublicEventEmitter alloc] initWithRest:_realtime.rest logger:logger];
_messagesEventEmitter = [[ARTInternalEventEmitter alloc] initWithQueues:_queue userQueue:_userQueue];
_attachedEventEmitter = [[ARTInternalEventEmitter alloc] initWithQueue:_queue];
Expand Down Expand Up @@ -324,8 +324,8 @@ - (ARTErrorInfo *)errorReason_nosync {
return _errorReason;
}

- (ARTRealtimePresenceInternal *)presence {
return _realtimePresence;
- (id<ARTRealtimePresenceProtocol>)presence {
return _internalPresence;
}

#if TARGET_OS_IPHONE
Expand Down Expand Up @@ -567,14 +567,14 @@ - (void)performTransitionToState:(ARTRealtimeChannelState)state withParams:(ARTC
break;
case ARTRealtimeChannelDetached:
self.channelSerial = nil; // RTP5a1
[self.presence failsSync:params.errorInfo]; // RTP5a
[self.internalPresence failsSync:params.errorInfo]; // RTP5a
maratal marked this conversation as resolved.
Show resolved Hide resolved
break;
case ARTRealtimeChannelFailed:
self.channelSerial = nil; // RTP5a1
self.attachResume = false;
[_attachedEventEmitter emit:nil with:params.errorInfo];
[_detachedEventEmitter emit:nil with:params.errorInfo];
[self.presence failsSync:params.errorInfo]; // RTP5a
[self.internalPresence failsSync:params.errorInfo]; // RTP5a
break;
default:
break;
Expand Down Expand Up @@ -658,7 +658,7 @@ - (void)setAttached:(ARTProtocolMessage *)message {
}
ARTChannelStateChange *stateChange = [[ARTChannelStateChange alloc] initWithCurrent:state previous:state event:ARTChannelEventUpdate reason:message.error resumed:message.resumed];
[self emit:stateChange.event with:stateChange];
[self.presence onAttached:message];
[self.internalPresence onAttached:message];
}
return;
}
Expand All @@ -671,7 +671,7 @@ - (void)setAttached:(ARTProtocolMessage *)message {
}
params.resumed = message.resumed;
[self performTransitionToState:ARTRealtimeChannelAttached withParams:params];
[self.presence onAttached:message];
[self.internalPresence onAttached:message];
[_attachedEventEmitter emit:nil with:nil];
}

Expand Down Expand Up @@ -709,7 +709,7 @@ - (void)setDetached:(ARTProtocolMessage *)message {

- (void)failPendingPresenceWithState:(ARTState)state info:(nullable ARTErrorInfo *)info {
ARTStatus *const status = [ARTStatus state:state info:info];
[self.presence failPendingPresence:status];
[self.internalPresence failPendingPresence:status];
}

- (void)detachChannel:(ARTChannelStateChangeParams *)params {
Expand Down Expand Up @@ -804,11 +804,11 @@ - (void)onPresence:(ARTProtocolMessage *)message {
if (message.channelSerial) {
self.channelSerial = message.channelSerial;
}
[self.presence onMessage:message];
[self.internalPresence onMessage:message];
}

- (void)onSync:(ARTProtocolMessage *)message {
[self.presence onSync:message];
[self.internalPresence onSync:message];
}

- (void)onError:(ARTProtocolMessage *)msg {
Expand Down Expand Up @@ -1026,8 +1026,8 @@ - (void)detachAfterChecks {
[self->_detachedEventEmitter emit:nil with:errorInfo];
}] startTimer];

if (self.presence.syncInProgress_nosync) {
[self.presence failsSync:[ARTErrorInfo createWithCode:ARTErrorChannelOperationFailed message:@"channel is being DETACHED"]];
if (self.internalPresence.syncInProgress_nosync) {
[self.internalPresence failsSync:[ARTErrorInfo createWithCode:ARTErrorChannelOperationFailed message:@"channel is being DETACHED"]];
}
}

Expand Down
2 changes: 1 addition & 1 deletion Source/ARTRealtimeChannels.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ - (void)release:(NSString *)name callback:(ARTCallback)cb {
[channel _detach:^(ARTErrorInfo *errorInfo) {
[channel off_nosync];
[channel _unsubscribe];
[channel.presence _unsubscribe];
[channel.internalPresence _unsubscribe];

// Only release if the stored channel now is the same as whne.
// Otherwise, subsequent calls to this release method race, and
Expand Down
2 changes: 1 addition & 1 deletion Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN

@interface ARTRealtimeChannelInternal : ARTChannel <ARTRealtimeChannelProtocol>

@property (readonly) ARTRealtimePresenceInternal *presence;
@property (readonly) ARTRealtimePresenceInternal *internalPresence;
#if TARGET_OS_IPHONE
@property (readonly) ARTPushChannelInternal *push;
#endif
Expand Down
10 changes: 5 additions & 5 deletions Source/include/Ably/ARTRealtimeChannel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

NS_ASSUME_NONNULL_BEGIN

@class ARTRealtimePresence;
@class ARTRealtimeChannelOptions;
@class ARTChannelProperties;
#if TARGET_OS_IPHONE
Expand Down Expand Up @@ -39,6 +38,11 @@ NS_ASSUME_NONNULL_BEGIN
/// :nodoc: TODO: docstring
@property (readonly, nullable, getter=getOptions) ARTRealtimeChannelOptions *options;

/**
* An `ARTRealtimePresence` object.
*/
@property (readonly) id<ARTRealtimePresenceProtocol> presence;

/**
* A shortcut for the `-[ARTRealtimeChannelProtocol attach:]` method.
*/
Expand Down Expand Up @@ -180,10 +184,6 @@ ART_EMBED_INTERFACE_EVENT_EMITTER(ARTChannelEvent, ARTChannelStateChange *)
NS_SWIFT_SENDABLE
@interface ARTRealtimeChannel : NSObject <ARTRealtimeChannelProtocol>

/**
* An `ARTRealtimePresence` object.
*/
@property (readonly) ARTRealtimePresence *presence;
#if TARGET_OS_IPHONE
/**
* An `ARTPushChannel` object.
Expand Down
1 change: 0 additions & 1 deletion Source/include/Ably/ARTRealtimePresence.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
#import <Ably/ARTRestPresence.h>
#import <Ably/ARTDataQuery.h>
#import <Ably/ARTEventEmitter.h>
#import <Ably/ARTRealtimeChannel.h>

NS_ASSUME_NONNULL_BEGIN

Expand Down
22 changes: 11 additions & 11 deletions Test/Tests/RealtimeClientChannelTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,14 @@ class RealtimeClientChannelTests: XCTestCase {
channel2.attach()

XCTAssertFalse(channel2.presence.syncComplete)
XCTAssertEqual(channel1.internal.presence.members.count, 1)
XCTAssertEqual(channel2.internal.presence.members.count, 0)
XCTAssertEqual(channel1.internal.internalPresence.members.count, 1)
XCTAssertEqual(channel2.internal.internalPresence.members.count, 0)
maratal marked this conversation as resolved.
Show resolved Hide resolved
}

expect(channel2.presence.syncComplete).toEventually(beTrue(), timeout: testTimeout)

XCTAssertEqual(channel1.internal.presence.members.count, 1)
expect(channel2.internal.presence.members).toEventually(haveCount(1), timeout: testTimeout)
XCTAssertEqual(channel1.internal.internalPresence.members.count, 1)
expect(channel2.internal.internalPresence.members).toEventually(haveCount(1), timeout: testTimeout)
maratal marked this conversation as resolved.
Show resolved Hide resolved

waitUntil(timeout: testTimeout) { done in
channel1.publish("message", data: nil) { errorInfo in
Expand All @@ -212,14 +212,14 @@ class RealtimeClientChannelTests: XCTestCase {
}
}

expect(channel1.internal.presence.members).toEventually(haveCount(2), timeout: testTimeout)
expect(channel1.internal.presence.members.keys).to(allPass { $0.hasPrefix("\(channel1.internal.connectionId):Client") || $0.hasPrefix("\(channel2.internal.connectionId):Client") })
expect(channel1.internal.presence.members.values).to(allPass { $0.action == .present })
expect(channel1.internal.internalPresence.members).toEventually(haveCount(2), timeout: testTimeout)
expect(channel1.internal.internalPresence.members.keys).to(allPass { $0.hasPrefix("\(channel1.internal.connectionId):Client") || $0.hasPrefix("\(channel2.internal.connectionId):Client") })
expect(channel1.internal.internalPresence.members.values).to(allPass { $0.action == .present })

expect(channel2.internal.presence.members).toEventually(haveCount(2), timeout: testTimeout)
expect(channel2.internal.presence.members.keys).to(allPass { $0.hasPrefix("\(channel1.internal.connectionId):Client") || $0.hasPrefix("\(channel2.internal.connectionId):Client") })
XCTAssertEqual(channel2.internal.presence.members["\(channel1.internal.connectionId):Client 1"]!.action, ARTPresenceAction.present)
XCTAssertEqual(channel2.internal.presence.members["\(channel2.internal.connectionId):Client 2"]!.action, ARTPresenceAction.present)
expect(channel2.internal.internalPresence.members).toEventually(haveCount(2), timeout: testTimeout)
expect(channel2.internal.internalPresence.members.keys).to(allPass { $0.hasPrefix("\(channel1.internal.connectionId):Client") || $0.hasPrefix("\(channel2.internal.connectionId):Client") })
XCTAssertEqual(channel2.internal.internalPresence.members["\(channel1.internal.connectionId):Client 1"]!.action, ARTPresenceAction.present)
XCTAssertEqual(channel2.internal.internalPresence.members["\(channel2.internal.connectionId):Client 2"]!.action, ARTPresenceAction.present)
}

// RTL2
Expand Down
Loading
Loading