Create Task
Maniphest T171956

Allow PDF rendering to be triggered only by electron for single-article PDFs
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To
ABorbaWMF
Authored By
ovasileva
Jul 28 2017, 2:05 PM
Tags
Referenced Files
F9702279: Screen Shot 2017-09-21 at 4.56.31 PM.png
Sep 21 2017, 2:57 PM
F9702276: Screen Shot 2017-09-21 at 4.55.47 PM.png
Sep 21 2017, 2:57 PM
Subscribers
Aklapper
• bmansurov
gerritbot
Jdlrobson
• Nirzar
ovasileva
phuedx
ReleaseTaggerBot

Description

Background

When we remove OCG, Electron will be the only option on the selection screen

Acceptance Criteria

  • Remove OCG as a rendering option
  • Remove radio button from single-column option
  • Update https://www.mediawiki.org/wiki/Extension:ElectronPdfService
  • Remove all OCG backend logic from ElectronPDFService extension
  • Bump ElectronPDFService version as this is breaking change
  • Existing instrumentation for Special:ElectronPdf and rendering with the Electron rendering service remains intact

Workflow

tl;dr: https://wikimedia.invisionapp.com/share/WMDH1YGQD#/screens/253241970 (for guideline purposes only - when reviewing form does not need to look exactly like mock)

  1. User selects "Download as PDF".
  2. System displays selection screen with the following:
    • icon
    • heading: Download as PDF
    • article file name (name of article)
    • button: "Download"
  3. User selects "Download"
  4. The PDF download is triggered.

Notes

@phuedx: #6 of the workflow was:

  1. Once download is completed, system navigates user back to original article screen.

AFAIK this is impossible without using newer HTML5 APIs.

  • do not include spinner or back button

Verification steps

Details

SubjectRepoBranchLines +/-
Remove option to render books using OCGmediawiki/extensions/ElectronPdfServicemaster+61 -373
Customize query in gerrit

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
ovasileva changed the status of subtask T171957: [Spike 8hrs] How should the new print styles be applied to single-article ("save as PDF") PDFs? from Stalled to Open.Aug 30 2017, 4:23 PM
ovasileva added a project: Proton.Aug 30 2017, 5:43 PM
ovasileva moved this task from Triage to Needs Analysis on the Proton board.
ovasileva triaged this task as High priority.Aug 30 2017, 5:45 PM
ovasileva updated the task description. (Show Details)
ovasileva moved this task from Needs Analysis to Backlog on the Proton board.Sep 6 2017, 6:58 PM
Jdlrobson moved this task from Incoming to Needs Prioritization on the Web-Team-Backlog board.Sep 7 2017, 6:42 PM
Jdlrobson added subscribers: • bmansurov, Jdlrobson.

What exactly needs deploying here? ElectronPdf is already deployed to all wikis.

e.g.
https://en.wikipedia.org/w/index.php?title=Special:ElectronPdf&page=Holcobius+simulans&action=show-selection-screen&coll-download-url=%2Fw%2Findex.php%3Ftitle%3DSpecial%3ABook%26bookcmd%3Drender_article%26arttitle%3DHolcobius%2Bsimulans%26returnto%3DHolcobius%2Bsimulans%26oldid%3D609004067%26writer%3Drdf2latex

cc @bmansurov

• bmansurov added a comment.Sep 7 2017, 7:09 PM

Yes, this task looks like a duplicate of T165954: Allow electron to render single PDF's on all projects.

Jdlrobson closed this task as a duplicate of T165954: Allow electron to render single PDF's on all projects.Sep 7 2017, 7:16 PM
ovasileva added a comment.EditedSep 7 2017, 8:12 PM

@Jdlrobson, @bmansurov- Wait, I think it would be better to just change the title and keep this open. We will need to:

  • trigger electron download not from page with both options but directly from the print to pdf link
  • qa with new styles on production

Is there another task that reflects this?

ovasileva renamed this task from Deploy Electron PDF renderer for single-article PDFs to all projects to Allow PDF rendering to be triggered upon clicking "Print to PDF".Sep 7 2017, 8:13 PM
ovasileva reopened this task as Open.
ovasileva updated the task description. (Show Details)
• bmansurov added a comment.Sep 7 2017, 8:18 PM

I see. Then this task is different.

ovasileva moved this task from Needs Prioritization to Upcoming on the Web-Team-Backlog board.Sep 11 2017, 11:53 AM
ovasileva closed subtask T171957: [Spike 8hrs] How should the new print styles be applied to single-article ("save as PDF") PDFs? as Invalid.Sep 12 2017, 4:08 PM
ovasileva updated the task description. (Show Details)Sep 12 2017, 4:18 PM
ovasileva updated the task description. (Show Details)
• bmansurov updated the task description. (Show Details)Sep 13 2017, 2:19 PM
ovasileva added a comment.Sep 13 2017, 3:01 PM

@bmansurov - for the difference in renders - we'll get this as a part of T175166: Cleanup and update Electron PDF Service grafana board. We could also combine graphs 1 and 3 and 2 and 4 to have a direct comparison.

ovasileva added a comment.Sep 13 2017, 4:37 PM

@ovasileva - to change this task to removing the double-column option and radio button from original page.

ovasileva renamed this task from Allow PDF rendering to be triggered upon clicking "Print to PDF" to Allow PDF rendering to be triggered only by electron.Sep 13 2017, 4:42 PM
ovasileva mentioned this in T169757: Improve usability of "download as pdf" page .
ovasileva updated the task description. (Show Details)
ovasileva added a subscriber: • Nirzar.Sep 13 2017, 4:44 PM

@Nirzar - to add mockup and update to have all information available in T169757: Improve usability of "download as pdf" page

ovasileva updated the task description. (Show Details)Sep 14 2017, 11:47 AM
ovasileva closed subtask T169757: Improve usability of "download as pdf" page as Invalid.
ovasileva added a project: Readers-Web-Kanbanana-Board-Old.Sep 14 2017, 2:58 PM
ovasileva moved this task from Backlog to Current Sprint on the Proton board.Sep 14 2017, 3:49 PM
phuedx updated the task description. (Show Details)Sep 14 2017, 5:08 PM
phuedx subscribed.
ovasileva updated the task description. (Show Details)Sep 14 2017, 5:30 PM
ovasileva set the point value for this task to 5.
pmiazga updated the task description. (Show Details)Sep 14 2017, 5:32 PM
pmiazga updated the task description. (Show Details)
pmiazga updated the task description. (Show Details)Sep 14 2017, 5:35 PM
pmiazga updated the task description. (Show Details)
phuedx updated the task description. (Show Details)Sep 14 2017, 10:06 PM
ovasileva renamed this task from Allow PDF rendering to be triggered only by electron to Allow PDF rendering to be triggered only by electron for single-article PDFs.Sep 15 2017, 2:29 PM
ovasileva moved this task from Current Sprint to Backlog - Q2 on the Proton board.
ovasileva updated the task description. (Show Details)
phuedx added a comment.Sep 15 2017, 2:51 PM

@ovasileva: What's the rationale for ignoring the spinner/back button in T171956#3610576?

ovasileva added a comment.Sep 15 2017, 3:14 PM

@phuedx - we decided during standup that we'll build the page first so we can retire OCG asap and then continue with additions/improvements. I think @bmansurov had some concerns around adding new functionality to this page as it's based on very old code.

ovasileva moved this task from To Do to Needs Design Review on the Readers-Web-Kanbanana-Board-Old board.Sep 18 2017, 2:46 PM
ovasileva moved this task from Upcoming to 2017-18 Q1 on the Web-Team-Backlog board.Sep 19 2017, 3:48 PM
• bmansurov claimed this task.Sep 20 2017, 2:48 PM
• bmansurov moved this task from Needs Design Review to Doing on the Readers-Web-Kanbanana-Board-Old board.
gerritbot subscribed.Sep 20 2017, 6:21 PM

Change 379291 had a related patch set uploaded (by Bmansurov; owner: Bmansurov):
[mediawiki/extensions/ElectronPdfService@master] Remove the option to render books using OCG

https://gerrit.wikimedia.org/r/379291

gerritbot added a project: Patch-For-Review.Sep 20 2017, 6:21 PM
• bmansurov mentioned this in rEEPS7423ac3a7cc4: Remove the option to render books using OCG.Sep 20 2017, 6:25 PM
• bmansurov mentioned this in rEEPS28b2a479a242: WIP: Remove the option to render books using OCG.Sep 20 2017, 6:55 PM
• bmansurov added a comment.Sep 20 2017, 8:28 PM

@ovasileva on Wikipedias where OCG is disabled, the "Download as PDF" triggers a download immediately (as opposed to taking the user to Special:Book). Do we want to keep this behavior? This is something we need to keep in mind when removing OCG completely.

• bmansurov mentioned this in rEEPSaa37f7bb1fec: Remove the option to render books using OCG.Sep 20 2017, 8:29 PM
• bmansurov moved this task from Doing to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Sep 20 2017, 8:29 PM
• bmansurov moved this task from Needs Code Review to Doing on the Readers-Web-Kanbanana-Board-Old board.Sep 20 2017, 8:53 PM
ovasileva added a comment.EditedSep 21 2017, 12:09 PM

@bmansurov - no, that was our initial plan, but we would want the workflow from this task on all projects. i.e. completing this task would remove OCG from the UI on all projects and all projects will be forwarded to special:electronPDF

• bmansurov added a comment.EditedSep 21 2017, 12:38 PM

@ovasileva I think there's is a confusion here. Let me try again.

If you go to https://uz.wikipedia.org/wiki/Bosh_Sahifa and click on "Download as PDF", a PDF will be generated immediately. But doing so on enwiki takes the user to the Special:Book Special:ElectronPDF page. Which behavior do we want to keep in the long run?

ovasileva added a comment.EditedSep 21 2017, 2:57 PM

@bmansurov - now I'm a bit confused. Selecting "Download as PDF" on enwiki right now redirects to the selection screen which currently is Special:ElectronPDF:

Screen Shot 2017-09-21 at 4.56.31 PM.png (437×1 px, 63 KB)

Then, selecting two columns directs to Special: Book

Screen Shot 2017-09-21 at 4.55.47 PM.png (387×1 px, 114 KB)

I think this task was assuming that the changes would be applied in Special:ElectronPDF. Otherwise, we can delete the last page and make them in Special:Book

To confirm, however, selecting "download as PDF" should redirect to the selection screen for all projects.

• bmansurov added a comment.Sep 21 2017, 2:59 PM

Sorry, replace "Special:Book" with "Special:ElectronPDF" in my last comment.

ovasileva added a comment.Sep 21 2017, 3:01 PM

Cool, so yeah, this would be for all projects (including the ones that don't redirect to Special:ElectronPDF currently.

• bmansurov added a comment.Sep 21 2017, 3:18 PM

FYI, I've renamed 'Selection Screen' to 'Download Screen' in https://grafana-admin.wikimedia.org/dashboard/db/mediawiki-electronpdfservice?orgId=1 as there's no selection in the code anymore.

• bmansurov moved this task from Doing to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Sep 21 2017, 3:32 PM
• bmansurov mentioned this in rEEPSe2163f1d9c16: Remove option to render books using OCG.Sep 21 2017, 3:32 PM
• bmansurov mentioned this in rEEPSce388e31920e: Remove option to render books using OCG.Sep 21 2017, 3:37 PM
Jdlrobson moved this task from Needs Code Review to Needs More Work on the Readers-Web-Kanbanana-Board-Old board.Sep 25 2017, 6:56 PM

I've left some feedback on the patch !

• bmansurov moved this task from Needs More Work to Doing on the Readers-Web-Kanbanana-Board-Old board.Sep 25 2017, 7:03 PM
• bmansurov moved this task from Doing to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Sep 25 2017, 7:54 PM
• bmansurov mentioned this in rEEPSc84e2f579721: Remove option to render books using OCG.Sep 25 2017, 7:55 PM
Jdlrobson updated the task description. (Show Details)Sep 25 2017, 8:07 PM
• bmansurov mentioned this in T176755: Clean up OCG related code from ElectronPdfService once OCG is gone.Sep 26 2017, 2:57 PM
• bmansurov mentioned this in rEEPS296c6079fa48: Remove option to render books using OCG.Sep 26 2017, 2:58 PM
gerritbot added a comment.Sep 26 2017, 6:42 PM

Change 379291 merged by jenkins-bot:
[mediawiki/extensions/ElectronPdfService@master] Remove option to render books using OCG

https://gerrit.wikimedia.org/r/379291

Jdlrobson moved this task from Needs Code Review to Needs QA on the Readers-Web-Kanbanana-Board-Old board.Sep 26 2017, 6:45 PM
Jdlrobson updated the task description. (Show Details)Sep 26 2017, 6:48 PM
• bmansurov removed • bmansurov as the assignee of this task.Sep 26 2017, 6:59 PM
ReleaseTaggerBot added a project: MW-1.31-release-notes (WMF-deploy-2017-10-03 (1.31.0-wmf.2)).Sep 26 2017, 7:00 PM
Jdlrobson assigned this task to ABorbaWMF.Sep 28 2017, 5:07 PM

Over to you Anthony.

ABorbaWMF moved this task from Needs QA to Ready for Signoff on the Readers-Web-Kanbanana-Board-Old board.Sep 28 2017, 11:56 PM

Looks good on Beta. I tried a few articles and browsers. Only one option for PDF download.

ovasileva closed this task as Resolved.Oct 2 2017, 9:27 AM

looks good to me!

ovasileva added a comment.Oct 2 2017, 11:27 AM

Is this on the train? Or do we have to deploy it separately? @bmansurov, @Jdlrobson?

phuedx added a subscriber: ReleaseTaggerBot.Oct 2 2017, 11:34 AM

@ovasileva: Looking at the tag that @ReleaseTaggerBot added, this'll roll out with this week's train. If a task has had a lot of work done to it, then don't trust what @ReleaseTaggerBot is saying though 🙂

MBinder_WMF moved this task from 2017-18 Q1 to 2017-18 Q2 on the Web-Team-Backlog board.Mar 6 2018, 6:44 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits