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 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
|
# frozen_string_literal: true
require "spec_helper"
require "fiber"
if defined?(Console) && defined?(Async)
Console.logger.disable(Async::Task)
end
describe GraphQL::Dataloader do
class BatchedCallsCounter
def initialize
@count = 0
end
def increment
@count += 1
end
attr_reader :count
end
class FiberSchema < GraphQL::Schema
module Database
extend self
DATA = {}
[
{ id: "1", name: "Wheat", type: "Grain" },
{ id: "2", name: "Corn", type: "Grain" },
{ id: "3", name: "Butter", type: "Dairy" },
{ id: "4", name: "Baking Soda", type: "LeaveningAgent" },
{ id: "5", name: "Cornbread", type: "Recipe", ingredient_ids: ["1", "2", "3", "4"] },
{ id: "6", name: "Grits", type: "Recipe", ingredient_ids: ["2", "3", "7"] },
{ id: "7", name: "Cheese", type: "Dairy" },
].each { |d| DATA[d[:id]] = d }
def log
@log ||= []
end
def mget(ids)
log << [:mget, ids.sort]
ids.map { |id| DATA[id] }
end
def find_by(attribute, values)
log << [:find_by, attribute, values.sort]
values.map { |v| DATA.each_value.find { |dv| dv[attribute] == v } }
end
end
class DataObject < GraphQL::Dataloader::Source
def initialize(column = :id)
@column = column
end
def fetch(keys)
if @column == :id
Database.mget(keys)
else
Database.find_by(@column, keys)
end
end
end
class ToString < GraphQL::Dataloader::Source
def fetch(keys)
keys.map(&:to_s)
end
end
class NestedDataObject < GraphQL::Dataloader::Source
def fetch(ids)
@dataloader.with(DataObject).load_all(ids)
end
end
class SlowDataObject < GraphQL::Dataloader::Source
def initialize(batch_key)
# This is just so that I can force different instances in test
@batch_key = batch_key
end
def fetch(keys)
t = Thread.new {
sleep 0.5
Database.mget(keys)
}
dataloader.yield
t.value
end
end
class CustomBatchKeySource < GraphQL::Dataloader::Source
def initialize(batch_key)
@batch_key = batch_key
end
def self.batch_key_for(batch_key)
Database.log << [:batch_key_for, batch_key]
# Ignore it altogether
:all_the_same
end
def fetch(keys)
Database.mget(keys)
end
end
class KeywordArgumentSource < GraphQL::Dataloader::Source
def initialize(column:)
@column = column
end
def fetch(keys)
if @column == :id
Database.mget(keys)
else
Database.find_by(@column, keys)
end
end
end
class AuthorizedSource < GraphQL::Dataloader::Source
def initialize(counter)
@counter = counter
end
def fetch(recipes)
@counter && @counter.increment
recipes.map { true }
end
end
class ErrorSource < GraphQL::Dataloader::Source
def fetch(ids)
raise GraphQL::Error, "Source error on: #{ids.inspect}"
end
end
module Ingredient
include GraphQL::Schema::Interface
field :name, String, null: false
field :id, ID, null: false
field :name_by_scoped_context, String
def name_by_scoped_context
context[:ingredient_name]
end
end
class Grain < GraphQL::Schema::Object
implements Ingredient
end
class LeaveningAgent < GraphQL::Schema::Object
implements Ingredient
end
class Dairy < GraphQL::Schema::Object
implements Ingredient
end
class Recipe < GraphQL::Schema::Object
def self.authorized?(obj, ctx)
ctx.dataloader.with(AuthorizedSource, ctx[:batched_calls_counter]).load(obj)
end
field :name, String, null: false
field :ingredients, [Ingredient], null: false
def ingredients
ingredients = dataloader.with(DataObject).load_all(object[:ingredient_ids])
ingredients
end
field :slow_ingredients, [Ingredient], null: false
def slow_ingredients
# Use `object[:id]` here to force two different instances of the loader in the test
dataloader.with(SlowDataObject, object[:id]).load_all(object[:ingredient_ids])
end
end
class Query < GraphQL::Schema::Object
field :recipes, [Recipe], null: false
def recipes
Database.mget(["5", "6"])
end
field :ingredient, Ingredient do
argument :id, ID
end
def ingredient(id:)
dataloader.with(DataObject).load(id)
end
field :ingredient_by_name, Ingredient do
argument :name, String
end
def ingredient_by_name(name:)
ing = dataloader.with(DataObject, :name).load(name)
context.scoped_set!(:ingredient_name, "Scoped:#{name}")
ing
end
field :nested_ingredient, Ingredient do
argument :id, ID
end
def nested_ingredient(id:)
dataloader.with(NestedDataObject).load(id)
end
field :slow_recipe, Recipe do
argument :id, ID
end
def slow_recipe(id:)
dataloader.with(SlowDataObject, id).load(id)
end
field :recipe, Recipe do
argument :id, ID, loads: Recipe, as: :recipe
end
def recipe(recipe:)
recipe
end
field :key_ingredient, Ingredient do
argument :id, ID
end
def key_ingredient(id:)
dataloader.with(KeywordArgumentSource, column: :id).load(id)
end
class RecipeIngredientInput < GraphQL::Schema::InputObject
argument :id, ID
argument :ingredient_number, Int
end
field :recipe_ingredient, Ingredient do
argument :recipe, RecipeIngredientInput
end
def recipe_ingredient(recipe:)
recipe_object = dataloader.with(DataObject).load(recipe[:id])
ingredient_idx = recipe[:ingredient_number] - 1
ingredient_id = recipe_object[:ingredient_ids][ingredient_idx]
dataloader.with(DataObject).load(ingredient_id)
end
field :common_ingredients, [Ingredient] do
argument :recipe_1_id, ID
argument :recipe_2_id, ID
end
def common_ingredients(recipe_1_id:, recipe_2_id:)
req1 = dataloader.with(DataObject).request(recipe_1_id)
req2 = dataloader.with(DataObject).request(recipe_2_id)
recipe1 = req1.load
recipe2 = req2.load
common_ids = recipe1[:ingredient_ids] & recipe2[:ingredient_ids]
dataloader.with(DataObject).load_all(common_ids)
end
field :common_ingredients_with_load, [Ingredient], null: false do
argument :recipe_1_id, ID, loads: Recipe
argument :recipe_2_id, ID, loads: Recipe
end
def common_ingredients_with_load(recipe_1:, recipe_2:)
common_ids = recipe_1[:ingredient_ids] & recipe_2[:ingredient_ids]
dataloader.with(DataObject).load_all(common_ids)
end
field :common_ingredients_from_input_object, [Ingredient], null: false do
class CommonIngredientsInput < GraphQL::Schema::InputObject
argument :recipe_1_id, ID, loads: Recipe
argument :recipe_2_id, ID, loads: Recipe
end
argument :input, CommonIngredientsInput
end
def common_ingredients_from_input_object(input:)
recipe_1 = input[:recipe_1]
recipe_2 = input[:recipe_2]
common_ids = recipe_1[:ingredient_ids] & recipe_2[:ingredient_ids]
dataloader.with(DataObject).load_all(common_ids)
end
field :ingredient_with_custom_batch_key, Ingredient do
argument :id, ID
argument :batch_key, String
end
def ingredient_with_custom_batch_key(id:, batch_key:)
dataloader.with(CustomBatchKeySource, batch_key).load(id)
end
field :recursive_ingredient_name, String do
argument :id, ID
end
def recursive_ingredient_name(id:)
res = context.schema.execute("{ ingredient(id: #{id}) { name } }")
res["data"]["ingredient"]["name"]
end
field :test_error, String do
argument :source, Boolean, required: false, default_value: false
end
def test_error(source:)
if source
dataloader.with(ErrorSource).load(1)
else
raise GraphQL::Error, "Field error"
end
end
class LookaheadInput < GraphQL::Schema::InputObject
argument :id, ID
argument :batch_key, String
end
field :lookahead_ingredient, Ingredient, extras: [:lookahead] do
argument :input, LookaheadInput
end
def lookahead_ingredient(input:, lookahead:)
lookahead.arguments # forces a datalaoder.run_isolated call
dataloader.with(CustomBatchKeySource, input[:batch_key]).load(input[:id])
end
end
query(Query)
class Mutation1 < GraphQL::Schema::Mutation
argument :argument_1, String, prepare: ->(val, ctx) {
raise FieldTestError
}
def resolve(argument_1:)
argument_1
end
end
class Mutation2 < GraphQL::Schema::Mutation
argument :argument_2, String, prepare: ->(val, ctx) {
raise FieldTestError
}
def resolve(argument_2:)
argument_2
end
end
class Mutation3 < GraphQL::Schema::Mutation
argument :label, String
type String
def resolve(label:)
log = context[:mutation_log] ||= []
log << "begin #{label}"
dataloader.with(DataObject).load(1)
log << "end #{label}"
label
end
end
class GetCache < GraphQL::Schema::Mutation
type String
def resolve
dataloader.with(ToString).load(1)
end
end
class Mutation < GraphQL::Schema::Object
field :mutation_1, mutation: Mutation1
field :mutation_2, mutation: Mutation2
field :mutation_3, mutation: Mutation3
field :set_cache, String do
argument :input, String
end
def set_cache(input:)
dataloader.with(ToString).merge({ 1 => input })
input
end
field :get_cache, mutation: GetCache
end
mutation(Mutation)
def self.object_from_id(id, ctx)
ctx.dataloader.with(DataObject).load(id)
end
def self.resolve_type(type, obj, ctx)
get_type(obj[:type])
end
orphan_types(Grain, Dairy, Recipe, LeaveningAgent)
use GraphQL::Dataloader
class FieldTestError < StandardError; end
rescue_from(FieldTestError) do |err, obj, args, ctx, field|
errs = ctx[:errors] ||= []
errs << "FieldTestError @ #{ctx[:current_path]}, #{field.path} / #{ctx[:current_field].path}"
nil
end
end
class UsageAnalyzer < GraphQL::Analysis::AST::Analyzer
def initialize(query)
@query = query
@fields = Set.new
end
def on_enter_field(node, parent, visitor)
args = @query.arguments_for(node, visitor.field_definition)
# This bug has been around for a while,
# see https://github.com/rmosolgo/graphql-ruby/issues/3321
if args.is_a?(GraphQL::Execution::Lazy)
args = args.value
end
@fields << [node.name, args.keys]
end
def result
@fields
end
end
def database_log
FiberSchema::Database.log
end
before do
database_log.clear
end
ALL_FIBERS = []
class PartsSchema < GraphQL::Schema
class FieldSource < GraphQL::Dataloader::Source
DATA = [
{"id" => 1, "name" => "a"},
{"id" => 2, "name" => "b"},
{"id" => 3, "name" => "c"},
{"id" => 4, "name" => "d"},
]
def fetch(fields)
@previously_fetched ||= Set.new
fields.each do |f|
if !@previously_fetched.add?(f)
raise "Duplicate fetch for #{f.inspect}"
end
end
Array.new(fields.size, DATA)
end
end
class StringFilter < GraphQL::Schema::InputObject
argument :equal_to_any_of, [String]
end
class ComponentFilter < GraphQL::Schema::InputObject
argument :name, StringFilter
end
class FetchObjects < GraphQL::Schema::Resolver
argument :filter, ComponentFilter, required: false
def resolve(**_kwargs)
context.dataloader.with(FieldSource).load("#{field.path}/#{object&.fetch("id")}")
end
end
class Component < GraphQL::Schema::Object
field :name, String
end
class Part < GraphQL::Schema::Object
field :components, [Component], resolver: FetchObjects
end
class Manufacturer < GraphQL::Schema::Object
field :parts, [Part], resolver: FetchObjects
end
class Query < GraphQL::Schema::Object
field :manufacturers, [Manufacturer], resolver: FetchObjects
end
query(Query)
use GraphQL::Dataloader
end
module DataloaderAssertions
def self.included(child_class)
child_class.class_eval do
let(:schema) { make_schema_from(FiberSchema) }
let(:parts_schema) { make_schema_from(PartsSchema) }
it "Works with request(...)" do
res = schema.execute <<-GRAPHQL
{
commonIngredients(recipe1Id: 5, recipe2Id: 6) {
name
}
}
GRAPHQL
expected_data = {
"data" => {
"commonIngredients" => [
{ "name" => "Corn" },
{ "name" => "Butter" },
]
}
}
assert_equal expected_data, res
assert_equal [[:mget, ["5", "6"]], [:mget, ["2", "3"]]], database_log
end
it "runs mutations sequentially" do
res = schema.execute <<-GRAPHQL
mutation {
first: mutation3(label: "first")
second: mutation3(label: "second")
}
GRAPHQL
assert_equal({ "first" => "first", "second" => "second" }, res["data"])
assert_equal ["begin first", "end first", "begin second", "end second"], res.context[:mutation_log]
end
it "clears the cache between mutations" do
res = schema.execute <<-GRAPHQL
mutation {
setCache(input: "Salad")
getCache
}
GRAPHQL
assert_equal({"setCache" => "Salad", "getCache" => "1"}, res["data"])
end
it "batch-loads" do
res = schema.execute <<-GRAPHQL
{
i1: ingredient(id: 1) { id name }
i2: ingredient(id: 2) { name }
r1: recipe(id: 5) {
# This loads Ingredients 3 and 4
ingredients { name }
}
# This loads Ingredient 7
ri1: recipeIngredient(recipe: { id: 6, ingredientNumber: 3 }) {
name
}
}
GRAPHQL
expected_data = {
"i1" => { "id" => "1", "name" => "Wheat" },
"i2" => { "name" => "Corn" },
"r1" => {
"ingredients" => [
{ "name" => "Wheat" },
{ "name" => "Corn" },
{ "name" => "Butter" },
{ "name" => "Baking Soda" },
],
},
"ri1" => {
"name" => "Cheese",
},
}
assert_equal(expected_data, res["data"])
expected_log = [
[:mget, [
"1", "2", # The first 2 ingredients
"5", # The first recipe
"6", # recipeIngredient recipeId
]],
[:mget, [
"7", # recipeIngredient ingredient_id
]],
[:mget, [
"3", "4", # The two unfetched ingredients the first recipe
]],
]
assert_equal expected_log, database_log
end
it "caches and batch-loads across a multiplex" do
context = {}
result = schema.multiplex([
{ query: "{ i1: ingredient(id: 1) { name } i2: ingredient(id: 2) { name } }", },
{ query: "{ i2: ingredient(id: 2) { name } r1: recipe(id: 5) { ingredients { name } } }", },
{ query: "{ i1: ingredient(id: 1) { name } ri1: recipeIngredient(recipe: { id: 5, ingredientNumber: 2 }) { name } }", },
], context: context)
expected_result = [
{"data"=>{"i1"=>{"name"=>"Wheat"}, "i2"=>{"name"=>"Corn"}}},
{"data"=>{"i2"=>{"name"=>"Corn"}, "r1"=>{"ingredients"=>[{"name"=>"Wheat"}, {"name"=>"Corn"}, {"name"=>"Butter"}, {"name"=>"Baking Soda"}]}}},
{"data"=>{"i1"=>{"name"=>"Wheat"}, "ri1"=>{"name"=>"Corn"}}},
]
assert_equal expected_result, result
expected_log = [
[:mget, ["1", "2", "5"]],
[:mget, ["3", "4"]],
]
assert_equal expected_log, database_log
end
it "works with calls within sources" do
res = schema.execute <<-GRAPHQL
{
i1: nestedIngredient(id: 1) { name }
i2: nestedIngredient(id: 2) { name }
}
GRAPHQL
expected_data = { "i1" => { "name" => "Wheat" }, "i2" => { "name" => "Corn" } }
assert_equal expected_data, res["data"]
assert_equal [[:mget, ["1", "2"]]], database_log
end
it "works with batch parameters" do
res = schema.execute <<-GRAPHQL
{
i1: ingredientByName(name: "Butter") { id }
i2: ingredientByName(name: "Corn") { id }
i3: ingredientByName(name: "Gummi Bears") { id }
}
GRAPHQL
expected_data = {
"i1" => { "id" => "3" },
"i2" => { "id" => "2" },
"i3" => nil,
}
assert_equal expected_data, res["data"]
assert_equal [[:find_by, :name, ["Butter", "Corn", "Gummi Bears"]]], database_log
end
it "works with manual parallelism" do
start = Time.now.to_f
schema.execute <<-GRAPHQL
{
i1: slowRecipe(id: 5) { slowIngredients { name } }
i2: slowRecipe(id: 6) { slowIngredients { name } }
}
GRAPHQL
finish = Time.now.to_f
# For some reason Async adds some overhead to this manual parallelism.
# But who cares, you wouldn't use Thread#join in that case
delta = schema.dataloader_class == GraphQL::Dataloader ? 0.1 : 0.5
# Each load slept for 0.5 second, so sequentially, this would have been 2s sequentially
assert_in_delta 1, finish - start, delta, "Load threads are executed in parallel"
expected_log = [
# These were separated because of different recipe IDs:
[:mget, ["5"]],
[:mget, ["6"]],
# These were cached separately because of different recipe IDs:
[:mget, ["2", "3", "7"]],
[:mget, ["1", "2", "3", "4"]],
]
# Sort them because threads may have returned in slightly different order
assert_equal expected_log.sort, database_log.sort
end
it "Works with multiple-field selections and __typename" do
query_str = <<-GRAPHQL
{
ingredient(id: 1) {
__typename
name
}
}
GRAPHQL
res = schema.execute(query_str)
expected_data = {
"ingredient" => {
"__typename" => "Grain",
"name" => "Wheat",
}
}
assert_equal expected_data, res["data"]
end
it "Works when the parent field didn't yield" do
query_str = <<-GRAPHQL
{
recipes {
ingredients {
name
}
}
}
GRAPHQL
res = schema.execute(query_str)
expected_data = {
"recipes" =>[
{ "ingredients" => [
{"name"=>"Wheat"},
{"name"=>"Corn"},
{"name"=>"Butter"},
{"name"=>"Baking Soda"}
]},
{ "ingredients" => [
{"name"=>"Corn"},
{"name"=>"Butter"},
{"name"=>"Cheese"}
]},
]
}
assert_equal expected_data, res["data"]
expected_log = [
[:mget, ["5", "6"]],
[:mget, ["1", "2", "3", "4", "7"]],
]
assert_equal expected_log, database_log
end
it "loads arguments in batches, even with request" do
query_str = <<-GRAPHQL
{
commonIngredientsWithLoad(recipe1Id: 5, recipe2Id: 6) {
name
}
}
GRAPHQL
res = schema.execute(query_str)
expected_data = {
"commonIngredientsWithLoad" => [
{"name"=>"Corn"},
{"name"=>"Butter"},
]
}
assert_equal expected_data, res["data"]
expected_log = [
[:mget, ["5", "6"]],
[:mget, ["2", "3"]],
]
assert_equal expected_log, database_log
end
it "works with sources that use keyword arguments in the initializer" do
query_str = <<-GRAPHQL
{
keyIngredient(id: 1) {
__typename
name
}
}
GRAPHQL
res = schema.execute(query_str)
expected_data = {
"keyIngredient" => {
"__typename" => "Grain",
"name" => "Wheat",
}
}
assert_equal expected_data, res["data"]
end
it "Works with analyzing arguments with `loads:`, even with .request" do
query_str = <<-GRAPHQL
{
commonIngredientsWithLoad(recipe1Id: 5, recipe2Id: 6) {
name
}
}
GRAPHQL
query = GraphQL::Query.new(schema, query_str)
results = GraphQL::Analysis::AST.analyze_query(query, [UsageAnalyzer])
expected_results = [
["commonIngredientsWithLoad", [:recipe_1, :recipe_2]],
["name", []],
]
normalized_results = results.first.to_a
normalized_results.each do |key, values|
values.sort!
end
assert_equal expected_results, results.first.to_a
end
it "Works with input objects, load and request" do
query_str = <<-GRAPHQL
{
commonIngredientsFromInputObject(input: { recipe1Id: 5, recipe2Id: 6 }) {
name
}
}
GRAPHQL
res = schema.execute(query_str)
expected_data = {
"commonIngredientsFromInputObject" => [
{"name"=>"Corn"},
{"name"=>"Butter"},
]
}
assert_equal expected_data, res["data"]
expected_log = [
[:mget, ["5", "6"]],
[:mget, ["2", "3"]],
]
assert_equal expected_log, database_log
end
it "batches calls in .authorized?" do
query_str = "{ r1: recipe(id: 5) { name } r2: recipe(id: 6) { name } }"
context = { batched_calls_counter: BatchedCallsCounter.new }
schema.execute(query_str, context: context)
assert_equal 1, context[:batched_calls_counter].count
query_str = "{ recipes { name } }"
context = { batched_calls_counter: BatchedCallsCounter.new }
schema.execute(query_str, context: context)
assert_equal 1, context[:batched_calls_counter].count
end
it "Works with input objects using variables, load and request" do
query_str = <<-GRAPHQL
query($input: CommonIngredientsInput!) {
commonIngredientsFromInputObject(input: $input) {
name
}
}
GRAPHQL
res = schema.execute(query_str, variables: { input: { recipe1Id: 5, recipe2Id: 6 }})
expected_data = {
"commonIngredientsFromInputObject" => [
{"name"=>"Corn"},
{"name"=>"Butter"},
]
}
assert_equal expected_data, res["data"]
expected_log = [
[:mget, ["5", "6"]],
[:mget, ["2", "3"]],
]
assert_equal expected_log, database_log
end
it "supports general usage" do
a = b = c = nil
res = GraphQL::Dataloader.with_dataloading { |dataloader|
dataloader.append_job {
a = dataloader.with(FiberSchema::DataObject).load("1")
}
dataloader.append_job {
b = dataloader.with(FiberSchema::DataObject).load("1")
}
dataloader.append_job {
r1 = dataloader.with(FiberSchema::DataObject).request("2")
r2 = dataloader.with(FiberSchema::DataObject).request("3")
c = [
r1.load,
r2.load
]
}
:finished
}
assert_equal :finished, res
assert_equal [[:mget, ["1", "2", "3"]]], database_log
assert_equal "Wheat", a[:name]
assert_equal "Wheat", b[:name]
assert_equal ["Corn", "Butter"], c.map { |d| d[:name] }
end
it "works with scoped context" do
query_str = <<-GRAPHQL
{
i1: ingredientByName(name: "Corn") { nameByScopedContext }
i2: ingredientByName(name: "Wheat") { nameByScopedContext }
i3: ingredientByName(name: "Butter") { nameByScopedContext }
}
GRAPHQL
expected_data = {
"i1" => { "nameByScopedContext" => "Scoped:Corn" },
"i2" => { "nameByScopedContext" => "Scoped:Wheat" },
"i3" => { "nameByScopedContext" => "Scoped:Butter" },
}
result = schema.execute(query_str)
assert_equal expected_data, result["data"]
end
it "works when the schema calls itself" do
result = schema.execute("{ recursiveIngredientName(id: 1) }")
assert_equal "Wheat", result["data"]["recursiveIngredientName"]
end
it "uses .batch_key_for in source classes" do
query_str = <<-GRAPHQL
{
i1: ingredientWithCustomBatchKey(id: 1, batchKey: "abc") { name }
i2: ingredientWithCustomBatchKey(id: 2, batchKey: "def") { name }
i3: ingredientWithCustomBatchKey(id: 3, batchKey: "ghi") { name }
}
GRAPHQL
res = schema.execute(query_str)
expected_data = { "i1" => { "name" => "Wheat" }, "i2" => { "name" => "Corn" }, "i3" => { "name" => "Butter" } }
assert_equal expected_data, res["data"]
expected_log = [
# Each batch key is given to the source class:
[:batch_key_for, "abc"],
[:batch_key_for, "def"],
[:batch_key_for, "ghi"],
# But since they return the same value,
# all keys are fetched in the same call:
[:mget, ["1", "2", "3"]]
]
assert_equal expected_log, database_log
end
it "uses cached values from .merge" do
query_str = "{ ingredient(id: 1) { id name } }"
assert_equal "Wheat", schema.execute(query_str)["data"]["ingredient"]["name"]
assert_equal [[:mget, ["1"]]], database_log
database_log.clear
dataloader = schema.dataloader_class.new
data_source = dataloader.with(FiberSchema::DataObject)
data_source.merge({ "1" => { name: "Kamut", id: "1", type: "Grain" } })
assert_equal "Kamut", data_source.load("1")[:name]
res = schema.execute(query_str, context: { dataloader: dataloader })
assert_equal [], database_log
assert_equal "Kamut", res["data"]["ingredient"]["name"]
end
it "raises errors from fields" do
err = assert_raises GraphQL::Error do
schema.execute("{ testError }")
end
assert_equal "Field error", err.message
end
it "raises errors from sources" do
err = assert_raises GraphQL::Error do
schema.execute("{ testError(source: true) }")
end
assert_equal "Source error on: [1]", err.message
end
it "works with very very large queries" do
query_str = "{".dup
fields = 1100
fields.times do |i|
query_str << "\n field#{i}: lookaheadIngredient(input: { id: 1, batchKey: \"key-#{i}\"}) { name }"
end
query_str << "\n}"
GC.start
GC.disable
res = schema.execute(query_str)
assert_equal fields, res["data"].keys.size
all_fibers = []
ObjectSpace.each_object(Fiber) do |f|
all_fibers << f
end
all_fibers.delete(Fiber.current)
if all_fibers.any?(&:alive?)
puts <<~ERR
Alive fibers:
- #{all_fibers.select(&:alive?).join("\n - ")}
ERR
end
assert_equal [false], all_fibers.map(&:alive?).uniq
ensure
GC.enable
end
it "doesn't perform duplicate source fetches" do
query = <<~QUERY
query {
manufacturers {
parts {
components(filter: {name: {equalToAnyOf: ["c1", "c2", "c3"]}}) {
name
}
}
}
}
QUERY
response = parts_schema.execute(query).to_h
assert_equal [4, 4, 4, 4], response["data"]["manufacturers"].map { |parts_obj| parts_obj["parts"].size }
end
end
end
end
def make_schema_from(schema)
schema
end
include DataloaderAssertions
if RUBY_VERSION >= "3.1.1"
require "async"
describe "AsyncDataloader" do
def make_schema_from(schema)
Class.new(schema) {
use GraphQL::Dataloader::AsyncDataloader
}
end
include DataloaderAssertions
end
end
if Fiber.respond_to?(:scheduler)
describe "nonblocking: true" do
def make_schema_from(schema)
Class.new(schema) do
use GraphQL::Dataloader, nonblocking: true
end
end
before do
Fiber.set_scheduler(::DummyScheduler.new)
end
after do
Fiber.set_scheduler(nil)
end
include DataloaderAssertions
end
if RUBY_ENGINE == "ruby" && !ENV["GITHUB_ACTIONS"]
describe "nonblocking: true with libev" do
require "libev_scheduler"
def make_schema_from(schema)
Class.new(schema) do
use GraphQL::Dataloader, nonblocking: true
end
end
before do
Fiber.set_scheduler(Libev::Scheduler.new)
end
after do
Fiber.set_scheduler(nil)
end
include DataloaderAssertions
end
end
end
describe "example from #3314" do
module Example
class FooType < GraphQL::Schema::Object
field :id, ID, null: false
end
class FooSource < GraphQL::Dataloader::Source
def fetch(ids)
ids.map { |id| OpenStruct.new(id: id) }
end
end
class QueryType < GraphQL::Schema::Object
field :foo, Example::FooType do
argument :foo_id, GraphQL::Types::ID, required: false, loads: Example::FooType
end
def foo(foo: nil)
dataloader.with(Example::FooSource).load("load")
end
end
class Schema < GraphQL::Schema
query Example::QueryType
use GraphQL::Dataloader
def self.object_from_id(id, ctx)
ctx.dataloader.with(Example::FooSource).load(id)
end
def self.resolve_type(type, obj, ctx)
type
end
end
end
it "loads properly" do
result = Example::Schema.execute(<<-GRAPHQL)
{
fooWithLoad: foo(fooId: "Other") {
__typename
id
}
}
GRAPHQL
# This should not have a Lazy in it
expected_result = {
"data" => {
"fooWithLoad" => { "id" => "load", "__typename" => "Foo" },
}
}
assert_equal expected_result, result.to_h
end
end
class FiberErrorSchema < GraphQL::Schema
class ErrorObject < GraphQL::Dataloader::Source
def fetch(_)
raise ArgumentError, "Nope"
end
end
class Query < GraphQL::Schema::Object
field :load, String, null: false
field :load_all, String, null: false
field :request, String, null: false
field :request_all, String, null: false
def load
dataloader.with(ErrorObject).load(123)
end
def load_all
dataloader.with(ErrorObject).load_all([123])
end
def request
req = dataloader.with(ErrorObject).request(123)
req.load
end
def request_all
req = dataloader.with(ErrorObject).request_all([123])
req.load
end
end
use GraphQL::Dataloader
query(Query)
rescue_from(StandardError) do |err, obj, args, ctx, field|
ctx[:errors] << "#{err.message} (#{field.owner.name}.#{field.graphql_name}, #{obj.inspect}, #{args.inspect})"
nil
end
end
it "Works with error handlers" do
context = { errors: [] }
res = FiberErrorSchema.execute("{ load loadAll request requestAll }", context: context)
expected_errors = [
"Nope (FiberErrorSchema::Query.load, nil, {})",
"Nope (FiberErrorSchema::Query.loadAll, nil, {})",
"Nope (FiberErrorSchema::Query.request, nil, {})",
"Nope (FiberErrorSchema::Query.requestAll, nil, {})",
]
assert_nil(res["data"])
assert_equal(expected_errors, context[:errors].sort)
end
it "has proper context[:current_field]" do
res = FiberSchema.execute("mutation { mutation1(argument1: \"abc\") { __typename } mutation2(argument2: \"def\") { __typename } }")
assert_equal({"mutation1"=>nil, "mutation2"=>nil}, res["data"])
expected_errors = [
"FieldTestError @ [\"mutation1\"], Mutation.mutation1 / Mutation.mutation1",
"FieldTestError @ [\"mutation2\"], Mutation.mutation2 / Mutation.mutation2",
]
assert_equal expected_errors, res.context[:errors]
end
it "passes along throws" do
value = catch(:hello) do
dataloader = GraphQL::Dataloader.new
dataloader.append_job do
throw(:hello, :world)
end
dataloader.run
end
assert :world, value
end
class CanaryDataloader < GraphQL::Dataloader::NullDataloader
end
it "uses context[:dataloader] when given" do
res = Class.new(GraphQL::Schema) do
query_type = Class.new(GraphQL::Schema::Object) do
graphql_name "Query"
end
query(query_type)
end.execute("{ __typename }")
assert_instance_of GraphQL::Dataloader::NullDataloader, res.context.dataloader
res = FiberSchema.execute("{ __typename }")
assert_instance_of GraphQL::Dataloader, res.context.dataloader
refute res.context.dataloader.nonblocking?
res = FiberSchema.execute("{ __typename }", context: { dataloader: CanaryDataloader.new } )
assert_instance_of CanaryDataloader, res.context.dataloader
if Fiber.respond_to?(:scheduler)
Fiber.set_scheduler(::DummyScheduler.new)
res = FiberSchema.execute("{ __typename }", context: { dataloader: GraphQL::Dataloader.new(nonblocking: true) })
assert res.context.dataloader.nonblocking?
res = FiberSchema.multiplex([{ query: "{ __typename }" }], context: { dataloader: GraphQL::Dataloader.new(nonblocking: true) })
assert res[0].context.dataloader.nonblocking?
Fiber.set_scheduler(nil)
end
end
describe "#run_isolated" do
module RunIsolated
class CountSource < GraphQL::Dataloader::Source
def fetch(ids)
@count ||= 0
@count += ids.size
ids.map { |_id| @count }
end
end
end
it "uses its own queue" do
dl = GraphQL::Dataloader.new
result = {}
dl.append_job { result[:a] = 1 }
dl.append_job { result[:b] = 2 }
dl.append_job { result[:c] = 3 }
dl.run_isolated { result[:d] = 4 }
assert_equal({ d: 4 }, result)
dl.run_isolated {
_r1 = dl.with(RunIsolated::CountSource).request(1)
_r2 = dl.with(RunIsolated::CountSource).request(2)
r3 = dl.with(RunIsolated::CountSource).request(3)
# This is going to `Fiber.yield`
result[:e] = r3.load
}
assert_equal({ d: 4, e: 3 }, result)
dl.run
assert_equal({ a: 1, b: 2, c: 3, d: 4, e: 3 }, result)
end
it "shares a cache" do
dl = GraphQL::Dataloader.new
result = {}
dl.run_isolated {
_r1 = dl.with(RunIsolated::CountSource).request(1)
_r2 = dl.with(RunIsolated::CountSource).request(2)
r3 = dl.with(RunIsolated::CountSource).request(3)
# Run all three of the above requests:
result[:a] = r3.load
}
dl.append_job {
# This should return cached from above
result[:b] = dl.with(RunIsolated::CountSource).load(1)
}
dl.append_job {
# This one is run by itself
result[:c] = dl.with(RunIsolated::CountSource).load(4)
}
assert_equal({ a: 3 }, result)
dl.run
assert_equal({ a: 3, b: 3, c: 4 }, result)
end
end
describe "thread local variables" do
module ThreadVariable
class Type < GraphQL::Schema::Object
field :key, String, null: false
field :value, String, null: false
end
class Source < GraphQL::Dataloader::Source
def fetch(keys)
keys.map { |key| OpenStruct.new(key: key, value: Thread.current[key.to_sym]) }
end
end
class QueryType < GraphQL::Schema::Object
field :thread_var, ThreadVariable::Type do
argument :key, GraphQL::Types::String
end
def thread_var(key:)
dataloader.with(ThreadVariable::Source).load(key)
end
end
class Schema < GraphQL::Schema
query ThreadVariable::QueryType
use GraphQL::Dataloader
end
end
it "sets the parent thread locals in the execution fiber" do
Thread.current[:test_thread_var] = 'foobarbaz'
result = ThreadVariable::Schema.execute(<<-GRAPHQL)
{
threadVar(key: "test_thread_var") {
key
value
}
}
GRAPHQL
expected_result = {
"data" => {
"threadVar" => { "key" => "test_thread_var", "value" => "foobarbaz" }
}
}
assert_equal expected_result, result.to_h
end
end
describe "thread-local variables with custom dataloader" do
module CustomThreadVariable
class Type < GraphQL::Schema::Object
field :key, String, null: false
field :value, String, null: false
end
class CustomDataloader < GraphQL::Dataloader
def get_fiber_variables
{ test_thread_var: "bazbarfoo" }
end
end
class Source < GraphQL::Dataloader::Source
def fetch(keys)
keys.map { |key| OpenStruct.new(key: key, value: Thread.current[key.to_sym]) }
end
end
class QueryType < GraphQL::Schema::Object
field :thread_var, CustomThreadVariable::Type do
argument :key, GraphQL::Types::String
end
def thread_var(key:)
dataloader.with(CustomThreadVariable::Source).load(key)
end
end
class Schema < GraphQL::Schema
query CustomThreadVariable::QueryType
use CustomDataloader
end
end
it "sets the parent thread locals in the execution fiber" do
result = CustomThreadVariable::Schema.execute(<<-GRAPHQL)
{
threadVar(key: "test_thread_var") {
key
value
}
}
GRAPHQL
expected_result = {
"data" => {
"threadVar" => { "key" => "test_thread_var", "value" => "bazbarfoo" }
}
}
assert_equal expected_result, result.to_h
end
end
describe "dataloader calls from inside sources" do
class NestedDataloaderCallsSchema < GraphQL::Schema
class Echo < GraphQL::Dataloader::Source
def fetch(keys)
keys
end
end
class Nested < GraphQL::Dataloader::Source
def fetch(keys)
dataloader.with(Echo).load_all(keys)
end
end
class Nested2 < GraphQL::Dataloader::Source
def fetch(keys)
dataloader.with(Nested).load_all(keys)
end
end
class QueryType < GraphQL::Schema::Object
field :nested, String
field :nested2, String
def nested
dataloader.with(Nested).load("nested")
end
def nested2
dataloader.with(Nested2).load("nested2")
end
end
query QueryType
use GraphQL::Dataloader
end
end
it "loads data from inside source methods" do
assert_equal({ "data" => { "nested" => "nested" } }, NestedDataloaderCallsSchema.execute("{ nested }"))
assert_equal({ "data" => { "nested2" => "nested2" } }, NestedDataloaderCallsSchema.execute("{ nested2 }"))
assert_equal({ "data" => { "nested" => "nested", "nested2" => "nested2" } }, NestedDataloaderCallsSchema.execute("{ nested nested2 }"))
end
describe "with lazy authorization hooks" do
class LazyAuthHookSchema < GraphQL::Schema
class Source < ::GraphQL::Dataloader::Source
def fetch(ids)
return ids.map {|i| i * 2}
end
end
class BarType < GraphQL::Schema::Object
field :id, Integer
def id
object
end
def self.authorized?(object, context)
-> { true }
end
end
class FooType < GraphQL::Schema::Object
field :dataloader_value, BarType
def self.authorized?(object, context)
-> { true }
end
def dataloader_value
dataloader.with(Source).load(1)
end
end
class QueryType < GraphQL::Schema::Object
field :foo, FooType
def foo
{}
end
end
use GraphQL::Dataloader
query QueryType
lazy_resolve Proc, :call
end
it "resolves everything" do
dataloader_query = """
query {
foo {
dataloaderValue {
id
}
}
}
"""
dataloader_result = LazyAuthHookSchema.execute(dataloader_query)
assert_equal 2, dataloader_result["data"]["foo"]["dataloaderValue"]["id"]
end
end
end
|