Project Information
- Name of tool/project: JsonConfig (extension)
- Project home page: https://www.mediawiki.org/wiki/Extension:JsonConfig
- Name of team requesting review: Charts task force
- Primary contact: @Jdlrobson (filling in for @Catrope)
- Target date for deployment: ???
- Link to code repository / patchset: https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/JsonConfig/+/refs/heads/master
- Link to scc output for general sizing of codebases (https://github.com/boyter/scc): TODO
Description of the tool/project:
The JsonConfig extension allows other extensions to store their configuration data as a JSON blob in a wiki page.
Description of how the tool will be used at WMF:
The extension has been deployed to Wikimedia production for 5+years but with the introduction of Charts it is seeing renewed usage.
In T369950, @mmartorana pointed out that the json-config extension hasn’t been reviewed in some time (T163827, 5 years ago). I recommend conducting an updated review, as it plays a critical role in input validation.
Has this project been reviewed before?
Yes
Working test environment
The extension and the service are deployed in the beta cluster.
- Example chart definition page (which is a JSON blob when you edit it, but appears as a chart when you view it): https://commons.wikimedia.beta.wmflabs.org/wiki/Data:1993_Canadian_federal_election.chart
- This uses the data from https://commons.wikimedia.beta.wmflabs.org/wiki/Data:1993_Canadian_federal_election.tab, which is a tabular data page. Tabular data pages are provided by the JsonConfig extension and are already available in production, see e.g. https://commons.wikimedia.org/wiki/Data:Election_results/May_2018_Ohio_Issue_1.tab
- For local testing, follow the instructions in the README file in the JsonConfig extension repo
Post-deployment
The Charts task force is responsible for this extension and is actively developing it. The main point of contact is Jon Robson (@Jdlrobson), who is filling in for Roan Kattouw (@Catrope)'s parental leave until late November / early December.