Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve WebSocketServer Error Handling #6230

Merged
merged 2 commits into from
Nov 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions spec/ParseLiveQuery.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
'use strict';

describe('ParseLiveQuery', function() {
it('can subscribe to query', async done => {
await reconfigureServer({
liveQuery: {
classNames: ['TestObject'],
},
startLiveQueryServer: true,
verbose: false,
silent: true,
});
const object = new TestObject();
await object.save();

const query = new Parse.Query(TestObject);
query.equalTo('objectId', object.id);
const subscription = await query.subscribe();
subscription.on('update', async object => {
expect(object.get('foo')).toBe('bar');
done();
});
object.set({ foo: 'bar' });
await object.save();
});

afterEach(async function(done) {
const client = await Parse.CoreManager.getLiveQueryController().getDefaultLiveQueryClient();
client.close();
// Wait for live query client to disconnect
setTimeout(() => {
done();
}, 1000);
});
});
39 changes: 39 additions & 0 deletions spec/ParseWebSocketServer.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,45 @@ describe('ParseWebSocketServer', function() {
}, 10);
});

it('can handle error event', async () => {
jasmine.restoreLibrary('ws', 'Server');
const WebSocketServer = require('ws').Server;
let wssError;
class WSSAdapter {
constructor(options) {
this.options = options;
}
onListen() {}
onConnection() {}
onError() {}
start() {
const wss = new WebSocketServer({ server: this.options.server });
wss.on('listening', this.onListen);
wss.on('connection', this.onConnection);
wss.on('error', error => {
wssError = error;
this.onError(error);
});
this.wss = wss;
}
}

const server = await reconfigureServer({
liveQuery: {
classNames: ['TestObject'],
},
liveQueryServerOptions: {
wssAdapter: WSSAdapter,
},
startLiveQueryServer: true,
verbose: false,
silent: true,
});
const wssAdapter = server.liveQueryServer.parseWebSocketServer.server;
wssAdapter.wss.emit('error', 'Invalid Packet');
expect(wssError).toBe('Invalid Packet');
});

afterEach(function() {
jasmine.restoreLibrary('ws', 'Server');
});
Expand Down
2 changes: 2 additions & 0 deletions src/Adapters/WebSocketServer/WSAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ export class WSAdapter extends WSSAdapter {

onListen() {}
onConnection(ws) {}
onError(error) {}
start() {
const wss = new WebSocketServer({ server: this.options.server });
wss.on('listening', this.onListen);
wss.on('connection', this.onConnection);
wss.on('error', this.onError);
}
close() {}
}
Expand Down
9 changes: 9 additions & 0 deletions src/Adapters/WebSocketServer/WSSAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
// Adapter classes must implement the following functions:
// * onListen()
// * onConnection(ws)
// * onError(error)
// * start()
// * close()
//
Expand All @@ -22,6 +23,7 @@ export class WSSAdapter {
constructor(options) {
this.onListen = () => {};
this.onConnection = () => {};
this.onError = () => {};
}

// /**
Expand All @@ -36,6 +38,13 @@ export class WSSAdapter {
// */
// onConnection(ws) {}

// /**
// * Emitted when error event is called.
// *
// * @param {Error} error - WebSocketServer error
// */
// onError(error) {}

/**
* Initialize Connection.
*
Expand Down
2 changes: 2 additions & 0 deletions src/LiveQuery/ParseLiveQueryServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,8 @@ class ParseLiveQueryServer {
event: 'ws_disconnect',
clients: this.clients.size,
subscriptions: this.subscriptions.size,
useMasterKey: client.hasMasterKey,
installationId: client.installationId,
});
});

Expand Down
3 changes: 3 additions & 0 deletions src/LiveQuery/ParseWebSocketServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ export class ParseWebSocketServer {
}
}, config.websocketTimeout || 10 * 1000);
};
wss.onError = error => {
logger.error(error);
};
wss.start();
this.server = wss;
}
Expand Down