Use the enum to display the error code and error type directly

[irevoire]

Currently, we represent all the possible error codes and types as enums in meilisearch;

meilisearch/meilisearch-types/src/error.rs

Lines 111 to 184 in ab655a8

	#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
	pub enum Code {
	// error related to your setup
	IoError,
	NoSpaceLeftOnDevice,
	TooManyOpenFiles,
	// index related error
	CreateIndex,
	IndexAlreadyExists,
	IndexNotFound,
	InvalidIndexUid,
	InvalidMinWordLengthForTypo,
	DuplicateIndexFound,
	// invalid state error
	InvalidState,
	MissingPrimaryKey,
	PrimaryKeyAlreadyPresent,
	MaxFieldsLimitExceeded,
	MissingDocumentId,
	InvalidDocumentId,
	Filter,
	Sort,
	BadParameter,
	BadRequest,
	DatabaseSizeLimitReached,
	DocumentNotFound,
	Internal,
	InvalidGeoField,
	InvalidRankingRule,
	InvalidStore,
	InvalidToken,
	MissingAuthorizationHeader,
	MissingMasterKey,
	DumpNotFound,
	InvalidTaskDateFilter,
	InvalidTaskStatusesFilter,
	InvalidTaskTypesFilter,
	InvalidTaskCanceledByFilter,
	InvalidTaskUidsFilter,
	TaskNotFound,
	TaskDeletionWithEmptyQuery,
	TaskCancelationWithEmptyQuery,
	PayloadTooLarge,
	RetrieveDocument,
	SearchDocuments,
	UnsupportedMediaType,
	DumpAlreadyInProgress,
	DumpProcessFailed,
	// Only used when importing a dump
	UnretrievableErrorCode,
	InvalidContentType,
	MissingContentType,
	MalformedPayload,
	MissingPayload,
	ApiKeyNotFound,
	MissingParameter,
	InvalidApiKeyActions,
	InvalidApiKeyIndexes,
	InvalidApiKeyExpiresAt,
	InvalidApiKeyDescription,
	InvalidApiKeyName,
	InvalidApiKeyUid,
	ImmutableField,
	ApiKeyAlreadyExists,
	}

But when we need to display them, instead of using their name, we write the implementation by hand instead of letting a tool like serde_json do it for us;

meilisearch/meilisearch-types/src/error.rs

Lines 186 to 334 in ab655a8

	impl Code {
	/// associate a `Code` variant to the actual ErrCode
	fn err_code(&self) -> ErrCode {
	use Code::*;
	match self {
	// related to the setup
	IoError => ErrCode::invalid("io_error", StatusCode::UNPROCESSABLE_ENTITY),
	TooManyOpenFiles => {
	ErrCode::invalid("too_many_open_files", StatusCode::UNPROCESSABLE_ENTITY)
	}
	NoSpaceLeftOnDevice => {
	ErrCode::invalid("no_space_left_on_device", StatusCode::UNPROCESSABLE_ENTITY)
	}
	// index related errors
	// create index is thrown on internal error while creating an index.
	CreateIndex => {
	ErrCode::internal("index_creation_failed", StatusCode::INTERNAL_SERVER_ERROR)
	}
	IndexAlreadyExists => ErrCode::invalid("index_already_exists", StatusCode::CONFLICT),
	// thrown when requesting an unexisting index
	IndexNotFound => ErrCode::invalid("index_not_found", StatusCode::NOT_FOUND),
	InvalidIndexUid => ErrCode::invalid("invalid_index_uid", StatusCode::BAD_REQUEST),
	// invalid state error
	InvalidState => ErrCode::internal("invalid_state", StatusCode::INTERNAL_SERVER_ERROR),
	// thrown when no primary key has been set
	MissingPrimaryKey => {
	ErrCode::invalid("primary_key_inference_failed", StatusCode::BAD_REQUEST)
	}
	// error thrown when trying to set an already existing primary key
	PrimaryKeyAlreadyPresent => {
	ErrCode::invalid("index_primary_key_already_exists", StatusCode::BAD_REQUEST)
	}
	// invalid ranking rule
	InvalidRankingRule => ErrCode::invalid("invalid_ranking_rule", StatusCode::BAD_REQUEST),
	// invalid database
	InvalidStore => {
	ErrCode::internal("invalid_store_file", StatusCode::INTERNAL_SERVER_ERROR)
	}
	// invalid document
	MaxFieldsLimitExceeded => {
	ErrCode::invalid("max_fields_limit_exceeded", StatusCode::BAD_REQUEST)
	}
	MissingDocumentId => ErrCode::invalid("missing_document_id", StatusCode::BAD_REQUEST),
	InvalidDocumentId => ErrCode::invalid("invalid_document_id", StatusCode::BAD_REQUEST),
	// error related to filters
	Filter => ErrCode::invalid("invalid_filter", StatusCode::BAD_REQUEST),
	// error related to sorts
	Sort => ErrCode::invalid("invalid_sort", StatusCode::BAD_REQUEST),
	BadParameter => ErrCode::invalid("bad_parameter", StatusCode::BAD_REQUEST),
	BadRequest => ErrCode::invalid("bad_request", StatusCode::BAD_REQUEST),
	DatabaseSizeLimitReached => {
	ErrCode::internal("database_size_limit_reached", StatusCode::INTERNAL_SERVER_ERROR)
	}
	DocumentNotFound => ErrCode::invalid("document_not_found", StatusCode::NOT_FOUND),
	Internal => ErrCode::internal("internal", StatusCode::INTERNAL_SERVER_ERROR),
	InvalidGeoField => ErrCode::invalid("invalid_geo_field", StatusCode::BAD_REQUEST),
	InvalidToken => ErrCode::authentication("invalid_api_key", StatusCode::FORBIDDEN),
	MissingAuthorizationHeader => {
	ErrCode::authentication("missing_authorization_header", StatusCode::UNAUTHORIZED)
	}
	MissingMasterKey => {
	ErrCode::authentication("missing_master_key", StatusCode::UNAUTHORIZED)
	}
	InvalidTaskDateFilter => {
	ErrCode::invalid("invalid_task_date_filter", StatusCode::BAD_REQUEST)
	}
	InvalidTaskUidsFilter => {
	ErrCode::invalid("invalid_task_uids_filter", StatusCode::BAD_REQUEST)
	}
	InvalidTaskStatusesFilter => {
	ErrCode::invalid("invalid_task_statuses_filter", StatusCode::BAD_REQUEST)
	}
	InvalidTaskTypesFilter => {
	ErrCode::invalid("invalid_task_types_filter", StatusCode::BAD_REQUEST)
	}
	InvalidTaskCanceledByFilter => {
	ErrCode::invalid("invalid_task_canceled_by_filter", StatusCode::BAD_REQUEST)
	}
	TaskNotFound => ErrCode::invalid("task_not_found", StatusCode::NOT_FOUND),
	TaskDeletionWithEmptyQuery => {
	ErrCode::invalid("missing_task_filters", StatusCode::BAD_REQUEST)
	}
	TaskCancelationWithEmptyQuery => {
	ErrCode::invalid("missing_task_filters", StatusCode::BAD_REQUEST)
	}
	DumpNotFound => ErrCode::invalid("dump_not_found", StatusCode::NOT_FOUND),
	PayloadTooLarge => ErrCode::invalid("payload_too_large", StatusCode::PAYLOAD_TOO_LARGE),
	RetrieveDocument => {
	ErrCode::internal("unretrievable_document", StatusCode::BAD_REQUEST)
	}
	SearchDocuments => ErrCode::internal("search_error", StatusCode::BAD_REQUEST),
	UnsupportedMediaType => {
	ErrCode::invalid("unsupported_media_type", StatusCode::UNSUPPORTED_MEDIA_TYPE)
	}
	// error related to dump
	DumpAlreadyInProgress => {
	ErrCode::invalid("dump_already_processing", StatusCode::CONFLICT)
	}
	DumpProcessFailed => {
	ErrCode::internal("dump_process_failed", StatusCode::INTERNAL_SERVER_ERROR)
	}
	MissingContentType => {
	ErrCode::invalid("missing_content_type", StatusCode::UNSUPPORTED_MEDIA_TYPE)
	}
	MalformedPayload => ErrCode::invalid("malformed_payload", StatusCode::BAD_REQUEST),
	InvalidContentType => {
	ErrCode::invalid("invalid_content_type", StatusCode::UNSUPPORTED_MEDIA_TYPE)
	}
	MissingPayload => ErrCode::invalid("missing_payload", StatusCode::BAD_REQUEST),
	// This one can only happen when importing a dump and encountering an unknown code in the task queue.
	UnretrievableErrorCode => {
	ErrCode::invalid("unretrievable_error_code", StatusCode::BAD_REQUEST)
	}
	// error related to keys
	ApiKeyNotFound => ErrCode::invalid("api_key_not_found", StatusCode::NOT_FOUND),
	MissingParameter => ErrCode::invalid("missing_parameter", StatusCode::BAD_REQUEST),
	InvalidApiKeyActions => {
	ErrCode::invalid("invalid_api_key_actions", StatusCode::BAD_REQUEST)
	}
	InvalidApiKeyIndexes => {
	ErrCode::invalid("invalid_api_key_indexes", StatusCode::BAD_REQUEST)
	}
	InvalidApiKeyExpiresAt => {
	ErrCode::invalid("invalid_api_key_expires_at", StatusCode::BAD_REQUEST)
	}
	InvalidApiKeyDescription => {
	ErrCode::invalid("invalid_api_key_description", StatusCode::BAD_REQUEST)
	}
	InvalidApiKeyName => ErrCode::invalid("invalid_api_key_name", StatusCode::BAD_REQUEST),
	InvalidApiKeyUid => ErrCode::invalid("invalid_api_key_uid", StatusCode::BAD_REQUEST),
	ApiKeyAlreadyExists => ErrCode::invalid("api_key_already_exists", StatusCode::CONFLICT),
	ImmutableField => ErrCode::invalid("immutable_field", StatusCode::BAD_REQUEST),
	InvalidMinWordLengthForTypo => {
	ErrCode::invalid("invalid_min_word_length_for_typo", StatusCode::BAD_REQUEST)
	}
	DuplicateIndexFound => {
	ErrCode::invalid("duplicate_index_found", StatusCode::BAD_REQUEST)
	}
	}
	}

That's very error-prone, not tested and could cause issues in the dump since we need to deserialize the string by hand once again to try to get the original enum.

We then have to store String in the final type we give to actix-web when we could keep our original types and ease everything.

[curquiza]

Closed by #3329