@onify/fake-amqplib 1.0.0 → 3.0.0

package/README.md

@@ -1,13 +1,45 @@
-Onify fake-amqplib
-==================
+# Onify fake-amqplib
 
-[![Built latest](https://github.com/onify/fake-amqplib/actions/workflows/build-latest.yaml/badge.svg)](https://github.com/onify/fake-amqplib/actions/workflows/build-latest.yaml)
+[![Built latest](https://github.com/onify/fake-amqplib/actions/workflows/build-latest.yaml/badge.svg)](https://github.com/onify/fake-amqplib/actions/workflows/build-latest.yaml)[![Coverage Status](https://coveralls.io/repos/github/onify/fake-amqplib/badge.svg?branch=default)](https://coveralls.io/github/onify/fake-amqplib?branch=default)
 
 Mocked version of https://www.npmjs.com/package/amqplib.
 
-### Overriding amqplib
+## Fake api
 
-You might want to override `amqplib` with `@onify/fake-amqplib` in tests. This can be done this way:
+- `async connect(amqpurl[, ...otherOptions, callback])`: wait for a fake connection or expect one in the callback
+- `connectSync(amqpurl[, ...otherOptions])`: utility method to create a connection without waiting for promise to resolve - synchronous
+- `resetMock()`: reset all connections and brokers
+- `setVersion(minor)`: next connection will be to a amqp of a specific version
+- `connections`: list of faked connections
+
+## RabbitMQ versions
+
+RabbitMQ behaviour differs between versions. To specify your version of RabbitMQ you can call `setVersion(minorVersionFloatOrString)`. Default version is 3.5.
+
+Example:
+```js
+var fakeAmqp = require('@onify/fake-amqplib');
+
+// prepare your connections
+(async () => {
+  fakeAmqp.setVersion('2.2');
+  const conn2 = await fakeAmqp.connect('amqp://rabbit2-2');
+
+  fakeAmqp.setVersion('3.2');
+  const conn3 = await fakeAmqp.connect('amqp://rabbit3-2');
+
+  fakeAmqp.setVersion('3.7');
+  const conn37 = await fakeAmqp.connect('amqp://rabbit3-7');
+})()
+```
+
+## Mocking amqplib
+
+You might want to override `amqplib` with `@onify/fake-amqplib` in tests. This can be done in a number of ways.
+
+### CommonJS
+
+Example on how to mock amqplib when working with commonjs.
 
 ```javascript
 const amqplib = require('amqplib');
@@ -16,8 +48,7 @@ const fakeAmqp = require('@onify/fake-amqplib');
 amqplib.connect = fakeAmqp.connect;
 ```
 
-If you are using version 2 or higher of [exp-amqp-connection](https://www.npmjs.com/package/exp-amqp-connection)
-you can use [mock-require](https://www.npmjs.com/package/mock-require) to replace `amqplib` with `@onify/fake-amqplib` in your tests like this:
+or:
 
 ```javascript
 const mock = require('mock-require');
@@ -26,7 +57,7 @@ const fakeAmqp = require('@onify/fake-amqplib');
 mock('amqplib/callback_api', fakeAmqp);
 ```
 
-or just mock the entire amqplib with
+or just mock the entire amqplib with:
 
 ```javascript
 const mock = require('mock-require');
@@ -35,33 +66,62 @@ const fakeAmqp = require('@onify/fake-amqplib');
 mock('amqplib', fakeAmqp);
 ```
 
-### RabbitMQ versions
+### ESM
 
-Some behaviour differs between versions. To specify your version of RabbitMQ you can call `setVersion(minorVersionFloatOrString)`. Default version is 3.5.
+Example on how to mock amqplib import when working with modules.
 
-Example:
-```js
-var fakeAmqp = require('@onify/fake-amqplib');
+**[Quibble](https://www.npmjs.com/package/quibble) mocha example**
 
-// prepare your connections
-(async () => {
-  fakeAmqp.setVersion('2.2');
-  const conn2 = await fakeAmqp.connect('amqp://rabbit2-2');
+Both amqplib and fake-amqplib have to be quibbled if reset mock is used during testing.
 
-  fakeAmqp.setVersion('3.2');
-  const conn3 = await fakeAmqp.connect('amqp://rabbit3-1');
+_test/setup.js_
+```js
+import * as fakeAmqpLib from '@onify/fake-amqplib';
+import { connect as fakeConnect } from '@onify/fake-amqplib';
+import quibble from 'quibble';
 
-  fakeAmqp.setVersion('3.7');
-  const conn37 = await fakeAmqp.connect('amqp://rabbit3-7');
-})()
+(async () => {
+  await quibble.esm('amqplib', { connect: fakeConnect });
+  await quibble.esm('amqplib/callback_api', { connect: fakeConnect });
+  await quibble.esm('@onify/fake-amqplib', { ...fakeAmqpLib });
+})();
 ```
 
-### Fake api
-
-List of available methods and a property
+_.mocharc.json_ (true for node version < 20)
+```json
+{
+  "recursive": true,
+  "require": ["test/setup.js"],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "no-warnings",
+    "loader=quibble"
+  ]
+}
+```
 
-- `connections`: property with all faked connections
-- `connectSync(amqpurl[, ...otherOptions])`: helper method to create a connection without waiting for promise to resolve - synchronous
-- `resetMock()`: reset all connections and brokers
-- `setVersion(minor)`: next connection will be to a amqp of a specific version
-- `async connect(amqpurl[, ...otherOptions, callback])`: make a fake connection
+_test/amqplib-connection-test.js_
+```js
+import assert from 'node:assert';
+import { connect } from 'amqplib';
+import { connect as connectCb } from 'amqplib/callback_api';
+
+import { resetMock } from '@onify/fake-amqplib';
+
+describe('connection', () => {
+  afterEach(resetMock);
+
+  it('connect promise', async () => {
+    const connection = await connect('amqp://host');
+    assert.equal(connection.connection.serverProperties.version, '3.5.0');
+  });
+
+  it('connect callback', (done) => {
+    connectCb('amqp://host', (err, connection) => {
+      if (err) return done(err);
+      assert.equal(connection.connection.serverProperties.version, '3.5.0');
+      done();
+    });
+  });
+});
+```

package/index.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="amqplib" />
+/// <reference types="node" />
+
+import { Options, Connection, Channel } from "amqplib";
+import { EventEmitter } from "events";
+import { Broker } from 'smqp';
+
+export interface FakeAmqplibChannel extends Channel {
+  /** Channel name and identifier, for faking purposes */
+  _channelName: string;
+  _broker: Broker;
+  _version: number;
+  new(broker: Broker, connection: FakeAmqplibConnection): FakeAmqplibChannel;
+  get _closed(): boolean;
+}
+
+export interface FakeAmqplibConnection extends Connection {
+  _channels: FakeAmqplibChannel[];
+  _url: URL;
+  /** Connection identifier, for faking purposes */
+  _id: string;
+  _broker: Broker;
+  _version: number;
+  new(broker: Broker, version: number, amqpUrl: string, options?: any): FakeAmqplibConnection;
+  get _closed(): boolean;
+}
+
+interface SocketOptions {
+  host?: string;
+  keepAlive?: boolean;
+  keepAliveDelay?: number;
+  noDelay?: boolean;
+  port?: number;
+  serverName?: string;
+  timeout?: number;
+  [x: string]: any;
+}
+
+type connectCallback = (
+  err: Error,
+  connection: FakeAmqplibConnection
+) => void;
+
+export class FakeAmqplib {
+  connections: FakeAmqplibConnection[];
+  constructor(version?: number)
+  connect(url: string | Options.Connect, socketOptions?: SocketOptions): Promise<FakeAmqplibConnection>;
+  connect(url: string | Options.Connect, socketOptions: SocketOptions, callback: connectCallback): void;
+  connect(url: string | Options.Connect, callback: (err: Error, connection: FakeAmqplibConnection) => void): void;
+  connectSync(url: string | Options.Connect, socketOptions?: SocketOptions): FakeAmqplibConnection;
+  resetMock(): void;
+  setVersion(minorVersion: number): void;
+}
+
+export function connect(url: string | Options.Connect, socketOptions?: SocketOptions): Promise<FakeAmqplibConnection>;
+export function connect(url: string | Options.Connect, socketOptions: SocketOptions, callback: connectCallback): void;
+export function connect(url: string | Options.Connect, callback: connectCallback): void;
+export function connectSync(url: string | Options.Connect, socketOptions?: SocketOptions): FakeAmqplibConnection;
+export function resetMock(): void;
+export function setVersion(minorVersion: number): void;