Add a new `meilisearch_types` crate

Move `meilisearch_error` to `meilisearch_types::error`
Move `meilisearch_lib::index_resolver::IndexUid` to `meilisearch_types::index_uid`
Add a new `InvalidIndexUid` error in `meilisearch_types::index_uid`

Cargo.lock

@@ -2006,7 +2006,7 @@ dependencies = [
  "base64",
  "enum-iterator",
  "hmac",
- "meilisearch-error",
+ "meilisearch-types",
  "milli",
  "rand",
  "serde",
@@ -2017,17 +2017,6 @@ dependencies = [
  "uuid",
 ]
 
-[[package]]
-name = "meilisearch-error"
-version = "0.28.0"
-dependencies = [
- "actix-web",
- "proptest",
- "proptest-derive",
- "serde",
- "serde_json",
-]
-
 [[package]]
 name = "meilisearch-http"
 version = "0.28.0"
@@ -2061,8 +2050,8 @@ dependencies = [
  "manifest-dir-macros",
  "maplit",
  "meilisearch-auth",
- "meilisearch-error",
  "meilisearch-lib",
+ "meilisearch-types",
  "mime",
  "num_cpus",
  "obkv",
@@ -2129,7 +2118,7 @@ dependencies = [
  "lazy_static",
  "log",
  "meilisearch-auth",
- "meilisearch-error",
+ "meilisearch-types",
  "milli",
  "mime",
  "mockall",
@@ -2163,6 +2152,17 @@ dependencies = [
  "whoami",
 ]
 
+[[package]]
+name = "meilisearch-types"
+version = "0.28.0"
+dependencies = [
+ "actix-web",
+ "proptest",
+ "proptest-derive",
+ "serde",
+ "serde_json",
+]
+
 [[package]]
 name = "memchr"
 version = "2.5.0"

Cargo.toml

@@ -2,7 +2,7 @@
 resolver = "2"
 members = [
     "meilisearch-http",
-    "meilisearch-error",
+    "meilisearch-types",
     "meilisearch-lib",
     "meilisearch-auth",
     "permissive-json-pointer",

meilisearch-auth/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 base64 = "0.13.0"
 enum-iterator = "0.7.0"
 hmac = "0.12.1"
-meilisearch-error = { path = "../meilisearch-error" }
+meilisearch-types = { path = "../meilisearch-types" }
 milli = { git = "https://github.com/meilisearch/milli.git", tag = "v0.29.2" }
 rand = "0.8.4"
 serde = { version = "1.0.136", features = ["derive"] }

meilisearch-auth/src/error.rs

@@ -1,7 +1,7 @@
 use std::error::Error;
 
-use meilisearch_error::ErrorCode;
-use meilisearch_error::{internal_error, Code};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::internal_error;
 use serde_json::Value;
 
 pub type Result<T> = std::result::Result<T, AuthControllerError>;

meilisearch-http/Cargo.toml

@@ -45,7 +45,7 @@ itertools = "0.10.3"
 jsonwebtoken = "8.0.1"
 log = "0.4.14"
 meilisearch-auth = { path = "../meilisearch-auth" }
-meilisearch-error = { path = "../meilisearch-error" }
+meilisearch-types = { path = "../meilisearch-types" }
 meilisearch-lib = { path = "../meilisearch-lib" }
 mime = "0.3.16"
 num_cpus = "1.13.1"

meilisearch-http/src/error.rs

@@ -1,6 +1,6 @@
 use actix_web as aweb;
 use aweb::error::{JsonPayloadError, QueryPayloadError};
-use meilisearch_error::{Code, ErrorCode, ResponseError};
+use meilisearch_types::error::{Code, ErrorCode, ResponseError};
 
 #[derive(Debug, thiserror::Error)]
 pub enum MeilisearchHttpError {

meilisearch-http/src/extractors/authentication/error.rs

@@ -1,4 +1,4 @@
-use meilisearch_error::{Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
 
 #[derive(Debug, thiserror::Error)]
 pub enum AuthenticationError {

meilisearch-http/src/extractors/authentication/mod.rs

@@ -5,12 +5,11 @@ use std::ops::Deref;
 use std::pin::Pin;
 
 use actix_web::FromRequest;
+use error::AuthenticationError;
 use futures::future::err;
 use futures::Future;
-use meilisearch_error::{Code, ResponseError};
-
-use error::AuthenticationError;
 use meilisearch_auth::{AuthController, AuthFilter};
+use meilisearch_types::error::{Code, ResponseError};
 
 pub struct GuardedData<P, D> {
     data: D,

meilisearch-http/src/lib.rs

@@ -148,10 +148,10 @@ macro_rules! create_app {
         use actix_web::middleware::TrailingSlash;
         use actix_web::App;
         use actix_web::{middleware, web};
-        use meilisearch_error::ResponseError;
         use meilisearch_http::error::MeilisearchHttpError;
         use meilisearch_http::routes;
         use meilisearch_http::{configure_data, dashboard};
+        use meilisearch_types::error::ResponseError;
 
         App::new()
             .configure(|s| configure_data(s, $data.clone(), $auth.clone(), &$opt, $analytics))

meilisearch-http/src/routes/api_key.rs

@@ -7,7 +7,7 @@ use time::OffsetDateTime;
 use uuid::Uuid;
 
 use meilisearch_auth::{error::AuthControllerError, Action, AuthController, Key};
-use meilisearch_error::{Code, ResponseError};
+use meilisearch_types::error::{Code, ResponseError};
 
 use crate::extractors::{
     authentication::{policies::*, GuardedData},

meilisearch-http/src/routes/dump.rs

@@ -1,7 +1,7 @@
 use actix_web::{web, HttpRequest, HttpResponse};
 use log::debug;
-use meilisearch_error::ResponseError;
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 use serde_json::json;
 
 use crate::analytics::Analytics;

meilisearch-http/src/routes/indexes/documents.rs

@@ -6,10 +6,10 @@ use actix_web::{web, HttpRequest, HttpResponse};
 use bstr::ByteSlice;
 use futures::{Stream, StreamExt};
 use log::debug;
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index_controller::{DocumentAdditionFormat, Update};
 use meilisearch_lib::milli::update::IndexDocumentsMethod;
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 use mime::Mime;
 use once_cell::sync::Lazy;
 use serde::Deserialize;

meilisearch-http/src/routes/indexes/mod.rs

@@ -1,8 +1,8 @@
 use actix_web::{web, HttpRequest, HttpResponse};
 use log::debug;
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index_controller::Update;
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 use serde::{Deserialize, Serialize};
 use serde_json::json;
 use time::OffsetDateTime;

meilisearch-http/src/routes/indexes/search.rs

@@ -1,12 +1,12 @@
 use actix_web::{web, HttpRequest, HttpResponse};
 use log::debug;
 use meilisearch_auth::IndexSearchRules;
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index::{
     SearchQuery, DEFAULT_CROP_LENGTH, DEFAULT_CROP_MARKER, DEFAULT_HIGHLIGHT_POST_TAG,
     DEFAULT_HIGHLIGHT_PRE_TAG, DEFAULT_SEARCH_LIMIT,
 };
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 use serde::Deserialize;
 use serde_cs::vec::CS;
 use serde_json::Value;

meilisearch-http/src/routes/indexes/settings.rs

@@ -1,10 +1,10 @@
 use log::debug;
 
 use actix_web::{web, HttpRequest, HttpResponse};
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index::{Settings, Unchecked};
 use meilisearch_lib::index_controller::Update;
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 use serde_json::json;
 
 use crate::analytics::Analytics;
@@ -21,7 +21,7 @@ macro_rules! make_setting_route {
             use meilisearch_lib::milli::update::Setting;
             use meilisearch_lib::{index::Settings, index_controller::Update, MeiliSearch};
 
-            use meilisearch_error::ResponseError;
+            use meilisearch_types::error::ResponseError;
             use $crate::analytics::Analytics;
             use $crate::extractors::authentication::{policies::*, GuardedData};
             use $crate::extractors::sequential_extractor::SeqHandler;

meilisearch-http/src/routes/mod.rs

@@ -6,9 +6,9 @@ use serde::{Deserialize, Serialize};
 
 use time::OffsetDateTime;
 
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index::{Settings, Unchecked};
 use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
 
 use crate::extractors::authentication::{policies::*, GuardedData};
 

meilisearch-http/src/routes/tasks.rs

@@ -1,8 +1,9 @@
 use actix_web::{web, HttpRequest, HttpResponse};
-use meilisearch_error::ResponseError;
 use meilisearch_lib::tasks::task::{TaskContent, TaskEvent, TaskId};
 use meilisearch_lib::tasks::TaskFilter;
-use meilisearch_lib::{IndexUid, MeiliSearch};
+use meilisearch_lib::MeiliSearch;
+use meilisearch_types::error::ResponseError;
+use meilisearch_types::index_uid::IndexUid;
 use serde::Deserialize;
 use serde_cs::vec::CS;
 use serde_json::json;

meilisearch-http/src/task.rs

@@ -3,12 +3,12 @@ use std::fmt::{self, Write};
 use std::str::FromStr;
 use std::write;
 
-use meilisearch_error::ResponseError;
 use meilisearch_lib::index::{Settings, Unchecked};
 use meilisearch_lib::tasks::batch::BatchId;
 use meilisearch_lib::tasks::task::{
     DocumentDeletion, Task, TaskContent, TaskEvent, TaskId, TaskResult,
 };
+use meilisearch_types::error::ResponseError;
 use serde::{Deserialize, Serialize, Serializer};
 use time::{Duration, OffsetDateTime};
 

meilisearch-http/tests/documents/add_documents.rs

@@ -638,7 +638,7 @@ async fn error_document_add_create_index_bad_uid() {
     let (response, code) = index.add_documents(json!([{"id": 1}]), None).await;
 
     let expected_response = json!({
-        "message": "`883  fj!` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+        "message": "invalid index uid `883  fj!`, the uid must be an integer or a string containing only alphanumeric characters a-z A-Z 0-9, hyphens - and underscores _.",
         "code": "invalid_index_uid",
         "type": "invalid_request",
         "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
@@ -655,7 +655,7 @@ async fn error_document_update_create_index_bad_uid() {
     let (response, code) = index.update_documents(json!([{"id": 1}]), None).await;
 
     let expected_response = json!({
-        "message": "`883  fj!` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+        "message": "invalid index uid `883  fj!`, the uid must be an integer or a string containing only alphanumeric characters a-z A-Z 0-9, hyphens - and underscores _.",
         "code": "invalid_index_uid",
         "type": "invalid_request",
         "link": "https://docs.meilisearch.com/errors#invalid_index_uid"

meilisearch-http/tests/index/create_index.rs

@@ -102,7 +102,7 @@ async fn error_create_with_invalid_index_uid() {
     let (response, code) = index.create(None).await;
 
     let expected_response = json!({
-        "message": "`test test#!` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+        "message": "invalid index uid `test test#!`, the uid must be an integer or a string containing only alphanumeric characters a-z A-Z 0-9, hyphens - and underscores _.",
         "code": "invalid_index_uid",
         "type": "invalid_request",
         "link": "https://docs.meilisearch.com/errors#invalid_index_uid"

meilisearch-http/tests/settings/get_settings.rs

@@ -197,7 +197,7 @@ async fn error_update_setting_unexisting_index_invalid_uid() {
     assert_eq!(code, 400);
 
     let expected = json!({
-        "message": "`test##!  ` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+        "message": "invalid index uid `test##!  `, the uid must be an integer or a string containing only alphanumeric characters a-z A-Z 0-9, hyphens - and underscores _.",
         "code": "invalid_index_uid",
         "type": "invalid_request",
         "link": "https://docs.meilisearch.com/errors#invalid_index_uid"});

meilisearch-lib/Cargo.toml

@@ -29,7 +29,7 @@ itertools = "0.10.3"
 lazy_static = "1.4.0"
 log = "0.4.14"
 meilisearch-auth = { path = "../meilisearch-auth" }
-meilisearch-error = { path = "../meilisearch-error" }
+meilisearch-types = { path = "../meilisearch-types" }
 milli = { git = "https://github.com/meilisearch/milli.git", tag = "v0.29.2" }
 mime = "0.3.16"
 num_cpus = "1.13.1"
@@ -59,7 +59,7 @@ whoami = { version = "1.2.1", optional = true }
 
 [dev-dependencies]
 actix-rt = "2.7.0"
-meilisearch-error = { path = "../meilisearch-error", features = ["test-traits"] }
+meilisearch-types = { path = "../meilisearch-types", features = ["test-traits"] }
 mockall = "0.11.0"
 nelson = { git = "https://github.com/meilisearch/nelson.git", rev = "675f13885548fb415ead8fbb447e9e6d9314000a"}
 paste = "1.0.6"

meilisearch-lib/src/document_formats.rs

@@ -2,7 +2,8 @@ use std::borrow::Borrow;
 use std::fmt::{self, Debug, Display};
 use std::io::{self, BufRead, BufReader, BufWriter, Cursor, Read, Seek, Write};
 
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::internal_error;
 use milli::documents::DocumentBatchBuilder;
 
 type Result<T> = std::result::Result<T, DocumentFormatError>;

meilisearch-lib/src/dump/compat/v2.rs

@@ -1,5 +1,5 @@
 use anyhow::bail;
-use meilisearch_error::Code;
+use meilisearch_types::error::Code;
 use milli::update::IndexDocumentsMethod;
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;

meilisearch-lib/src/dump/compat/v3.rs

@@ -1,4 +1,5 @@
-use meilisearch_error::{Code, ResponseError};
+use meilisearch_types::error::{Code, ResponseError};
+use meilisearch_types::index_uid::IndexUid;
 use milli::update::IndexDocumentsMethod;
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
@@ -6,7 +7,6 @@ use uuid::Uuid;
 
 use super::v4::{Task, TaskContent, TaskEvent};
 use crate::index::{Settings, Unchecked};
-use crate::index_resolver::IndexUid;
 use crate::tasks::task::{DocumentDeletion, TaskId, TaskResult};
 
 use super::v2;

meilisearch-lib/src/dump/compat/v4.rs

@@ -1,4 +1,5 @@
-use meilisearch_error::ResponseError;
+use meilisearch_types::error::ResponseError;
+use meilisearch_types::index_uid::IndexUid;
 use milli::update::IndexDocumentsMethod;
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
@@ -9,7 +10,6 @@ use crate::tasks::batch::BatchId;
 use crate::tasks::task::{
     DocumentDeletion, TaskContent as NewTaskContent, TaskEvent as NewTaskEvent, TaskId, TaskResult,
 };
-use crate::IndexUid;
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct Task {

meilisearch-lib/src/dump/error.rs

@@ -1,5 +1,6 @@
 use meilisearch_auth::error::AuthControllerError;
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::internal_error;
 
 use crate::{index_resolver::error::IndexResolverError, tasks::error::TaskError};
 

meilisearch-lib/src/error.rs

@@ -1,7 +1,7 @@
 use std::error::Error;
 use std::fmt;
 
-use meilisearch_error::{Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
 use milli::UserError;
 
 #[derive(Debug)]

meilisearch-lib/src/index/error.rs

@@ -1,6 +1,7 @@
 use std::error::Error;
 
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::internal_error;
 use serde_json::Value;
 
 use crate::{error::MilliError, update_file_store};

meilisearch-lib/src/index_controller/error.rs

@@ -1,7 +1,8 @@
 use std::error::Error;
 
-use meilisearch_error::Code;
-use meilisearch_error::{internal_error, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::index_uid::IndexUidFormatError;
+use meilisearch_types::internal_error;
 use tokio::task::JoinError;
 
 use super::DocumentAdditionFormat;
@@ -63,3 +64,9 @@ impl ErrorCode for IndexControllerError {
         }
     }
 }
+
+impl From<IndexUidFormatError> for IndexControllerError {
+    fn from(err: IndexUidFormatError) -> Self {
+        IndexResolverError::from(err).into()
+    }
+}

meilisearch-lib/src/index_controller/mod.rs

@@ -11,6 +11,7 @@ use actix_web::error::PayloadError;
 use bytes::Bytes;
 use futures::Stream;
 use futures::StreamExt;
+use meilisearch_types::index_uid::IndexUid;
 use milli::update::IndexDocumentsMethod;
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
@@ -37,7 +38,6 @@ use error::Result;
 use self::error::IndexControllerError;
 use crate::index_resolver::index_store::{IndexStore, MapIndexStore};
 use crate::index_resolver::meta_store::{HeedMetaStore, IndexMetaStore};
-pub use crate::index_resolver::IndexUid;
 use crate::index_resolver::{create_index_resolver, IndexResolver};
 use crate::update_file_store::UpdateFileStore;
 

meilisearch-lib/src/index_controller/updates/error.rs

@@ -1,7 +1,7 @@
 use std::error::Error;
 use std::fmt;
 
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::{internal_error, Code, ErrorCode};
 
 use crate::{
     document_formats::DocumentFormatError,

meilisearch-lib/src/index_resolver/error.rs

@@ -1,6 +1,8 @@
 use std::fmt;
 
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::index_uid::IndexUidFormatError;
+use meilisearch_types::internal_error;
 use tokio::sync::mpsc::error::SendError as MpscSendError;
 use tokio::sync::oneshot::error::RecvError as OneshotRecvError;
 use uuid::Uuid;
@@ -25,8 +27,8 @@ pub enum IndexResolverError {
     UuidAlreadyExists(Uuid),
     #[error("{0}")]
     Milli(#[from] milli::Error),
-    #[error("`{0}` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).")]
-    BadlyFormatted(String),
+    #[error("{0}")]
+    BadlyFormatted(#[from] IndexUidFormatError),
 }
 
 impl<T> From<MpscSendError<T>> for IndexResolverError

meilisearch-lib/src/index_resolver/mod.rs

@@ -2,20 +2,17 @@ pub mod error;
 pub mod index_store;
 pub mod meta_store;
 
-use std::convert::{TryFrom, TryInto};
-use std::error::Error;
-use std::fmt;
+use std::convert::TryFrom;
 use std::path::Path;
-use std::str::FromStr;
 use std::sync::Arc;
 
 use error::{IndexResolverError, Result};
 use index_store::{IndexStore, MapIndexStore};
-use meilisearch_error::ResponseError;
+use meilisearch_types::error::ResponseError;
+use meilisearch_types::index_uid::IndexUid;
 use meta_store::{HeedMetaStore, IndexMetaStore};
 use milli::heed::Env;
 use milli::update::{DocumentDeletionResult, IndexerConfig};
-use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
 use tokio::task::spawn_blocking;
 use uuid::Uuid;
@@ -35,12 +32,6 @@ pub use real::IndexResolver;
 #[cfg(test)]
 pub use test::MockIndexResolver as IndexResolver;
 
-/// An index uid is composed of only ascii alphanumeric characters, - and _, between 1 and 400
-/// bytes long
-#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
-#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
-pub struct IndexUid(#[cfg_attr(test, proptest(regex("[a-zA-Z0-9_-]{1,400}")))] String);
-
 pub fn create_index_resolver(
     path: impl AsRef<Path>,
     index_size: usize,
@@ -53,81 +44,6 @@ pub fn create_index_resolver(
     Ok(IndexResolver::new(uuid_store, index_store, file_store))
 }
 
-impl IndexUid {
-    pub fn new_unchecked(s: impl AsRef<str>) -> Self {
-        Self(s.as_ref().to_string())
-    }
-
-    pub fn into_inner(self) -> String {
-        self.0
-    }
-
-    /// Return a reference over the inner str.
-    pub fn as_str(&self) -> &str {
-        &self.0
-    }
-}
-
-impl std::ops::Deref for IndexUid {
-    type Target = str;
-
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
-impl TryInto<IndexUid> for String {
-    type Error = IndexUidFormatError;
-
-    fn try_into(self) -> std::result::Result<IndexUid, IndexUidFormatError> {
-        IndexUid::from_str(&self)
-    }
-}
-
-#[derive(Debug)]
-pub struct IndexUidFormatError {
-    invalid_uid: String,
-}
-
-impl fmt::Display for IndexUidFormatError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(
-            f,
-            "invalid index uid `{}`, the uid must be an integer \
-            or a string containing only alphanumeric characters \
-            a-z A-Z 0-9, hyphens - and underscores _.",
-            self.invalid_uid,
-        )
-    }
-}
-
-impl Error for IndexUidFormatError {}
-
-impl From<IndexUidFormatError> for IndexResolverError {
-    fn from(error: IndexUidFormatError) -> Self {
-        Self::BadlyFormatted(error.invalid_uid)
-    }
-}
-
-impl FromStr for IndexUid {
-    type Err = IndexUidFormatError;
-
-    fn from_str(uid: &str) -> std::result::Result<IndexUid, IndexUidFormatError> {
-        if !uid
-            .chars()
-            .all(|x| x.is_ascii_alphanumeric() || x == '-' || x == '_')
-            || uid.is_empty()
-            || uid.len() > 400
-        {
-            Err(IndexUidFormatError {
-                invalid_uid: uid.to_string(),
-            })
-        } else {
-            Ok(IndexUid(uid.to_string()))
-        }
-    }
-}
-
 mod real {
     use super::*;
 

meilisearch-lib/src/lib.rs

@@ -13,7 +13,7 @@ mod update_file_store;
 
 use std::path::Path;
 
-pub use index_controller::{IndexUid, MeiliSearch};
+pub use index_controller::MeiliSearch;
 pub use milli;
 pub use milli::heed;
 

meilisearch-lib/src/tasks/error.rs

@@ -1,4 +1,5 @@
-use meilisearch_error::{internal_error, Code, ErrorCode};
+use meilisearch_types::error::{Code, ErrorCode};
+use meilisearch_types::internal_error;
 use tokio::task::JoinError;
 
 use crate::update_file_store::UpdateFileStoreError;

meilisearch-lib/src/tasks/handlers/index_resolver_handler.rs

@@ -60,9 +60,9 @@ mod test {
         task::{Task, TaskContent},
     };
     use crate::update_file_store::{Result as FileStoreResult, UpdateFileStore};
-    use crate::IndexUid;
 
     use super::*;
+    use meilisearch_types::index_uid::IndexUid;
     use milli::update::IndexDocumentsMethod;
     use nelson::Mocker;
     use proptest::prelude::*;

meilisearch-lib/src/tasks/scheduler.rs

@@ -534,10 +534,11 @@ fn make_batch(tasks: &mut TaskQueue, config: &SchedulerConfig) -> Processing {
 
 #[cfg(test)]
 mod test {
+    use meilisearch_types::index_uid::IndexUid;
     use milli::update::IndexDocumentsMethod;
     use uuid::Uuid;
 
-    use crate::{index_resolver::IndexUid, tasks::task::TaskContent};
+    use crate::tasks::task::TaskContent;
 
     use super::*;
 

meilisearch-lib/src/tasks/task.rs

@@ -1,4 +1,5 @@
-use meilisearch_error::ResponseError;
+use meilisearch_types::error::ResponseError;
+use meilisearch_types::index_uid::IndexUid;
 use milli::update::{DocumentAdditionResult, IndexDocumentsMethod};
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
@@ -6,7 +7,6 @@ use uuid::Uuid;
 
 use super::batch::BatchId;
 use crate::index::{Settings, Unchecked};
-use crate::index_resolver::IndexUid;
 
 pub type TaskId = u32;
 

meilisearch-lib/src/tasks/task_store/mod.rs

@@ -267,13 +267,11 @@ impl TaskStore {
 
 #[cfg(test)]
 pub mod test {
-    use crate::{
-        tasks::{scheduler::Processing, task_store::store::test::tmp_env},
-        IndexUid,
-    };
+    use crate::tasks::{scheduler::Processing, task_store::store::test::tmp_env};
 
     use super::*;
 
+    use meilisearch_types::index_uid::IndexUid;
     use nelson::Mocker;
     use proptest::{
         strategy::Strategy,

meilisearch-lib/src/tasks/task_store/store.rs

@@ -179,11 +179,11 @@ impl Store {
 #[cfg(test)]
 pub mod test {
     use itertools::Itertools;
+    use meilisearch_types::index_uid::IndexUid;
     use milli::heed::EnvOpenOptions;
     use nelson::Mocker;
     use tempfile::TempDir;
 
-    use crate::index_resolver::IndexUid;
     use crate::tasks::task::TaskContent;
 
     use super::*;

meilisearch-types/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "meilisearch-error"
+name = "meilisearch-types"
 version = "0.28.0"
 authors = ["marin <postma.marin@protonmail.com>"]
 edition = "2021"

meilisearch-types/src/index_uid.rs

@@ -0,0 +1,85 @@
+use serde::{Deserialize, Serialize};
+use std::error::Error;
+use std::fmt;
+use std::str::FromStr;
+
+/// An index uid is composed of only ascii alphanumeric characters, - and _, between 1 and 400
+/// bytes long
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
+#[cfg_attr(feature = "test-traits", derive(proptest_derive::Arbitrary))]
+pub struct IndexUid(
+    #[cfg_attr(feature = "test-traits", proptest(regex("[a-zA-Z0-9_-]{1,400}")))] String,
+);
+
+impl IndexUid {
+    pub fn new_unchecked(s: impl AsRef<str>) -> Self {
+        Self(s.as_ref().to_string())
+    }
+
+    pub fn into_inner(self) -> String {
+        self.0
+    }
+
+    /// Return a reference over the inner str.
+    pub fn as_str(&self) -> &str {
+        &self.0
+    }
+}
+
+impl std::ops::Deref for IndexUid {
+    type Target = str;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl TryFrom<String> for IndexUid {
+    type Error = IndexUidFormatError;
+
+    fn try_from(uid: String) -> Result<Self, Self::Error> {
+        if !uid
+            .chars()
+            .all(|x| x.is_ascii_alphanumeric() || x == '-' || x == '_')
+            || uid.is_empty()
+            || uid.len() > 400
+        {
+            Err(IndexUidFormatError { invalid_uid: uid })
+        } else {
+            Ok(IndexUid(uid))
+        }
+    }
+}
+
+impl FromStr for IndexUid {
+    type Err = IndexUidFormatError;
+
+    fn from_str(uid: &str) -> Result<IndexUid, IndexUidFormatError> {
+        uid.to_string().try_into()
+    }
+}
+
+impl From<IndexUid> for String {
+    fn from(uid: IndexUid) -> Self {
+        uid.into_inner()
+    }
+}
+
+#[derive(Debug)]
+pub struct IndexUidFormatError {
+    pub invalid_uid: String,
+}
+
+impl fmt::Display for IndexUidFormatError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(
+            f,
+            "invalid index uid `{}`, the uid must be an integer \
+            or a string containing only alphanumeric characters \
+            a-z A-Z 0-9, hyphens - and underscores _.",
+            self.invalid_uid,
+        )
+    }
+}
+
+impl Error for IndexUidFormatError {}

meilisearch-types/src/lib.rs

@@ -0,0 +1,2 @@
+pub mod error;
+pub mod index_uid;