feat: allow extra params in body #3333

ardatan · 2024-06-27T18:38:45Z

By default, Yoga does not allow extra parameters in the request body other than query, operationName, extensions, and variables, then throws 400 HTTP Error.
This change adds a new option called extraParamNames to allow extra parameters in the request body.

import { createYoga } from 'graphql-yoga';

const yoga = createYoga({
  /* other options */
  extraParamNames: ['extraParam1', 'extraParam2'],
});

const res = await yoga.fetch('/graphql', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        query: 'query { __typename }',
        extraParam1: 'value1',
        extraParam2: 'value2',
    }),
});

console.assert(res.status === 200);

changeset-bot · 2024-06-27T18:38:48Z

🦋 Changeset detected

Latest commit: b1bfc8a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 23 packages

Name	Type
graphql-yoga	Minor
@graphql-yoga/nestjs	Major
@graphql-yoga/render-graphiql	Major
@graphql-yoga/plugin-apollo-inline-trace	Major
@graphql-yoga/apollo-managed-federation	Major
@graphql-yoga/plugin-apq	Major
@graphql-yoga/plugin-csrf-prevention	Major
@graphql-yoga/plugin-defer-stream	Major
@graphql-yoga/plugin-disable-introspection	Major
@graphql-yoga/plugin-graphql-sse	Major
@graphql-yoga/plugin-jwt	Major
@graphql-yoga/plugin-persisted-operations	Major
@graphql-yoga/plugin-prometheus	Major
@graphql-yoga/plugin-response-cache	Major
@graphql-yoga/plugin-sofa	Major
apollo-federation-gateway-with-yoga	Patch
apollo-subgraph-with-yoga	Patch
graphql-lambda	Patch
cloudflare-advanced	Patch
cloudflare	Patch
nextjs-app	Patch
hello-world-benchmark	Patch
@graphql-yoga/nestjs-federation	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-06-27T18:42:28Z

💻 Website Preview

The latest changes are available as preview in: https://c12ca00c.graphql-yoga.pages.dev

github-actions · 2024-06-27T18:42:45Z

✅ Benchmark Results

     ✓ no_errors{mode:graphql}
     ✓ expected_result{mode:graphql}
     ✓ no_errors{mode:graphql-jit}
     ✓ expected_result{mode:graphql-jit}
     ✓ no_errors{mode:graphql-response-cache}
     ✓ expected_result{mode:graphql-response-cache}
     ✓ no_errors{mode:graphql-no-parse-validate-cache}
     ✓ expected_result{mode:graphql-no-parse-validate-cache}

     checks.......................................: 100.00% ✓ 419648      ✗ 0     
     data_received................................: 1.7 GB  14 MB/s
     data_sent....................................: 85 MB   706 kB/s
     http_req_blocked.............................: avg=1.48µs   min=1µs      med=1.32µs   max=244.91µs p(90)=1.97µs   p(95)=2.16µs  
     http_req_connecting..........................: avg=2ns      min=0s       med=0s       max=123.54µs p(90)=0s       p(95)=0s      
     http_req_duration............................: avg=359.52µs min=216.29µs med=323.28µs max=24.01ms  p(90)=462.46µs p(95)=482.4µs 
       { expected_response:true }.................: avg=359.52µs min=216.29µs med=323.28µs max=24.01ms  p(90)=462.46µs p(95)=482.4µs 
     ✓ { mode:graphql-jit }.......................: avg=282.91µs min=216.29µs med=260.79µs max=15.38ms  p(90)=290.59µs p(95)=302.96µs
     ✓ { mode:graphql-no-parse-validate-cache }...: avg=485.71µs min=395.66µs med=458.14µs max=10.36ms  p(90)=499.43µs p(95)=527.11µs
     ✓ { mode:graphql-response-cache }............: avg=341.63µs min=268.51µs med=322.2µs  max=7.57ms   p(90)=353.98µs p(95)=365.4µs 
     ✓ { mode:graphql }...........................: avg=363.92µs min=276.07µs med=332.44µs max=24.01ms  p(90)=377.99µs p(95)=412.07µs
     http_req_failed..............................: 0.00%   ✓ 0           ✗ 209824
     http_req_receiving...........................: avg=33.72µs  min=16.15µs  med=33.56µs  max=1.14ms   p(90)=39.05µs  p(95)=41.11µs 
     http_req_sending.............................: avg=8.09µs   min=5.92µs   med=7.17µs   max=302.42µs p(90)=10.72µs  p(95)=11.47µs 
     http_req_tls_handshaking.....................: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting.............................: avg=317.69µs min=180.47µs med=281.97µs max=23.85ms  p(90)=420.24µs p(95)=438.08µs
     http_reqs....................................: 209824  1748.506543/s
     iteration_duration...........................: avg=567.07µs min=386.05µs med=527.68µs max=24.72ms  p(90)=673.56µs p(95)=697.89µs
     iterations...................................: 209824  1748.506543/s
     vus..........................................: 1       min=1         max=1   
     vus_max......................................: 2       min=2         max=2

github-actions · 2024-06-27T18:43:29Z

Apollo Federation Subgraph Compatibility Results

Federation 1 Support Federation 2 Support

`_service`	🟢
`@key (single)`	🟢
`@key (multi)`	🟢
`@key (composite)`	🟢
`repeatable @key`	🟢
`@requires`	🟢
`@provides`	🟢
`federated tracing`	🟢

`@link`	🟢
`@shareable`	🟢
`@tag`	🟢
`@override`	🟢
`@inaccessible`	🟢
`@composeDirective`	🟢
`@interfaceObject`	🟢

Learn more:

github-actions · 2024-06-27T18:43:56Z

🚀 Snapshot Release (`alpha`)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
`@graphql-yoga/apollo-link`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/urql-exchange`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`graphql-yoga`	`5.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/nestjs`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/nestjs-federation`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-apollo-inline-trace`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/apollo-managed-federation`	`0.2.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-apq`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-csrf-prevention`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-defer-stream`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-disable-introspection`	`2.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-graphql-sse`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-jwt`	`2.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-persisted-operations`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-prometheus`	`5.2.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-response-cache`	`3.7.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/plugin-sofa`	`3.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎
`@graphql-yoga/render-graphiql`	`5.5.0-alpha-20240628224657-b1bfc8af`	npm ↗︎ unpkg ↗︎

EmrysMyrddin

As said in slack, I would prefere to give access to the extra params in a seperate ctx field.

n1ru4l · 2024-06-28T09:23:54Z

.changeset/eighty-books-wonder.md

+});
+
+console.assert(res.status === 200);
+```


Should we also add this to the normal documentation?

Maybe a section called "Request customization", where we show this and also how you can set a custom GraphQL request parser?

0203957
What do you think?

enisdenjo · 2024-06-28T09:29:10Z

As said in slack, I would prefere to give access to the extra params in a seperate ctx field.

@EmrysMyrddin why?

enisdenjo · 2024-06-28T09:31:09Z

packages/graphql-yoga/__tests__/requests.spec.ts

@@ -402,6 +402,26 @@ describe('requests', () => {
    expect(body.errors?.[0].message).toBe('Unexpected parameter "test" in the request body.');
  });

+  it('does not error if there is a specified invalid parameter in the request body', async () => {


Maybe also add a test of having a field that's not specified in the extraParamNames?

Good idea! Done!
5f07980

n1ru4l

approved, bit lets add also some basic documentation

…discussion_r1658423243

ardatan requested review from enisdenjo, n1ru4l and EmrysMyrddin June 27, 2024 18:38

EmrysMyrddin approved these changes Jun 28, 2024

View reviewed changes

n1ru4l reviewed Jun 28, 2024

View reviewed changes

enisdenjo reviewed Jun 28, 2024

View reviewed changes

n1ru4l approved these changes Jun 28, 2024

View reviewed changes

ardatan referenced this pull request Jun 28, 2024

Apply feedback https://github.com/dotansimha/graphql-yoga/pull/3333\#…

5f07980

…discussion_r1658423243

ardatan referenced this pull request Jun 28, 2024

Apply feedback https://github.com/dotansimha/graphql-yoga/pull/3333\#…

c3b0b77

…discussion_r1658423243

ardatan force-pushed the extra-params-in-body branch from 0203957 to 8b8684e Compare June 28, 2024 20:07

ardatan requested review from saihaj, enisdenjo, EmrysMyrddin and n1ru4l June 28, 2024 20:08

ardatan added 4 commits June 28, 2024 23:39

feat: allow extra params in body

8698f69

Apply feedback https://github.com/dotansimha/graphql-yoga/pull/3333\#…

b3bfaf7

…discussion_r1658423243

Docs

dc0f497

Update request-customization.mdx

2d04aeb

ardatan force-pushed the extra-params-in-body branch from 1405e9b to 2d04aeb Compare June 28, 2024 20:39

Prettier

b1bfc8a

enisdenjo approved these changes Jul 1, 2024

View reviewed changes

n1ru4l approved these changes Jul 1, 2024

View reviewed changes

ardatan merged commit 9f3f945 into main Jul 1, 2024
35 checks passed

ardatan deleted the extra-params-in-body branch July 1, 2024 10:54

theguild-bot mentioned this pull request Jul 1, 2024

Upcoming Release Changes #3337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow extra params in body #3333

feat: allow extra params in body #3333

ardatan commented Jun 27, 2024

changeset-bot bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

EmrysMyrddin left a comment

n1ru4l Jun 28, 2024

ardatan Jun 28, 2024

enisdenjo commented Jun 28, 2024

enisdenjo Jun 28, 2024

ardatan Jun 28, 2024 •

edited

Loading

n1ru4l left a comment

feat: allow extra params in body #3333

feat: allow extra params in body #3333

Conversation

ardatan commented Jun 27, 2024

changeset-bot bot commented Jun 27, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Jun 27, 2024 • edited Loading

💻 Website Preview

github-actions bot commented Jun 27, 2024 • edited Loading

✅ Benchmark Results

github-actions bot commented Jun 27, 2024 • edited Loading

Apollo Federation Subgraph Compatibility Results

github-actions bot commented Jun 27, 2024 • edited Loading

🚀 Snapshot Release (alpha)

EmrysMyrddin left a comment

Choose a reason for hiding this comment

n1ru4l Jun 28, 2024

Choose a reason for hiding this comment

ardatan Jun 28, 2024

Choose a reason for hiding this comment

enisdenjo commented Jun 28, 2024

enisdenjo Jun 28, 2024

Choose a reason for hiding this comment

ardatan Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

n1ru4l left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

🚀 Snapshot Release (`alpha`)

ardatan Jun 28, 2024 •

edited

Loading