Rename Message.latestAction to action

Upon our integration tests starting to fail, we noticed that Realtime seems to have renamed the `latestAction` property to `action`. This change has not yet been reflected in the spec, but has been in JS [1]. I’ve created an issue to get the spec updated [2] but since this test failure is stopping us from merging anything else I am going to rename this property until we get a more definitive answer. Part of #169. [1] ably/ably-chat-js#427 [2] ably/specification#254
ably · Dec 4, 2024 · 25e3f41 · 25e3f41
1 parent 5676cac
commit 25e3f41
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 19 deletions.
diff --git a/Example/AblyChatExample/Mocks/Misc.swift b/Example/AblyChatExample/Mocks/Misc.swift
@@ -12,7 +12,7 @@ final class MockMessagesPaginatedResult: PaginatedResult {
         Array(repeating: 0, count: numberOfMockMessages).map { _ in
             Message(
                 serial: "\(Date().timeIntervalSince1970)",
-                latestAction: .create,
+                action: .create,
                 clientID: self.clientID,
                 roomID: self.roomID,
                 text: MockStrings.randomPhrase(),

diff --git a/Example/AblyChatExample/Mocks/MockClients.swift b/Example/AblyChatExample/Mocks/MockClients.swift
@@ -104,7 +104,7 @@ actor MockMessages: Messages {
         let subscription = MockSubscription<Message>(randomElement: {
             Message(
                 serial: "\(Date().timeIntervalSince1970)",
-                latestAction: .create,
+                action: .create,
                 clientID: MockStrings.names.randomElement()!,
                 roomID: self.roomID,
                 text: MockStrings.randomPhrase(),
@@ -130,7 +130,7 @@ actor MockMessages: Messages {
     func send(params: SendMessageParams) async throws -> Message {
         let message = Message(
             serial: "\(Date().timeIntervalSince1970)",
-            latestAction: .create,
+            action: .create,
             clientID: clientID,
             roomID: roomID,
             text: params.text,

diff --git a/Sources/AblyChat/ChatAPI.swift b/Sources/AblyChat/ChatAPI.swift
@@ -46,7 +46,7 @@ internal final class ChatAPI: Sendable {
 
         let message = Message(
             serial: response.serial,
-            latestAction: .create,
+            action: .create,
             clientID: clientId,
             roomID: roomId,
             text: params.text,

diff --git a/Sources/AblyChat/DefaultMessages.swift b/Sources/AblyChat/DefaultMessages.swift
@@ -83,7 +83,7 @@ internal final class DefaultMessages: Messages, EmitsDiscontinuities {
 
                 let message = Message(
                     serial: serial,
-                    latestAction: action,
+                    action: action,
                     clientID: clientID,
                     roomID: self.roomID,
                     text: text,

diff --git a/Sources/AblyChat/Message.swift b/Sources/AblyChat/Message.swift
@@ -9,17 +9,17 @@ public struct Message: Sendable, Codable, Identifiable, Equatable {
     public var id: String { serial }
 
     public var serial: String
-    public var latestAction: MessageAction
+    public var action: MessageAction
     public var clientID: String
     public var roomID: String
     public var text: String
     public var createdAt: Date?
     public var metadata: MessageMetadata
     public var headers: MessageHeaders
 
-    public init(serial: String, latestAction: MessageAction, clientID: String, roomID: String, text: String, createdAt: Date?, metadata: MessageMetadata, headers: MessageHeaders) {
+    public init(serial: String, action: MessageAction, clientID: String, roomID: String, text: String, createdAt: Date?, metadata: MessageMetadata, headers: MessageHeaders) {
         self.serial = serial
-        self.latestAction = latestAction
+        self.action = action
         self.clientID = clientID
         self.roomID = roomID
         self.text = text
@@ -30,7 +30,7 @@ public struct Message: Sendable, Codable, Identifiable, Equatable {
 
     internal enum CodingKeys: String, CodingKey {
         case serial
-        case latestAction
+        case action
         case clientID = "clientId"
         case roomID = "roomId"
         case text

diff --git a/Tests/AblyChatTests/ChatAPITests.swift b/Tests/AblyChatTests/ChatAPITests.swift
@@ -41,7 +41,7 @@ struct ChatAPITests {
         // Then
         let expectedMessage = Message(
             serial: "3446456",
-            latestAction: .create,
+            action: .create,
             clientID: "mockClientId",
             roomID: roomId,
             text: "hello",
@@ -91,7 +91,7 @@ struct ChatAPITests {
             items: [
                 Message(
                     serial: "3446456",
-                    latestAction: .create,
+                    action: .create,
                     clientID: "random",
                     roomID: roomId,
                     text: "hello",
@@ -101,7 +101,7 @@ struct ChatAPITests {
                 ),
                 Message(
                     serial: "3446457",
-                    latestAction: .create,
+                    action: .create,
                     clientID: "random",
                     roomID: roomId,
                     text: "hello response",

diff --git a/Tests/AblyChatTests/MessageSubscriptionTests.swift b/Tests/AblyChatTests/MessageSubscriptionTests.swift
@@ -26,7 +26,7 @@ private final class MockPaginatedResult<T: Equatable>: PaginatedResult {
 
 struct MessageSubscriptionTests {
     let messages = ["First", "Second"].map { text in
-        Message(serial: "", latestAction: .create, clientID: "", roomID: "", text: text, createdAt: .init(), metadata: [:], headers: [:])
+        Message(serial: "", action: .create, clientID: "", roomID: "", text: text, createdAt: .init(), metadata: [:], headers: [:])
     }
 
     @Test

diff --git a/Tests/AblyChatTests/MessageTests.swift b/Tests/AblyChatTests/MessageTests.swift
@@ -4,7 +4,7 @@ import Testing
 struct MessageTests {
     let earlierMessage = Message(
         serial: "ABC123@1631840000000-5:2",
-        latestAction: .create,
+        action: .create,
         clientID: "testClientID",
         roomID: "roomId",
         text: "hello",
@@ -15,7 +15,7 @@ struct MessageTests {
 
     let laterMessage = Message(
         serial: "ABC123@1631840000001-5:2",
-        latestAction: .create,
+        action: .create,
         clientID: "testClientID",
         roomID: "roomId",
         text: "hello",
@@ -26,7 +26,7 @@ struct MessageTests {
 
     let invalidMessage = Message(
         serial: "invalid",
-        latestAction: .create,
+        action: .create,
         clientID: "testClientID",
         roomID: "roomId",
         text: "hello",
@@ -70,7 +70,7 @@ struct MessageTests {
     func isEqual_whenMessageIsEqual_ReturnsTrue() async throws {
         let duplicateOfEarlierMessage = Message(
             serial: "ABC123@1631840000000-5:2",
-            latestAction: .create,
+            action: .create,
             clientID: "random",
             roomID: "",
             text: "",

diff --git a/Tests/AblyChatTests/Mocks/MockHTTPPaginatedResponse.swift b/Tests/AblyChatTests/Mocks/MockHTTPPaginatedResponse.swift
@@ -99,7 +99,7 @@ extension MockHTTPPaginatedResponse {
             [
                 "clientId": "random",
                 "serial": "3446456",
-                "latestAction": "message.create",
+                "action": "message.create",
                 "createdAt": 1_730_943_049_269,
                 "roomId": "basketball::$chat::$chatMessages",
                 "text": "hello",
@@ -109,7 +109,7 @@ extension MockHTTPPaginatedResponse {
             [
                 "clientId": "random",
                 "serial": "3446457",
-                "latestAction": "message.create",
+                "action": "message.create",
                 "roomId": "basketball::$chat::$chatMessages",
                 "text": "hello response",
                 "metadata": [:],