diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..6e5a53d --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,13 @@ +^pkgdown$ +^hotwater\.Rproj$ +^_pkgdown\.yml$ +^\.Rproj\.user$ +^\.github$ +^LICENSE\.md$ +^CODE_OF_CONDUCT\.md$ +^\.vscode$ +^vignettes/articles$ +^codecov\.yml$ +^\.lintr$ +^README\.Rmd$ +^TODO\.md$ diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..0f2fe08 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,52 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: R-CMD-check + +permissions: read-all + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true + build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")' diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 0000000..fefc52e --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,61 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: test-coverage + +permissions: read-all + +jobs: + test-coverage: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::covr, any::xml2 + needs: coverage + + - name: Test coverage + run: | + cov <- covr::package_coverage( + quiet = FALSE, + clean = FALSE, + install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") + ) + covr::to_cobertura(cov) + shell: Rscript {0} + + - uses: codecov/codecov-action@v4 + with: + fail_ci_if_error: ${{ github.event_name != 'pull_request' && true || false }} + file: ./cobertura.xml + plugin: noop + disable_search: true + token: ${{ secrets.CODECOV_TOKEN }} + + - name: Show testthat output + if: always() + run: | + ## -------------------------------------------------------------------- + find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true + shell: bash + + - name: Upload test results + if: failure() + uses: actions/upload-artifact@v4 + with: + name: coverage-test-failures + path: ${{ runner.temp }}/package diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f3efe36 --- /dev/null +++ b/.gitignore @@ -0,0 +1,52 @@ +# History files +.Rhistory +.Rapp.history + +# Session Data files +.RData +.RDataTmp + +# User-specific files +.Ruserdata + +# Example code in package build process +*-Ex.R + +# Output files from R CMD build +/*.tar.gz + +# Output files from R CMD check +/*.Rcheck/ + +# RStudio files +.Rproj.user/ + +# produced vignettes +vignettes/*.html +vignettes/*.pdf + +# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 +.httr-oauth + +# knitr and R markdown default cache directories +*_cache/ +/cache/ + +# Temporary files created by R markdown +*.utf8.md +*.knit.md + +# R Environment Variables +.Renviron + +# pkgdown site +docs/ + +# translation temp files +po/*~ + +# RStudio Connect folder +rsconnect/ + +# debug files +.fuse_hidden* diff --git a/.lintr b/.lintr new file mode 100644 index 0000000..75c558e --- /dev/null +++ b/.lintr @@ -0,0 +1,9 @@ +linters: linters_with_defaults( + line_length_linter(120), + implicit_integer_linter(), + indentation_linter(indent = 4L), + object_name_linter(styles = c("snake_case", "symbols"), regexes = character()), + object_name_linter = NULL + ) +exclusions: list("man/", "inst/", "src/", ".vscode/", ".Rproj.user/", "R/import-standalone-obj-type.R", "R/import-standalone-types-check.R") +encoding: "UTF-8" diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..cc572b9 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,29 @@ +Package: hotwater +Title: autoreload plumber APIs +Version: 0.0.0.9002 +Authors@R: + person("Elian", "Thiele-Evans", , "elianhte@gmail.com", role = c("aut", "cre"), + comment = c(ORCID = "0000-0001-8008-3165")) +Description: What the package does (one paragraph). +License: GPL (>= 3) +URL: https://github.com/ElianHugh/hotwater +BugReports: https://github.com/ElianHugh/hotwater/issues +Imports: + cli, + httpuv, + httr2, + nanonext, + mirai, + plumber, + utils +Suggests: + box, + docopt, + remotes, + testthat (>= 3.0.0), + xml2, + withr +Config/testthat/edition: 3 +Encoding: UTF-8 +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.1 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..175443c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,595 @@ +GNU General Public License +========================== + +_Version 3, 29 June 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and other +kinds of works. + +The licenses for most software and other practical works are designed to take away +your freedom to share and change the works. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change all versions of a +program--to make sure it remains free software for all its users. We, the Free +Software Foundation, use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General +Public Licenses are designed to make sure that you have the freedom to distribute +copies of free software (and charge for them if you wish), that you receive source +code or can get it if you want it, that you can change the software or use pieces of +it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or +asking you to surrender the rights. Therefore, you have certain responsibilities if +you distribute copies of the software, or if you modify it: responsibilities to +respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, +you must pass on to the recipients the same freedoms that you received. You must make +sure that they, too, receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: **(1)** assert +copyright on the software, and **(2)** offer you this License giving you legal permission +to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is +no warranty for this free software. For both users' and authors' sake, the GPL +requires that modified versions be marked as changed, so that their problems will not +be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of +the software inside them, although the manufacturer can do so. This is fundamentally +incompatible with the aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we have designed +this version of the GPL to prohibit the practice for those products. If such problems +arise substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom of +users. + +Finally, every program is threatened constantly by software patents. States should +not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that patents +applied to a free program could make it effectively proprietary. To prevent this, the +GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact copy. The +resulting work is called a “modified version” of the earlier work or a +work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on +the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for infringement under +applicable copyright law, except executing it on a computer or modifying a private +copy. Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that **(1)** +displays an appropriate copyright notice, and **(2)** tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form of a +work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of interfaces +specified for a particular programming language, one that is widely used among +developers working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that **(a)** is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and **(b)** serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code form. +A “Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on which +the executable work runs, or a compiler used to produce the work, or an object code +interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the +source code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. However, +it does not include the work's System Libraries, or general-purpose tools or +generally available free programs which are used unmodified in performing those +activities but which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for the work, and +the source code for shared libraries and dynamically linked subprograms that the work +is specifically designed to require, such as by intimate data communication or +control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of copyright on the +Program, and are irrevocable provided the stated conditions are met. This License +explicitly affirms your unlimited permission to run the unmodified Program. The +output from running a covered work is covered by this License only if the output, +given its content, constitutes a covered work. This License acknowledges your rights +of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey covered +works to others for the sole purpose of having them make modifications exclusively +for you, or provide you with facilities for running those works, provided that you +comply with the terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for you must do so +exclusively on your behalf, under your direction and control, on terms that prohibit +them from making any copies of your copyrighted material outside their relationship +with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological measure under any +applicable law fulfilling obligations under article 11 of the WIPO copyright treaty +adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention +of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of +technological measures to the extent such circumvention is effected by exercising +rights under this License with respect to the covered work, and you disclaim any +intention to limit operation or modification of the work as a means of enforcing, +against the work's users, your or third parties' legal rights to forbid circumvention +of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you receive it, in any +medium, provided that you conspicuously and appropriately publish on each copy an +appropriate copyright notice; keep intact all notices stating that this License and +any non-permissive terms added in accord with section 7 apply to the code; keep +intact all notices of the absence of any warranty; and give all recipients a copy of +this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer +support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to produce it from +the Program, in the form of source code under the terms of section 4, provided that +you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified it, and giving a +relevant date. +* **b)** The work must carry prominent notices stating that it is released under this +License and any conditions added under section 7. This requirement modifies the +requirement in section 4 to “keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this License to anyone who +comes into possession of a copy. This License will therefore apply, along with any +applicable section 7 additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no permission to license the +work in any other way, but it does not invalidate such permission if you have +separately received it. +* **d)** If the work has interactive user interfaces, each must display Appropriate Legal +Notices; however, if the Program has interactive interfaces that do not display +Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are +not by their nature extensions of the covered work, and which are not combined with +it such as to form a larger program, in or on a volume of a storage or distribution +medium, is called an “aggregate” if the compilation and its resulting +copyright are not used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work in an aggregate +does not cause this License to apply to the other parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of sections 4 and +5, provided that you also convey the machine-readable Corresponding Source under the +terms of this License, in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by the Corresponding Source fixed on a +durable physical medium customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by a written offer, valid for at least +three years and valid for as long as you offer spare parts or customer support for +that product model, to give anyone who possesses the object code either **(1)** a copy of +the Corresponding Source for all the software in the product that is covered by this +License, on a durable physical medium customarily used for software interchange, for +a price no more than your reasonable cost of physically performing this conveying of +source, or **(2)** access to copy the Corresponding Source from a network server at no +charge. +* **c)** Convey individual copies of the object code with a copy of the written offer to +provide the Corresponding Source. This alternative is allowed only occasionally and +noncommercially, and only if you received the object code with such an offer, in +accord with subsection 6b. +* **d)** Convey the object code by offering access from a designated place (gratis or for +a charge), and offer equivalent access to the Corresponding Source in the same way +through the same place at no further charge. You need not require recipients to copy +the Corresponding Source along with the object code. If the place to copy the object +code is a network server, the Corresponding Source may be on a different server +(operated by you or a third party) that supports equivalent copying facilities, +provided you maintain clear directions next to the object code saying where to find +the Corresponding Source. Regardless of what server hosts the Corresponding Source, +you remain obligated to ensure that it is available for as long as needed to satisfy +these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are being +offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A “User Product” is either **(1)** a “consumer product”, which +means any tangible personal property which is normally used for personal, family, or +household purposes, or **(2)** anything designed or sold for incorporation into a +dwelling. In determining whether a product is a consumer product, doubtful cases +shall be resolved in favor of coverage. For a particular product received by a +particular user, “normally used” refers to a typical or common use of +that class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the continued +functioning of the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for +use in, a User Product, and the conveying occurs as part of a transaction in which +the right of possession and use of the User Product is transferred to the recipient +in perpetuity or for a fixed term (regardless of how the transaction is +characterized), the Corresponding Source conveyed under this section must be +accompanied by the Installation Information. But this requirement does not apply if +neither you nor any third party retains the ability to install modified object code +on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to +continue to provide support service, warranty, or updates for a work that has been +modified or installed by the recipient, or for the User Product in which it has been +modified or installed. Access to a network may be denied when the modification itself +materially and adversely affects the operation of the network or violates the rules +and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with +this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. Additional +permissions that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may be +used separately under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when you +modify the work.) You may place additional permissions on material, added by you to a +covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed by works +containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that +modified versions of such material be marked in reasonable ways as different from the +original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or authors of the +material; or +* **e)** Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that material by anyone +who conveys the material (or modified versions of it) with contractual assumptions of +liability to the recipient, for any liability that these contractual assumptions +directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you received +it, or any part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms of +that license document, provided that the further restriction does not survive such +relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in +the relevant source files, a statement of the additional terms that apply to those +files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements apply +either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly provided under +this License. Any attempt otherwise to propagate or modify it is void, and will +automatically terminate your rights under this License (including any patent licenses +granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated **(a)** provisionally, unless and until the +copyright holder explicitly and finally terminates your license, and **(b)** permanently, +if the copyright holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, this +is the first time you have received notice of violation of this License (for any +work) from that copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify to +receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run a copy of the +Program. Ancillary propagation of a covered work occurring solely as a consequence of +using peer-to-peer transmission to receive a copy likewise does not require +acceptance. However, nothing other than this License grants you permission to +propagate or modify any covered work. These actions infringe copyright if you do not +accept this License. Therefore, by modifying or propagating a covered work, you +indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically receives a license +from the original licensors, to run, modify and propagate that work, subject to this +License. You are not responsible for enforcing compliance by third parties with this +License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an organization, or +merging organizations. If propagation of a covered work results from an entity +transaction, each party to that transaction who receives a copy of the work also +receives whatever licenses to the work the party's predecessor in interest had or +could give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or +affirmed under this License. For example, you may not impose a license fee, royalty, +or other charge for exercise of rights granted under this License, and you may not +initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging +that any patent claim is infringed by making, using, selling, offering for sale, or +importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus +licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, that +would be infringed by some manner, permitted by this License, of making, using, or +selling its contributor version, but do not include claims that would be infringed +only as a consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant patent +sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license +under the contributor's essential patent claims, to make, use, sell, offer for sale, +import and otherwise run, modify and propagate the contents of its contributor +version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent (such as an +express permission to practice a patent or covenant not to sue for patent +infringement). To “grant” such a patent license to a party means to make +such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of charge +and under the terms of this License, through a publicly available network server or +other readily accessible means, then you must either **(1)** cause the Corresponding +Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner consistent with +the requirements of this License, to extend the patent license to downstream +recipients. “Knowingly relying” means you have actual knowledge that, but +for the patent license, your conveying the covered work in a country, or your +recipient's use of the covered work in a country, would infringe one or more +identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a patent +license to some of the parties receiving the covered work authorizing them to use, +propagate, modify or convey a specific copy of the covered work, then the patent +license you grant is automatically extended to all recipients of the covered work and +works based on it. + +A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on the +non-exercise of one or more of the rights that are specifically granted under this +License. You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which you make +payment to the third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties who would receive +the covered work from you, a discriminatory patent license **(a)** in connection with +copies of the covered work conveyed by you (or copies made from those copies), or **(b)** +primarily for and in connection with specific products or compilations that contain +the covered work, unless you entered into that arrangement, or that patent license +was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot convey a covered work so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not convey it at all. For example, if you +agree to terms that obligate you to collect a royalty for further conveying from +those to whom you convey the Program, the only way you could satisfy both those terms +and this License would be to refrain entirely from conveying the Program. + +### 13. Use with the GNU Affero General Public License + +Notwithstanding any other provision of this License, you have permission to link or +combine any covered work with a work licensed under version 3 of the GNU Affero +General Public License into a single combined work, and to convey the resulting work. +The terms of this License will continue to apply to the part which is the covered +work, but the special requirements of the GNU Affero General Public License, section +13, concerning interaction through a network will apply to the combination as such. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in spirit +to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that +a certain numbered version of the GNU General Public License “or any later +version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by the +Free Software Foundation. If the Program does not specify a version number of the GNU +General Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU +General Public License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no +additional obligations are imposed on any author or copyright holder as a result of +your choosing to follow a later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE +OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided above cannot be +given local legal effect according to their terms, reviewing courts shall apply local +law that most closely approximates an absolute waiver of all civil liability in +connection with the Program, unless a warranty or assumption of liability accompanies +a copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to +the public, the best way to achieve this is to make it free software which everyone +can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them +to the start of each source file to most effectively state the exclusion of warranty; +and each file should have at least the “copyright” line and a pointer to +where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this +when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate parts of +the General Public License. Of course, your program's commands might be different; +for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, if any, to +sign a “copyright disclaimer” for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +<>. + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider it +more useful to permit linking proprietary applications with the library. If this is +what you want to do, use the GNU Lesser General Public License instead of this +License. But first, please read +<>. diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..5986ed5 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,5 @@ +# Generated by roxygen2: do not edit by hand + +export(install_hotwater) +export(run) +export(uninstall_hotwater) diff --git a/R/cli.R b/R/cli.R new file mode 100644 index 0000000..e8cdd41 --- /dev/null +++ b/R/cli.R @@ -0,0 +1,37 @@ +cli_welcome <- function() { + v <- utils::packageVersion("hotwater") # nolint: object_usage_linter. + cli::cli_h1("{.pkg hotwater} v{v}") +} + +cli_goodbye <- function() { + cli::cli_h2("{.pkg hotwater} turned off") +} + +cli_watching_directory <- function(engine) { + dirs <- c(engine$config$entry_dir, engine$config$dirs) # nolint: object_usage_linter. + cli::cli_inform("Watching {.file {dirs}} for changes...") +} + +cli_file_changed <- function(changes) { + cli::cli_alert("{.file {changes}} changed!") +} + +cli_server_start_progress <- function(engine) { + cli::cli_progress_step( + msg = "Starting plumber server on {.url {engine$config$host}:{engine$config$port}}", + msg_done = "Server running on {.url {engine$config$host}:{engine$config$port}}", + msg_failed = "Unable to start server on {.url {engine$config$host}:{engine$config$port}}", + spinner = TRUE, + .envir = parent.frame(n = 1L) + ) +} + +cli_server_stop_progress <- function() { + cli::cli_progress_step( + msg = "Awaiting runner stop...", + msg_done = "Stopped runner", + msg_failed = "Unable to stop runner", + spinner = TRUE, + .envir = parent.frame(n = 1L) + ) +} diff --git a/R/config.R b/R/config.R new file mode 100644 index 0000000..61244cc --- /dev/null +++ b/R/config.R @@ -0,0 +1,78 @@ +# handle all config here to pass to engine +# including defaults, config files, etc + +new_config <- function(...) { + dots <- list(...) + + host <- dots$host %||% + plumber::get_option_or_env("plumber.host") %||% + "127.0.0.1" + port <- dots$port %||% + plumber::get_option_or_env("plumber.port") %||% + new_port(host = host) + ignore <- dots$ignore %||% + utils::glob2rx( + paste0( + c("*.sqlite", "*.git*"), + collapse = "|" + ) + ) + + structure( + list( + entry_path = dots$path, + entry_dir = dirname(dots$path), + dirs = dots$dirs, + host = host, + port = port, + socket_port = new_port( + used = port, + host = host + ), + ignore = ignore, + runner_compute = "hotwater_runner" + ), + class = c("hotwater_config", "list") + ) +} + +validate_config <- function(config) { + stopifnot(is_config(config)) + + if (!file.exists(config$entry_path) || dir.exists(config$entry_path)) { + error_invalid_path(config$entry_path) + } + + if (!is.null(config$dirs) && any(!dir.exists(config$dirs))) { + invalid <- config$dirs[!dir.exists(config$dirs)] + error_invalid_dir(invalid) + } + + if (!is.numeric(config$port)) { + error_invalid_port(config$port) + } + + if (is.numeric(config$host)) { + error_invalid_host(config$host) + } +} + +#' it's possible to duplicate the port when it isn't immediately used +#' this just makes sure we end up with a different number... +#' @noRd +new_port <- function(used, host = "127.0.0.1") { + out <- NULL + if (missing(used)) { + out <- httpuv::randomPort(host = host, n = 100L) + } else { + repeat { + out <- httpuv::randomPort(host = host, n = 100L) + if (out != used) break + } + } + out +} + +is_config <- function(x) { + "hotwater_config" %in% class(x) +} \ No newline at end of file diff --git a/R/engine.R b/R/engine.R new file mode 100644 index 0000000..e3e2984 --- /dev/null +++ b/R/engine.R @@ -0,0 +1,87 @@ +new_engine <- function(config) { + stopifnot(is_config(config)) + structure( + list2env( + list( + runner = NULL, + config = config, + publisher = nanonext::socket( + protocol = "pub", + listen = sprintf( + "ws://%s:%s", + config$host, + config$socket_port + ), + autostart = TRUE + ) + ) + ), + class = c("hotwater_engine", "environment") + ) +} + +run_engine <- function(engine) { + callback <- function(changes) { + cli_file_changed(changes) + teardown_engine(engine) + buildup_engine(engine) + } + on.exit({ + teardown_engine(engine) + }) + + cli_welcome() + buildup_engine(engine) + + current_state <- directory_state( + c( + engine$config$entry_dir, + engine$config$dirs + ), + engine$config$ignore + ) + + repeat { + Sys.sleep(0.05) + current_state <- watch_directory( + engine, + current_state, + callback + ) + } +} + +kill_engine <- function(engine) { + stopifnot(is_engine(engine)) + kill_runner(engine) +} + +buildup_engine <- function(engine) { + stopifnot(is_engine(engine)) + + cli_server_start_progress(engine) + res <- new_runner(engine) + if (!res) { + cli::cli_progress_done(result = "failed") + } else { + publish_browser_reload(engine) + cli::cli_progress_done() + } + cli_watching_directory(engine) +} + +teardown_engine <- function(engine) { + stopifnot(is_engine(engine)) + + cli_server_stop_progress() + resp <- kill_engine(engine) + if (isTRUE(resp)) { + cli::cli_process_done() + } else { + cli::cli_progress_done(result = "failed") + } +} + +is_engine <- function(x) { + "hotwater_engine" %in% class(x) +} \ No newline at end of file diff --git a/R/errors.R b/R/errors.R new file mode 100644 index 0000000..b41d6b8 --- /dev/null +++ b/R/errors.R @@ -0,0 +1,59 @@ +new_hotwater_error <- function(type) { + sprintf("hotwater_%s_error", type) +} + +new_hotwater_warning <- function(type) { + sprintf("hotwater_%s_warning", type) +} + +error_invalid_path <- function(path) { + cli::cli_abort( + "Invalid path: {.file {path}}", + class = new_hotwater_error("invalid_path") + ) +} + +error_invalid_dir <- function(dir) { + cli::cli_abort( + "Invalid directory: {.file {dir}}", + class = new_hotwater_error("invalid_dir") + ) +} + +error_invalid_port <- function(port) { + cli::cli_abort( + "Invalid port: {port}", + class = new_hotwater_error("invalid_port") + ) +} + +error_invalid_host <- function(host) { + cli::cli_abort( + "Invalid host: {.url {host}}", + class = new_hotwater_error("invalid_host") + ) +} + +error_already_installed <- function(path) { + cli::cli_abort( + "{.pkg hotwater} already exists at {.file {path}}", + class = new_hotwater_error("install") + ) +} + +error_cannot_uninstall <- function(path) { + cli::cli_abort( + c( + "Could not uninstall {.pkg hotwater}.", + "*" = "Check that R has permissions to remove {.pkg hotwater} from {.path {path}}" + ), + class = new_hotwater_error("uninstall") + ) +} + +warning_not_installed <- function(path) { + cli::cli_warn( + "{.pkg hotwater} is not installed at {.path {path}}", + class = new_hotwater_warning("not_installed") + ) +} diff --git a/R/middleware.R b/R/middleware.R new file mode 100644 index 0000000..7f5796c --- /dev/null +++ b/R/middleware.R @@ -0,0 +1,63 @@ +injection <- function(engine) { + system.file("middleware", "injection.html", package = "hotwater", mustWork = TRUE) |> + readLines() |> + paste0(collapse = "\n") |> + sprintf(engine$publisher$listener[[1L]]$url) +} + +middleware <- function(engine) { + js <- injection(engine) + hook <- postserialise_hotwater(js) + function(pr) { + pr |> + # remove hotwater from the api spec + plumber::pr_set_api_spec(function(spec) { + spec$paths[["/__hotwater__"]] <- NULL + spec + }) |> + # the dummy path is needed for pinging the server from hotwater + plumber::pr_get( + "/__hotwater__", function() "running", + serializer = plumber::serializer_text(), + preempt = "__first__" + ) |> + plumber::pr_hook("postserialize", hook) + } +} + +postserialise_hotwater <- function(js) { + function(value) { + if (length(value$error) > 0L) { + return(value) + } + if (grepl("text/html", value$headers[["Content-Type"]])) { + value$headers[["Cache-Control"]] <- "no-cache" + value$body <- c(value$body, js) |> + paste0(collapse = "\n") + } + value + } +} + +publish_browser_reload <- function(engine) { + # at the moment, the message itself is largely meaningless because we're faking the + # protocol on the javascript side of things + # may be worth getting a minimal protocol working down the line on the JS side so we can send + # specific messages to the browser + nanonext::send(engine$publisher, "start") +} + +is_plumber_running <- function(engine) { + tryCatch( + expr = { + url <- sprintf("localhost:%s/__hotwater__", engine$config$port) + res <- httr2::request(url) |> + httr2::req_perform() |> + httr2::resp_status() + res == 200L + }, + error = function(e) { + FALSE + } + ) +} diff --git a/R/mirai.R b/R/mirai.R new file mode 100644 index 0000000..c047181 --- /dev/null +++ b/R/mirai.R @@ -0,0 +1,74 @@ +new_runner <- function(engine) { + stopifnot(is_engine(engine)) + + mirai::daemons( + n = 1L, + dispatcher = FALSE, + resilience = FALSE, + autoexit = get_kill_signal(), + output = TRUE, + .compute = engine$config$runner_compute + ) + + port <- engine$config$port + path <- engine$config$entry_path + mdware <- middleware(engine) + mod <- file.path(getwd(), engine$config$entry_path) + host <- engine$config$host + + engine$runner <- mirai::mirai( + { + if (requireNamespace("box", quietly = TRUE)) { + box::set_script_path(mod) + } + plumber::pr(path) |> + mdware() |> + plumber::pr_run( + port = port, + host = host, + quiet = TRUE, + debug = TRUE + ) + }, + .args = list( + port = port, + path = path, + host = host, + mdware = mdware, + mod = mod + ), + .compute = engine$config$runner_compute + ) + + i <- 0L + timeout <- 1000L + + while (i < timeout && is_runner_alive(engine) && !is_plumber_running(engine)) { + i <- i + 1L + try(cli::cli_progress_update(.envir = parent.frame(n = 1L)), silent = TRUE) + Sys.sleep(0.1) + } + + if (i == timeout && !is_plumber_running(engine)) { + return(FALSE) + } + + TRUE +} + +kill_runner <- function(engine) { + stopifnot(is_engine(engine)) + mirai::daemons(0L, .compute = engine$config$runner_compute) + !is_runner_alive(engine) +} + +is_runner_alive <- function(engine) { + stopifnot(is_engine(engine)) + mirai::unresolved(engine$runner) +} + +get_kill_signal <- function() { + tools::SIGKILL %|NA|% + tools::SIGTERM %|NA|% + tools::SIGINT +} diff --git a/R/run.R b/R/run.R new file mode 100644 index 0000000..16c2065 --- /dev/null +++ b/R/run.R @@ -0,0 +1,48 @@ +#' Start hotwater engine +#' +#' @description +#' Start a hotwater engine, which launches a plumber API that is restarted whenever +#' the plumber API's folder is modified. +#' +#' Extra directories can be specified to refresh the API when directories other than the plumber folder are modified. +#' +#' If a plumber endpoint returns an html response, when hotwater refreshes the API, hotwater will also order +#' a refresh of any webpage that is using the API. +#' +#' @param path path to plumber file +#' @param dirs extra directories to watch +#' @param port port to launch API on, defaults to `httpuv::randomPort()` +#' @param host host to launch API on, defaults to "127.0.0.1" +#' @param ignore vector of files or file extensions to ignore (globs) +#' +#' @examples +#' if (interactive()) { +#' hotwater::run(system.file("examples", "plumber.R", package = "hotwater")) +#' } +#' +#' @export +run <- function(path, dirs = NULL, port = NULL, host = NULL, ignore = NULL) { + config <- new_config( + path = path, + dirs = dirs, + port = port, + host = host, + ignore = ignore + ) + validate_config(config) + old <- hotwater$engine + if (!should_reuse_engine(old$config, config)) { + hotwater$engine <- new_engine(config) + } + run_engine(hotwater$engine) +} + +should_reuse_engine <- function(old_config, config) { + old_exists <- !is.null(old_config) + same_path <- identical(old_config$entry_path, config$entry_path) + same_dirs <- identical(old_config$dirs, config$dirs) + same_port <- identical(old_config$port, config$port) || is.null(config$port) + same_host <- identical(old_config$host, config$host) || is.null(config$host) + same_ignore <- identical(old_config$ignore, config$ignore) || is.null(config$ignore) + old_exists && same_path && same_port && same_dirs && same_host && same_ignore +} diff --git a/R/script.R b/R/script.R new file mode 100644 index 0000000..46eff55 --- /dev/null +++ b/R/script.R @@ -0,0 +1,101 @@ +common_install_paths <- list( + unix = c( + "~/.local/bin/", + "~/bin/", + "/usr/bin/", + "/usr/local/bin/", + "/bin/" + ), + windows = c() # does windows even work with this? +) + +#' WORK IN PROGRESS +#' @param install_folder folder (in PATH) to install hotwater +#' @export +install_hotwater <- function(install_folder = "~/.local/bin/") { + p <- file.path(install_folder, "hotwater") + + if (file.exists(p)) { + error_already_installed(p) + } + + success <- file.symlink( + from = system.file("exec", "hotwater", package = "hotwater"), + to = p + ) + + if (success) { + cli::cli_alert_success("Successfully installed {.pkg hotwater}!") + } else { + error_cannot_uninstall(install_folder) + } +} + +#' WORK IN PROGRESS +#' @param install_folder folder (in PATH) to uninstall hotwater +#' @export +uninstall_hotwater <- function(install_folder = "~/.local/bin/") { + p <- file.path(install_folder, "hotwater") + if (file.exists(p)) { + success <- file.remove(p) + if (success) { + cli::cli_alert_success("Successfully uninstalled {.pkg hotwater}") + } else { + error_cannot_uninstall(install_folder) + } + } else { + warning_not_installed(install_folder) + } +} + +#' Check suggested packages for CLI usage +#' +#' The {docopt} and {remotes} packages are required to run hotwater from the command line. +#' +#' @noRd +check_suggests <- function() { + suggests <- c("docopt") + for (suggestion in suggests) { + if (!requireNamespace(suggestion, quietly = TRUE)) { + cli::cli_abort( + c( + "Running {.pkg hotwater} from the command-line requires the {.pkg {suggestion}} package", + "*" = "Try running {.code install.packages('{suggestion}')}" + ), + call = globalenv() + ) + } + } +} + +#' Run hotwater as a bash script +#' @noRd +run_cli <- function() { + doc <- "hotwater + + Usage: + hotwater --file=FILE [--dirs=DIRS] [--port=PORT] [--host=SERVER] + hotwater -h | --help + hotwater -v | --version + + Options: + -h --help show help text + -v --version show hotwater version + -f FILE --file=FILE plumber path (required) + -d DIRS --dirs=DIRS extra directories + -p PORT --port=PORT plumber port + -s SERVER --server=SERVER plumber host + " + + args <- docopt::docopt( + doc, + version = as.character(utils::packageVersion("hotwater")) + ) + + run( + path = args$file, + dirs = args$dirs, + port = if (is.null(args$port)) NULL else as.numeric(args$port), + host = args$server + ) +} diff --git a/R/utils.R b/R/utils.R new file mode 100644 index 0000000..caf79c7 --- /dev/null +++ b/R/utils.R @@ -0,0 +1,9 @@ +`%nin%` <- Negate(`%in%`) + +`%||%` <- function(x, y) { + if (is.null(x)) y else x +} + +`%|NA|%` <- function(x, y) { + if (is.na(x)) y else x +} \ No newline at end of file diff --git a/R/watcher.R b/R/watcher.R new file mode 100644 index 0000000..39b0b9f --- /dev/null +++ b/R/watcher.R @@ -0,0 +1,34 @@ +watch_directory <- function(engine, current_state, callback) { + paths <- c( + engine$config$entry_dir, + engine$config$dirs + ) + next_state <- directory_state(paths, engine$config$ignore) + changed_files <- get_changed_files(current_state, next_state) + if (did_files_change(changed_files)) { + callback(changed_files) + return(next_state) + } + current_state +} + +get_changed_files <- function(current_state, next_state) { + new <- names(next_state[names(next_state) %nin% names(current_state)]) + removed <- names(current_state[names(current_state) %nin% names(next_state)]) + modified <- names(next_state[next_state %nin% current_state]) + unique(c(new, removed, modified)) +} + +did_files_change <- function(changed_files) { + length(changed_files) > 0L +} + +directory_state <- function(paths, ignore_pattern) { + res <- file.info( + list.files(paths, full.names = TRUE, recursive = TRUE, all.files = TRUE), + extra_cols = FALSE + ) + res <- res[grep(pattern = ignore_pattern, x = row.names(res), invert = TRUE), ] + res <- res[res$size > 0L, ] + stats::setNames(res$mtime, row.names(res)) +} diff --git a/R/zzz.R b/R/zzz.R new file mode 100644 index 0000000..fef93ed --- /dev/null +++ b/R/zzz.R @@ -0,0 +1,6 @@ +.onLoad <- function(...) { + ns <- asNamespace("hotwater") + if (is.null(ns[["hotwater"]])) { + ns[["hotwater"]] <- new.env(parent = ns) + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b6f377 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ + + +# hotwater + + + +[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) +[![Codecov test coverage](https://codecov.io/gh/ElianHugh/hotwater/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ElianHugh/hotwater?branch=main) +[![R-CMD-check](https://github.com/ElianHugh/hotwater/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ElianHugh/hotwater/actions/workflows/R-CMD-check.yaml) + + + +- for plumber development +- autoreload for plumber +- also auto-refreshes the browser when a change is made +- run from the commandline with the `/exec/hotwater` bash script + +## Installation + +You can install the development version of hotwater from +[GitHub](https://github.com/) with: + +```r +# install.packages("devtools") +devtools::install_github("ElianHugh/hotwater") +``` + +## Example + +Hotwater can be run via an R session: + +```r +hotwater::run( + system.file("examples", "plumber.R", package = "hotwater"), + port = 9999L +) +``` + +```r +✔ Server running on <127.0.0.1:9999> [17ms] +→ Watching ./path/to/ for changes... +``` + +or a terminal using the bash script: + +```sh +hotwater -f my/plumber/api.R -p 9999 +``` + +```r +✔ Server running on <127.0.0.1:9999> [17ms] +→ Watching ./path/to/ for changes... +``` diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..bb97b75 --- /dev/null +++ b/TODO.md @@ -0,0 +1,17 @@ +# TODO + +## 1 + +- Cannot pass a plumber router to hotwater + +## 2 + +- Updating CSS shouldn't typically cause a refresh + +## 3 + +- Look at using NNG js side for more advances msg passing + +## 4 + +- The CLI messages are a bit all over the place, and errors don't always cause the progress bar to fail diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..04c5585 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,14 @@ +comment: false + +coverage: + status: + project: + default: + target: auto + threshold: 1% + informational: true + patch: + default: + target: auto + threshold: 1% + informational: true diff --git a/exec/hotwater b/exec/hotwater new file mode 100644 index 0000000..0ce2275 --- /dev/null +++ b/exec/hotwater @@ -0,0 +1,9 @@ +#!/usr/bin/env Rscript + +if (!requireNamespace("hotwater", quietly = TRUE)) { + cli::cli_inform("Bootstrapping hotwater...") + remotes::install_github("ElianHugh/hotwater") +} + +hotwater:::check_suggests() +hotwater:::run_cli() diff --git a/hotwater.Rproj b/hotwater.Rproj new file mode 100644 index 0000000..fd8dd28 --- /dev/null +++ b/hotwater.Rproj @@ -0,0 +1,22 @@ +Version: 1.0 + +RestoreWorkspace: No +SaveWorkspace: No +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 4 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +AutoAppendNewline: Yes +StripTrailingWhitespace: Yes +LineEndingConversion: Posix + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace diff --git a/inst/examples/plumber.R b/inst/examples/plumber.R new file mode 100644 index 0000000..f612fe1 --- /dev/null +++ b/inst/examples/plumber.R @@ -0,0 +1,5 @@ +#' @get / +#' @serializer html +function() { + "Hello world." +} diff --git a/inst/middleware/injection.html b/inst/middleware/injection.html new file mode 100644 index 0000000..0884d8b --- /dev/null +++ b/inst/middleware/injection.html @@ -0,0 +1,15 @@ + diff --git a/man/install_hotwater.Rd b/man/install_hotwater.Rd new file mode 100644 index 0000000..169ca29 --- /dev/null +++ b/man/install_hotwater.Rd @@ -0,0 +1,14 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/script.R +\name{install_hotwater} +\alias{install_hotwater} +\title{WORK IN PROGRESS} +\usage{ +install_hotwater(install_folder = "~/.local/bin/") +} +\arguments{ +\item{install_folder}{folder (in PATH) to install hotwater} +} +\description{ +WORK IN PROGRESS +} diff --git a/man/run.Rd b/man/run.Rd new file mode 100644 index 0000000..3e7c973 --- /dev/null +++ b/man/run.Rd @@ -0,0 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/run.R +\name{run} +\alias{run} +\title{Start hotwater engine} +\usage{ +run(path, dirs = NULL, port = NULL, host = NULL, ignore = NULL) +} +\arguments{ +\item{path}{path to plumber file} + +\item{dirs}{extra directories to watch} + +\item{port}{port to launch API on, defaults to \code{httpuv::randomPort()}} + +\item{host}{host to launch API on, defaults to "127.0.0.1"} + +\item{ignore}{vector of files or file extensions to ignore (globs)} +} +\description{ +Start a hotwater engine, which launches a plumber API that is restarted whenever +the plumber API's folder is modified. + +Extra directories can be specified to refresh the API when directories other than the plumber folder are modified. + +If a plumber endpoint returns an html response, when hotwater refreshes the API, hotwater will also order +a refresh of any webpage that is using the API. +} +\examples{ +if (interactive()) { + hotwater::run(system.file("examples", "plumber.R", package = "hotwater")) +} + +} diff --git a/man/uninstall_hotwater.Rd b/man/uninstall_hotwater.Rd new file mode 100644 index 0000000..6994000 --- /dev/null +++ b/man/uninstall_hotwater.Rd @@ -0,0 +1,14 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/script.R +\name{uninstall_hotwater} +\alias{uninstall_hotwater} +\title{WORK IN PROGRESS} +\usage{ +uninstall_hotwater(install_folder = "~/.local/bin/") +} +\arguments{ +\item{install_folder}{folder (in PATH) to uninstall hotwater} +} +\description{ +WORK IN PROGRESS +} diff --git a/tests/testthat.R b/tests/testthat.R new file mode 100644 index 0000000..96e5aa4 --- /dev/null +++ b/tests/testthat.R @@ -0,0 +1,12 @@ +# This file is part of the standard setup for testthat. +# It is recommended that you do not modify it. +# +# Where should you do additional test configuration? +# Learn more about the roles of various files in: +# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview +# * https://testthat.r-lib.org/articles/special-files.html + +library(testthat) +library(hotwater) + +test_check("hotwater") diff --git a/tests/testthat/_snaps/middleware.md b/tests/testthat/_snaps/middleware.md new file mode 100644 index 0000000..0fe2f60 --- /dev/null +++ b/tests/testthat/_snaps/middleware.md @@ -0,0 +1,7 @@ +# middleware injection works + + Code + injection(dummy_engine) + Output + [1] "" + diff --git a/tests/testthat/helpers.R b/tests/testthat/helpers.R new file mode 100644 index 0000000..ae5f912 --- /dev/null +++ b/tests/testthat/helpers.R @@ -0,0 +1,12 @@ +new_test_engine <- function() { + new_engine( + new_config( + path = system.file("examples", "plumber.R", package = "hotwater") + ) + ) +} + +cleanup_test_engine <- function(engine) { + kill_engine(engine) + close(engine$publisher) +} diff --git a/tests/testthat/test-cli.R b/tests/testthat/test-cli.R new file mode 100644 index 0000000..dfeb76e --- /dev/null +++ b/tests/testthat/test-cli.R @@ -0,0 +1,6 @@ +test_that("startup/teardown messages don't error", { + engine <- new_test_engine() + expect_no_error(suppressMessages(buildup_engine(engine))) + expect_no_error(suppressMessages(teardown_engine(engine))) + cleanup_test_engine(engine) +}) diff --git a/tests/testthat/test-config.R b/tests/testthat/test-config.R new file mode 100644 index 0000000..e4318ae --- /dev/null +++ b/tests/testthat/test-config.R @@ -0,0 +1,6 @@ +test_that("config is validated", { + bad <- new_config( + path = "." + ) + expect_error(validate_config(bad)) +}) diff --git a/tests/testthat/test-engine.R b/tests/testthat/test-engine.R new file mode 100644 index 0000000..341fe0d --- /dev/null +++ b/tests/testthat/test-engine.R @@ -0,0 +1,31 @@ +test_that("engine reuse", { + engine <- new_engine( + new_config( + path = "./foo/bar.R", + dirs = "./R", + host = "127.0.0.1" + ) + ) + expect_true( + should_reuse_engine( + old = engine$config, + new_config( + dirs = engine$config$dirs, + path = engine$config$entry_path, + port = engine$config$port, + host = engine$config$host, + ignore = engine$config$ignore + ) + ) + ) + cleanup_test_engine(engine) +}) + +test_that("can kill engine", { + engine <- new_test_engine() + new_runner(engine) + expect_true(is_runner_alive(engine)) + kill_engine(engine) + expect_false(is_runner_alive(engine)) + cleanup_test_engine(engine) +}) diff --git a/tests/testthat/test-middleware.R b/tests/testthat/test-middleware.R new file mode 100644 index 0000000..0a04086 --- /dev/null +++ b/tests/testthat/test-middleware.R @@ -0,0 +1,82 @@ +test_that("middleware injection works", { + dummy_engine <- list( + publisher = list( + listener = list( + list(url = 1234L) + ) + ) + ) + expect_snapshot(injection(dummy_engine)) + fn <- middleware(dummy_engine) + router <- fn(plumber::pr()) + expect_s3_class(router$routes$`__hotwater__`, "PlumberEndpoint") + expect_identical( + router$`.__enclos_env__`$private$hooks$postserialize[[1L]], + postserialise_hotwater(injection(dummy_engine)) + ) +}) + +test_that("middleware injection works with filters", { + engine <- new_test_engine() + runner <- mirai::mirai( + { + plumber::pr(config$entry_path) |> + plumber::pr_filter("foo", function(req, res) { + stop("I break things") + }) |> + middleware_filter() |> + plumber::pr_run(port = config$port) + }, + config = engine$config, + middleware_filter = middleware(engine), + .compute = engine$config$runner_compute + ) + + i <- 1L + while (i < 20L && !is_plumber_running(engine)) { + i <- i + 1L + Sys.sleep(0.5) + } + + resp <- httr2::request(sprintf("localhost:%s/__hotwater__", engine$config$port)) |> + httr2::req_perform() |> + httr2::resp_status() + + expect_identical(resp, 200L) + cleanup_test_engine(engine) +}) + +test_that("is_plumber_running works", { + engine <- new_test_engine() + router <- mirai::mirai( + { + plumber::pr(config$entry_path) |> + plumber::pr_get( + "/__hotwater__", + function() "running", + serializer = plumber::serializer_text() + ) |> + plumber::pr_run(port = config$port) + }, + config = engine$config, + .compute = engine$config$runner_compute + ) + i <- 1L + while (i < 20L && !is_plumber_running(engine)) { + i <- i + 1L + Sys.sleep(0.5) + } + kill_runner(engine) + expect_lt(i, 20L, label = "loop iterations") + cleanup_test_engine(engine) +}) + +test_that("autoreloader is attached", { + engine <- new_test_engine() + new_runner(engine) + resp <- httr2::request(sprintf("localhost:%s", engine$config$port)) |> + httr2::req_perform() |> + httr2::resp_body_html() + expect_true(grepl(resp, pattern = "