remove relevance in sort order when no query string is present (comse…

…s#770) if `query` is empty, `Relevance` ordering option in UI should not be visible for /codebases/ - simplify order by relevance logic, instead of passing strings around and interpreting them downstream, set order_by_relevance directly in the search_backend ES call - re-enable "Apply Filters" for Event and Jobs - remove the option to create non-existent tags in the tag filter on the sidebars: Codebase, Event, Jobs, Profile Co-authored-by: Anton Suharev <[email protected]>
sgfost · Oct 25, 2024 · ff5c42d · ff5c42d
1 parent 108230c
commit ff5c42d
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 31 deletions.
diff --git a/django/core/jinja_config.py b/django/core/jinja_config.py
@@ -131,10 +131,7 @@ def generate_search_form_inputs(query_params):
     Returns:
         list: A list of tuples representing the hidden input fields.
     """
-    # set default ordering to relevance, if it is not specified
-    search_parameters = {
-        "ordering": "relevance",
-    }
+    search_parameters = {}
     if query_params:
         # parse_qsl handles splitting and unquoting key-value pairs and generates a list of tuples
         # do not include the actual query in the query parameters

diff --git a/django/core/view_helpers.py b/django/core/view_helpers.py
@@ -87,7 +87,13 @@ def build_search_query(input_text: str) -> SearchQuery:
 
 
 def get_search_queryset(
-    query, queryset, operator="or", fields=None, tags=None, criteria=None
+    query,
+    queryset,
+    operator="or",
+    fields=None,
+    tags=None,
+    criteria=None,
+    order_by_relevance=False,
 ):
     search_backend = get_search_backend()
 
@@ -132,11 +138,6 @@ def get_search_queryset(
     Set up order by relevance override for search
     other sort orders are handled by SmallResultSetPagination filtering and SORT_BY_FILTERS
     """
-    order_by_relevance = False
-    if "ordering" in criteria:
-        sort_order = criteria.pop("ordering")
-        if sort_order == "relevance":
-            order_by_relevance = True
     """
     Filter queryset
     """

diff --git a/django/library/views.py b/django/library/views.py
@@ -399,14 +399,16 @@ def filter_queryset(self, request, queryset, view):
             criteria.update(id__in=codebases.values_list("id", flat=True))
             # or we could include the PL in the query
             # qs += " ".join(programming_languages)
-        if ordering:
-            criteria.update(ordering=ordering)
-        else:
-            if qs:
-                # set default ordering for search when ordering is not specified
-                criteria.update(ordering="relevance")
 
-        return get_search_queryset(qs, queryset, tags=tags, criteria=criteria)
+        # set order by relevance if there's a query string and no explicit ordering requested
+        order_by_relevance = qs and (not ordering or ordering == "relevance")
+        return get_search_queryset(
+            qs,
+            queryset,
+            tags=tags,
+            criteria=criteria,
+            order_by_relevance=order_by_relevance,
+        )
 
 
 class CodebaseViewSet(SpamCatcherViewSetMixin, CommonViewSetMixin, HtmlNoDeleteViewSet):

diff --git a/frontend/src/apps/codebase_list.ts b/frontend/src/apps/codebase_list.ts
@@ -1,5 +1,6 @@
 import "vite/modulepreload-polyfill"; // Ensure that this is needed based on your project setup
 
+import { isEmpty } from "lodash";
 import { createApp } from "vue";
 import CodebaseListSidebar from "@/components/CodebaseListSidebar.vue";
 import SortBy from "@/components/ListSortBy.vue";
@@ -8,11 +9,20 @@ import { extractDataParams } from "@/util";
 const props = extractDataParams("sidebar", ["languageFacets"]);
 createApp(CodebaseListSidebar, props).mount("#sidebar");
 
-createApp(SortBy, {
-  sortOptions: [
-    { value: "relevance", label: "Relevance" },
-    { value: "-first_published_at", label: "Publish date: newest" },
-    { value: "first_published_at", label: "Publish date: oldest" },
-    { value: "-last_modified", label: "Recently Modified" },
-  ],
-}).mount("#sortby");
+// Function to check if 'query' exists and is not empty
+function hasQueryParam(param: string) {
+  const params = new URLSearchParams(window.location.search);
+  const value = params.get(param);
+  return !isEmpty(value);
+}
+
+const relevanceOption = hasQueryParam("query") ? [{ value: "relevance", label: "Relevance" }] : [];
+
+const sortOptions = [
+  ...relevanceOption,
+  { value: "-first_published_at", label: "Most recently published" },
+  { value: "first_published_at", label: "Earliest published" },
+  { value: "-last_modified", label: "Recently modified" },
+];
+
+createApp(SortBy, { sortOptions }).mount("#sortby");
diff --git a/frontend/src/components/CodebaseListSidebar.vue b/frontend/src/components/CodebaseListSidebar.vue
@@ -57,6 +57,7 @@
           label="Tags"
           type="Codebase"
           placeholder="Language, framework, etc."
+          :taggable="false"
         />
       </form>
     </template>
@@ -120,7 +121,7 @@ const initialFilterValues = {
 onMounted(() => {
   if (props.languageFacets) {
     const localLanguageFacets = { ...props.languageFacets };
-    console.log(localLanguageFacets);
+    // console.log(localLanguageFacets);
     parsedLanguageFacets = Object.entries(localLanguageFacets)
       .sort(([, valueA], [, valueB]) => valueB - valueA) // Sort by value in descending order
       .map(([name, value]) => ({ value: name, label: `${name} (${value})` }));

diff --git a/frontend/src/components/EventListSidebar.vue b/frontend/src/components/EventListSidebar.vue
@@ -7,7 +7,7 @@
   >
     <template #form>
       <form @submit="handleSubmit">
-        <TaggerField class="mb-3" name="tags" label="Keywords" type="Event" />
+        <TaggerField class="mb-3" name="tags" label="Keywords" type="Event" :taggable="false" />
         <DatepickerField
           class="mb-3"
           name="submissionDeadlineAfter"

diff --git a/frontend/src/components/JobListSidebar.vue b/frontend/src/components/JobListSidebar.vue
@@ -8,7 +8,7 @@
   >
     <template #form>
       <form @submit="handleSubmit">
-        <TaggerField class="mb-3" name="tags" label="Keywords" type="Job" />
+        <TaggerField class="mb-3" name="tags" label="Keywords" type="Job" :taggable="false" />
         <DatepickerField class="mb-3" name="initialPostingAfter" label="Posted after" />
         <DatepickerField name="applicationDeadlineAfter" label="Application deadline after" />
       </form>

diff --git a/frontend/src/components/ListSidebar.vue b/frontend/src/components/ListSidebar.vue
@@ -56,7 +56,9 @@ export interface SearchProps {
   clearAllFilters?: () => void;
 }
 
-const props = defineProps<SearchProps>();
+const props = withDefaults(defineProps<SearchProps>(), {
+  isFilterChanged: true,
+});
 
 function handleApplyFilters() {
   isApplyingFiltersLoading.value = true;

diff --git a/frontend/src/components/ProfileListSidebar.vue b/frontend/src/components/ProfileListSidebar.vue
@@ -8,7 +8,7 @@
   >
     <template #form>
       <form @submit="handleSubmit">
-        <TaggerField name="tags" label="Keywords" type="Profile" />
+        <TaggerField name="tags" label="Keywords" type="Profile" :taggable="false" />
         <!-- consider adding full member/peer reviewer filter -->
       </form>
     </template>

diff --git a/frontend/src/components/form/TaggerField.vue b/frontend/src/components/form/TaggerField.vue
@@ -20,7 +20,7 @@
       :clear-on-select="false"
       :close-on-select="false"
       :options-limit="50"
-      :taggable="true"
+      :taggable="taggable"
       :limit="20"
       @tag="addTag"
       @search-change="fetchMatchingTags"
@@ -66,11 +66,13 @@ export interface TaggerFieldProps {
   help?: string;
   placeholder?: string;
   required?: boolean;
+  taggable?: boolean;
   type?: TagType;
 }
 
 const props = withDefaults(defineProps<TaggerFieldProps>(), {
   type: "",
+  taggable: true,
   placeholder: "Type to add tags",
 });