Merge pull request #20552 from overleaf/ac-update-node-fetch-2

Reapply "Upgrade node-fetch to 2.7.0", Fix fetch-utils tests

GitOrigin-RevId: b42a2d2c50ce73f474e39755845e4df065f30b48

libraries/fetch-utils/package.json

@@ -27,7 +27,7 @@
   "dependencies": {
     "@overleaf/o-error": "*",
     "lodash": "^4.17.21",
-    "node-fetch": "^2.6.11",
+    "node-fetch": "^2.7.0",
     "selfsigned": "^2.4.1"
   }
 }

libraries/fetch-utils/test/unit/FetchUtilsTests.js

@@ -1,5 +1,5 @@
 const { expect } = require('chai')
-const { FetchError } = require('node-fetch')
+const { FetchError, AbortError } = require('node-fetch')
 const { Readable } = require('stream')
 const { once } = require('events')
 const { TestServer } = require('./helpers/TestServer')
@@ -15,8 +15,6 @@ const {
   CustomHttpsAgent,
 } = require('../..')
 
-const abortErrorMessage = 'The user aborted a request'
-
 const HTTP_PORT = 30001
 const HTTPS_PORT = 30002
 
@@ -106,8 +104,11 @@ describe('fetch-utils', function () {
 
     it('supports abort signals', async function () {
       await expect(
-        fetchJson(this.url('/hang'), { signal: AbortSignal.timeout(10) })
-      ).to.be.rejectedWith(abortErrorMessage)
+        abortOnceReceived(
+          signal => fetchJson(this.url('/hang'), { signal }),
+          this.server
+        )
+      ).to.be.rejectedWith(AbortError)
       await expectRequestAborted(this.server.lastReq)
     })
 
@@ -148,7 +149,7 @@ describe('fetch-utils', function () {
         body: stream,
       })
       stream.destroy()
-      await expect(promise).to.be.rejectedWith(abortErrorMessage)
+      await expect(promise).to.be.rejectedWith(AbortError)
       await wait(80)
       expect(this.server.lastReq).to.be.undefined
     })
@@ -162,7 +163,7 @@ describe('fetch-utils', function () {
       })
       await once(this.server.events, 'request-received')
       stream.destroy()
-      await expect(promise).to.be.rejectedWith(abortErrorMessage)
+      await expect(promise).to.be.rejectedWith(AbortError)
       await expectRequestAborted(this.server.lastReq)
     })
 
@@ -175,20 +176,27 @@ describe('fetch-utils', function () {
 
     it('supports abort signals', async function () {
       await expect(
-        fetchStream(this.url('/hang'), { signal: AbortSignal.timeout(10) })
-      ).to.be.rejectedWith(abortErrorMessage)
+        abortOnceReceived(
+          signal => fetchStream(this.url('/hang'), { signal }),
+          this.server
+        )
+      ).to.be.rejectedWith(AbortError)
       await expectRequestAborted(this.server.lastReq)
     })
 
     it('destroys the request body when an error occurs', async function () {
       const stream = Readable.from(infiniteIterator())
       await expect(
-        fetchStream(this.url('/hang'), {
-          method: 'POST',
-          body: stream,
-          signal: AbortSignal.timeout(10),
-        })
-      ).to.be.rejectedWith(abortErrorMessage)
+        abortOnceReceived(
+          signal =>
+            fetchStream(this.url('/hang'), {
+              method: 'POST',
+              body: stream,
+              signal,
+            }),
+          this.server
+        )
+      ).to.be.rejectedWith(AbortError)
       expect(stream.destroyed).to.be.true
     })
   })
@@ -206,7 +214,7 @@ describe('fetch-utils', function () {
         body: stream,
       })
       stream.destroy()
-      await expect(promise).to.be.rejectedWith(abortErrorMessage)
+      await expect(promise).to.be.rejectedWith(AbortError)
       expect(this.server.lastReq).to.be.undefined
     })
 
@@ -219,7 +227,7 @@ describe('fetch-utils', function () {
       })
       await once(this.server.events, 'request-received')
       stream.destroy()
-      await expect(promise).to.be.rejectedWith(abortErrorMessage)
+      await expect(promise).to.be.rejectedWith(AbortError)
       await wait(80)
       await expectRequestAborted(this.server.lastReq)
     })
@@ -238,20 +246,27 @@ describe('fetch-utils', function () {
 
     it('supports abort signals', async function () {
       await expect(
-        fetchNothing(this.url('/hang'), { signal: AbortSignal.timeout(10) })
-      ).to.be.rejectedWith(abortErrorMessage)
+        abortOnceReceived(
+          signal => fetchNothing(this.url('/hang'), { signal }),
+          this.server
+        )
+      ).to.be.rejectedWith(AbortError)
       await expectRequestAborted(this.server.lastReq)
     })
 
     it('destroys the request body when an error occurs', async function () {
       const stream = Readable.from(infiniteIterator())
       await expect(
-        fetchNothing(this.url('/hang'), {
-          method: 'POST',
-          body: stream,
-          signal: AbortSignal.timeout(10),
-        })
-      ).to.be.rejectedWith(abortErrorMessage)
+        abortOnceReceived(
+          signal =>
+            fetchNothing(this.url('/hang'), {
+              method: 'POST',
+              body: stream,
+              signal,
+            }),
+          this.server
+        )
+      ).to.be.rejectedWith(AbortError)
       expect(stream.destroyed).to.be.true
     })
   })
@@ -365,6 +380,18 @@ async function* infiniteIterator() {
   }
 }
 
+/**
+ * @param {(signal: AbortSignal) => Promise<any>} func
+ * @param {TestServer} server
+ */
+async function abortOnceReceived(func, server) {
+  const controller = new AbortController()
+  const promise = func(controller.signal)
+  await once(server.events, 'request-received')
+  controller.abort()
+  return await promise
+}
+
 async function expectRequestAborted(req) {
   if (!req.destroyed) {
     try {
@@ -376,8 +403,8 @@ async function expectRequestAborted(req) {
         throw err
       }
     }
-    expect(req.destroyed).to.be.true
   }
+  expect(req.destroyed).to.be.true
 }
 
 const wait = ms => new Promise(resolve => setTimeout(resolve, ms))

libraries/fetch-utils/test/unit/helpers/TestServer.js

@@ -12,6 +12,7 @@ class TestServer {
 
     this.app.use(bodyParser.json())
     this.app.use((req, res, next) => {
+      this.events.emit('request-received')
       this.lastReq = req
       next()
     })
@@ -40,7 +41,6 @@ class TestServer {
     })
 
     this.app.post('/sink', (req, res) => {
-      this.events.emit('request-received')
       req.on('data', () => {})
       req.on('end', () => {
         res.status(204).end()