Page MenuHomePhabricator

[EPIC] Separate CategoryOverlay responsibilities and add unit tests
Closed, DeclinedPublic


CategoryOverlay contains a lot of glue code like most Overlays do. This in itself isn't inappropriate but it also touches many details which makes the code large, monolithic, and unwieldy to read, modify, and test. This task encompasses the work to break apart CategoryOverlay into separate view, gateway + marshaling, and overlay responsibilities as well as adding tests for each of these components to avoid regressions.

Some groundwork has been done in T191987:

While doing so we will add tests. This will give us much needed information on how to improve all our overlays going forward, while providing some much needed maintenance to the category overlay.

Understandably given the process with which the feature got made, the existing category feature in beta has no unit tests or browser tests. This is a prerequisite for putting any code to stable where we need to maintain it for millions of users and having confidence that it is serving there needs. Note that the redesign of categories may remove the need for some of these tests.

Sign off notes

  • CategoryOverlay has a sufficient level of unit test coverage
  • Some basic browser tests have been added for the viewing of categories (also possibly tabbing)

Developer notes

  • This will be easier once categories have been ported to webpack.

Event Timeline

Niedzielski created this task.
Restricted Application changed the subtype of this task from "Deadline" to "Task". · View Herald TranscriptSep 21 2018, 5:58 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Jdlrobson triaged this task as Lowest priority.Jan 3 2019, 10:55 PM
Jdlrobson moved this task from Incoming to Needs Prioritization on the Readers-Web-Backlog board.
Jdlrobson renamed this task from Separate CategoryOverlay responsibilities and add unit tests to [EPIC] Separate CategoryOverlay responsibilities and add unit tests.Jan 3 2019, 10:58 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson moved this task from Needs Prioritization to Epics/Goals on the Readers-Web-Backlog board.
Jdlrobson changed the task status from Open to Stalled.Jul 24 2020, 3:39 PM

Stalled on T246049

We will remove this code. See T246049.