Writing an extension for deployment

From MediaWiki.org
Jump to: navigation, search

This page documents instructions for writing a MediaWiki extension for deployment on Wikimedia wikis. Many people have written extensions that have been deployed to Wikimedia wikis.

The general workflow is:

Get community support for your idea[edit | edit source]

Community support can be shown by having an active discussion on the need of the extension on a wiki and documenting the responses. If there is no active community support, support can be built through discussions and proposals.

  • Post your idea to the wikitech-l mailing list to get feedback from experienced developers and Wikimedians
  • Communicate your ideas/plans to affected wikis to garner both support and suggestions/feedback

Get your design reviewed[edit | edit source]

Whether you have already written the extension or it's just an idea, you'll need a design review before your code is deployed. Chances are good that changes will be needed to your initial design to accommodate the overall product and UI goals as well as the technical realities of running your code on Wikimedia project sites. Changing your design is easier sooner rather than later so start looking for reviewers as soon as you can.

Product design review[edit | edit source]

For a product design review, talk to a Wikimedia Foundation product manager. This starts a conversation (and possibly testing) about the design of your feature, which should include community consensus on the wiki where the extension would be deployed. If the process stalls, forward your note to a product manager who can attempt to raise visibility in the biweekly product team discussions.

User experience design review[edit | edit source]

For user experience design review, e-mail the design mailing list. As you continue the conversation, you should use your judgment on whether to write code as you go, write some prototype code to aid in the discussion, or wait till the conversation's reached some consensus on user experience design.

Technical design review[edit | edit source]

E-mail the Wikimedia developers' mailing list for a technical design review. (If you don't get a response within a week, ask the Technical Contributor Coordinator for help.) The reviewer will check whether the idea would work with our existing code and architecture. They may point you to another extension that is already in use whose functionality duplicates what you want, or could be easily extended to do what you want. In that case, you should use Git to work on the extension that is already in use.

Setup your new project for development[edit | edit source]

Once your idea has been vetted by the community and is generally seen as a useful and practical addition, it's time to make sure you are setup for the process of developing within the MediaWiki projects.

  1. Sign up for developer access if you do not already have it.
  2. Create an Extension:My Extension page in the Extension: namespace on mediawiki.org documenting your extension for developers and for people who will install or configure the extension. The extension template is a good place to start.
  3. Create a Help:Extension:My Extension page in the Help:Extension: namespace on mediawiki.org for your extension's end user documentation. Cross-link it with the Extension:My Extension page above.
  4. Request a component in Bugzilla to track bugs and feature requests for your extension. You will be notified of all new bugs reported in the component.
  5. Request a new Gerrit repository to store the source code for your extension. This is where all code review will happen.
  6. Find an existing Labs project to join or request a new one to host a testing server with your extension deployed to it for testing and demonstrations.

Coding your extension[edit | edit source]

The developing extensions page contains a good overview of the parts needed in an extension. Read Coding conventions, Pre-commit checklist, Performance tuning, and Security for developers and make sure that your code follows these guidelines.

Localization[edit | edit source]

Your extension will need to be translated on Translatewiki before it can be deployed anywhere, and putting it in Git with the proper i18n files and such will make that happen fairly quickly.

Deployability and feature flags[edit | edit source]

The Wikimedia Foundation runs nearly a thousand wikis in hundreds of languages. When we deploy code on our cluster, we enable extensions on a wiki-by-wiki basis and often configure them differently for each one.

It is important that extensions have feature flags for turning particular behavior on and off, where that makes sense.

People will feel a lot more comfortable deploying an extension that does nothing until $wgMyExtensionLoadGun = true is set, and has a separate $wgMyExtensionPullTrigger = false flag.

This enables the extension to be deployed on a subset of wikis (for example, test and test2) without affecting all users.

Code review[edit | edit source]

You should try to get two or more trusted developers to follow your project in Gerrit and give you reviews. Find a couple of established MediaWiki developers to look over your code and point out any flaws in it. If you don't yet know any other MediaWiki developers, ask in IRC, or on the developers' mailing lists. They will help you find anything that doesn't have a chance of making it past the next step. Make sure they know you're trying to follow this guide. If they know you're trying to get your code deployed, they'll look for things that would block deployment.

Review for deployment[edit | edit source]

After your extension is basically complete, your code has been checked by a few developers and the issues have been resolved create a tracking bug in Bugzilla using this semi-prefilled form for the extension's deployment to Wikimedia wikis. This bug should only concern deployment itself; any sub-issues (that block deployment) should be separate bugs that are marked as "blocking" this bug.

Your deployment tracking bug should:

  • point to on-wiki community consensus for having the extension installed on a particular wiki, as necessary; and
  • indicate that the extension hasn't been deployed to a Wikimedia wiki yet and ask for a deployment review.

If you need help with that, poke the Bugwrangler.

Anything that is deployed on the Wikimedia cluster needs to be reviewed for security and scalability issues. Anyone in the group that owns the MediaWiki Gerrit project can perform a deployment review, so you can ask them directly, or you can ask the Engineering Community Manager to help you find a deployment reviewer. Track these requests by creating security and performance review bugs and marking them as blocking your deployment tracking bug.

Any issues that the deployment reviewers identify must be addressed before anyone can deploy your code on the cluster. If you've followed the advice of earlier reviewers closely, you probably won't have too much of a problem here. But the senior developers do their job very seriously, so they may well spot a show-stopper that eluded your earlier reviewers.

Deploy to beta cluster on Labs[edit | edit source]

Before enabling a new extension in production, it can be tested on the beta cluster. To do this, add the new extension to the mediawiki/extensions.git repo. It will be updated automatically.[FIXME: It?] It[FIXME: It?] uses the same wmf-config directory and repository as production, but in addition the beta cluster machines load InitialiseSettings-labs.php and CommonSettings-labs.php files so you can have settings that only apply to Labs. When testing on Labs before production, these can override wgUseMyExtension, setting it to true on one or more beta cluster wikis.

It is possible to deploy extensions that do not exist in production to the beta cluster. However, the beta cluster runs code only from the master branch in Git. You should merge code into the master branch early and often in order to exercise that code as fully as possible on the beta cluster before it goes out to the general public. If you have specific questions about using the beta cluster, you can e-mail the Quality Assurance mailing list or ask in #wikimedia-qa on IRC.

Schedule deployment[edit | edit source]

If everything appears ready for deployment, add the "shell" keyword to the bug (so that people with shell access can find the request). Coordinate with the release manager to add your extension deployment to the deployment calendar.

See also[edit | edit source]

Roan Kattouw's presentation on security.