amqplib 2.2.0 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log for amqplib
 
+## v2.2.1
+- Return the server acknowledgement from promise-based `channel.cancel`, matching the callback API (thanks [@edsonsims](https://github.com/edsonsims)).
+- Type `cancel` replies as `Replies.Cancel` (`{ consumerTag }`) in both the promise and callback API declarations, which previously claimed `Replies.Empty`.
+- Fix callback-based `waitForConfirms` never calling back when invoked after the confirm channel closed with unconfirmed messages; it now yields a `channel closed` error, matching the promise API (thanks [@youdie006](https://github.com/youdie006)).
+- `waitForConfirms` (both APIs) now always fails with `channel closed` after the channel closes with unconfirmed messages. Previously it reported success if every outstanding message had its own callback, or on any call after the first.
+- The callback API's `waitForConfirms` callback is now required in the TypeScript declarations, matching the docs. Calling it without one threw at runtime.
+- Replace `.npmignore` with a `files` allowlist in `package.json` so the published package no longer includes tests, tooling config, dotfiles or the defs generator. Install size drops from 577 kB to 358 kB (fixes #859, thanks [@rubiesonthesky](https://github.com/rubiesonthesky))
+
 ## v2.2.0
 - Add `calculateDelay` recovery option for supplying a custom reconnect delay strategy, e.g. full jitter, decorrelated jitter or a fixed schedule. When set, `maxDelay` is not applied to its return value; when it throws or returns an invalid value, recovery gives up as if `maxRetries` were exhausted (fixes #855, thanks [@GiHoon1123](https://github.com/GiHoon1123))
 - The built-in reconnect delay no longer exceeds `maxDelay`. Previously the cap was applied before jitter, so delays could overshoot it by up to the jitter fraction. The exponential base is now capped at `maxDelay / (1 + jitter)` so the full jitter range fits under the cap; with default settings the steady-state delay is now spread over 20-30s rather than 24-36s

package/callback_api.d.ts

@@ -103,7 +103,7 @@ export interface Channel extends events.EventEmitter {
     callback?: (err: Error, ok: Replies.Consume) => void,
   ): void;
 
-  cancel(consumerTag: string, callback?: (err: Error, ok: Replies.Empty) => void): void;
+  cancel(consumerTag: string, callback?: (err: Error, ok: Replies.Cancel) => void): void;
   get(queue: string, options?: Options.Get, callback?: (err: Error, ok: GetMessage | false) => void): void;
 
   ack(message: Message, allUpTo?: boolean): void;
@@ -132,7 +132,7 @@ export interface ConfirmChannel extends Channel {
     callback?: (err: Error, ok: Replies.Empty) => void,
   ): boolean;
 
-  waitForConfirms(callback?: (err?: Error) => void): void;
+  waitForConfirms(callback: (err?: Error) => void): void;
 }
 
 export declare class IllegalOperationError extends Error {

package/index.d.ts

@@ -77,7 +77,7 @@ export interface Channel extends events.EventEmitter {
     options?: Options.Consume,
   ): Promise<Replies.Consume>;
 
-  cancel(consumerTag: string): Promise<Replies.Empty>;
+  cancel(consumerTag: string): Promise<Replies.Cancel>;
   get(queue: string, options?: Options.Get): Promise<GetMessage | false>;
 
   ack(message: Message, allUpTo?: boolean): void;

package/lib/callback_model.js

@@ -255,28 +255,9 @@ class ConfirmChannel extends Channel {
   }
 
   waitForConfirms(k) {
-    const awaiting = [];
-    const unconfirmed = this.unconfirmed;
-    unconfirmed.forEach((val, index) => {
-      if (val === null); // already confirmed
-      else {
-        const confirmed = new Promise((resolve, reject) => {
-          unconfirmed[index] = (err) => {
-            if (val) val(err);
-            if (err === null) resolve();
-            else reject(err);
-          };
-        });
-        awaiting.push(confirmed);
-      }
-    });
-    return Promise.all(awaiting).then(
-      () => {
-        k();
-      },
-      (err) => {
-        k(err);
-      },
+    this._waitForConfirms().then(
+      () => k(),
+      (err) => k(err),
     );
   }
 }

package/lib/channel.js

@@ -21,6 +21,7 @@ class Channel extends EventEmitter {
     // for unconfirmed messages
     this.lwm = 1; // the least, unconfirmed deliveryTag
     this.unconfirmed = []; // rolling window of delivery callbacks
+    this.closedWithUnconfirmed = false;
     this.on(
       'ack',
       this.handleConfirm.bind(this, (cb) => {
@@ -39,7 +40,10 @@ class Channel extends EventEmitter {
         const cb = this.unconfirmed[i];
         if (cb) cb(err);
       }
-      this.unconfirmed = this.unconfirmed.filter((cb) => cb === false);
+      // Remember that confirms were lost, so every later waitForConfirms
+      // fails, whether or not the messages had their own callbacks
+      this.closedWithUnconfirmed = this.unconfirmed.some((cb) => cb !== null);
+      this.unconfirmed = [];
     });
     // message frame state machine
     this.handleMessage = acceptDeliveryOrReturn;
@@ -243,6 +247,28 @@ class Channel extends EventEmitter {
     }
   }
 
+  // Resolves once every outstanding message is confirmed, and rejects on
+  // the first nack, or if the channel closes before all are confirmed.
+  // Shared by the promise and callback ConfirmChannel#waitForConfirms.
+  _waitForConfirms() {
+    if (this.closedWithUnconfirmed) return Promise.reject(new Error('channel closed'));
+    const awaiting = [];
+    const unconfirmed = this.unconfirmed;
+    unconfirmed.forEach((cb, index) => {
+      if (cb !== null) {
+        const confirmed = new Promise((resolve, reject) => {
+          unconfirmed[index] = (err) => {
+            if (cb) cb(err);
+            if (err === null) resolve();
+            else reject(err);
+          };
+        });
+        awaiting.push(confirmed);
+      }
+    });
+    return Promise.all(awaiting);
+  }
+
   pushConfirmCallback(cb) {
     // `null` is used specifically for marking already confirmed slots,
     // so I coerce `undefined` and `null` to false; functions are never

package/lib/channel_model.js

@@ -146,12 +146,9 @@ class Channel extends BaseChannel {
   }
 
   async cancel(consumerTag) {
-    await promisify((cb) => {
-      this._rpc(defs.BasicCancel, Args.cancel(consumerTag), defs.BasicCancelOk, cb);
-    })().then((ok) => {
-      this.unregisterConsumer(consumerTag);
-      return ok.fields;
-    });
+    const fields = await this.rpc(defs.BasicCancel, Args.cancel(consumerTag), defs.BasicCancelOk);
+    this.unregisterConsumer(consumerTag);
+    return fields;
   }
 
   get(queue, options) {
@@ -234,29 +231,7 @@ class ConfirmChannel extends Channel {
   }
 
   waitForConfirms() {
-    const awaiting = [];
-    const unconfirmed = this.unconfirmed;
-    unconfirmed.forEach((cb, index) => {
-      if (cb !== null) {
-        const confirmed = new Promise((resolve, reject) => {
-          unconfirmed[index] = (err) => {
-            if (cb) cb(err);
-            if (err === null) resolve();
-            else reject(err);
-          };
-        });
-        awaiting.push(confirmed);
-      }
-    });
-    // Channel closed
-    if (!this.pending) {
-      const err = new Error('channel closed');
-      while (unconfirmed.length > 0) {
-        const cb = unconfirmed.shift();
-        if (cb) cb(err);
-      }
-    }
-    return Promise.all(awaiting);
+    return this._waitForConfirms();
   }
 }
 

package/lib/properties.d.ts

@@ -19,6 +19,9 @@ export namespace Replies {
   interface Consume {
     consumerTag: string;
   }
+  interface Cancel {
+    consumerTag: string;
+  }
 }
 
 export namespace Options {

package/package.json

@@ -2,7 +2,7 @@
   "name": "amqplib",
   "homepage": "http://amqp-node.github.io/amqplib/",
   "main": "./channel_api.js",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -46,5 +46,15 @@
     "RabbitMQ"
   ],
   "author": "Michael Bridgen <mikeb@squaremobius.net>",
-  "license": "MIT"
+  "license": "MIT",
+  "files": [
+    "lib",
+    "examples",
+    "channel_api.js",
+    "callback_api.js",
+    "index.d.ts",
+    "callback_api.d.ts",
+    "CHANGELOG.md",
+    "LICENSE-MIT"
+  ]
 }

package/.claude/commands/lint-disable.md

@@ -1,9 +0,0 @@
-Please follow the following process when I ask you to disable a lint rule using /lint-disable $rule
-
-1. Create and change to a new branch. Ask for the branch name.
-2. If the rule is off by default, delete it (See https://biomejs.dev/linter/javascript/rules/ for rule details)
-3. If the rule is on by default, configure it to off in biome.json
-4. Update the project changelog
-5. Add the changes
-6. Commit the changes
-7. Push the changes

package/.claude/commands/lint-enable.md

@@ -1,12 +0,0 @@
-Please follow the following process when I ask you to enable a lint rule using /lint-enable $rule
-
-1. Create and change to a new branch. Ask for the branch name.
-2. Configure the rule to error in biome.json
-3. Run lint (npm run lint). If there are NO errors, goto step 8
-4. Use biome to SAFELY auto fix (npm run lint -- --fix). If there are errors stop and ask for instruction.
-5. Run the tests (npm test). If there are errors, stop and ask for instruction.
-6. If the rule defaults to error, delete it (See https://biomejs.dev/linter/javascript/rules/ for rule details)
-7. Update the project changelog
-8. Add the changes
-9. Commit the changes
-10. Push the changes

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,41 +0,0 @@
----
-name: Bug report / Support request
-about: Report a bug or ask for help
-title: ''
-labels: ''
-assignees: ''
-
----
-
-Before reporting a bug or requesting support please... 
-
-1. Read the troubleshooting guide
-
-   - https://amqp-node.github.io/amqplib/#troubleshooting
-
-2. Search for existing open and closed issues
-
-   - https://github.com/amqp-node/amqplib/issues?q=is%3Aissue+TYPE+YOUR+KEYWORDS+HERE
-
-3. Ensure you are familiar with the amqplib Channel API and RabbitMQ basics
-
-   - https://amqp-node.github.io/amqplib/channel_api.html
-   - https://www.cloudamqp.com/blog/part1-rabbitmq-for-beginners-what-is-rabbitmq.html
-   - https://www.rabbitmq.com/tutorials/amqp-concepts.html
-
-If the above does not help, please provide as much of the following information as is relevant...
-
-  - A clear and concise description of the problem
-  - RabbitMQ version
-  - amqplib version
-  - Node.js version
-  - The simplest possible code snippet that demonstrates the problem
-  - A stack trace
-
-Please format code snippets and/or stack traces using GitHub Markdown
-
-  - https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
-
-Thank you
-
-

package/.github/workflows/publish.yml

@@ -1,113 +0,0 @@
-# Runs when a GitHub release is published (draft releases do not trigger it).
-#
-# Tests the tagged commit on every supported Node.js version, then stages the
-# package on npm with `npm stage publish` using OIDC trusted publishing, so no
-# npm token is stored in this repository. Nothing goes live until a maintainer
-# reviews the staged version and approves it with 2FA:
-#
-#   npm stage list amqplib
-#   npm stage approve <stage-id>
-#
-# Prerequisites on npmjs.com: the package's trusted publisher must be set to
-# this repository and this workflow file (publish.yml), with allowed actions
-# restricted to `npm stage publish`.
-
-name: Publish
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    services:
-      rabbitmq:
-        image: rabbitmq:4.2-alpine
-        ports:
-          - 5672:5672
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x, 24.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "npm"
-
-      - run: npm ci
-
-      - name: Wait for RabbitMQ
-        run: |
-          n=0
-          while :
-          do
-            sleep 5
-            echo 'HELO\n\n\n\n' | nc localhost 5672 | grep AMQP
-            [[ $? = 0 ]] && break || ((n++))
-            (( n >= 5 )) && break
-          done
-
-      - run: echo 'HELO\n\n\n\n' | nc localhost 5672 | grep AMQP
-
-      - run: make test
-
-  stage:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write # required for OIDC trusted publishing
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 24.x
-          cache: "npm"
-          registry-url: https://registry.npmjs.org/
-
-      # npm stage publish needs npm 11.15.0 or later
-      - run: npm install -g npm@^11.15.0
-
-      - run: npm ci
-
-      - name: Check release tag matches package.json version
-        id: version
-        env:
-          RELEASE_TAG: ${{ github.event.release.tag_name }}
-        run: |
-          version="$(node -p "require('./package.json').version")"
-          if [[ "$RELEASE_TAG" != "v${version}" ]]; then
-            echo "Release tag ${RELEASE_TAG} does not match package.json version v${version}" >&2
-            exit 1
-          fi
-          echo "version=${version}" >> "$GITHUB_OUTPUT"
-
-      # Pre-release versions (e.g. 2.2.0-rc.0) are staged under the `next`
-      # dist-tag; everything else under `latest`. The tag is fixed at staging
-      # time and cannot be changed on approval.
-      - name: Choose dist-tag
-        id: dist-tag
-        env:
-          VERSION: ${{ steps.version.outputs.version }}
-        run: |
-          if [[ "$VERSION" == *-* ]]; then
-            echo "tag=next" >> "$GITHUB_OUTPUT"
-          else
-            echo "tag=latest" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Stage publish
-        env:
-          DIST_TAG: ${{ steps.dist-tag.outputs.tag }}
-        run: npm stage publish --tag "$DIST_TAG" --provenance

package/.github/workflows/test.yml

@@ -1,54 +0,0 @@
-# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    services:
-      rabbitmq:
-        image: rabbitmq:4.2-alpine
-        ports:
-          - 5672:5672
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x, 24.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "npm"
-
-      # Install all prerequisites
-      - run: npm ci
-
-      # Ensure RabbitMQ is available before continuing
-      - run: |
-          n=0
-          while :
-          do
-            sleep 5
-            echo 'HELO\n\n\n\n' | nc localhost 5672 | grep AMQP
-            [[ $? = 0 ]] && break || ((n++))
-            (( n >= 5 )) && break
-          done
-
-      - run: echo 'HELO\n\n\n\n' | nc localhost 5672 | grep AMQP
-
-      # Check TypeScript types
-      - run: npm run typecheck
-
-      # Run the tests
-      - run: make test

package/CLAUDE.md

@@ -1,12 +0,0 @@
-# Project-Specific Guidelines for amqplib
-
-## Generated Files - DO NOT EDIT
-- `lib/defs.js` - This file is generated code. NEVER modify it directly.
-  - Generated via `make lib/defs.js` from the AMQP specification
-  - If linting issues arise, exclude this file from linting rules rather than modifying it
-
-## Commit Requirements
-- NEVER commit when tests are failing
-- NEVER commit when there are lint errors
-- Always run `npm test` and `npm run lint` before committing
-- If tests are failing, investigate and fix the issue before proceeding

package/Makefile

@@ -1,42 +0,0 @@
-RABBITMQ_SRC_VERSION=v3.12.13
-JSON=amqp-rabbitmq-0.9.1.json
-AMQP_JSON=https://raw.githubusercontent.com/rabbitmq/rabbitmq-server/$(RABBITMQ_SRC_VERSION)/deps/rabbitmq_codegen/$(JSON)
-
-NODEJS_VERSIONS='18.20.0' '20.10.0' '22.14.0' '24.7.0'
-
-UGLIFY=./node_modules/.bin/uglifyjs
-
-.PHONY: test test-all-nodejs coverage lib/defs.js
-
-error:
-	@echo "Please choose one of the following targets: test, test-all-nodejs, coverage, lib/defs.js"
-	@exit 1
-
-test:
-	node --test --test-reporter=spec
-
-test-all-nodejs:
-	for v in $(NODEJS_VERSIONS); \
-		do echo "-- Node version $$v --"; \
-		nave use $$v node --test --test-reporter=spec; \
-		done
-
-coverage:
-	node --test --test-coverage --test-reporter=spec
-
-lib/defs.js: clean bin/generate-defs test
-
-clean:
-	rm -f lib/defs.js bin/amqp-rabbitmq-0.9.1.json
-
-bin/generate-defs: $(UGLIFY) bin/generate-defs.js bin/amqp-rabbitmq-0.9.1.json
-	(cd bin; node ./generate-defs.js > ../lib/defs.js)
-	$(UGLIFY) ./lib/defs.js -o ./lib/defs.js \
-		-c 'sequences=false' --comments \
-		-b 'indent-level=2' 2>&1 | (grep -v 'WARN' || true)
-
-bin/amqp-rabbitmq-0.9.1.json:
-	curl -L $(AMQP_JSON) > $@
-
-$(UGLIFY):
-	npm install