nanite-systems/stream

The Nanite Systems streaming services is a backwards-compatible ESS of PS2 Census ESS. It implements numerous fixes and present a more reliable event stream.

Description

The Nanite Systems streaming services is a backwards-compatible ESS of PS2 Census ESS. It implements numerous fixes and present a more reliable event stream. The service is composed of multiple microservices:

• Collector service: Maintains connections to the Census ESS instances and collects, deduplicates, and multiplexes the event stream;
• Manifold ESS: The endpoint of the NS ESS that exposes the event stream;
• API service: exposes service states and commands like recent characters;
• Auth service: forward auth service id validator.

Requirements

• Node.js v18
• Pnpm v8
• Docker

Installation

# install dependencies and setup projects
$ pnpm i

# configuration of each app
$ cp .env.example .env

Running the service

For each individual service

# development, e.g.
$ pnpm stream-collector start

# watch mode
$  pnpm stream-collector start:dev

License

All NS projects are Apache-2.0 licensed.

stream's Issues

Fix new release trigger no build

Changeset not creating tags and releases

Changeset should create tags and releases on version change.

Add AsyncAPI support

Similar to Swagger/OpenAPI, but for websockets https://www.asyncapi.com/

Extend metrics

NSS could make use of additional metrics:

• stream-api:
  • census connection state count(connected, disconnected);
  • census request latency;
• stream-auth
  • service id check count(census, cache);
  • census service id check latency.

Prettier sort

Deprecate utf-8-validate(planned)

utf-8-validate becomes redundant in v19 of Node, so should be deprecated when v20 LTS is released.

Connection states need to be recorded on a per connection basis

Currently no label is added to discriminate based on connection for ess_connection_state_count.

Implement ENV_PATHS environment variable to manage shared env files

Move NS auth to monorepo

Auth app to be migrated to the monorepo to reduce overhead of maintenance.

Improve deduplication headers

Headers send with messages in RabbitMQ are not quite there yet. Needs some additional work including hashing perhaps.

Consul intergration for NSS

Let collector handle multiple connections with cycling algorithm

Each collector only has a single connection, with running multiple collectors with only some rudimentary functionality to manage connections. What we know now is that the ESS uses multiple instances, some of which can go bad. Each instance has its own heartbeat, which can be used to discriminate between instances.

The idea is to spawn multiple connections on a single collector and cycle connections such that between the connections the heartbeats are out of sync.

Unentangle logging using files + Loki

Disconnect log missing connection context in collector

Disconnect logs do not indicate which connection disconnected.

[refactor] Support replay

Let a connection replay messages from a certain point. This to allows clients to not miss any messages on reconnects.

The functionality can be achieved using RabbitMQs stream plugin. Retention will probably be around 5-10minutes depending on testing. To make use of this the client needs to provide a query parameter with a timestamp.