Merge pull request #1932 from Fred-Wu/feat/session-aware-plot-viewer

Feat/session aware plot viewer

Author: Fred-Wu

.github/workflows/main.yml

@@ -20,6 +20,8 @@ concurrency:
 
 jobs:
   test:
+    env:
+      VSCR_REQUIRE_PLOT_TESTS: '1'
     strategy:
       fail-fast: false
       matrix:
@@ -43,9 +45,29 @@ jobs:
       - name: Verify managed tool consent
         run: pnpm run test:tool-consent
       - name: Install R test dependencies
-        run: install.packages(c("remotes", "pkgbuild", "languageserver", "lintr", "styler", "renv"))
+        uses: r-lib/actions/setup-r-dependencies@f9a764fea8d5c63df6ef9a5c7795bf7deb5d7e05 # v2
+        with:
+          working-directory: sess
+          # Keep Suggests for live plot tests. languageserver brings lintr/styler;
+          # renv is exercised by the Interactive library-isolation tests.
+          extra-packages: |
+            any::remotes
+            any::pkgbuild
+            any::languageserver
+            any::renv
+      - run: pnpm run compile
+      - name: Install bundled sess with prepared dependencies
+        run: remotes::install_local('dist/resources/sess', dependencies = FALSE, upgrade = 'never', force = TRUE)
+        shell: Rscript {0}
+      - name: Verify live plot lifecycle dependencies
+        run: |
+          packages <- c("processx", "later", "jsonlite", "jgd", "httpgd", "svglite")
+          for (package in packages) {
+            message("Loading plot test dependency: ", package)
+            loadNamespace(package)
+          }
+          stopifnot(packageVersion("httpgd") >= "2.0.1")
         shell: Rscript {0}
-      - run: pnpm run build
       - name: Verify managed jgd preparation
         run: pnpm run test:prepare-jgd
       - name: Verify managed rstudioapi preparation
@@ -88,14 +110,20 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y tmux
           VSCR_TEST_TMUX=1 pnpm exec mocha out/test/node/interactiveRuntime.test.js --ui tdd --timeout 60000 --grep "^Interactive real R runtime standalone agent survives its launcher process exiting$"
-      - name: Run Node tests
+      - name: Run Node tests including live plot lifecycle tests
         run: pnpm run test:node
+      - name: Run plot lifecycle extension tests (Linux)
+        if: runner.os == 'Linux'
+        run: xvfb-run -a pnpm run test:extension --label plot-lifecycle
+      - name: Run plot lifecycle extension tests
+        if: runner.os != 'Linux'
+        run: pnpm run test:extension --label plot-lifecycle
       - name: Run extension tests (Linux)
         if: runner.os == 'Linux'
-        run: xvfb-run -a pnpm run test:extension
+        run: xvfb-run -a pnpm run test:extension --label provider-tests --label editor-command-tests --label interactive-integration
       - name: Run extension tests
         if: runner.os != 'Linux'
-        run: pnpm run test:extension
+        run: pnpm run test:extension --label provider-tests --label editor-command-tests --label interactive-integration
       - name: Preserve extension test failure logs
         if: failure()
         uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2

.vscode-test.mjs

@@ -36,6 +36,13 @@ export default defineConfig([
 		mocha: { ...common.mocha, require: './out/test/common/extensionSetup.js' },
 		launchArgs: testProfile('provider-tests', false)
 	},
+	{
+		...common,
+		label: 'plot-lifecycle',
+		files: 'out/test/plot/**/*.test.js',
+		mocha: { ...common.mocha, require: './out/test/common/extensionSetup.js' },
+		launchArgs: testProfile('plots', false)
+	},
 	{
 		...common,
 		label: 'editor-command-tests',

R/tests/attach_sess.R

@@ -238,7 +238,7 @@ writeLines(c(
     "      sys.source(file.path(getwd(), 'sess', 'R', 'server.R'), scheduler)",
     "      scheduler$.read_discovery <- function(path) list(endpoint='endpoint-b')",
     "      scheduler$.configure_discovery_jgd <- function(discovery, enabled) NULL",
-    "      scheduler$runtime_stop <- function() invisible(NULL)",
+    "      scheduler$runtime_stop <- function(preserve_plots=FALSE) invisible(NULL)",
     "      scheduler$connect <- function(endpoint, ...) {",
     "        connect_count <<- connect_count + 1L",
     "        observed[[connect_count]] <<- readLines(reconnect_file, warn=FALSE)",

R/tests/prepare-jgd.R

@@ -46,10 +46,20 @@ local({
             "jgd <- function() {",
             "  path <- Sys.getenv('JGD_TEST_DEVICE_LOG', '')",
             "  if (nzchar(path)) cat('jgd\\n', file=path, append=TRUE)",
+            # sess now tracks the opened device and attaches its session identity.
+            # A null PDF supplies a real device without requiring a JGD renderer.
+            "  grDevices::pdf(NULL)",
+            "  invisible(NULL)",
+            "}",
+            "jgd_server_info <- function() list(server_info=c(deviceId=as.character(grDevices::dev.cur())))",
+            "jgd_frame_ext <- function(value) {",
+            "  path <- Sys.getenv('JGD_TEST_DEVICE_LOG', '')",
+            "  if (nzchar(path)) cat(value, '\\n', file=paste0(path, '-frames'), append=TRUE)",
             "  invisible(NULL)",
             "}"
         ), file.path(package, "R", "api.R"))
-        writeLines(c("export(fixture_device)", "export(jgd)"), file.path(package, "NAMESPACE"))
+        writeLines(c("export(fixture_device)", "export(jgd)",
+                     "export(jgd_server_info)", "export(jgd_frame_ext)"), file.path(package, "NAMESPACE"))
         previous <- setwd(root)
         on.exit(setwd(previous), add = TRUE)
         output <- system2_with_child_environment(
@@ -336,6 +346,16 @@ local({
                           "fixture-jgd-socket-next", "TRUE")))
     stopifnot(identical(readLines(file.path(root, "real-approved-real-device"), warn = FALSE),
                         c("jgd", "jgd")))
+    frames <- lapply(readLines(file.path(root, "real-approved-real-device-frames"), warn = FALSE),
+                     jsonlite::fromJSON)
+    stopifnot(length(frames) == 2L)
+    stopifnot(all(vapply(frames, function(frame) {
+        identity <- frame$vscodeR
+        nzchar(identity$sessionId) && nzchar(identity$pid) &&
+            nzchar(identity$deviceId) && identical(identity$restoring, FALSE)
+    }, logical(1))))
+    stopifnot(identical(frames[[1L]]$vscodeR$sessionId, frames[[2L]]$vscodeR$sessionId))
+    stopifnot(!identical(frames[[1L]]$vscodeR$deviceId, frames[[2L]]$vscodeR$deviceId))
 
     approved_root <- file.path(root, "approved")
     dir.create(approved_root)