ResourceLoader: Add support for packageFiles
authorRoan Kattouw <roan.kattouw@gmail.com>
Sat, 3 Nov 2018 00:53:17 +0000 (17:53 -0700)
committerKrinkle <krinklemail@gmail.com>
Tue, 5 Feb 2019 22:05:02 +0000 (22:05 +0000)
commitfbbd65d2df43f522f4deae71939ca10149488774
treea9fa0e26ee80b37c200026d6772e39bd3edee14b
parent7665ec56c75d96ac6b300635f5875ae495b41af8
ResourceLoader: Add support for packageFiles

Package files are files that are part of a module, but are not
immediately executed when the module executes. Instead, they are
lazy-excecuted when require() is called on them. Package files can be
scripts (JS) or data (JSON), and can be real files on the file system,
or virtual files generated by a callback.

Using virtual data files, server-side data and config variables can be
bundled with a module. Support for file-based require() allows us to
import npm modules into ResourceLoader more easily.

The require function passed to each script execution context, which was
previously a reference to the global mw.loader.require() function, is
changed to one that is scoped to the module and the file being executed.
This is needed to support relative paths: require( '../foo.js' ) can
mean a different file depending on the path of the calling file.

The results of require()ing each file (i.e. the value of module.exports
after executing it) are stored, and calling require() on the same file a
second time won't execute it again, but will return the stored value.

Miscellaneous changes:
- Add XmlJsCode::encodeObject(), which combines an associative array of
  XmlJsCode objects into one larger XmlJsCode object. This is needed for
  encoding the packageFiles parameter in mw.loader.implement() calls.

Bug: T133462
Change-Id: I78cc86e626de0720397718cd2bed8ed279579112
includes/XmlJsCode.php
includes/resourceloader/ResourceLoader.php
includes/resourceloader/ResourceLoaderFileModule.php
includes/resourceloader/ResourceLoaderModule.php
resources/src/startup/mediawiki.js
tests/phpunit/data/resourceloader/sample.json [new file with mode: 0644]
tests/phpunit/includes/XmlTest.php
tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php
tests/phpunit/includes/resourceloader/ResourceLoaderTest.php
tests/qunit/suites/resources/mediawiki/mediawiki.loader.test.js