Skip to content

Advanced Search: Use namespace_ancestry for issues

Dmitry Gruzd requested to merge 335825-use-namespace_ancestry-for-searches into master

What does this MR do?

This change is behind the elasticsearch_use_group_level_optimization feature flag

This is the second step of #335825 (closed)

  1. Advanced Search: Add namespace_ancestry_ids to issues index
  2. (this MR) Using the namespace_ancestry_ids field to improve group issues searches

This MR improves the group issues search by utilizing prefix search against the namespace_ancestry_ids field added in !70042 (merged). Instead of passing a list of projects in order to complete a group-level search, we'll use a wildcard (prefix) search. Here's the original technical proposal: #335825 (comment 625116161). The only change since then is that now we have a trailing separator (1-3-4 becomes 1-3-4-)

Screenshots or Screencasts (strongly suggested)

Screenshot_2021-09-27_at_17.05.44

How to setup and validate locally (strongly suggested)

Example below:

  1. Get your gdk setup to work with Elasticsearch and create your index from scratch
  2. Please ensure that the :redo_backfill_namespace_ancestry_ids_for_issues migration is completed before continuing
[1] pry(main)> Elastic::DataMigrationService.migration_has_finished?(:redo_backfill_namespace_ancestry_ids_for_issues)
=> true
  1. Enable the Performance Bar

  2. Visit /search and search for issues inside a group (not in a project), ensure that Advanced Search is working and you have results for the query

  3. Enable the feature flag

    Feature.enable(:elasticsearch_use_group_level_optimization)
  4. Wait a minute for the feature flag cache to update and refresh the search page

  5. Ensure that there are still the same results

  6. Confirm that in the performance bar behind ES calls you can see "prefix": { "namespace_ancestry_ids" as a part of the query

    Click to see an example query
     {
       "query":{
         "bool":{
           "must":[
             {
               "simple_query_string":{
                 "_name":"issue:match:search_terms",
                 "fields":[
                   "iid^3",
                   "title^2",
                   "description"
                 ],
                 "query":"update",
                 "lenient":true,
                 "default_operator":"and"
               }
             }
           ],
           "filter":[
             {
               "term":{
                 "type":{
                   "_name":"doc:is_a:issue",
                   "value":"issue"
                 }
               }
             },
             {
               "bool":{
                 "should":[
                   {
                     "prefix":{
                       "namespace_ancestry_ids":{
                         "_name":"issue:authorized:namespace:ancestry_filter:descendants",
                         "value":"22-"
                       }
                     }
                   }
                 ]
               }
             }
           ]
         }
       },
       "highlight":{
         "fields":{
           "iid":{
     
           },
           "title":{
     
           },
           "description":{
     
           }
         },
         "number_of_fragments":0,
         "pre_tags":[
           "gitlabelasticsearch→"
         ],
         "post_tags":[
           "←gitlabelasticsearch"
         ]
       }
     }
    

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • [-] 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

Related to #335825 (closed)

Edited by John Mason

Merge request reports