feat: add client.protocol override option for client (#218)

* Add `client.protocol` override option for client

Enables users of reverse proxies to specify a different protocol scheme
for client requests (typically `wss` from the browser) from the protocol
scheme served by the server (typically `ws`).

* Add properly-typed protocol to validation

* Update tests for client

* change `serverProtocol` back to `protocol`

Co-authored-by: Andrew Powell <[email protected]>

Co-authored-by: Andrew Powell <[email protected]>

Author: pappasam

README.md

@@ -103,6 +103,11 @@ Type: `String`
 
 If set, allows for overriding the `WebSocket` address, which corresponds to the server address by default. Values for this option should be in a valid `{host}:{port}` format. e.g. `localhost:433`.
 
+#### `client.protocol`
+Type: `String`
+
+If set, allows for overriding the `WebSocket` protocol scheme string, which corresponds to the server protocol scheme by default. Values for this option should be one of the following: `ws` or `wss`.
+
 #### `client.retry`
 Type: `Boolean`
 

lib/client/client.js

@@ -24,7 +24,7 @@ const run = (buildHash, options) => {
   const { error, info, warn } = require('./log')();
 
   const protocol = secure ? 'wss' : 'ws';
-  const socket = new ClientSocket(client, `${protocol}://${client.address || address}/wps`);
+  const socket = new ClientSocket(client, `${client.protocol || protocol}://${client.address || address}/wps`);
 
   const { compilerName } = options;
 

lib/validate.js

@@ -35,6 +35,7 @@ module.exports = {
       allowMany: boolean(),
       client: partial({
         address: string(),
+        protocol: union([literal('ws'), literal('wss')]),
         retry: boolean(),
         silent: boolean()
       }),

test/validate.test.js

@@ -10,8 +10,14 @@ test('defaults', (t) => {
 });
 
 test('client', (t) => {
-  const result = validate({ client: { address: '0', retry: false, silent: false } });
+  const result = validate({ client: { address: '0', protocol: "wss", retry: false, silent: false } });
   t.falsy(result.error);
+
+  const resultWs = validate({ client: { address: '0', protocol: "ws", retry: false, silent: false } });
+  t.falsy(resultWs.error);
+
+  const resultProtocolBad = validate({ client: { address: '0', protocol: "lala", retry: false, silent: false } });
+  t.truthy(resultProtocolBad.error);
 });
 
 test('error', (t) => {