adjustments after an API release

Author: mustberuss

Diff for: tests/testthat/test-api-bugs.R

@@ -1,4 +1,4 @@
-test_that("Queries returning non-utility patents don't page well", {
+test_that("Queries returning non-utility patents well", {
   skip_on_cran()
   only_utility_qry <- with_qfuns(
     and(
@@ -18,7 +18,7 @@ test_that("Queries returning non-utility patents don't page well", {
 
   all_types_res <- search_pv(only_utility_qry, all_pages = TRUE)
   expect_true(
-    nrow(all_types_res$data$patents) != all_types_res$query_results$total_hits
+    nrow(all_types_res$data$patents) == all_types_res$query_results$total_hits
   )
 })
 
@@ -41,6 +41,7 @@ test_that("inventors.inventor and assignees.assignee aren't returned
   expect_no_error(good_res$data$patents$assignees[[1]]$assignee)
 })
 
+# this seems to have been fixed- empty lists are returned
 # See bug report in PatentsView API repo: PVS-1125
 test_that("Fields that are all NULL don't return at all", {
   skip_on_cran()
@@ -59,12 +60,12 @@ test_that("Fields that are all NULL don't return at all", {
 
   result1 <- search_pv(query, fields = fields, sort = sort, size = 1000)
   no_cpc_at_issue <- colnames(result1$data$patents)
-  expect_false("cpc_at_issue" %in% no_cpc_at_issue)
+  expect_true("cpc_at_issue" %in% no_cpc_at_issue)
 
   result2 <- search_pv(query, fields = fields, sort = sort, size = 10)
-  two_field_result <- colnames(result2$data$patents)
+  three_field_result <- colnames(result2$data$patents)
   # only returns: c("patent_id", "uspc_at_issue")
-  expect_true(length(two_field_result) == 2)
+  expect_true(length(three_field_result) == 3)
 })
 
 # Reported to the API team PVS-1147
@@ -173,6 +174,7 @@ test_that("We can't sort by all fields", {
   expect_lt(length(results), length(sorts_to_try))
 })
 
+# this is fixed, w/d patents only come back if option exclude_withdrawn is false
 
 # PVS-1342 Underlying data issues
 # There are ~8,000 patents that were in the bulk XML files that PatentsView is
@@ -191,7 +193,7 @@ test_that("Withdrawn patents are still present in the database", {
 
   query <- qry_funs$eq("patent_id" = withdrawn)
   results <- search_pv(query, method = "POST")
-  expect_equal(results$query_results$total_hits, length(withdrawn))
+  expect_equal(results$query_results$total_hits, 0)
 })
 
 # PVS-1342 Underlying data issues
@@ -212,3 +214,15 @@ test_that("Missing patents are still missing", {
 
   expect_equal(results$query_results$total_hits, 0)
 })
+
+# PVS-1884 The publication endpoint's rule_47_flag is always false
+test_that("Querying the publication endpoint on rule_47_flag isn't meaningful", {
+  skip_on_cran()
+
+  res <- search_pv(qry_funs$eq(rule_47_flag = TRUE), endpoint = "publication")
+  expect_equal(res$query_results$total_hits, 0)
+
+  res <- search_pv(qry_funs$eq(rule_47_flag = FALSE), endpoint = "publication")
+  expect_gt(res$query_results$total_hits, 8000000)
+
+})

Diff for: tests/testthat/test-check-query.R

@@ -38,8 +38,8 @@ test_that("errors are thrown on invalid queries", {
   )
 
   expect_error(
-    search_pv(qry_funs$eq("rule_47_flag" = TRUE), endpoint = "publication"),
-    "^.* must be of type character$"
+    search_pv(qry_funs$eq("rule_47_flag" = "TRUE"), endpoint = "publication"),
+    "^.* must be a boolean$"
   )
 
   expect_error(

Diff for: tests/testthat/test-search-pv.R

@@ -146,38 +146,36 @@ test_that("We can call all the legitimate HATEOAS endpoints", {
 })
 
 test_that("Shorthand specification of fields results in expected results", {
-
+    skip_on_cran()
     query <- TEST_QUERIES[["patent"]]
 
+    # We ask for all of assignee's nested fields (total of 9 fields currently).
+    # It gets turned into a shorthand request, however now 11 fields are returned.
+    # Returned but not requested:  assignee and assignee_location_id
+    # Now the test is really that the shorthand notation was used and
+    # that we got back all of the requested fields, ignoring the extras
     all_assn_flds <- get_fields("patent", groups = "assignees")
-    full_res <- search_pv(query, fields = all_assn_flds)
+    full_res <- search_pv(query, fields = all_assn_flds, method = "POST")
+    api_request <- httr2::last_request()$body$data
+    expect_true(grepl('"f":\\["assignees","patent_id"\\]', api_request))
+
+    unnested_requested_flds <- sub(".*\\.(.*)", "\\1", all_assn_flds)
+    returned_flds <- names(full_res$data$patents$assignees[[1]])
+    expect_true(all(unnested_requested_flds %in% returned_flds))
 
+    # Here we explicitly request 8 fields but we get 9 back.  We get assignee_id back
+    # as well as assignee (that we didn't ask for).  The opposite is not true,
+    # asking for just assignee doesn't return assignee or assignee_id
     no_city <- all_assn_flds[all_assn_flds != "assignees.assignee_city"]
     no_city_res <- search_pv(query, fields = no_city)
 
-    no_city_has_seven <- length(no_city_res$data$patents$assignees[[1]]) == 7
-    all_cols_has_nine <- length(full_res$data$patents$assignees[[1]]) == 9
-    expect_true(no_city_has_seven&& all_cols_has_nine)
-})
-
-test_that("nested shorthand produces the same results as fully qualified ones", {
-  skip_on_cran()
-
-  # The API now allows you to use the `group` name in place of all the field
-  # names belonging to that group when specifying which fields you want. The
-  # group names are given in fieldsdf$group.
-  # This is indirectly testing our parse of the OpenAPI object in
-  # data-raw/fieldsdf.R
-  all_qualified_fields <- fieldsdf[
-    fieldsdf$endpoint == "patent" & fieldsdf$group == "application",
-    "field"
-  ]
+    unnested_requested_flds <- sub(".*\\.(.*)", "\\1", no_city)
+    returned_flds <- names(no_city_res$data$patents$assignees[[1]])
 
-  query <- TEST_QUERIES[["patent"]]
-  shorthand_res <- search_pv(query, fields = "application")
-  qualified_res <- search_pv(query, fields = all_qualified_fields)
+    # we request "assignee" but don't get "assignee" or "assignee_id" back
+    # so we can't expect_true TODO move to api-bugs?
+    expect_false(all(unnested_requested_flds %in% returned_flds))
 
-  expect_equal(shorthand_res$data, qualified_res$data)
 })
 
 test_that("The 'after' parameter works properly", {
@@ -189,7 +187,6 @@ test_that("The 'after' parameter works properly", {
   expect_gt(results$query_results$total_hits, 1000)
 
   after <- results$data$patents$patent_id[[nrow(results$data$patents)]]
-  after <- pad_patent_id(after)
   subsequent <- search_pv(big_query, after = after, sort = sort)
 
   expect_equal(nrow(subsequent$data$patents), 1000)