Update ws and @types/node, update code to match. (#942)

Author: brendandburns

package-lock.json

@@ -55,9 +55,9 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@types/js-yaml": "^4.0.1",
-    "@types/node": "^10.12.0",
+    "@types/node": "^18.11.17",
     "@types/request": "^2.47.1",
-    "@types/ws": "^6.0.1",
+    "@types/ws": "^8.5.3",
     "byline": "^5.0.0",
     "execa": "5.0.0",
     "isomorphic-ws": "^5.0.0",
@@ -71,7 +71,7 @@
     "tmp-promise": "^3.0.2",
     "tslib": "^2.4.1",
     "underscore": "^1.13.6",
-    "ws": "^7.3.1"
+    "ws": "^8.11.0"
   },
   "devDependencies": {
     "@types/byline": "^4.2.31",

package.json

@@ -1,9 +1,13 @@
 import https = require('https');
 import request = require('request');
+import WebSocket = require('ws');
 
 import { User } from './config_types';
 
 export interface Authenticator {
     isAuthProvider(user: User): boolean;
-    applyAuthentication(user: User, opts: request.Options | https.RequestOptions): Promise<void>;
+    applyAuthentication(
+        user: User,
+        opts: request.Options | https.RequestOptions | WebSocket.ClientOptions,
+    ): Promise<void>;
 }

src/auth.ts

@@ -6,7 +6,9 @@ import net = require('net');
 import path = require('path');
 
 import request = require('request');
+import { base64 } from 'rfc4648';
 import shelljs = require('shelljs');
+import WebSocket = require('ws');
 
 import * as api from './api';
 import { Authenticator } from './auth';
@@ -130,18 +132,23 @@ export class KubeConfig {
         this.makePathsAbsolute(rootDirectory);
     }
 
-    public async applytoHTTPSOptions(opts: https.RequestOptions): Promise<void> {
-        const user = this.getCurrentUser();
-        const cluster = this.getCurrentCluster();
-
+    public async applytoHTTPSOptions(opts: https.RequestOptions | WebSocket.ClientOptions): Promise<void> {
         await this.applyOptions(opts);
 
+        const user = this.getCurrentUser();
         if (user && user.username) {
-            opts.auth = `${user.username}:${user.password}`;
+            // The ws docs say that it accepts anything that https.RequestOptions accepts,
+            // but Typescript doesn't understand that idea (yet) probably could be fixed in
+            // the typings, but for now just cast to any
+            (opts as any).auth = `${user.username}:${user.password}`;
         }
 
+        const cluster = this.getCurrentCluster();
         if (cluster && cluster.tlsServerName) {
-            opts.servername = cluster.tlsServerName;
+            // The ws docs say that it accepts anything that https.RequestOptions accepts,
+            // but Typescript doesn't understand that idea (yet) probably could be fixed in
+            // the typings, but for now just cast to any
+            (opts as any).servername = cluster.tlsServerName;
         }
     }
 
@@ -163,7 +170,7 @@ export class KubeConfig {
         }
 
         if (cluster && cluster.tlsServerName) {
-            opts.agentOptions = { servername: cluster.tlsServerName } as https.RequestOptions;
+            opts.agentOptions = { servername: cluster.tlsServerName } as https.AgentOptions;
         }
     }
 
@@ -402,7 +409,7 @@ export class KubeConfig {
         return this.getContextObject(this.currentContext);
     }
 
-    private applyHTTPSOptions(opts: request.Options | https.RequestOptions): void {
+    private applyHTTPSOptions(opts: request.Options | https.RequestOptions | WebSocket.ClientOptions): void {
         const cluster = this.getCurrentCluster();
         const user = this.getCurrentUser();
         if (!user) {
@@ -426,7 +433,9 @@ export class KubeConfig {
         }
     }
 
-    private async applyAuthorizationHeader(opts: request.Options | https.RequestOptions): Promise<void> {
+    private async applyAuthorizationHeader(
+        opts: request.Options | https.RequestOptions | WebSocket.ClientOptions,
+    ): Promise<void> {
         const user = this.getCurrentUser();
         if (!user) {
             return;
@@ -447,7 +456,9 @@ export class KubeConfig {
         }
     }
 
-    private async applyOptions(opts: request.Options | https.RequestOptions): Promise<void> {
+    private async applyOptions(
+        opts: request.Options | https.RequestOptions | WebSocket.ClientOptions,
+    ): Promise<void> {
         this.applyHTTPSOptions(opts);
         await this.applyAuthorizationHeader(opts);
     }

src/config.ts

@@ -263,6 +263,7 @@ describe('KubeConfig', () => {
 
             const opts: requestlib.Options = {
                 url: 'https://company.com',
+                agentOptions: {} as https.AgentOptions,
             };
             await kc.applyToRequest(opts);
 

src/config_test.ts

@@ -30,7 +30,7 @@ export class FileAuth implements Authenticator {
 
     private refreshToken(filePath: string): void {
         // TODO make this async?
-        this.token = fs.readFileSync(filePath).toString('UTF-8');
+        this.token = fs.readFileSync(filePath).toString('utf8');
         this.lastRead = new Date();
     }
 

src/file_auth.ts

@@ -7,6 +7,7 @@ import { V1Status } from './api';
 import { KubeConfig } from './config';
 import { Cluster, Context, User } from './config_types';
 import { WebSocketHandler, WebSocketInterface } from './web-socket-handler';
+import { fail } from 'assert';
 
 const setImmediatePromise = promisify(setImmediate);
 
@@ -127,8 +128,7 @@ describe('WebSocket', () => {
 
         const promise = handler.connect(path, null, null);
         await setImmediatePromise();
-
-        mockWs.onerror({
+        mockWs.onerror!({
             error: 'some error',
             message: 'some message',
             type: 'type',
@@ -184,26 +184,27 @@ describe('WebSocket', () => {
 
         const event = {
             target: mockWs,
+            type: 'open',
         };
-        mockWs.onopen(event);
+        mockWs.onopen!(event);
         const errEvt = {
             error: {},
             message: 'some message',
             type: 'some type',
             target: mockWs,
         };
-        mockWs.onmessage({
+        mockWs.onmessage!({
             data: 'string data',
             type: 'type',
             target: mockWs,
         });
         const buff = Buffer.alloc(10, 100);
-        mockWs.onmessage({
+        mockWs.onmessage!({
             data: buff,
             type: 'type',
             target: mockWs,
         });
-        mockWs.onerror(errEvt);
+        mockWs.onerror!(errEvt);
         await promise;
     });
     it('should connect properly with handlers', async () => {
@@ -266,28 +267,29 @@ describe('WebSocket', () => {
 
         const event = {
             target: mockWs,
+            type: 'open',
         };
-        mockWs.onopen(event);
+        mockWs.onopen!(event);
         const errEvt = {
             error: {},
             message: 'some message',
             type: 'some type',
             target: mockWs,
         };
-        mockWs.onmessage({
+        mockWs.onmessage!({
             data: 'string data',
             type: 'type',
             target: mockWs,
         });
         const fill = 100;
         const size = 10;
         const buff = Buffer.alloc(size, fill);
-        mockWs.onmessage({
+        mockWs.onmessage!({
             data: buff,
             type: 'type',
             target: mockWs,
         });
-        mockWs.onerror(errEvt);
+        mockWs.onerror!(errEvt);
         await promise;
 
         expect(closeCount).to.equal(2);