Throw and reject Promise with an Error

ngbrown · baelter · commit 7d11630238e5 · 2023-08-23T11:10:20.000+02:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -13,6 +13,8 @@
   },
   "plugins": ["@typescript-eslint"],
   "rules": {
-    "@typescript-eslint/consistent-type-imports": "error"
+    "@typescript-eslint/consistent-type-imports": "error",
+    "prefer-promise-reject-errors": "error",
+    "no-throw-literal": "error"
   }
 }
diff --git a/src/amqp-socket-client.ts b/src/amqp-socket-client.ts
@@ -99,7 +99,7 @@ export class AMQPClient extends AMQPBaseClient {
         // first 7 bytes of a frame was split over two reads, this reads the second part
         if (this.framePos !== 0) {
           const copied = buf.copy(this.frameBuffer, this.framePos, bufPos, bufPos + 7 - this.framePos)
-          if (copied === 0) throw `Copied 0 bytes framePos=${this.framePos} bufPos=${bufPos} bytesWritten=${bufLen}`
+          if (copied === 0) throw new AMQPError(`Copied 0 bytes framePos=${this.framePos} bufPos=${bufPos} bytesWritten=${bufLen}`, this)
           this.frameSize = this.frameBuffer.readInt32BE(bufPos + 3) + 8
           this.framePos += copied
           bufPos += copied
@@ -108,7 +108,7 @@ export class AMQPClient extends AMQPBaseClient {
         // frame header is split over reads, copy to frameBuffer
         if (bufPos + 3 + 4 > bufLen) {
           const copied = buf.copy(this.frameBuffer, this.framePos, bufPos, bufLen)
-          if (copied === 0) throw `Copied 0 bytes framePos=${this.framePos} bufPos=${bufPos} bytesWritten=${bufLen}`
+          if (copied === 0) throw new AMQPError(`Copied 0 bytes framePos=${this.framePos} bufPos=${bufPos} bytesWritten=${bufLen}`, this)
           this.framePos += copied
           break
         }
@@ -128,7 +128,7 @@ export class AMQPClient extends AMQPBaseClient {
       const leftOfFrame = this.frameSize - this.framePos
       const copyBytes = Math.min(leftOfFrame, bufLen - bufPos)
       const copied = buf.copy(this.frameBuffer, this.framePos, bufPos, bufPos + copyBytes)
-      if (copied === 0) throw `Copied 0 bytes, please report this bug, frameSize=${this.frameSize} framePos=${this.framePos} bufPos=${bufPos} copyBytes=${copyBytes} bytesWritten=${bufLen}`
+      if (copied === 0) throw new AMQPError(`Copied 0 bytes, please report this bug, frameSize=${this.frameSize} framePos=${this.framePos} bufPos=${bufPos} copyBytes=${copyBytes} bytesWritten=${bufLen}`, this)
       this.framePos += copied
       bufPos += copied
       if (this.framePos === this.frameSize) {
diff --git a/src/amqp-view.ts b/src/amqp-view.ts
@@ -272,7 +272,7 @@ export class AMQPView extends DataView {
         break
       }
       default:
-        throw `Field type '${k}' not supported`
+        throw new Error(`Field type '${k}' not supported`)
     }
     return [v, i - byteOffset]
   }
@@ -333,7 +333,7 @@ export class AMQPView extends DataView {
         }
         break
       default:
-        throw `Unsupported field type '${field}'`
+        throw new Error(`Unsupported field type '${field}'`)
     }
     return i - byteOffset
   }
diff --git a/src/amqp-websocket-client.ts b/src/amqp-websocket-client.ts
@@ -76,7 +76,7 @@ export class AMQPWebSocketClient extends AMQPBaseClient {
           reject(err)
         }
       } else {
-        reject("Socket not connected")
+        reject(new AMQPError("Socket not connected", this))
       }
     })
   }
diff --git a/test-browser/websocket.ts b/test-browser/websocket.ts
@@ -593,7 +593,7 @@ test("onerror is not called when conn is closed by client", async () => {
   const conn = await amqp.connect()
   const callbackPromise = new Promise((done, reject) => {
   conn.onerror = vi.fn(
-      (err: AMQPError) => reject(`onerror should not be called when gracefully closed. Error was: ${err.message}`)
+      (err: AMQPError) => reject(new Error(`onerror should not be called when gracefully closed. Error was: ${err.message}`))
   )
     setTimeout(done, 10)
   })
diff --git a/test/test.ts b/test/test.ts
@@ -598,7 +598,7 @@ test("onerror is not called when conn is closed by client", async () => {
   const conn = await amqp.connect()
   const callbackPromise = new Promise((done, reject) => {
     conn.onerror = vi.fn(
-      (err: AMQPError) => reject(`onerror should not be called when gracefully closed. Error was: ${err.message}`)
+      (err: AMQPError) => reject(new Error(`onerror should not be called when gracefully closed. Error was: ${err.message}`))
     )
     setTimeout(done, 10)
   })

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`},`
`14`	`14`	`"plugins": ["@typescript-eslint"],`
`15`	`15`	`"rules": {`
`16`		`- "@typescript-eslint/consistent-type-imports": "error"`
	`16`	`+ "@typescript-eslint/consistent-type-imports": "error",`
	`17`	`+ "prefer-promise-reject-errors": "error",`
	`18`	`+ "no-throw-literal": "error"`
`17`	`19`	`}`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -272,7 +272,7 @@ export class AMQPView extends DataView {`
`272`	`272`	`break`
`273`	`273`	`}`
`274`	`274`	`default:`
`275`		- throw `Field type '${k}' not supported`
	`275`	+ throw new Error(`Field type '${k}' not supported`)
`276`	`276`	`}`
`277`	`277`	`return [v, i - byteOffset]`
`278`	`278`	`}`
`@@ -333,7 +333,7 @@ export class AMQPView extends DataView {`
`333`	`333`	`}`
`334`	`334`	`break`
`335`	`335`	`default:`
`336`		- throw `Unsupported field type '${field}'`
	`336`	+ throw new Error(`Unsupported field type '${field}'`)
`337`	`337`	`}`
`338`	`338`	`return i - byteOffset`
`339`	`339`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ export class AMQPWebSocketClient extends AMQPBaseClient {`
`76`	`76`	`reject(err)`
`77`	`77`	`}`
`78`	`78`	`} else {`
`79`		`- reject("Socket not connected")`
	`79`	`+ reject(new AMQPError("Socket not connected", this))`
`80`	`80`	`}`
`81`	`81`	`})`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -593,7 +593,7 @@ test("onerror is not called when conn is closed by client", async () => {`
`593`	`593`	`const conn = await amqp.connect()`
`594`	`594`	`const callbackPromise = new Promise((done, reject) => {`
`595`	`595`	`conn.onerror = vi.fn(`
`596`		- (err: AMQPError) => reject(`onerror should not be called when gracefully closed. Error was: ${err.message}`)
	`596`	+ (err: AMQPError) => reject(new Error(`onerror should not be called when gracefully closed. Error was: ${err.message}`))
`597`	`597`	`)`
`598`	`598`	`setTimeout(done, 10)`
`599`	`599`	`})`
Original file line number	Diff line number	Diff line change
`@@ -598,7 +598,7 @@ test("onerror is not called when conn is closed by client", async () => {`
`598`	`598`	`const conn = await amqp.connect()`
`599`	`599`	`const callbackPromise = new Promise((done, reject) => {`
`600`	`600`	`conn.onerror = vi.fn(`
`601`		- (err: AMQPError) => reject(`onerror should not be called when gracefully closed. Error was: ${err.message}`)
	`601`	+ (err: AMQPError) => reject(new Error(`onerror should not be called when gracefully closed. Error was: ${err.message}`))
`602`	`602`	`)`
`603`	`603`	`setTimeout(done, 10)`
`604`	`604`	`})`