Enforce integer during pagination #72

awong234 · 2018-06-13T19:17:13Z

box_ls et cetera return HTTP status 400: Bad Request during box_pagination execution. The issue was found to be that R explicitly uses scientific notation when the offset (or any number) >= 100,000; below this, I suppose it supplies an integer or something recognizable by the Box API as an integer.

The only relevant change here is line 57 in boxr_misc.R, within box_pagination().

-url$query$offset <- (page - 1) * limit
+url$query$offset <- as.integer((page - 1) * limit)

The other stuff is just ad hoc functions I included, but may be valuable for users with large data storage; box_ls_short just queries the "name" field from the folder, speeding up the query by about 35%. Do you have any other suggestions for speeding up box_ls when the directory is big (>1e5 files)?

Sorry if it's a little messy with all the files being changed, I don't have much experience with Roxygen2 to selectively update the stuff, but I imagine you can easily change things here and there on your end.

… results in HTTP 400 error.

ijlyttle · 2018-06-16T22:47:25Z

Hi @awong234

Nice catch!

I'm just waiting for some restarted tests to pass, but I expect I will merge this shortly.

Thanks!

PS May I add you to the contributors?

ijlyttle · 2018-06-16T23:25:31Z

R/boxr_misc.R

+#'   examining the contents of local directories.
+#'   
+#' @export
+box_ls_short <- function(dir_id = box_getwd(), limit = 1000, max = Inf) {


Could you rerun document()? TravisCI found a mismatch between this and the .Rd file. Thanks!

ijlyttle · 2018-06-16T23:27:12Z

PPS If you are re-running document(), could you add yourself to Contributors in DESCRIPTION? Thanks!

ijlyttle · 2018-06-17T12:19:25Z

Hi Alec,

I had a closer look at the function box_ls_short() that you are proposing, and while I like the idea of the functionality it would provide, I have a hesitation to repeat all of the code from box_ls().

It would solve my concern if, instead of adding a new function, we were to add an argument to box_ls(), fields = NULL.

If fields is NULL, all the fields would be returned. If fields is some subset of the available fields, only those fields would be returned. You may need some logic like:

filelds_all <- 
  c("modified_at" ,"content_modified_at", "name", "id", "type",
    "sha1" ,"size", "owned_by", "path_collection", "description")

if (is.null(fields)) {
  fields <- fields_all
} else {
  assertthat::assert_that(
    all(fields %in% fields_all),
    msg = paste("all fields must be in", paste(fields_all, collapse = ", "))
  )
}

In summary my proposal is to:

Add the fields argument to box_ls() (as well as @author)
Remove box_ls_short()
document()

What do you think? Let me know if you would like to take this on. If not, I can make the change after accepting the PR.

ijlyttle · 2018-06-17T12:21:44Z

R/boxr_misc.R

+#' @return A data.frame describing the contents of the the folder specified by 
+#'   \code{dir_id}. Non recursive.
+#'   
+#' @author Alec Wong \email{[email protected]}


For your email address to format properly, you will have to use @@.

… for box_ls from Ian Lyttle for querying fewer fields, if so desired.

awong234 · 2018-06-17T14:02:33Z

Hi Ian,

Thanks for the tips! I would be happy to be listed as among the contributors.

I've integrated your suggestions in a new commit, and made the other changes you requested. Let me know if there is something missing.

ijlyttle · 2018-06-17T14:38:34Z

R/boxr_misc.R


-  fields <- c("modified_at" ,"content_modified_at", "name", "id", "type",
-              "sha1" ,"size", "owned_by", "path_collection", "description")
+  filelds_all <- 


This was a typo on my part - should be fields_all.

Can you build-and-install on your end, just to make sure the function works as you expect?

In the longer term, I will have to look more-closely at the tests.

Thanks!

ijlyttle · 2018-06-17T15:12:16Z

R/boxr_misc.R


-  filelds_all <- 
+  fields_all <- 
    c("modified_at" ,"content_modified_at", "name", "id", "type",


I think you also need an entry at line 6 to document the fields argument, something like:

#` @param fields Default (`NULL`) returns all possible columns: #` `"modified_at"`, `"content_modified_at"`, `"name"`, `"id"`, `"type"`, `"sha1"`, #` `"size"`, `"owned_by"`, `"path_collection"`, `"description"`. #` To return a subset of columns, specify as a character vector. #`

If you document() again (and let me know that it works as you expect), I think we're there!

Thanks!

Oh right! Will do

ijlyttle · 2018-06-17T15:40:08Z

Hi Alec,

Just to be sure before I merge, box_ls() behaves as you expect using fields = NULL and fields = "name"?

awong234 · 2018-06-17T17:37:07Z

Hi Ian,

Just tested functionality now, they return values as expected. Thanks!

ijlyttle · 2018-06-17T18:03:25Z

Thanks! 🎉

awong234 added 4 commits June 11, 2018 20:38

boxr_misc.r : added shorter box_ls_short() fn that only queries names.

ec7dd33

boxr_misc.R : Added roxygen export

c5ecfaa

roxygenized with box_ls_short

aedb22f

boxr_misc.R : Enforcing integer offset for pagination. Not doing this…

8ef2150

… results in HTTP 400 error.

ijlyttle reviewed Jun 16, 2018

View reviewed changes

ijlyttle reviewed Jun 17, 2018

View reviewed changes

awong234 added 3 commits June 17, 2018 09:57

added Alec Wong to contributors in Description. Integrated suggestion…

e02081d

… for box_ls from Ian Lyttle for querying fewer fields, if so desired.

documented using roxygenize

2fd2a8f

removed conflicting author line

a98fc28

removed conflicting author line and documented using roxygenize

8f75d86

ijlyttle reviewed Jun 17, 2018

View reviewed changes

boxr_misc.R : adjusted typo 'fields_all'

649787e

ijlyttle reviewed Jun 17, 2018

View reviewed changes

awong234 added 2 commits June 17, 2018 11:18

boxr_misc.R : Documented field parameter in box_ls. Roxygenized.

e621a5d

boxr_misc.R : fixed typos in description of fields parameter

a57b7b4

documented with roxygen.

67e7943

ijlyttle merged commit af81cbd into r-box:master Jun 17, 2018

Uh oh!

Enforce integer during pagination #72

Enforce integer during pagination #72

Uh oh!

Conversation

awong234 commented Jun 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ijlyttle commented Jun 16, 2018

Uh oh!

ijlyttle Jun 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ijlyttle commented Jun 16, 2018

Uh oh!

ijlyttle commented Jun 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ijlyttle Jun 17, 2018

Choose a reason for hiding this comment

Uh oh!

awong234 commented Jun 17, 2018

Uh oh!

ijlyttle Jun 17, 2018

Choose a reason for hiding this comment

Uh oh!

ijlyttle Jun 17, 2018

Choose a reason for hiding this comment

Uh oh!

awong234 Jun 17, 2018

Choose a reason for hiding this comment

Uh oh!

ijlyttle commented Jun 17, 2018

Uh oh!

awong234 commented Jun 17, 2018

Uh oh!

ijlyttle commented Jun 17, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

awong234 commented Jun 13, 2018 •

edited

Loading

ijlyttle Jun 16, 2018 •

edited

Loading

ijlyttle commented Jun 17, 2018 •

edited

Loading