rhodecode-enterprise-ce Pull Request !2276

Closed

Pull request !2276 Created on by

Issue #5548 - Add initial search API method

Needs more input validation & tests, but works great for integration with internal bug tracker.

Commit flow:

branch:default of u/pc/rhodecode-enterprise-ce-fork-pc → branch:default of rhodecode-enterprise-ce

Versions:

Pull request versions not available.

Collapse 3 commits

ver	Time	Author	Commit	Description
`latest`	Tue, 26 Mar 2019 14:58:58	pc	`r3508:469847094947`	Issue #5548 - Pass repo_group_name
`latest`	Tue, 26 Mar 2019 14:52:34	pc	`r3507:0208bd4c9de8`	Issue #5548 - Add repo_group_name and docs to search API
`v1`	Thu, 21 Mar 2019 11:52:57	pc	`r3506:733c92d7db87`	Issue #5548 - Add initial search API method
3 commits hidden, click expand to show them.

Collapse all files

rhodecode/api/views/search_api.py

0 +2 -2

                     try:
                         search_result = searcher.search(
-                            search_query, search_type, apiuser, repo_name,
+                            search_query, search_type, apiuser, repo_name, repo_group_name,
-                            requested_page, page_limit, search_sort)
+                            requested_page=requested_page, page_limit=page_limit, sort=search_sort)
                         data.update(dict(
                             results=list(search_result['results']), page=requested_page,
                         note
                    

              
          
          
              
  

  
    
  
  

  

    
        marcink
    
  

          

          
              Thu, 21 Mar 2019 14:11:38
          


          

              
                
              

          

                    
                        outdated v1
                        |
                    

            
              
              

                
                    Comment #21761
                    
                

                    
                    
                      Edit
                    
                    
                      Delete
                    
              
            

            |
                  
                 

          
      
      
          New 4.16 API allow repo_name, or repo_group_name scope filtering imho worth to add this.
Please see the search() implementation: https://code.rhodecode.com/rhodecode-enterprise-ce/files/c75dd264c5f748c55e73391632ccd00a07f03f99/rhodecode/lib/index/whoosh.py#L102
                         note
                    

              
          
          
              
  

  
    
  
  

  

    
        marcink
    
  

          

          
              Thu, 21 Mar 2019 14:13:15
          


          

              
                
              

          

                    
                        outdated v1
                        |
                    

            
              
              

                
                    Comment #21762
                    
                

                    
                    
                      Edit
                    
                    
                      Delete
                    
              
            

            |
                  
                 

          
      
      
          for usage would be great to list the 3 types available, otherwise people need to guess.
'content', 'path', 'commit'

Collapse all files

rhodecode/api/views/search_api.py

0 +12 -4

             @jsonrpc_method()
-            def search(request, apiuser, search_query, search_type, page_limit=Optional(10), page=Optional(1), search_sort=Optional('newfirst'), repo_name=Optional(None)):
+            def search(request, apiuser, search_query, search_type, page_limit=Optional(10), page=Optional(1), search_sort=Optional('newfirst'), repo_name=Optional(None), repo_group_name=Optional(None)):
                
                    
                
                
            


        

    

      

  

      
          

              

                    
                        
                        note
                    

              
          
          
              
  

  
    
  
  

  

    
        marcink
    
  

          

          
              Thu, 21 Mar 2019 14:11:38
          


          

              
                
              

          

                    
                        outdated v1
                        |
                    

            
              
              

                
                    Comment #21761
                    
                

                    
                    
                      Edit
                    
                    
                      Delete
                    
              
            

            |
                  
                 

          
      
      
          New 4.16 API allow repo_name, or repo_group_name scope filtering imho worth to add this.
Please see the search() implementation: https://code.rhodecode.com/rhodecode-enterprise-ce/files/c75dd264c5f748c55e73391632ccd00a07f03f99/rhodecode/lib/index/whoosh.py#L102
                 """
                 Search
                 :type apiuser: AuthUser
                 :param search_query: Search query.
                 :type search_query: str
-                :param search_type: Search type. either commit or content.
+                :param search_type: Search type. The following are valid options:
                
                    
                
                
            


        

    

      

  

      
          

              

                    
                        
                        note
                    

              
          
          
              
  

  
    
  
  

  

    
        marcink
    
  

          

          
              Thu, 21 Mar 2019 14:13:15
          


          

              
                
              

          

                    
                        outdated v1
                        |
                    

            
              
              

                
                    Comment #21762
                    
                

                    
                    
                      Edit
                    
                    
                      Delete
                    
              
            

            |
                  
                 

          
      
      
          for usage would be great to list the 3 types available, otherwise people need to guess.
'content', 'path', 'commit'
+                    * commit
+                    * content
+                    * path
                 :type search_type: str
-                :param page_limit: Page item limit. Default 10 items.
+                :param page_limit: Page item limit, from 1 to 500. Default 10 items.
                 :type page_limit: Optional(int)
                 :param page: Page number. Default first page.
                 :type page: Optional(int)
-                :param search_sort: Search sort. Default newfirst.
+                :param search_sort: Search sort order. Default newfirst. The following are valid options:
+                    * newfirst
+                    * oldfirst
                 :type search_sort: Optional(str)
                 :param repo_name: Filter by one repo. Default is all.
                 :type repo_name: Optional(str)
+                :param repo_group_name: Filter by one repo group. Default is all.
+                :type repo_group_name: Optional(str)
                 """
                 searcher = searcher_from_config(request.registry.settings)
                 data = {'execution_time': ''}
                 repo_name = Optional.extract(repo_name)
+                repo_group_name = Optional.extract(repo_group_name)
                 schema = search_schema.SearchParamsSchema()

Collapse all files

rhodecode/api/views/search_api.py

0 created 644 +101 0

@@ -0,0 +1,101 b''
	1	# -- coding: utf-8 --
	2
	3	# Copyright (C) 2011-2018 RhodeCode GmbH
	4	#
	5	# This program is free software: you can redistribute it and/or modify
	6	# it under the terms of the GNU Affero General Public License, version 3
	7	# (only), as published by the Free Software Foundation.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU Affero General Public License
	15	# along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	#
	17	# This program is dual-licensed. If you wish to learn more about the
	18	# RhodeCode Enterprise Edition, including its added features, Support services,
	19	# and proprietary license terms, please see https://rhodecode.com/licenses/
	20
	21
	22	import logging
	23
	24	from rhodecode.api import jsonrpc_method
	25	from rhodecode.api.exc import JSONRPCValidationError
	26	from rhodecode.api.utils import Optional
	27	from rhodecode.lib.index import searcher_from_config
	28	from rhodecode.model import validation_schema
	29	from rhodecode.model.validation_schema.schemas import search_schema
	30
	31	log = logging.getLogger(__name__)
	32
	33
	34	@jsonrpc_method()
	35	def search(request, apiuser, search_query, search_type, page_limit=Optional(10), page=Optional(1), search_sort=Optional('newfirst'), repo_name=Optional(None)):
	36	"""
	37	Search
	38
	39	:param apiuser: This is filled automatically from the \|authtoken\|.
	40	:type apiuser: AuthUser
	41	:param search_query: Search query.
	42	:type search_query: str
	43	:param search_type: Search type. either commit or content.
	44	:type search_type: str
	45	:param page_limit: Page item limit. Default 10 items.
	46	:type page_limit: Optional(int)
	47	:param page: Page number. Default first page.
	48	:type page: Optional(int)
	49	:param search_sort: Search sort. Default newfirst.
	50	:type search_sort: Optional(str)
	51	:param repo_name: Filter by one repo. Default is all.
	52	:type repo_name: Optional(str)
	53	"""
	54
	55	searcher = searcher_from_config(request.registry.settings)
	56	data = {'execution_time': ''}
	57	repo_name = Optional.extract(repo_name)
	58
	59	schema = search_schema.SearchParamsSchema()
	60
	61	search_params = {}
	62	try:
	63	search_params = schema.deserialize(
	64	dict(search_query=search_query,
	65	search_type=search_type,
	66	search_sort=Optional.extract(search_sort),
	67	page_limit=Optional.extract(page_limit),
	68	requested_page=Optional.extract(page))
	69	)
	70	except validation_schema.Invalid as err:
	71	raise JSONRPCValidationError(colander_exc=err)
	72
	73	search_query = search_params.get('search_query')
	74	search_type = search_params.get('search_type')
	75	search_sort = search_params.get('search_sort')
	76
	77	if search_params.get('search_query'):
	78	page_limit = search_params['page_limit']
	79	requested_page = search_params['requested_page']
	80
	81	try:
	82	search_result = searcher.search(
	83	search_query, search_type, apiuser, repo_name,
	84	requested_page, page_limit, search_sort)
	85
	86	data.update(dict(
	87	results=list(search_result['results']), page=requested_page,
	88	item_count=search_result['count'],
	89	items_per_page=page_limit))
	90	finally:
	91	searcher.cleanup()
	92
	93	if not search_result['error']:
	94	data['execution_time'] = '%s results (%.3f seconds)' % (
	95	search_result['count'],
	96	search_result['runtime'])
	97	else:
	98	node = schema['search_query']
	99	raise JSONRPCValidationError(colander_exc=validation_schema.Invalid(node, search_result['error']))
	100
	101	return data

General Comments 9

v1 |

|

Auto status change to "Under Review"

note

jenkins-tests

v1 |

|

Build Succeeded!

note

marcink

v1 |

|

P.s we don't see a signed CLA for the contribution. If you wish to merge this please check: https://rhodecode.com/sign-cla

cla-bot

v1 |

|

CLA FOUND and APPROVED

|

Pull request updated. Auto status change to "Under Review"

Changed commits:
  * 2 added
  * 0 removed

Changed files:
  * M rhodecode/api/views/search_api.py

note

jenkins-tests

|

Build Succeeded!

cla-bot

|

CLA FOUND and APPROVED

marcink

|

Status change > Approved

marcink

|

Thanks for contribution. We'll merge this manually.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

	This file was removed from diff during updates to this pull-request. There are still outdated/unresolved comments attached to it.
					note marcink Thu, 21 Mar 2019 14:11:38 outdated `v1` `\|` Comment #21761 Edit Delete `\|` New 4.16 API allow repo_name, or repo_group_name scope filtering imho worth to add this. Please see the search() implementation: https://code.rhodecode.com/rhodecode-enterprise-ce/files/c75dd264c5f748c55e73391632ccd00a07f03f99/rhodecode/lib/index/whoosh.py#L102 note marcink Thu, 21 Mar 2019 14:13:15 outdated `v1` `\|` Comment #21762 Edit Delete `\|` for usage would be great to list the 3 types available, otherwise people need to guess. `'content', 'path', 'commit'`