feat(all): Task store

implements:
https://github.com/meilisearch/specifications/blob/develop/text/0060-refashion-updates-apis.md

linked PR:

- #1889
- #1891
- #1892
- #1902
- #1906
- #1911
- #1914
- #1915
- #1916
- #1918
- #1924
- #1925
- #1926
- #1930
- #1936
- #1937
- #1942
- #1944
- #1945
- #1946
- #1947
- #1950
- #1951
- #1957
- #1959
- #1960
- #1961
- #1962
- #1964

- https://github.com/meilisearch/milli/pull/414
- https://github.com/meilisearch/milli/pull/409
- https://github.com/meilisearch/milli/pull/406
- https://github.com/meilisearch/milli/pull/418

- close #1687
- close #1786
- close #1940
- close #1948
- close #1949
- close #1932
- close #1956

meilisearch-lib/src/index_controller/dump_actor/compat/mod.rs

@@ -0,0 +1,16 @@
+pub mod v2;
+pub mod v3;
+
+/// Parses the v1 version of the Asc ranking rules `asc(price)`and returns the field name.
+pub fn asc_ranking_rule(text: &str) -> Option<&str> {
+    text.split_once("asc(")
+        .and_then(|(_, tail)| tail.rsplit_once(")"))
+        .map(|(field, _)| field)
+}
+
+/// Parses the v1 version of the Desc ranking rules `desc(price)`and returns the field name.
+pub fn desc_ranking_rule(text: &str) -> Option<&str> {
+    text.split_once("desc(")
+        .and_then(|(_, tail)| tail.rsplit_once(")"))
+        .map(|(field, _)| field)
+}

meilisearch-lib/src/index_controller/dump_actor/compat/v2.rs

@@ -0,0 +1,147 @@
+use anyhow::bail;
+use chrono::{DateTime, Utc};
+use meilisearch_error::Code;
+use milli::update::IndexDocumentsMethod;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+use crate::index::{Settings, Unchecked};
+
+#[derive(Serialize, Deserialize)]
+pub struct UpdateEntry {
+    pub uuid: Uuid,
+    pub update: UpdateStatus,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum UpdateFormat {
+    Json,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct DocumentAdditionResult {
+    pub nb_documents: usize,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum UpdateResult {
+    DocumentsAddition(DocumentAdditionResult),
+    DocumentDeletion { deleted: u64 },
+    Other,
+}
+
+#[allow(clippy::large_enum_variant)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(tag = "type")]
+pub enum UpdateMeta {
+    DocumentsAddition {
+        method: IndexDocumentsMethod,
+        format: UpdateFormat,
+        primary_key: Option<String>,
+    },
+    ClearDocuments,
+    DeleteDocuments {
+        ids: Vec<String>,
+    },
+    Settings(Settings<Unchecked>),
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Enqueued {
+    pub update_id: u64,
+    pub meta: UpdateMeta,
+    pub enqueued_at: DateTime<Utc>,
+    pub content: Option<Uuid>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Processed {
+    pub success: UpdateResult,
+    pub processed_at: DateTime<Utc>,
+    #[serde(flatten)]
+    pub from: Processing,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Processing {
+    #[serde(flatten)]
+    pub from: Enqueued,
+    pub started_processing_at: DateTime<Utc>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Aborted {
+    #[serde(flatten)]
+    pub from: Enqueued,
+    pub aborted_at: DateTime<Utc>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Failed {
+    #[serde(flatten)]
+    pub from: Processing,
+    pub error: ResponseError,
+    pub failed_at: DateTime<Utc>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(tag = "status", rename_all = "camelCase")]
+pub enum UpdateStatus {
+    Processing(Processing),
+    Enqueued(Enqueued),
+    Processed(Processed),
+    Aborted(Aborted),
+    Failed(Failed),
+}
+
+type StatusCode = ();
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct ResponseError {
+    #[serde(skip)]
+    pub code: StatusCode,
+    pub message: String,
+    pub error_code: String,
+    pub error_type: String,
+    pub error_link: String,
+}
+
+pub fn error_code_from_str(s: &str) -> anyhow::Result<Code> {
+    let code = match s {
+        "index_creation_failed" => Code::CreateIndex,
+        "index_already_exists" => Code::IndexAlreadyExists,
+        "index_not_found" => Code::IndexNotFound,
+        "invalid_index_uid" => Code::InvalidIndexUid,
+        "invalid_state" => Code::InvalidState,
+        "missing_primary_key" => Code::MissingPrimaryKey,
+        "primary_key_already_present" => Code::PrimaryKeyAlreadyPresent,
+        "invalid_request" => Code::InvalidRankingRule,
+        "max_fields_limit_exceeded" => Code::MaxFieldsLimitExceeded,
+        "missing_document_id" => Code::MissingDocumentId,
+        "invalid_facet" => Code::Filter,
+        "invalid_filter" => Code::Filter,
+        "invalid_sort" => Code::Sort,
+        "bad_parameter" => Code::BadParameter,
+        "bad_request" => Code::BadRequest,
+        "document_not_found" => Code::DocumentNotFound,
+        "internal" => Code::Internal,
+        "invalid_geo_field" => Code::InvalidGeoField,
+        "invalid_token" => Code::InvalidToken,
+        "missing_authorization_header" => Code::MissingAuthorizationHeader,
+        "payload_too_large" => Code::PayloadTooLarge,
+        "unretrievable_document" => Code::RetrieveDocument,
+        "search_error" => Code::SearchDocuments,
+        "unsupported_media_type" => Code::UnsupportedMediaType,
+        "dump_already_in_progress" => Code::DumpAlreadyInProgress,
+        "dump_process_failed" => Code::DumpProcessFailed,
+        _ => bail!("unknow error code."),
+    };
+
+    Ok(code)
+}

meilisearch-lib/src/index_controller/dump_actor/compat/v3.rs

@@ -0,0 +1,198 @@
+use chrono::{DateTime, Utc};
+use meilisearch_error::{Code, ResponseError};
+use milli::update::IndexDocumentsMethod;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+use crate::index::{Settings, Unchecked};
+use crate::index_resolver::IndexUid;
+use crate::tasks::task::{DocumentDeletion, Task, TaskContent, TaskEvent, TaskId, TaskResult};
+
+use super::v2;
+
+#[derive(Serialize, Deserialize)]
+pub struct DumpEntry {
+    pub uuid: Uuid,
+    pub uid: String,
+}
+
+#[derive(Serialize, Deserialize)]
+pub struct UpdateEntry {
+    pub uuid: Uuid,
+    pub update: UpdateStatus,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(tag = "status", rename_all = "camelCase")]
+pub enum UpdateStatus {
+    Processing(Processing),
+    Enqueued(Enqueued),
+    Processed(Processed),
+    Failed(Failed),
+}
+
+impl From<v2::UpdateResult> for TaskResult {
+    fn from(other: v2::UpdateResult) -> Self {
+        match other {
+            v2::UpdateResult::DocumentsAddition(result) => TaskResult::DocumentAddition {
+                indexed_documents: result.nb_documents as u64,
+            },
+            v2::UpdateResult::DocumentDeletion { deleted } => TaskResult::DocumentDeletion {
+                deleted_documents: deleted,
+            },
+            v2::UpdateResult::Other => TaskResult::Other,
+        }
+    }
+}
+
+#[allow(clippy::large_enum_variant)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum Update {
+    DeleteDocuments(Vec<String>),
+    DocumentAddition {
+        primary_key: Option<String>,
+        method: IndexDocumentsMethod,
+        content_uuid: Uuid,
+    },
+    Settings(Settings<Unchecked>),
+    ClearDocuments,
+}
+
+impl From<Update> for TaskContent {
+    fn from(other: Update) -> Self {
+        match other {
+            Update::DeleteDocuments(ids) => {
+                TaskContent::DocumentDeletion(DocumentDeletion::Ids(ids))
+            }
+            Update::DocumentAddition {
+                primary_key,
+                method,
+                ..
+            } => TaskContent::DocumentAddition {
+                content_uuid: Uuid::default(),
+                merge_strategy: method,
+                primary_key,
+                // document count is unknown for legacy updates
+                documents_count: 0,
+            },
+            Update::Settings(settings) => TaskContent::SettingsUpdate {
+                settings,
+                // There is no way to know now, so we assume it isn't
+                is_deletion: false,
+            },
+            Update::ClearDocuments => TaskContent::DocumentDeletion(DocumentDeletion::Clear),
+        }
+    }
+}
+
+#[allow(clippy::large_enum_variant)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(tag = "type")]
+pub enum UpdateMeta {
+    DocumentsAddition {
+        method: IndexDocumentsMethod,
+        primary_key: Option<String>,
+    },
+    ClearDocuments,
+    DeleteDocuments {
+        ids: Vec<String>,
+    },
+    Settings(Settings<Unchecked>),
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Enqueued {
+    pub update_id: u64,
+    pub meta: Update,
+    pub enqueued_at: DateTime<Utc>,
+}
+
+impl Enqueued {
+    fn update_task(self, task: &mut Task) {
+        // we do not erase the `TaskId` that was given to us.
+        task.content = self.meta.into();
+        task.events.push(TaskEvent::Created(self.enqueued_at));
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Processed {
+    pub success: v2::UpdateResult,
+    pub processed_at: DateTime<Utc>,
+    #[serde(flatten)]
+    pub from: Processing,
+}
+
+impl Processed {
+    fn update_task(self, task: &mut Task) {
+        self.from.update_task(task);
+
+        let event = TaskEvent::Succeded {
+            result: TaskResult::from(self.success),
+            timestamp: self.processed_at,
+        };
+        task.events.push(event);
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Processing {
+    #[serde(flatten)]
+    pub from: Enqueued,
+    pub started_processing_at: DateTime<Utc>,
+}
+
+impl Processing {
+    fn update_task(self, task: &mut Task) {
+        self.from.update_task(task);
+
+        let event = TaskEvent::Processing(self.started_processing_at);
+        task.events.push(event);
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Failed {
+    #[serde(flatten)]
+    pub from: Processing,
+    pub msg: String,
+    pub code: Code,
+    pub failed_at: DateTime<Utc>,
+}
+
+impl Failed {
+    fn update_task(self, task: &mut Task) {
+        self.from.update_task(task);
+
+        let event = TaskEvent::Failed {
+            error: ResponseError::from_msg(self.msg, self.code),
+            timestamp: self.failed_at,
+        };
+        task.events.push(event);
+    }
+}
+
+impl From<(UpdateStatus, String, TaskId)> for Task {
+    fn from((update, uid, task_id): (UpdateStatus, String, TaskId)) -> Self {
+        // Dummy task
+        let mut task = Task {
+            id: task_id,
+            index_uid: IndexUid::new(uid).unwrap(),
+            content: TaskContent::IndexDeletion,
+            events: Vec::new(),
+        };
+
+        match update {
+            UpdateStatus::Processing(u) => u.update_task(&mut task),
+            UpdateStatus::Enqueued(u) => u.update_task(&mut task),
+            UpdateStatus::Processed(u) => u.update_task(&mut task),
+            UpdateStatus::Failed(u) => u.update_task(&mut task),
+        }
+
+        task
+    }
+}