Less magic numbers, use constant for frame_max setting

baelter · baelter · commit 3782a002a4e1 · 2026-02-25T10:52:37.000+01:00
diff --git a/src/amqp-base-client.ts b/src/amqp-base-client.ts
@@ -6,6 +6,7 @@ import { AMQPView } from "./amqp-view.js"
 import type { Logger } from "./types.js"
 
 export const VERSION = "3.4.1"
+export const MIN_FRAME_SIZE = 4096 // 8192
 
 /**
  * Base class for AMQPClients.
@@ -44,7 +45,7 @@ export abstract class AMQPBaseClient {
     password: string,
     name?: string,
     platform?: string,
-    frameMax = 8192,
+    frameMax = MIN_FRAME_SIZE,
     heartbeat = 0,
     channelMax = 0,
     logger?: Logger | null,
@@ -61,7 +62,7 @@ export abstract class AMQPBaseClient {
     this.logger = logger || undefined
     this.channels = [new AMQPChannel(this, 0)]
     this.onerror = (error: AMQPError) => this.logger?.error("amqp-client connection closed", error.message)
-    if (frameMax < 8192) throw new Error("frameMax must be 8192 or larger")
+    if (frameMax < MIN_FRAME_SIZE) throw new Error(`frameMax must be ${MIN_FRAME_SIZE} or larger`)
     this.frameMax = frameMax
     if (heartbeat < 0) throw new Error("heartbeat must be positive")
     this.heartbeat = heartbeat
diff --git a/src/amqp-socket-client.ts b/src/amqp-socket-client.ts
@@ -1,4 +1,4 @@
-import { AMQPBaseClient } from "./amqp-base-client.js"
+import { AMQPBaseClient, MIN_FRAME_SIZE } from "./amqp-base-client.js"
 import { AMQPError } from "./amqp-error.js"
 import type { AMQPTlsOptions } from "./amqp-tls-options.js"
 import type { Logger } from "./types.js"
@@ -32,7 +32,7 @@ export class AMQPClient extends AMQPBaseClient {
     const username = decodeURIComponent(u.username) || "guest"
     const password = decodeURIComponent(u.password) || "guest"
     const name = u.searchParams.get("name") || ""
-    const frameMax = parseInt(u.searchParams.get("frameMax") || "8192")
+    const frameMax = parseInt(u.searchParams.get("frameMax") || MIN_FRAME_SIZE.toString())
     const heartbeat = parseInt(u.searchParams.get("heartbeat") || "0")
     const channelMax = parseInt(u.searchParams.get("channelMax") || "0")
     const platform = `${process.release.name} ${process.version} ${process.platform} ${process.arch}`
diff --git a/src/amqp-websocket-client.ts b/src/amqp-websocket-client.ts
@@ -1,4 +1,4 @@
-import { AMQPBaseClient, VERSION } from "./amqp-base-client.js"
+import { AMQPBaseClient, VERSION, MIN_FRAME_SIZE } from "./amqp-base-client.js"
 import { AMQPView } from "./amqp-view.js"
 import { AMQPError } from "./amqp-error.js"
 import { AMQPChannel } from "./amqp-channel.js"
@@ -49,7 +49,7 @@ export class AMQPWebSocketClient extends AMQPBaseClient {
     username = "guest",
     password = "guest",
     name?: string,
-    frameMax = 8192,
+    frameMax = MIN_FRAME_SIZE,
     heartbeat = 0,
     logger?: Logger | null,
   ) {
diff --git a/test-browser/websocket.ts b/test-browser/websocket.ts
@@ -705,7 +705,7 @@ test("onerror is not called when conn is closed by client", async () => {
 })
 
 test("will throw on too large headers", async () => {
-  const amqp = getNewClient({ frameMax: 8192 })
+  const amqp = getNewClient()
   const conn = await amqp.connect()
   const ch = await conn.channel()
   await expect(
@@ -717,7 +717,7 @@ test("will throw on too large headers", async () => {
 })
 
 test("will split body over multiple frames", async () => {
-  const amqp = getNewClient({ frameMax: 8192 })
+  const amqp = getNewClient()
   const conn = await amqp.connect()
   const ch = await conn.channel()
   const q = await ch.queue("")
diff --git a/test/test.ts b/test/test.ts
@@ -786,7 +786,7 @@ test("onerror is not called when conn is closed by client", async () => {
 })
 
 test("will throw on too large headers", async () => {
-  const amqp = getNewClient({ frameMax: 8192 })
+  const amqp = getNewClient()
   const conn = await amqp.connect()
   const ch = await conn.channel()
   await expect(
@@ -798,7 +798,7 @@ test("will throw on too large headers", async () => {
 })
 
 test("will split body over multiple frames", async () => {
-  const amqp = getNewClient({ frameMax: 8192 })
+  const amqp = getNewClient()
   const conn = await amqp.connect()
   const ch = await conn.channel()
   const q = await ch.queue("")
