pusher 4.0.0 → 5.0.1

package/.github/stale.yml

@@ -1,7 +1,7 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 
 # Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 365
+daysUntilStale: 90
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
 # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
@@ -23,4 +23,4 @@ markComment: >
   This issue has been automatically marked as stale because it has not had
   recent activity. It will be closed if no further activity occurs. If you'd
   like this issue to stay open please leave a comment indicating how this issue
-  is affecting you. Thankyou.
+  is affecting you. Thank you.

package/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [10.x, 10.x, 12.x, 14.x]
+
+    name: Node.js ${{ matrix.node }} Test
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linter
+        run: npm run lint
+
+      - name: Run test suite
+        run: npm test
+        env:
+          PUSHER_URL: ${{ secrets.INTEGRATION_TESTS_PUSHER_URL }}

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 5.0.1 (2022-01-24)
+
+[FIXED] Incorrect `require` on `version.js` was causing a compilation error in Webpack
+[FIXED] Inconsistent encoding for shared secret between other SDKs
+
+## 5.0.0 (2021-02-18)
+
+[BREAKING CHANGE] `trigger` now accepts a `params` _object_ instead of a `socket_id` as the third parameter.
+
+[ADDED] Support for requesting channel attributes as part of a `trigger` and `triggerBatch` request via an `info` parameter.
+
+## 4.0.2 (2020-11-30)
+
+[FIXED] Workaround for a [Webpack bug](https://github.com/webpack/webpack/issues/4742) (thanks @JJ-Kidd)
+
+## 4.0.1 (2020-11-09)
+
+[FIXED] The type definitions had drifted out of sync with the implementation.
+
 ## 4.0.0 (2020-10-20)
 
 [BREAKING CHANGE] Methods that previously took callbacks now return promises.
@@ -38,6 +57,7 @@ const pusher = new Pusher.forURL(process.env.PUSHER_URL, {
 [UPGRADED] development dependencies
 
 [ADDED] encryptionMasterKeyBase64 constructor parameter to make it easier to use the full range of 32 byte binary values in encryption key
+
 [DEPRECATED] encryptionMasterKey constructor parameter - use encryptionMasterKeyBase64
 
 ## 3.0.0 (2019-09-26)

package/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/pusher/pusher-http-node.svg?branch=master)](https://travis-ci.org/pusher/pusher-http-node)
+[![Build Status](https://github.com/pusher/pusher-http-node/workflows/Tests/badge.svg)](https://github.com/pusher/pusher-http-node/actions?query=workflow%3ATests+branch%3Amaster)
 [![npm version](https://badge.fury.io/js/pusher.svg)](https://badge.fury.io/js/pusher)
 
 # Pusher Channels Node.js REST library
@@ -7,15 +7,15 @@ In order to use this library, you need to have an account on <https://pusher.com
 
 ## Supported platforms
 
-This SDK supports **Node.js** version 8+.
+This SDK supports **Node.js** version 10+.
 
-We test the library against a selection of Node.js versions which we update over time. Please refer to [travis.yml](https://github.com/pusher/pusher-http-node/blob/master/.travis.yml) for the set of versions that are currently tested with CI.
+We test the library against a selection of Node.js versions which we update over time. Please refer to [test.yml](https://github.com/pusher/pusher-http-node/blob/master/.github/workflows/test.yml) for the set of versions that are currently tested with CI.
 
 If you find any compatibility issues, please [raise an issue](https://github.com/pusher/pusher-http-node/issues/new) in the repository or contact support at [support@pusher.com](support@pusher.com). We will happily investigate reported problems ❤️.
 
 ## Installation
 
-You need to be running at least Node.js 8 to use this library.
+You need to be running at least Node.js 10 to use this library.
 
 ```
 $ npm install pusher
@@ -160,14 +160,84 @@ You can trigger a batch of up to 10 events.
 
 ### Excluding event recipients
 
-In order to avoid the client that triggered the event from also receiving it, the `trigger` function takes an optional `socketId` parameter. For more informaiton see: <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients>.
+In order to avoid the client that triggered the event from also receiving it, a `socket_id` parameter can be added to the `params` object. For more information see: <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients>.
 
 ```javascript
-const socketId = "1302.1081607"
-pusher.trigger(channel, event, data, socketId)
+pusher.trigger(channel, event, data, { socket_id: "1302.1081607" })
+
+pusher.triggerBatch([
+  { channel: channel, name: name, data: data, socket_id: "1302.1081607" },
+])
+```
+
+### Fetch subscriber and user counts at the time of publish [[EXPERIMENTAL](https://pusher.com/docs/lab#experimental-program)]
+
+For the channels that were published to, you can request for the number of subscribers or user to be returned in the response body.
+
+#### Regular triggering
+
+```javascript
+pusher
+  .trigger("presence-my-channel", "event", "test", { info: "user_count,subscription_count" })
+  .then(response => {
+    if (response.status !== 200) {
+      throw Error("unexpected status")
+    }
+    // Parse the response body as JSON
+    return response.json()
+  )
+  .then(body => {
+    const channelsInfo = body.channels
+    // Do something with channelsInfo
+  })
+  .catch(error => {
+    // Handle error
+  })
+```
+
+#### Batch triggering
+
+```javascript
+const batch = [
+  {
+    channel: "my-channel",
+    name: "event",
+    data: "test1",
+    info: "subscription_count",
+  },
+  {
+    channel: "presence-my-channel",
+    name: "event",
+    data: "test2",
+    info: "user_count,subscription_count",
+  },
+]
+pusher
+  .triggerBatch(batch)
+  .then((response) => {
+    if (response.status !== 200) {
+      throw Error("unexpected status")
+    }
+    // Parse the response body as JSON
+    return response.json()
+  })
+  .then((body) => {
+    body.batch.forEach((attributes, i) => {
+      process.stdout.write(
+        `channel: ${batch[i].channel}, name: ${batch[i].name}, subscription_count: ${attributes.subscription_count}`
+      )
+      if ("user_count" in attributes) {
+        process.stdout.write(`, user_count: ${attributes.user_count}`)
+      }
+      process.stdout.write("\n")
+    })
+  })
+  .catch((error) => {
+    console.error(error)
+  })
 ```
 
-### End-to-end encryption [BETA]
+### End-to-end encryption
 
 This library supports end-to-end encryption of your private channels. This means that only you and your connected clients will be able to read your messages. Pusher cannot decrypt them. You can enable this feature by following these steps:
 

package/examples/typescript/main.ts

@@ -4,8 +4,7 @@ import * as Pusher from "pusher"
 
 const pusher = Pusher.forURL(process.env.PUSHER_URL, {
   encryptionMasterKeyBase64: Buffer.from(
-    "01234567890123456789012345678901",
-    "binary"
+    "01234567890123456789012345678901"
   ).toString("base64"),
   agent: new Agent({ keepAlive: true }),
 })

package/index.d.ts

@@ -1,3 +1,4 @@
+import { Agent } from "http"
 import { Response } from "node-fetch"
 
 export = Pusher
@@ -9,7 +10,7 @@ declare class Pusher {
     channel: string | Array<string>,
     event: string,
     data: any,
-    socketId?: string
+    params?: Pusher.TriggerParams
   ): Promise<Response>
 
   trigger(
@@ -47,7 +48,7 @@ declare namespace Pusher {
     useTLS?: boolean
     encrypted?: boolean
     timeout?: number
-    agent?: http.Agent
+    agent?: Agent
     encryptionMasterKeyBase64?: string
   }
   interface ClusterOptions extends BaseOptions {
@@ -60,10 +61,17 @@ declare namespace Pusher {
 
   export type Options = ClusterOptions | HostOptions
 
+  export interface TriggerParams {
+    socket_id?: string
+    info?: string
+  }
+
   export interface BatchEvent {
     channel: string
     name: string
     data: any
+    socket_id?: string
+    info?: string
   }
 
   type ReservedParams =
@@ -135,7 +143,7 @@ declare namespace Pusher {
   }
 
   export class WebHook {
-    constructor(token: Token, request: request.Request)
+    constructor(token: Token, request: WebHookRequest)
 
     isValid(extraTokens?: Token | Array<Token>): boolean
     isContentTypeValid(): boolean
@@ -145,5 +153,5 @@ declare namespace Pusher {
     getTime(): Date
   }
 
-  export type Response = Response
+  export { Response }
 }

package/lib/config.js

@@ -49,7 +49,7 @@ function Config(options) {
       )
     }
 
-    this.encryptionMasterKey = options.encryptionMasterKey
+    this.encryptionMasterKey = Buffer.from(options.encryptionMasterKey)
   }
 
   // Handle base64 encoded 32 byte key to encourage use of the full range of byte values
@@ -61,10 +61,7 @@ function Config(options) {
       throw new Error("encryptionMasterKeyBase64 must be valid base64")
     }
 
-    const decodedKey = Buffer.from(
-      options.encryptionMasterKeyBase64,
-      "base64"
-    ).toString("binary")
+    const decodedKey = Buffer.from(options.encryptionMasterKeyBase64, "base64")
     if (decodedKey.length !== 32) {
       throw new Error(
         "encryptionMasterKeyBase64 must decode to 32 bytes, but the string " +

package/lib/events.js

@@ -23,16 +23,14 @@ function encrypt(pusher, channel, data) {
   })
 }
 
-exports.trigger = function (pusher, channels, eventName, data, socketId) {
+exports.trigger = function (pusher, channels, eventName, data, params) {
   if (channels.length === 1 && util.isEncryptedChannel(channels[0])) {
     const channel = channels[0]
     const event = {
       name: eventName,
       data: encrypt(pusher, channel, data),
       channels: [channel],
-    }
-    if (socketId) {
-      event.socket_id = socketId
+      ...params,
     }
     return pusher.post({ path: "/events", body: event })
   } else {
@@ -49,9 +47,7 @@ exports.trigger = function (pusher, channels, eventName, data, socketId) {
       name: eventName,
       data: ensureJSON(data),
       channels: channels,
-    }
-    if (socketId) {
-      event.socket_id = socketId
+      ...params,
     }
     return pusher.post({ path: "/events", body: event })
   }

package/lib/pusher.js

@@ -130,12 +130,14 @@ Pusher.prototype.authenticate = function (socketId, channel, data) {
  * @param {String|String[]} channel list of at most 100 channels
  * @param {String} event event name
  * @param data event data, objects are JSON-encoded
- * @param {String} [socketId] id of a socket that should not receive the event
+ * @param {Object} [params] additional optional request body parameters
+ * @param {String} [params.socket_id] id of a socket that should not receive the event
+ * @param {String} [params.info] a comma separate list of attributes to be returned in the response. Experimental, see https://pusher.com/docs/lab#experimental-program
  * @see RequestError
  */
-Pusher.prototype.trigger = function (channels, event, data, socketId) {
-  if (socketId) {
-    validateSocketId(socketId)
+Pusher.prototype.trigger = function (channels, event, data, params) {
+  if (params && params.socket_id) {
+    validateSocketId(params.socket_id)
   }
   if (!(channels instanceof Array)) {
     // add single channel to array for multi trigger compatibility
@@ -150,7 +152,7 @@ Pusher.prototype.trigger = function (channels, event, data, socketId) {
   for (let i = 0; i < channels.length; i++) {
     validateChannel(channels[i])
   }
-  return events.trigger(this, channels, event, data, socketId)
+  return events.trigger(this, channels, event, data, params)
 }
 
 /* Triggers a batch of events
@@ -159,7 +161,9 @@ Pusher.prototype.trigger = function (channels, event, data, socketId) {
  * {
  *   name: string,
  *   channel: string,
- *   data: any JSON-encodable data
+ *   data: any JSON-encodable data,
+ *   socket_id: [optional] string,
+ *   info: [optional] string experimental, see https://pusher.com/docs/lab#experimental-program
  * }
  */
 Pusher.prototype.triggerBatch = function (batch) {
@@ -230,7 +234,9 @@ Pusher.prototype.createSignedQueryString = function (options) {
 Pusher.prototype.channelSharedSecret = function (channel) {
   return crypto
     .createHash("sha256")
-    .update(channel + this.config.encryptionMasterKey)
+    .update(
+      Buffer.concat([Buffer.from(channel), this.config.encryptionMasterKey])
+    )
     .digest()
 }
 

package/lib/requests.js

@@ -1,5 +1,7 @@
-const fetch = require("node-fetch")
-const AbortController = require("abort-controller")
+// Redundant default as a workaround for this WebPack bug:
+// https://github.com/webpack/webpack/issues/4742
+const fetch = require("node-fetch").default
+const AbortController = require("abort-controller").default
 
 const errors = require("./errors")
 const util = require("./util")

package/lib/version.js

@@ -1 +1 @@
-module.exports = require("../package").version
+module.exports = require("../package.json").version

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pusher",
   "description": "Node.js client to interact with the Pusher Channels REST API",
-  "version": "4.0.0",
+  "version": "5.0.1",
   "author": "Pusher <support@pusher.com>",
   "contributors": [
     {
@@ -29,6 +29,8 @@
     "tweetnacl-util": "^0.15.0"
   },
   "devDependencies": {
+    "@types/node": "^14.14.6",
+    "@types/node-fetch": "^2.5.7",
     "eslint": "^7.11.0",
     "expect.js": "=0.3.1",
     "express": "^4.17.1",

package/tests/integration/pusher/authenticate.js

@@ -149,14 +149,14 @@ describe("Pusher", function () {
 describe("Pusher with encryptionMasterKey", function () {
   let pusher
 
-  const testMasterKey = "01234567890123456789012345678901"
+  const testMasterKeyBase64 = "zyrm8pvV2C9fJcBfhyXzvxbJVN/H7QLmbe0xJi1GhPU="
 
   beforeEach(function () {
     pusher = new Pusher({
       appId: 1234,
       key: "f00d",
       secret: "tofu",
-      encryptionMasterKey: testMasterKey,
+      encryptionMasterKeyBase64: testMasterKeyBase64,
     })
   })
 
@@ -168,7 +168,7 @@ describe("Pusher with encryptionMasterKey", function () {
         auth:
           "f00d:962c48b78bf93d98ff4c92ee7dff04865821455b7b401e9d60a9e0a90af2c105",
         channel_data: '"foo"',
-        shared_secret: "BYBsePpRCQkGPvbWu/5j8x+MmUF5sgPH5DmNBwkTzYs=",
+        shared_secret: "nlr49ISQHz91yS3cy/yWmW8wFMNeTnNL5tNHnbPJcLQ=",
       })
     })
     it("should not return a shared_secret for non-encrypted channels", function () {

package/tests/integration/pusher/constructor.js

@@ -102,7 +102,7 @@ describe("Pusher", function () {
     it("should support `encryptionMasterKey` of 32 bytes", function () {
       const key = "01234567890123456789012345678901"
       const pusher = new Pusher({ encryptionMasterKey: key })
-      expect(pusher.config.encryptionMasterKey).to.equal(key)
+      expect(pusher.config.encryptionMasterKey.toString()).to.equal(key)
     })
 
     it("should reject `encryptionMasterKey` of 31 bytes", function () {
@@ -121,14 +121,14 @@ describe("Pusher", function () {
 
     it("should support `encryptionMasterKeyBase64` which decodes to 32 bytes", function () {
       const key = "01234567890123456789012345678901"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       const pusher = new Pusher({ encryptionMasterKeyBase64: keyBase64 })
-      expect(pusher.config.encryptionMasterKey).to.equal(key)
+      expect(pusher.config.encryptionMasterKey.toString()).to.equal(key)
     })
 
     it("should reject `encryptionMasterKeyBase64` which decodes to 31 bytes", function () {
       const key = "0123456789012345678901234567890"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       expect(function () {
         new Pusher({ encryptionMasterKeyBase64: keyBase64 })
       }).to.throwException(/31 bytes/)
@@ -136,7 +136,7 @@ describe("Pusher", function () {
 
     it("should reject `encryptionMasterKeyBase64` which decodes to 33 bytes", function () {
       const key = "012345678901234567890123456789012"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       expect(function () {
         new Pusher({ encryptionMasterKeyBase64: keyBase64 })
       }).to.throwException(/33 bytes/)

package/tests/integration/pusher/trigger.js

@@ -99,7 +99,7 @@ describe("Pusher", function () {
         .catch(done)
     })
 
-    it("should add socket_id to the request body", function (done) {
+    it("should add params to the request body", function (done) {
       nock("http://api.pusherapp.com")
         .filteringPath(function (path) {
           return path
@@ -107,18 +107,23 @@ describe("Pusher", function () {
             .replace(/auth_signature=[0-9a-f]{64}/, "auth_signature=Y")
         })
         .post(
-          "/apps/1234/events?auth_key=f00d&auth_timestamp=X&auth_version=1.0&body_md5=0478e1ed73804ae1be97cfa6554cf039&auth_signature=Y",
+          "/apps/1234/events?auth_key=f00d&auth_timestamp=X&auth_version=1.0&body_md5=2e4f053f1c325dedbe21abd8f1852b53&auth_signature=Y",
           {
             name: "my_event",
             data: '{"some":"data "}',
             channels: ["test_channel"],
             socket_id: "123.567",
+            info: "user_count,subscription_count",
           }
         )
         .reply(200, "{}")
 
+      const params = {
+        socket_id: "123.567",
+        info: "user_count,subscription_count",
+      }
       pusher
-        .trigger("test_channel", "my_event", { some: "data " }, "123.567")
+        .trigger("test_channel", "my_event", { some: "data " }, params)
         .then(() => done())
         .catch(done)
     })
@@ -131,20 +136,31 @@ describe("Pusher", function () {
             .replace(/auth_signature=[0-9a-f]{64}/, "auth_signature=Y")
         })
         .post(
-          "/apps/1234/events?auth_key=f00d&auth_timestamp=X&auth_version=1.0&body_md5=cf87d666b4a829a54fc44b313584b2d7&auth_signature=Y",
+          "/apps/1234/events?auth_key=f00d&auth_timestamp=X&auth_version=1.0&body_md5=d3a47b3241328a6432adf60c8e91b6fb&auth_signature=Y",
           {
             name: "my_event",
             data: '{"some":"data "}',
             channels: ["test_channel"],
+            info: "subscription_count",
           }
         )
-        .reply(200, "OK")
+        .reply(200, '{"channels":{"test_channel":{"subscription_count":123}}}')
 
       pusher
-        .trigger("test_channel", "my_event", { some: "data " })
+        .trigger(
+          "test_channel",
+          "my_event",
+          { some: "data " },
+          { info: "subscription_count" }
+        )
         .then((response) => {
           expect(response.status).to.equal(200)
-          done()
+          return response.text().then((body) => {
+            expect(body).to.equal(
+              '{"channels":{"test_channel":{"subscription_count":123}}}'
+            )
+            done()
+          })
         })
         .catch(done)
     })
@@ -286,7 +302,12 @@ describe("Pusher", function () {
         .reply(200, "{}")
 
       pusher
-        .trigger("test_channel", "my_event", { some: "data " }, "123.567")
+        .trigger(
+          "test_channel",
+          "my_event",
+          { some: "data " },
+          { socket_id: "123.567" }
+        )
         .then(() => done())
         .catch(done)
     })
@@ -317,7 +338,12 @@ describe("Pusher", function () {
         .reply(200)
 
       pusher
-        .trigger("test_channel", "my_event", { some: "data " }, "123.567")
+        .trigger(
+          "test_channel",
+          "my_event",
+          { some: "data " },
+          { socket_id: "123.567" }
+        )
         .catch((error) => {
           expect(error).to.be.a(Pusher.RequestError)
           expect(error.message).to.equal("Request failed with an error")
@@ -421,8 +447,7 @@ describe("Pusher with encryptionMasterKey", function () {
   let pusher
 
   const testMasterKey = Buffer.from(
-    "01234567890123456789012345678901",
-    "binary"
+    "01234567890123456789012345678901"
   ).toString("base64")
 
   beforeEach(function () {

package/.travis.yml

@@ -1,20 +0,0 @@
-language: node_js
-jobs:
-  include:
-    - node_js: 14
-      script:
-        - npm run lint
-        - npm test
-    - node_js: 12
-      script:
-        - npm run lint
-        - npm test
-    - node_js: 10
-      script:
-        - npm run lint
-        - npm test
-    - node_js: 8
-      script:
-        # eslint doesn't support node 8, but it's sufficient to check that the
-        # tests pass.
-        - npm test