Search UI add issue scope results filtering by state

What does this MR do?

Issue #237932 (closed)

Allow users doing Basic (PostgreSQL backed) or Advanced (Elasticsearch backed) search to filter issue scope results by the state field (all, opened, closed). The filtering changes are applied at the Global, Group, and Project search levels.

Updated and added new tests.

To test this manually you will need to have Elasticsearch setup and Advanced Search enabled for at least 1 project.

Videos

Video showing Basic Search

global-basic-search

group-basic-search

project-basic-search

Video showing Advanced Search

global-advanced-search

group-advanced-search

project-advanced-search

Does this MR meet the acceptance criteria?

Conformity

• Changelog entry
• Documentation (if required)
• Code review guidelines
• Merge request performance guidelines
• Style guides
• Database guides
• Separation of EE specific content

Availability and Testing

• Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process.
• Tested in all supported browsers
• [-] Informed Infrastructure department of a default or new setting change, if applicable per definition of done

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

• [-] Label as security and @ mention @gitlab-com/gl-security/appsec
• [-] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
• [-] Security reports checked/validated by a reviewer from the AppSec team

app/assets/javascripts/search/state_filter/components/state_filter.vue

@@ -3,6 +3,8 @@ import { GlDropdown, GlDropdownItem, GlDropdownDivider } from '@gitlab/ui';
 import { FILTER_STATES, FILTER_HEADER, FILTER_TEXT } from '../constants';
 import { setUrlParams, visitUrl } from '~/lib/utils/url_utility';
 
+const FILTERS_ARRAY = Object.values(FILTER_STATES);
+
 export default {
   name: 'StateFilter',
   components: {
@@ -19,16 +21,9 @@ export default {
       type: String,
       required: false,
       default: FILTER_STATES.ANY.value,
-      validator: v => Object.values(FILTER_STATES).some(({ value }) => value === v),
+      validator: v => FILTERS_ARRAY.some(({ value }) => value === v),
     },
   },
-  data() {
-    return {
-      filterStates: FILTER_STATES,
-      filterText: FILTER_TEXT,
-      filterHeader: FILTER_HEADER,
-    };
-  },
   computed: {
     selectedFilterText() {
       let filterText = FILTER_TEXT;
@@ -41,7 +36,11 @@ export default {
     },
     selectedFilter: {
       get() {
-        return this.state;
+        if (FILTERS_ARRAY.some(({ value }) => value === this.state)) {
+          return this.state;
+        }
+
+        return FILTER_STATES.ANY.value;
       },
       set(state) {
         visitUrl(setUrlParams({ state }));
@@ -49,6 +48,12 @@ export default {
     },
   },
   methods: {
+    dropDownItemClass(filter) {
+      return {
+        'gl-border-b-solid gl-border-b-gray-100 gl-border-b-1 gl-pb-2! gl-mb-2':
+          filter === FILTER_STATES.ANY,
+      };
+    },
     isFilterSelected(filter) {
       return filter === this.selectedFilter;
     },
@@ -56,6 +61,9 @@ export default {
       this.selectedFilter = state;
     },
   },
+  filterStates: FILTER_STATES,
+  filterHeader: FILTER_HEADER,
+  filtersArray: FILTERS_ARRAY,
 };
 </script>
 
@@ -66,36 +74,18 @@ export default {
     class="col-sm-3 gl-pt-4 gl-pl-0"
   >
     <header class="gl-text-center gl-font-weight-bold gl-font-lg">
-      {{ filterHeader }}
+      {{ $options.filterHeader }}
     </header>
     <gl-dropdown-divider />
     <gl-dropdown-item
-      :key="filterStates.ANY.value"
-      :active="isFilterSelected(filterStates.ANY.value)"
-      :is-check-item="true"
-      :is-checked="isFilterSelected(filterStates.ANY.value)"
-      @click="handleFilterChange(filterStates.ANY.value)"
-    >
-      {{ filterStates.ANY.label }}
-    </gl-dropdown-item>
-    <gl-dropdown-divider />
-    <gl-dropdown-item
-      :key="filterStates.OPEN.value"
-      :active="isFilterSelected(filterStates.OPEN.value)"
-      :is-check-item="true"
-      :is-checked="isFilterSelected(filterStates.OPEN.value)"
-      @click="handleFilterChange(filterStates.OPEN.value)"
-    >
-      {{ filterStates.OPEN.label }}
-    </gl-dropdown-item>
-    <gl-dropdown-item
-      :key="filterStates.CLOSED.value"
-      :active="isFilterSelected(filterStates.CLOSED.value)"
+      v-for="filter in $options.filtersArray"
+      :key="filter.value"
       :is-check-item="true"
-      :is-checked="isFilterSelected(filterStates.CLOSED.value)"
-      @click="handleFilterChange(filterStates.CLOSED.value)"
+      :is-checked="isFilterSelected(filter.value)"
+      :class="dropDownItemClass(filter)"
+      @click="handleFilterChange(filter.value)"
     >
-      {{ filterStates.CLOSED.label }}
+      {{ filter.label }}
     </gl-dropdown-item>
   </gl-dropdown>
 </template>