meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4,645 opened on May 21, 2024

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)Rust (2,542 forks)batch import
good first issuemaintenance

Repository metrics

Stars
 (57,572 stars)
PR merge metrics
 (Avg merge 11d 20h) (41 merged PRs in 30d)

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

Research direction
Replace the current numeric action keys with bitflags using the bitflags crate, ensuring backward compatibility and updating all usages.
Tech stack
rust
Domain
backend
Issue type
Refactor
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-2 days
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
Rustbitflags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65