pusher-js-mock

Mock Pusher.js in your JavaScript tests with ease

Installing ⏬

Using yarn:

yarn add --dev pusher-js-mock

Or using npm:

npm install -D pusher-js-mock

Usage 🛠

• Emitting an event in tests
• Stubbing Pusher when imported from pusher-js package
• Stubbing Pusher when used as a global variable
• Mocking presence channels

For more detailed examples, check out examples directory inside the project!

Also, you can check out the Docs for even more information.

Emitting an event in tests

If you need to mock a Pusher object in your tests that can subscribe to channel, it's best to use PusherMock.

1import { PusherMock } from "pusher-js-mock";
2
3// initializing PusherMock
4const pusher = new PusherMock();
5
6// subscribing to a Pusher channel
7const channel = pusher.subscribe("my-channel");
8
9// emitting an event
10channel.emit("event-name");

Stubbing Pusher when imported from pusher-js package

If you're using Pusher in your code in this or similar manner:

1import Pusher from "pusher-js";

You will need to mock Pusher in a specific way.

I suggest you use Jest to test your code. To do this in Jest, you'll need something like this:

1jest.mock("pusher-js", () => {
2  const Pusher = require("pusher-js-mock").PusherMock;
3  return Pusher;
4});

If you have tips on how to mock this using other testing frameworks, please submit an issue or a pull request.

Stubbing Pusher when used as a global variable

This shows how to stub a pusher if you're attaching it to window object in your project. If you're attaching a PusherFactory to a window object like this in your code:

1window.PusherFactory = {
2  pusherClient: function(pusherKey) {
3    return new Pusher(pusherKey);
4  },
5};

It's best for you to use PusherFactoryMock.

1import { PusherFactoryMock } from "pusher-js-mock";
2
3// initialize instance of PusherFactoryMock
4const pusherFactoryMock = new PusherFactoryMock();
5// replace it with the object that is attached to a window
6window.PusherFactory = pusherFactoryMock;
7
8// get the Pusher client reference
9pusher = pusherFactoryMock.pusherClient();

This way you'll just replace your PusherFactory with PusherFactoryMock.

Using presence channels

This package also supports using presence channels for multiple clients. The mock will automatically detect when presence- is in the channel name and return a presence channel with channel.members filled out as expected. You can pass in IDs and info via a custom authorizer, just as you would with the real package.

Unfortunately due to the nature of async testing in jest, there are a few rules:

1. Return an object {id, info} where the auth key would normally go in the callback, i.e.

1authorize: (socketId, callback) => callback(false, { id, info });

2. If your authorizer is async, you'll have to wrap your assertions in process.nextTick to allow the promise to resolve and set the ID & info.

1// given this Pusher config with async auth
2{
3  authorizer: () => ({
4    authorize: async (socketId, callback) =>
5    Promise.resolve().then(() => callback(false, { id, info }))
6  })
7}
8
9// do this in your tests
10const channel = client.subscribe("presence-channel")
11process.nextTick(() => {
12  expect(channel.members.myID).toBe("my-id")
13})
14...

3. If you're using an syncronous authorizer, you can put await new Promise(setImmediate) above your assertions to flush internal promises and apply your id & info to the client:

1// given this Pusher config with sync auth
2{
3  authorizer: () => ({
4    authorize: (socketId, callback) => callback(false, { id, info }),
5  });
6}
7
8// do this in your tests
9const channel = client.subscribe("presence-channel");
10await new Promise(setImmediate);
11expect(channel.members.myID).toBe("my-id");

If you're using React, you'll have to wrap it further in act:

1await act(async () => await new Promise(setImmediate));

Here's an example:

1// create-client.js
2import Pusher from "pusher-js";
3import { getAuthSomehow } from "./getAuthSomehow";
4
5export const createClient = ({ id, info }) =>
6  new Pusher("APP_KEY", {
7    cluster: "APP_CLUSTER",
8    // see https://github.com/pusher/pusher-js#authorizer-function
9    authorizer: ({ name }) => ({
10      authorize: async (socketId, callback) => {
11        const auth = await getAuthSomehow(id, info);
12        callback(false, auth);
13      },
14    }),
15  });
16
17export default createClient;

1// create-client.spec.js
2import createClient from "../create-client";
3
4// mock the authorize function and pusher
5jest.mock("pusher-js", () => require("pusher-js-mock"));
6jest.mock("../getAuthSomehow", () => ({
7  // async auth result resolves to { id, info } object, which gets set in the client
8  getAuthSomehow: (id, info) => Promise.resolve({ id, info }),
9}));
10
11it("should create a presence channel", async () => {
12  // arrange: create pusher client
13  const pusher = createClient({ id: "my-id", info: { role: "moderator" } });
14
15  // act: required to ensure pusher events are called, i.e. pusher:member_added
16  const presenceChannel = await pusher.subscribe("presence-channel");
17
18  // process.nextTick wraps our assertions to ensure the promise has resolved.
19  process.nextTick(() => {
20    // assert: presenceChannel has the properties we expect it to.
21    expect(presenceChannel.members.myID).toBe("my-id");
22    expect(presenceChannel.members.me).toEqual({
23      id: "my-id",
24      info: { role: "moderator" },
25    });
26    expect(presenceChannel.members.members).toEqual({
27      "my-id": { role: "moderator" },
28    });
29  });
30});

Check out a code example of using presence channels

Code of Conduct

Contributing

Credits

Photo by Octavian Rosca on Unsplash