wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-12 09:18:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups
1238 commits 279 branches 0 tags 65 MiB
JavaScript 84.7%
PHP 9.8%
Less 5%
Shell 0.5%
Go to file
Sam Smith 67eb3b1dcf i13n: Log EL events with mw.track 
Currently, the mw.eventLog.Schema class samples per pageview. However,
we expect that if a user is bucketed for a session, then all
EventLogging events logged during that session are in the sample.

Moreover, loading the class in the way that we did - asynchronously,
using mw.loader#using - introduced an issue where the eventLogging
change listener would subscribe in the next tick of the JavaScript VM's
event loop and miss the "pageLoaded" event being queued (see T167273).

Changes:
* Make the schema module follow the form of the statsvInstrumentation
  module, i.e. make it expose the #isEnabled method, and add the
  associated getEventLoggingTracker function.
* Update the eventLogging change listener accept the tracker returned by
  getEventLoggingTracker.
* Update/fix related JSDoc documentation.

Bug: T167236
Bug: T167273
Change-Id: I4f653bbaf1bbc2c2f70327e338080e17cd3443d4
2017-06-17 00:51:32 +00:00
doc Docs: Add ADR about using webpack's production mode and UglifyJS 2017-05-12 18:12:30 +02:00
i18n Localisation updates from https://translatewiki.net. 2017-06-12 22:43:32 +02:00
images Optimise SVGs with svgo 2017-04-26 17:15:45 +01:00
includes Implement html/rest.js gateway which handles HTML Restbase responses 2017-06-13 20:19:05 +02:00
resources i13n: Log EL events with mw.track 2017-06-17 00:51:32 +00:00
src i13n: Log EL events with mw.track 2017-06-17 00:51:32 +00:00
tests i13n: Log EL events with mw.track 2017-06-17 00:51:32 +00:00
.eslintrc.json Tooling: Begin to use webpack for JS code generation 2017-02-13 13:42:22 +01:00
.gitattributes Hygiene: Move build/ext.popups/ to src/ 2017-02-14 09:59:59 -08:00
.gitignore Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
.gitreview Merge remote-tracking branch 'gerrit/mpga' 2017-02-14 11:20:17 -08:00
.istanbul.yml Hygiene: Tidy up QUnit references 2017-05-04 15:53:44 +01:00
.stylelintrc Remove jshint/jscs, add eslint and stylelint 2016-12-16 13:35:34 +01:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 15:30:07 +04:30
composer.json Introduce PHPCS check in CI 2017-05-16 19:59:29 +02:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Implement html/rest.js gateway which handles HTML Restbase responses 2017-06-13 20:19:05 +02:00
Gemfile doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3 2017-05-23 05:33:31 +01:00
Gemfile.lock Hygiene: Remove RL-related step 2016-12-13 14:46:03 +00:00
Gruntfile.js Remove eslint:fix 2017-05-03 10:19:31 +01:00
jsdoc.json Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
package.json Test: Upgrade mw-node-qunit and use globs 2017-06-16 14:50:19 +02:00
phpcs.xml Introduce PHPCS check in CI 2017-05-16 19:59:29 +02:00
Popups.php Add extension.json, empty php entry point 2015-07-02 22:19:24 +00:00
README.md Add code coverage reports npm script 2017-03-03 13:34:33 +01:00
webpack.config.js Enable production settings for the production bundle 2017-05-11 10:37:45 +02:00

README.md

mediawiki/extensions/Popups

See https://www.mediawiki.org/wiki/Extension:Popups for more information about what it does.

Development

Popups uses an asset bundler so when developing for the extension you'll need to run a script to assemble the frontend assets.

You can find the frontend source files in src/, the compiled sources in resources/dist/, and other frontend assets managed by resource loader in resources/*.

After an npm install:

  • On one terminal, kickstart the bundler process:
    • npm start Will run the bundler in watch mode, re-assembling the files on file change.
    • npm run build Will compile the assets just once, ready for deployment. You must run this step before sending the patch or CI will fail (so that sources and built assets are in sync).
  • On another terminal, run tests and linting tools:
    • npm test To run the linting tools and the tests.
      • You can find the QUnit tests that depend on running MediaWiki under tests/qunit/
      • You can find the isolated QUnit tests under tests/node-qunit/, which you can run with npm run test:node
    • We recommend you install a file watcher like nodemon to watch sources and auto run linting and tests.
      • npm install -g nodemon
      • Example running linting and node unit tests:
        • nodemon -w src/ --exec "grunt lint:all && npm run test:node"
    • Get code coverage report with npm run coverage
      • Reports printed in the coverage/ folder