Yoga v1 migration guidance

[ghoshrahul]

I was using GraphQL Yoga version 1.18.3 and am planning to upgrade to v2 using the migration guide. I have a couple of doubts regarding a few things:-

1. In version 1, we could pass an options flag, for our server.start(options) , where options contained a few parameters like port, endpoint, bodyParserOptions. The guide does not cover the same in v2. Please point me to the exact docs for the same. Old docs
2. In version 1, the yoga server had express app attached. I believe it is removed in version 2. Do I need to import express as a separate dependency for the same?
3. Is there a way to attach additional context to the request and response object? For example I want to attach a request-id to request and response, before forwarding the request to downstream service.

Please let me know if any information is required.

[ardatan]

In version 1, we could pass an options flag, for our server.start(options) , where options contained a few parameters like port, endpoint, bodyParserOptions. The guide does not cover the same in v2. Please point me to the exact docs for the same.

You can pass those parameters in createServer's options.
https://github.com/dotansimha/graphql-yoga/blob/master/packages/node/src/types.ts#L16
You're right it seems we don't have docs for those. I'll create an issue for that.

In version 1, the yoga server had express app attached. I believe it is removed in version 2. Do I need to import express as a separate dependency for the same?

By default, Yoga doesn't need an extra framework. You can just start the standalone server without any extra dependencies. But if you have some Express middlewares etc, you should setup an extra Express app and plug Yoga into it like we describe in our docs;
https://www.graphql-yoga.com/docs/integrations/integration-with-express#example

Is there a way to attach additional context to the request and response object? For example I want to attach a request-id to request and response, before forwarding the request to downstream service.

You can access incoming request and outgoing response objects through the context.
https://www.graphql-yoga.com/docs/features/context#nodejs-standalone-express-and-nextjs-etc

[ghoshrahul]

Thank you for the quick reply @ardatan

By default, Yoga doesn't need an extra framework. You can just start the standalone server without any extra dependencies. But if you have some Express middlewares etc, you should setup an extra Express app and plug Yoga into it like we describe in our docs;
https://www.graphql-yoga.com/docs/integrations/integration-with-express#example

In this we had used it as a graphQL server as well as exposing certain rest endpoints. So I had leveraged that option in the older version. So if I provide a port on the graphQL server, attach it to express app, and then ask the express app to listen to a different port, what is the expected outcome? This is not clear to me.

I will try out the other suggestions in the meanwhile and report if any issues faced.

[ardatan]

Those options are used only if you use Yoga as a standalone server. If you plug it into an Express app, all those options will be ignored. You can consider it like a regular Express middleware that doesn't care the port, hostname and the path.

[ghoshrahul]

@ardatan

You can pass those parameters in createServer's options.
https://github.com/dotansimha/graphql-yoga/blob/master/packages/node/src/types.ts#L16

I have checked this link that you have shared. The port option is available, but I don't see anything regarding bodyParserOptions. This is something that I will require, as we are using the more than the default option of 100Kb

[ardatan]

I have checked this link that you have shared. The port option is available, but I don't see anything regarding bodyParserOptions. This is something that I will require, as we are using the more than the default option of 100Kb

You can use Express's body parser options because we don't have this kind of additional steps in Yoga.

[ghoshrahul]

Thank you @ardatan , I have done as you mentioned here and am happy to report that this part is working successfully.