colyseus-events

Generate json-patch events from colyseus state.

import { wireEvents } from 'colyseus-events';
import { getStateCallbacks } from 'colyseus.js';
const room: Room<GameState> = await client.joinOrCreate("game");
const { events } = wireEvents(room, new EventEmitter());
// `events` will emit json-patch events whenever the room state changes

Version Support

v4.0+: Requires @colyseus/schema 3.x (Colyseus 0.15/0.16+)

Breaking change from v3.x: The API now accepts the room object instead of just the room.state object. This change is required for @colyseus/schema 3.x compatibility.

For @colyseus/schema 2.x support, use [email protected]

Installation

npm install colyseus-events --save

How to use

wireEvents

Import wireEvents and call it once when connecting to a room on the client side:

import { wireEvents } from 'colyseus-events';
import { getStateCallbacks } from 'colyseus.js';
const room: Room<GameState> = await client.joinOrCreate("game");
const { events } = wireEvents(room, getStateCallbacks(room), new EventEmitter());
// `events` will emit json-patch events whenever the room state changes

then you can wire listeners to events using the JSON-pointer of target field as event name.

customWireEvents

To change the behavior for parts or all of your state, use customWireEvents to produce your own version of wireEvents:

import { customWireEvents, coreVisitors} from 'colyseus-events';
import { getStateCallbacks } from 'colyseus.js';
const special = {
    visit: (traverse: Traverse, state: Container, events: Events, jsonPath: string, callbackProxy): boolean => { /* see Visitor implementation below*/},
};
const wireEvents = customWireEvents([ special, ...coreVisitors]);
const room: Room<GameState> = await client.joinOrCreate("game");
const { events } = wireEvents(room, getStateCallbacks(room), new EventEmitter());
// `events` will emit json-patch events whenever the room state changes

customWireEvents accepts a single argument, a collection of Visitor objects, and returns afunctyion compatible with the default wireEvents. In fact, the default wireEvents function is itself the result customWireEvents when using coreVisitors as the argument. it is defined in wire-events.ts by the following line:

export const wireEvents = customWireEvents(coreVisitors);

The order of the visitors is crucial: they are executed as a fallback chain: the first visitor to return true will stop the chain and prevent later visitors from wiring the same state. So be sure to order them by specificity: the more specific handlers should first check for their use case before the generic visitors, and coreVisitors should be the last visitors.

Visitor implementation

A visitor must implement a single method, visit(traverse, state, events, namespace, callbackProxy). This method should:

1. Check if it is going to handle the state object, and return false if not.
2. Use the callback proxy to register listeners on the state object.
3. Hook callbacks using the proxy: $(state).onAdd(), $(state).listen(), etc.
4. For every new value in callbacks, call the traverse function and emit events.
5. Return true to stop the visitor chain.

Examples can be found in core-visitors.ts. Here is a brief of the visitor that handles MapSchema:

{
    visit: (traverse: Traverse, state: Container, events: Events, namespace: string, callbackProxy) => {
            // Check if it is going to handle the state object, and return `false` if not.
            if (!(state instanceof MapSchema)) {
                return false;
            }
            // Get callback proxy for this state object
            const $ = callbackProxy(state);

            // Hook on new elements using the proxy
            $.onAdd((value: unknown, field: unknown) => {
                const fieldStr = field as string;
                const fieldNamespace = `${namespace}/${fieldStr}`; // path to the new element
                events.emit(namespace, Add(fieldNamespace, value as Colyseus)); // emit the add event
                traverse(value as Colyseus, events, fieldNamespace, callbackProxy); // call the traverse function on the new value
            });

            ...

            // finally return true. this will break the visitors fallback chain and complete the wiring for this object.
            return true;
        }
}

Examples

For example, given the room state:

export class Inner extends Schema {
    @type('uint8') public x = 0;
    @type('uint8') public y = 0;
}
export class GameState extends Schema {
    @type('uint8') public foo = 0;
    @type(Inner) public bar = new Inner();
    @type(['uint8']) public numbersArray = new ArraySchema<number>();
    @type({ map: 'uint8' }) public mapNumbers = new MapSchema<number>();
    @type({ collection: 'uint8' }) public numbersCollection = new CollectionSchema<number>();
    @type({ set: 'uint8' }) public numbersSet = new SetSchema<number>();
}

changing values

when changing a value in Schema or collection (ArraySchema, MapSchema, CollectionSchema, or SetSchema), an event will be emitted. The name of the event will be the JSON-pointer describing the location of the property. The event value will be a "replace" JSON Patch corresponding with the change. For example:

• when the server executes: room.state.foo = 1 an event named '/foo' will be emitted with value { op: 'replace', path: '/foo', value: 1 }
• when the server executes: room.numbersArray[0] = 1 (assuming numbersArray had a previous value at index 0) an event named '/numbersArray/1' will be emitted with value { op: 'replace', path: '/numbersArray/1', value: 1 }
• when the server executes: room.mapNumbers.set('F00', 1) (assuming mapNumbers had a previous value at key F00) an event named '/mapNumbers/F00' will be emitted with value { op: 'replace', path: '/mapNumbers/F00', value: 1 }
• when the server executes: room.state.bar.x = 1 an event named '/bar/x' will be emitted with value { op: 'replace', path: '/bar/x', value: 1 }
• when the server executes: room.state.bar = new Inner() an event named '/bar' will be emitted with value { op: 'replace', path: '/bar', value: {{the actual object in state.bar }} }

...and so on.

adding and removing elements in collections

when adding or removing elements in a collection (ArraySchema, MapSchema, CollectionSchema, or SetSchema), an event will be also be emitted. The name of the event will be the JSON-pointer describing the location of the container. The event value will be a "add" or "remove" JSON Patch corresponding with the change. the path in the event value will point to the location of the element that was added or removed. For example:

• when the server executes: room.numbersArray.push(1) an event named '/numbersArray' will be triggered with value { op: 'add', path: '/numbersArray/0', value: 1 }
• when the server executes: room.numbersArray.pop() an event named '/numbersArray' will be triggered with value { op: 'remove', path: '/numbersArray/0' }
• when the server executes: room.mapNumbers.set('F00', 1) an event named '/mapNumbers' will be triggered with value { op: 'add', path: '/mapNumbers/F00', value: 1 }
• when the server executes: room.mapNumbers.delete('F00') an event named '/mapNumbers' will be triggered with value { op: 'remove', path: '/mapNumbers/F00' }
• when the server executes: room.numbersCollection.add(1) an event named '/numbersCollection' will be triggered with value { op: 'add', path: '/numbersCollection/0', value: 1 }
• when the server executes: room.numbersSet.add(1) an event named '/numbersSet' will be triggered with value { op: 'add', path: '/numbersSet/0', value: 1 }

...and so on.

You are welcomed to explore the tests in the github repo for more examples.

Contributor instructions

Installing workspace

to install a development environment, you need to have node.js git installd. Then, git clone this repo locally and run:

$ npm install
$ npm test

and that's it, you've just installed the development environment!

This project is written with VSCode in mind. specifically configured for these extensions: dbaeumer.vscode-eslint, esbenp.prettier-vscode.

test

npm run test

execute all tests.

clean

npm run clean

Removes any built code and any built executables.

build

npm run build

Cleans, then builds the library.

Your built code will be in the ./dist/ directory.