1451911 - Action argument schemas published to NPM should include a JSON formatted version

Status: RESOLVED FIXED

(Firefox :: Normandy Client, enhancement, P1)

Description

[Michael Cooper [:mythmon]]

In bug 1440777, I added a set of schemas for local actions in Normandy. These are used by the code to verify the data sent from the server for each action. They are also intended to be used by the server to help validate user input and catch errors sooner. To facilitate this, the schemas are published to NPM.

However, the schemas are published as Javascript files, and the server is written in Python. Although it may be possible to deal with this on the server, it will be much easier to simply publish the schemas in JSON format, which they are anyways. This bug covers publishing a JSON version of the schemas.

This work blocks preference rollout.

Comment 1

[Michael Cooper [:mythmon]]

Attachment: Bug 1451911 - Publish action argument schemas as JSON

Review commit: https://reviewboard.mozilla.org/r/234258/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/234258/

Comment 2

[Code Review Bot [:reviewbot]]

Comment on attachment 8965489 [details]
Bug 1451911 - Publish action argument schemas as JSON

https://reviewboard.mozilla.org/r/234258/#review239890


Code analysis found 3 defects in this patch:
 - 3 defects found by mozlint

You can run this analysis locally with:
 - `./mach lint path/to/file` (JS/Python)


If you see a problem in this automated review, please report it here: http://bit.ly/2y9N9Vx


::: toolkit/components/normandy/actions/schemas/export_json.js:8
(Diff revision 1)
> +/**
> + * This script exports the schemas from this package in JSON format, for use by
> + * other tools. It is run as a part of the publishing process to NPM.
> + */
> +
> +const fs = require("fs");

Error: 'require' is not defined. [eslint: no-undef]

::: toolkit/components/normandy/actions/schemas/export_json.js:9
(Diff revision 1)
> + * This script exports the schemas from this package in JSON format, for use by
> + * other tools. It is run as a part of the publishing process to NPM.
> + */
> +
> +const fs = require("fs");
> +const schemas = require("./index.js");

Error: 'require' is not defined. [eslint: no-undef]

::: toolkit/components/normandy/actions/schemas/index.js:22
(Diff revision 1)
>      }
>    }
>  };
>  
> -if (this.exports) {
> -  this.exports = ActionSchemas;
> +if (typeof module !== "undefined") {
> +  module.exports = ActionSchemas;

Error: 'module' is not defined. [eslint: no-undef]

Comment 3

[Michael Cooper [:mythmon]]

Comment on attachment 8965489 [details]
Bug 1451911 - Publish action argument schemas as JSON

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/234258/diff/1-2/

Comment 4

[Robert Helmer [:rhelmer]]

Comment on attachment 8965489 [details]
Bug 1451911 - Publish action argument schemas as JSON

https://reviewboard.mozilla.org/r/234258/#review239898

lgtm! I'm not sure offhand what the magic incantation is to get eslint to ignore `require` and `module`, I think `/* global require, module */` might do it.

Comment 5

[Michael Cooper [:mythmon]]

Peter: I've published 0.2.0 to NPM with the changes from this bug. You should be able to access the schemas as JSON from the NPM package now.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/119611f33837
Publish action argument schemas as JSON r=rhelmer

Comment 7

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/119611f33837