Replacing node-fetch with cross-fetch (#687)

* installing cross-fetch

* implementing cross-fetch

* Correcting web3 dependancy

* importing types from cross-fetch

* fixing dependancies

* adding imports from cross/fetch/lib

* changing .buffer() to .arrayBufer()

* implementing timeout-signal

* chaning require statements to import statements

* fixing require/import issues

* using default import for timeoutSignal

* fixing linting issues

* fixing dependancy issue

* lint fix

* fix timeout

Signed-off-by: mihaisc <mihai.scarlat@smartcontrol.ro>

* add abort controller compatible with browser and node

Signed-off-by: mihaisc <mihai.scarlat@smartcontrol.ro>

Co-authored-by: mihaisc <mihai.scarlat@smartcontrol.ro>

package.json

@@ -38,17 +38,18 @@
   },
   "homepage": "https://github.com/oceanprotocol/ocean.js#readme",
   "peerDependencies": {
-    "web3": "^1.2.3"
+    "web3": "^1.3.4"
   },
   "dependencies": {
     "@ethereum-navigator/navigator": "^0.5.2",
     "@oceanprotocol/contracts": "^0.5.10",
     "@types/crypto-js": "^4.0.1",
+    "cross-fetch": "^3.1.2",
     "crypto-js": "^4.0.0",
     "decimal.js": "^10.2.1",
     "fs": "0.0.1-security",
     "lzma": "^2.3.2",
-    "node-fetch": "^2.6.1",
+    "node-abort-controller": "^1.2.0",
     "save-file": "^2.3.1",
     "uuid": "^8.3.2",
     "web3": "^1.3.4",
@@ -60,8 +61,8 @@
     "@types/chai": "^4.2.11",
     "@types/chai-spies": "^1.0.1",
     "@types/mocha": "^8.0.3",
-    "@types/node": "^14.14.20",
-    "@types/node-fetch": "^2.5.5",
+    "@types/node": "^14.14.35",
+    "@types/node-fetch": "^2.5.8",
     "@typescript-eslint/eslint-plugin": "^4.13.0",
     "@typescript-eslint/parser": "^4.13.0",
     "auto-changelog": "^2.2.1",

src/ocean/utils/WebServiceConnector.ts

@@ -1,11 +1,9 @@
-import { BodyInit, RequestInit, Response } from 'node-fetch'
+import { Response } from 'node-fetch'
 import fs from 'fs'
 import { Logger } from '../../utils'
 import save from 'save-file'
-// import { createWriteStream } from 'streamsaver'
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const fetch = require('node-fetch')
+import timeoutSignal from '../../utils/Timeout'
+const fetch = require('cross-fetch')
 
 /**
  * Provides a common interface to web services.
@@ -40,12 +38,12 @@ export class WebServiceConnector {
         method: 'POST',
         body: payload,
         headers,
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     } else {
       return this.fetch(url, {
         method: 'POST',
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     }
   }
@@ -56,7 +54,7 @@ export class WebServiceConnector {
       headers: {
         'Content-type': 'application/json'
       },
-      timeout: 5000
+      signal: timeoutSignal(5000)
     })
   }
 
@@ -68,15 +66,15 @@ export class WebServiceConnector {
         headers: {
           'Content-type': 'application/json'
         },
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     } else {
       return this.fetch(url, {
         method: 'PUT',
         headers: {
           'Content-type': 'application/json'
         },
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     }
   }
@@ -89,15 +87,15 @@ export class WebServiceConnector {
         headers: {
           'Content-type': 'application/json'
         },
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     } else {
       return this.fetch(url, {
         method: 'DELETE',
         headers: {
           'Content-type': 'application/json'
         },
-        timeout: 5000
+        signal: timeoutSignal(5000)
       })
     }
   }

src/provider/Provider.ts

@@ -7,13 +7,9 @@ import { ComputeInput } from '../ocean/interfaces/ComputeInput'
 import { Output } from '../ocean/interfaces/ComputeOutput'
 import { MetadataAlgorithm } from '../ddo/interfaces/MetadataAlgorithm'
 import { Versions } from '../ocean/Versions'
-import { Response } from 'node-fetch'
 import { DDO } from '../ddo/DDO'
 import DID from '../ocean/DID'
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const fetch = require('node-fetch')
-
 export interface ServiceEndpoint {
   serviceName: string
   method: string

src/utils/Timeout.ts

@@ -0,0 +1,17 @@
+import AbortController from 'node-abort-controller'
+
+export default function timeoutSignal(timeout: number) {
+  if (!Number.isInteger(timeout)) {
+    throw new TypeError(`Expected an integer, got ${typeof timeout}`)
+  }
+  const signalMap = new WeakMap()
+  const controller = new AbortController()
+
+  const timeoutId = setTimeout(() => {
+    controller.abort()
+  }, timeout)
+
+  signalMap.set(controller.signal, timeoutId)
+  // any is needed due to some type incompatibility
+  return controller.signal as any
+}

test/unit/__mocks__/WebServiceConnector.mock.ts

@@ -1,5 +1,5 @@
 import { WebServiceConnector } from '../../../src/ocean/utils/WebServiceConnector'
-import { RequestInit } from 'node-fetch'
+import { RequestInit } from 'cross-fetch/lib.fetch'
 
 export default class WebServiceConnectorMock extends (WebServiceConnector as any) {
   constructor(private returnData: any) {