Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing headers (using Fastify) #91

Closed
kireerik opened this issue Jan 19, 2024 · 6 comments
Closed

missing headers (using Fastify) #91

kireerik opened this issue Jan 19, 2024 · 6 comments
Labels
bug Something isn't working help wanted Extra attention is needed released Has been released and published

Comments

@kireerik
Copy link

We are using @fastify/ cors and cookies and the headers are missing when using this library.

If I change this line (

reply.raw.writeHead(init.status, init.statusText, init.headers);
) like this (

    reply.raw.writeHead(init.status, init.statusText, {...reply.getHeaders(), ...init.headers});

) then the cors headers are not missing, but the cookie header is still missing.

@enisdenjo
Copy link
Owner

Hey there, the Cookie header does not come from the server - it comes only from the client (see MDN).

However, a server can send a Set-Cookie header though. Can you try that?

Regarding the rest of the headers, a PR is very welcome - would you consider opening one? Thanks in advance!

@enisdenjo enisdenjo added the bug Something isn't working label Jan 21, 2024
@kireerik
Copy link
Author

kireerik commented Jan 22, 2024

Hi, yes, that's what is not working as well. We are using @fastify/cookie to set a cookie from the server side using Set-Cookie.

Sure, I can for sure create a pull request for the cors case. However the missing Set-Cookie header is a bit unclear for me. I am not sure how should I get it. We set the cookie from a (GraphQL) (mutation) resolver (using @fastify/cookie).

@enisdenjo
Copy link
Owner

Is the set-cookie header present without graphql-sse? Maybe it is not in the getHeaders (you can check that by console logging the results)?

@kireerik
Copy link
Author

kireerik commented Jan 22, 2024

Yes, it is. Yes it is not in the getHeaders.

Anyway. Now we are using the GraphQL Yoga server which (after resolving 2 issues related to it) seems to work as expected.

related issue:

@enisdenjo enisdenjo added the help wanted Extra attention is needed label Jan 26, 2024
enisdenjo pushed a commit that referenced this issue Mar 27, 2024
## [2.5.3](v2.5.2...v2.5.3) (2024-03-27)

### Bug Fixes

* **use/fastify:** Include middleware headers ([134c1b0](134c1b0)), closes [#91](#91)
@enisdenjo
Copy link
Owner

🎉 This issue has been resolved in version 2.5.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@enisdenjo enisdenjo added the released Has been released and published label Mar 27, 2024
@enisdenjo
Copy link
Owner

Sorry for waiting so long! This issue has been fixed with 134c1b0 and released in v2.5.3. Please check it out, thanks!

pholuj-candis pushed a commit to CandisIO/graphql-sse that referenced this issue Oct 10, 2024
# 1.0.0 (2024-10-10)

### Bug Fixes

* Add file extensions to imports/exports in ESM type definitions ([bbf23b1](bbf23b1))
* Add koa exports to package.json ([enisdenjo#85](https://github.com/CandisIO/graphql-sse/issues/85)) ([e99cf99](e99cf99))
* Add support for `graphql@v16` ([89367f2](89367f2))
* Add types path to package.json `exports` ([44f95b6](44f95b6))
* Bump `graphql` version to v16 in package.json ([af219f9](af219f9))
* **client:** Abort request when reporting error ([91057bd](91057bd))
* **client:** Avoid bundling DOM types, have the implementor supply his own `Response` type ([98780c0](98780c0))
* **client:** Leverage active streams for reliable network error retries ([607b468](607b468))
* **client:** Network errors during event emission contain the keyword "stream" in Firefox ([054f16b](054f16b))
* **client:** Operation requests are of application/json content-type ([0084de7](0084de7))
* **client:** Respect retry attempts when server goes away after connecting ([enisdenjo#57](https://github.com/CandisIO/graphql-sse/issues/57)) ([75c9f17](75c9f17)), closes [enisdenjo#55](https://github.com/CandisIO/graphql-sse/issues/55)
* **client:** Respect retry attempts when server goes away after connecting in single connection mode ([enisdenjo#59](https://github.com/CandisIO/graphql-sse/issues/59)) ([e895c5b](e895c5b)), closes [enisdenjo#55](https://github.com/CandisIO/graphql-sse/issues/55)
* **client:** Retry if connection is closed while having active streams ([83a0178](83a0178)), closes [enisdenjo#28](https://github.com/CandisIO/graphql-sse/issues/28)
* **client:** Retry network errors even if they occur during event emission ([489b1b0](489b1b0)), closes [enisdenjo#27](https://github.com/CandisIO/graphql-sse/issues/27)
* **client:** Should not call complete after subscription error ([d8b7634](d8b7634))
* **client:** TypeScript generic for ensuring proper arguments when using "single connection mode" ([be2ae7d](be2ae7d))
* **client:** Use closures instead of bindings (with `this`) ([8ecdf3c](8ecdf3c))
* Define graphql execution results ([89da803](89da803))
* **handler:** Always include the `data` field in stream messages ([enisdenjo#71](https://github.com/CandisIO/graphql-sse/issues/71)) ([4643c9a](4643c9a))
* **handler:** Correct typings and support for http2 ([08d6ca3](08d6ca3)), closes [enisdenjo#38](https://github.com/CandisIO/graphql-sse/issues/38)
* **handler:** Detect `ExecutionArgs` in `onSubscribe` return value ([a16b921](a16b921)), closes [enisdenjo#58](https://github.com/CandisIO/graphql-sse/issues/58)
* **handler:** Support generics for requests and responses ([9ab10c0](9ab10c0))
* **handler:** Use 3rd `body` argument only if is object or string ([2062579](2062579))
* Prefer `X-GraphQL-Event-Stream-Token` header name for clarity ([9aaa0a9](9aaa0a9))
* remove package.json workspaces entry in release ([c6dc093](c6dc093))
* Request parameters `query` field can only be a string ([16c9600](16c9600)), closes [enisdenjo#65](https://github.com/CandisIO/graphql-sse/issues/65)
* **server:** Operation result can be async generator or iterable ([24b6078](24b6078))
* **use/express,use/fastify:** Resolve body if previously parsed ([6573e94](6573e94))
* **use/express:** make sure that we not send something through previously closed stream ([e4b8c5f](e4b8c5f))
* **use/fastify:** Include middleware headers ([134c1b0](134c1b0)), closes [enisdenjo#91](https://github.com/CandisIO/graphql-sse/issues/91)
* **use/http,use/http2,use/express,use/fastify:** Check `writable` instead of `closed` before writing to response ([3c71f69](3c71f69)), closes [enisdenjo#69](https://github.com/CandisIO/graphql-sse/issues/69)
* **use/http,use/http2,use/express,use/fastify:** Handle cases where response's `close` event is late ([enisdenjo#75](https://github.com/CandisIO/graphql-sse/issues/75)) ([4457cba](4457cba)), closes [enisdenjo#69](https://github.com/CandisIO/graphql-sse/issues/69)
* **use/koa:** Use parsed body from request ([enisdenjo#87](https://github.com/CandisIO/graphql-sse/issues/87)) ([b290b90](b290b90))

### Features

* Client ([enisdenjo#3](https://github.com/CandisIO/graphql-sse/issues/3)) ([754487d](754487d))
* **client:** Accept `referrer` and `referrerPolicy` fetch options ([enisdenjo#32](https://github.com/CandisIO/graphql-sse/issues/32)) ([dbaa90a](dbaa90a))
* **client:** Add `credentials` property for requests ([79d0266](79d0266))
* **client:** Add `lazyCloseTimeout` as a close timeout after last operation completes ([16e5e31](16e5e31)), closes [enisdenjo#17](https://github.com/CandisIO/graphql-sse/issues/17)
* **client:** Async iterator for subscriptions ([enisdenjo#66](https://github.com/CandisIO/graphql-sse/issues/66)) ([fb8bf11](fb8bf11))
* **client:** Event listeners for both operation modes ([enisdenjo#84](https://github.com/CandisIO/graphql-sse/issues/84)) ([6274f44](6274f44))
* **client:** Inspect incoming messages through `ClientOptions.onMessage` ([496e74b](496e74b)), closes [enisdenjo#20](https://github.com/CandisIO/graphql-sse/issues/20)
* **handler:** Export handler options type for each integration ([2a2e517](2a2e517))
* **handler:** Server and environment agnostic handler ([enisdenjo#37](https://github.com/CandisIO/graphql-sse/issues/37)) ([22cf03d](22cf03d))
* **handler:** Use Koa ([enisdenjo#80](https://github.com/CandisIO/graphql-sse/issues/80)) ([283b453](283b453)), closes [enisdenjo#78](https://github.com/CandisIO/graphql-sse/issues/78)
* Server request handler ([enisdenjo#2](https://github.com/CandisIO/graphql-sse/issues/2)) ([8381796](8381796))
* **use/koa:** expose full Koa context to options ([enisdenjo#86](https://github.com/CandisIO/graphql-sse/issues/86)) ([b37a6f9](b37a6f9))

### Performance Improvements

* **client:** Avoid recreating result variables when reading the response stream ([16f6a6c](16f6a6c))

### BREAKING CHANGES

* **handler:** The handler is now server agnostic and can run _anywhere_

- Core of `graphql-sse` is now server agnostic and as such offers a handler that implements a generic request/response model
- Handler does not await for whole operation to complete anymore. Only the processing part (parsing, validating and executing)
- GraphQL context is now typed
- Hook arguments have been changed, they're not providing the Node native req/res anymore - they instead provide the generic request/response
- `onSubscribe` hook can now return an execution result too (useful for caching for example)
- Throwing in `onNext` and `onComplete` hooks will bubble the error to the returned iterator

### Migration

Even though the core of graphql-sse is now completely server agnostic, there are adapters to ease the integration with existing solutions. Migrating is actually not a headache!

Beware that the adapters **don't** handle internal errors, it's your responsibility to take care of that and behave accordingly.

#### [`http`](https://nodejs.org/api/http.html)

```diff
import http from 'http';
- import { createHandler } from 'graphql-sse';
+ import { createHandler } from 'graphql-sse/lib/use/http';

// Create the GraphQL over SSE handler
const handler = createHandler({ schema });

// Create an HTTP server using the handler on `/graphql/stream`
const server = http.createServer((req, res) => {
  if (req.url.startsWith('/graphql/stream')) {
    return handler(req, res);
  }
  res.writeHead(404).end();
});

server.listen(4000);
console.log('Listening to port 4000');
```

#### [`http2`](https://nodejs.org/api/http2.html)

```diff
import fs from 'fs';
import http2 from 'http2';
- import { createHandler } from 'graphql-sse';
+ import { createHandler } from 'graphql-sse/lib/use/http2';

// Create the GraphQL over SSE handler
const handler = createHandler({ schema });

// Create an HTTP server using the handler on `/graphql/stream`
const server = http.createServer((req, res) => {
  if (req.url.startsWith('/graphql/stream')) {
    return handler(req, res);
  }
  res.writeHead(404).end();
});

server.listen(4000);
console.log('Listening to port 4000');
```

#### [`express`](https://expressjs.com/)

```diff
import express from 'express'; // yarn add express
- import { createHandler } from 'graphql-sse';
+ import { createHandler } from 'graphql-sse/lib/use/express';

// Create the GraphQL over SSE handler
const handler = createHandler({ schema });

// Create an express app
const app = express();

// Serve all methods on `/graphql/stream`
app.use('/graphql/stream', handler);

server.listen(4000);
console.log('Listening to port 4000');
```

#### [`fastify`](https://www.fastify.io/)

```diff
import Fastify from 'fastify'; // yarn add fastify
- import { createHandler } from 'graphql-sse';
+ import { createHandler } from 'graphql-sse/lib/use/fastify';

// Create the GraphQL over SSE handler
const handler = createHandler({ schema });

// Create a fastify app
const fastify = Fastify();

// Serve all methods on `/graphql/stream`
fastify.all('/graphql/stream', handler);

fastify.listen({ port: 4000 });
console.log('Listening to port 4000');
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed released Has been released and published
Projects
None yet
Development

No branches or pull requests

2 participants