Skip to content

Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpkyle merged 7 commits into from
Oct 17, 2019
Merged

Add line number context to stack traces when srcrefs are available #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cff1b45
use KeepSource to retrieve internal srcrefs
Oct 16, 2019
2776612
:sparkles: support line #s when in debug mode
Oct 16, 2019
f91b85f
rename to countEnclosingFrames
Oct 16, 2019
23cc314
capture fmt/unfmt versions for stack message
Oct 16, 2019
674347a
rename show_viewer to use_viewer
Oct 16, 2019
d4d4f2e
:necktie: fix whitespace
Oct 17, 2019
ff632ce
:pencil2: add separator and :camel:
Oct 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions DESCRIPTION
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down
10 changes: 5 additions & 5 deletions R/dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
private$updateReloadHash()
private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
host <- dynGet("host")
port <- dynGet("port")

app_url <- paste0("http://", host, ":", port)

if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
if (use_viewer && host %in% c("localhost", "127.0.0.1"))
rstudioapi::viewer(app_url)
else {
else if (use_viewer) {
warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
utils::browseURL(app_url)
}
}
})

# user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
port = Sys.getenv('DASH_PORT', 8050),
block = TRUE,
showcase = FALSE,
viewer = FALSE,
use_viewer = FALSE,
dev_tools_prune_errors = TRUE,
debug = FALSE,
dev_tools_ui = NULL,
Expand Down
100 changes: 68 additions & 32 deletions R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
if (header) {
write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
}
write(
crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
call_stack
),
": ",
call_stack
call_stack,
" ",
lapply(call_stack, attr, "flineref")
)
),
stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
if(is.null(call_stack)) {
return(NULL)
}
header <- " ### DashR Traceback (most recent/innermost call last) ###"
header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

formattedStack <- c(paste0(
" ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
),
": ",
call_stack,
" ",
lapply(call_stack, attr, "lineref"),
collapse="<br>"
)
)
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
}

functionsAsList <- lapply(calls, function(completeCall) {
currentCall <- completeCall[[1]]
# avoid attempting to cast closures as strings, which will fail
# some calls in the stack are symbol (name) objects, while others
# are calls, which must be deparsed; the first element in the vector
# should be the function signature
if (is.name(completeCall[[1]]))
currentCall <- as.character(completeCall[[1]])
else if (is.call(completeCall[[1]]))
currentCall <- deparse(completeCall)[1]
else
currentCall <- completeCall[[1]]

attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

if (is.function(currentCall) & !is.primitive(currentCall)) {
constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
functionsAsList <- removeHandlers(functionsAsList)
}

# use deparse in case the call throwing the error is a symbol,
# since this cannot be "printed" without deparsing the call
warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
functionsAsList[[length(functionsAsList)]],
conditionMessage(e)))

stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
functionsAsList[[length(functionsAsList)]],
conditionMessage(e))

assign("stack_message", value=stack_message,
envir=sys.frame(1)$private)
envir=sys.frame(countEnclosingFrames("private"))$private)

printCallStack(functionsAsList)
}
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
)
} else {
evalq(expr)
}
}
}

getLineWithError <- function(currentCall, formatted=TRUE) {
srcref <- attr(currentCall, "srcref", exact = TRUE)
if (!is.null(srcref) & !(getAppPath()==FALSE)) {
# filename
srcfile <- attr(srcref, "srcfile", exact = TRUE)
# line number
context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
if (formatted)
context <- crayon::yellow$italic(context)
return(context)
} else
""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
cmd_args <- commandArgs(trailingOnly = FALSE)
file_argument <- "--file="
matched_arg <- grep(file_argument, cmd_args)

# if app is instantiated via Rscript, cmd_args should contain path
if (length(matched_arg) > 0) {
# Rscript
return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
}
}
# if app is instantiated via source(), sys.frames should contain path
else if (!is.null(sys.frames()[[1]]$ofile)) {
return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
}
}

countEnclosingFrames <- function(object) {
for (i in 1:sys.nframe()) {
objs <- ls(envir=sys.frame(i))
if (object %in% objs)
return(i)
}
}

changedAssets <- function(before, after) {
# identify files that used to exist in the asset map,
# but which have been removed
# but which have been removed
deletedElements <- before[which(is.na(match(before, after)))]

# identify files which were added since the last refresh
addedElements <- after[which(is.na(match(after, before)))]

# identify any items that have been updated since the last
# refresh based on modification time attributes set in map
#
#
# in R, attributes are discarded when subsetting, so it's
# necessary to subset the attributes being compared instead.
# here we only compare objects which overlap
before_modtimes <-attributes(before)$modtime[before %in% after]
after_modtimes <- attributes(after)$modtime[after %in% before]

changedElements <- after[which(after_modtimes > before_modtimes)]

if (length(deletedElements) == 0) {
deletedElements <- NULL
}
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
)
}

dashLogger <- function(event = NULL,
message = NULL,
request = NULL,
time = Sys.time(),
dashLogger <- function(event = NULL,
message = NULL,
request = NULL,
time = Sys.time(),
...) {
orange <- crayon::make_style("orange")

# dashLogger is being called from within fiery, and the Fire() object generator
# is called from a private method within the Dash() R6 class; this makes
# accessing variables set within Dash's private fields somewhat complicated
#
# the following line retrieves the value of the silence_route_logging parameter,
# which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

if (!is.null(event)) {
msg <- sprintf("%s: %s", event, message)
msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
message = crayon::blue(msg), msg)

# assign the status group for color coding
if (event == "request") {
status_group <- as.integer(cut(request$respond()$status,
status_group <- as.integer(cut(request$respond()$status,
breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
}

# if log messages are suppressed, report only server stop/start messages, errors, and warnings
# otherwise, print everything to console
if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
}
}
}

clientsideFunction <- function(namespace, function_name) {
return(list(namespace=namespace, function_name=function_name))
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add line number context to stack traces when srcrefs are available by rpkyle · Pull Request #133 · plotly/dashR · GitHub
Skip to content
Add line number context to stack traces when srcrefs are available#133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 7 commits into

from

Oct 17, 2019
 Merged


Add line number context to stack traces when srcrefs are available
#133
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
cff1b45

use KeepSource to retrieve internal srcrefs

Oct 16, 2019
2776612

:sparkles: support line #s when in debug mode

Oct 16, 2019
f91b85f

rename to countEnclosingFrames

Oct 16, 2019
23cc314

capture fmt/unfmt versions for stack message

Oct 16, 2019
674347a

rename show_viewer to use_viewer

Oct 16, 2019
d4d4f2e

:necktie: fix whitespace

Oct 17, 2019
ff632ce

:pencil2: add separator and :camel:

Oct 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ Remotes: plotly/dash-html-components@17da1f4,
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
KeepSource: true
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
URL: https://github.com/plotly/dashR
Expand Down

10 changes: 5 additions & 5 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,18 +525,18 @@ Dash <- R6::R6Class(
 private$updateReloadHash()
 private$index()

viewer <- getOption("viewer")
use_viewer <- !(is.null(getOption("viewer"))) && (dynGet("use_viewer") == TRUE)
 host <- dynGet("host")
 port <- dynGet("port")

 app_url <- paste0("http://", host, ":", port)

 if (!is.null(viewer) && host %in% c("localhost", "127.0.0.1"))
 if (use_viewer && host %in% c("localhost", "127.0.0.1"))
 rstudioapi::viewer(app_url)
 else {
 else if (use_viewer) {
 warning("RStudio viewer not supported; ensure that host is 'localhost' or '127.0.0.1' and that you are using RStudio to run your app. Opening default browser...")
 utils::browseURL(app_url)
 }
}
 })

 # user-facing fields
Expand DownExpand Up@@ -611,7 +611,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
viewer = FALSE,
use_viewer = FALSE,
 dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
Expand Down

100 changes: 68 additions & 32 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -684,7 +684,7 @@ encode_plotly <- function(layout_objs) {
# so that it is pretty printed to stderr()
printCallStack <- function(call_stack, header=TRUE) {
 if (header) {
 write(crayon::yellow$bold(" ### DashR Traceback (most recent/innermost call last) ###"), stderr())
 write(crayon::yellow$bold(" ### Dash for R Traceback (most recent/innermost call last) ###"), stderr())
 }
 write(
 crayon::white(
Expand All@@ -694,7 +694,9 @@ printCallStack <- function(call_stack, header=TRUE) {
 call_stack
 ),
 ": ",
 call_stack
 call_stack,
 " ",
 lapply(call_stack, attr, "flineref")
 )
 ),
 stderr()
Expand All@@ -707,7 +709,7 @@ stackTraceToHTML <- function(call_stack,
 if(is.null(call_stack)) {
 return(NULL)
 }
 header <- " ### DashR Traceback (most recent/innermost call last) ###"
 header <- " ### Dash for R Traceback (most recent/innermost call last) ###"

 formattedStack <- c(paste0(
 " ",
Expand All@@ -716,6 +718,8 @@ stackTraceToHTML <- function(call_stack,
 ),
 ": ",
 call_stack,
 " ",
 lapply(call_stack, attr, "lineref"),
 collapse="<br>"
 )
 )
Expand DownExpand Up@@ -761,7 +765,19 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 }

 functionsAsList <- lapply(calls, function(completeCall) {
 currentCall <- completeCall[[1]]
 # avoid attempting to cast closures as strings, which will fail
 # some calls in the stack are symbol (name) objects, while others
 # are calls, which must be deparsed; the first element in the vector
 # should be the function signature
 if (is.name(completeCall[[1]]))
 currentCall <- as.character(completeCall[[1]])
 else if (is.call(completeCall[[1]]))
 currentCall <- deparse(completeCall)[1]
 else
 currentCall <- completeCall[[1]]

 attr(currentCall, "flineref") <- getLineWithError(completeCall, formatted=TRUE)
 attr(currentCall, "lineref") <- getLineWithError(completeCall, formatted=FALSE)

 if (is.function(currentCall) & !is.primitive(currentCall)) {
 constructedCall <- paste0("<anonymous> function(",
Expand DownExpand Up@@ -813,18 +829,16 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 functionsAsList <- removeHandlers(functionsAsList)
 }

 # use deparse in case the call throwing the error is a symbol,
 # since this cannot be "printed" without deparsing the call
 warning(call. = FALSE, immediate. = TRUE, sprintf("Execution error in %s: %s",
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e)))

 stack_message <- stackTraceToHTML(functionsAsList,
deparse(functionsAsList[[length(functionsAsList)]]),
 functionsAsList[[length(functionsAsList)]],
 conditionMessage(e))

 assign("stack_message", value=stack_message,
 envir=sys.frame(1)$private)
 envir=sys.frame(countEnclosingFrames("private"))$private)

 printCallStack(functionsAsList)
 }
Expand All@@ -836,8 +850,22 @@ getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 )
 } else {
 evalq(expr)
 }
 }
}

getLineWithError <- function(currentCall, formatted=TRUE) {
 srcref <- attr(currentCall, "srcref", exact = TRUE)
 if (!is.null(srcref) & !(getAppPath()==FALSE)) {
 # filename
 srcfile <- attr(srcref, "srcfile", exact = TRUE)
 # line number
 context <- sprintf("-- %s, Line %s", srcfile$filename, srcref[[1]])
 if (formatted)
 context <- crayon::yellow$italic(context)
 return(context)
 } else
 ""
}

# This helper function drops error
# handling functions from the call
Expand DownExpand Up@@ -938,12 +966,12 @@ getAppPath <- function() {
 cmd_args <- commandArgs(trailingOnly = FALSE)
 file_argument <- "--file="
 matched_arg <- grep(file_argument, cmd_args)

 # if app is instantiated via Rscript, cmd_args should contain path
 if (length(matched_arg) > 0) {
 # Rscript
 return(normalizePath(sub(file_argument, "", cmd_args[matched_arg])))
 }
 }
 # if app is instantiated via source(), sys.frames should contain path
 else if (!is.null(sys.frames()[[1]]$ofile)) {
 return(normalizePath(sys.frames()[[1]]$ofile))
Expand All@@ -969,25 +997,33 @@ setModtimeAsAttr <- function(path) {
 }
}

countEnclosingFrames <- function(object) {
 for (i in 1:sys.nframe()) {
 objs <- ls(envir=sys.frame(i))
 if (object %in% objs)
 return(i)
 }
}

changedAssets <- function(before, after) {
 # identify files that used to exist in the asset map,
 # but which have been removed
 # but which have been removed
 deletedElements <- before[which(is.na(match(before, after)))]

 # identify files which were added since the last refresh
 addedElements <- after[which(is.na(match(after, before)))]

 # identify any items that have been updated since the last
 # refresh based on modification time attributes set in map
 #
 #
 # in R, attributes are discarded when subsetting, so it's
 # necessary to subset the attributes being compared instead.
 # here we only compare objects which overlap
 before_modtimes <-attributes(before)$modtime[before %in% after]
 after_modtimes <- attributes(after)$modtime[after %in% before]

 changedElements <- after[which(after_modtimes > before_modtimes)]

 if (length(deletedElements) == 0) {
 deletedElements <- NULL
 }
Expand All@@ -1005,36 +1041,36 @@ changedAssets <- function(before, after) {
 )
}

dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
dashLogger <- function(event = NULL,
 message = NULL,
 request = NULL,
 time = Sys.time(),
 ...) {
 orange <- crayon::make_style("orange")

 # dashLogger is being called from within fiery, and the Fire() object generator
 # is called from a private method within the Dash() R6 class; this makes
 # accessing variables set within Dash's private fields somewhat complicated
 #
 # the following line retrieves the value of the silence_route_logging parameter,
 # which is nearly 20 frames up the stack; if it's not found, we'll assume FALSE
 silence_routes_logging <- dynGet("self", ifnotfound = FALSE)$config$silence_routes_logging

 if (!is.null(event)) {
 msg <- sprintf("%s: %s", event, message)
 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),

 msg <- switch(event, error = crayon::red(msg), warning = crayon::yellow(msg),
 message = crayon::blue(msg), msg)

 # assign the status group for color coding
 if (event == "request") {
 status_group <- as.integer(cut(request$respond()$status,
 status_group <- as.integer(cut(request$respond()$status,
 breaks = c(100, 200, 300, 400, 500, 600), right = FALSE))
 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),

 msg <- switch(status_group, crayon::blue$bold(msg), crayon::green$bold(msg),
 crayon::cyan$bold(msg), orange$bold(msg), crayon::red$bold(msg))
 }

 # if log messages are suppressed, report only server stop/start messages, errors, and warnings
 # otherwise, print everything to console
 if (event %in% c("start", "stop", "error", "warning") || !(silence_routes_logging)) {
Expand All@@ -1043,7 +1079,7 @@ dashLogger <- function(event = NULL,
 }
 }
}

clientsideFunction <- function(namespace, function_name) {
 return(list(namespace=namespace, function_name=function_name))
}