Fix schemas and tests

3 files changed, 29 insertions, 26 deletions

diff --git a/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts b/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
index f90961cc8..da5667db3 100644
--- a/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
+++ b/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
@@ -105,20 +105,22 @@ export class OrderWatcherWebSocketServer {
 
     private async _onMessageCallbackAsync(connection: WebSocket.connection, message: any): Promise<void> {
         let response: WebSocketResponse;
-        assert.doesConformToSchema('message', message, schemas.orderWatcherWebSocketUtf8MessageSchema);
-        const request: WebSocketRequest = JSON.parse(message.utf8Data);
-        assert.doesConformToSchema('request', request, schemas.orderWatcherWebSocketRequestSchema);
-        assert.isString(request.jsonrpc, JSON_RPC_VERSION);
+        let id: number | null = null;
         try {
+            assert.doesConformToSchema('message', message, schemas.orderWatcherWebSocketUtf8MessageSchema);
+            const request: WebSocketRequest = JSON.parse(message.utf8Data);
+            id = request.id;
+            assert.doesConformToSchema('request', request, schemas.orderWatcherWebSocketRequestSchema);
+            assert.isString(request.jsonrpc, JSON_RPC_VERSION);
             response = {
-                id: request.id,
+                id,
                 jsonrpc: JSON_RPC_VERSION,
                 method: request.method,
                 result: await this._routeRequestAsync(request),
             };
         } catch (err) {
             response = {
-                id: request.id,
+                id,
                 jsonrpc: JSON_RPC_VERSION,
                 method: null,
                 error: err.toString(),
diff --git a/packages/order-watcher/src/types.ts b/packages/order-watcher/src/types.ts
index 536363d8a..2b529a939 100644
--- a/packages/order-watcher/src/types.ts
+++ b/packages/order-watcher/src/types.ts
@@ -48,21 +48,21 @@ export enum OrderWatcherMethod {
 // the data field of their WebSocket message to interact with the server.
 export type WebSocketRequest = AddOrderRequest | RemoveOrderRequest | GetStatsRequest;
 
-interface AddOrderRequest {
+export interface AddOrderRequest {
     id: number;
     jsonrpc: string;
     method: OrderWatcherMethod.AddOrder;
     params: { signedOrder: SignedOrder };
 }
 
-interface RemoveOrderRequest {
+export interface RemoveOrderRequest {
     id: number;
     jsonrpc: string;
     method: OrderWatcherMethod.RemoveOrder;
     params: { orderHash: string };
 }
 
-interface GetStatsRequest {
+export interface GetStatsRequest {
     id: number;
     jsonrpc: string;
     method: OrderWatcherMethod.GetStats;
@@ -72,21 +72,21 @@ interface GetStatsRequest {
 // of the WebSocket messages that the server sends out.
 export type WebSocketResponse = SuccessfulWebSocketResponse | ErrorWebSocketResponse;
 
-interface SuccessfulWebSocketResponse {
+export interface SuccessfulWebSocketResponse {
     id: number;
     jsonrpc: string;
     method: OrderWatcherMethod;
     result: OrderState | GetStatsResult | undefined; // result is undefined for ADD_ORDER and REMOVE_ORDER
 }
 
-interface ErrorWebSocketResponse {
-    id: number;
+export interface ErrorWebSocketResponse {
+    id: number | null;
     jsonrpc: string;
     method: null;
     error: JSONRPCError;
 }
 
-interface JSONRPCError {
+export interface JSONRPCError {
     code: number;
     message: string;
     data?: string | object;
diff --git a/packages/order-watcher/test/order_watcher_websocket_server_test.ts b/packages/order-watcher/test/order_watcher_websocket_server_test.ts
index 8a6deede8..d21c676fc 100644
--- a/packages/order-watcher/test/order_watcher_websocket_server_test.ts
+++ b/packages/order-watcher/test/order_watcher_websocket_server_test.ts
@@ -11,6 +11,7 @@ import 'mocha';
 import * as WebSocket from 'websocket';
 
 import { OrderWatcherWebSocketServer } from '../src/order_watcher/order_watcher_websocket_server';
+import { AddOrderRequest, OrderWatcherMethod, RemoveOrderRequest } from '../src/types';
 
 import { chaiSetup } from './utils/chai_setup';
 import { constants } from './utils/constants';
@@ -43,8 +44,8 @@ describe.only('OrderWatcherWebSocketServer', async () => {
     let orderHash: string;
     // Manually encode types rather than use /src/types to mimick real data that user
     // would input. Otherwise we would be forced to use enums, which hide problems.
-    let addOrderPayload: { id: string; jsonrpc: string; method: string; params: { signedOrder: SignedOrder } };
-    let removeOrderPayload: { id: string; jsonrpc: string; method: string; params: { orderHash: string } };
+    let addOrderPayload: AddOrderRequest;
+    let removeOrderPayload: RemoveOrderRequest;
     const decimals = constants.ZRX_DECIMALS;
     const fillableAmount = Web3Wrapper.toBaseUnitAmount(new BigNumber(5), decimals);
     // HACK: createFillableSignedOrderAsync is Promise-based, which forces us
@@ -90,15 +91,15 @@ describe.only('OrderWatcherWebSocketServer', async () => {
         );
         orderHash = orderHashUtils.getOrderHashHex(signedOrder);
         addOrderPayload = {
-            id: 'addOrderPayload',
+            id: 1,
             jsonrpc: '2.0',
-            method: 'ADD_ORDER',
+            method: OrderWatcherMethod.AddOrder,
             params: { signedOrder },
         };
         removeOrderPayload = {
-            id: 'removeOrderPayload',
+            id: 1,
             jsonrpc: '2.0',
-            method: 'REMOVE_ORDER',
+            method: OrderWatcherMethod.RemoveOrder,
             params: { orderHash },
         };
 
@@ -124,14 +125,14 @@ describe.only('OrderWatcherWebSocketServer', async () => {
 
     it('responds to getStats requests correctly', (done: any) => {
         const payload = {
-            id: 'getStats',
+            id: 1,
             jsonrpc: '2.0',
             method: 'GET_STATS',
         };
         wsClient.onopen = () => wsClient.send(JSON.stringify(payload));
         wsClient.onmessage = (msg: any) => {
             const responseData = JSON.parse(msg.data);
-            expect(responseData.id).to.be.eq('getStats');
+            expect(responseData.id).to.be.eq(1);
             expect(responseData.jsonrpc).to.be.eq('2.0');
             expect(responseData.method).to.be.eq('GET_STATS');
             expect(responseData.result.orderCount).to.be.eq(0);
@@ -141,7 +142,7 @@ describe.only('OrderWatcherWebSocketServer', async () => {
 
     it('throws an error when an invalid method is attempted', async () => {
         const invalidMethodPayload = {
-            id: 'invalidMethodPayload',
+            id: 1,
             jsonrpc: '2.0',
             method: 'BAD_METHOD',
         };
@@ -158,7 +159,7 @@ describe.only('OrderWatcherWebSocketServer', async () => {
 
     it('throws an error when jsonrpc field missing from request', async () => {
         const noJsonRpcPayload = {
-            id: 'noJsonRpcPayload',
+            id: 1,
             method: 'GET_STATS',
         };
         wsClient.onopen = () => wsClient.send(JSON.stringify(noJsonRpcPayload));
@@ -172,7 +173,7 @@ describe.only('OrderWatcherWebSocketServer', async () => {
 
     it('throws an error when we try to add an order without a signedOrder', async () => {
         const noSignedOrderAddOrderPayload = {
-            id: 'noSignedOrderAddOrderPayload',
+            id: 1,
             jsonrpc: '2.0',
             method: 'ADD_ORDER',
             orderHash: '0x7337e2f2a9aa2ed6afe26edc2df7ad79c3ffa9cf9b81a964f707ea63f5272355',
@@ -190,7 +191,7 @@ describe.only('OrderWatcherWebSocketServer', async () => {
 
     it('throws an error when we try to add a bad signedOrder', async () => {
         const invalidAddOrderPayload = {
-            id: 'invalidAddOrderPayload',
+            id: 1,
             jsonrpc: '2.0',
             method: 'ADD_ORDER',
             signedOrder: {
@@ -258,7 +259,7 @@ describe.only('OrderWatcherWebSocketServer', async () => {
             takerAddress,
         );
         const nonZeroMakerFeeOrderPayload = {
-            id: 'nonZeroMakerFeeOrderPayload',
+            id: 1,
             jsonrpc: '2.0',
             method: 'ADD_ORDER',
             signedOrder: nonZeroMakerFeeSignedOrder,