pusher-js/spec/javascripts/integration/core/pusher_spec/test_builder.js

Pusher Channels JavaScript library for browsers, React Native, NodeJS and web workers

const Pusher = require('pusher_integration');

const Integration = require('integration');
const Collections = require('core/utils/collections');
const Runtime = require('runtime').default;
const TRANSPORTS = Runtime.Transports;
const waitsFor = require('../../../helpers/waitsFor');

function canRunTwoConnections(transport) {
  if (transport !== "sockjs") {
    return true;
  }
  return !/(MSIE [67])|(Version\/(4|5\.0).*Safari)/.test(navigator.userAgent);
}

function subscribe(pusher, channelName, callback) {
  var channel = pusher.subscribe(channelName);
  channel.bind("pusher:subscription_succeeded", function(param) {
    callback(channel, param);
  });
  return channel;
}

function delay(timeMs) {
  return new Promise(resolve => setTimeout(resolve, timeMs));
}

function build(testConfig) {
  var forceTLS = testConfig.forceTLS;
  var transport = testConfig.transport;

  if (!TRANSPORTS[transport].isSupported({ useTLS: forceTLS })) {
    return;
  }

  describe("with " + (transport ? transport + ", " : "") + "forceTLS=" + forceTLS, function() {
    var pusher1, pusher2;
    var jasmineDefaultTimeout = jasmine.DEFAULT_TIMEOUT_INTERVAL;

    beforeAll(() => {
      jasmine.DEFAULT_TIMEOUT_INTERVAL = 41000;
    });

    afterAll(() => {
      jasmine.DEFAULT_TIMEOUT_INTERVAL = jasmineDefaultTimeout;
    });

    beforeEach(function() {
      Collections.objectApply(TRANSPORTS, function(t, name) {
        spyOn(t, "isSupported").and.returnValue(false);
      });
      TRANSPORTS[transport].isSupported.and.returnValue(true);
    });

    describe("setup", function() {
      it("should open connections", async function() {
        pusher1 = new Pusher("c49a449b916bb4246729", {
          forceTLS: forceTLS,
          cluster: "mt1"
        });
        if (canRunTwoConnections(transport)) {
          pusher2 = new Pusher("c49a449b916bb4246729", {
            forceTLS: forceTLS,
            cluster: "mt1"
          });
          await waitsFor(function() {
            return pusher2.connection.state === "connected";
          }, "second connection to be established", 20000);
        }
        await waitsFor(function() {
          return pusher1.connection.state === "connected";
        }, "first connection to be established", 20000);
      });

    });

    describe("with a public channel", function() {
      buildPublicChannelTests(
        function() { return pusher1; }
      );
    });

    describe("with a private channel", function() {
      var channelName = Integration.getRandomName("private-integration");
      var channel1, channel2;

      buildSubscriptionStateTests(
        function() { return pusher1; },
        "private-"
      );

      if (canRunTwoConnections(transport)) {
        buildClientEventsTests(
          function() { return pusher1; },
          function() { return pusher2; },
          "private-"
        );
      }
    });

    describe("with a presence channel", function() {
      buildSubscriptionStateTests(
        function() { return pusher1; },
        "presence-"
      );

      if (canRunTwoConnections(transport)) {
        buildClientEventsTests(
          function() { return pusher1; },
          function() { return pusher2; },
          "presence-"
        );
        buildPresenceChannelTests(
          function() { return pusher1; },
          function() { return pusher2; }
        );
      }
    });

    describe("teardown", function() {
      if (canRunTwoConnections(transport)) {
        it("should disconnect second connection", function() {
          pusher2.disconnect();
        });
      }

      it("should disconnect first connection", function() {
        pusher1.disconnect();
      });
    });
  });
}
function buildPresenceChannelTests(getPusher1, getPusher2) {
  it("should get connection's member data", async function() {
    var pusher = getPusher1();
    var channelName = Integration.getRandomName("presence-integration_me");

    var members = null;
    subscribe(pusher, channelName, function(channel, ms) {
      members = ms;
    });

    await waitsFor(function() {
      return members !== null;
    }, "channel to subscribe", 10000);

    expect(members.me).toEqual({
      id: pusher.connection.socket_id,
      info: {
        name: "Integration " + pusher.connection.socket_id,
        email: "integration-" + pusher.connection.socket_id + "@example.com"
      }
    });
  });

  it("should receive a member added event", async function() {
    var pusher1 = getPusher1();
    var pusher2 = getPusher2();
    var channelName = Integration.getRandomName("presence-integration_member_added");

    var member = null;
    subscribe(pusher1, channelName, function(channel) {
      channel.bind("pusher:member_added", function(m) {
        member = m;
      });

      subscribe(pusher2, channelName, function() {});
    });

    await waitsFor(function() {
      return member !== null;
    }, "the member added event", 10000);

    expect(member.id).toEqual(pusher2.connection.socket_id);
    expect(member).toEqual({
      id: pusher2.connection.socket_id,
      info: {
        name: "Integration " + pusher2.connection.socket_id,
        email: "integration-" + pusher2.connection.socket_id + "@example.com"
      }
    });

    pusher1.unsubscribe(channelName);
    pusher2.unsubscribe(channelName);
  });

  it("should receive a member removed event", async function() {
    var pusher1 = getPusher1();
    var pusher2 = getPusher2();
    var channelName = Integration.getRandomName("presence-integration_member_removed");

    var member = null;
    subscribe(pusher2, channelName, function(channel) {
      channel.bind("pusher:member_added", function(_) {
        channel.bind("pusher:member_removed", function(m) {
          member = m;
        });
        pusher1.unsubscribe(channelName);
      });

      subscribe(pusher1, channelName, function() {});
    });

    await waitsFor(function() {
      return member !== null;
    }, "the member removed event", 10000);

    expect(member.id).toEqual(pusher1.connection.socket_id);
    expect(member).toEqual({
      id: pusher1.connection.socket_id,
      info: {
        name: "Integration " + pusher1.connection.socket_id,
        email: "integration-" + pusher1.connection.socket_id + "@example.com"
      }
    });

    pusher2.unsubscribe(channelName);
  });

  it("should maintain correct members count", async function() {
    var pusher1 = getPusher1();
    var pusher2 = getPusher2();
    var channelName = Integration.getRandomName("presence-integration_member_count");

    var channel1, channel2;

    var onSubscribed1 = jasmine.createSpy("onSubscribed1");
    var onSubscribed2 = jasmine.createSpy("onSubscribed2");
    var onMemberAdded = jasmine.createSpy("onMemberAdded");
    var onMemberRemoved = jasmine.createSpy("onMemberRemoved");

    channel1 = subscribe(pusher1, channelName, onSubscribed1);
    expect(channel1.members.count).toEqual(0);

    await waitsFor(function() {
      return onSubscribed1.calls.count() > 0;
    }, "first connection to subscribe", 10000);

    expect(channel1.members.count).toEqual(1);
    channel1.bind("pusher:member_added", onMemberAdded);
    channel2 = subscribe(pusher2, channelName, onSubscribed2);

    await waitsFor(function() {
      return onSubscribed2.calls.count() > 0;
    }, "second connection to subscribe", 10000);

    expect(channel2.members.count).toEqual(2);

    await waitsFor(function() {
      return onMemberAdded.calls.count() > 0;
    }, "member added event", 10000);

    expect(channel1.members.count).toEqual(2);
    channel2.bind("pusher:member_removed", onMemberRemoved);
    pusher1.unsubscribe(channelName);

    await waitsFor(function() {
      return onMemberRemoved.calls.count() > 0;
    }, "member removed event", 10000);

    expect(channel2.members.count).toEqual(1);
  });

  it("should maintain correct members data", async function() {
    var pusher1 = getPusher1();
    var pusher2 = getPusher2();
    var channelName = Integration.getRandomName("presence-integration_member_count");

    var channel1, channel2;

    var onSubscribed1 = jasmine.createSpy("onSubscribed1");
    var onSubscribed2 = jasmine.createSpy("onSubscribed2");
    var onMemberAdded = jasmine.createSpy("onMemberAdded");
    var onMemberRemoved = jasmine.createSpy("onMemberRemoved");

    var member1 = {
      id: pusher1.connection.socket_id,
      info: {
        name: "Integration " + pusher1.connection.socket_id,
        email: "integration-" + pusher1.connection.socket_id + "@example.com"
      }
    };
    var member2 = {
      id: pusher2.connection.socket_id,
      info: {
        name: "Integration " + pusher2.connection.socket_id,
        email: "integration-" + pusher2.connection.socket_id + "@example.com"
      }
    };

    channel1 = subscribe(pusher1, channelName, onSubscribed1);

    await waitsFor(function() {
      return onSubscribed1.calls.count() > 0;
    }, "first connection to subscribe", 10000);

    expect(channel1.members.get(pusher1.connection.socket_id))
      .toEqual(member1);
    expect(channel1.members.get(pusher2.connection.socket_id))
      .toBe(null);

    expect(channel1.members.me).toEqual(member1);

    channel1.bind("pusher:member_added", onMemberAdded);
    channel2 = subscribe(pusher2, channelName, onSubscribed2);

    await waitsFor(function() {
      return onSubscribed2.calls.count() > 0;
    }, "second connection to subscribe", 10000);

    expect(channel2.members.get(pusher1.connection.socket_id))
      .toEqual(member1);
    expect(channel2.members.get(pusher2.connection.socket_id))
      .toEqual(member2);

    expect(channel2.members.me).toEqual(member2);

    await waitsFor(function() {
      return onMemberAdded.calls.count() > 0;
    }, "member added event", 10000);

    expect(channel1.members.get(pusher1.connection.socket_id))
      .toEqual(member1);
    expect(channel1.members.get(pusher2.connection.socket_id))
      .toEqual(member2);

    channel2.bind("pusher:member_removed", onMemberRemoved);
    pusher1.unsubscribe(channelName);

    await waitsFor(function() {
      return onMemberRemoved.calls.count() > 0;
    }, "member removed event", 10000);

    expect(channel2.members.get(pusher1.connection.socket_id))
      .toBe(null);
    expect(channel2.members.get(pusher2.connection.socket_id))
      .toEqual(member2);
  });
}
function buildClientEventsTests(getPusher1, getPusher2, prefix) {
  it("should receive a client event sent by another connection", async function() {
    var pusher1 = getPusher1();
    var pusher2 = getPusher2();

    var channelName = Integration.getRandomName((prefix || "") + "integration_client_events");

    var channel1, channel2;
    var onSubscribed1 = jasmine.createSpy("onSubscribed1");
    var onSubscribed2 = jasmine.createSpy("onSubscribed2");

    var eventName = "client-test";
    var data = { foo: "bar" };
    var onEvent1 = jasmine.createSpy("onEvent1");
    var onEvent2 = jasmine.createSpy("onEvent2");


    channel1 = subscribe(pusher1, channelName, onSubscribed1);
    channel2 = subscribe(pusher2, channelName, onSubscribed2);

    await waitsFor(function() {
      return onSubscribed1.calls.count() > 0 && onSubscribed2.calls.count() > 0;
    }, "both connections to subscribe", 10000);

    channel1.bind(eventName, onEvent1);
    channel2.bind(eventName, onEvent2);
    pusher1.send_event(eventName, data, channelName);

    await waitsFor(function() {
      return onEvent2.calls.count();
    }, "second connection to receive a message", 10000);

    pusher1.unsubscribe(channelName);
    pusher2.unsubscribe(channelName);
  });

  it("should not receive a client event sent by itself", async function() {
    var pusher = getPusher1();

    var channelName = Integration.getRandomName((prefix || "") + "integration_client_events");
    var onSubscribed = jasmine.createSpy("onSubscribed");

    var eventName = "client-test";
    var onEvent = jasmine.createSpy("onEvent");
    var timer = null;

    var channel = subscribe(pusher, channelName, onSubscribed);
    await waitsFor(function() {
      return onSubscribed.calls.count() > 0;
    }, "connection to subscribe", 10000);

    channel.bind(eventName, onEvent);
    pusher.send_event(eventName, {}, channelName);
    await delay(5000);

    expect(onEvent).not.toHaveBeenCalled();
    pusher.unsubscribe(channelName);
  });
}
function buildPublicChannelTests(getPusher, prefix) {
  it("should subscribe and receive a message sent via REST API", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    var onSubscribed = jasmine.createSpy("onSubscribed");
    var channel = subscribe(pusher, channelName, onSubscribed);

    var eventName = "integration_event";
    var data = { x: 1, y: "z" };
    var received = null;

    await waitsFor(function() {
      return onSubscribed.calls.count();
    }, "subscription to succeed", 10000);

    channel.bind(eventName, function(message) {
      received = message;
    });
    Integration.sendAPIMessage({
      url: Integration.API_URL + "/v2/send",
      channel: channelName,
      event: eventName,
      data: data
    });

    await waitsFor(function() {
      return received !== null;
    }, "message to get delivered", 10000);

    expect(received).toEqual(data);
    pusher.unsubscribe(channelName);
  });

  it("should not receive messages after unsubscribing", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    var onSubscribed = jasmine.createSpy("onSubscribed");
    var channel = subscribe(pusher, channelName, onSubscribed);

    var eventName = "after_unsubscribing";
    var received = null;
    var timer = null;

    await waitsFor(function() {
      return onSubscribed.calls.count();
    }, "subscription to succeed", 10000);

    channel.bind(eventName, function(message) {
      received = message;
    });
    pusher.unsubscribe(channelName);
    Integration.sendAPIMessage({
      url: Integration.API_URL + "/v2/send",
      channel: channelName,
      event: eventName,
      data: {}
    });
    await delay(5000);
    expect(received).toBe(null);
  });

  it("should handle unsubscribing as an idempotent operation", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    var onSubscribed = jasmine.createSpy("onSubscribed");
    subscribe(pusher, channelName, onSubscribed);

    await waitsFor(function() {
      return onSubscribed.calls.count();
    }, "subscription to succeed", 10000);

    pusher.unsubscribe(channelName);
    pusher.unsubscribe(channelName);
    pusher.unsubscribe(channelName);
  });

  it("should handle cancelling pending subscription", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    var eventName = "after_unsubscribing";
    var received = null;
    var timer = null;

    var channel = pusher.subscribe(channelName);
    channel.bind(eventName, function(message) {
      received = message;
    });

    pusher.unsubscribe(channelName);
    await waitsFor(function() {
      return !channel.subscriptionPending;
    }, "subscription to succeed", 10000);

    Integration.sendAPIMessage({
      url: Integration.API_URL + "/v2/send",
      channel: channelName,
      event: eventName,
      data: {}
    });
    await delay(5000);

    expect(channel.subscribed).toEqual(false);
    expect(received).toBe(null);
  });

  it("should handle reinstating cancelled pending subscription", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    var eventName = "after_subscribing";
    var received = null;
    var timer = null;

    var channel = pusher.subscribe(channelName);
    channel.bind(eventName, function(message) {
      received = message;
    });

    pusher.unsubscribe(channelName);
    pusher.subscribe(channelName);
    await waitsFor(function() {
      return !channel.subscriptionPending;
    }, "subscription to succeed", 10000);

    Integration.sendAPIMessage({
      url: Integration.API_URL + "/v2/send",
      channel: channelName,
      event: eventName,
      data: {}
    });
    await delay(10000);

    expect(channel.subscribed).toEqual(true);
    expect(received).not.toBe(null);
  });
}

function buildSubscriptionStateTests(getPusher, prefix) {
  it("sub-sub = sub", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);
    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    await waitsFor(function() {
      return pusher.channel(channelName).subscribed;
    }, "subscription to finish", 10000);

    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);
  });

  it("sub-wait-sub = sub", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    await waitsFor(function() {
      return pusher.channel(channelName).subscribed;
    }, "subscription to finish", 10000);

    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);
  });

  it("sub-unsub = NOP", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(true);

    // there is no easy way to know when an unsubscribe request has been
    // actioned by the server, so we just wait a while
    await delay(5000);

    expect(pusher.channel(channelName)).toBe(undefined);
  });

  it("sub-wait-unsub = NOP", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    await waitsFor(function() {
      return pusher.channel(channelName).subscribed;
    }, "subscription to finish", 10000);

    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName)).toBe(undefined);
  });

  it("sub-unsub-sub = sub", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(true);

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    await waitsFor(function() {
      return pusher.channel(channelName).subscribed;
    }, "subscription to finish", 10000);

    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);
  });

  it("sub-unsub-wait-sub = sub", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(true);

    // there is no easy way to know when an unsubscribe request has been
    // actioned by the server, so we just wait a while
    await delay(5000);
    expect(pusher.channel(channelName)).toBe(undefined);

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    await waitsFor(function() {
      return pusher.channel(channelName).subscribed;
    }, "subscription to finish", 10000);

    expect(pusher.channel(channelName).subscribed).toEqual(true);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(false);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);
  });

  it("sub-unsub-unsub = NOP", async function() {
    var pusher = getPusher();
    var channelName = Integration.getRandomName((prefix || "") + "integration");

    pusher.subscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(false);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(true);

    pusher.unsubscribe(channelName)
    expect(pusher.channel(channelName).subscribed).toEqual(false);
    expect(pusher.channel(channelName).subscriptionPending).toEqual(true);
    expect(pusher.channel(channelName).subscriptionCancelled).toEqual(true);

    // there is no easy way to know when an unsubscribe request has been
    // actioned by the server, so we just wait a while
    await delay(5000);

    expect(pusher.channel(channelName)).toBe(undefined);
  });
}
module.exports = {build}