-
Notifications
You must be signed in to change notification settings - Fork 3
/
client.js
180 lines (149 loc) · 4.64 KB
/
client.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
'use strict';
const debug = require('debug')('sc2:debug:proto');
const WebSocket = require('ws');
const protobuf = require('protobufjs/light');
const taskQueue = require('promise-task-queue');
const promiseFromEvent = require('event-to-promise');
const createEventEmitter = require('create-event-emitter');
const sc2 = protobuf.Root.fromJSON(require('./proto-bundle.js'));
const Request = sc2.lookupType('Request');
const Response = sc2.lookupType('Response');
/**
* this extracts the possible Request/Response types from the `oneof` def:
*
* 'createGame', 'joinGame', 'restartGame', 'startReplay', 'leaveGame',
* 'quickSave', 'quickLoad', 'quit', 'gameInfo', 'observation', 'action',
* 'obsAction', 'step', 'data', 'query', 'saveReplay', 'replayInfo',
* 'availableMaps', 'saveMap', 'mapCommand', 'ping', 'debug'
**/
const responseTypes = Response.oneofs.response.oneof;
/** map the Request/Response types to an array of objs with meta data */
const responses = Response.fieldsArray.map((field) => ({
name: field.name,
type: field.type,
errorType: `field.type:${Error}`,
}));
/**
* convenience wrapper for creating the event emitter functions
*/
function queueWrapper(responseName, successEvent, errorEvent) {
return function (err, res) {
if (err) {
this.emit(errorEvent, err);
} else {
this.emit(successEvent, res[responseName]);
}
};
}
/**
* creates an event emitter with a unique event per request type
*/
function createApiQueue() {
return createEventEmitter(
responses.reduce((fns, entry) => {
return {
...fns,
[entry.name]: queueWrapper(
entry.name,
entry.type,
entry.errorType,
),
};
}, {}));
}
/**
* creates a unique payload creation and push-to-queue function per request type
* @returns {NodeSC2Proto.ApiFunctions}
*/
function createApiFunctions() {
function responseReducer(acc, entry) {
function protoAPIFunction(req = {}) {
const request = Request.create({ [entry.name]: req });
const payload = Request.encode(request).finish();
return this._promiseQueue.push(entry.name, payload);
}
return {
...acc,
[entry.name]: protoAPIFunction,
};
}
return responses.reduce(responseReducer, {});
}
/**
* creates a promise queue to enforce single-concurrency on a
* per-request type basis. this function *must* be bound to the
* proto client before a new queue is created, due to the queue
* task functions being invoked on the queue manager.
*/
function createPromiseQueue() {
const queue = taskQueue();
responses.forEach((entry) => {
queue.define(entry.name, (payload) => {
const promise = promiseFromEvent(
this._protoApiQueue,
entry.type,
{ error: entry.errorType }
);
this._request(payload);
return promise;
}, { concurrency: 1 });
});
return queue;
}
function createConnection({ host = '127.0.0.1', port = 5000 }) {
return new WebSocket(`ws://${host}:${port}/sc2api`);
}
function createProtoClient() {
const _ws = null;
const status = 99;
const apiQueue = createApiQueue();
apiQueue.setMaxListeners(24);
// @TODO should we be exposing the websocket itself like this?
/** @type {NodeSC2Proto.ProtoClient} */
const client = {
...createApiFunctions(),
_ws,
async connect(opts) {
this._ws = createConnection(opts);
this._ws.on('message', (res) => {
let err;
//@ts-ignore i promise you it's not a string
const responseMessage = Response.decode(res);
/** @type {SC2APIProtocol.Response} */
const response = Response.toObject(responseMessage, {
longs: String, // default uint64's to strings
defaults: true, // populates empty arrays and objects instead of dropping
});
if (response.status) {
this.status = response.status;
}
if (response.error && response.error.length > 0) {
err = Object.assign(
new Error(`Response Error: ${JSON.stringify(response.error, null, 2)}`),
{ err: response.error },
);
}
const responseType = responseTypes.find(type => response[type]);
const callbackHandler = this._protoApiQueue[responseType];
if (!callbackHandler) {
debug("WARNING: response received with no valid response type handler: ", response)
} else {
this._protoApiQueue[responseType](err, response);
}
});
this._ws.on('error', console.warn);
this._ws.on('close', () => debug('CONNECTION CLOSED'));
await promiseFromEvent(this._ws, 'open');
debug(`successfully connected to sc2 client on port ${opts.port}`);
return this.ping();
},
status,
_request(requestBuffer) {
this._ws.send(requestBuffer);
},
_protoApiQueue: apiQueue,
};
client._promiseQueue = createPromiseQueue.bind(client)();
return client;
}
module.exports = createProtoClient;