wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-09-23 18:29:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups
1467 commits 270 branches 0 tags 63 MiB
JavaScript 83.4%
PHP 11.3%
Less 4.9%
Shell 0.4%
Go to file
jdlrobson a702c0f499 Capture page view-like interactions 
* New action added PREVIEW_SEEN
* The action will be used to signal that a page view needs
to be recorded.
* PREVIEW_SEEN is a delayed action which is triggered
as a side-effect of the previewShow action. It is only dispatched
if the user is still previewing the same card and the page
related to the card has preview type `page`
* The pageview changelistener is added when
$wgPopupsVirtualPageViews is set to true.
* The page view changelistener listens for page views and logs
them using EventLogging when needed using
https://meta.wikimedia.org/wiki/Schema:VirtualPageView

Note:
* Currently if a user has enabled the DNT header, the
event will not be logged. There is ongoing discussion on the
ticket and fixing this will be addressed separately.
* Only title and referrer are logged in the initial version.
The task demands that "namespace" is logged but this information
is not provided by the summary endpoints we use so will need
to be added later (if indeed needed) either via a change to that
endpoint of by using JavaScript to parse the URL.

Bug: T184793
Change-Id: Id1fe34e4bdada3a41f0d888a753af366d4756590
2018-02-16 23:03:33 +00:00
doc Docs: Fix typo in Grafana link label 2017-08-26 00:08:03 +01:00
i18n Localisation updates from https://translatewiki.net. 2018-02-15 22:47:18 +01:00
images BetaFeatures logo: Merge logo and title path 2017-11-28 10:30:37 -08:00
includes Capture page view-like interactions 2018-02-16 23:03:33 +00:00
resources Capture page view-like interactions 2018-02-16 23:03:33 +00:00
src Capture page view-like interactions 2018-02-16 23:03:33 +00:00
tests Capture page view-like interactions 2018-02-16 23:03:33 +00:00
.eslintrc.es5.json Run eslint on compiled assets to ensure code is es5 compatible 2017-09-07 12:30:33 +02:00
.eslintrc.json Limit line length to 80 characters 2018-01-19 14:20:39 +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
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 15.0.0 2017-12-30 02:19:18 +00:00
.stylelintrc.json build: Update linters 2018-02-04 22:09:45 +00:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 15:30:07 +04:30
composer.json build: Updating mediawiki/mediawiki-codesniffer to 16.0.0 2018-02-15 13:44:12 +00:00
COPYING Add COPYING file 2014-02-06 15:38:46 +05:30
extension.json Capture page view-like interactions 2018-02-16 23:03:33 +00:00
Gruntfile.js build: Always exclude vendor 2017-11-10 17:42:04 +00:00
jsdoc.json Generate docs inside doc folder 2017-05-30 10:16:57 -04:00
package-lock.json Updating mw-node-qunit to v3 2018-02-08 12:20:52 +01:00
package.json Updating mw-node-qunit to v3 2018-02-08 12:20:52 +01:00
Popups.php Hygiene: Update required MediaWiki version 2017-07-24 16:12:03 +02:00
README.md Add code coverage reports npm script 2017-03-03 13:34:33 +01:00
webpack.config.js Do not include @nomin instruction in dist build 2017-10-11 14:34:18 -07: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