aws / aws/event-ruler

Enforce Leading and Trailing double quote in ByteMachine

Open
#23 5 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
615
Forks
82
Avg merge
1d 22h
Merged PRs (30d)
7

Description

## What is your idea?
In actual usage of Ruler, ByteMachine stores string values always with a beginning and ending double quote. However, ByteMachine is capable of storing string values that begin and end with any character. This unnecessary flexibility leads to more complexity and special cases, for example, to support a leading or trailing wildcard character for wildcard patterns. We can simplify the code and remove some special cases by updating ByteMachine to either enforce the leading/trailing double quotes itself, or to be the component that adds these double quotes.

## Would you be willing to make the change?
Maybe.

## Additional context
Discussion arose during: https://github.com/aws/event-ruler/pull/18

Contributor guide

Open the contributing guide

Research direction

Start by reading the ByteMachine implementation and the discussion from pull request 18. Determine whether ByteMachine should enforce or add leading and trailing double quotes, then inspect the surrounding wildcard-handling behavior. Done means the chosen invariant removes the described special cases without breaking string matching.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.