Fix TAG field search with special characters in doctest #3101
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The doctest in
doctests/query-em.js
(test caseem3
) was incorrectly demonstrating how to search for email addresses in TAG fields. The test was wrapped in a try-catch block that printed "'[email protected]' syntax not yet supported", giving the false impression that searching TAG fields with special characters is unsupported functionality.Root Cause
The original code attempted to search using:
This fails because:
@
and.
must be escaped when searching TAG field values@fieldname:{value}
According to Redis documentation, punctuation characters in TAG fields require proper escaping.
Solution
Updated the test to use the correct pattern already demonstrated in
examples/search-json.js
:Changes
This converts a failing test that was hiding behind error handling into properly working documentation that demonstrates the correct usage pattern.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.