waitForPendingUpdate method

[curquiza]

Issue fully detailed here.

[ppamorim]

@curquiza Is this feature really needed? The Swift library is 100% async by design.

[bidoubiwa]

Hey @ppamorim ppamorim!
I think there are two different "asynchronicity".

1. The asynchronicity of the httprequest. Where you have to wait for MeiliSearch Server to respond
2. The asynchronicity of MeiliSearch processes. Where you have to wait for your actions to be proccessed by MeiliSearch. (More info here)

This function aims to create a waiting function for the second case, not the first/

When I look into your tests I observe this

   self.client.addOrReplaceDocument(
            UID: uid,
            document: document,
            primaryKey: primaryKey) { result in

            switch result {
            case .success(let update):
                XCTAssertEqual(stubUpdate, update)
                expectation.fulfill()
            case .failure:
                XCTFail("Failed to add or replace Movies document")
            }

        }

        self.wait(for: [expectation], timeout: 1.0)

If I read your code correctly. On the last line of this code block, you wait for addOrReplaceDocument to be fulfilled and you consider it to be fulfilled once MeiliSearch responded with the update information. This is the first case of asynchronicity discussed above.
But this does not mean that the addDocument has been processed by MeiliSearch. It is possibly still in the queue.

The idea with waitForPendingUpdate is that it waits for the second case of asynchronicity discussed above. I'm do not know any swift but let me make a pseudo code with it:

   self.client.addOrReplaceDocument(
            UID: uid,
            document: document,
            primaryKey: primaryKey) { result in

            switch result {
            case .success(let update):
               XCTAssertEqual(stubUpdate, update)
               self.client. waitForPendingUpdate(
                    UID: uid, 
                    updateId: update["updateId"]) { result in 
                    switch result {
                         case .success(let updateInfo):
                               XCTAssertEqual("processed", update.status)
                               expectation.fulfill()
                         case .failure:
                               XCTFail("Failed to add or replace Movies document")
                    }
            }

               }               
            case .failure:
                XCTFail("Failed to add or replace Movies document")
            }

        }

        self.wait(for: [expectation], timeout: 1.0)

This will ensur that the documents have been processed and thus added correctly to MeiliSearch. The user will be able to wait upon any asynchronous MeiliSearch process and not just the MeiliSearch server response. In this case, the user is now sure all of his documents have been added and he can use the search.

Maybe I understood swift wrongly. But in the case I did not, do you feel this has more sense ?

[ppamorim]

@bidoubiwa Oh nice I will implement this! Thank you for the complete explanation.