Fixes for returning suggested mentions (Future)

pubnub · Oct 30, 2024 · af7db1d · af7db1d
1 parent 99f42ae
commit af7db1d
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 31 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -48,9 +48,9 @@ jobs:
         with:
           ruby-version: 3.2.2
           bundler-cache: true
-      - name: Clear SPM and build cache
+      - name: Clear Swift Package Manager cache
         run: rm -rf "$HOME/Library/Caches/org.swift.swiftpm"
-      - name: Clear SPM and build cache (2)
+      - name: Clear build cache
         run: rm -rf .build    	    
       - name: Pre-load simulators list
         if: ${{ matrix.environment != 'macOS' }}

diff --git a/Sources/MessageDraft/MessageDraftChangeListener.swift b/Sources/MessageDraft/MessageDraftChangeListener.swift
@@ -19,46 +19,48 @@ public protocol MessageDraftChangeListener: AnyObject {
   ///
   /// - Parameters:
   ///   - messageElements: An array of `MessageElement` representing current elements within the message
-  ///   - suggestedMentions: A  future object that will return the result of suggested mentions after calling its ``SuggestedMentionsFuture/async(completion:)`` method
-  func onChange(messageElements: [MessageElement], suggestedMentions: SuggestedMentionsFuture)
+  ///   - suggestedMentions: A  future object that will return the result of suggested mentions after calling its ``FutureObject/async(completion:)`` method
+  func onChange(messageElements: [MessageElement], suggestedMentions: any FutureObject<[SuggestedMention]>)
 }
 
 /// A closure-based implementation of the ``MessageDraftChangeListener`` protocol.
 ///
 /// This class allows you to handle delegate events by passing a closure, reducing the need to implement the ``MessageDraftChangeListener`` protocol.
 /// This is useful when you want to quickly handle messages without writing additional boilerplate code.
 final public class ClosureMessageDraftChangeListener: MessageDraftChangeListener {
-  let onChangeClosure: (([MessageElement], SuggestedMentionsFuture) -> Void)
+  let onChangeClosure: (([MessageElement], any FutureObject<[SuggestedMention]>) -> Void)
 
-  init(onChange: @escaping ([MessageElement], SuggestedMentionsFuture) -> Void) {
+  init(onChange: @escaping ([MessageElement], any FutureObject<[SuggestedMention]>) -> Void) {
     self.onChangeClosure = onChange
   }
 
-  public func onChange(messageElements: [MessageElement], suggestedMentions: SuggestedMentionsFuture) {
+  public func onChange(messageElements: [MessageElement], suggestedMentions: any FutureObject<[SuggestedMention]>) {
     onChangeClosure(messageElements, suggestedMentions)
   }
 }
 
-/// A protocol representing a `[SuggestedMention]` value  that will be available in the future.
-public protocol SuggestedMentionsFuture {
-  /// Starts an asynchronous operation and provides the result upon completion.
+/// A custom future-like object representing a value that will be provided asynchronously in the future.
+public protocol FutureObject<T> {
+  /// An associaded type representing the success value associated with this protocol or class. Defined by a conforming type
+  associatedtype T
+  /// Registers a completion handler to be called asynchronously with the result (success or failure).
   ///
   /// - Parameters:
-  ///   - completion: The async `Result` of the method call
-  ///     - **Success**: The successful result of the operation
+  ///    - completion: The async result of the call
+  ///     - **Success**: A successful value
   ///     - **Failure**: An `Error` describing the failure
-  func async(completion: @escaping (Swift.Result<[SuggestedMention], Error>) -> Void)
+  func async(completion: @escaping (Swift.Result<T, Error>) -> Void)
 }
 
-class SuggestedMentionsFutureImpl: SuggestedMentionsFuture {
+class SuggestedMentionsFuture: FutureObject {
   let future: PubNubChat.PNFuture
 
   init(future: PubNubChat.PNFuture) {
     self.future = future
   }
-
+  
   func async(completion: @escaping (Swift.Result<[SuggestedMention], Error>) -> Void) {
-    future.async(caller: self, callback: { (result: FutureResult<SuggestedMentionsFutureImpl, [PubNubChat.SuggestedMention]>) in
+    future.async(caller: self, callback: { (result: FutureResult<SuggestedMentionsFuture, [PubNubChat.SuggestedMention]>) in
       switch result.result {
       case let .success(suggestedMentions):
         completion(.success(suggestedMentions.compactMap { SuggestedMention.from(mention: $0) }))

diff --git a/Sources/MessageDraft/MessageDraftImpl.swift b/Sources/MessageDraft/MessageDraftImpl.swift
@@ -69,7 +69,7 @@ extension MessageDraftImpl: MessageDraft {
     let underlyingListener = KMPMessageDraftChangeListener { elements, mentions in
       listener.onChange(
         messageElements: elements.compactMap { MessageElement.from(element: $0) },
-        suggestedMentions: SuggestedMentionsFutureImpl(future: mentions)
+        suggestedMentions: SuggestedMentionsFuture(future: mentions)
       )
     }
 

diff --git a/Tests/MessageDraftIntegrationTests.swift b/Tests/MessageDraftIntegrationTests.swift
@@ -64,7 +64,7 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
     expectation.expectedFulfillmentCount = 1
 
     let messageDraft = channel.createMessageDraft()
-    let listener = ClosureMessageDraftChangeListener(onChange: { elements, future in
+    let listener = ClosureMessageDraftChangeListener() { elements, future in
       if !elements.containsAnyMention() {
         future.async() {
           switch $0 {
@@ -80,7 +80,7 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
           }
         }
       }      
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.update(text: "This is a @user")
@@ -114,7 +114,7 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
     expectation.expectedFulfillmentCount = 1
 
     let messageDraft = channel.createMessageDraft()
-    let listener = ClosureMessageDraftChangeListener(onChange: { elements, future in
+    let listener = ClosureMessageDraftChangeListener() { elements, future in
       if !elements.containsAnyMention() {
         future.async() {
           switch $0 {
@@ -130,7 +130,7 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
           }
         }
       }
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.update(text: "This is a #chnl")
@@ -178,12 +178,12 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
       text: suggestedMention.replaceWith
     )
 
-    let listener = ClosureMessageDraftChangeListener(onChange: { [unowned self] elements, future in
+    let listener = ClosureMessageDraftChangeListener() { [unowned self] elements, future in
       XCTAssertEqual(elements.count, 2)
       XCTAssertEqual(elements[0], .plainText(text: "Some prefix. This is a "))
       XCTAssertEqual(elements[1], .link(text: channel.name ?? "", target: .channel(channelId: channel.id)))
       expectation.fulfill()
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.insertText(offset: 0, text: "Some prefix. ")
@@ -211,11 +211,11 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
       text: suggestedMention.replaceWith
     )
 
-    let listener = ClosureMessageDraftChangeListener(onChange: { [unowned self] elements, future in
+    let listener = ClosureMessageDraftChangeListener() { [unowned self] elements, future in
       XCTAssertEqual(elements.count, 1)
       XCTAssertEqual(elements[0], .link(text: channel.name ?? "", target: .channel(channelId: channel.id)))
       expectation.fulfill()
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.removeText(offset: 0, length: 10)
@@ -243,10 +243,10 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
       text: suggestedMention.replaceWith
     )
 
-    let listener = ClosureMessageDraftChangeListener(onChange: { [unowned self] elements, future in
+    let listener = ClosureMessageDraftChangeListener() { [unowned self] elements, future in
       XCTAssertEqual(elements[0], .plainText(text: "This is a \(channel.name ?? "")"))
       expectation.fulfill()
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.removeMention(offset: suggestedMention.offset)
@@ -276,11 +276,11 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
       text: suggestedMention.replaceWith
     )
 
-    let listener = ClosureMessageDraftChangeListener(onChange: { elements, future in
+    let listener = ClosureMessageDraftChangeListener() { elements, future in
       XCTAssertEqual(elements.count, 1)
       XCTAssertFalse(elements[0].isLink())
       expectation.fulfill()
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.insertText(offset: 12, text: "_!!!!!_")
@@ -310,11 +310,11 @@ class MessageDraftIntegrationTests: PubNubSwiftChatSDKIntegrationTests {
       text: suggestedMention.replaceWith
     )
 
-    let listener = ClosureMessageDraftChangeListener(onChange: { elements, future in
+    let listener = ClosureMessageDraftChangeListener() { elements, future in
       XCTAssertEqual(elements.count, 1)
       XCTAssertFalse(elements[0].isLink())
       expectation.fulfill()
-    })
+    }
 
     messageDraft.addChangeListener(listener)
     messageDraft.removeText(offset: 12, length: 5)