feat: support undici v7

Author: 3846masa

MIGRATION.md

@@ -1,9 +1,57 @@
 # MIGRATION GUIDES
 
+## Migration guide from v6.x.x to v7.0.0
+
+- [Node.js v18 is no longer supported.](#nodejs-v18-is-no-longer-supported)
+- [When using global fetch with Node.js v22, v23, v24, undici v6 should be installed.](#when-using-global-fetch-with-nodejs-v22-v23-v24-undici-v6-should-be-installed)
+- [undici v7 supports](#undici-v7-supports)
+
+### Node.js v18 is no longer supported.
+
+Node.js v18 is no longer supported.
+
+### When using global fetch with Node.js v22, v23, v24, undici v6 should be installed.
+
+The global fetch built-in to Node.js v20, v22, and v23 is undici v6.
+
+So, you should install undici v6 and then load `CookieAgent` from `http-cookie-agent/undici/v6`.
+
+```diff
+- import { CookieAgent } from 'http-cookie-agent/undici';
++ import { CookieAgent } from 'http-cookie-agent/undici/v6';
+```
+
+### undici v7 supports
+
+When using `CookieClient` or `createCookieClient`, you should replace it with the compose method.
+
+```diff
+- import { CookieClient } from 'http-cookie-agent/undici';
++ import { cookie } from 'http-cookie-agent/undici';
++ import { Client } from 'undici';
+
+- const client = new CookieClient('https://example.com', { cookie: { jar } });
++ const client = new Client('https://example.com').compose(cookie({ jar }));
+```
+
+When using `CookieAgent`, you can use the code as is.
+If you want to redirect like undici v6, you can add a "redirect" feature with the compose method.
+
+```typescript
+import { CookieAgent } from 'http-cookie-agent/undici';
+import { CookieJar } from 'tough-cookie';
+import { fetch, interceptors } from 'undici';
+
+const jar = new CookieJar();
+const agent = new CookieAgent({ cookies: { jar } }).compose(interceptors.redirect());
+
+await fetch('https://example.com', { dispatcher: agent, maxRedirections: 3 });
+```
+
 ## Migration guide from v2.x.x to v4.0.0
 
 - [The import path has been changed.](#the-import-path-has-been-changed)
-- [The property name for passing cookiejar to agent has been changed.](#the-property-name-for-passing-cookiejar-to-agent-has-been-changed)
+- [The property name for passing CookieJar to Agent has been changed.](#the-property-name-for-passing-cookiejar-to-agent-has-been-changed)
 - [Using synchronous CookieJar functions by default.](#using-synchronous-cookiejar-functions-by-default)
 
 ### The import path has been changed.

README.md

@@ -14,7 +14,6 @@ Allows cookies with every Node.js HTTP clients (e.g. Node.js global fetch, undic
 - [Install](#install)
 - [Usage](#usage)
   - [Supported libraries](#supported-libraries)
-  - [Using with an asynchronous Cookie store](#using-with-an-asynchronous-cookie-store)
   - [Using with another Agent library](#using-with-another-agent-library)
 - [Contributing](#contributing)
 - [License](#license)
@@ -86,6 +85,23 @@ const agent = new CookieAgent({ cookies: { jar } });
 await fetch('https://example.com', { dispatcher: agent });
 ```
 
+Alternatively, `http-cookie-agent` can be used as [interceptors](https://github.com/nodejs/undici/blob/v7.0.0/docs/docs/api/Dispatcher.md#dispatchercomposeinterceptors-interceptor).
+In this case, the `cookie()` must be placed at the beginning of the interceptors.
+
+```js
+import { fetch, interceptors } from 'undici';
+import { CookieJar } from 'tough-cookie';
+import { cookie } from 'http-cookie-agent/undici';
+
+const jar = new CookieJar();
+const agent = new Agent()
+  .compose(cookie({ jar }))
+  .compose(interceptors.retry())
+  .compose(interceptors.redirect({ maxRedirections: 3 }));
+
+await fetch('https://example.com', { dispatcher: agent });
+```
+
 #### `node:http` / `node:https`
 
 ```js
@@ -258,7 +274,7 @@ await client.get('https://example.com');
 ```js
 import { request, setGlobalDispatcher } from 'urllib';
 import { CookieJar } from 'tough-cookie';
-import { CookieClient } from 'http-cookie-agent/undici';
+import { CookieAgent } from 'http-cookie-agent/undici';
 
 const jar = new CookieJar();
 const agent = new CookieAgent({ cookies: { jar } });
@@ -290,44 +306,17 @@ https.get('https://example.com', { agent }, (res) => {
 
 #### `undici`
 
-If you want to use another undici Agent library, use `CookieClient` via factory function.
+If you want to use another undici Agent library, use `cookie` with the compose method.
 
 ```js
 import { fetch, ProxyAgent } from 'undici';
 import { CookieJar } from 'tough-cookie';
-import { CookieClient } from 'http-cookie-agent/undici';
+import { cookie } from 'http-cookie-agent/undici';
 
 const jar = new CookieJar();
 const agent = new ProxyAgent({
-  factory: (origin, opts) => {
-    return new CookieClient(origin, {
-      ...opts,
-      cookies: { jar },
-    });
-  },
-});
-
-await fetch('https://example.com', { dispatcher: agent });
-```
-
-If you want to use another undici Client library, wrap the client in `createCookieClient`.
-
-```js
-import { fetch, Agent, MockClient } from 'undici';
-import { CookieJar } from 'tough-cookie';
-import { createCookieClient } from 'http-cookie-agent/undici';
-
-const CookieClient = createCookieClient(MockClient);
-
-const jar = new CookieJar();
-const agent = new Agent({
-  factory: (origin, opts) => {
-    return new CookieClient(origin, {
-      ...opts,
-      cookies: { jar },
-    });
-  },
-});
+  /* ... */
+}).compose(cookie({ jar }));
 
 await fetch('https://example.com', { dispatcher: agent });
 ```

examples/undici/proxy.mjs

@@ -1,6 +1,6 @@
 import http from 'node:http';
 
-import { CookieClient } from 'http-cookie-agent/undici';
+import { cookie } from 'http-cookie-agent/undici';
 import { createProxy } from 'proxy';
 import { CookieJar } from 'tough-cookie';
 import { fetch, ProxyAgent } from 'undici';
@@ -11,9 +11,8 @@ proxyServer.listen(9000);
 
 const jar = new CookieJar();
 const agent = new ProxyAgent({
-  factory: (origin, /** @type {object} */ opts) => new CookieClient(origin, { ...opts, cookies: { jar } }),
   uri: 'http://127.0.0.1:9000',
-});
+}).compose(cookie({ jar }));
 
 await fetch('https://httpbin.org/cookies/set/session/userid', { dispatcher: agent });
 

examples/undici/with_interceptor.mjs

@@ -0,0 +1,14 @@
+import { CookieAgent } from 'http-cookie-agent/undici';
+import { CookieJar } from 'tough-cookie';
+import { fetch, interceptors } from 'undici';
+
+const jar = new CookieJar();
+const agent = new CookieAgent({ cookies: { jar } }).compose(
+  interceptors.retry(),
+  interceptors.redirect({ maxRedirections: 3 }),
+);
+
+await fetch('https://httpbin.org/cookies/set/session/userid', { dispatcher: agent });
+
+const cookies = await jar.getCookies('https://httpbin.org');
+console.log(cookies);

package.json

@@ -97,11 +97,11 @@
     "typescript": "5.8.3",
     "undici": "7.8.0",
     "undici@v6": "npm:[email protected]",
-    "urllib": "4.4.0"
+    "urllib": "4.6.11"
   },
   "peerDependencies": {
     "tough-cookie": "^4.0.0 || ^5.0.0",
-    "undici": "^5.11.0 || ^6.0.0"
+    "undici": "^7.0.0"
   },
   "peerDependenciesMeta": {
     "undici": {