guix package --search does not search output names

Done

Details

4 participants

Chris Marusich
Ludovic Courtès
Tobias Geerinckx-Rice
swedebugia

Owner: unassigned

Submitted by: Chris Marusich

Severity: normal

Chris Marusich wrote on 5 May 2019 21:39

Recipients:(address . bug-guix@gnu.org)

Message-ID:87r29czo6e.fsf@gmail.com

Hi,

mikadoZero reported a bug here:

https://lists.gnu.org/archive/html/help-guix/2019-04/msg00206.html

The bug is reproducible. On Guix commit

aa7cdc57dc28673dedfc6ec210974aaa0099a419, a search for keyword "cargo"

does not find the "cargo" output of the "rust" package:

Toggle snippet (18 lines)$ guix package --search=cargo
name: chromium-bsu
version: 0.9.16.1
outputs: out
systems: x86_64-linux i686-linux armhf-linux aarch64-linux mips64el-linux
dependencies: gettext-minimal@0.19.8.1 glu@9.0.0 pkg-config@0.29.2
+ quesoglc@0.7.2 sdl-union@1.2.15
location: gnu/packages/games.scm:3295:2
homepage: http://chromium-bsu.sourceforge.net/
license: Clarified Artistic, Expat
synopsis: Fast-paced, arcade-style, top-scrolling space shooter  
description: In this game you are the captain of the cargo ship Chromium
+ B.S.U.  and are responsible for delivering supplies to the troops on the front
+ line.  Your ship has a small fleet of robotic fighters which you control from
+ the relative safety of the Chromium vessel.
relevance: 2

It should have printed all the "rust" packages, and the "mrustc"

package, since each of them has a "cargo" output. Example:

Toggle snippet (15 lines)name: rust
version: 1.34.0
outputs: out doc cargo
systems: x86_64-linux i686-linux armhf-linux aarch64-linux mips64el-linux
dependencies: bison@3.0.5 cmake@3.13.1 curl@7.63.0 flex@2.6.4 gdb@8.2.1
+ jemalloc@5.1.0 libssh2@1.8.2 llvm@6.0.1 openssl@1.0.2p pkg-config@0.29.2
+ procps@3.3.15 python2@2.7.15 rust@1.33.0 which@2.21
location: gnu/packages/rust.scm:1026:4
homepage: https://www.rust-lang.org
license: ASL 2.0, Expat
synopsis: Compiler for the Rust progamming language  
description: Rust is a systems programming language that provides memory
+ safety and thread safety guarantees.

The general problem here is that Guix does not include outputs whose
name matches the given regex.  One might argue that we should simply add
the output's name to a searchable field, like the description, in cases
like this, but if it's easy to fix, we should just fix it.

-- 
Chris

Tobias Geerinckx-Rice wrote on 5 May 2019 23:41

[PATCH] ui: Search matches additional package outputs.

Recipients:(address . 35588@debbugs.gnu.org)

Message-ID:20190505214153.32372-1-me@tobias.gr

* guix/ui.scm (%package-metrics): Add a PACKAGE-OUTPUTS metric with a

relevance of 1.

* guix/scripts/package.scm (process-query)<search>: Add the

REGEXP/NEWLINE flag.

---

mikadoZero, Guix,

Here's a patch to match package outputs (except ‘out’, since it can't affect the relative score) in ‘guix search’.

Before:

~ λ guix search ernel-patch

# nothing

After:

~ λ guix search ernel-patch

name: wireguard

version: 0.0.20190406

outputs: out kernel-patch

…

~ λ guix search ^ernel-patch

# nothing

While the new REGEXP/NEWLINE flag affects how all fields are matched, I don't think it actually changes anything in practice without the second hunk.

If there's a possibility that it might, I'd split this into two commits.

Kind regards,

T G-R

guix/scripts/package.scm | 3 ++-

guix/ui.scm | 6 ++++++

2 files changed, 8 insertions(+), 1 deletion(-)

Toggle diff (33 lines)diff --git a/guix/scripts/package.scm b/guix/scripts/package.scm
index aa27984ea2..a31e78484e 100644
--- a/guix/scripts/package.scm
+++ b/guix/scripts/package.scm
@@ -751,7 +751,8 @@ processed, #f otherwise."
                                       (('query 'search rx) rx)
                                       (_                   #f))
                                     opts))
-              (regexps  (map (cut make-regexp* <> regexp/icase) patterns)))
+              (regexps  (map (cut make-regexp* <> regexp/icase regexp/newline)
+                             patterns)))
          (leave-on-EPIPE
           (let-values (((packages scores)
                         (find-packages-by-description regexps)))
diff --git a/guix/ui.scm b/guix/ui.scm
index 92c845e944..f2466b605b 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1404,6 +1404,12 @@ score, the more relevant OBJ is to REGEXPS."
   ;; of regexps.
   `((,package-name . 4)
 
+    ;; Separate package outputs by newlines to match regexps like "^tools$".
+    ;; Hard-codedly ignore ‘out’ since it presumably exists for every package.
+    (,(lambda (package)
+        (string-join (delete "out" (package-outputs package))
+                     "\n")) . 1)
+
     ;; Match regexps on the raw Texinfo since formatting it is quite expensive
     ;; and doesn't have much of an effect on search results.
     (,(lambda (package)
-- 
2.21.0

Chris Marusich wrote on 6 May 2019 11:08

Recipients:(name . Tobias Geerinckx-Rice)(address . me@tobias.gr)(address . 35588@debbugs.gnu.org)

Message-ID:87bm0g6jbp.fsf@garuda.local.i-did-not-set--mail-host-address--so-tickle-me

Hi Tobias!

Tobias Geerinckx-Rice <me@tobias.gr> writes:

Toggle quote (2 lines)

> Here's a patch to match package outputs (except ‘out’, since it can't affect the relative score) in ‘guix search’.

Wow, thank you for the quick patch!  Indeed, it works as advertised.

That said, I see that your patch only omits the "out" output, and it
also changes the way the regular expression matching works for all
fields.  Previously, a regex like "foo$" would have matched against
"foo" at the end of a package's description string, but now it matches
"foo" right before any newline in the description.  In practice, it
seems we have many newlines in the descriptions, since people wrap the
lines in the source code with non-escaped newlines.  I doubt anyone is
relying on the use of $ or ^ to match at the start of end of the
description, so this probably isn't a big deal, but it made me wonder
how else we might be able to accomplish the same task without changing
the way the regexes already work.

I've attached a patch that attempts to do that.  Basically, this patch
is like yours in spirit, but it excludes a few more "common" outputs,
and it splits the outputs into a list, rather than separating them by
newlines in a single string.  The downside is that I had to update all
the other "metrics" procedures so they would always return a list.  I
kind of feel like returning the same type of object is an upside, not a
downside, but I guess the pattern of returning #f for special cases is
pretty common in Guile, so maybe my change isn't very idiomatic.

What do you think of this solution?  I think it's a little more drastic,
but it feels cleaner to me.  If I'm bike shedding, feel free to call me
out on that!  ;-)

-- 
Chris

Attachment: 0001-ui-Make-package-outputs-searchable.patch

Ludovic Courtès wrote on 6 May 2019 11:32

Recipients:(name . Chris Marusich)(address . cmmarusich@gmail.com)

Message-ID:87muk0kjxf.fsf@gnu.org

Hello,

Chris Marusich <cmmarusich@gmail.com> skribis:

Toggle quote (10 lines)> Tobias Geerinckx-Rice <me@tobias.gr> writes:
>
>> Here's a patch to match package outputs (except ‘out’, since it can't affect the relative score) in ‘guix search’.
>
> Wow, thank you for the quick patch!  Indeed, it works as advertised.
>
> That said, I see that your patch only omits the "out" output, and it
> also changes the way the regular expression matching works for all
> fields.

Yeah, how does this regexp/newline related to matching outputs, Tobias?

Toggle quote (4 lines)

> What do you think of this solution? I think it's a little more drastic,

> but it feels cleaner to me. If I'm bike shedding, feel free to call me

> out on that! ;-)

FWIW I find it a bit too drastic. :-) It leads to much verbosity and

I’m not sure this is warranted.

Toggle quote (17 lines)>  (define %package-metrics
>    ;; Metrics used to compute the "relevance score" of a package against a set
>    ;; of regexps.
> -  `((,package-name . 4)
> -
> +  `((,(lambda (package)
> +        (list (package-name package)))
> +     . 4)
> +    ;; Match against uncommon outputs.
> +    (,(lambda (package)
> +        (filter (lambda (output)
> +                  (not (member output
> +                               ;; Some common outpus shared by many packages.
> +                               '("out" "debug" "doc" "static"))))
> +                (package-outputs package)))
> +     . 1)

Could we have just this hunk or is there something I’m missing that

would make it insufficient?

Thank you,

Ludo’.

Chris Marusich wrote on 7 May 2019 02:57

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)

Message-ID:87zhnzxer9.fsf@gmail.com

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (3 lines)

> Could we have just this hunk or is there something I’m missing that

> would make it insufficient?

That hunk alone is not enough, but I think the attached patch would do

the trick. We just need to allow for the new possibility that the

"field" procedure returns a list of strings.

What do you think?

Chris

From c1150a217a416ef4ceccf87c56e36e8e921f873a Mon Sep 17 00:00:00 2001
From: Chris Marusich <cmmarusich@gmail.com>
Date: Mon, 6 May 2019 01:51:30 -0700
Subject: [PATCH] ui: Make package outputs searchable.

* guix/ui.scm (relevance): Allow the "field" procedure of a metric to
return a list, and handle that case appropriately.  Update docstring.
(%package-metrics): Add a metric for package outputs.
* guix/scripts/package.scm (find-packages-by-description): Update
docstring.

Co-authored-by: Tobias Geerinckx-Rice <me@tobias.gr>
---
 guix/scripts/package.scm |  6 +++---
 guix/ui.scm              | 24 +++++++++++++++++++-----
 2 files changed, 22 insertions(+), 8 deletions(-)

Toggle diff (75 lines)diff --git a/guix/scripts/package.scm b/guix/scripts/package.scm
index aa27984ea2..06e4cf5b9c 100644
--- a/guix/scripts/package.scm
+++ b/guix/scripts/package.scm
@@ -180,9 +180,9 @@ hooks\" run when building the profile."
 ;;;
 
 (define (find-packages-by-description regexps)
-  "Return two values: the list of packages whose name, synopsis, or
-description matches at least one of REGEXPS sorted by relevance, and the list
-of relevance scores."
+  "Return two values: the list of packages whose name, synopsis, description,
+or output matches at least one of REGEXPS sorted by relevance, and the list of
+relevance scores."
   (let ((matches (fold-packages (lambda (package result)
                                   (if (package-superseded package)
                                       result
diff --git a/guix/ui.scm b/guix/ui.scm
index 92c845e944..b7ccd8312a 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -11,6 +11,8 @@
 ;;; Copyright © 2016 Benz Schenk <benz.schenk@uzh.ch>
 ;;; Copyright © 2018 Kyle Meyer <kyle@kyleam.com>
 ;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
+;;; Copyright © 2019 Chris Marusich <cmmarusich@gmail.com>
+;;; Copyright © 2019 Tobias Geerinckx-Rice <me@tobias.gr>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -1370,9 +1372,9 @@ WIDTH columns.  EXTRA-FIELDS is a list of symbol/value pairs to emit."
 (define (relevance obj regexps metrics)
   "Compute a \"relevance score\" for OBJ as a function of its number of
 matches of REGEXPS and accordingly to METRICS.  METRICS is list of
-field/weight pairs, where FIELD is a procedure that returns a string
-describing OBJ, and WEIGHT is a positive integer denoting the weight of this
-field in the final score.
+field/weight pairs, where FIELD is a procedure that returns a string or list
+of strings describing OBJ, and WEIGHT is a positive integer denoting the
+weight of this field in the final score.
 
 A score of zero means that OBJ does not match any of REGEXPS.  The higher the
 score, the more relevant OBJ is to REGEXPS."
@@ -1394,8 +1396,11 @@ score, the more relevant OBJ is to REGEXPS."
             ((field . weight)
              (match (field obj)
                (#f  relevance)
-               (str (+ relevance
-                       (* (score str) weight)))))))
+               ((? string? str) (+ relevance
+                                   (* (score str) weight)))
+               ((? list? lst) (+ relevance
+                                 (* weight
+                                    (apply + (map score lst)))))))))
         0
         metrics))
 
@@ -1404,6 +1409,15 @@ score, the more relevant OBJ is to REGEXPS."
   ;; of regexps.
   `((,package-name . 4)
 
+    ;; Match against uncommon outputs.
+    (,(lambda (package)
+        (filter (lambda (output)
+                  (not (member output
+                               ;; Some common outpus shared by many packages.
+                               '("out" "debug" "doc" "static"))))
+                (package-outputs package)))
+     . 1)
+
     ;; Match regexps on the raw Texinfo since formatting it is quite expensive
     ;; and doesn't have much of an effect on search results.
     (,(lambda (package)
-- 
2.20.1

Ludovic Courtès wrote on 7 May 2019 10:25

Recipients:(name . Chris Marusich)(address . cmmarusich@gmail.com)

Message-ID:87mujy8yd8.fsf@gnu.org

Hello,

Chris Marusich <cmmarusich@gmail.com> skribis:

Toggle quote (13 lines)> From c1150a217a416ef4ceccf87c56e36e8e921f873a Mon Sep 17 00:00:00 2001
> From: Chris Marusich <cmmarusich@gmail.com>
> Date: Mon, 6 May 2019 01:51:30 -0700
> Subject: [PATCH] ui: Make package outputs searchable.
>
> * guix/ui.scm (relevance): Allow the "field" procedure of a metric to
> return a list, and handle that case appropriately.  Update docstring.
> (%package-metrics): Add a metric for package outputs.
> * guix/scripts/package.scm (find-packages-by-description): Update
> docstring.
>
> Co-authored-by: Tobias Geerinckx-Rice <me@tobias.gr>

[...]

Toggle quote (10 lines)>               (match (field obj)
>                 (#f  relevance)
> -               (str (+ relevance
> -                       (* (score str) weight)))))))
> +               ((? string? str) (+ relevance
> +                                   (* (score str) weight)))
> +               ((? list? lst) (+ relevance
> +                                 (* weight
> +                                    (apply + (map score lst)))))))))

Nitpick: it’s a bit subjective, but I think this clause might be

slightly nicer like this:

((lst ...)

(+ relevance (* weight (reduce + 0 (map score lst)))))

Anyway, LGTM!

Thanks,

Ludo’.

swedebugia wrote on 8 May 2019 00:24

Recipients:(address . 35588@debbugs.gnu.org)

Message-ID:7951ec53-8eee-04a3-9be4-7501d46eceb8@riseup.net

On 2019-05-07 02:57, Chris Marusich wrote:

Toggle quote (7 lines)

> + ;; Match against uncommon outputs.

> + (,(lambda (package)

> + (filter (lambda (output)

> + (not (member output

> + ;; Some common outpus shared by many packages.

> + '("out" "debug" "doc" "static"))))

I suggest we add "gui" and "lib" to this list.

Cheers

Swedebugia

Chris Marusich wrote on 8 May 2019 08:50

Re: bug#35588: [PATCH] ui: Search matches additional package outputs., bug#35588: [PATCH] ui: Search matches additional package outputs.

Recipients:

Message-ID:878svhv3re.fsf@gmail.com

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (16 lines)>>               (match (field obj)
>>                 (#f  relevance)
>> -               (str (+ relevance
>> -                       (* (score str) weight)))))))
>> +               ((? string? str) (+ relevance
>> +                                   (* (score str) weight)))
>> +               ((? list? lst) (+ relevance
>> +                                 (* weight
>> +                                    (apply + (map score lst)))))))))
>
> Nitpick: it’s a bit subjective, but I think this clause might be
> slightly nicer like this:
>
>   ((lst ...)
>    (+ relevance (* weight (reduce + 0 (map score lst)))))

Works for me! I've changed the match clause accordingly in the attached

patch.

swedebugia <swedebugia@riseup.net> writes:

Toggle quote (10 lines)> On 2019-05-07 02:57, Chris Marusich wrote:
>> +    ;; Match against uncommon outputs.
>> +    (,(lambda (package)
>> +        (filter (lambda (output)
>> +                  (not (member output
>> +                               ;; Some common outpus shared by many packages.
>> +                               '("out" "debug" "doc" "static"))))
>
> I suggest we add "gui" and "lib" to this list.

Actually, I was curious about this, so I checked how many outputs are

being used by all our packages today. Here are the results:

Toggle snippet (54 lines)scheme@(guix-user)> ,use (gnu packages) (guix packages)
scheme@(guix-user)> (define (increment table key) (hash-set! table key (+ 1 (hash-ref table key 0))))
scheme@(guix-user)> (define (increment-outputs package table) (for-each (lambda (output) (increment table output)) (package-outputs package)) table)
scheme@(guix-user)> (define outputs-to-count (fold-packages increment-outputs (make-hash-table)))
scheme@(guix-user)> ,pp (sort (hash-map->list cons outputs-to-count) (lambda (a b) (< (cdr a) (cdr b))))
$1 = (("kernel-patch" . 1)
 ("pcf-8bit" . 1)
 ("python2" . 1)
 ("schema" . 1)
 ("octave" . 1)
 ("jp" . 1)
 ("db" . 1)
 ("gtk3" . 1)
 ("kr" . 1)
 ("subtree" . 1)
 ("pulseaudio" . 1)
 ("cn" . 1)
 ("ruby" . 1)
 ("fbgrab" . 1)
 ("credential-netrc" . 1)
 ("front-end" . 1)
 ("psf" . 1)
 ("tw" . 1)
 ("libedataserverui" . 1)
 ("gtk2" . 1)
 ("pcf" . 1)
 ("send-email" . 1)
 ("jack" . 1)
 ("python3" . 1)
 ("ndiff" . 1)
 ("installer" . 1)
 ("svn" . 1)
 ("image" . 1)
 ("tiles" . 2)
 ("fortran" . 3)
 ("include" . 3)
 ("utils" . 3)
 ("tests" . 3)
 ("python" . 4)
 ("tk" . 4)
 ("metis" . 4)
 ("gui" . 4)
 ("examples" . 5)
 ("jdk" . 6)
 ("bin" . 8)
 ("cargo" . 16)
 ("static" . 33)
 ("lib" . 38)
 ("debug" . 87)
 ("doc" . 134)
 ("out" . 9811))
scheme@(guix-user)> 

In light of that, I've chosen to exclude all of the following outputs:

'("out" "doc" "debug" "lib" "static" "bin" "examples" "gui" "tests"

"utils" "include")

I've also added a test to verify that package outputs are included in

search results.

What do you all think of this latest version?

Chris

Attachment: 0001-ui-Make-package-outputs-searchable.patch

Ludovic Courtès wrote on 8 May 2019 12:39

Recipients:(name . Chris Marusich)(address . cmmarusich@gmail.com)

Message-ID:87pnotz0un.fsf@gnu.org

Hi!

Chris Marusich <cmmarusich@gmail.com> skribis:

Toggle quote (8 lines)

> In light of that, I've chosen to exclude all of the following outputs:

> '("out" "doc" "debug" "lib" "static" "bin" "examples" "gui" "tests"

> "utils" "include")

> I've also added a test to verify that package outputs are included in

> search results.

I would exclude only the standard output names used by (guix build

gnu-build-system), so:

("out" "doc" "debug" "lib" "include" "bin")

That way one can still do ‘guix search git gui’ or ‘guix search bind utils’.

Toggle quote (2 lines)

> What do you all think of this latest version?

Thanks for the new test! LGTM.

Ludo’.

Chris Marusich wrote on 9 May 2019 09:22

Re: bug#35588: [PATCH] ui: Search matches additional package outputs.

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)

Message-ID:87lfzgcctg.fsf_-_@gmail.com

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (7 lines)

> I would exclude only the standard output names used by (guix build

> gnu-build-system), so:

> ("out" "doc" "debug" "lib" "include" "bin")

> That way one can still do ‘guix search git gui’ or ‘guix search bind utils’.

I didn't know you could do that! Your suggestion makes sense. I've

done as you suggest in commit 387e6b9e340ce4b401f220f72881415623a466f7.

Thanks everyone! I'm closing this bug report.

Chris

Ludovic Courtès wrote on 9 May 2019 12:18

control message for bug #35588

Recipients:(address . control@debbugs.gnu.org)

Message-ID:87d0ksexs3.fsf@gnu.org

tags 35588 fixed

close 35588

Your comment

This issue is archived.

To comment on this conversation send an email to 35588@debbugs.gnu.org

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date