802586 - config.js.tmpl doesn't display keywords correctly anymore

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, defect)

Description

[Kohei Yoshino [:kohei]]

I'd like to retrieve the Bugzilla keywords such can be seen here:
https://bugzilla.mozilla.org/describekeywords.cgi

Comment 1

[Kohei Yoshino [:kohei]]

Oh I've got it...
https://bugzilla.mozilla.org/config.cgi?ctype=json

Comment 2

[Kohei Yoshino [:kohei]]

Nope, I mean https://bugzilla.mozilla.org/config.cgi
But anyway It doesn't have the keyword descriptions.

Comment 3

[Gervase Markham [:gerv]]

BzAPI can only give you what Bugzilla gives you. Bugzilla would need to be enhanced to provide this information.

Gerv

Comment 4

[David Lawrence [:dkl]]

Attachment: Patch to add keyword descriptions to config.js (v1)

Comment 5

[Gervase Markham [:gerv]]

Comment on attachment 674665 [details] [diff] [review]
Patch to add keyword descriptions to config.js (v1)

dkl: no config.cgi changes?

I don't quite get how this works now... config.cgi sets a "keywords" var, but config.js.tmpl seems to access a "keyword" var! Is it currently broken?

Gerv

Comment 6

[David Lawrence [:dkl]]

(In reply to Gervase Markham [:gerv] from comment #5)
> Comment on attachment 674665 [details] [diff] [review]
> Patch to add keyword descriptions to config.js (v1)
> 
> dkl: no config.cgi changes?
> 
> I don't quite get how this works now... config.cgi sets a "keywords" var,
> but config.js.tmpl seems to access a "keyword" var! Is it currently broken?
> 
> Gerv

Yes. Now that I did some research, config.js.tmpl as been broken wrt keywords since bug 690873 was committed. This patch fixes that issue as well it seems.

dkl

Comment 7

[Frédéric Buclin]

Note that config.cgi already provides all the information needed by BzAPI, see bug 690873. So the original request is WFM (or a dupe of 690873). Also, this patch will be of no help for BzAPI as BzAPI uses config.json.tmpl, not config.js.tmpl.

So I'm morphing this bug to fix the regression introduced by bug 690873.

Comment 8

[Frédéric Buclin]

Comment on attachment 674665 [details] [diff] [review]
Patch to add keyword descriptions to config.js (v1)

>+var keyword_descs = {
>+[% FOREACH k = keywords %]
>+  {
>+    name:        '[% k.name FILTER js %]',
>+    description: '[% k.description FILTER js %]',
>+  },
>+[% END %]
>+};

What we want is an arrayref of hashrefs, not a hashref of hashrefs. So please write

 var keyword_descs = [
   ...
 ]

on checkin. r=LpSolit with this fix.

Comment 9

[David Lawrence [:dkl]]

Fixed the brackets on commit.

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk
modified template/en/default/config.js.tmpl
Committed revision 8445.  

Committing to: bzr+ssh://[e-mail]/bugzilla/4.4
modified template/en/default/config.js.tmpl
Committed revision 8432.

dkl

Comment 10

[Gervase Markham [:gerv]]

Bug 805770 filed for the original request for BzAPI.

Gerv