meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4.645 aberto em 21 de mai. de 2024

Ver no GitHub
 (11 comments) (0 reactions) (0 assignees)Rust (733 forks)batch import
good first issuemaintenance

Métricas do repositório

Stars
 (20.887 stars)
Métricas de merge de PR
 (Mesclagem média 4d 3h) (37 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Comece revisando a implementação existente das ações de chave em meilisearch types/src/keys.rs. Entenda a abordagem atual de 'números únicos' e como as ações são definidas. Leia a documentação da crate bitflags para aprender como definir flags combináveis. Em seguida, refatore a enum Action para usar a macro bitflags, garantindo que todos os valores de ação existentes sejam preservados. Atualize qualquer código que compare ou use esses valores de ação para funcionar com operações bitwise. Verifique os testes que precisam de atualizações. Discuta quaisquer alterações que quebrem compatibilidade nos comentários da issue.
Pilha de tecnologia
rust
Domain
backendauthenticationauthorization
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Rust programmingbitflags crateMeilisearch codebase overview
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65