Map Websocket error codes to short descriptions (#2601)

Author: jacogr

CHANGELOG.md

@@ -9,6 +9,7 @@ Changes:
 - When cloning an API instance the registry is shared with the source
 - Optimize derive `receivedHeartbeats` to not re-create the full object
 - Add `staking.stakerPrefs` derive to retrieve validatorPrefs over a range of eras
+- Basic map of Websocket error codes to short descriptions (where none available)
 
 
 ## 1.32.1 Sep 7, 2020

package.json

@@ -28,15 +28,15 @@
     "@babel/core": "^7.11.6",
     "@babel/register": "^7.11.5",
     "@babel/runtime": "^7.11.2",
-    "@polkadot/dev": "^0.55.48",
-    "@polkadot/ts": "^0.3.44",
+    "@polkadot/dev": "^0.55.51",
+    "@polkadot/ts": "^0.3.46",
     "@polkadot/typegen": "workspace:packages/typegen",
     "@types/jest": "^26.0.13",
     "@vuepress/plugin-search": "^1.5.4",
     "copyfiles": "^2.3.0",
     "typedoc": "^0.19.1",
     "typedoc-plugin-markdown": "^2.4.2",
-    "typedoc-plugin-no-inherit": "^1.1.10"
+    "typedoc-plugin-no-inherit": "^1.2.0"
   },
   "version": "1.33.0-beta.5"
 }

packages/rpc-provider/src/ws/Provider.ts

@@ -11,6 +11,7 @@ import { assert, isNull, isUndefined, isChildClass, logger } from '@polkadot/uti
 
 import Coder from '../coder';
 import defaults from '../defaults';
+import { getWSErrorString } from './errors';
 import getWSClass from './getWSClass';
 
 interface SubscriptionHandler {
@@ -314,7 +315,7 @@ export default class WsProvider implements ProviderInterface {
 
   #onSocketClose = (event: CloseEvent): void => {
     if (this.#autoConnectMs > 0) {
-      l.error(`disconnected from ${this.#endpoints[this.#endpointIndex]} code: '${event.code}' reason: '${event.reason}'`);
+      l.error(`disconnected from ${this.#endpoints[this.#endpointIndex]}: ${event.code}:: ${event.reason || getWSErrorString(event.code)}`);
     }
 
     this.#isConnected = false;

packages/rpc-provider/src/ws/errors.ts

@@ -0,0 +1,42 @@
+// Copyright 2017-2020 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+// from https://stackoverflow.com/questions/19304157/getting-the-reason-why-websockets-closed-with-close-code-1006
+
+const specificStatusCodeMappings: Record<number, string> = {
+  1000: 'Normal Closure',
+  1001: 'Going Away',
+  1002: 'Protocol Error',
+  1003: 'Unsupported Data',
+  1004: '(For future)',
+  1005: 'No Status Received',
+  1006: 'Abnormal Closure',
+  1007: 'Invalid frame payload data',
+  1008: 'Policy Violation',
+  1009: 'Message too big',
+  1010: 'Missing Extension',
+  1011: 'Internal Error',
+  1012: 'Service Restart',
+  1013: 'Try Again Later',
+  1014: 'Bad Gateway',
+  1015: 'TLS Handshake'
+};
+
+export function getWSErrorString (code: number): string {
+  if (code >= 0 && code <= 999) {
+    return '(Unused)';
+  } else if (code >= 1016) {
+    if (code <= 1999) {
+      return '(For WebSocket standard)';
+    } else if (code <= 2999) {
+      return '(For WebSocket extensions)';
+    } else if (code <= 3999) {
+      return '(For libraries and frameworks)';
+    } else if (code <= 4999) {
+      return '(For applications)';
+    }
+  }
+
+  return specificStatusCodeMappings[code] || '(Unknown)';
+}

packages/typegen/package.json

@@ -43,7 +43,7 @@
     "@polkadot/util": "^3.4.1",
     "handlebars": "^4.7.6",
     "websocket": "^1.0.32",
-    "yargs": "^15.4.1"
+    "yargs": "^16.0.3"
   },
   "devDependencies": {
     "@types/websocket": "^1.0.1",