Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add number of matches into /api/search/{domain} results #1665

Merged
merged 3 commits into from
Oct 16, 2023

Conversation

DL6ER
Copy link
Member

@DL6ER DL6ER commented Oct 14, 2023

What does this implement/fix?

During review of pi-hole/pi-hole#5361, I noticed that there is no way for the client to know if their search request reached the given limit of results to return or if there are (possibly many) more entries to retrieve given a higher value of N.

The PR adds a new object having total counts not being clipped by the parameter N:
image

Example result for partial match of doubleclick.net:
image

Related issue or feature (if applicable): N/A

Pull request in docs with documentation (if applicable): N/A


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)

Checklist:

  • The code change is tested and works locally.
  • I based my code and PRs against the repositories developmental branch.
  • I signed off all commits. Pi-hole enforces the DCO for all contributions
  • I signed all my commits. Pi-hole requires signatures to verify authorship
  • I have read the above and my PR is ready for review.

@DL6ER DL6ER requested a review from a team October 14, 2023 18:51
Signed-off-by: DL6ER <dl6er@dl6er.de>
Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a helpful PR. I have some remarks.

  1. Can you return the sum of all results in .results?
  2. Do we still need the (old) total? It's anyway clipped at N if more results are found, or would be the same as in 1) if less are found.
  3. The help text for N says: "Maximum number of results to be returned (per type)" - is it really per type?

@yubiuser
Copy link
Member

Do we have a way to signal that the results exceed the hard coded limit of 10.000?

@DL6ER
Copy link
Member Author

DL6ER commented Oct 15, 2023

Can you return the sum of all results in .results?

Yes

Do we still need the (old) total? It's anyway clipped at N if more results are found, or would be the same as in 1) if less are found.

Yes, too.

The help text for N says: "Maximum number of results to be returned (per type)" - is it really per type?

Yes, N=20 means at most 20 domains, 20 allow regex, 20 deny regex, and 20 anti- plus 20 gravity. So it could return up to 100 results in total. It could really easily be made a "20 maximum total". The reason for how it is right now is that 20 matches in gravity could have easily hidden 20 domains on the denylist.

Do we have a way to signal that the results exceed the hard coded limit of 10.000?

Well, not really. The limit only applies to N, not the internal counting. (you can see in my example that > 30,000 domains match doubleclick partially on gravity)

… have been clipped)

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER DL6ER merged commit 4f70235 into development-v6 Oct 16, 2023
18 checks passed
@DL6ER DL6ER deleted the new/search_results branch October 16, 2023 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants