Merge branch '258215-add-fuzzy-search-on-full-path-in-groups' into 'master'

Add fuzzy-search on full path in Groups API

See merge request gitlab-org/gitlab!45729

app/models/namespace.rb

@@ -117,8 +117,12 @@ class Namespace < ApplicationRecord
     # query - The search query as a String.
     #
     # Returns an ActiveRecord::Relation.
-    def search(query)
-      fuzzy_search(query, [:name, :path])
+    def search(query, include_parents: false)
+      if include_parents
+        where(id: Route.fuzzy_search(query, [Route.arel_table[:path], Route.arel_table[:name]]).select(:source_id))
+      else
+        fuzzy_search(query, [:path, :name])
+      end
     end
 
     def clean_path(path)

changelogs/unreleased/258215-add-fuzzy-search-on-full-path-in-groups.yml

+---
+title: Add fuzzy-search on full path in Groups API
+merge_request: 45729
+author:
+type: changed

db/migrate/20201021101956_add_index_route_on_name_trigram_to_route.rb

+# frozen_string_literal: true
+
+class AddIndexRouteOnNameTrigramToRoute < ActiveRecord::Migration[6.0]
+  include Gitlab::Database::MigrationHelpers
+
+  DOWNTIME = false
+  INDEX_NAME = 'index_route_on_name_trigram'
+
+  disable_ddl_transaction!
+
+  def up
+    add_concurrent_index :routes, :name, name: INDEX_NAME, using: :gin, opclass: { name: :gin_trgm_ops }
+  end
+
+  def down
+    remove_concurrent_index_by_name(:routes, INDEX_NAME)
+  end
+end

db/schema_migrations/20201021101956

+47158d21bd1a800e5a9da1bfea25870f14cc0b094e5f3e9a4b7608b8a9eca180
\ No newline at end of file

db/structure.sql

@@ -21616,6 +21616,8 @@ CREATE INDEX index_reviews_on_merge_request_id ON reviews USING btree (merge_req
 
 CREATE INDEX index_reviews_on_project_id ON reviews USING btree (project_id);
 
+CREATE INDEX index_route_on_name_trigram ON routes USING gin (name gin_trgm_ops);
+
 CREATE UNIQUE INDEX index_routes_on_path ON routes USING btree (path);
 
 CREATE INDEX index_routes_on_path_text_pattern_ops ON routes USING btree (path varchar_pattern_ops);

lib/api/groups.rb

@@ -46,7 +46,7 @@ module API
           find_params.fetch(:all_available, current_user&.can_read_all_resources?)
 
         groups = GroupsFinder.new(current_user, find_params).execute
-        groups = groups.search(params[:search]) if params[:search].present?
+        groups = groups.search(params[:search], include_parents: true) if params[:search].present?
         groups = groups.where.not(id: params[:skip_groups]) if params[:skip_groups].present?
         order_options = { params[:order_by] => params[:sort] }
         order_options["id"] ||= "asc"

spec/models/namespace_spec.rb

@@ -147,7 +147,7 @@ RSpec.describe Namespace do
   end
 
   describe '.search' do
-    let(:namespace) { create(:namespace) }
+    let_it_be(:namespace) { create(:namespace) }
 
     it 'returns namespaces with a matching name' do
       expect(described_class.search(namespace.name)).to eq([namespace])
@@ -172,6 +172,18 @@ RSpec.describe Namespace do
     it 'returns namespaces with a matching path regardless of the casing' do
       expect(described_class.search(namespace.path.upcase)).to eq([namespace])
     end
+
+    it 'returns namespaces with a matching route path' do
+      expect(described_class.search(namespace.route.path, include_parents: true)).to eq([namespace])
+    end
+
+    it 'returns namespaces with a partially matching route path' do
+      expect(described_class.search(namespace.route.path[0..2], include_parents: true)).to eq([namespace])
+    end
+
+    it 'returns namespaces with a matching route path regardless of the casing' do
+      expect(described_class.search(namespace.route.path.upcase, include_parents: true)).to eq([namespace])
+    end
   end
 
   describe '.with_statistics' do