Skip to content

Commit 9a1787e

Browse files
klippxklippx
authored
feat: allow users to specify operationName in multi-operation queries (#629)
1 parent 3206f6b commit 9a1787e

5 files changed

Lines changed: 282 additions & 7 deletions

File tree

‎package-lock.json‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"license": "MIT",
2626
"dependencies": {
2727
"@octokit/request": "^9.1.4",
28-
"@octokit/types": "^13.6.2",
28+
"@octokit/types": "^13.8.0",
2929
"universal-user-agent": "^7.0.0"
3030
},
3131
"devDependencies": {

‎src/graphql.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const NON_VARIABLE_OPTIONS = [
1616
"request",
1717
"query",
1818
"mediaType",
19+
"operationName",
1920
];
2021

2122
const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];

‎test/defaults.test.ts‎

Lines changed: 115 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { describe, expect, it } from "vitest";
2-
import fetchMock from "fetch-mock";
2+
import fetchMock, { type CallLog } from "fetch-mock";
33
import { getUserAgent } from "universal-user-agent";
44

55
import { VERSION } from "../src/version";
@@ -214,4 +214,118 @@ describe("graphql.defaults()", () => {
214214
},
215215
});
216216
});
217+
218+
it("Allows user to specify non variable options", () => {
219+
const mockData = {
220+
repository: {
221+
issues: {
222+
edges: [
223+
{
224+
node: {
225+
title: "Foo",
226+
},
227+
},
228+
{
229+
node: {
230+
title: "Bar",
231+
},
232+
},
233+
{
234+
node: {
235+
title: "Baz",
236+
},
237+
},
238+
],
239+
},
240+
},
241+
};
242+
243+
const query = /* GraphQL */ `
244+
query Blue($last: Int) {
245+
repository(owner: "blue", name: "graphql.js") {
246+
issues(last: $last) {
247+
edges {
248+
node {
249+
title
250+
}
251+
}
252+
}
253+
}
254+
}
255+
256+
query Green($last: Int) {
257+
repository(owner: "green", name: "graphql.js") {
258+
issues(last: $last) {
259+
edges {
260+
node {
261+
title
262+
}
263+
}
264+
}
265+
}
266+
}
267+
`.trim();
268+
269+
const fetch = fetchMock.createInstance();
270+
271+
fetch.post(
272+
"https://api.github.com/graphql",
273+
{ data: mockData },
274+
{
275+
method: "POST",
276+
headers: {
277+
accept: "application/vnd.github.v3+json",
278+
authorization: "token secret123",
279+
"user-agent": userAgent,
280+
},
281+
matcherFunction: (callLog: CallLog) => {
282+
const expected = {
283+
query: query,
284+
operationName: "Blue",
285+
variables: { last: 3 },
286+
};
287+
const result = callLog.options.body === JSON.stringify(expected);
288+
if (!result) {
289+
console.warn("Body did not match expected value", {
290+
expected,
291+
actual: JSON.parse(callLog.options.body as string),
292+
});
293+
}
294+
return result;
295+
},
296+
},
297+
);
298+
299+
const authenticatedGraphql = graphql.defaults({
300+
headers: {
301+
authorization: `token secret123`,
302+
},
303+
request: {
304+
fetch: fetch.fetchHandler,
305+
},
306+
});
307+
308+
return new Promise<void>((res, rej) =>
309+
authenticatedGraphql({
310+
query,
311+
headers: {
312+
authorization: `token secret123`,
313+
},
314+
request: {
315+
fetch: fetch.fetchHandler,
316+
},
317+
operationName: "Blue",
318+
last: 3,
319+
})
320+
.then((result) => {
321+
expect(JSON.stringify(result)).toStrictEqual(
322+
JSON.stringify(mockData),
323+
);
324+
res();
325+
})
326+
.catch(() => {
327+
rej("Should have resolved");
328+
}),
329+
);
330+
});
217331
});

‎test/graphql.test.ts‎

Lines changed: 161 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { describe, expect, it } from "vitest";
2-
import fetchMock from "fetch-mock";
2+
import fetchMock, { type CallLog } from "fetch-mock";
33
import { getUserAgent } from "universal-user-agent";
44

55
import { graphql } from "../src";
@@ -323,4 +323,164 @@ describe("graphql()", () => {
323323
);
324324
});
325325
});
326+
327+
describe("When using a query with multiple operations", () => {
328+
const mockData = {
329+
repository: {
330+
issues: {
331+
edges: [
332+
{
333+
node: {
334+
title: "Foo",
335+
},
336+
},
337+
{
338+
node: {
339+
title: "Bar",
340+
},
341+
},
342+
{
343+
node: {
344+
title: "Baz",
345+
},
346+
},
347+
],
348+
},
349+
},
350+
};
351+
352+
const mockErrors = {
353+
errors: [{ message: "An operation name is required" }],
354+
data: undefined,
355+
status: 400,
356+
};
357+
358+
const query = /* GraphQL */ `
359+
query Blue($last: Int) {
360+
repository(owner: "blue", name: "graphql.js") {
361+
issues(last: $last) {
362+
edges {
363+
node {
364+
title
365+
}
366+
}
367+
}
368+
}
369+
}
370+
371+
query Green($last: Int) {
372+
repository(owner: "green", name: "graphql.js") {
373+
issues(last: $last) {
374+
edges {
375+
node {
376+
title
377+
}
378+
}
379+
}
380+
}
381+
}
382+
`.trim();
383+
384+
it("Sends both queries to the server (which will respond with bad request)", () => {
385+
const fetch = fetchMock.createInstance();
386+
387+
fetch.post("https://api.github.com/graphql", mockErrors, {
388+
method: "POST",
389+
headers: {
390+
accept: "application/vnd.github.v3+json",
391+
authorization: "token secret123",
392+
"user-agent": userAgent,
393+
},
394+
matcherFunction: (callLog: CallLog) => {
395+
const expected = {
396+
query: query,
397+
variables: { last: 3 },
398+
};
399+
const result = callLog.options.body === JSON.stringify(expected);
400+
if (!result) {
401+
console.warn("Body did not match expected value", {
402+
expected,
403+
actual: JSON.parse(callLog.options.body as string),
404+
});
405+
}
406+
return result;
407+
},
408+
});
409+
410+
return new Promise<void>((res, rej) =>
411+
graphql(query, {
412+
headers: {
413+
authorization: `token secret123`,
414+
},
415+
request: {
416+
fetch: fetch.fetchHandler,
417+
},
418+
last: 3,
419+
})
420+
.then(() => {
421+
rej("Should have thrown an error");
422+
})
423+
.catch((result) => {
424+
expect(JSON.stringify(result.response)).toStrictEqual(
425+
JSON.stringify(mockErrors),
426+
);
427+
res();
428+
}),
429+
);
430+
});
431+
432+
it('Allows the user to specify the operation name in the "operationName" option', () => {
433+
const fetch = fetchMock.createInstance();
434+
435+
fetch.post(
436+
"https://api.github.com/graphql",
437+
{ data: mockData },
438+
{
439+
method: "POST",
440+
headers: {
441+
accept: "application/vnd.github.v3+json",
442+
authorization: "token secret123",
443+
"user-agent": userAgent,
444+
},
445+
matcherFunction: (callLog: CallLog) => {
446+
const expected = {
447+
query: query,
448+
operationName: "Blue",
449+
variables: { last: 3 },
450+
};
451+
const result = callLog.options.body === JSON.stringify(expected);
452+
if (!result) {
453+
console.warn("Body did not match expected value", {
454+
expected,
455+
actual: JSON.parse(callLog.options.body as string),
456+
});
457+
}
458+
return result;
459+
},
460+
},
461+
);
462+
463+
return new Promise<void>((res, rej) =>
464+
graphql(query, {
465+
headers: {
466+
authorization: `token secret123`,
467+
},
468+
request: {
469+
fetch: fetch.fetchHandler,
470+
},
471+
operationName: "Blue",
472+
last: 3,
473+
})
474+
.then((result) => {
475+
expect(JSON.stringify(result)).toStrictEqual(
476+
JSON.stringify(mockData),
477+
);
478+
res();
479+
})
480+
.catch((error) => {
481+
rej(error);
482+
}),
483+
);
484+
});
485+
});
326486
});

0 commit comments

Comments
 (0)