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
|
# frozen_string_literal: true
require "spec_helper"
if Fiber.respond_to?(:scheduler) # Ruby 3+
describe GraphQL::Dataloader::NonblockingDataloader do
class NonblockingSchema < GraphQL::Schema
class SleepSource < GraphQL::Dataloader::Source
def fetch(keys)
max_sleep = keys.max
# t1 = Time.now
# puts "----- SleepSource => #{max_sleep} "
sleep(max_sleep)
# puts "----- SleepSource done #{max_sleep} after #{Time.now - t1}"
keys.map { |_k| max_sleep }
end
end
class WaitForSource < GraphQL::Dataloader::Source
def initialize(tag)
@tag = tag
end
def fetch(waits)
max_wait = waits.max
# puts "[#{Time.now.to_f}] Waiting #{max_wait} for #{@tag}"
`sleep #{max_wait}`
# puts "[#{Time.now.to_f}] Finished for #{@tag}"
waits.map { |_w| @tag }
end
end
class Sleeper < GraphQL::Schema::Object
field :sleeper, Sleeper, null: false, resolver_method: :sleep do
argument :duration, Float
end
def sleep(duration:)
`sleep #{duration}`
duration
end
field :duration, Float, null: false
def duration; object; end
end
class Waiter < GraphQL::Schema::Object
field :wait_for, Waiter, null: false do
argument :tag, String
argument :wait, Float
end
def wait_for(tag:, wait:)
dataloader.with(WaitForSource, tag).load(wait)
end
field :tag, String, null: false
def tag
object
end
end
class Query < GraphQL::Schema::Object
field :sleep, Float, null: false do
argument :duration, Float
end
field :sleeper, Sleeper, null: false, resolver_method: :sleep do
argument :duration, Float
end
def sleep(duration:)
`sleep #{duration}`
duration
end
field :wait_for, Waiter, null: false do
argument :tag, String
argument :wait, Float
end
def wait_for(tag:, wait:)
dataloader.with(WaitForSource, tag).load(wait)
end
end
query(Query)
use GraphQL::Dataloader::NonblockingDataloader
end
def with_scheduler
Fiber.set_scheduler(scheduler_class.new)
yield
ensure
Fiber.set_scheduler(nil)
end
module NonblockingDataloaderAssertions
def self.included(child_class)
child_class.class_eval do
it "runs IO in parallel by default" do
dataloader = GraphQL::Dataloader::NonblockingDataloader.new
results = {}
dataloader.append_job { sleep(0.1); results[:a] = 1 }
dataloader.append_job { sleep(0.2); results[:b] = 2 }
dataloader.append_job { sleep(0.3); results[:c] = 3 }
assert_equal({}, results, "Nothing ran yet")
started_at = Time.now
with_scheduler { dataloader.run }
ended_at = Time.now
assert_equal({ a: 1, b: 2, c: 3 }, results, "All the jobs ran")
assert_in_delta 0.3, ended_at - started_at, 0.05, "IO ran in parallel"
end
it "works with sources" do
dataloader = GraphQL::Dataloader::NonblockingDataloader.new
r1 = dataloader.with(NonblockingSchema::SleepSource).request(0.1)
r2 = dataloader.with(NonblockingSchema::SleepSource).request(0.2)
r3 = dataloader.with(NonblockingSchema::SleepSource).request(0.3)
v1 = nil
dataloader.append_job {
v1 = r1.load
}
started_at = Time.now
with_scheduler { dataloader.run }
ended_at = Time.now
assert_equal 0.3, v1
started_at_2 = Time.now
# These should take no time at all since they're already resolved
v2 = r2.load
v3 = r3.load
ended_at_2 = Time.now
assert_equal 0.3, v2
assert_equal 0.3, v3
assert_in_delta 0.0, started_at_2 - ended_at_2, 0.05, "Already-loaded values returned instantly"
assert_in_delta 0.3, ended_at - started_at, 0.05, "IO ran in parallel"
end
it "works with GraphQL" do
started_at = Time.now
res = with_scheduler {
NonblockingSchema.execute("{ s1: sleep(duration: 0.1) s2: sleep(duration: 0.2) s3: sleep(duration: 0.3) }")
}
ended_at = Time.now
assert_equal({"s1"=>0.1, "s2"=>0.2, "s3"=>0.3}, res["data"])
assert_in_delta 0.3, ended_at - started_at, 0.05, "IO ran in parallel"
end
it "nested fields don't wait for slower higher-level fields" do
query_str = <<-GRAPHQL
{
s1: sleeper(duration: 0.1) {
sleeper(duration: 0.1) {
sleeper(duration: 0.1) {
duration
}
}
}
s2: sleeper(duration: 0.2) {
sleeper(duration: 0.1) {
duration
}
}
s3: sleeper(duration: 0.3) {
duration
}
}
GRAPHQL
started_at = Time.now
res = with_scheduler {
NonblockingSchema.execute(query_str)
}
ended_at = Time.now
expected_data = {
"s1" => { "sleeper" => { "sleeper" => { "duration" => 0.1 } } },
"s2" => { "sleeper" => { "duration" => 0.1 } },
"s3" => { "duration" => 0.3 }
}
assert_equal expected_data, res["data"]
assert_in_delta 0.3, ended_at - started_at, 0.05, "Fields ran without any waiting"
end
it "runs dataloaders in parallel across branches" do
query_str = <<-GRAPHQL
{
w1: waitFor(tag: "a", wait: 0.2) {
waitFor(tag: "b", wait: 0.2) {
waitFor(tag: "c", wait: 0.2) {
tag
}
}
}
# After the first, these are returned eagerly from cache
w2: waitFor(tag: "a", wait: 0.2) {
waitFor(tag: "a", wait: 0.2) {
waitFor(tag: "a", wait: 0.2) {
tag
}
}
}
w3: waitFor(tag: "a", wait: 0.2) {
waitFor(tag: "b", wait: 0.2) {
waitFor(tag: "d", wait: 0.2) {
tag
}
}
}
w4: waitFor(tag: "e", wait: 0.6) {
tag
}
}
GRAPHQL
started_at = Time.now
res = with_scheduler do
NonblockingSchema.execute(query_str)
end
ended_at = Time.now
expected_data = {
"w1" => { "waitFor" => { "waitFor" => { "tag" => "c" } } },
"w2" => { "waitFor" => { "waitFor" => { "tag" => "a" } } },
"w3" => { "waitFor" => { "waitFor" => { "tag" => "d" } } },
"w4" => { "tag" => "e" }
}
assert_equal expected_data, res["data"]
# We've basically got two options here:
# - Put all jobs in the same queue (fields and sources), but then you don't get predictable batching.
# - Work one-layer-at-a-time, but then layers can get stuck behind one another. That's what's implemented here.
assert_in_delta 1.0, ended_at - started_at, 0.5, "Sources were executed in parallel"
end
end
end
end
describe "With the toy scheduler from Ruby's tests" do
let(:scheduler_class) { ::DummyScheduler }
include NonblockingDataloaderAssertions
end
if RUBY_ENGINE == "ruby" && !ENV["GITHUB_ACTIONS"]
describe "With libev_scheduler" do
require "libev_scheduler"
let(:scheduler_class) { Libev::Scheduler }
include NonblockingDataloaderAssertions
end
end
describe "with evt" do
require "evt"
let(:scheduler_class) { Evt::Scheduler }
include NonblockingDataloaderAssertions
end
end
end
|