wip: start working on connection to the requests by a tcp server.

Fixes #1359

Author: Tal Hadad

R/session/init.R

@@ -95,7 +95,7 @@ init_last <- function() {
   )
 
   # Attach to vscode
-  exports$.vsc.attach()
+  #exports$.vsc.attach()
 
   invisible()
 }

R/session/vsc.R

@@ -8,6 +8,7 @@ dir_watcher <- Sys.getenv("VSCODE_WATCHER_DIR", file.path(homedir, ".vscode-R"))
 request_file <- file.path(dir_watcher, "request.log")
 request_lock_file <- file.path(dir_watcher, "request.lock")
 settings_file <- file.path(dir_watcher, "settings.json")
+request_tcp_connection <- NA
 user_options <- names(options())
 
 logger <- if (getOption("vsc.debug", FALSE)) {
@@ -208,9 +209,12 @@ request <- function(command, ...) {
     command = command,
     ...
   )
-  jsonlite::write_json(obj, request_file,
-    auto_unbox = TRUE, null = "null", force = TRUE)
-  cat(get_timestamp(), file = request_lock_file)
+  request_target <- if (is.na(request_tcp_connection)) request_file else request_tcp_connection
+  jsonlite::write_json(obj, request_target,
+    auto_unbox = TRUE, na = "string", null = "null", force = TRUE)
+  if (is.na(request_tcp_connection)) {
+    cat(get_timestamp(), file = request_lock_file)
+  }
 }
 
 try_catch_timeout <- function(expr, timeout = Inf, ...) {
@@ -369,8 +373,12 @@ update_workspace <- function(...) {
       loaded_namespaces = loadedNamespaces(),
       globalenv = if (show_globalenv) inspect_env(.GlobalEnv, globalenv_cache) else NULL
     )
-    jsonlite::write_json(data, workspace_file, force = TRUE, pretty = FALSE)
-    cat(get_timestamp(), file = workspace_lock_file)
+    if (is.na(request_tcp_connection)) {
+      jsonlite::write_json(data, workspace_file, force = TRUE, pretty = FALSE)
+      cat(get_timestamp(), file = workspace_lock_file)
+    } else {
+      request("updateWorkspace", workspaceData = data)
+    }
   }, error = message)
   TRUE
 }
@@ -419,6 +427,7 @@ if (use_httpgd && "httpgd" %in% .packages(all.available = TRUE)) {
     }
   )
 
+  # TODO: Make this be available by TCP only as well
   update_plot <- function(...) {
     tryCatch({
       if (plot_updated && check_null_dev()) {
@@ -595,47 +604,64 @@ if (show_view) {
         )
       }
     }
+    send_data_request <- function(data, source, type, ...) {
+      if (is.na(request_tcp_connection)) {
+        file <- tempfile(tmpdir = tempdir, ...)
+        if (type == "json") {
+          jsonlite::write_json(data, file, na = "string", null = "null", auto_unbox = TRUE, force = TRUE)
+        } else {
+          writeLines(code, file)
+        }
+        request("dataview", source = source, type = type,
+          title = title, file = file, viewer = viewer, uuid = uuid)
+      } else {
+        request("dataview", source = source, type = type,
+          title = title, data = data, viewer = viewer, uuid = uuid)
+      }
+    }
     if (is.data.frame(x) || is.matrix(x)) {
       x <- as_truncated_data(x)
       data <- dataview_table(x)
-      file <- tempfile(tmpdir = tempdir, fileext = ".json")
-      jsonlite::write_json(data, file, na = "string", null = "null", auto_unbox = TRUE, force = TRUE)
-      request("dataview", source = "table", type = "json",
-        title = title, file = file, viewer = viewer, uuid = uuid)
+      send_data_request(data, source = "table", type = "json", fileext = ".json")
     } else if (is.list(x)) {
       tryCatch({
-        file <- tempfile(tmpdir = tempdir, fileext = ".json")
-        jsonlite::write_json(x, file, na = "string", null = "null", auto_unbox = TRUE, force = TRUE)
-        request("dataview", source = "list", type = "json",
-          title = title, file = file, viewer = viewer, uuid = uuid)
+        send_data_request(x, source = "list", type = "json", fileext = ".json")
       }, error = function(e) {
-        file <- file.path(tempdir, paste0(make.names(title), ".txt"))
         text <- utils::capture.output(print(x))
-        writeLines(text, file)
-        request("dataview", source = "object", type = "txt",
-          title = title, file = file, viewer = viewer, uuid = uuid)
+        send_data_request(text, source = "object", type = "txt", paste0(make.names(title)), fileext = ".txt")
       })
     } else {
-      file <- file.path(tempdir, paste0(make.names(title), ".R"))
       if (is.primitive(x)) {
         code <- utils::capture.output(print(x))
       } else {
         code <- deparse(x)
       }
-      writeLines(code, file)
-      request("dataview", source = "object", type = "R",
-        title = title, file = file, viewer = viewer, uuid = uuid)
+      send_data_request(code, source = "object", type = "R", paste0(make.names(title)), fileext = ".R")
     }
   }
 
   rebind("View", show_dataview, "utils")
 }
 
-attach <- function() {
+attach <- function(host = "127.0.0.1", port = NA) {
   load_settings()
   if (rstudioapi_enabled()) {
     rstudioapi_util_env$update_addin_registry(addin_registry)
   }
+  if (!is.na(request_tcp_connection)) {
+    close(request_tcp_connection)
+    request_tcp_connection <<- NA
+  }
+  if (!is.na(port)) {
+    request_tcp_connection <<- socketConnection(
+      host = host,
+      port = port,
+      blocking = TRUE,
+      server = FALSE,
+      open = "a+"
+    )
+  }
+  parent <- parent.env(environment())
   request("attach",
     version = sprintf("%s.%s", R.version$major, R.version$minor),
     tempdir = tempdir,
@@ -646,9 +672,9 @@ attach <- function() {
     ),
     plot_url = if (identical(names(dev.cur()), "httpgd")) httpgd::hgd_url(),
     server = if (use_webserver) list(
-      host = host,
-      port = port,
-      token = token
+      host = parent$host,
+      port = parent$port,
+      token = parent$token
     ) else NULL
   )
 }
@@ -929,4 +955,9 @@ print.hsearch <- function(x, ...) {
   invisible(NULL)
 }
 
-reg.finalizer(.GlobalEnv, function(e) .vsc$request("detach"), onexit = TRUE)
+reg.finalizer(.GlobalEnv, function(e) {
+  .vsc$request("detach")
+  if (!is.na(request_tcp_connection)) {
+    close(request_tcp_connection)
+  }
+}, onexit = TRUE)

package.json

@@ -2157,6 +2157,7 @@
     "jquery.json-viewer": "^1.5.0",
     "js-yaml": "^4.1.0",
     "node-fetch": "^2.6.7",
+    "promise-socket": "^7.0.0",
     "vscode-languageclient": "^8.1.0",
     "vsls": "^1.0.4753",
     "winreg": "^1.2.4"

src/extension.ts

@@ -24,6 +24,7 @@ import * as rShare from './liveShare';
 import * as httpgdViewer from './plotViewer';
 import * as languageService from './languageService';
 import { RTaskProvider } from './tasks';
+import { docProvider, docScheme } from './virtualDocs';
 
 
 // global objects used in other files
@@ -45,6 +46,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
         void vscode.commands.executeCommand('workbench.extensions.search', '@installed R Tools');
     }
 
+    context.subscriptions.push(
+        vscode.workspace.registerTextDocumentContentProvider(docScheme, docProvider)
+    );
+
     // create a new instance of RExtensionImplementation
     // is used to export an interface to the help panel
     // this export is used e.g. by vscode-r-debugger to show the help panel from within debug sessions

src/liveShare/index.ts

@@ -2,7 +2,6 @@
 export * from './shareCommands';
 export * from './shareSession';
 export * from './shareTree';
-export * from './virtualDocs';
 
 import * as vscode from 'vscode';
 import * as vsls from 'vsls';

src/liveShare/shareSession.ts

@@ -6,7 +6,6 @@ import { asViewColumn, config, readContent } from '../util';
 import { showBrowser, showDataView, showWebView, WorkspaceData } from '../session';
 import { liveSession, UUID, rGuestService, _sessionStatusBarItem as sessionStatusBarItem } from '.';
 import { autoShareBrowser } from './shareTree';
-import { docProvider, docScheme } from './virtualDocs';
 
 // Workspace Vars
 let guestPid: string;
@@ -19,7 +18,7 @@ let info: IRequest['info'];
 // Used to keep track of shared browsers
 export const browserDisposables: { Disposable: vscode.Disposable, url: string, name: string }[] = [];
 
-export interface IRequest {
+export type IRequest = {
     command: string;
     time?: string;
     pid?: string;
@@ -30,6 +29,7 @@ export interface IRequest {
     file?: string;
     viewer?: string;
     plot?: string;
+    workspaceData?: WorkspaceData;
     action?: string;
     args?: unknown;
     sd?: string;
@@ -43,7 +43,17 @@ export interface IRequest {
         command: string,
         start_time: string
     };
-}
+} & (
+    {
+        coomad: 'dataview';
+        type: 'json';
+        data: object;
+    } | {
+        coomad: 'dataview';
+        type: 'txt' | 'R';
+        data: string;
+    }
+)
 
 export function initGuest(context: vscode.ExtensionContext): void {
     // create status bar item that contains info about the *guest* session watcher
@@ -54,8 +64,7 @@ export function initGuest(context: vscode.ExtensionContext): void {
     sessionStatusBarItem.tooltip = 'Click to attach to host terminal';
     sessionStatusBarItem.show();
     context.subscriptions.push(
-        sessionStatusBarItem,
-        vscode.workspace.registerTextDocumentContentProvider(docScheme, docProvider)
+        sessionStatusBarItem
     );
     rGuestService?.setStatusBarItem(sessionStatusBarItem);
     guestResDir = path.join(context.extensionPath, 'dist', 'resources');
@@ -149,7 +158,7 @@ export async function updateGuestRequest(file: string, force: boolean = false):
                 if (request.source && request.type && request.title && request.file
                     && request.viewer !== undefined) {
                     await showDataView(request.source,
-                        request.type, request.title, request.file, request.viewer);
+                        request.type, request.title, request.file, request.data, request.viewer);
                 }
                 break;
             }