Add plot file/origin attribution (#1067)

jmcphers · DavisVaughan · web-flow · commit 778da3e1b69c · 2026-03-03T12:27:50.000-08:00
* initial impl

* add ui comm to dummy frontend

* update formatting

* code review feedback

* code review feedpack part 2

* Update crates/ark/src/plots/graphics_device.rs

Co-authored-by: Davis Vaughan &lt;davis@rstudio.com&gt;

* test nested source contexts

* simplify source context push

* explicit drop context

---------

Co-authored-by: Davis Vaughan &lt;davis@rstudio.com&gt;
diff --git a/crates/amalthea/src/comm/connections_comm.rs b/crates/amalthea/src/comm/connections_comm.rs
@@ -1,7 +1,7 @@
 // @generated
 
 /*---------------------------------------------------------------------------------------------
- *  Copyright (C) 2024-2025 Posit Software, PBC. All rights reserved.
+ *  Copyright (C) 2024-2026 Posit Software, PBC. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
 //
diff --git a/crates/amalthea/src/comm/help_comm.rs b/crates/amalthea/src/comm/help_comm.rs
@@ -1,7 +1,7 @@
 // @generated
 
 /*---------------------------------------------------------------------------------------------
- *  Copyright (C) 2024-2025 Posit Software, PBC. All rights reserved.
+ *  Copyright (C) 2024-2026 Posit Software, PBC. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
 //
diff --git a/crates/amalthea/src/comm/plot_comm.rs b/crates/amalthea/src/comm/plot_comm.rs
@@ -1,7 +1,7 @@
 // @generated
 
 /*---------------------------------------------------------------------------------------------
- *  Copyright (C) 2024-2025 Posit Software, PBC. All rights reserved.
+ *  Copyright (C) 2024-2026 Posit Software, PBC. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
 //
@@ -30,7 +30,7 @@ pub struct IntrinsicSize {
 /// The plot's metadata
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct PlotMetadata {
-	/// A human-readable name for the plot
+	/// A unique, human-readable name for the plot
 	pub name: String,
 
 	/// The kind of plot e.g. 'Matplotlib', 'ggplot2', etc.
@@ -40,7 +40,10 @@ pub struct PlotMetadata {
 	pub execution_id: String,
 
 	/// The code fragment that produced the plot
-	pub code: String
+	pub code: String,
+
+	/// The origin of the plot, if known
+	pub origin: Option<PlotOrigin>
 }
 
 /// A rendered plot
@@ -66,6 +69,34 @@ pub struct PlotSize {
 	pub width: i64
 }
 
+/// The origin (source) of a plot
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PlotOrigin {
+	/// The URI of the document containing the code that produced the plot, if
+	/// available
+	pub uri: String,
+
+	/// The range within the document at uri that produced the plot, if
+	/// available
+	pub range: Option<PlotRange>
+}
+
+/// The range of a plot within a document
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PlotRange {
+	/// The line number on which the plot starts (0-indexed)
+	pub start_line: i64,
+
+	/// The character number on which the plot starts (0-indexed)
+	pub start_character: i64,
+
+	/// The line number on which the plot ends (0-indexed)
+	pub end_line: i64,
+
+	/// The character number on which the plot ends (0-indexed)
+	pub end_character: i64
+}
+
 /// The settings used to render the plot
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct PlotRenderSettings {
diff --git a/crates/amalthea/src/comm/variables_comm.rs b/crates/amalthea/src/comm/variables_comm.rs
@@ -1,7 +1,7 @@
 // @generated
 
 /*---------------------------------------------------------------------------------------------
- *  Copyright (C) 2024-2025 Posit Software, PBC. All rights reserved.
+ *  Copyright (C) 2024-2026 Posit Software, PBC. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
 //
diff --git a/crates/ark/src/console.rs b/crates/ark/src/console.rs
@@ -1561,10 +1561,16 @@ impl Console {
                     reply_tx,
                 });
 
-                // Push execution context to graphics device for plot attribution
+                // Push execution context to graphics device for plot attribution.
+                // Extract code_location from the execute request for source file origin.
+                let code_location = exec_req.code_location().log_err().flatten().map(|mut loc| {
+                    loc.uri = ExtUrl::normalize(loc.uri);
+                    loc
+                });
                 graphics_device::on_execute_request(
                     originator.header.msg_id.clone(),
                     exec_req.code.clone(),
+                    code_location,
                 );
 
                 input
diff --git a/crates/ark/src/modules/positron/completions.R b/crates/ark/src/modules/positron/completions.R
@@ -122,7 +122,9 @@ customCompletionHandlers <- new.env(parent = emptyenv())
     "Sys.setenv",
     "...",
     function(position) {
-        if (position != "name") return(NULL)
+        if (position != "name") {
+            return(NULL)
+        }
 
         .ps.completions.createCustomCompletions(
             values = names(Sys.getenv()),
@@ -180,8 +182,9 @@ customCompletionHandlers <- new.env(parent = emptyenv())
         )
 
         method <- eval(call, envir = globalenv())
-        if (is.function(method))
+        if (is.function(method)) {
             return(.ps.completions.formalNamesDefault(method))
+        }
     }
 }
 
diff --git a/crates/ark/src/modules/positron/connection.R b/crates/ark/src/modules/positron/connection.R
@@ -421,5 +421,8 @@ bigrquery_connection_code <- function(con) {
         params <- c(params, sprintf('billing = "%s"', billing))
     }
 
-    sprintf("DBI::dbConnect(bigrquery::bigquery(), %s)", paste(params, collapse = ", "))
+    sprintf(
+        "DBI::dbConnect(bigrquery::bigquery(), %s)",
+        paste(params, collapse = ", ")
+    )
 }
diff --git a/crates/ark/src/modules/positron/graphics.R b/crates/ark/src/modules/positron/graphics.R
@@ -529,4 +529,3 @@ render_path <- function(id, format) {
     file <- paste0("render-", id, ".", format)
     file.path(directory, file)
 }
-
diff --git a/crates/ark/src/modules/positron/hooks_source.R b/crates/ark/src/modules/positron/hooks_source.R
@@ -70,6 +70,28 @@ make_ark_source <- function(original_source) {
             args$catch.aborts <- NULL
         }
 
+        # Try to resolve the file URI early so we can attribute plots to this
+        # source file. This is best-effort; if it fails we proceed without attribution.
+        uri <- tryCatch(path_to_file_uri(file), error = function(e) NULL)
+
+        # Push source context for plot attribution (if we have a URI).
+        # The defer ensures we always pop, even if source() errors.
+        # Use tryCatch so that source() still works if the native function
+        # is not yet available (e.g. during development with mismatched builds).
+        if (!is.null(uri)) {
+            tryCatch(
+                {
+                    .ps.Call("ps_graphics_push_source_context", uri)
+                    defer(tryCatch(
+                        .ps.Call("ps_graphics_pop_source_context"),
+                        error = function(e) NULL
+                    ))
+                    TRUE
+                },
+                error = function(e) FALSE
+            )
+        }
+
         # DRY: Promise for calling `original_source` with all arguments.
         # Evaluated lazily only when needed for fallback paths.
         eval(bquote(
@@ -97,7 +119,6 @@ make_ark_source <- function(original_source) {
             return(fall_back)
         }
 
-        uri <- path_to_file_uri(file)
         if (is.null(uri)) {
             return(fall_back)
         }
diff --git a/crates/ark/src/modules/positron/package.R b/crates/ark/src/modules/positron/package.R
@@ -79,13 +79,21 @@
 
 get_package_addins <- function(pkg) {
     path <- system.file("rstudio", "addins.dcf", package = pkg)
-    if (!nzchar(path)) return(list())
+    if (!nzchar(path)) {
+        return(list())
+    }
 
     dcf <- tryCatch(read.dcf(path), error = function(cnd) {
-        log_error(sprintf("Failed to read addins.dcf for '%s': %s", pkg, conditionMessage(cnd)))
+        log_error(sprintf(
+            "Failed to read addins.dcf for '%s': %s",
+            pkg,
+            conditionMessage(cnd)
+        ))
         NULL
     })
-    if (is.null(dcf)) return(list())
+    if (is.null(dcf)) {
+        return(list())
+    }
 
     cols <- colnames(dcf)
     out <- lapply(seq_len(nrow(dcf)), function(i) {
@@ -96,7 +104,9 @@ get_package_addins <- function(pkg) {
 
 parse_addin_row <- function(dcf, row, cols, pkg) {
     binding <- dcf_field(dcf, row, "Binding", cols)
-    if (!nzchar(binding)) return(NULL)
+    if (!nzchar(binding)) {
+        return(NULL)
+    }
 
     list(
         name = dcf_field(dcf, row, "Name", cols),
@@ -120,7 +130,9 @@ parse_addin_row <- function(dcf, row, cols, pkg) {
 
 get_package_templates <- function(pkg) {
     path <- system.file("rmarkdown", "templates", package = pkg)
-    if (!nzchar(path)) return(list())
+    if (!nzchar(path)) {
+        return(list())
+    }
 
     dirs <- list.dirs(path, recursive = FALSE, full.names = TRUE)
     out <- lapply(dirs, function(dir) parse_template_dir(dir, pkg))
@@ -129,13 +141,21 @@ get_package_templates <- function(pkg) {
 
 parse_template_dir <- function(dir, pkg) {
     yaml_path <- file.path(dir, "template.yaml")
-    if (!file.exists(yaml_path)) return(NULL)
+    if (!file.exists(yaml_path)) {
+        return(NULL)
+    }
 
     meta <- tryCatch(yaml::read_yaml(yaml_path), error = function(cnd) {
-        log_error(sprintf("Failed to read template.yaml at '%s': %s", yaml_path, conditionMessage(cnd)))
+        log_error(sprintf(
+            "Failed to read template.yaml at '%s': %s",
+            yaml_path,
+            conditionMessage(cnd)
+        ))
         NULL
     })
-    if (is.null(meta)) return(NULL)
+    if (is.null(meta)) {
+        return(NULL)
+    }
 
     list(
         name = meta$name %||% basename(dir),
diff --git a/crates/ark/src/modules/positron/repos.R b/crates/ark/src/modules/positron/repos.R
@@ -25,7 +25,10 @@ apply_repo_defaults <- function(
             #
             # This is the only instance in which we replace an already-set
             # repository option with a default.
-            if (identical(repos[["CRAN"]], "@CRAN@") || isTRUE(attr(repos, "IDE"))) {
+            if (
+                identical(repos[["CRAN"]], "@CRAN@") ||
+                    isTRUE(attr(repos, "IDE"))
+            ) {
                 repos[["CRAN"]] <- defaults[["CRAN"]]
 
                 # Flag this CRAN repository as being set by the IDE. This flag is
diff --git a/crates/ark/src/modules/rstudio/help.R b/crates/ark/src/modules/rstudio/help.R
@@ -1,9 +1,11 @@
 #' @export
 .rs.api.previewRd <- function(rdFile) {
-    if (!is.character(rdFile) || (length(rdFile) != 1))
+    if (!is.character(rdFile) || (length(rdFile) != 1)) {
         stop("rdFile must be a single element character vector.")
-    if (!file.exists(rdFile))
+    }
+    if (!file.exists(rdFile)) {
         stop("The specified rdFile ' ", rdFile, "' does not exist.")
+    }
 
     invisible(.ps.help.previewRd(rdFile))
 }
diff --git a/crates/ark/src/modules/rstudio/stubs.R b/crates/ark/src/modules/rstudio/stubs.R
@@ -55,8 +55,9 @@
 #' @export
 .rs.api.viewer <- function(url, height = NULL) {
     # Validate arguments
-    if (!is.character(url) || (length(url) != 1))
+    if (!is.character(url) || (length(url) != 1)) {
         stop("url must be a single element character vector.")
+    }
     height <- .ps.validate.viewer.height(height)
 
     if (!is_http_url(url)) {
diff --git a/crates/ark/src/plots/graphics_device.rs b/crates/ark/src/plots/graphics_device.rs
diff --git a/crates/ark/tests/plots.rs b/crates/ark/tests/plots.rs
diff --git a/crates/ark_test/src/dummy_frontend.rs b/crates/ark_test/src/dummy_frontend.rs

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,9 @@ customCompletionHandlers <- new.env(parent = emptyenv())`
`122`	`122`	`"Sys.setenv",`
`123`	`123`	`"...",`
`124`	`124`	`function(position) {`
`125`		`- if (position != "name") return(NULL)`
	`125`	`+ if (position != "name") {`
	`126`	`+ return(NULL)`
	`127`	`+ }`
`126`	`128`
`127`	`129`	`.ps.completions.createCustomCompletions(`
`128`	`130`	`values = names(Sys.getenv()),`
`@@ -180,8 +182,9 @@ customCompletionHandlers <- new.env(parent = emptyenv())`
`180`	`182`	`)`
`181`	`183`
`182`	`184`	`method <- eval(call, envir = globalenv())`
`183`		`- if (is.function(method))`
	`185`	`+ if (is.function(method)) {`
`184`	`186`	`return(.ps.completions.formalNamesDefault(method))`
	`187`	`+ }`
`185`	`188`	`}`
`186`	`189`	`}`
`187`	`190`
Original file line number	Diff line number	Diff line change
`@@ -421,5 +421,8 @@ bigrquery_connection_code <- function(con) {`
`421`	`421`	`params <- c(params, sprintf('billing = "%s"', billing))`
`422`	`422`	`}`
`423`	`423`
`424`		`- sprintf("DBI::dbConnect(bigrquery::bigquery(), %s)", paste(params, collapse = ", "))`
	`424`	`+ sprintf(`
	`425`	`+ "DBI::dbConnect(bigrquery::bigquery(), %s)",`
	`426`	`+ paste(params, collapse = ", ")`
	`427`	`+ )`
`425`	`428`	`}`
Original file line number	Diff line number	Diff line change
`@@ -529,4 +529,3 @@ render_path <- function(id, format) {`
`529`	`529`	`file <- paste0("render-", id, ".", format)`
`530`	`530`	`file.path(directory, file)`
`531`	`531`	`}`
`532`		`-`