feat: Implementing Conditional Schema Support in @graphql-yoga/nestjs

[magrinj]

Problem

In the current implementation of graphql-yoga, users have the flexibility to pass a function to the schema property, facilitating the setup of a conditional schema. Unfortunately, this functionality is not mirrored in the @graphql-yoga/nestjs package, creating a limitation when working with frameworks like Nest.JS, which appears to have restricted support for conditional schemas in the GraphQLModule.

At Twenty, we have a specific requirement to determine schemas dynamically based on the tenant to enable custom objects for our customers. The absence of this feature in the @graphql-yoga/nestjs package hinders our ability to provide a more personalized and scalable service.

Solution

To bridge this gap, I have introduced a new option called conditionalSchema. This option allows for the merging of conditional schema directives with the existing schema property, thereby enhancing flexibility and functionality. This enhancement not only preserves the autoSchemaFile option but also introduces the possibility to incorporate conditional schemas within the generated ones.

Changes Made:

• Introduced a conditionalSchema option in the @graphql-yoga/nestjs package.
• Ensured compatibility with the existing schema property.
• Facilitated the integration of conditional schema elements within generated schemas.

Request for Feedback

I'm requiring your feedback on this implementation. Specifically, I am keen to understand potential edge cases or concerns that might arise with this enhancement.

[changeset-bot]

🦋 Changeset detected

Latest commit: 98ff4cd

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

This PR includes changesets to release 24 packages

Name	Type
@graphql-yoga/nestjs	Major
graphql-yoga	Minor
@graphql-yoga/nestjs-federation	Patch
@graphql-yoga/render-graphiql	Major
@graphql-yoga/plugin-apollo-inline-trace	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
functions	Patch
hackernews	Patch
nextjs-app	Patch
hello-world-benchmark	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

[n1ru4l]

Can you please add a test that confirms the changes work as expected?

[magrinj]

@n1ru4l I've added a test, let me know if it's of for you !

[enisdenjo]

This looks good, thanks! Can you please rung pnpm changeset to version the package, thanks!

[magrinj]

@enisdenjo I just ran the pnpm changeset command and rebase my PR

[enisdenjo]

Great stuff @magrinj, thank you very much! And sorry for the delay. 😬

[enisdenjo]

Oh, I just saw the CI, I see the build is failing - can you check whats up please?

[magrinj]

@enisdenjo Oh yes sorry, I was using the wrong type for conditionalSchema, instead of creating a new one, I've exposed the one from graphql-yoga package.
I've run pnpm changeset in minor but I'm not sure because both package need to be in their last version to make it work.

[enisdenjo]

Final change. 😄

[enisdenjo]

Great job! Thanks!

[enisdenjo]

@magrinj some tests are failing, can you please check. Sorry for the back and forth...

[magrinj]

@enisdenjo Is there any way we can discuss like Discord ? Actually the problem seems a bit complex, and I think I need some suggestion to fix it.
Seems like subscription are broken when I provide a schema property.

[enisdenjo]

@magrinj I am not very active on Discord, how about Slack? If you're ok with that, please provide me an e-mail and I'll invite you as a guest to our Slack!

[magrinj]

@enisdenjo Of course no I've Slack too, you can invite me on contact@magrin.fr
Thanks !

[enisdenjo]

@magrinj invite's out!

[magrinj]

@enisdenjo Thanks a lot, I'll try to reach you tomorrow if you're available

[enisdenjo]

Great! Looking forward to hearing from you.

[magrinj]

@enisdenjo Ok so for now, I've disabled conditionalSchema option with subscriptions.
I'm trying to make another PR with your help to implement the subscription support.

[enisdenjo]

Great job @magrinj! I'll merge this and cut a new version.

[enisdenjo]

@magrinj now we have Bun checks failing (see job). 😬

Can you check it out?

[magrinj]

@enisdenjo Hello, sorry for the delay, I've some days off this week.
I don't really understand what's happening for now, I don't think I'll have time to take a look this week, but maybe next week !

[magrinj]

@enisdenjo I've fix the issue, it was a small one sorry of the delay...

[enisdenjo]

@magrinj this looks great to me, we ready to merge?

[EmrysMyrddin]

@enisdenjo Did you noticed that the changeset set bot is triggering a major version on lots of packaging ? Not sure why

[enisdenjo]

Good catch. 🤔

I don't know why though. The changesets in this PR are all minor. Could be that the bot has a brainfart?

[EmrysMyrddin]

I don't know ^^'
Do you think we can just merge it and see what happens on master ?

[enisdenjo]

Do you think we can just merge it and see what happens on master ?

Let's see. 😄

[github-actions]

✅ 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% ✓ 422316      ✗ 0     
     data_received................................: 1.7 GB  14 MB/s
     data_sent....................................: 85 MB   710 kB/s
     http_req_blocked.............................: avg=1.39µs   min=941ns    med=1.27µs   max=245.28µs p(90)=1.78µs   p(95)=1.99µs  
     http_req_connecting..........................: avg=2ns      min=0s       med=0s       max=130.48µs p(90)=0s       p(95)=0s      
     http_req_duration............................: avg=363.6µs  min=199.5µs  med=319.29µs max=14.1ms   p(90)=519.47µs p(95)=538.74µs
       { expected_response:true }.................: avg=363.6µs  min=199.5µs  med=319.29µs max=14.1ms   p(90)=519.47µs p(95)=538.74µs
     ✓ { mode:graphql-jit }.......................: avg=274.4µs  min=199.5µs  med=254.21µs max=14.1ms   p(90)=284.84µs p(95)=295.85µs
     ✓ { mode:graphql-no-parse-validate-cache }...: avg=546.16µs min=432.38µs med=519.54µs max=9.79ms   p(90)=558.68µs p(95)=587.76µs
     ✓ { mode:graphql-response-cache }............: avg=337.85µs min=264.44µs med=319.97µs max=6.6ms    p(90)=351.51µs p(95)=361.79µs
     ✓ { mode:graphql }...........................: avg=359.61µs min=264.17µs med=328.11µs max=12.75ms  p(90)=371.7µs  p(95)=413.52µs
     http_req_failed..............................: 0.00%   ✓ 0           ✗ 211158
     http_req_receiving...........................: avg=31.78µs  min=16.22µs  med=31.88µs  max=7.19ms   p(90)=37.23µs  p(95)=39.36µs 
     http_req_sending.............................: avg=7.67µs   min=5.38µs   med=6.98µs   max=379.04µs p(90)=10.16µs  p(95)=10.86µs 
     http_req_tls_handshaking.....................: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting.............................: avg=324.13µs min=168.75µs med=280.62µs max=14.02ms  p(90)=479.92µs p(95)=497.27µs
     http_reqs....................................: 211158  1759.627026/s
     iteration_duration...........................: avg=563.66µs min=365.37µs med=515.54µs max=15.96ms  p(90)=722.9µs  p(95)=746.31µs
     iterations...................................: 211158  1759.627026/s
     vus..........................................: 1       min=1         max=1   
     vus_max......................................: 2       min=2         max=2   

[enisdenjo]

@EmrysMyrddin seems like the changesets are a-ok. See #3148.

[magrinj]

Thanks for the merge ! 🙂