Subprotocols

Deploying a SPA is not easy. You can deploy new versions of client and server, but users may use old client for weeks because they do not reload the page. It could be even worse for mobile application. User may avoid updating client and use old client for months.

As a result, the server needs to be able to speak with different versions of clients. Logux has subprotocol versions to do it.

Subprotocol is your application-level protocol:

• What actions can be generated on the client and the server.
• The schema of action’s objects.
• The reaction on this actions.

Subprotocol version is a Semantic Versioning string with 3 numbers: 0.3.4, 0.3.5, 1.0.0, etc.

On the client you define what subprotocol version does it use:

const client = new CrossTabClient({
  subprotocol: '1.1.0',
  …
})

In Logux Node.js server or Logux proxy, you define what subprotocol does server use and what clients does it support (by SemVer range syntax).

const server = new Server(
  Server.loadOptions(process, {
    subprotocol: '1.1.0',
    supports: '^1.0.0', // equal to >= 1.0.0 < 2.0.0
    …
  })
)

If the server doesn’t support the client’s subprotocol, it will refuse the connection and client will show “Please reload page” warning to the user.

On the server you can have different logic for different clients:

server.type('user/add', {
  …,
  async process (ctx, action, meta) {
    if (ctx.isSubprotocol('~1.1.0')) {
      await db.createUser({ id: action.id, name: action.name })
    } else {
      await db.createUser({ id: action.user.id, name: action.user.name })
    }
  }
})

# app/logux/actions/users.rb
module Channels
  class Users < Logux::ChannelController
    def add
      user = if meta.subprotocol =~ /1.1.\d+/
        User.new(id: action[:id], name: action[:name])
      else
        User.new(id: action[:user][:id], name: action[:user][:name])
      end
      user.save!
    end
  end
end