Bump protocol version to v6 and add plugin compatibility checks

This implements the protocol-version-bumping process proposed in the
pinned plugin-support commit.

Note that all of the v6 changes are LiveObjects-related, hence no other
changes in ably-cocoa.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: lawrence-forooghian

Package.resolved

@@ -19,7 +19,8 @@ let package = Package(
         .package(name: "msgpack", url: "https://github.com/rvi/msgpack-objective-C", from: "0.4.0"),
         .package(name: "AblyDeltaCodec", url: "https://github.com/ably/delta-codec-cocoa", from: "1.3.5"),
         .package(name: "Nimble", url: "https://github.com/quick/nimble", from: "11.2.2"),
-        .package(name: "ably-cocoa-plugin-support", url: "https://github.com/ably/ably-cocoa-plugin-support", from: "1.0.0")
+        // TODO: Unpin before release
+        .package(name: "ably-cocoa-plugin-support", url: "https://github.com/ably/ably-cocoa-plugin-support", .revision("c20f969"))
     ],
     targets: [
         .target(

Package.swift

@@ -251,7 +251,10 @@ - (NSString *)host:(NSString *)host forEnvironment:(NSString *)environment {
         return nil;
     }
 
-    return [publicPlugin internalPlugin];
+    id<APLiveObjectsInternalPluginProtocol> plugin = [publicPlugin internalPlugin];
+    NSAssert(plugin.compatibleWithProtocolV6,
+             @"This version of ably-cocoa requires a LiveObjects plugin compatible with protocol v6.");
+    return plugin;
 }
 #endif
 

Source/ARTClientOptions.m

@@ -3,7 +3,7 @@
 #import "ARTNSArray+ARTFunctional.h"
 #import "ARTClientInformation+Private.h"
 
-static NSString *const ARTDefault_apiVersion = @"5"; // CSV2
+static NSString *const ARTDefault_apiVersion = @"6"; // CSV2
 
 NSString *const ARTDefaultProduction = @"production";
 

Source/ARTDefault.m

@@ -93,6 +93,10 @@ static ARTLogLevel _convertPluginLogLevel(APLogLevel pluginLogLevel) {
 
 @implementation ARTPluginAPI
 
+- (BOOL)usesLiveObjectsProtocolV6 {
+    return YES;
+}
+
 + (void)registerSelf {
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{

Source/ARTPluginAPI.m

@@ -5,7 +5,7 @@ import Ably.ARTDefault // System under Test
 class ARTDefaultTests: XCTestCase {
 
     func testVersions() {
-        XCTAssertEqual(ARTDefault.apiVersion(), "5")
+        XCTAssertEqual(ARTDefault.apiVersion(), "6")
         XCTAssertEqual(ARTDefault.libraryVersion(), "1.2.58")
     }
 }

Test/AblyTests/Tests/ARTDefaultTests.swift

@@ -15,6 +15,8 @@ class PluginAPITests: XCTestCase {
     }
 
     class MockInternalLiveObjectsPlugin: NSObject, _AblyPluginSupportPrivate.LiveObjectsInternalPluginProtocol {
+        var compatibleWithProtocolV6: Bool { true }
+
         internal var receivedConnectionDetails: [(connectionDetails: (any ConnectionDetailsProtocol)?, channel: any RealtimeChannel)] = []
 
         func nosync_prepare(_ channel: any RealtimeChannel, client: any RealtimeClient) {

Test/AblyTests/Tests/PluginAPITests.swift

@@ -342,7 +342,7 @@ class RealtimeClientConnectionTests: XCTestCase {
 
                 // This test should not directly validate version against ARTDefault.version(), as
                 // ultimately the version header has been derived from that value.
-                expect(webSocketTransport.websocketURL?.query).to(haveParam("v", withValue: "5"))
+                expect(webSocketTransport.websocketURL?.query).to(haveParam("v", withValue: "6"))
 
                 done()
             }

Test/AblyTests/Tests/RealtimeClientConnectionTests.swift

@@ -50,7 +50,7 @@ class RealtimeClientTests: XCTestCase {
 
                 // This test should not directly validate version against ARTDefault.version(), as
                 // ultimately the version header has been derived from that value.
-                expect(transport.lastUrl!.query).to(haveParam("v", withValue: "5"))
+                expect(transport.lastUrl!.query).to(haveParam("v", withValue: "6"))
 
                 done()
             }

Test/AblyTests/Tests/RealtimeClientTests.swift

@@ -163,7 +163,7 @@ class RestClientTests: XCTestCase {
 
                 // This test should not directly validate version against ARTDefault.version(), as
                 // ultimately the version header has been derived from that value.
-                XCTAssertEqual(version, "5")
+                XCTAssertEqual(version, "6")
 
                 done()
             }
@@ -1744,7 +1744,7 @@ class RestClientTests: XCTestCase {
 
                 // This test should not directly validate version against ARTDefault.version(), as
                 // ultimately the version header has been derived from that value.
-                XCTAssertEqual(headerAblyVersion, "5")
+                XCTAssertEqual(headerAblyVersion, "6")
 
                 done()
             }