meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4645 aperta il 21 mag 2024

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)Rust (733 fork)batch import
good first issuemaintenance

Metriche repository

Star
 (20.887 star)
Metriche merge PR
 (Merge medio 4g 3h) (37 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Inizia esaminando l'implementazione esistente delle azioni chiave in meilisearch types/src/keys.rs. Comprendi l'attuale approccio dei 'numeri singoli' e come sono definite le azioni. Leggi la documentazione della crate bitflags per imparare come definire flag combinabili. Quindi, rifattorizza l'enum Action per utilizzare la macro bitflags, assicurandoti che tutti i valori di azione esistenti siano preservati. Aggiorna qualsiasi codice che confronta o utilizza questi valori di azione per funzionare con operazioni bitwise. Controlla i test che necessitano di aggiornamenti. Discuti eventuali cambiamenti di rottura nei commenti dell'issue.
Tech stack
rust
Dominio
backendauthenticationauthorization
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rust programmingbitflags crateMeilisearch codebase overview
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65