kallithea Changeset - d5ab6db3b9e2

Changeset - d5ab6db3b9e2

Parent rev.

Child rev.

[Not reviewed]

default

0 2 0

Mads Kiilerich - 7 years ago 2018-12-23 21:16:07
mads@kiilerich.com

search: better messaging when the index hasn't been built yet

Improve the situation around the "Please run whoosh indexer" message.

1. It is not a situation that justifies logging a stack trace.
2. Don't just say "whoosh indexer" - it actually has a name: kallithea-cli index-create .
3. Don't report server side commands in the user interface.

2 files changed with 3 insertions and 6 deletions:

kallithea/controllers/search.py

kallithea/tests/functional/test_search.py

0 comments (0 inline, 0 general)

kallithea/controllers/search.py

➞

Show inline comments

@@ @@ -91,58 +91,56 @@ class SearchController(BaseRepoControlle @@
                 idx = open_dir(index_dir, indexname=index_name)
                 searcher = idx.searcher()
                 qp = QueryParser(search_type, schema=schema_defn)
                 if c.repo_name:
                     # use "repository_rawname:" instead of "repository:"
                     # for case-sensitive matching
                     cur_query = u'repository_rawname:%s %s' % (c.repo_name, cur_query)
                 try:
                     query = qp.parse(unicode(cur_query))
                     # extract words for highlight
                     if isinstance(query, Phrase):
                         highlight_items.update(query.words)
                     elif isinstance(query, Prefix):
                         highlight_items.add(query.text)
                     else:
                         for i in query.all_terms():
                             if i[0] in ['content', 'message']:
                                 highlight_items.add(i[1])
                     matcher = query.matcher(searcher)
                     log.debug('query: %s', query)
                     log.debug('hl terms: %s', highlight_items)
                     results = searcher.search(query)
                     res_ln = len(results)
                     c.runtime = '%s results (%.3f seconds)' % (
                         res_ln, results.runtime
+                    )
                     def url_generator(**kw):
                         q = urllib.quote(safe_str(c.cur_query))
                         return update_params("?q=%s&type=%s" \
                         % (q, safe_str(c.cur_type)), **kw)
                     repo_location = RepoModel().repos_path
                     c.formated_results = Page(
                         WhooshResultWrapper(search_type, searcher, matcher,
                                             highlight_items, repo_location),
                         page=p,
                         item_count=res_ln,
                         items_per_page=10,
                         url=url_generator
+                    )
                 except QueryParserError:
                     c.runtime = _('Invalid search query. Try quoting it.')
                 searcher.close()
             except EmptyIndexError:
                 log.error(traceback.format_exc())
                 log.error('Empty Index data')
                 c.runtime = _('There is no index to search in. '
                               'Please run whoosh indexer')
                 log.error("Empty search index - run 'kallithea-cli index-create' regularly")
                 c.runtime = _('The server has no search index.')
             except Exception:
                 log.error(traceback.format_exc())
                 c.runtime = _('An error occurred during search operation.')
         # Return a rendered template
         return render('/search/search.html')

kallithea/tests/functional/test_search.py

➞

Show inline comments

 import mock
 import os
 from kallithea.tests.base import *
 class TestSearchController(TestController):
     def test_index(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'))
         response.mustcontain('class="form-control" id="q" name="q" type="text"')
         # Test response...
     def test_empty_search(self, tmpdir):
         self.log_user()
         config_mock = {
             'app_conf': {
                 # can be any existing dir that does not contain an actual index
                 'index_dir': str(tmpdir),
+            }
+        }
         with mock.patch('kallithea.controllers.search.config', config_mock):
             response = self.app.get(url(controller='search', action='index'),
                                     {'q': HG_REPO})
             response.mustcontain('There is no index to search in. '
                                  'Please run whoosh indexer')
             response.mustcontain('The server has no search index.')
     def test_normal_search(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'),
                                 {'q': 'def repo'})
         response.mustcontain('58 results')
     def test_repo_search(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'),
                                 {'q': 'repository:%s def test' % HG_REPO})
         response.mustcontain('18 results')
     def test_search_last(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'),
                                 {'q': 'last:t', 'type': 'commit'})
         response.mustcontain('2 results')
     def test_search_commit_message(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'),
                     {'q': 'bother to ask where to fetch repo during tests',
                      'type': 'commit'})
         response.mustcontain('2 results')
         response.mustcontain('a00c1b6f5d7a6ae678fd553a8b81d92367f7ecf1')
         response.mustcontain('c6eb379775c578a95dad8ddab53f963b80894850')
     def test_search_commit_message_hg_repo(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index',
                                     repo_name=HG_REPO),
                     {'q': 'bother to ask where to fetch repo during tests',
                      'type': 'commit'})
         response.mustcontain('1 results')
         response.mustcontain('a00c1b6f5d7a6ae678fd553a8b81d92367f7ecf1')
     def test_search_commit_changed_file(self):
         self.log_user()
         response = self.app.get(url(controller='search', action='index'),
                                 {'q': 'changed:tests/utils.py',
                                  'type': 'commit'})
         response.mustcontain('29 results')

0 comments (0 inline, 0 general)