1066184 - data/params.js should be renamed to data/params.json since the data form is JSON and not JS

Status: RESOLVED FIXED

(Bugzilla :: Administration, task)

Description

[David Lawrence [:dkl]]

Something I should have caught earlier on in the review process but since it is not too late, is that the newly formatted data/params.js should be instead named data/params.json. The data contained inside is in JSON format and the standard extension name is .json

dkl

Comment 1

[David Lawrence [:dkl]]

Attachment: 1066184_1.patch

Comment 2

[Frédéric Buclin]

Comment on attachment 8488100 [details] [diff] [review]
1066184_1.patch

>--- a/Bugzilla/Config.pm

You forgot to fix the message when we delete the old data/params file:

  say "$old_file has been converted into $old_file.js, using the JSON format.";

It must say "into $old_file.json".


Also, as some installations already upgraded, such as landfill-tip or probably several developer installations, you must add code to update_params() to rename the already converted data/params.js into data/params.json. A trivial

  rename "$old_file.js", "$old_file.json" if -e "$old_file.js";

right before the call to read_param_file() will do it.


>--- a/template/en/default/admin/params/editparams.html.tmpl
>+++ b/template/en/default/admin/params/editparams.html.tmpl

>-   javascript_urls = ['js/params.js', 'js/util.js']
>+   javascript_urls = ['js/params.json', 'js/util.js']

This change must go away. js/params.js and data/params.js are two distinct files. :)


Everything else is fine.

Comment 3

[Frédéric Buclin]

(In reply to Frédéric Buclin from comment #2)

>   rename "$old_file.js", "$old_file.json" if -e "$old_file.js";

You could also write:

  rename "$old_file.js", "$old_file.json" if -e "$old_file.js" && !-e "$old_file.json";

to make sure that an unrelated params.js won't override an existing params.json in the future.

Comment 4

[David Lawrence [:dkl]]

Attachment: 1066184_2.patch

Comment 5

[Frédéric Buclin]

Comment on attachment 8488185 [details] [diff] [review]
1066184_2.patch

r=LpSolit

Comment 6

[David Lawrence [:dkl]]

To ssh://[e-mail]/bugzilla/bugzilla.git
   c11b241..84ec7f6  master -> master