Realtime Channel attach, detach and state events #20

tiholic · 2020-07-22T15:31:58Z

Realtime Channel API enhancement

Implementation for Realtime's ChannelStateChange event listener
attach and detach implemented on a RealtimeChannel
setOptions method is updated to throw an exception, as ChannelOptions are not supported in current PR

Other (non-API) enhancements

Ability to pass payload via EventChannel for listening to platform events. That payload can be passed as an AblyEventMessage. This is similar to AblyMessage except that it carries an eventName attributes instead of a handleId
implement new platform methods attachRealtimeChannel, detachRealtimeChannel, setRealtimeChannelOptions

QuintinWillison

I've done a first sweep - there's sure to be stuff I've overlooked but I think there's enough feedback here to keep you busy with some improvements that'll make the code easier to read. Please, please, please default to using final / const wherever possible - in particular final for Java object references and const for Objective-C object pointers. They make your intent clear, in particular within the busier methods and functions where local variable intent, purpose and mutability is not always clear.

android/src/main/java/io/ably/flutter/plugin/AblyEventStreamHandler.java

android/src/main/java/io/ably/flutter/plugin/AblyFlutterMessage.java

android/src/main/java/io/ably/flutter/plugin/AblyMethodCallHandler.java

android/src/main/java/io/ably/flutter/plugin/generated/PlatformConstants.java

example/lib/main.dart

android/src/main/java/io/ably/flutter/plugin/AblyMethodCallHandler.java

ios/Classes/AblyFlutterPlugin.m

ref: #20 (comment)

ConnectionStateChange.current is set as RealtimeConnection~state as soon as event is received before giving it back to source listeners.

1. Channel can be created by passing just the name or both name and channel options 2. As de-registering just requires getting hold of a channel name, options is not used in onCancel method on platform side 3. Example updated with API Support: Android ✓ iOS ✓

…ptions 1. `attachRealtimeChannel` - to attach to a channel 2. `detachRealtimeChannel` - to detach from a channel 3. `setRealtimeChannelOptions` - to update channel options

1. Returning proper message for errors reg. "onRealtimeChannelStateChanged" 2. ChannelStateChange errorInfo decoding handled properly

1. attach and detach use completion listeners/callbacks 2. setOptions is supported only on android side as cocoa doesn't have that API yet (may be 🤔) Android RealtimeChannelStateChange listener implemented Support: Android ✓ iOS ✓

Enable "close connection", "Attach to channel" and "Detach from channel" Dispose listeners on widget dispose.

Remove unwanted comments, delays Added necessary comments and print logs in example

Channel options support is completely removed from dart side, but the methods are retained on Android/iOS side as to support at later point in time.

Create an inline listener and update the connection and channel state property respectively

ref: #20 (comment)

zoechi

A few suggestions

lib/src/impl/realtime/channels.dart

example/lib/main.dart

lib/src/impl/message.dart

lib/src/impl/platform_object.dart

lib/src/impl/realtime/channels.dart

#20 (comment) #20 (comment)

#20 (comment)

ref: #20 (comment)

#20 (comment) #20 (comment)

#20 (comment)

ref: #20 (comment)

tiholic requested review from QuintinWillison, mattheworiordan and paddybyers July 22, 2020 15:32

QuintinWillison changed the base branch from master to main July 23, 2020 07:53

QuintinWillison suggested changes Jul 23, 2020

View reviewed changes

tiholic added a commit that referenced this pull request Jul 30, 2020

making variables final

bb9f4f5

ref: #20 (comment)

tiholic added 23 commits August 3, 2020 16:03

RealtimeConnection conforming to RTN4d

9cb06a5

ConnectionStateChange.current is set as RealtimeConnection~state as soon as event is received before giving it back to source listeners.

introducing new platform constant ablyEventMessage - CodeGen only

197f31a

ablyEventMessage related definitions, encoder/decoders

f43bc8b

ablyEventMessage in action - event trigger happens via EventMessage

d111df1

new platform constants CodeGen for attach/detach channel and update o…

4da54e0

…ptions 1. `attachRealtimeChannel` - to attach to a channel 2. `detachRealtimeChannel` - to detach from a channel 3. `setRealtimeChannelOptions` - to update channel options

minor fixes

0208814

1. Returning proper message for errors reg. "onRealtimeChannelStateChanged" 2. ChannelStateChange errorInfo decoding handled properly

fix wrong event name

6997a1a

fix nil issue! >_<

29aff63

new APIs: attach, detach and setOptions

d07cd19

1. attach and detach use completion listeners/callbacks 2. setOptions is supported only on android side as cocoa doesn't have that API yet (may be 🤔) Android RealtimeChannelStateChange listener implemented Support: Android ✓ iOS ✓

update example

a0aad22

Enable "close connection", "Attach to channel" and "Detach from channel" Dispose listeners on widget dispose.

cleanup code:

ded7bbd

Remove unwanted comments, delays Added necessary comments and print logs in example

update README, remove support for ChannelOptions

0ee73a7

Channel options support is completely removed from dart side, but the methods are retained on Android/iOS side as to support at later point in time.

update state property in Connection and Channel

33e7a9b

Create an inline listener and update the connection and channel state property respectively

cleanup

dcec0e6

added trailing comma, for future benefit

d13ad56

fix stale comment

fe3c0a8

raising NPE is better than assert while validating null values

256e0b3

improvise comment on example

0f700a7

indentation fix: mixed up tabs and spaces for generated java files

9f4d325

fix and optimize event type specific listener

835bbfd

making all block scoped variables constant and the blocks themselves

d2614d4

making variables final

f7bf23f

ref: #20 (comment)

tiholic force-pushed the feature/channel-state-events branch from bb9f4f5 to f7bf23f Compare August 3, 2020 10:34

tiholic requested a review from zoechi August 3, 2020 11:27

zoechi suggested changes Aug 3, 2020

View reviewed changes

This was referenced Aug 4, 2020

Add linting rules #30

Closed

Manual testing on RTN14 and RTN15 #27

Merged

tiholic added 3 commits August 5, 2020 01:09

dynamic -> object and constructor optimization

c0fb7c7

#20 (comment) #20 (comment)

simplify get _payload syntax in realtime channel

3958791

syntactic sugar

8c5196f

#20 (comment)

tiholic mentioned this pull request Aug 4, 2020

Realtime message subscription #21

Merged

mutableCopy -> copy

efc5104

tiholic mentioned this pull request Aug 11, 2020

Fix: iOS hot-restart issue with active listeners #26

Merged

tiholic added 4 commits August 12, 2020 14:07

fixing payload getter to make more sense:

4a82e39

ref: #20 (comment)

optimizing registration and handle acquisition! neat.

2976017

adding comment on why is used

b5c5387

marking name and options as final in channel

353bded

zoechi approved these changes Aug 12, 2020

View reviewed changes

tiholic merged commit f5c67ff into main Aug 12, 2020

tiholic added a commit that referenced this pull request Aug 12, 2020

making variables final

e5fd6c2

ref: #20 (comment)

tiholic added a commit that referenced this pull request Aug 12, 2020

dynamic -> object and constructor optimization

80aa5c5

#20 (comment) #20 (comment)

tiholic added a commit that referenced this pull request Aug 12, 2020

syntactic sugar

4b15d51

#20 (comment)

tiholic added a commit that referenced this pull request Aug 12, 2020

fixing payload getter to make more sense:

8b56f1c

ref: #20 (comment)

tiholic deleted the feature/channel-state-events branch August 12, 2020 15:08

sync-by-unito bot mentioned this pull request Oct 26, 2022

Error with onDeactivate #294

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Realtime Channel attach, detach and state events #20

Realtime Channel attach, detach and state events #20

tiholic commented Jul 22, 2020

QuintinWillison left a comment

zoechi left a comment

Realtime Channel attach, detach and state events #20

Realtime Channel attach, detach and state events #20

Conversation

tiholic commented Jul 22, 2020

Realtime Channel API enhancement

Other (non-API) enhancements

QuintinWillison left a comment

Choose a reason for hiding this comment

zoechi left a comment

Choose a reason for hiding this comment