549586 - "See also" field should parse bug numbers from the local bugzilla installation as valid

Status: RESOLVED FIXED

(Bugzilla :: Creating/Changing Bugs, enhancement)

Description

[Thomas D. (:thomas8)]

STR

User wants to include a link to another bug from the same installation (say bmo):
- the other bug has some relevance for the current bug
- but it's neither a duplicate, nor dependent, nor blocking.
I often find that I need to add links to such just somehow "related / relevant" bugs within bmo.

Actual result:

a) you have to enter *full bug URL* of related bug from same bugzilla installation into "See also" field, like this: 
See Also: [https://bugzilla.mozilla.org/show_bug.cgi?id=55436, ...]

b) after committing, a linkified version of the *full bug URL* will be displayed in "See Also" Field, like this:
See Also: _https://bugzilla.mozilla.org/show_bug.cgi?id=55436_
Given the fact that the linked bug is from the same installation:
- that's very cluttered with information you don't need (the full path),
- and lacking tooltip information you *do* need (the bug's title, status etc.)

Expected result:

a) Allow entering plain bug numbers from same installation into See Also field (in addition to full URLs), like this:
See Also: [55436, http://somewhere_else.com/external_link.htm, ...]

b) parse / auto-linkify bug links from local bugzilla installation, like this:
See Also: Bug 55436, http://somewhere_else.com/external_link.htm, ...
(with or without the word "Bug" in front of the bug number)

This requires parsing the following
- plain numbers (e.g. 55436)
- full URLs from local installation (e.g. https://bugzilla.mozilla.org/show_bug.cgi?id=55436)
-> both of these should be displayed autolinkified like this:
See also: bug 55436 (with or without the word bug in front of it)

Technically, should be simple:

Step1:
comma-split the string with values from "See also", so you get an array with the following values:
- 55436
- https://bugzilla.mozilla.org/show_bug.cgi?id=94505
- http://somewhere_else.com/external_link.htm

Step2:
convert all plain numbers into full bug urls from same installation:
- 55436 -> https://bugzilla.mozilla.org/show_bug.cgi?id=55436
- https://bugzilla.mozilla.org/show_bug.cgi?id=94505
- http://somewhere_else.com/external_link.htm

Step3:
for display, auto-linkify all bug URLs from local installation
- https://bugzilla.mozilla.org/show_bug.cgi?id=55436 -> bug 55436
- https://bugzilla.mozilla.org/show_bug.cgi?id=94505 -> bug 94505
- http://somewhere_else.com/external_link.htm

So final display is this:
See also: Bug 55436, Bug 94505, http://somewhere_else.com/external_link.htm
(with or without the word bug)

Please vote for this bug if you'd like the comfort and functionality of this RFE.

Comment 1

[Frédéric Buclin]

Replacing the URL by a shorter name is already what bug 475059 is asking for, and not only for local installations.

Comment 2

[Max Kanat-Alexander]

Actually, the part about being able to enter bug numbers is not a duplicate, and is a valid request for something that I've wanted to do as well.

Comment 3

[Thomas D. (:thomas8)]

Max, adding a local bug number to "see also" means creating a link between two bugs on the local installation (e.g. bmo). I'd expect that for /local/ links, they should appear on /both/ bugs, i. e. when I set "see also: bug 475059" for this bug, then in bug 475059, we should also automatically add "see also: bug 549586" so that the link works both ways (same as we do for "depends/blocks" fields which are functionally very similar).

Should I file that as a separate bug, or can we expect it as part of this bug?

Comment 4

[Max Kanat-Alexander]

(In reply to comment #3)
> Max, adding a local bug number to "see also" means creating a link between two
> bugs on the local installation (e.g. bmo). I'd expect that for /local/ links,
> they should appear on /both/ bugs, i. e. when I set "see also: bug 475059" for
> this bug, then in bug 475059, we should also automatically add "see also: bug
> 549586" so that the link works both ways (same as we do for "depends/blocks"
> fields which are functionally very similar).
> 
> Should I file that as a separate bug, or can we expect it as part of this bug?

  Oh, that's a good point. Yeah, file it as a separate bug.

Comment 5

[Thomas D. (:thomas8)]

(In reply to comment #4)
>   Oh, that's a good point. Yeah, file it as a separate bug.
-> bug 553932

Comment 6

[Tiago Mello [:timello]]

Attachment: v1

Max, small patch.

Comment 7

[Max Kanat-Alexander]

Comment on attachment 470349 [details] [diff] [review]
v1

>=== modified file 'Bugzilla/Bug.pm'
>+        my $ref_bug = new Bugzilla::Bug->check($id);

  No "new".

>+        if ($ref_bug->id == $self->id) {
>+            ThrowUserError('bug_url_invalid',
>+                { url => $input, reason => 'id_self_reference' });

  Instead of using bug_url_invalid, I think we should use a new error, because the text here doesn't really make sense--you didn't input a URL, you input a bug number.

  Also, this should catch full-URL links to the local Bugzilla, not just aliases or ids.

>+        $ref_bug->add_see_also($local_bug_uri . $self->id);
>+        push @{ $self->{see_also_update} }, $ref_bug;

  Does that work even if see_also_update is undef?

Comment 8

[Biju]

along with this enhancement cant we add URLs for bugzilla attachments also?

Comment 9

[Tiago Mello [:timello]]

(In reply to comment #7)
> Comment on attachment 470349 [details] [diff] [review]
> 
> >+        $ref_bug->add_see_also($local_bug_uri . $self->id);
> >+        push @{ $self->{see_also_update} }, $ref_bug;
> 
>   Does that work even if see_also_update is undef?

It does.

Comment 10

[Tiago Mello [:timello]]

Attachment: v2.

Comment 11

[Tiago Mello [:timello]]

Attachment: v3.

Fixing a nit.

Comment 12

[Max Kanat-Alexander]

Comment on attachment 470451 [details] [diff] [review]
v3.

>=== modified file 'Bugzilla/Bug.pm'
>+    if (my (undef, $id) = $input =~ m/^(\Q$local_bug_uri\E|)(\w+)$/) {

  This needs to happen only after the URL is canonicalized in the "show_bug" section below. So instead of this, just check for \w+ and change it into a URL, and then deal with the rest of it below in the show_bug section.

>+        my $ref_bug = Bugzilla::Bug->check($id);

  I think you also need to call can_edit_product on the referred bug, to implement canedit protections.

Comment 13

[Tiago Mello [:timello]]

Attachment: v4

Comment 14

[Max Kanat-Alexander]

Comment on attachment 471007 [details] [diff] [review]
v4

Looks great! Thanks timello! :-)

Comment 15

[Tiago Mello [:timello]]

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk/                                                                                                             
modified Bugzilla/Bug.pm
modified template/en/default/global/user-error.html.tmpl
Committed revision 7459.

Comment 16

[Max Kanat-Alexander]

Attachment: Fix "no urlbase" case

The regexes weren't properly checking for the input URL actually *starting* with the specified urlbase, so things like "http://show_bug.cgi?id=2" would have triggered it. (This was breaking the xt/search.t test.)

Comment 17

[Max Kanat-Alexander]

Committing to: bzr+ssh://bzr.mozilla.org/bugzilla/trunk/                       
modified Bugzilla/Bug.pm
Committed revision 7461.

Comment 18

[Frédéric Buclin]

Added to relnotes in bug 713346.

Comment 19

[Thomas D. (:thomas8)]

Where can I find information when bmo (currently 4.0.8+) will be updated to Bugzilla 4.2 so that this useful feature will land there, too?

Comment 20

[David Lawrence [:dkl]]

(In reply to Thomas D. from comment #19)
> Where can I find information when bmo (currently 4.0.8+) will be updated to
> Bugzilla 4.2 so that this useful feature will land there, too?

BMO will hopefully be upgrading around the beginning of December.

dkl