Commit 634c9ea
committed
feat(execution): expose async-work-finished execution hook
Expose an execution hook that runs once tracked async work has finished,
including work that can outlive a returned execution result.
The hook is available through `hooks.asyncWorkFinished` on execution args.
`AsyncWorkTracker.wait()` now has a synchronous fast-path:
- returns `void` when no async work is currently tracked
- returns `Promise<void>` only while tracked work is pending
This keeps synchronous execution paths synchronous when hooks are enabled.
`GraphQLResolveInfoHelpers.promiseAll` is a wrapper that allows rejected
branches to be tracked as execution async work.
Intended use: return or await this promise from resolver work.
Example (synchronous execution stays synchronous):
```ts
const calls: Array<string> = [];
const result = execute({
schema,
document: parse('{ test }'),
hooks: {
asyncWorkFinished() {
calls.push('asyncWorkFinished');
},
},
});
// result is sync and the hook has already run.
console.log(result);
console.log(calls);
```
Un-awaited async side effects are an anti-pattern:
```ts
resolve(_source, _args, _context, info) {
const { promiseAll } = info.getAsyncHelpers();
promiseAll([Promise.reject(new Error('bad')), pendingCleanup]).catch(
() => undefined,
);
return 'ok';
}
```
In that anti-pattern, tracking starts only after rejection (on a later
microtask), so this work is not guaranteed to delay
`hooks.asyncWorkFinished`.
Use `track(...)` for un-awaited async side effects:
```ts
resolve(_source, _args, _context, info) {
const { track } = info.getAsyncHelpers();
track([doCleanupAsync()]);
return 'ok';
}
```
Regression tests now assert both behaviors: the anti-pattern timing and
the `track(...)` recommendation.1 parent 2e97665 commit 634c9ea
File tree
13 files changed
+625
-10
lines changed- src
- execution
- __tests__
- incremental
- legacyIncremental
- type
13 files changed
+625
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
33 | 42 | | |
34 | 43 | | |
35 | 44 | | |
| |||
39 | 48 | | |
40 | 49 | | |
41 | 50 | | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
42 | 58 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| 64 | + | |
| 65 | + | |
64 | 66 | | |
65 | 67 | | |
66 | 68 | | |
| |||
116 | 118 | | |
117 | 119 | | |
118 | 120 | | |
| 121 | + | |
119 | 122 | | |
120 | 123 | | |
121 | 124 | | |
| |||
370 | 373 | | |
371 | 374 | | |
372 | 375 | | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
373 | 390 | | |
374 | 391 | | |
375 | 392 | | |
376 | 393 | | |
377 | 394 | | |
378 | 395 | | |
379 | 396 | | |
| 397 | + | |
380 | 398 | | |
381 | 399 | | |
382 | 400 | | |
383 | | - | |
384 | 401 | | |
385 | 402 | | |
386 | 403 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
103 | 103 | | |
104 | 104 | | |
105 | 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 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
264 | | - | |
| 264 | + | |
265 | 265 | | |
266 | 266 | | |
267 | 267 | | |
| |||
300 | 300 | | |
301 | 301 | | |
302 | 302 | | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
303 | 307 | | |
304 | 308 | | |
305 | 309 | | |
| |||
0 commit comments