Ft/docx rendering, RE: #304 #347
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding support for a `public_file` query param so the OSF can request a public renderer. Added office365 which is a public renderer. This uses office online to do .docx file conversions.
Cleans up some imports that don't need to be qualified, or explicitly imports whatever resources the files need.
`markupsafe.escape(url)` is a little more informative to read than just `escape(url)`, so this reverts the change to use the former.
Long strings are better quotes with triple quotes so they're more readable, also has the nice effect of lettin strings that have other quotation marks in them not need to be escaped.
This changes th QueryParameterError to append a tuple to its attr stack rather than a list.
Added a clarifiaction on why the renderer won't work locally. The rendering service needs to access the file thatis to be rendered, and the url waterbutler gives the renderer is going to be inaccessible to the outside world, unless the developer configures waterbutler to use an externally accessible hostname/ip.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an update to #304
Ticket
https://openscience.atlassian.net/browse/SVCS-488
OSF side PR: CenterForOpenScience/osf.io#8002
Purpose
This ticket replaces #282. Credit goes to @AddisonSchiller 🎆🎆.
.docxrendering is very intensive on the OSF. By using Microsoft's online rendering service to render publicly available.docxfiles, we can remove a lot of pressure from theunoconvcontainer.Changes
public_filequery param. This query param is optional.public_file=Truedenotes that the file is public (the project it belongs to is public) , whilepublic_file=Falsedenotes that it is private. All other values forpublic_filecause errors to be raised.ProviderMetadatanow has anis_publicflag, with default value set toFalse.Side Effects
iframesandboxing may cause issue, need to verify on staging.QA Notes
The Office365 renderer does not use the
.pdfrenderer likeunoconvused to, so the pdfs that get made by this renderer may not display exactly the same. More QA notes to come. There is also aREADME.mdin the renderer with more information about testing.Deployment Notes