Skip to content
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

Use environments for Connect content + user caches #667

Merged
merged 6 commits into from
Nov 1, 2022
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
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@

* Improved error message for `pin_versions()` (#657).

* Switched content and user caches for Connect to use environments instead
of files on disk. This means caches will no longer persist between sessions
but will be much less likely to end up in a broken state (#667).


# pins 1.0.3

Expand Down
57 changes: 20 additions & 37 deletions R/board_rsconnect.R
Original file line number Diff line number Diff line change
Expand Up @@ -388,17 +388,21 @@ board_pin_find.pins_board_rsconnect <- function(board,

# Content -----------------------------------------------------------------

the <- rlang::new_environment()
the$connect_content_cache <- rlang::new_environment()
the$connect_user_cache <- rlang::new_environment()

rsc_content_find <- function(board, name, version = NULL, warn = TRUE) {
name <- rsc_parse_name(name)
content <- rlang::env_cache(
env = the$connect_content_cache,
nm = name$full %||% name$name,
default = rsc_content_find_live(board, name, version = NULL, warn = TRUE)
)
content
}

cache_path <- fs::path(board$cache, "content-cache.yml")
if (!is.null(name$owner)) {

cache <- read_cache(cache_path)
if (has_name(cache, name$full)) {
return(cache[[name$full]])
}
}
rsc_content_find_live <- function(board, name, version = NULL, warn = TRUE) {

# https://docs.rstudio.com/connect/api/#get-/v1/content
json <- rsc_GET(board, "v1/content", list(name = name$name))
Expand Down Expand Up @@ -434,7 +438,7 @@ rsc_content_find <- function(board, name, version = NULL, warn = TRUE) {
guid = selected$guid,
url = selected$content_url
)
update_cache(cache_path, name$full, content)
content
}

rsc_content_create <- function(board, name, metadata, access_type = "acl") {
Expand Down Expand Up @@ -520,9 +524,8 @@ rsc_content_version_cached <- function(board, guid) {
rsc_content_delete <- function(board, name) {
content <- rsc_content_find(board, name)
rsc_DELETE(board, rsc_v1("content", content$guid))

cache_path <- fs::path(board$cache, "content-cache.yml")
update_cache(cache_path, name, NULL)
env_unbind(the$connect_content_cache, name)
invisible(NULL)
}

rsc_parse_name <- function(x) {
Expand All @@ -536,31 +539,11 @@ rsc_parse_name <- function(x) {
}

rsc_user_name <- function(board, guid) {
path <- fs::path(board$cache, "users-cache.yml")
users <- read_cache(path)

if (has_name(users, guid)) {
users[[guid]]
} else {
# https://docs.rstudio.com/connect/api/#get-/v1/users/{guid}
username <- rsc_GET(board, rsc_v1("users", guid))$username
update_cache(path, guid, username)
}
}

read_cache <- function(path) {
if (file.exists(path)) {
yaml::read_yaml(path, eval.expr = FALSE)
} else {
list()
}
}
update_cache <- function(path, key, value) {
cache <- read_cache(path)
cache[[key]] <- value
write_yaml(cache, path)

value
rlang::env_cache(
env = the$connect_user_cache,
nm = guid,
rsc_GET(board, rsc_v1("users", guid))$username
)
}

# helpers -----------------------------------------------------------------
Expand Down
16 changes: 16 additions & 0 deletions R/board_url.R
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,22 @@ download_cache_path <- function(path) {
fs::path(path, "download-cache.yaml")
}

read_cache <- function(path) {
if (file.exists(path)) {
yaml::read_yaml(path, eval.expr = FALSE)
} else {
list()
}
}

update_cache <- function(path, key, value) {
cache <- read_cache(path)
cache[[key]] <- value
write_yaml(cache, path)

value
}

has_expired <- function(x) {
if (is.null(x)) {
TRUE
Expand Down
2 changes: 1 addition & 1 deletion tests/testthat/_snaps/board_rsconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Code
rsc_content_find(board, "marjory/test-partial")
Condition
Error in `rsc_content_find()`:
Error in `rsc_content_find_live()`:
! Can't find pin named 'test-partial' with owner 'marjory'

# can create and delete content
Expand Down