[yocto] [layerindex-web][patch v2 1/1] recipes.html: Require keyword for recipe search
Paul Eggleton
paul.eggleton at linux.intel.com
Mon Nov 6 23:27:03 PST 2017
Hi Amanda,
A few comments below.
On Tuesday, 7 November 2017 1:21:23 PM NZDT Amanda Brindle wrote:
> Use JavaScript to check if the search box for recipe search is
> empty before querying the database. This will prevent the "502
> Bad Gateway" error that occurs when the query takes too long due
> to the large list of recipes.
We should mention that the main reason we are using this workaround rather
than fixing the underlying issue is that since there are so many recipes
spread across quite a number of layers in the OE index, there's no
point allowing you to search without a keyword in order to browse the list;
it simply isn't digestible as a whole.
> Add a browse button for the Machines and Distros pages.
Could you also please add one for the new Classes page you added
(now merged to master)?
> Fixes [YOCTO #11930]
>
> Signed-off-by: Amanda Brindle <amanda.r.brindle at intel.com>
> ---
> layerindex/views.py | 10 ++++++++--
> templates/layerindex/distros.html | 3 ++-
> templates/layerindex/machines.html | 3 ++-
> templates/layerindex/recipes.html | 12 +++++++++++-
> 4 files changed, 23 insertions(+), 5 deletions(-)
>
> diff --git a/layerindex/views.py b/layerindex/views.py
> index 3b22067..9b5d505 100644
> --- a/layerindex/views.py
> +++ b/layerindex/views.py
> @@ -656,7 +656,10 @@ class MachineSearchView(ListView):
>
> def get_queryset(self):
> _check_url_branch(self.kwargs)
> - query_string = self.request.GET.get('q', '')
> + if self.request.GET.get('search', ''):
> + query_string = self.request.GET.get('q', '')
> + else:
> + query_string = ""
> init_qs = Machine.objects.filter(layerbranch__branch__name=self.kwargs['branch'])
> if query_string.strip():
> entry_query = simplesearch.get_query(query_string, ['name', 'description'])
> @@ -705,7 +708,10 @@ class DistroSearchView(ListView):
>
> def get_queryset(self):
> _check_url_branch(self.kwargs)
> - query_string = self.request.GET.get('q', '')
> + if self.request.GET.get('search', ''):
> + query_string = self.request.GET.get('q', '')
> + else:
> + query_string = ""
> init_qs = Distro.objects.filter(layerbranch__branch__name=self.kwargs['branch'])
> if query_string.strip():
> entry_query = simplesearch.get_query(query_string, ['name', 'description'])
> diff --git a/templates/layerindex/distros.html b/templates/layerindex/distros.html
> index 7085584..34b5419 100644
> --- a/templates/layerindex/distros.html
> +++ b/templates/layerindex/distros.html
> @@ -34,7 +34,8 @@
> <div class="input-append">
> <form id="filter-form" action="{% url 'distro_search' url_branch %}" method="get">
> <input type="text" class="input-xxlarge" id="appendedInputButtons" placeholder="Search distros" name="q" value="{{ search_keyword }}" />
> - <button class="btn" type="submit">search</button>
> + <button class="btn" type="submit" name="search" value="1">search</button>
> + <button class="btn" type="submit" name="browse" value="1">browse</button>
> </form>
> </div>
> </div>
> diff --git a/templates/layerindex/machines.html b/templates/layerindex/machines.html
> index 2a9f947..d91228a 100644
> --- a/templates/layerindex/machines.html
> +++ b/templates/layerindex/machines.html
> @@ -33,7 +33,8 @@
> <div class="input-append">
> <form id="filter-form" action="{% url 'machine_search' url_branch %}" method="get">
> <input type="text" class="input-xxlarge" id="appendedInputButtons" placeholder="Search machines" name="q" value="{{ search_keyword }}" />
> - <button class="btn" type="submit">search</button>
> + <button class="btn" type="submit" name="search" value="1">search</button>
> + <button class="btn" type="submit" name="browse" value="1">browse</button>
> </form>
> </div>
> </div>
> diff --git a/templates/layerindex/recipes.html b/templates/layerindex/recipes.html
> index 60a2667..28f3f55 100644
> --- a/templates/layerindex/recipes.html
> +++ b/templates/layerindex/recipes.html
> @@ -32,13 +32,14 @@
>
> <div class="row-fluid">
> <div class="input-append">
> - <form id="filter-form" action="{% url 'recipe_search' url_branch %}" method="get">
> + <form id="filter-form" action="{% url 'recipe_search' url_branch %}" method="get" onsubmit="return validate()">
> <input type="text" class="input-xxlarge" id="appendedInputButtons" placeholder="Search recipes" name="q" value="{{ search_keyword }}" />
> <button class="btn" type="submit">search</button>
> </form>
> </div>
> </div>
>
> + <div id="error"> </div>
> {% if recipe_list %}
> <table class="table table-striped table-bordered recipestable">
> <thead>
> @@ -87,5 +88,14 @@
> $('.icon-hdd').tooltip({title:"Inherits image"});
> $('.label-inverse').tooltip();
> });
> +
> + function validate(){
> + if (!$("#appendedInputButtons").val()){
> + $("#error").html("<error>Recipe search cannot be blank</error>");
> + $("error").addClass("control-group alert alert-error");
> + return false;
> + }
> + }
> +
I'm not sure <error> is a valid HTML tag. Looking at the bootstrap docs I think
we should actually be using its error state and help text functionality (see
"Validation states" on http://getbootstrap.com/2.3.2/base-css.html#forms ).
I tested it and to fix the layout apparently we need to rearrange the tags so that
<form> is immediately under the row-fluid div, i.e. it should be:
<div class="row-fluid">
<form ...>
<div class="control-group">
<div class="controls" id="searchfield">
<div class="input-append">
<input ... />
<button ...>search</button>
</div>
<span class="help-inline" id="errortext"></span>
</div>
</div>
</form>
</div>
For maximum effect you also need to actually focus the search box at the same
time as setting the error within the javascript.
If you could also change the text to "Please specify search text" at the
same time (and surround with <p></p> to get the correct alignment) that would
be great.
Thanks,
Paul
--
Paul Eggleton
Intel Open Source Technology Centre
More information about the yocto
mailing list