meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4 645 ouverte le 21 mai 2024

Voir sur GitHub
 (11 commentaires) (0 réactions) (0 assignés)Rust (733 forks)batch import
good first issuemaintenance

Métriques du dépôt

Stars
 (20 887 stars)
Métriques de merge PR
 (Merge moyen 4j 3h) (37 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Commencez par examiner l'implémentation existante des actions de clé dans meilisearch types/src/keys.rs. Comprenez l'approche actuelle des 'nombres uniques' et comment les actions sont définies. Lisez la documentation de la crate bitflags pour apprendre à définir des drapeaux combinables. Ensuite, refactorisez l'énumération Action pour utiliser la macro bitflags, en veillant à ce que toutes les valeurs d'action existantes soient préservées. Mettez à jour tout code qui compare ou utilise ces valeurs d'action pour fonctionner avec des opérations bit à bit. Vérifiez les tests nécessitant des mises à jour. Discutez de tout changement cassant dans les commentaires de l'issue.
Stack technique
rust
Domaine
backendauthenticationauthorization
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust programmingbitflags crateMeilisearch codebase overview
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65