Fix missing throw on no FTS on not search#660
Merged
Conversation
Contributor
WalkthroughThe validation logic in IndexedQueries.php now checks for fulltext index requirements when filters are of type TYPE_SEARCH or TYPE_NOT_SEARCH. Previously, only TYPE_SEARCH triggered this validation. No public API signatures were changed. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Validator
participant IndexCatalog as FulltextIndexCatalog
Client->>Validator: validate(filter)
alt filter.type in {TYPE_SEARCH, TYPE_NOT_SEARCH}
Validator->>IndexCatalog: hasFulltextIndex(filter.attribute)
alt index exists
Validator-->>Client: ok
else
Validator-->>Client: error (missing fulltext index)
end
else
Validator-->>Client: ok (no fulltext check)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/Database/Validator/IndexedQueries.php (1)
94-97: Simplify condition with in_array for readabilityMinor cleanup to avoid repeating getMethod():
- if ( - $filter->getMethod() === Query::TYPE_SEARCH || - $filter->getMethod() === Query::TYPE_NOT_SEARCH - ) { + if (\in_array($filter->getMethod(), [Query::TYPE_SEARCH, Query::TYPE_NOT_SEARCH], true)) {
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/Database/Validator/IndexedQueries.php(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/Database/Validator/IndexedQueries.php (1)
src/Database/Query.php (2)
getMethod(122-125)Query(8-836)
🔇 Additional comments (1)
src/Database/Validator/IndexedQueries.php (1)
94-97: Correctly enforce FTS for NOT_SEARCH as wellRequiring a fulltext index for both search and notSearch is logically correct and prevents unindexed scans.
Comment on lines
+94
to
+97
| if ( | ||
| $filter->getMethod() === Query::TYPE_SEARCH || | ||
| $filter->getMethod() === Query::TYPE_NOT_SEARCH | ||
| ) { |
Contributor
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Add/verify tests for NOT_SEARCH requiring FTS
Please ensure we have coverage that fails validation when using notSearch without a fulltext index and passes when the index exists.
Run this to check for existing tests; I can help add them if missing:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Look for notSearch usage in tests and any assertion on the FTS requirement
rg -n -S "TYPE_NOT_SEARCH|notSearch"
rg -n -S "requires a fulltext index"Length of output: 4482
Add tests for notSearch requiring fulltext index
We need to cover the new Query::TYPE_NOT_SEARCH path in the fulltext‐index validator to ensure it fails when no FTS index exists and passes when one does.
Please add test cases in:
- tests/unit/Validator/IndexedQueriesTest.php
- A test that
$validator->isValid(Query::notSearch('name', 'foo'))returns false and$validator->getDescription()equals
"Searching by attribute \"name\" requires a fulltext index."when no fulltext index is defined. - A test that the same query returns true when the mock index list includes a fulltext index on “name.”
- A test that
(Optional) Extend your end-to-end suite as well:
- tests/e2e/Adapter/Scopes/GeneralTests.php – cover notSearch against a table without and with an FTS index.
Sample snippet for IndexedQueriesTest.php:
public function testNotSearchRequiresFulltextIndex(): void
{
$validator = new IndexedQueries(['description'], []); // no fulltext index on 'name'
$filter = Query::notSearch('name', 'foo');
$this->assertFalse($validator->isValid($filter));
$this->assertEquals(
'Searching by attribute "name" requires a fulltext index.',
$validator->getDescription()
);
// Now allow fulltext on 'name'
$validatorWithFTS = new IndexedQueries(['description'], ['name']);
$this->assertTrue($validatorWithFTS->isValid($filter));
}🤖 Prompt for AI Agents
In src/Database/Validator/IndexedQueries.php around lines 94-97 the branch
handling Query::TYPE_NOT_SEARCH was added but lacks unit coverage; add tests in
tests/unit/Validator/IndexedQueriesTest.php that create an IndexedQueries
instance without a fulltext index for 'name', assert
$validator->isValid(Query::notSearch('name','foo')) returns false and
$validator->getDescription() equals "Searching by attribute \"name\" requires a
fulltext index.", then create a second IndexedQueries instance that includes
'name' in the FTS list and assert isValid returns true; optionally add
corresponding e2e cases in tests/e2e/Adapter/Scopes/GeneralTests.php to exercise
notSearch against a table without and with an FTS index.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary by CodeRabbit