ably-cocoa

Changes

Full Changelog

Fixed bugs:

• Common crash related to websocket failing with error #1083, fixed by adding a nil-pointer check in #1098 (mikepulaski)
• Fix of RSH3a2a1 implementation when the clientId doesn't change #1107 (ricardopereira)
• [not conforming to RTL2g] realtime#close emits detached event on an already detached channel #1088, fixed by #1091 (ricardopereira)

Enhancements:

• Compliance with RSL1m1 spec - Message should fill clientId, if unavailable, from Rest/Realtime instance #1108, implemented by adding X-Ably-ClientId header to REST requests in #1110 (ricardopereira)
• Update SocketRocket dependency to 0.5.2-ably-8 #1087 (lawrence-forooghian)

Versions

Podfile

pod 'Ably', '1.2.4'

Cartfile

github "ably/ably-cocoa" == 1.2.4

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 12.4.

Bug Fix

Fixes issue: Publishing messages with authCallback is broken after upgrading from 1.1.16 to 1.2.1 #1074.

Fixed by pull request: Fixes 40012 "Malformed message; invalid clientId" when message has no clientId and credentials can assume any clientId #1082 (ricardopereira)

Full Changelog

Versions

Podfile

pod 'Ably', '1.2.3'

Cartfile

github "ably/ably-cocoa" == 1.2.3

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 12.0.1.

Highlights

Supports Build with Xcode 12

Fixes the Carthage build. Increases the minimum deployment target for iOS, from 8 to 9 (conflated in #1075).

New Push Notification Registration API for apps using the SwiftUI App Lifecycle

For new Swift-based apps created with Xcode 12, the default lifecycle is SwiftUI App.
This means that the previous approach we supported of conforming to ARTPushRegistererDelegate on your UIApplicationDelegate no longer works.

Going forward apps should use the pushRegistererDelegate property on client options to supply this delegate (#1075).

Reduced Dependencies

We've removed both KSCrash (#1073) and SAMKeychain (#1067).

In Cocoa there is no effective way to catch selectively only those exceptions that occur within the library, and the attempt to do that using KCrash was interfering with app developers' own exception handling. Our advice is that app developers incorporate their own application-wide exception handling and crash reporting.

Fixed issues:

• Deadlock getting ARTRealtimeChannel between two dispatch_sync (ui queue vs ably main queue) #1029
• Push Notification Registration via ARTPushRegistererDelegate don't work in iOS 14 when instantiated via @UIApplicationDelegateAdaptor #1069
• Conflict KSCrashAblyFork #1068

Merged pull requests:

• Support ARTPushRegistererDelegate on iOS 14 #1075 (QuintinWillison)
• Remove KSCrash and unhandled exception handlers #1073 (QuintinWillison)
• Remove SAMKeychain dependency and use internal solution #1067 (ricardopereira)
• Fix Push State Machine delegate syncing the main queue #1064 (ricardopereira)
• Add use\_frameworks! recommendation #1061 (kavalerov)
• Correct CocoaPods instruction #1060 (kavalerov)
• Bump protocol version to 1.2 #1058 (QuintinWillison)
• Fix some waitUntil error "expects its completion closure to be only called once" #1028 (ricardopereira)

Full Changelog

Versions

Podfile

pod 'Ably', '1.2.2'

Cartfile

github "ably/ably-cocoa" == 1.2.2

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 12.0.1.

Fixes issues in our uncaught exception handling code:

• Fix Data race in ARTstartHandlingUncaughtExceptions #1030
• Merge Improve unhandled exception handling code #1056 (QuintinWillison)

Also some improvements to our test suite:

• Fix Flaky test: message receiving order #977
• Merge Test suite: fix lib version #1026 (ricardopereira)
• Merge Should not wait for AblyTest.options in 'context' scope #1023 (ricardopereira)
• Merge Fix 977 #1022 (ricardopereira)

Full Changelog

Versions

Podfile

pod 'Ably', '1.2.1'

Cartfile

github "ably/ably-cocoa" == 1.2.1

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.1.

Adds the capability to subscribe to a channel in delta mode.

Subscribing to a channel in delta mode enables delta compression. This is a way for a client to subscribe to a channel so that message payloads sent contain only the difference (ie the delta) between the present message and the previous message on the channel.

Full Changelog

Versions

Podfile

pod 'Ably', '1.2.0'

Cartfile

github "ably/ably-cocoa" == 1.2.0

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.1.

Changes

Full Changelog

Implemented enhancements:

• Remove queueing messages in a channel-level queue #894

Fixed bugs:

• lib fails all the user's channels on transition to connecting/disconnected if queueMessages is disabled? #1004

Closed issues:

• Implement push spec update https://github.com/ably/docs/pull/710 #876

Merged pull requests:

• Refine release procedure #1014 (QuintinWillison)
• Fix 'queueMessages' expected behaviour #1005 (ricardopereira)

Versions

Podfile

pod 'Ably', '1.1.23'

Cartfile

github "ably/ably-cocoa" == 1.1.23

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.1.

Changes

Full Changelog

Fixed bugs:

• Allow customers to subclass ARTLog #1011 (QuintinWillison)

Merged pull requests:

• Test suite: keep channel name prefix for current ClientOptions while calling 'setupOptions' and other improvements #1009 (ricardopereira)
• Avoid leak from user incorrectly holding to authCallback's callback. #1000 (tcard)

Versions

Podfile

pod 'Ably', '1.1.22'

Cartfile

github "ably/ably-cocoa" == 1.1.22

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.1.

Changes

Full Changelog

• Fix Objective-C namespace collisions #1006 (SlaunchaMan)
• Fix strong ref cycle: Rest.push and Rest.push.admin <-> Rest. #999 (tcard)

Versions

Podfile

pod 'Ably', '1.1.21'

Cartfile

github "ably/ably-cocoa" == 1.1.21

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.1.

Changes

Full Changelog

• Support build with Xcode 10 (23b235c) - brings in SocketRocket #5

Versions

Podfile

pod 'Ably', '1.1.20'

Cartfile

github "ably/ably-cocoa" == 1.1.20

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.

Changes

Fixed bugs:

• Old push state AfterRegistrationUpdateFailed needs migration #993

Closed issues:

• Auth token refresh misses when macOS is sleeping #984

Merged pull requests:

• Push: Fix activate() behavior while syncing device. #995 (tcard)
• Migrate persisted AfterRegistrationUpdateFailed to ...SyncFailed. #994 (tcard)
• Use tests dispatch queue, not main, to POST /apps. #991 (tcard)
• Update SocketRocket dependency #990 (ricardopereira)
• Document development flow #989 (QuintinWillison)
• Second Attempt to Update KSCrash dependency #988 (QuintinWillison)
• Fix handling of token error when first connecting. #986 (tcard)
• Update KSCrash dependency #981 (QuintinWillison)
• Fix bad merge in README. #980 (tcard)
• Validate and sync when activating push for registered device #974 (tcard)
• Update ably-ios references to ably-cocoa #954 (tcard)

Versions

Podfile

pod 'Ably', '1.1.19'

Cartfile

github "ably/ably-cocoa" == 1.1.19

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.

Changes

Fixed bugs:

• Result of internet-up.ably-realtime.com is ignored #952
• Realtime suspended connection retrial using wrong timeout #913

Closed issues:

• Remove develop branch #969
• Flaky test: RTP2f (incoming LEAVE while SYNCing) #938
• Flaky test: RTN17* (fallback hosts) #931

Versions

Podfile

pod 'Ably', '1.1.18'

Cartfile

github "ably/ably-cocoa" == 1.1.18

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.

Changes

Merged pull requests:

• Remove push state machine singleton (#972)
• Add clarification to release process: document --since-tag effects (#971)

Versions

Podfile

pod 'Ably', '1.1.17'

Cartfile

github "ably/ably-cocoa" == 1.1.17

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.

Changes

Bug fixes:

• Can now compile Ably headers in Objective-C++ (#964)
• Now push activation state machine doesn't get stuck in certain states (#967)

Versions

Podfile

pod 'Ably', '1.1.16'

Cartfile

github "ably/ably-cocoa" == 1.1.16

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.

Important changes

• KSCrash fork has been renamed to KSCrashAblyFork
  #955
• Update msgpack to v0.3 #951

Complete list of changes available here.

⚠️ Breaking changes

We changed the name of our version of KSCrash framework to KSCrashAblyFork. In case you're using the library with Carthage, then you need to update the name of the KSCrash framework on your application targets’ Build Phases settings tab.

Versions

Podfile

pod 'Ably', '1.1.15'

Cartfile

github "ably/ably-cocoa" == 1.1.15

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.3.

Changes

Continuation of the attempt to fix an issue experienced by those specifying the Ably pod as a dependency in their own CocoaPod spec, relating to the Ably fork of the KSCrash and MsgPack framework.

Partially addressing #949

Versions

Podfile

pod 'Ably', '1.1.15-beta.1'

Cartfile

WARNING This beta release has been created as an attempt to fix a CocoaPods related issue. As such there is a possibility that inclusion via Carthage may not work.

github "ably/ably-cocoa" == 1.1.15-beta.1

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Changes

This is an attempt to fix an issue experienced by those specifying the Ably pod as a dependency in their own CocoaPod spec, relating to the Ably fork of the KSCrash framework.

Partially addressing #949

Versions

Podfile

pod 'Ably', '1.1.15-beta.0'

Cartfile

WARNING This beta release has been created as an attempt to fix a CocoaPods related issue. As such there is a possibility that inclusion via Carthage may not work.

github "ably/ably-cocoa" == 1.1.15-beta.0

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Changes

Bug fixes:

• iOS Incompatible library version crash - DYLIB_COMPATIBILITY_VERSION vs DYLIB_CURRENT_VERSION #946: We were publishing incorrect metadata in our dynamic library for iOS.

Versions

Podfile

pod 'Ably', '1.1.14'

Cartfile

github "ably/ably-cocoa" == 1.1.14

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.2.1.

Changes

Bug fixes:

• Using clientId no longer forces token auth, per 1.1. spec #849
• Network Reachability #908
• Multi-threaded stability improvements #918, #919, #920
• Possibility of out-of-order publishing #926

Versions

Podfile

pod 'Ably', '1.1.13'

Cartfile

github "ably/ably-cocoa" == 1.1.13

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.1.

Changes

• Push: replace token NSData.description usage #889

Versions

Podfile

pod 'Ably', '1.1.12'

Cartfile

github "ably/ably-cocoa" == 1.1.12

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.1.

Important changes

• Push: replace system NSLog with internal ARTLogger #896
• Push: replace token NSData.description usage #889
• Push: fix crash "dispatch_sync called on queue already owned by current thread" #888
• Push: PushChannel.subscribe should not call the callback in the internal queue #862

Tentative fix of:

• Crash on creating weak ref to deallocating object #879

Versions

Podfile

pod 'Ably', '1.1.11-beta.1'

Cartfile

github "ably/ably-cocoa" == 1.1.11-beta.1

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 11.0.