Add-ons/QA/Testplan/Add-ons Post Reviews Process
Revision History
Date | Version | Author | Description |
---|---|---|---|
20/06/2017 | 1.0 | Valentina Virlics | Created first draft |
31/08/2017 | 2.0 | Valentina Virlics | Updated |
Contents
Overview
- Add-ons listed on AMO are all pre-reviewed by a team of employees and volunteers. This process creates problems with waiting times, especially for add-ons escalated for special review, leading to developers to choose self-hosting or not develop for Firefox at all.
- We aim to a post-review model (for WebExtensions), where they are approved and published - if they pass a series of automatic tests - and manually post-reviewed.
Goals
- Automatically approve WebExtensions without human intervention
- Decrease the waiting time for publishing a WebExtension or a WebExtension update to approximately 15 minutes. Currently, waiting times vary between a few hours to several weeks.
- Improve the value of user feedback channels (abuse reports, ratings on AMO) so they can be used to prioritize post-reviews.
- Better expose developers to documentation on add-on policies and rules during the submission process.
Entry Criteria
Current Status
- The feature is under development
Exit Criteria
- All related bugs triaged
- All blockers fixed
- All resolved bugs verified by QA
- Found-fixed bugs rate going down in time
Scope
what's in scope?
1. Deploy Auto-approval
- WebExtensions will continue to be submitted through the regular flow, and a command will be run regularly (~every hour) to evaluate and auto-approve some of them, based on criteria defined in the linked PRD.
2. Implement post-review queue for auto-approved add-ons
- Add-ons that are auto-approved will appear in the post-review queue from Reviewer Tools.
- List will contain: add-on name and version number (linking to the corresponding review page), last review (time since last manual review - in days), Flags and Weight (sorted after weight)
3. Changes to Reviewer Tools
- If the last review for an add-on was done manually or the user looking at the page doesn’t have the Addons:PostReview permission, show the current reviewer page.
- If the last review for an add-on was automatic and the user looking at the page has the Addons:PostReview permission, show the reviewer page with the following changes:
- Display recent user ratings (3 stars of fewer) and abuse reports (for the add-on or the developers, if there are any reports), with links to the full lists, below the add-on metadata and right above “More about this add-on”.
- The "Confirm Approval" resolution should be available, and shouldn’t display the form for comments and canned responses. Instead, it should only show the Save button. Confirming doesn’t send any information to the developer or change its status. It only records it so the last manually-approved version is used to calculate the code changes compared to the latest version.
- Reject Multiple Versions - should allow the reviewer to select a range of versions to reject (disable) with a single review message.
- Reviewer reply - should work the same as with regular reviews. (combined with the possibility of a more info request checkbox option).
- Requesting super-review - should increase weight if the add-on wasn’t flagged for super-review before.
- Adding a comment - should work the same as with regular reviews.
4. Post-review prioritization
- The post-review list will be sorted according to a weighted sum of the following risk factors:
- The add-on has the admin review flag.
- Flags raised by static validation after webextension submission: eval(), document.write(), setInterval/setTimeout (with a string, not a function), document.write, innerHTML, or a custom CSP;
- Size of code changed since last manual approval.
- User feedback obtained from abuse reports (for the add-on and the developers).
- User feedback obtained from ratings left on add-on listings.
- Add-on reputation, set by admin reviewers.
- Number of active users.
- Past rejection history.
Note: Add-on Reputation - is an admin-set override that helps rank down popular add-ons that are known to be high-quality and would generally rank higher due to code complexity and high volume of user feedback. This also includes add-ons developed by Mozilla. The reputation is an integer ranging between 0 and 3, that is set per-add-on, defaulting to 0.
5. Submission process updates
- The submission flow will have the following changes:
- New submissions should show the new Distribution Agreement/Review Policy with links to MDN .
- The last submission step should indicate the add-on will be available soon and not refer to waiting for review.
- After submission, the uploaded version should be publicly available on AMO within 15 minutes (probably less time than that).
- Check that the add-on status is appropriately updated in the Developer Hub.
- Check that the add-on appears in the auto-approval list (requires the tester to have the Addons:PostReview permission).
- Check the add-ons and weights to verify they are being calculated correctly based on the spec.
6. Remove auto-approval restrictions
- All WebExtension submissions will be post-reviewed after this point
what's out of scope?
- Add-ons/Webextensions functionality
Risks
- This is major change in the way we review add-ons. The security implications are significant, so getting security review and approval as early as possible will ensure this project won’t be delayed.
- The current reviewer team is trained to use the pre-review system, and are more familiar with legacy APIs than WebExtensions.
- A group of contractors is in process of being hired to help with WebExtension reviews, and they would be the first to handle the post-review process. Any delays in their on-boarding will lead to insufficient post-review staffing and higher security risk.
Ownership
Product Manager: Jorge Villalobos; irc nick :jorgev
QA Manager: Krupa Raj; irc nick :krupa
QA Lead: Victor Carciu; irc nick :victorc
Add-ons QA: Valentina Virlics; irc nick :ValentinaV
Requirements for testing
Environments
- Windows
- Mac OS
Servers
- Stage: https://addons.allizom.org/en-US/
- Dev: https://addons-dev.allizom.org/en-US/
- Production: https://addons.mozilla.org/en-US/
Channels
- Release
Test Strategy
Test Execution Schedule
The following table identifies the anticipated testing period available for test execution.
Project phase | Date | |
---|---|---|
Start project | 14.03.2017 | |
Study PRD/mocks received | 20.04.2017 | |
QA - Test plan creation | 20.06.2017 | |
QA - Test cases preparation | 01.08.2017 | |
QA - Test cases execution | 01.09.2017 | |
Release Date | 15.09.2017 |
Testing Tools
Process | Tool |
---|---|
Test plan creation | Mozilla wiki |
Test case creation | TestRail / Google doc |
Test case execution | TestRail |
Bugs management | Github |
References
- PRD - https://docs.google.com/document/d/1hVx-NbuVRc0wKXSdt8eHceObexY93YFzMXtqYC95nUs/edit
- Tracker bugs:
- Add-ons Auto Approvals test plan
- Implementation plan for Q2
- Post-review testing plan
- Post-review weights for prioritization
Testcases
Test Areas
- Review of extensions
Test suite
Full Test Suite.
Bug Work
Bug fix verification
Sign off
Criteria
Check list
- All test cases should be executed
- All blockers must be fixed and verified or have an agreed-upon timeline for being fixed