ably-cocoa

Changes

Full Changelog

Fixed issues:

• Push device deregistration does not clear device details. #1177
• App build fails due to missing dependencies. #1755 and #1824

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 14.2 and Carthage 0.39.1.

Changes

Full Changelog

Fixed issues:

• Fixes an issue where certain errors will cause a Realtime connection to transition to FAILED when it should be transitioning to DISCONNECTED and retrying the connection attempt. #1817

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 14.2 and Carthage 0.39.1.

Changes

Full Changelog

Implemented features:

• Location pushes #1771
• Incremental backoff and jitter #1431
• Handle os connectivity event while CONNECTING #1626

Closed issues:

• Compiler warning "Non-portable path to file..." #1757
• App crash and dyld error message "AblyDeltaCodec cannot be loaded, image not found" #1183
• Compatibility with Xcode 15 #1803

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 14.2 and Carthage 0.39.0.

Changes

Full Changelog

Implemented features:

• A preview of an implementation of the location pushes #1771
• Incremental backoff and jitter #1431
• Handle os connectivity event while CONNECTING #1626

Closed issues:

• Compiler warning "Non-portable path to file..." #1757
• App crash and dyld error message "AblyDeltaCodec cannot be loaded, image not found" #1183

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.39.0.

Changes

Full Changelog

Public API changes:

• This release hides some private types that had been unintentionally exposed in the public API of the ably-cocoa library.

Internal changes:

• The ably-cocoa library no longer calls any of the ARTLog methods in the ARTLog (Shorthand) category, nor the -logWithError: method. Be aware that if you have created a custom subclass of ARTLog which overrides any of these methods, they will no longer be called. ARTLog now performs all of its logging using only the -log:withLevel: method.

Fixed bugs:

• Fallback host is being discarded before fallbackRetryTimeout elapses #1683
• Compilation error in SocketRocket in Xcode 14.3 #1591
• Call to _connect in ARTRealtimeInternal constructor #1566
• SCNetworkReachabilitySetCallback (Crashed: io.ably.main) #1380
• Crash in ARTOSReachability #593

Closed issues:

• Run tests in Ably-iOS and Ably-macOS using Xcode 14.3 #1653
• Emit file name and line number with every logged message #1643
• Thread running at QOS_CLASS_USER_INTERACTIVE waiting on a lower QoS thread running at QOS_CLASS_DEFAULT. Investigate ways to avoid priority inversions #1569
• App Store publication issues when using Carthage #1559
• Remove extra callback with setSuspended #1550
• Make sure we can build the library and run the tests using Xcode 14 #1523

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.39.0.

Changes

Full Changelog

Closed issues:

• Replace all calls to NSLog with calls to the ARTLog instance #1554

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Fixed bugs:

• Xcode 14 Thread Performance Checker warns of a priority inversion from SocketRocket code #1516

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Fixed bugs:

• Ably agents client option is implemented incorrectly #1525

Closed issues:

• Implement API for fetching Agent identifier #1530
• Fix error on trying to override HTTPURLResponse._allHeaderFields with Xcode 14 #1522
• Replace usage of SecKeychainItemDelete to fix deprecation error in Xcode 14 #1521

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Closed issues:

• SDK tests are not running on MacBook Pro M1 #1506
• Create Feature Compliance Manifest for ably-cocoa #1443

Implemented features:

• Implement RTP8j spec point #1517

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Closed issues:

• Make docs workflow run for all tags #1440, in: #1501 (maratal)
• Link to Ably error codes in ARTErrorInfo docstrings #1502, in: #1503 (maratal)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Documentation:

• Docstring comments added for documentation generation with Jazzy (#1491)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Fixed bugs:

• Warnings of the form Umbrella header for module 'Ably' does not include header 'ARTPushActivationEvent.h' (fixed by #1474)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.38.0.

Changes

Full Changelog

Fixed bugs:

• SCNetworkReachabilitySetCallback (Crashed: io.ably.main) #1380, fixed in: Fix of the crash in the ARTOSReachability #1453 (maratal)
• Channel names are not properly url-encoded #1449, fixed in: Fixed channel name url encoding #1451 (maratal)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.37.0.

Changes

Full Changelog

Implemented enhancements:

• Add support to get channel lifecycle status #1415, in: #1420 (maratal)
• Missing properties in ARTErrorInfo #1261, in: #1304 (maratal)
• Missing properties in ARTClientOptions #1260, in: fallback retry timeout option #1290 (maratal)
• Feature/1305 symmetric decryption #1307 (maratal)

Fixed bugs:

• Mutable ARTDeviceDetails.metadata #1435, fixed in: Added missing strong property attributes #1434 (maratal)
• According to spec, the SDK should be responsible for calling -[UIApplication registerForRemoteNotifications], not the user #1271, in: Call to the registerForRemoteNotifications #1293 (maratal)

Closed issues:

• Remove call to registerForRemoteNotifications from Basic APNS example #1359, in: #1360 (maratal)
• Create simplified ably-cocoa example project for demonstrating push notifications capability #1318, in: Basic APNS example #1319 (maratal)

Merged pull requests:

• Fix symlink command on contributing guide #1436 (ikbalkaya)
• Jazzy docs generation workflow #1428 (maratal)
• Fix nonexistent version number in readme SPM instructions #1324 (lawrence-forooghian)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.4.1 and Carthage 0.37.0.

Changes

Full Changelog

Revert Bug Fix:

We made a change, released in version 1.2.8, which we suspect has been causing issues for some customers.
This release reverts that change.

• Reverting Fix/1177 full reset rsh3g2a only #1272 (maratal)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.2.1 and Carthage 0.37.0.

Changes

Full Changelog

Bug Fix:

This bug affects customers using message content encryption alongisde channel history for a single Ably client instance. History REST requests were incorrectly returning encrypted payloads, despite encryption having been enabled via the Realtime channel setOptions API.

• Bug: Updating ARTRealtimeChannel’s options doesn’t update the options of its ARTRestChannelInternal #1265
• Fix: When setting realtime channel options, pass through to REST channel #1266 (lawrence-forooghian)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.2.1 and Carthage 0.37.0.

Changes

Full Changelog

Implemented enhancements:

• Rename ARTDeviceTokenKey to ARTAPNSDeviceTokenKey #1209
• Deprecation: Replace usages of deprecated kCCAlgorithmAES128 with kCCAlgorithmAES #1199
• Add support for remembered REST fallback host #815
• Ensure request method accepts UPDATE, PATCH & DELETE verbs #780

Fixed bugs:

• Calling state's machine activation callback upon push device details failure #1236
• Push device deregistration does not clear/ reset device details #1177

Closed issues:

• Check ability of using ably-cocoa in SwiftUI projects #1254
• Improve test file structure and naming #1203
• Run static analysis for builds in CI #1202
• Investigate how we might get rid of the Quick testing framework #1201

Merged pull requests:

• Fix/1177 full reset device details (RSH3g2a only) #1259 (maratal)
• Improve test file structure and naming #1252 (lawrence-forooghian)
• Treat warnings as errors across the codebase #1249 (lawrence-forooghian)
• Remove the Quick testing framework #1240 (lawrence-forooghian)
• Fix Carthage #3019 workaround for Xcode 13 #1235 (lawrence-forooghian)
• Feature/1209 device token key #1215 (maratal)
• Replaced deprecated kCCAlgorithmAES128 with kCCAlgorithmAES #1214 (maratal)
• Turned on static analyser after build #1213 (maratal)

Installation and Compatibility

For SPM, CocoaPods and Carthage see Installation Guide.

Ably.framework.zip, attached to this release, was built with Xcode 13.2.1.

Full Changelog

Implemented enhancements:

• Stop base64-encoding authorization headers unnecessarily #1185
• Conflict with XAspect with HAVE_CONFIG_H macro #1161
• Blocks supplied as properties or method arguments should have typedef #1032
• Unused function warnings in xdelta3.x when Ably added via CocoaPods - Unused Entity Issue #1031
• Reduce library dependencies #949
• Improve error message for invalid state operations #843
• Finish implementing TI3 #760
• Update Stats fields with latest MessageTraffic types #732
• Address issues raised by Xcode’s static analyzer #694
• Quick Documentation: add headerdoc comments #298

Fixed bugs:

• Encrypt messages if a new ARTRealtimeChannelOptions or ARTChannelOptions containing cipher is set #1207
• Prebuilt Ably.framework from make carthage_package doesn't work in Xcode projects #1168
• Library version identifier invalid #900
• Check RTN15c3 implementation #847
• when using authUrl with authMethod=POST, authParams are sent JSON-encoded, not form-encoded #690

Closed issues:

• Add Swift Package Manager badges to README.md #1204
• NSSecureCoding NSObject bypasses security #1188
• Add Ably-cocoa swift package to Swift Package Index #1141
• App Store upload problem - non-public API use #1104
• Memory leak(s) when using event emitters #1099
• build warning - treating a forced downcast to 'ARTClientOptions' as optional will never produce 'nil' #1035
• Warnings about deprecations when used in a Mac Catalyst app #1003
• Possible race conditions in Test Suite #912

Merged pull requests:

• Fix ARTChannel.setOptions and ARTRealtimeChannel.setOptions: Recreate ARTDataEncoder on ARTChannel options update #1208 (lukasz-szyszkowski)
• Add Swift Package Index badges #1205 (lukasz-szyszkowski)
• Fix/694 static analyser issues #1198 (maratal)
• Log message text fixed. #1197 (maratal)
• Removed optional base64 auth header #1195 (maratal)
• Fix/1188 Added allowed class for NSKeyedUnarchiver #1194 (maratal)
• Added Xcodebuild Logs uploading step #1192 (maratal)
• Make sure we all use the same version of Fastlane #1189 (lawrence-forooghian)
• Assure new secret to be created only together with the deviceId #1187 (maratal)
• Copied descriptions from ably.com/documentation/realtime/types #1176 (maratal)
• New stats fields #1175 (maratal)
• Reattaching channels in compliance with RTN15c3 #1172 (maratal)
• 1003 mac catalyst warnings #1171 (maratal)
• Documentation: Add link to example app, and clarify ARTPushRegistererDelegate usage #1170 (ben-xD)
• Blocks typedef #1166 (maratal)

Changes

Changelog
Full Changelog for this release

Merged pull requests:

• Update AblyDeltaCodec dependency to 1.3.1 #1165 (ben-xD)

Installation

Swift Package Manager

• For Xcode projects (e.g. iOS apps): Add https://github.com/ably/ably-cocoa to your project under Swift Packages tab.
• For Swift Packages (e.g. other libraries):
  • In dependencies: [...], add .package(url: "https://github.com/ably/ably-cocoa", from: "1.2.6"),
  • In target(dependencies: [...]), add .product(name: "Ably", package: "ably-cocoa")

Cocoapods, add the following to your Podfile.

pod 'Ably', '1.2'

Carthage, follow Installing through Carthage

Imports

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 12.5.1.

Changes

Full Changelog

Implemented enhancements:

• Add transportParams to ClientOptions #1112
• Implement RSC7d (Ably-Agent header) #1111
• Defaults: Generate environment fallbacks #1066
• Make stateChange nonnull? #1017
• Compile SocketRocket with main library #805

Fixed bugs:

• Memory leaks in the Realtime client #1129
• Token based authentication always results in 40101 Request mac does not match #1093
• Potentially insecure usage of the NSURLSession API #1079
• Incorrect import reference? #1072

Closed issues:

• Expose device property in ARTRealtime.h #1154
• Remove ULID dependency (replace usage with NSUUID) #1127
• Implement ErrorInfo URLs to help debug issues #1125
• Carthage build for Nimble framework with deprecated linker flag -lswiftXCTest #1123
• Implement RSC15j (fallback host header) #1116
• Implement RSC15f (successful fallback host) #1115
• In last version, connecting to server takes too long time on old devices #1102
• Fail connection immediately if authorize() called and 403 returned #1078

Merged pull requests:

• Fix for potentially insecure usage of the NSURLSession API #1158 (maratal)
• 1017 state change nonnull #1156 (maratal)
• xcbkptlist removed #1155 (maratal)
• Move deviceSecret into ARTLocalDevice #1153 (ben-xD)
• Remove references to ULID in xcodeproj #1152 (maratal)
• Store succeed fallback host as default for 10 minutes (RSC15f) #1150 (lukasz-szyszkowski)
• Fix/1078 fail immediately on 403 #1149 (maratal)
• (RSC15j) Add Host header for fallback hosts. #1148 (lukasz-szyszkowski)
• Extending ErrorInfo with href and requestId #1147 (lukasz-szyszkowski)
• Add transport params to client options (RTC1f) #1142 (lukasz-szyszkowski)
• Swift Package Manager support #1136 (lukasz-szyszkowski)
• Real time client memory leaks fixes #1130 (lukasz-szyszkowski)
• Remove ULID dependency and replace usage with NSUUID #1128 (ben-xD)
• Fix for deprecated linker flag for Nimble framework #1124 (lukasz-szyszkowski)
• Ably-Agent Header #1119 (maratal)
• Environment fallback hosts #1113 (ricardopereira)
• Accept authURL response with timestamp argument as string #1097 (ricardopereira)

Installation

Swift Package Manager

• For Xcode projects (e.g. iOS apps): Add https://github.com/ably/ably-cocoa to your project under Swift Packages tab.
• For Swift Packages (e.g. other libraries):
  • In dependencies: [...], add .package(url: "https://github.com/ably/ably-cocoa", from: "1.2.5"),
  • In target(dependencies: [...]), add .product(name: "Ably", package: "ably-cocoa")

Cocoapods, add the following to your Podfile.

pod 'Ably', '1.2.5'

Carthage, follow Installing through Carthage

Imports

Objective-C

#import <Ably/Ably.h>

Swift

import Ably

Compatibility

• Carthage release for Swift is built with Xcode 12.5.1.