Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 1.85 KB

README.md

File metadata and controls

74 lines (55 loc) · 1.85 KB

@dab-co/jam-mqtt

Installing npm dependencies

With .npmrc

  • Generate a token with repo and read:packages scopes
  • do READ_PACKAGE_API_KEY=<your token> to set it as environment variable
  • npm install

Without .npmrc on root

  • Use npm --registry=https://npm.pkg.github.com adduser
    • Generate a token with repo and read:packages scopes, don't enter your github password.
  • And then do npm config set @dab-co:registry https://npm.pkg.github.com
  • Run npm install

Errors

Errors that occur from client's data are written to /user_id/devices/client_id with qos 0.

Example error format

{
  "type": "error",
  "handler": "authenticate",
  "category": "api_token",
  "message": "wrong api token",
  "messageId": null
}

Errors thrown by handlers

preConnect

  • Spam
    • too many failed auth attempts

authenticate

  • id

    • client id and user id don't match

  • api_token

    • wrong api token format

      Raised when api token is empty

    • unknown user id

    • wrong api token

  • logout

    • a new device has connected

authorizePublish

This is the only handler that will not have the messageId field as null since errors thrown are caused by that specific message. However, if the message has a qos of 0, the message will not have an id and simply an error will be thrown not associated with any message.

  • topic

    • not enough topic levels
    • wildcards are not allowed in topic
    • can't publish to other user's channel except inbox

  • notification_token

    • fatal database error

    Raised when no column for notification token exists in database, could mean that there is a bigger issue in server

  • friends

    • not friends with the receiver

authorizeSubscribe

The category field here is set to the topic user tries subscribing to

  • wildcards are not allowed in topic
  • not enough topic levels
  • not authorized