[v3] express.use() on custom path does not work without setting graphqlEndpoint

[charlypoly]

The following code example returns 404 when querying /api/v1/graphql:

const app = express();

const yoga = createYoga({
	schema: // ...
});

app.use(`/api/v1/graphql`, yoga);

However, it works with the following:

const app = express();

const yoga = createYoga({
    graphqlEndpoint: `/api/v1/graphql`,
	schema: // ...
});

app.use(`/api/v1/graphql`, yoga);

If this is the expected behavior, we should document it 📖

[EmrysMyrddin]

I have added a failing test case.
The problem is not exactly what is shown in the given example. The bug appears only when the endpoint doesn't end with /graphql.

I'm working on a fix, but for now I'm not sure how I can do this without introducing a breaking change.

[ardatan]

You have to define graphqlEndpoint in createYoga.

app.use('/my-path', 
  createYoga({
     ....,
     graphqlEndpoint: '/my-path'
  })
)

[EmrysMyrddin]

Yes, that's a workaround, but I'm trying to find a fix which doesn't require the developer to duplicate the endpoint setting.

If I don't find a good way to do it, I will just try to improve documentation to make it clear graphqlEndpoint is mandatory even when using external http server router.

[ardatan]

No it is not a workaround. It hasn't been documented yet, this is why we keep this issue open.

[EmrysMyrddin]

Ok, I will update the documentation then :-)
Thank you for the clarification !

[EmrysMyrddin]

@ardatan Do you think I have to add this information in every pages in the "Integrations" category ?

[Vince-Smith]

No it is not a workaround. It hasn't been documented yet, this is why we keep this issue open.

@ardatan I know this is closed, but I came across this recently and did a little digging and just wanted to confirm.

graphql-yoga/packages/graphql-yoga/src/plugins/use-unhandled-route.ts

Lines 55 to 56 in eca7cd1

	url.pathname !== args.graphqlEndpoint &&
	url.pathname !== `${args.graphqlEndpoint}/` &&

Is there any reason that these calls couldn't be changed to:

 !url.pathname.endsWith(args.graphqlEndpoint) && 
 !url.pathname.endsWith(`${args.graphqlEndpoint}/`) && 

Reason being right now I don't really have a custom graphql endpoint, it's still the default of /graphql it's just nested in middlewares like /api/v1/graphql.

I would expect graphqlEndpoint to be used if I wanted to expose graphql somewhere like /foo or /api/v1/foo.

[ardatan]

I would expect graphqlEndpoint to be used if I wanted to expose graphql somewhere like /foo or /api/v1/foo.

But this is an assumption, when you provide /foo as graphqlEndpoint, then it will handle /foo, /somerandom/foo, and any combination ending with /foo which is an incorrect behavior. That's why it needs to be explicit.