Check that version is not the same (#727)

* Check whether old and new version are the same

* Use devel testthat

* Refine error message

* Move test to be with other versioning tests

* Fix DESCRIPTION

* Use some `Sys.sleep()` in vignettes to make new timestamps/versions

* Add needed Sys.sleep() and remove not needed ones

* Update error message, pass call

* Write different content so hash changes here

* Change content of pin to change hash

* Update NEWS

* Return NULL for same versions, and don't store

* Revert "Return NULL for same versions, and don't store"

This reverts commit 73e0f4d.

* Update NEWS again (messed up revert)

* Oh my gosh 🙈

NEWS.md

@@ -8,6 +8,9 @@
 
 * Updated error messages and type checking (#731) along with testing strategy (#724).
 
+* Added new check for whether a new version is the same as the previous version,
+  as can happen when writing pin versions very quickly (#727).
+
 # pins 1.1.0
 
 ## Breaking changes

R/pin-meta.R

@@ -38,7 +38,7 @@
 #' b %>% pin_download("mtcars")
 #'
 #' # Use tags instead
-#' b %>% pin_write(head(mtcars), "mtcars", tags = c("fuel-efficiency", "automotive"))
+#' b %>% pin_write(tail(mtcars), "mtcars", tags = c("fuel-efficiency", "automotive"))
 #' b %>% pin_meta("mtcars")
 #'
 pin_meta <- function(board, name, version = NULL, ...) {
@@ -105,7 +105,8 @@ test_api_meta <- function(board) {
   testthat::test_that("can update pin metadata", {
     # RSC requires at least 3 characters
     name <- local_pin(board, 1, title = "xxx-a1", description = "xxx-a2")
-    pin_write(board, 1, name, title = "xxx-b1", description = "xxx-b2")
+    # change content so hash changes
+    pin_write(board, 2, name, title = "xxx-b1", description = "xxx-b2")
 
     meta <- pin_meta(board, name)
     testthat::expect_equal(meta$title, "xxx-b1")

R/pin_versions.R

@@ -160,11 +160,18 @@ version_from_path <- function(x) {
   out
 }
 
-version_setup <- function(board, name, new_version, versioned = NULL) {
+version_setup <- function(board, name, new_version, versioned = NULL, call = caller_env()) {
   if (pin_exists(board, name)) {
     versions <- pin_versions(board, name)
     old_version <- versions$version[[1]]
     n_versions <- nrow(versions)
+    if (old_version == new_version) {
+      cli::cli_abort(c(
+        "The new version {.val {new_version}} is the same as the most recent version.",
+        i = "Did you try to create a new version with the same timestamp as the last version?"
+      ),
+      call = call)
+    }
   } else {
     n_versions <- 0
   }

tests/testthat/_snaps/pin_versions.md

@@ -29,6 +29,16 @@
       Warning:
       The `full` argument of `pin_versions()` is deprecated as of pins 1.0.0.
 
+# informative error for writing with same version
+
+    Code
+      board %>% pin_write(1:10, "x")
+      board %>% pin_write(1:10, "x")
+    Condition
+      Error in `pin_store()`:
+      ! The new version "20120304T050607Z-xxxxx" is the same as the most recent version.
+      i Did you try to create a new version with the same timestamp as the last version?
+
 # can prune old versions
 
     Code

tests/testthat/test-pin_versions.R

@@ -35,6 +35,14 @@ test_that("can parse versions from path", {
   expect_equal(out$hash, "hash")
 })
 
+test_that("informative error for writing with same version", {
+  local_mocked_bindings(version_name = function(metadata) "20120304T050607Z-xxxxx")
+  board <- board_temp(versioned = TRUE)
+  expect_snapshot(error = TRUE, {
+    board %>% pin_write(1:10, "x")
+    board %>% pin_write(1:10, "x")
+  })
+})
 
 # versions pruning --------------------------------------------------------
 

vignettes/pins-update.Rmd

@@ -50,6 +50,10 @@ pin_read(board, "mtcars")
 
 Since the board object is always the first argument, you might also want to use the pipe:
 
+```{r, echo=FALSE}
+Sys.sleep(1)
+```
+
 ```{r}
 # Modern API
 board <- board_local()

vignettes/pins.Rmd

@@ -104,6 +104,10 @@ This includes:
 
 When creating the pin, you can override the default description or provide additional metadata that is stored with the data:
 
+```{r, echo=FALSE}
+Sys.sleep(1)
+```
+
 ```{r}
 board %>% pin_write(mtcars, 
   description = "Data extracted from the 1974 Motor Trend US magazine, and comprises fuel consumption and 10 aspects of automobile design and performance for 32 automobiles (1973–74 models).",