1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
|
# frozen_string_literal: true
# A shared module for testing ArrayConnection, RelationConnection,
# DatasetConnection and MongoRelationConnection.
#
# The test must implement `schema` to serve the queries below with the expected results.
module ConnectionAssertions
MAX_PAGE_SIZE = 6
DEFAULT_PAGE_SIZE = 4
NAMES = [
"Avocado",
"Beet",
"Cucumber",
"Dill",
"Eggplant",
"Fennel",
"Ginger",
"Horseradish",
"I Can't Believe It's Not Butter",
"Jicama",
]
class NonceEnabledEncoder
class << self
def encode(value, nonce: false)
"#{JSON.dump([value])}#{nonce ? "+nonce" : ""}"
end
def decode(value, nonce: false)
if nonce
value = value.sub(/\+nonce$/, "")
end
JSON.parse(value).first
end
end
end
def self.build_schema(get_items:, connection_class:, total_count_connection_class:)
base_schema = Class.new(GraphQL::Schema)
Class.new(base_schema) do
default_max_page_size ConnectionAssertions::MAX_PAGE_SIZE
default_page_size ConnectionAssertions::DEFAULT_PAGE_SIZE
cursor_encoder(NonceEnabledEncoder)
# Make a way to get local variables (passed in as args)
# into method resolvers below
class << self
attr_accessor :get_items, :connection_class, :total_count_connection_class, :custom_connection_class_with_custom_edge
end
self.get_items = get_items
self.connection_class = connection_class
self.total_count_connection_class = total_count_connection_class
item = Class.new(GraphQL::Schema::Object) do
graphql_name "Item"
field :name, String, null: false
end
custom_item_edge = Class.new(GraphQL::Types::Relay::BaseEdge) do
node_type item
graphql_name "CustomItemEdge"
field :parent_class, String, null: false
def parent_class
object.parent.class.inspect
end
field :node_class_name, String, null: false
end
custom_edge_class = Class.new(GraphQL::Pagination::Connection::Edge) do
def node_class_name
node.class.name
end
end
custom_item_connection = Class.new(GraphQL::Types::Relay::BaseConnection) do
graphql_name "CustomItemConnection"
edge_type custom_item_edge, edge_class: custom_edge_class
field :total_count, Integer, null: false
end
if connection_class
self.custom_connection_class_with_custom_edge = Class.new(connection_class) do
const_set(:Edge, custom_edge_class)
end
end
custom_items_with_custom_edge = Class.new(GraphQL::Types::Relay::BaseConnection) do
graphql_name "AnotherCustomItemConnection"
edge_type custom_item_edge
end
query = Class.new(GraphQL::Schema::Object) do
graphql_name "Query"
field :items, item.connection_type, null: false do
argument :max_page_size_override, Integer, required: false
argument :default_page_size_override, Integer, required: false
end
def items(max_page_size_override: :no_value, default_page_size_override: :no_value)
if max_page_size_override == :no_value && default_page_size_override == :no_value
# don't manually apply the wrapper when it's not required -- check automatic wrapping.
get_items
else
args = {}
args[:max_page_size] = max_page_size_override if max_page_size_override != :no_value
args[:default_page_size] = default_page_size_override if default_page_size_override != :no_value
context.schema.connection_class.new(get_items, **args)
end
end
field :custom_items, custom_item_connection, null: false
def custom_items
context.schema.total_count_connection_class.new(get_items)
end
if connection_class
field :custom_items_with_custom_edge, custom_items_with_custom_edge, null: false
def custom_items_with_custom_edge
context.schema.custom_connection_class_with_custom_edge.new(get_items)
end
end
field :limited_items, item.connection_type, null: false, max_page_size: 2
def limited_items
get_items
end
field :preloaded_items, item.connection_type
def preloaded_items
relation = get_items
relation.load # force the unbounded relation to load from the database
relation
end
field :unbounded_items, item.connection_type, max_page_size: nil, default_page_size: nil
def unbounded_items
get_items
end
field :offset_items, item.connection_type
def offset_items
get_items.offset(2)
end
private
def get_items
context.schema.get_items.call
end
end
query(query)
end
end
def self.included(child_module)
child_module.class_exec do
def exec_query(query_str, variables)
schema.execute(query_str, variables: variables)
end
def get_page_info(result, page_info_field)
result["data"]["items"]["pageInfo"][page_info_field]
end
def assert_names(expected_names, result)
nodes_names = result["data"]["items"]["nodes"].map { |n| n["name"] }
assert_equal expected_names, nodes_names, "The nodes shortcut field has expected names"
edges_names = result["data"]["items"]["edges"].map { |n| n["node"]["name"] }
assert_equal expected_names, edges_names, "The edges.node has expected names"
end
describe "cursor-based pagination" do
let(:query_str) { <<-GRAPHQL
query($first: Int, $after: String, $last: Int, $before: String) {
items(first: $first, after: $after, last: $last, before: $before) {
nodes {
name
}
edges {
node {
name
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
}
}
GRAPHQL
}
it "works with first/after" do
res = exec_query(query_str, first: 3)
assert_names(["Avocado", "Beet", "Cucumber"], res)
assert get_page_info(res, "hasNextPage")
refute get_page_info(res, "hasPreviousPage")
after_cursor = get_page_info(res, "endCursor")
res2 = exec_query(query_str, first: 3, after: after_cursor)
assert_names(["Dill", "Eggplant", "Fennel"], res2)
assert get_page_info(res2, "hasNextPage")
assert get_page_info(res2, "hasPreviousPage")
after_cursor2 = get_page_info(res2, "endCursor")
res3 = exec_query(query_str, first: 30, after: after_cursor2)
assert_names(["Ginger", "Horseradish", "I Can't Believe It's Not Butter", "Jicama"], res3)
refute get_page_info(res3, "hasNextPage")
assert get_page_info(res3, "hasPreviousPage")
end
it "works with last/before" do
res = exec_query(query_str, last: 3)
assert_names(["Horseradish", "I Can't Believe It's Not Butter", "Jicama"], res)
refute get_page_info(res, "hasNextPage")
assert get_page_info(res, "hasPreviousPage")
before_cursor = get_page_info(res, "startCursor")
res2 = exec_query(query_str, last: 3, before: before_cursor)
assert_names(["Eggplant", "Fennel", "Ginger"], res2)
assert get_page_info(res2, "hasNextPage")
assert get_page_info(res2, "hasPreviousPage")
before_cursor2 = get_page_info(res2, "startCursor")
res3 = exec_query(query_str, last: 10, before: before_cursor2)
assert_names(["Avocado", "Beet", "Cucumber", "Dill"], res3)
assert get_page_info(res3, "hasNextPage")
refute get_page_info(res3, "hasPreviousPage")
end
it "returns empty lists for `after: 1` and `before: 2`" do
res = exec_query(query_str, first: 2)
assert_names(["Avocado", "Beet"], res)
after_cursor = get_page_info(res, "startCursor")
before_cursor = get_page_info(res, "endCursor")
res = exec_query(query_str, after: after_cursor, before: before_cursor)
assert_equal true, get_page_info(res, "hasNextPage")
assert_equal true, get_page_info(res, "hasPreviousPage")
assert_names [], res
res = exec_query(query_str, after: after_cursor, before: before_cursor, first: 3)
assert_equal true, get_page_info(res, "hasNextPage")
assert_equal true, get_page_info(res, "hasPreviousPage")
assert_names [], res
end
it "handles out-of-bounds cursors" do
# It treats negative cursors like zero
bogus_negative_cursor = NonceEnabledEncoder.encode("-10")
res = exec_query(query_str, first: 3, after: bogus_negative_cursor)
assert_names(["Avocado", "Beet", "Cucumber"], res)
# It returns nothing for cursors beyond the array
bogus_huge_cursor = NonceEnabledEncoder.encode("100")
res = exec_query(query_str, first: 3, after: bogus_huge_cursor)
assert_names([], res)
# It returns nothing before the first cursor
first_cursor = NonceEnabledEncoder.encode("1")
res = exec_query(query_str, first: 3, before: first_cursor)
assert_names([], res)
end
it "handles negative firsts and lasts by treating them as zero" do
res = exec_query(query_str, first: -3)
assert_names([], res)
res = exec_query(query_str, last: -9)
assert_names([], res)
end
it "handles blank cursors by treating them as nil" do
res = exec_query(query_str, first: 3, after: "")
assert_names(["Avocado", "Beet", "Cucumber"], res)
res = exec_query(query_str, last: 3, before: "")
assert_names(["Horseradish", "I Can't Believe It's Not Butter", "Jicama"], res)
end
it "builds cursors with nonce" do
res = exec_query(query_str, first: 3, after: "")
end_cursor = get_page_info(res, "endCursor")
assert end_cursor.end_with?("+nonce"), "it added nonce to #{end_cursor.inspect}"
end
it "applies max_page_size to first and last" do
# max_page_size overrides first
res = exec_query(query_str, first: 10)
assert_names(["Avocado", "Beet", "Cucumber", "Dill", "Eggplant", "Fennel"], res)
assert_equal true, get_page_info(res, "hasNextPage")
assert_equal false, get_page_info(res, "hasPreviousPage")
# max_page_size overrides last
res = exec_query(query_str, last: 10)
assert_names(["Eggplant", "Fennel", "Ginger", "Horseradish", "I Can't Believe It's Not Butter", "Jicama"], res)
assert_equal false, get_page_info(res, "hasNextPage")
assert_equal true, get_page_info(res, "hasPreviousPage")
end
it "applies default_page_size to first when first and last are unspecified" do
res = exec_query(query_str, {})
# Neither first nor last was provided, so default_page_size was applied.
assert_names(["Avocado", "Beet", "Cucumber", "Dill"], res)
assert_equal true, get_page_info(res, "hasNextPage")
assert_equal false, get_page_info(res, "hasPreviousPage")
end
it "returns unbounded lists" do
query_str = <<-GRAPHQL
query($first: Int, $after: String, $last: Int, $before: String) {
unboundedItems(first: $first, after: $after, last: $last, before: $before) {
nodes {
name
}
edges {
node {
name
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
}
}
GRAPHQL
res = exec_query(query_str, {})
assert_equal 10, res["data"]["unboundedItems"]["nodes"].size
end
end
describe "customizing" do
it "serves custom fields" do
res = schema.execute <<-GRAPHQL, root_value: :something
{
items: customItems(first: 3) {
nodes {
name
}
edges {
node {
name
}
parentClass
nodeClassName
}
totalCount
}
}
GRAPHQL
assert_names(["Avocado", "Beet", "Cucumber"], res)
assert_equal 10, res["data"]["items"]["totalCount"]
edge = res["data"]["items"]["edges"][0]
# Since this connection hangs off `Query`, the root value is the parent.
assert_equal "Symbol", edge["parentClass"]
if schema.get_items
node_class_name = schema.get_items.call.first.class.name
assert_instance_of String, node_class_name
assert_equal node_class_name, edge["nodeClassName"]
end
end
it "uses custom ::Edge classes" do
skip "Not supported" if schema.connection_class.nil?
res = schema.execute <<-GRAPHQL, root_value: :something
{
items: customItemsWithCustomEdge(first: 3) {
nodes {
name
}
edges {
node {
name
}
nodeClassName
}
}
}
GRAPHQL
assert_names(["Avocado", "Beet", "Cucumber"], res)
edge = res["data"]["items"]["edges"][0]
node_class_name = schema.get_items.call.first.class.name
assert_instance_of String, node_class_name
assert_equal node_class_name, edge["nodeClassName"]
end
it "applies local max-page-size settings" do
# Smaller default:
res = schema.execute <<-GRAPHQL
{
items(first: 10, maxPageSizeOverride: 3) {
nodes {
name
}
edges {
node {
name
}
}
}
}
GRAPHQL
assert_names(["Avocado", "Beet", "Cucumber"], res)
# Larger than the default:
res = schema.execute <<-GRAPHQL
{
items(first: 10, maxPageSizeOverride: 7) {
nodes {
name
}
edges {
node {
name
}
}
}
}
GRAPHQL
assert_names(["Avocado", "Beet", "Cucumber", "Dill", "Eggplant", "Fennel", "Ginger"], res)
# Unlimited
res = schema.execute <<-GRAPHQL
{
items(first: 100, maxPageSizeOverride: null) {
nodes {
name
}
edges {
node {
name
}
}
}
}
GRAPHQL
assert_names(NAMES, res)
end
it "applies a field-level max-page-size configuration" do
res = schema.execute <<-GRAPHQL
{
items: limitedItems(first: 10) {
nodes {
name
}
edges {
node {
name
}
}
}
}
GRAPHQL
assert_names(["Avocado", "Beet"], res)
end
end
end
end
end
|