meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4.645 geöffnet am 21. Mai 2024

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (733 Forks)batch import
good first issuemaintenance

Repository-Metriken

Stars
 (20.887 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 3h) (37 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Beginnen Sie mit der Überprüfung der bestehenden Schlüsselaktionen Implementierung in meilisearch types/src/keys.rs. Verstehen Sie den aktuellen Ansatz der 'einzelnen Zahlen' und wie Aktionen definiert sind. Lesen Sie die Dokumentation der bitflags Crate, um zu lernen, wie kombinierbare Flags definiert werden. Refaktorieren Sie dann die Action Enum, um das bitflags Makro zu verwenden, und stellen Sie sicher, dass alle vorhandenen Aktionswerte erhalten bleiben. Aktualisieren Sie jeglichen Code, der diese Aktionswerte vergleicht oder verwendet, damit er mit bitweisen Operationen funktioniert. Überprüfen Sie Tests, die Aktualisierungen benötigen. Besprechen Sie etwaige Breaking Changes in den Issue Kommentaren.
Tech Stack
rust
Domain
backendauthenticationauthorization
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust programmingbitflags crateMeilisearch codebase overview
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65