394669 - Make bug numbers clickable for hg.mozilla.org

Status: RESOLVED FIXED

(Developer Services :: Mercurial: hg.mozilla.org, defect)

Description

[Ed Lee :Mardak]

Attachment: v1

Linkify various bug-like checkin comments such as...

bug 1, bug #1, b=1, #12345, 20070

For the last 2 cases, it'll linkify only numbers that are 5 digits or longer.

This applies to viewing (long) changelogs, changesets, file annotations, file views.

I'll post it upstream and perhaps someone will generalize it to not have b.mo somewhat hardcoded. ;)

Comment 1

[Reed Loden [:reed]]

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

>+    "bug": lambda x: bug(x, 'http://bugzilla.mozilla.org/show_bug.cgi?id='),

s/http/https/

Comment 2

[Reed Loden [:reed]]

Doing patches like this isn't going to work. Either the patches need to go upstream, or we need to put hgweb in a repo that we can edit and use. Local patches are _bad_ (re: prior experience with local patches for tinderbox/bonsai).

Comment 3

[Ed Lee :Mardak]

Attachment: v2

http -> https, look for 4 digits instead of 5

Setting up a local repository of mercurial would work. Basically it would be a branch of the main line, and we would be able to keep versions and so on.

Kinda like what I'm doing right now to generate these patches.. I've got hg keeping track of hg as well as serving itself.

Comment 4

[Ed Lee :Mardak]

Attachment: v3

I've updated the patch to be generic (set bugtracker in [web]) and update the default template, so it should be more likely to land upstream.

----

Convert bug numbers to links in descriptions for hgweb; set bugtracker in [web]
http://www.selenic.com/pipermail/mercurial/2007-September/014492.html

This patch converts bug-like numbers in descriptions to be links if
the configuration [web] section has a "bugtracker" value. Updates
default and gitweb templates.

Commit messages can have references to bug numbers that contain useful
discussions, so providing a link to the bug lets people viewing the
repository get a bigger picture easier. The patch looks in the
description for text like bug 1, bug #1, b=1, #1234, 2007; so there
might be false positives, but that's not too bad.

I added the "bug" filter in hgmod_web.py because it needed to use a
configuration value that's not easily accessible from templater.py.
Additionally, filters that don't actually exist won't get applied, so
an unset bugtracker will have the "bug" filter do nothing.

Example .hgrc:
[web]
bugtracker = https://bugzilla.mozilla.org/show_bug.cgi?id=

The default and gitweb templates use "desc" in different places, but
all the non-link uses of desc should now be bug-ifyable. (I avoided
making nested links which work but are messy...)

Comment 5

[Ed Lee :Mardak]

Turns out there's an "interhg" extension-in-the-making which basically does what I've coded up, but slightly more general in some ways. You can specify a regular expression of text to match and the corresponding replace text.

There's currently some "issues" filed.. http://www.selenic.com/mercurial/bts/issue699 and http://www.selenic.com/mercurial/bts/issue698

But the extension is on the "crew" repository for people to test.
http://hg.intevation.org/mercurial/crew/file/4fe04b183fd8/hgext/interhg.py

To use it, it would probably be along the lines of..

[extensions]
interhg =

[interhg]
pat1 = s/((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))/<a href="https:\/\/bugzilla.mozilla.org\/show_bug.cgi?id=\2">\1</a>/

Comment 6

[Aravind Gottipati [:aravind]]

I can go ahead and install this extension if folks are okay with it.  I see you made some changes to the extension, do we need those or should I just pull from http://hg.intevation.org/mercurial/crew/file/4fe04b183fd8/hgext/interhg.py?

Comment 7

[Ed Lee :Mardak]

The files I attached here are my own changes, interhg is a completely separate extension that someone else happened to start a couple months back.

I tried out the interhg extension and it's mostly working. There are those 2 issues that I linked to above -- 1) links can appear inside other links breaking the outer link and 2) there should be more flexibility in the expression.

Assuming those issues are fixed, we could just do..

[interhg]
bugzilla = s|((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))|<a
href="https://bugzilla.mozilla.org/show_bug.cgi?id=\2">\1</a>|i

(Whereas with the current extension that you can pull from the crew repository, you would need to do..

[interhg]
pat1 = s/((?:[bB][uU][gG]|[bB]=|(?=#?\d{4,}))(?:\s*#?)(\d+))/<a
href="https:\/\/bugzilla.mozilla.org\/show_bug.cgi?id=\2">\1</a>/

The changeset that added interhg only added that one file, so I guess if you put interhg.py into the hgext directory, that might do it..

http://hg.intevation.org/mercurial/crew/rev/0ac6b537893f

Comment 8

[Aravind Gottipati [:aravind]]

Moving this to projects since I will work on this next quarter.

Comment 9

[Ed Lee :Mardak]

Now that 0.9.5 is out, the .hgrc file just needs..

[extensions]
interhg =

[interhg]
bugzilla = s|((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))|<a href="https://bugzilla.mozilla.org/show_bug.cgi?id=\2">\1</a>|i

However, there's a slight issue of links in links.. might be able to get around it with a span and onclick?

Comment 10

[Ed Lee :Mardak]

This seems to be working for me.

bugzilla = s|((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))|<span style="text-decoration: underline;" onclick="event.preventDefault(); document.location = 'https://bugzilla.mozilla.org/show_bug.cgi?id=\2';" onmouseover="window.status = 'https://bugzilla.mozilla.org/show_bug.cgi?id=\2';" onmouseout="window.status = '';" title="View bug \2">\1</span>|i

Could make it fancier with changing styles and all.

Comment 11

[Adam Guthrie]

*bump* What's the status here? Sounds like we just need to plop in an extension and make the change to the .hgrc file (per comment 9). Sounds easy enough.

Comment 12

[Benjamin Smedberg]

Edward, can you explain why you prefer the onclick solution to normal links? I'm not sure I understand how common the "nested" case is going to be. I can stage this on a local server for testing if desirable.

Comment 13

[Ed Lee :Mardak]

The problem with normal links is that commit messages are by default links.

http://hg.mozilla.org/cvs-trunk-mirror/

The commit message links to the changeset, and if we convert "bug ###" into a link, we end up with..

<a href="changeset">commit log <a href="bug">bug ###</a> broken link</a>

Where "broken link" doesn't show up as a link anymore.

Comment 14

[Ed Lee :Mardak]

(In reply to comment #11)
> Sounds like we just need to plop in an extension
Actually, no need to plop in the extension since version 0.9.5 -- it has it installed by default and enabling it just requires modifying the .hgrc file.

Comment 15

[Aravind Gottipati [:aravind]]

bsmedberg: do we want this enabled globally?

Comment 16

[Benjamin Smedberg]

Aravind, let me try a couple local tests and get back to you.

Comment 17

[Benjamin Smedberg]

Aravind, here's what I'd like to do, if it sounds reasonable to you:

1) take some gitweb_mozilla template changes. I have a cloned repository at http://hg.mozilla.org/users/bsmedberg_mozilla.com/index.cgi/hg_templates/

2) Add the following settings to the global config:

[extensions]
interhg =

[interhg]
a_httplinks = s|(https?://\S+)|<a href="\1">\1</a>|i
bugzilla = s|((?:bug[\s#]*|b=#?|#)(\d{3,}))|<a href="https://bugzilla.mozilla.org/show_bug.cgi?id=\2" title="Bug \2">\1</a>|i

These changes are running at http://office.smedbergs.us/hgwebdir.cgi/mozilla-central/ if you want to see them in action.

Comment 18

[Reed Loden [:reed]]

> bugzilla = s|((?:bug[\s#]*|b=#?|#)(\d{3,}))|<a
> href="https://bugzilla.mozilla.org/show_bug.cgi?id=\2" title="Bug \2">\1</a>|i

Bonsai requires at least 4 numbers in a row... might want to do the same thing with this, too...

Comment 19

[Aravind Gottipati [:aravind]]

Done.

Reed: bumped that to 4 digits in a row.  Can't be upsetting bonsai!

Comment 20

[Benjamin Smedberg]

This causes the Atom feed to be malformed:

http://feedvalidator.org/check.cgi?url=http%3A%2F%2Fhg.mozilla.org%2Fmozilla-central%2Findex.cgi%2Fatom-log

So we're running interhg on the feed output incorrectly. Aravind, can you please turn off interhg for the moment, until I can figure out if there's a way to fix it?

Comment 21

[Aravind Gottipati [:aravind]]

sure.  Done.

Comment 22

[Benjamin Smedberg]

Want this open... assigning to me for the moment to think about a better solution.

Comment 23

[matthew zeier [:mrz]]

Marking incomplete - re-open when you have a better solution.

Comment 24

[Benjamin Smedberg]

This bug is assigned to me, please do not mark it incomplete or it will fall off my radar.

Comment 25

[matthew zeier [:mrz]]

Okay, pushed to Projecst.  Move out of there when you're ready (aren't you afk?).

Comment 27

[John O'Duinn [:joduinn] (please use "needinfo?" flag)]

bsmedberg: any update on this?

Comment 28

[Benjamin Smedberg]

It's low-priority... the idea is to have an extension like interhg but rather than hooking the default escape filter to use a different filter and then use that filter from the templates for selected areas that we actually want filtered.

Comment 29

[Daniel Holbert [:dholbert]]

For anyone who doesn't want to wait for this bug to be fixed:  Zbigniew Braniecki has written a greasemonkey script that implements this.

Blog post:
  http://diary.braniecki.net/2008/06/05/hgmozillaorg-linkify-bookmarklet/
Script:
  http://labs.braniecki.net/mozilla/scripts/hglinkify.user.js

Comment 30

[Jeremy Orem [:oremj]]

Changing QA Contact.

Comment 31

[(not currently active) Ted Mielczarek]

bsmedberg: are you still going to do this, or would you like me to take it?

Comment 32

[Benjamin Smedberg]

If you'd like to take it, I don't mind. The plan I had was:

* write an hg extension which adds a new filter to do linkification in the same way interhg does
* modify our templates to use the new filter

Comment 33

[(not currently active) Ted Mielczarek]

I added a small extension and modified the templates to use it:
http://hg.mozilla.org/users/bsmedberg_mozilla.com/hgpoller/index.cgi/rev/7b1f803a8b01
http://hg.mozilla.org/index.cgi/hg_templates/rev/faa27022b7de

Comment 34

[u88484]

Sorry that I don't know how what Ted posted is supposed to get applied but since its resolved fixed, I assumed I would see clickable bug numbers on hg.mozilla.org but I don't.  Can we just reopen this and resolve it once its verified that the bug numbers are clickable?

Comment 35

[(not currently active) Ted Mielczarek]

No. It's fixed in the repo, it needs to be deployed. I'll file that bug shortly.

Comment 36

[(not currently active) Ted Mielczarek]

Filed bug 448459 on getting this deployed.

Comment 37

[Dirkjan Ochtman (:djc)]

I do wonder, why not use interhg for this? What makes buglink.py better?

Comment 38

[Ed Lee :Mardak]

interhg uses "extend" modifier which can be used in places where replacing text with an anchor node is undesirable: titles or rss feeds. buglink lets us pick exactly which spots to replace with a buglink.