runtime version scanner: organize files like an r package (#279)

* reorganize files

* update github action

* migrate to connectapi’s built-in get_usage

* Update extensions/runtime-version-scanner/.Rbuildignore

Co-authored-by: Kara Woo <[email protected]>

* Update extensions/runtime-version-scanner/DESCRIPTION

Co-authored-by: Kara Woo <[email protected]>

* Update DESCRIPTION

* update packaging workflow

---------

Co-authored-by: Kara Woo <[email protected]>

Author: toph-allen

.github/workflows/runtime-version-scanner.yml

@@ -42,7 +42,7 @@ jobs:
       - run: Rscript -e 'install.packages(c("testthat", "httptest"))'
         working-directory: extensions/${{ env.EXTENSION_NAME }}
 
-      - run: Rscript -e 'testthat::test_dir("tests/testthat")'
+      - run: Rscript -e 'testthat::test_local()'
         working-directory: extensions/${{ env.EXTENSION_NAME }}
 
       # Now that the extension is built we need to upload an artifact to pass
@@ -57,13 +57,12 @@ jobs:
           # Replace the below with the files your content needs
           path: |
             extensions/${{ env.EXTENSION_NAME }}/app.R
-            extensions/${{ env.EXTENSION_NAME }}/connect_module.R
-            extensions/${{ env.EXTENSION_NAME }}/get_usage.R
-            extensions/${{ env.EXTENSION_NAME }}/renv.lock
-            extensions/${{ env.EXTENSION_NAME }}/version_ordering.R
-            extensions/${{ env.EXTENSION_NAME }}/supported_versions.R
+            extensions/${{ env.EXTENSION_NAME }}/R/connect_module.R
+            extensions/${{ env.EXTENSION_NAME }}/R/supported_versions.R
+            extensions/${{ env.EXTENSION_NAME }}/R/version_ordering.R
             extensions/${{ env.EXTENSION_NAME }}/www/styles.css
             extensions/${{ env.EXTENSION_NAME }}/manifest.json
+            extensions/${{ env.EXTENSION_NAME }}/renv.lock
 
       # Package up the extension into a TAR using the package-extension action
       - uses: ./.github/actions/package-extension

extensions/runtime-version-scanner/.Rbuildignore

@@ -0,0 +1,5 @@
+^renv$
+^renv\.lock$
+^app\.R$
+^Makefile$
+^manifest\.json$

extensions/runtime-version-scanner/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to the Usage Metrics Dashboard extension will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1]
+
+### Added
+
+- Added CHANGELOG.md to the repo.
+- Reorganized code to use an R package-like structure.
+
+## [1.0.0]
+
+### Added
+
+- Initial release.

extensions/runtime-version-scanner/DESCRIPTION

@@ -0,0 +1,8 @@
+Package: runtime.version.scanner
+Title: Runtime Version Scanner
+Version: 1.0.1
+Authors@R: c(
+    person("Toph", "Allen", , "[email protected]", role = c("aut", "cre")),
+    person(given = "Posit, PBC", role = c("cph", "fnd")))
+Description: Functions to power the Runtime Version Scanner extension.
+License: MIT + file LICENSE

extensions/runtime-version-scanner/Makefile

@@ -1,7 +1,7 @@
 .PHONY: test update-manifest
 
 test:
-	Rscript -e 'testthat::test_dir("tests/testthat")'
+	Rscript -e 'testthat::test_local()'
 
 # This recipe updates the manifest, with a few helpful modifications:
 # - Copies over `extension` and `environment` blocks from the old manifest to

extensions/runtime-version-scanner/connect_module.R renamed to extensions/runtime-version-scanner/R/connect_module.R

@@ -92,7 +92,6 @@ connectVisitorClient <- function(
       }
     )
 
-    # “Use the ‘…’ Integration” button logic
     observeEvent(input$auto_add_integration, {
       auto_add_integration(publisher_client, selected_integration_guid())
       runjs("window.top.location.reload(true);")

extensions/runtime-version-scanner/supported_versions.R renamed to extensions/runtime-version-scanner/R/supported_versions.R

@@ -16,10 +16,8 @@ ANY_VERSION <- "999.99.99"
 
 plan(mirai_multisession)
 
-source("get_usage.R")
-source("connect_module.R")
-source("version_ordering.R")
-source("supported_versions.R")
+files.sources = list.files("R", full.names = TRUE)
+sapply(files.sources, source)
 
 options(
   spinner.type = 1,
@@ -48,6 +46,11 @@ app_mode_lookup <- with(
   setNames(as.character(ind), values)
 )
 
+to_iso8601 <- function(x) {
+  strftime(x, "%Y-%m-%dT%H:%M:%S%z") |>
+    sub("([+-]\\d{2})(\\d{2})$", "\\1:\\2", x = _)
+}
+
 # Shiny app definition
 
 ui <- page_sidebar(
@@ -400,7 +403,15 @@ server <- function(input, output, session) {
 
   usage_task <- ExtendedTask$new(function(window_days) {
     future({
-      get_usage(client, from = today() - days(window_days), to = today()) |>
+      from <- as.POSIXct(
+        paste(today() - days(window_days), "00:00:00"),
+        tz = ""
+      )
+      to <- as.POSIXct(paste(today(), "00:00:00"), tz = "")
+
+      usage_list <- get_usage(client, from = from, to = to)
+      as_tibble(usage_list) |>
+        select(content_guid) |>
         group_by(content_guid) |>
         summarize(views = n(), .groups = "drop")
     })