rsconnect::writeManifest for Quarto content
#572
Merged
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
toph-allen
changed the base branch from
main
to
toph-remove-quarto-compatibility-shim-code
toph-allen
changed the title
rsconnect::writeManifest for Quarto contentrsconnect::writeManifest for Quarto content
toph-allen
force-pushed
the
toph-writeManifest-for-quarto-content
branch
from
583fdd7 to
052e689
Compare
Base automatically changed from
toph-remove-quarto-compatibility-shim-code
to
main
March 22, 2022 18:57
Quarto inspection - now is gated by passing in a full Quarto path - should also work for single quarto documents
# Conflicts: # R/deployApp.R
- move duplicated complex functions to an inferQuartoInfo function - “quarto” used to mean either the path to the executable or the ready-for-manifest list. Now, the list is referred to as “quartoInfo”, matching “pyInfo”. Lookup doesn’t happen in the same place as “pyInfo”, but naming is more consistent.
toph-allen
changed the title
rsconnect::writeManifest for Quarto contentrsconnect::writeManifest for Quarto content
|
CI should be fixed now. The check on Travis turned up an "unstated dependency" on Weird. |
|
In its current state, this gives all Quarto content the |
aronatkins
reviewed
Mar 28, 2022
aronatkins
approved these changes
Mar 28, 2022
R/bundle.R
Outdated
|
|
||
| # Extract the Quarto version and engines, either from a parsed "quarto inspect" | ||
| # result or from metadata provided by the quarto-r package. | ||
| getQuartoManifestDetails <- function(inspect = list(), metadata = list()) { |
There was a problem hiding this comment.
nit: I would prefer if this were split into two "constructor" functions, rather than one function that consumed the inputs differently depending upon what is present. Frankly, it might be simpler if the behavior were just inlined into inferQuartoInfo, but I don't feel strongly.
There was a problem hiding this comment.
Agreed. I'll inline it. I think that having two separate list() statements in two separate functions is a bit too much indirection.
|
If you don't have For # If quarto::quarto_path() doesn't find Quarto, you need to use the IDE quarto
QUARTO_PATH <- "/Applications/RStudio.app/Contents/MacOS/quarto/bin/quarto"
# Quarto content
rsconnect::writeManifest("quarto-book-none", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-doc-none", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-multidoc-proj-none", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-none", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-none-ojs", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-py", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-r", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-r-py", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-proj-r-shiny", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-website-none", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-website-py", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-website-r", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-website-r-py", quarto = QUARTO_PATH)
rsconnect::writeManifest("quarto-website-r-py-separate-files", quarto = QUARTO_PATH)
# Non-quarto content
rsconnect::writeManifest("rmd-shiny-runtime-shinyrmd-complete")
rsconnect::writeManifest("rmd-shiny-runtime-shinyrmd-simple")
rsconnect::writeManifest("rmd-site")
rsconnect::writeManifest("shinyapp")For # Assuming you have a server named "localhost" configured in the IDE / in the rsconnect package
server <- "localhost"
# If quarto::quarto_path() doesn't find Quarto, you need to use the IDE quarto
QUARTO_PATH <- "/Applications/RStudio.app/Contents/MacOS/quarto/bin/quarto"
# Quarto content
rsconnect::deployApp("quarto-book-none", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-doc-none", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-multidoc-proj-none", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-none", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-none-ojs", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-py", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-r", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-r-py", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-proj-r-shiny", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-website-none", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-website-py", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-website-r", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-website-r-py", quarto = QUARTO_PATH, server = server)
rsconnect::deployApp("quarto-website-r-py-separate-files", quarto = QUARTO_PATH, server = server)
# Non-quarto content
rsconnect::deployApp("rmd-shiny-runtime-shinyrmd-complete", server = server)
rsconnect::deployApp("rmd-shiny-runtime-shinyrmd-simple", server = server)
rsconnect::deployApp("rmd-site", server = server)
rsconnect::deployApp("shinyapp", server = server) |
- Added test for null Quarto on content that Quarto can’t render
Merged
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 draft PR adds Quarto support to
rsconnect::writeManifest. I think that some of the compatibility affordances should also be added torsconnect::deployApp, for consistency's sake.Intent
Add support for Quarto content to
rsconnect::writeManifest()and expands support inrsconnect::deployApp(). It adds support for Quarto documents with the following runtimes:It also adds partial support for Python-only Quarto projects, using the Jupyter engine. However, these manifests contain
packagesobjects listing R packages, and they should not.Approach
To avoid adding a dependency on the Quarto package, we call
quarto inspectourselves in a function namedquartoInspect(). We only attempt this if the user supplies aquartoparameter containing the full path to a Quarto executable.rsconnect::deployApp()continues to support deployment viaquarto::quarto_publish_app()viaquarto_versionandquarto_enginesfields onmetadataobjects. This information is only used if thequartopath is not supplied.Additions and changes to internal functions
inferQuartoInfo(appDir, appPrimaryDoc, quarto, metadata = NULL)quartoInspect().NULLandmetadatawas passed, attempts to find Quarto info in metadata.metadatadefaults to NULL becausemetadatadoesn't exist in some locations this function is called; it exists forquarto-rcompatibility indeployApp().getQuartoManifestDetails(inspect = list(), metadata = list())inspectormetadata, will return Quarto info ready for insertion into manifest.quartoInspect(appDir = NULL, appPrimaryDoc = null, quarto = NULL)quartois notNULL, attempts to callquarto inspectfirst onappDir, and if that fails (which it will for single documents), onappDir/appPrimaryDoc.inspectresults orNULL.Changes to main deployment functions
writeManifest()quartoparameter.inferQuartoInfo()early on. Results are assigned toquartoInfoobject, followingpyInfo. This is passed into otherinferfunctions, and then tocreateAppManifest.contentCategoryis provided, andquartoInfois notNULL, setscontentCategoryto"site", following current treatment of Quarto content.deployApp()quartoparameter.quartoparameter, along withmetadata, tobundleApp()bundleApp()quartoandmetadataparameters.inferQuartoInfo()etc. exactly likewriteManifest().Regarding the
deployApp()=>bundleApp()call chain, I decided to have theinferQuartoInfo()call occur withinbundleApp()because in many ways, that function is analogous towriteManifest(), and I thought that it would be much easier to maintain the shared parts of their code if replicated functionality looked the same, between them, rather than being spread betweendeployApp()andbundleApp(). But becausedeployApp()needs to support determining Quarto info frommetadata,bundleApp()had to gain it as an optional argument.In
bundle.R, the variable namequartowas used interchangeably to refer to a Quarto path or to the extracted Quarto info. It now uses the namequartoInfoanywhere that the object must be thequartoInfolist, and usesquartoanywhere it must be a path, and left that name in places where the code doesn't care (e.g.inferAppMode()just checks that the object is notNULL).Documentation
quartoparameter.on.failureparameter indeployAppto match its position in the function documentation.Testing & QA
quartoInspect(),inferQuartoInfo(), andwriteManifest()on Quarto content.writeManifest()tests, using cleaned up items fromconnect-content:quarto-doc-none,quarto-proj-r-shiny,quarto-website-py,quarto-website-r-py,quarto-website-r.The most direct way to validate these changes for a piece of content is to run
writeManifest()on a piece of content and examine the generated manifest. The changes in this PR only affect the output when the full path to a Quarto binary is passed to thequartoparameter (which doesn't exist in the version ofrsconnecton main). The easiest way to pass that binary requires you to have thequartoR package installed. You'll also want the latestrmarkdownandshinyinstalled. I don't think there will be any other dependencies — I've omitted the extra-dependency packages from the list below.If you see any other dependency errors from the content, you should just "install.packages()" them.
Inspecting
writeManifestchangesIf you work within the
connect-contentrepo, you can take advantage of git to directly diff the changes. The manifests of Quarto packages inconnect-contentwere generated with the IDE, so they aren't a direct comparison torsconnectmain.I've found that the easiest way to make direct comparisons is to work on a new local branch of
connect-contentThen, you can:mainversion ofrsconnect. Check out themainbranch; open thersconnect.Rrojproject in the IDE; click "Install" under the "Build" tab in the top-right pane.connect-contentrepo, runrsconnect::writeManifest()on all the content you want to check. Commit those changes to your local branch.For example, running R in the
bundlesdirectory ofconnect-content:Run this command again for the
appDirof each content bundle you want to examine. Commit all of the changes.rsconnect. Check out themainbranch; open thersconnect.Rrojproject in the IDE; click "Install" under the "Build" tab in the top-right pane. After you've reinstalled the dev version, you should quit and reopen all your R sessions.connect-contentrepo, in your new R session, runrsconnect::writeManifest()on all the content you want to check. Don't commit the changes.To examine the Quarto-mode changes, you'd run:
You could also run without the Quarto argument to ensure that nothing has changed.
git statusandgit diffto see what files have changed between the versions.If you run R from the
bundlesdirectory, you should be able to just runrsconnectfor all the bundles you want to check. I've included code snippets below.What To Look For
Compared to the
mainversion, you should see the following changes in thewriteManifesttests:quartoargument:rmd-staticas their appmode should getquarto-staticas their appmode.rmd-shinyas their appmode should getquarto-shinyas their appmode.quartoobject in withversionandengines.quartoargument, no changes should occur.For the
mainversion, run:For this branch, run:
Testing `deployApp()
The same code changes are used in
deployApp. You can run the following code snippet to deploy the listed content to Connect.Set your working directory to
connect-content/bundles, and open a fresh R session. Make sure the dev branch ofrsconnectis installed to your R library.Quarto content should show "Quarto *" under "Content Type".
Other things to test
deployApp()also uses the changed workflow. Deploying Quarto and non-quarto content should work the same, e.g.deployApp(appDir = "quarto-proj-r-shiny", quarto = quarto::quarto_path().quarto::quarto_publish_app()calls deployApp to deploy Quarto content. Instead of passing in aquartopath, it passes in ametadataobject. To test that this method of deployment still works, you can usequarto_publish_app()to publish some Quarto content (ensuring that it runs correctly on the server) or pass in a metadata object yourself.This code assumes that you have set up a local Connect dev instance as the server
localhostin R. You can do this in the RStudio IDE, under the "Publishing" section in preferences.Appendix: Performance experiments
One of the reasons we gated
quarto inspectbehind thequartoparameter is its performance impact: about little over half a second on average.plumberbundle, running vanillarsconnect::writeManifestafter initial package load takes about 0.45 seconds. Withquarto inspectit takes about 1.05 seconds. Runningquarto inspectat the command line takes about 0.58 seconds, so this tracks.quarto-website-r-pybundle, runningrsconnect::writeManifestwith a metadata option takes about 1.55 seconds (skips thequarto inspectcodepath).rsconnect::writeManifestwithquarto inspecttakes about 2.1 seconds. Again, a penalty of about 0.6 seconds, which corresponds to how longquarto inspecttakes to run.