fix: change set-cookie type define to string | string[] (#471)

fengmk2 · web-flow · commit 674915a2be7b · 2023-09-19T10:51:01.000+08:00
closes #467
diff --git a/.gitignore b/.gitignore
@@ -14,4 +14,4 @@ src/**/*.d.ts
 test/fixtures/ts/*.js
 test/fixtures/ts-esm/*.js
 .eslintcache
-.tshy/
+.tshy*
diff --git a/package.json b/package.json
@@ -76,6 +76,7 @@
     "mime-types": "^2.1.35",
     "pump": "^3.0.0",
     "qs": "^6.11.2",
+    "type-fest": "^4.3.1",
     "undici": "^5.22.1",
     "ylru": "^1.3.2"
   },
diff --git a/src/HttpClient.ts b/src/HttpClient.ts
@@ -2,7 +2,6 @@ import diagnosticsChannel from 'node:diagnostics_channel';
 import { EventEmitter } from 'node:events';
 import { LookupFunction } from 'node:net';
 import { STATUS_CODES } from 'node:http';
-import type { IncomingHttpHeaders } from 'node:http';
 import { debuglog } from 'node:util';
 import {
   createGunzip,
@@ -31,6 +30,7 @@ import pump from 'pump';
 // Compatible with old style formstream
 import FormStream from 'formstream';
 import { HttpAgent, CheckAddressFunction } from './HttpAgent.js';
+import type { IncomingHttpHeaders } from './IncomingHttpHeaders.js';
 import { RequestURL, RequestOptions, HttpMethod, RequestMeta } from './Request.js';
 import { RawResponseWithMeta, HttpClientResponse, SocketInfo } from './Response.js';
 import { parseJSON, sleep, digestAuthHeader, globalId, performanceTime, isReadable } from './utils.js';
diff --git a/src/IncomingHttpHeaders.ts b/src/IncomingHttpHeaders.ts
@@ -0,0 +1,7 @@
+import type { Except } from 'type-fest';
+import type { IncomingHttpHeaders as HTTPIncomingHttpHeaders } from 'node:http';
+
+// fix set-cookie type define https://github.com/nodejs/undici/pull/1893
+export interface IncomingHttpHeaders extends Except<HTTPIncomingHttpHeaders, 'set-cookie'> {
+  'set-cookie'?: string | string[];
+}
diff --git a/src/Request.ts b/src/Request.ts
@@ -1,9 +1,7 @@
-import { Readable, Writable } from 'node:stream';
-import type { IncomingHttpHeaders } from 'node:http';
+import type { Readable, Writable } from 'node:stream';
 import type { Dispatcher } from 'undici';
-import type {
-  HttpClientResponse,
-} from './Response.js';
+import type { IncomingHttpHeaders } from './IncomingHttpHeaders.js';
+import type { HttpClientResponse } from './Response.js';
 
 export type HttpMethod = Dispatcher.HttpMethod;
 
diff --git a/src/Response.ts b/src/Response.ts
@@ -1,5 +1,5 @@
-import { Readable } from 'node:stream';
-import { IncomingHttpHeaders } from 'node:http';
+import type { Readable } from 'node:stream';
+import type { IncomingHttpHeaders } from './IncomingHttpHeaders.js';
 
 export type SocketInfo = {
   id: number;
diff --git a/src/index.ts b/src/index.ts
@@ -46,7 +46,13 @@ export {
   FixJSONCtlCharsHandler, FixJSONCtlChars,
 } from './Request.js';
 
-export { SocketInfo, Timing, RawResponseWithMeta, HttpClientResponse } from './Response.js';
+export {
+  SocketInfo, Timing, RawResponseWithMeta, HttpClientResponse,
+} from './Response.js';
+export {
+  IncomingHttpHeaders,
+} from './IncomingHttpHeaders.js';
+
 
 export default {
   request,
diff --git a/test/fixtures/server.ts b/test/fixtures/server.ts
@@ -133,6 +133,18 @@ export async function startServer(options?: {
       return res.end('<h1>hello</h1>');
     }
 
+    if (pathname === '/set-one-cookie') {
+      res.setHeader('set-cookie', 'foo=bar; path=/');
+      res.setHeader('content-type', 'text/html');
+      return res.end('<h1>hello set-cookie</h1>');
+    }
+
+    if (pathname === '/set-two-cookie') {
+      res.setHeader('Set-Cookie', [ 'foo=bar; path=/', 'hello=world; path=/' ]);
+      res.setHeader('content-type', 'text/html');
+      return res.end('<h1>hello set-cookie</h1>');
+    }
+
     if (pathname === '/redirect') {
       res.setHeader('Location', '/redirect-to-url');
       res.statusCode = 302;
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -30,6 +30,28 @@ describe('index.test.ts', () => {
       assert(!response.redirected);
     });
 
+    it('should response set-cookie as a string', async () => {
+      const response = await urllib.request(`${_url}set-one-cookie`);
+      assert.equal(response.status, 200);
+      assert.equal(typeof response.headers['set-cookie'], 'string');
+      assert.equal(response.headers['set-cookie'], 'foo=bar; path=/');
+      assert.equal(response.headers['Set-Cookie'], undefined);
+      assert.equal(response.headers['content-type'], 'text/html');
+      assert.equal(response.headers['content-length'], '25');
+    });
+
+    it('should response set-cookie as an array string', async () => {
+      const response = await urllib.request(`${_url}set-two-cookie`);
+      assert.equal(response.status, 200);
+      assert(Array.isArray(response.headers['set-cookie']));
+      assert.equal(typeof response.headers['set-cookie'], 'object');
+      assert.deepEqual(response.headers['set-cookie'], [
+        'foo=bar; path=/',
+        'hello=world; path=/',
+      ]);
+      assert.equal(response.headers['Set-Cookie'], undefined);
+    });
+
     it('should request with T response data', async () => {
       type HelloData = {
         hello: string;
diff --git a/test/mts/src/index.mts b/test/mts/src/index.mts
@@ -1,8 +1,9 @@
-import { request } from "urllib";
+import { request, IncomingHttpHeaders } from "urllib";
 const responseObj = await request("test");
 
 type IsAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
 (x: IsAny<number, true, never>) => x; // never
 (x: IsAny<any, true, never>) => x; // true
 
 (x: IsAny<typeof responseObj, true, never>) => x; // true
+console.log(responseObj.headers as IncomingHttpHeaders);
