fix(search): implements changes to search to capture user queries #4471
Conversation
This file contains 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
Makes changes to models, views, adds migrations Fixes: #4230
for more information, see https://pre-commit.ci
mlissner
requested changes
Sep 17, 2024
| # Create and save the SearchQuery object | ||
| SearchQuery.objects.create( | ||
| get_params=request.GET.urlencode(), | ||
| query_time_ms=render_dict.get("query_time", 0), |
There was a problem hiding this comment.
I think I'd set this to null if we don't have the value, or if the called function always returns the value, I'd do:
Suggested change
| query_time_ms=render_dict.get("query_time", 0), | |
| query_time_ms=render_dict["query_time"], |
By doing that, you'd enforce the calling function to always deliver on its promise.
| SearchQuery.objects.create( | ||
| get_params=request.GET.urlencode(), | ||
| query_time_ms=render_dict.get("query_time", 0), | ||
| hit_cache=render_dict.get("hit_cache", False), |
There was a problem hiding this comment.
Similarly, defauling to False here seems a bit weird if we know the value will always be in render_dict.
| @@ -514,41 +519,59 @@ def show_results(request: HttpRequest) -> HttpResponse: | |||
| if not is_bot(request): | |||
| async_to_sync(tally_stat)("search.results") | |||
|
|
|||
| # Perform the search | |||
| search_type = request.GET.get("type", SEARCH_TYPES.OPINION) | |||
There was a problem hiding this comment.
Is there a reason you tweaked the case statement into an if/else, and moved it up here?
Comment on lines
+52
to
+60
| class SearchQuery(models.Model): | ||
| date_created = models.DateTimeField(auto_now_add=True, db_index=True) | ||
| date_modified = models.DateTimeField(auto_now=True, db_index=True) | ||
| get_params = models.CharField(max_length=255) | ||
| query_time_ms = models.IntegerField() | ||
| hit_cache = models.BooleanField() | ||
|
|
||
| def str(self): | ||
| return f"Query: {self.get_params} at {self.date_created}" |
There was a problem hiding this comment.
Getting models exactly right is important because DB migrations are annoying, so I have a few comments here:
- We can use
AbstractDateTimeModelto automatically add the date-created and date_modified fields. - We'll want full descriptions of each field, as in other models.
- In postgresql, you don't get a performance boost by doing max_length, and I can promise you that some queries will be really long. I'd remove that so that long queries don't crash things.
- We'll want to link these queries to users, so we'll need a FK to them (there are lots of examples).
- The documentation isn't (yet) clear about this, annoyingly, but
db_indexis considered the old way of adding an index. These days, they should go into theMetaclass.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Makes changes to models, views, adds migrations
Fixes: #4230