Redesign update API to task API

[alallema]

Breaking Changes

All the actions on indexes are now asynchronous:

• create_index(), update_index(), delete_index() return a task response instead of an Index.
• index.create and index.delete from index return a task.
• wait_for_pending_update()
  • is renamed into wait_for_task
  • the current index.wait_for_task() method call /tasks/:uid
• index.get_update_status is renamed index.get_task
• index.get_all_update_status is renamed index.get_tasks

Notes: The only two methods that now return an Index are client.index() and client.get_index()

Enhancements

• new method client.wait_for_task() call /tasks/:uid
• new method client.get_tasks that calls /tasks
• new method client.get_task that calls /tasks/:uid

Misc

• delete_if_exists and get_or_create_index are commented since we don't know yet if we will remove them or not.

[sanders41]

In addition to the review comments, a couple of additional comments.

In conftest.py the clear_indexes fixture can have race conditions now that the delete of indexes is async. To prevent this the deleting should wait for the task to complete.

@fixture(autouse=True)
def clear_indexes(client):
    """
    Auto-clears the indexes after each test function run.
    Makes all the test functions independent.
    """
    # Yields back to the test function.
    yield
    # Deletes all the indexes in the MeiliSearch instance.
    indexes = client.get_indexes()
    for index in indexes:
        result = client.index(index.uid).delete()
        client.wait_for_task(result["uid"])

Just as a suggestion, the new task functionality, wait_for_task, get_task, and get_tasks, could be their own functions outside of the Client and Index. This would prevent the need to have and maintain the same code in two different places.

[sanders41]

LGTM! Good job on this one, there were a lot of changes here.

BTW, if it is helpful I have already implemented the new auth key management here. Implementation itself was simple, it was more the tests and fixtures (all relevant fixtures are in the test file) around it that took some thinking.

[alallema]

LGTM! Good job on this one, there were a lot of changes here.

BTW, if it is helpful I have already implemented the new auth key management here. Implementation itself was simple, it was more the tests and fixtures (all relevant fixtures are in the test file) around it that took some thinking.

Thank you so much for this review @sanders41! 🔥
I still need to modify the wait_for_task, get_task, and get_tasks I will probably do it tomorrow.

[bidoubiwa]

LGTM 🔥🔥🔥

[alallema]

bors merge

[bors]

Build failed:

• integration-tests (3.6)