snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-22 10:07:40 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Try fix Sequence impl, refactor, improve

Browse Source
This commit is contained in:
F. Levi 2024-10-20 21:46:39 +03:00
parent e4745a61a8
commit 0419b93032
3 changed files with 65 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
meilisearch-auth/src/store.rs
View File

@ -304,13 +304,13 @@ impl<'a> milli::heed::BytesDecode<'a> for KeyIdActionCodec {
fn bytes_decode(bytes: &'a [u8]) -> StdResult<Self::DItem, BoxedError> { fn bytes_decode(bytes: &'a [u8]) -> StdResult<Self::DItem, BoxedError> {
let (key_id_bytes, action_bytes) = try_split_array_at(bytes).ok_or(SliceTooShortError)?; let (key_id_bytes, action_bytes) = try_split_array_at(bytes).ok_or(SliceTooShortError)?;
let (action_repr, index) = let (action_bits, index) =
match try_split_array_at::<u8, 4>(action_bytes).ok_or(SliceTooShortError)? { match try_split_array_at::<u8, 4>(action_bytes).ok_or(SliceTooShortError)? {
(action_parts, []) => (Self::action_parts_to_repr(action_parts), None), (action_parts, []) => (Self::action_parts_to_repr(action_parts), None),
(action_parts, index) => (Self::action_parts_to_repr(action_parts), Some(index)), (action_parts, index) => (Self::action_parts_to_repr(action_parts), Some(index)),
}; };
let key_id = Uuid::from_bytes(*key_id_bytes); let key_id = Uuid::from_bytes(*key_id_bytes);
let action = Action::from_repr(action_repr).ok_or(InvalidActionError { action_repr })?; let action = Action::from_bits(action_bits).ok_or(InvalidActionError { action_bits })?;
Ok((key_id, action, index)) Ok((key_id, action, index))
} }
@ -323,7 +323,7 @@ impl<'a> milli::heed::BytesEncode<'a> for KeyIdActionCodec {
let mut bytes = Vec::new(); let mut bytes = Vec::new();
bytes.extend_from_slice(key_id.as_bytes()); bytes.extend_from_slice(key_id.as_bytes());
let action_bytes = u32::to_be_bytes(action.repr()); let action_bytes = u32::to_be_bytes(action.bits());
bytes.extend_from_slice(&action_bytes); bytes.extend_from_slice(&action_bytes);
if let Some(index) = index { if let Some(index) = index {
bytes.extend_from_slice(index); bytes.extend_from_slice(index);
@ -338,9 +338,9 @@ impl<'a> milli::heed::BytesEncode<'a> for KeyIdActionCodec {
pub struct SliceTooShortError; pub struct SliceTooShortError;
#[derive(Error, Debug)] #[derive(Error, Debug)]
#[error("cannot construct a valid Action from {action_repr}")] #[error("cannot construct a valid Action from {action_bits}")]
pub struct InvalidActionError { pub struct InvalidActionError {
pub action_repr: u32, pub action_bits: u32,
} }
pub fn generate_key_as_hexa(uid: Uuid, master_key: &[u8]) -> String { pub fn generate_key_as_hexa(uid: Uuid, master_key: &[u8]) -> String {

156
meilisearch-types/src/keys.rs
View File

@ -189,35 +189,35 @@ bitflags! {
const DocumentsAdd = 1 << 1; const DocumentsAdd = 1 << 1;
const DocumentsGet = 1 << 2; const DocumentsGet = 1 << 2;
const DocumentsDelete = 1 << 3; const DocumentsDelete = 1 << 3;
const DocumentsAll = Self::DocumentsAdd.repr() | Self::DocumentsGet.repr() | Self::DocumentsDelete.repr(); const DocumentsAll = Self::DocumentsAdd.bits() | Self::DocumentsGet.bits() | Self::DocumentsDelete.bits();
// Indexes // Indexes
const IndexesAdd = 1 << 4; const IndexesAdd = 1 << 4;
const IndexesGet = 1 << 5; const IndexesGet = 1 << 5;
const IndexesUpdate = 1 << 6; const IndexesUpdate = 1 << 6;
const IndexesDelete = 1 << 7; const IndexesDelete = 1 << 7;
const IndexesSwap = 1 << 8; const IndexesSwap = 1 << 8;
const IndexesAll = Self::IndexesAdd.repr() | Self::IndexesGet.repr() | Self::IndexesUpdate.repr() | Self::IndexesDelete.repr() | Self::IndexesSwap.repr(); const IndexesAll = Self::IndexesAdd.bits() | Self::IndexesGet.bits() | Self::IndexesUpdate.bits() | Self::IndexesDelete.bits() | Self::IndexesSwap.bits();
// Tasks // Tasks
const TasksCancel = 1 << 9; const TasksCancel = 1 << 9;
const TasksDelete = 1 << 10; const TasksDelete = 1 << 10;
const TasksGet = 1 << 11; const TasksGet = 1 << 11;
const TasksAll = Self::TasksCancel.repr() | Self::TasksDelete.repr() | Self::TasksGet.repr(); const TasksAll = Self::TasksCancel.bits() | Self::TasksDelete.bits() | Self::TasksGet.bits();
// Settings // Settings
const SettingsGet = 1 << 12; const SettingsGet = 1 << 12;
const SettingsUpdate = 1 << 13; const SettingsUpdate = 1 << 13;
const SettingsAll = Self::SettingsGet.repr() | Self::SettingsUpdate.repr(); const SettingsAll = Self::SettingsGet.bits() | Self::SettingsUpdate.bits();
// Stats // Stats
const StatsGet = 1 << 14; const StatsGet = 1 << 14;
const StatsAll = Self::StatsGet.repr(); const StatsAll = Self::StatsGet.bits();
// Metrics // Metrics
const MetricsGet = 1 << 15; const MetricsGet = 1 << 15;
const MetricsAll = Self::MetricsGet.repr(); const MetricsAll = Self::MetricsGet.bits();
// Dumps // Dumps
const DumpsCreate = 1 << 16; const DumpsCreate = 1 << 16;
const DumpsAll = Self::DumpsCreate.repr(); const DumpsAll = Self::DumpsCreate.bits();
// Snapshots // Snapshots
const SnapshotsCreate = 1 << 17; const SnapshotsCreate = 1 << 17;
const SnapshotsAll = Self::SnapshotsCreate.repr(); const SnapshotsAll = Self::SnapshotsCreate.bits();
const Version = 1 << 18; const Version = 1 << 18;
const KeysAdd = 1 << 19; const KeysAdd = 1 << 19;
const KeysGet = 1 << 20; const KeysGet = 1 << 20;
@ -241,33 +241,32 @@ bitflags! {
impl Action { impl Action {
const SERDE_MAP_ARR: [(&'static str, Self); 34] = [ const SERDE_MAP_ARR: [(&'static str, Self); 34] = [
("*", Self::All),
("search", Self::Search), ("search", Self::Search),
("documents.*", Self::DocumentsAll),
("documents.add", Self::DocumentsAdd), ("documents.add", Self::DocumentsAdd),
("documents.get", Self::DocumentsGet), ("documents.get", Self::DocumentsGet),
("documents.delete", Self::DocumentsDelete), ("documents.delete", Self::DocumentsDelete),
("indexes.*", Self::IndexesAll), ("documents.*", Self::DocumentsAll),
("indexes.create", Self::IndexesAdd), ("indexes.create", Self::IndexesAdd),
("indexes.get", Self::IndexesGet), ("indexes.get", Self::IndexesGet),
("indexes.update", Self::IndexesUpdate), ("indexes.update", Self::IndexesUpdate),
("indexes.delete", Self::IndexesDelete), ("indexes.delete", Self::IndexesDelete),
("indexes.swap", Self::IndexesSwap), ("indexes.swap", Self::IndexesSwap),
("tasks.*", Self::TasksAll), ("indexes.*", Self::IndexesAll),
("tasks.cancel", Self::TasksCancel), ("tasks.cancel", Self::TasksCancel),
("tasks.delete", Self::TasksDelete), ("tasks.delete", Self::TasksDelete),
("tasks.get", Self::TasksGet), ("tasks.get", Self::TasksGet),
("settings.*", Self::SettingsAll), ("tasks.*", Self::TasksAll),
("settings.get", Self::SettingsGet), ("settings.get", Self::SettingsGet),
("settings.update", Self::SettingsUpdate), ("settings.update", Self::SettingsUpdate),
("stats.*", Self::StatsAll), ("settings.*", Self::SettingsAll),
("stats.get", Self::StatsGet), ("stats.get", Self::StatsGet),
("metrics.*", Self::MetricsAll), ("stats.*", Self::StatsAll),
("metrics.get", Self::MetricsGet), ("metrics.get", Self::MetricsGet),
("dumps.*", Self::DumpsAll), ("metrics.*", Self::MetricsAll),
("dumps.create", Self::DumpsCreate), ("dumps.create", Self::DumpsCreate),
("snapshots.*", Self::SnapshotsAll), ("dumps.*", Self::DumpsAll),
("snapshots.create", Self::SnapshotsCreate), ("snapshots.create", Self::SnapshotsCreate),
("snapshots.*", Self::SnapshotsAll),
("version", Self::Version), ("version", Self::Version),
("keys.create", Self::KeysAdd), ("keys.create", Self::KeysAdd),
("keys.get", Self::KeysGet), ("keys.get", Self::KeysGet),
@ -275,6 +274,7 @@ impl Action {
("keys.delete", Self::KeysDelete), ("keys.delete", Self::KeysDelete),
("experimental.get", Self::ExperimentalFeaturesGet), ("experimental.get", Self::ExperimentalFeaturesGet),
("experimental.update", Self::ExperimentalFeaturesUpdate), ("experimental.update", Self::ExperimentalFeaturesUpdate),
("*", Self::All),
]; ];
fn get_action(v: &str) -> Option<Action> { fn get_action(v: &str) -> Option<Action> {
@ -289,92 +289,54 @@ impl Action {
.iter() .iter()
.find(|(_, action)| v == action) .find(|(_, action)| v == action)
.map(|(serde_name, _)| serde_name) .map(|(serde_name, _)| serde_name)
.expect("an action doesn't have a matching serialized value") .expect("an action is missing a matching serialized value")
} }
pub const fn from_repr(repr: u32) -> Option<Self> { fn get_index(&self) -> usize {
use actions::*; Self::SERDE_MAP_ARR
match repr { .iter()
SEARCH => Some(Self::Search), .enumerate()
DOCUMENTS_ADD => Some(Self::DocumentsAdd), .find(|(_, (_, action))| action == self)
DOCUMENTS_GET => Some(Self::DocumentsGet), .map(|(i, _)| i)
DOCUMENTS_DELETE => Some(Self::DocumentsDelete), .unwrap()
DOCUMENTS_ALL => Some(Self::DocumentsAll),
INDEXES_CREATE => Some(Self::IndexesAdd),
INDEXES_GET => Some(Self::IndexesGet),
INDEXES_UPDATE => Some(Self::IndexesUpdate),
INDEXES_DELETE => Some(Self::IndexesDelete),
INDEXES_SWAP => Some(Self::IndexesSwap),
INDEXES_ALL => Some(Self::IndexesAll),
TASKS_CANCEL => Some(Self::TasksCancel),
TASKS_DELETE => Some(Self::TasksDelete),
TASKS_GET => Some(Self::TasksGet),
TASKS_ALL => Some(Self::TasksAll),
SETTINGS_GET => Some(Self::SettingsGet),
SETTINGS_UPDATE => Some(Self::SettingsUpdate),
SETTINGS_ALL => Some(Self::SettingsAll),
STATS_GET => Some(Self::StatsGet),
// TODO: Issue: Since stats has only one element, all is the same as the one single element
// so this will never match all, because it matches that one and only element first
// STATS_ALL => Some(Self::StatsAll),
METRICS_GET => Some(Self::MetricsGet),
// METRICS_ALL => Some(Self::MetricsAll),
DUMPS_CREATE => Some(Self::DumpsCreate),
// DUMPS_ALL => Some(Self::DumpsAll),
SNAPSHOTS_CREATE => Some(Self::SnapshotsCreate),
VERSION => Some(Self::Version),
KEYS_CREATE => Some(Self::KeysAdd),
KEYS_GET => Some(Self::KeysGet),
KEYS_UPDATE => Some(Self::KeysUpdate),
KEYS_DELETE => Some(Self::KeysDelete),
EXPERIMENTAL_FEATURES_GET => Some(Self::ExperimentalFeaturesGet),
EXPERIMENTAL_FEATURES_UPDATE => Some(Self::ExperimentalFeaturesUpdate),
ALL => Some(Self::All),
_ => None,
}
}
pub const fn repr(&self) -> u32 {
self.bits()
} }
} }
pub mod actions { pub mod actions {
use super::Action as A; use super::Action as A;
pub const SEARCH: u32 = A::Search.repr(); pub const SEARCH: u32 = A::Search.bits();
pub const DOCUMENTS_ADD: u32 = A::DocumentsAdd.repr(); pub const DOCUMENTS_ADD: u32 = A::DocumentsAdd.bits();
pub const DOCUMENTS_GET: u32 = A::DocumentsGet.repr(); pub const DOCUMENTS_GET: u32 = A::DocumentsGet.bits();
pub const DOCUMENTS_DELETE: u32 = A::DocumentsDelete.repr(); pub const DOCUMENTS_DELETE: u32 = A::DocumentsDelete.bits();
pub const DOCUMENTS_ALL: u32 = A::DocumentsAll.repr(); pub const DOCUMENTS_ALL: u32 = A::DocumentsAll.bits();
pub const INDEXES_CREATE: u32 = A::IndexesAdd.repr(); pub const INDEXES_CREATE: u32 = A::IndexesAdd.bits();
pub const INDEXES_GET: u32 = A::IndexesGet.repr(); pub const INDEXES_GET: u32 = A::IndexesGet.bits();
pub const INDEXES_UPDATE: u32 = A::IndexesUpdate.repr(); pub const INDEXES_UPDATE: u32 = A::IndexesUpdate.bits();
pub const INDEXES_DELETE: u32 = A::IndexesDelete.repr(); pub const INDEXES_DELETE: u32 = A::IndexesDelete.bits();
pub const INDEXES_SWAP: u32 = A::IndexesSwap.repr(); pub const INDEXES_SWAP: u32 = A::IndexesSwap.bits();
pub const INDEXES_ALL: u32 = A::IndexesAll.repr(); pub const INDEXES_ALL: u32 = A::IndexesAll.bits();
pub const TASKS_CANCEL: u32 = A::TasksCancel.repr(); pub const TASKS_CANCEL: u32 = A::TasksCancel.bits();
pub const TASKS_DELETE: u32 = A::TasksDelete.repr(); pub const TASKS_DELETE: u32 = A::TasksDelete.bits();
pub const TASKS_GET: u32 = A::TasksGet.repr(); pub const TASKS_GET: u32 = A::TasksGet.bits();
pub const TASKS_ALL: u32 = A::TasksAll.repr(); pub const TASKS_ALL: u32 = A::TasksAll.bits();
pub const SETTINGS_GET: u32 = A::SettingsGet.repr(); pub const SETTINGS_GET: u32 = A::SettingsGet.bits();
pub const SETTINGS_UPDATE: u32 = A::SettingsUpdate.repr(); pub const SETTINGS_UPDATE: u32 = A::SettingsUpdate.bits();
pub const SETTINGS_ALL: u32 = A::SettingsAll.repr(); pub const SETTINGS_ALL: u32 = A::SettingsAll.bits();
pub const STATS_GET: u32 = A::StatsGet.repr(); pub const STATS_GET: u32 = A::StatsGet.bits();
pub const STATS_ALL: u32 = A::StatsAll.repr(); pub const STATS_ALL: u32 = A::StatsAll.bits();
pub const METRICS_GET: u32 = A::MetricsGet.repr(); pub const METRICS_GET: u32 = A::MetricsGet.bits();
pub const METRICS_ALL: u32 = A::MetricsAll.repr(); pub const METRICS_ALL: u32 = A::MetricsAll.bits();
pub const DUMPS_CREATE: u32 = A::DumpsCreate.repr(); pub const DUMPS_CREATE: u32 = A::DumpsCreate.bits();
pub const DUMPS_ALL: u32 = A::DumpsAll.repr(); pub const DUMPS_ALL: u32 = A::DumpsAll.bits();
pub const SNAPSHOTS_CREATE: u32 = A::SnapshotsCreate.repr(); pub const SNAPSHOTS_CREATE: u32 = A::SnapshotsCreate.bits();
pub const VERSION: u32 = A::Version.repr(); pub const VERSION: u32 = A::Version.bits();
pub const KEYS_CREATE: u32 = A::KeysAdd.repr(); pub const KEYS_CREATE: u32 = A::KeysAdd.bits();
pub const KEYS_GET: u32 = A::KeysGet.repr(); pub const KEYS_GET: u32 = A::KeysGet.bits();
pub const KEYS_UPDATE: u32 = A::KeysUpdate.repr(); pub const KEYS_UPDATE: u32 = A::KeysUpdate.bits();
pub const KEYS_DELETE: u32 = A::KeysDelete.repr(); pub const KEYS_DELETE: u32 = A::KeysDelete.bits();
pub const EXPERIMENTAL_FEATURES_GET: u32 = A::ExperimentalFeaturesGet.repr(); pub const EXPERIMENTAL_FEATURES_GET: u32 = A::ExperimentalFeaturesGet.bits();
pub const EXPERIMENTAL_FEATURES_UPDATE: u32 = A::ExperimentalFeaturesUpdate.repr(); pub const EXPERIMENTAL_FEATURES_UPDATE: u32 = A::ExperimentalFeaturesUpdate.bits();
pub(crate) const ALL: u32 = A::All.repr();
} }
impl<E: DeserializeError> Deserr<E> for Action { impl<E: DeserializeError> Deserr<E> for Action {
@ -447,7 +409,7 @@ impl Sequence for Action {
const CARDINALITY: usize = Self::SERDE_MAP_ARR.len(); const CARDINALITY: usize = Self::SERDE_MAP_ARR.len();
fn next(&self) -> Option<Self> { fn next(&self) -> Option<Self> {
let next_index = self.bits() as usize + 1; let next_index = self.get_index() + 1;
if next_index == Self::CARDINALITY { if next_index == Self::CARDINALITY {
None None
} else { } else {
@ -456,7 +418,7 @@ impl Sequence for Action {
} }
fn previous(&self) -> Option<Self> { fn previous(&self) -> Option<Self> {
let current_index = self.bits() as usize; let current_index = self.get_index();
if current_index == 0 { if current_index == 0 {
None None
} else { } else {

2
meilisearch/src/extractors/authentication/mod.rs
View File

@ -255,7 +255,7 @@ pub mod policies {
}; };
// check that the indexes are allowed // check that the indexes are allowed
let action = Action::from_repr(A).ok_or(AuthError::InternalInvalidAction(A))?; let action = Action::from_bits(A).ok_or(AuthError::InternalInvalidAction(A))?;
let auth_filter = auth let auth_filter = auth
.get_key_filters(key_uuid, search_rules) .get_key_filters(key_uuid, search_rules)
.map_err(|_e| AuthError::InvalidApiKey)?; .map_err(|_e| AuthError::InvalidApiKey)?;