Skip to content

Speed up backport_linter() #2348

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.

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
merged 9 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
+ to discourage many consecutive calls to `suppressMessages()` or `suppressPackageStartupMessages()` (part of #884, @MichaelChirico).
* `return_linter()` also has an argument `return_style` (`"implicit"` by default) which checks that all functions confirm to the specified return style of `"implicit"` or `"explicit"` (part of #884, @MichaelChirico, @AshesITR and @MEO265).
* `unnecessary_lambda_linter` is extended to encourage vectorized comparisons where possible, e.g. `sapply(x, sum) > 0` instead of `sapply(x, function(x) sum(x) > 0)` (part of #884, @MichaelChirico). Toggle this behavior with argument `allow_comparison`.
* `backport_linter()` is slightly faster by moving expensive computations outside the linting function (#2339, #2348, @AshesITR and @MichaelChirico).
* `Linter()` has a new argument `linter_level` (default `NA`). This is used by `lint()` to more efficiently check for expression levels than the idiom `if (!is_lint_level(...)) { return(list()) }` (#2351, @AshesITR).

### New linters
Expand Down
18 changes: 7 additions & 11 deletions R/backport_linter.R
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ backport_linter <- function(r_version = getRversion(), except = character()) {

backport_blacklist <- backports[r_version < R_system_version(names(backports))]
backport_blacklist <- lapply(backport_blacklist, setdiff, except)
backport_index <- rep(names(backport_blacklist), times = lengths(backport_blacklist))
names(backport_index) <- unlist(backport_blacklist)

names_xpath <- "//SYMBOL | //SYMBOL_FUNCTION_CALL"

Expand All @@ -52,26 +54,20 @@ backport_linter <- function(r_version = getRversion(), except = character()) {
all_names_nodes <- xml_find_all(xml, names_xpath)
all_names <- xml_text(all_names_nodes)

# not sapply/vapply, which may over-simplify to vector
# rbind makes sure we have a matrix with dimensions [n_versions x n_names]
# so that colSums() works to tell us which names are in an unavailable version
# rbind not cbind because R is column-major --> which() below will be in column order
needs_backport <- do.call(rbind, lapply(backport_blacklist, function(nm) all_names %in% nm))
bad_idx <- colSums(needs_backport) > 0L
bad_versions <- unname(backport_index[all_names])
needs_backport <- !is.na(bad_versions)

# which(arr.ind) returns things in the same order as which()
needs_backport_version_idx <- ((which(needs_backport) - 1L) %% length(backport_blacklist)) + 1L
lint_message <- sprintf(
paste(
"%s (R %s) is not available for dependency R >= %s.",
"Use the `except` argument of `backport_linter()` to configure available backports."
),
all_names[bad_idx],
names(backport_blacklist)[needs_backport_version_idx],
all_names[needs_backport],
bad_versions[needs_backport],
r_version
)
xml_nodes_to_lints(
all_names_nodes[bad_idx],
all_names_nodes[needs_backport],
source_expression = source_expression,
lint_message = lint_message,
type = "warning"
Expand Down