Incidents/2019-12-10 Cite

document status: 
== Summary ==
In-progress Cite extension code unleashed a flood of "PHP notice" logspam. These were all non-fatal errors, but at approximately 3,000 per hour put a burden on human log-watchers. Hotfixes helped reducing the logspam, before the actual issue was found, fixed, and backported.
=== Impact ===
* The 1.35.0-wmf.8 train was delayed for several hours. Deployers had to spend extra time attempting hotfixes.
* References disappeared from <references /> sections on an unknown number of content pages across the cluster. This effect was limited to pages that displayed an error message before, or made clever use of failing parser functions to achieve certain effects.
=== Detection ===
 noticed an increase in errors while monitoring logspam-watch during train deployment.
== Timeline (European time) ==
2019-12-09
* 17:52 group2 wikis synchronized to 1.35.0-wmf.8
* New errors discovered: https://logstash.wikimedia.org/goto/7879febbadcb8071ada5cba301a5ec3f
* 18:01 group2 wikis reverted to 1.35.0-wmf.5
* 23:00 Attempt to redeploy wmf.8 with hotfix included.
2019-12-10
* 00:12 Some errors are still present. Try a second hotfix on debug server. Give up for now.
* 14:29 After investing hours, the QWERTY team fully understood the issue, fixed , cherry-picked, and backported it.
* 17:47 Third hotfix to harden the problematic code path even more.
== Conclusions ==
What weaknesses did we learn about and how can we address them?
The issue was a combination of several factors we never saw in any test or dev environment:
* Working with the Message class can cause it to request its own Parser, which is done with PHP's built-in clone command.
* This only happens if MessageCache hasn't been used yet in the requet. Hence the majority of the failures came from the API, as this is much more likely there.
* Cloning an object in PHP will "magically" clone all of its properties, no matter if declared or dynamically created.
* The Cite extension uses a dynamic property $parser->extCite to store its instance, holding all state.
* A hook takes care that the Cite object is cloned as well when the Parser is cloned.
* Since , the state was stored two levels deep, but cloning only performed a shallow copy.
* Cloning now resulted in two different Parsers with two different Cite instances that share the same state array.
* The fresh Message parser needs to clean its state, which cleans the state in all Cite instances. Hence all previously seen <ref> got lost.
* The loop currently rendering a non-empty <references /> section starts to access keys in an empty array.
* This only happens when there is a reason to render a Message in the middle of this loop, e.g. because of a bad <ref>, or a template that renders an error.
=== What went well? ===
* Very fruitful teamwork within the small QWERTY team.
* Even if the hotfixes just silenced effects of the issue without fixing it, they helped a lot narrowing the issue down.
* Very few reports from users, as far as we are aware of. Which means the impact was probably relatively small for most wikis.
=== What went poorly? ===
* The issue peaked in the middle of the night when the European QWERTY team is typically not available. It was more luck than anything that one of the devs was available.
* References were affected on a huge number of Czech Wikipedia pages, due to a template unique to that wiki triggering the Message-render edge case.
=== Where did we get lucky? ===
* One of the devs currently working on (but not owning) the codebase noticed the incident early.
* Hotfixes silenced the loud errors enough to be able to unblock the train, only leaving incompletely rendered pages behind.
* On most wikis, incomplete renderings were limited to pages that contained errors anyway, hence weren't widely noticed.
* Even then, incomplete rendering only happened "randomly" under very specific circumstances. Most notably when VisualEditor called the parser API.
=== How many people were involved in the remediation? ===
* 2 WMF and 1 WMDE staff at first, 4 WMDE staff later.
== Links to relevant documentation ==
This is a one-off bug, no specific documentation exists in case it happens again.
== Actionables ==
NOTE: Please add the #wikimedia-incident Phabricator project to these follow-up tasks and move them to the "follow-up/actionable" column.
* – Original error report about the "undefined index" log spam. Resolved.
* – User reporting incomplete rendering of references. Resolved.
* and – Two very different integration tests are now able to prevent this from happening again.
* – Extra time was spent on reworking the Cite codebase to not rely on cloning any more.
* – The QWERTY team will hold a retrospective meeting.