meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4645 opened on May 21, 2024

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Rust (20,887 stars) (733 forks)batch import
good first issuemaintenance

Description

Currently, the Meilisearch action keys are single numbers and therefore cannot be combined. It's not possible to OR them NOT them. I needed to do a basic documents.add | documents.delete for the edit documents by using a function feature.

We must use bitflags to define those actions and be able to combine them. We could have 32 or 64 different combinable actions. We already use this library in heed and it works very well.

Contributor guide

Tech stack
rust
Domain
backendauthenticationauthorization
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingbitflags crateMeilisearch codebase overview
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by reviewing the existing key actions implementation in meilisearch types/src/keys.rs. Understand the current 'single numbers' approach and how actions are defined. Read the bitflags crate documentation to learn how to define combinable flags. Then, refactor the Action enum to use the bitflags macro, ensuring all existing action values are preserved. Update any code that compares or uses these action values to work with bitwise operations. Check for tests that need updates. Discuss any breaking changes in the issue comments.