meilisearch/MeiliSearch

Change key actions to be bitflags

Open

#4,645 创建于 2024年5月21日

在 GitHub 查看
 (11 评论) (0 反应) (0 负责人)Rust (20,887 star) (733 fork)batch import
good first issuemaintenance

描述

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.

贡献者指南

技术栈
rust
领域
backendauthenticationauthorization
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Rust programmingbitflags crateMeilisearch codebase overview
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
Start by reviewing the existing key actions implementation in meilisearch types/src/keys.rs. Understand the current 'single numbers' approach and how actions are defined. Read the bitflags crate documentation to learn how to define combinable flags. Then, refactor the Action enum to use the bitflags macro, ensuring all existing action values are preserved. Update any code that compares or uses these action values to work with bitwise operations. Check for tests that need updates. Discuss any breaking changes in the issue comments.