Skip to content

Search: little optimization when saving search queries #8132

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 1, 2021
Merged

Search: little optimization when saving search queries #8132

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
603af97
Search: little optimization when saving search queries
stsewd Apr 22, 2021
b297314
Merge branch 'master' into opt-save-search
stsewd Jun 1, 2021
e9b68f5
Comment
stsewd Jun 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions readthedocs/search/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,33 +169,30 @@ def record_search_query(project_slug, version_slug, query, total_results, time_s

# If a partial query exists,
# then just update that object.
for partial_query in partial_query_qs.iterator():
max_queries = 30
Copy link
Member

Choose a reason for hiding this comment

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

How did you come to this number? What does it mean as a user in the search context? Will it show only 30 results as maximum?

Copy link
Member Author

Choose a reason for hiding this comment

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

It means that we will only search the latest 30 searches that have happened in the last 10 seconds in that project/version. Just a small protection in case we get flooded.

Check max 30 queries, in case there is a flood of queries.

Copy link
Member Author

Choose a reason for hiding this comment

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

and this doesn't have anything to do with the search results a user gets, this code is to save in our db analytics about searches that a project has

for partial_query in partial_query_qs[:max_queries]:
if query.startswith(partial_query.query):
partial_query.query = query
partial_query.total_results = total_results
partial_query.save()
return

project = Project.objects.filter(slug=project_slug).first()
if not project:
log.debug(
'Not recording the search query because project does not exist. '
'project_slug: %s', project_slug
)
return

version = Version.objects.filter(project=project, slug=version_slug).first()

version = (
Version.objects
.filter(slug=version_slug, project__slug=project_slug)
.prefetch_related('project')
.first()
)
if not version:
log.debug(
'Not recording the search query because version does not exist. '
'project_slug: %s, version_slug: %s', project_slug, version_slug
'Not recording the search query because project does not exist. '
'project=%s version=%s',
project_slug, version_slug,
)
return

# Create a new SearchQuery object.
SearchQuery.objects.create(
project=project,
project=version.project,
version=version,
query=query,
total_results=total_results,
Expand Down