# activestack-gateway

> Socket server for ActiveStack

Latest version **0.2.5** (published 2016-05-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install activestack-gateway
pnpm add activestack-gateway
yarn add activestack-gateway
bun add activestack-gateway
```

Provides the command `activestack-gateway`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2016-05-03 |
| First published | 2015-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 4.1.1 |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jonathan Samples |
| Maintainers | jonnysamps |
| Keywords | Node, Socket, ActiveStack |

## Links

- npm: https://www.npmjs.com/package/activestack-gateway
- Repository: https://github.com/activestack/gateway
- Homepage: https://github.com/activestack/gateway#readme
- Issues: https://github.com/activestack/gateway/issues
- npm.io page: https://npm.io/package/activestack-gateway

## Dependencies (8)

- [redis](https://npm.io/package/redis.md) ^0.12.1
- [lodash](https://npm.io/package/lodash.md) ~1.3.1
- [winston](https://npm.io/package/winston.md) ^0.6.2
- [socket.io](https://npm.io/package/socket.io.md) git://github.com/curb47/socket.io.git
- [injecterooski](https://npm.io/package/injecterooski.md) *
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^0.9.9
- [webkit-devtools-agent](https://npm.io/package/webkit-devtools-agent.md) ^0.3.1
- [node-properties-parser](https://npm.io/package/node-properties-parser.md) ^0.0.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.2.5 (latest) — 2016-05-03
- 0.2.4 — 2016-04-29
- 0.2.3 — 2016-04-29
- 0.2.2 — 2016-04-29
- 0.2.1 — 2016-04-28
- 0.3.0 — 2015-10-08
- 0.2.0 — 2015-09-24
- 0.1.1 — 2015-08-10
- 0.1.0 — 2015-08-10

## README

ActiveStack Gateway
===================

[![Circle CI](https://circleci.com/gh/ActiveStack/gateway/tree/master.svg?style=svg)](https://circleci.com/gh/ActiveStack/gateway/tree/master)

Introduction
------------

The ActiveStack Gateway is a Node server that sets up a real-time socket server for clients wanting to 
connect to the ActiveStack backend.

Installation
------------

### Prerequisites

* Node = 0.10.x
* Redis
* RabbitMQ

### Install Options

The AS Gateway provides two usage methods:
  * Install globally with NPM: `npm install -g activestack-gateway`. This method will make the `activestack-gateway` executable
    available on your path for starting from the command line.
  * Install in your own node project with `npm install activestack-gateway`. This method will make the gateway available
    to your project at runtime so you can control the gateway from your application.
    
Usage
-------

If you installed the gateway with the global option then you'll have a new executable on your path: `activestack-gateway`.

To start the gateway server with default options run:
```bash
> activestack-gateway server|s
```

To start the gateway console to control an already running server run:
```bash
> activestack-gateway console|c
```

### Console Commands

Once you've started the active stack control console you can issue these commands to control the server:
* `quit` - to quit the console
* `restart` - to restart the server
* `shutdown` - to shut the server down
* `loglevel` - set the log level # Not currently implemented
* `clientmessageresendinterval` - print the client message resend interval configuration
* `clientcount` - print the number of clients connected to the server
    
Configuration
-------------

The AS Gateway allows several different configuration options.  These can be specified using a customer configuration file.

```
# How often should server process send heartbeats to workers
cluster.heartbeatInterval=1000
# How long before a worker times out and is restarted
cluster.workerTimeout=5000
# DON'T KNOW
cluster.watchdogInterval=1000
# Get warned when memory reaches this level
cluster.memoryWarning.rss=1024
# Get warned when memory reaches this level
cluster.memoryWarning.heapTotal=60
# Hard memory limit
cluster.memoryLimit.rss=2048
# Hard memory limit
cluster.memoryLimit.heapUsed=100
# How long to wait before worker is restarted
cluster.workerRestartDelay=50
# Worker backoff
cluster.maxRestartBackoff=10
# The number of workers to spawn. If not specified will use (numCPUs/2)+1
cluster.workerCount=2

# Logging level
frontend.logLevel=info
# Shutdown password
frontend.shutdownCode=pass123
# The port to listen on 
frontend.port=8080
# Use SSL or not
frontend.ssl=false

# Socket IO configurations
gateway.socketio.timeout=300
gateway.socketio.interval=20

# Redis configurations
gateway.redis.host=localhost
gateway.redis.port=6379
gateway.redis.password=
gateway.redis.gatewaycontrolqueue=gateway
gateway.redis.max_attempts=1
gateway.redis.offline_queue=false

# RabbitMQ configurations
gateway.rabbitmq.host=localhost
gateway.rabbitmq.port=5672
gateway.rabbitmq.login=guest
gateway.rabbitmq.password=guest
gateway.rabbitmq.durable=false
```

Running Tests
-------------
```npm test```

API Documentation
-----------------

## ActiveStack Services
- [gateway.js](src/service/gateway.js) - Passed in the Express HTTP Server instance to listen for connect requests on.
    1. Sets up a redis listener for the SocketIO library to use. This is meant to allow each instance of a SocketIO listener to be stateless.
    2. Starts up a SocketIO listener, attaching itself to the ExpressJS HTTP Server instance passed in from [server.js](stc/server.js).
    3. As part of the SocketIO listener, a Flash Policy "Server" is also started for Flash based socket clients.
    4. Creates and starts a new RabbitMQ listener.
    5. Once the RabbitMQ listener is established (i.e. has emitted its `ready` event) the SocketIO has its `connection` listener setup.
    6. SocketIO `connection` listener handles a new client connect request by:
        1. Storing a reference to the socket by its `socket.id`.
        2. Adds listeners to the new socket for `disconnect` and `logout`.
        3. Creates a new [Client](src/service/gateway/client.js), passing in the new socket, RabbitMQ instance, and RabbitMQ exchange.
        4. Once the new [Client](src/service/gateway/client.js) is established it is meant to handle all communication with the client except in the case of a socket `disconnect`/`logout`.

## ActiveStack Client
- [Client](src/service/gateway/client.js)
    1. Creates a new [Session](src/service/gateway/session.js) for the Client.  A Session represents the state of the 
       Client. In order to be stateless, the Session data is encrypted and sent to the client.  The encrypted session data is considered to be the reconnect "key" for any client reconnect attempts.  Whenever the Session data changes, the reconnect "key" is re-packaged and re-sent to the client.
    2. Sets up listeners for:
        1. `message` - Routes the message to all the clients [registered agents](src/service/gateway/agent_adapter/base.js)
        2. `logout` - Routes the logout message to all the clients [registered agents](src/service/gateway/agent_adapter/base.js)
        3. `disconnect` - Routes the disconnect message to all the clients [registered agents](src/service/gateway/agent_adapter/base.js)
        4. `error` - Handles the error accordingly, which potentially means invalidating and disposing of the Client.

---
_Source: https://npm.io/package/activestack-gateway · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._