6807485112

Committed 09 Nov 2023 04:38AM UTC coverage: 87.862% (-0.4%) from 88.307%

Build # 6807485112

Build Type

push

github

Committed by

web-flow

Commit Message

refactor: turn on @typescript-eslint/strict-type-checked (#163)

Enable rule and associated fixes. I think a lot of small bugs may have
been squashed

Run Details

542 of 658 branches covered (0.0%)

Branch coverage included in aggregate %.

88 of 103 new or added lines in 16 files covered. (85.44%)

5 existing lines in 3 files now uncovered.

1065 of 1171 relevant lines covered (90.95%)

3855.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

73.33

/src/network/udp-socket.ts

import dgram from 'dgram';
import { decrypt, encrypt } from 'tplink-smarthome-crypto';

import { replaceControlCharacters } from '../utils';
import TplinkSocket from './tplink-socket';

/**
 * @hidden
 */
export default class UdpSocket extends TplinkSocket {
  readonly socketType = 'UDP';

  override socket?: dgram.Socket;

  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  logDebug(...args: any[]): void {
    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
    this.log.debug(`[${this.socketId}] UdpSocket${args.shift()}`, ...args);
  }

  async createSocketImpl(): Promise<dgram.Socket> {
    return new Promise((resolve, reject) => {
      const socket = dgram.createSocket('udp4');
      this.socket = socket;

      this.socket.on('error', (err) => {
        this.logDebug(': createSocket:error');
        reject(err);
      });

      this.socket.bind(() => {
        this.logDebug('.createSocket(): listening on %j', socket.address());
        socket.removeAllListeners('error'); // remove listener so promise can't be resolved & rejected

        this.isBound = true;
        resolve(socket);
      });
    });
  }

  override close(): void {
    if (this.socket !== undefined) this.socket.close();
    super.close();
  }

  protected async sendAndGetResponse(
    payload: string,
    port: number,
    host: string,
    timeout: number,
  ): Promise<string> {
    return new Promise((resolve, reject) => {
      const { socket } = this;
      if (socket === undefined)
        throw new Error('send called without creating socket');

      let timer: NodeJS.Timeout | undefined;
      const setSocketTimeout = (socketTimeout: number): void => {
        if (timer != null) clearTimeout(timer);
        if (socketTimeout > 0) {
          timer = setTimeout(() => {
            this.logDebug(`: socketTimeout(${socketTimeout})`);
            reject(
              new Error(
                `UDP Timeout after ${socketTimeout}ms\n${host}:${port} ${payload}`,
              ),
            );
          }, socketTimeout);
        }
      };
      setSocketTimeout(timeout);

      socket.removeAllListeners('message');
      socket.removeAllListeners('close');
      socket.removeAllListeners('error');

      socket.on('message', (msg, rinfo) => {
        let decryptedMsg = '';
        try {
          this.logDebug(': socket:data rinfo: %j', rinfo);
          setSocketTimeout(0);

          decryptedMsg = decrypt(msg).toString('utf8');
          this.logDebug(
            `: socket:data message:${replaceControlCharacters(decryptedMsg)}`,
          );

          resolve(decryptedMsg);
        } catch (err) {
          this.log.error(
            `Error processing UDP message: From:[%j] SO_RCVBUF:[%d]${'\n'}  msg:[%o]${'\n'}  decrypted:[${replaceControlCharacters(
              decryptedMsg,
            )}]`,
            rinfo,
            socket.getRecvBufferSize(),
            msg,
          );
          reject(err);
        }
      });

      socket.on('close', () => {
        try {
          this.logDebug(': socket:close');
          setSocketTimeout(0);
        } finally {
          reject(new Error('UDP Socket Closed'));
        }
      });

      socket.on('error', (err) => {
        this.logDebug(': socket:error');
        setSocketTimeout(0);
        reject(err);
      });

      const encryptedPayload = encrypt(payload);
      this.logDebug(': socket:send payload.length', encryptedPayload.length);

      socket.send(
        encryptedPayload,
        0,
        encryptedPayload.length,
        port,
        host,
        (err) => {
          if (err) {
            try {
              this.logDebug(
                `: socket:send socket:error length: ${
                  encryptedPayload.length
                } SO_SNDBUF:${socket.getSendBufferSize()} `,
                err,
              );
              if (this.isBound) this.close();
            } finally {
              reject(err);
            }
            return;
          }
          this.logDebug(': socket:send sent');
        },
      );
    });
  }
}

1	import dgram from 'dgram';	24✔
2	import { decrypt, encrypt } from 'tplink-smarthome-crypto';	24✔
3
4	import { replaceControlCharacters } from '../utils';	24✔
5	import TplinkSocket from './tplink-socket';	24✔
6
7	/**
8	* @hidden
9	*/
10	export default class UdpSocket extends TplinkSocket {	24✔
11	readonly socketType = 'UDP';	8,523✔
12
13	override socket?: dgram.Socket;
14
15	// eslint-disable-next-line @typescript-eslint/no-explicit-any
16	logDebug(...args: any[]): void {
17	// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
18	this.log.debug(`[${this.socketId}] UdpSocket${args.shift()}`, ...args);	67,638✔
19	}
20
21	async createSocketImpl(): Promise<dgram.Socket> {
22	return new Promise((resolve, reject) => {	8,523✔
23	const socket = dgram.createSocket('udp4');	8,523✔
24	this.socket = socket;	8,523✔
25
26	this.socket.on('error', (err) => {	8,523✔
27	this.logDebug(': createSocket:error');	×
28	reject(err);	×
29	});
30
31	this.socket.bind(() => {	8,523✔
32	this.logDebug('.createSocket(): listening on %j', socket.address());	8,523✔
33	socket.removeAllListeners('error'); // remove listener so promise can't be resolved & rejected	8,523✔
34
35	this.isBound = true;	8,523✔
36	resolve(socket);	8,523✔
37	});
38	});
39	}
40
41	override close(): void {
42	if (this.socket !== undefined) this.socket.close();	8,523!
43	super.close();	8,523✔
44	}
45
46	protected async sendAndGetResponse(
47	payload: string,
48	port: number,
49	host: string,
50	timeout: number,
51	): Promise<string> {
52	return new Promise((resolve, reject) => {	12,648✔
53	const { socket } = this;	12,648✔
54	if (socket === undefined)	12,648!
55	throw new Error('send called without creating socket');	×
56
57	let timer: NodeJS.Timeout \| undefined;
58	const setSocketTimeout = (socketTimeout: number): void => {	12,648✔
59	if (timer != null) clearTimeout(timer);	33,819✔
60	if (socketTimeout > 0) {	33,819✔
61	timer = setTimeout(() => {	12,648✔
62	this.logDebug(`: socketTimeout(${socketTimeout})`);	×
63	reject(	×
64	new Error(
65	`UDP Timeout after ${socketTimeout}ms\n${host}:${port} ${payload}`,
66	),
67	);
68	}, socketTimeout);
69	}
70	};
71	setSocketTimeout(timeout);	12,648✔
72
73	socket.removeAllListeners('message');	12,648✔
74	socket.removeAllListeners('close');	12,648✔
75	socket.removeAllListeners('error');	12,648✔
76
77	socket.on('message', (msg, rinfo) => {	12,648✔
78	let decryptedMsg = '';	12,648✔
79	try {	12,648✔
80	this.logDebug(': socket:data rinfo: %j', rinfo);	12,648✔
81	setSocketTimeout(0);	12,648✔
82
83	decryptedMsg = decrypt(msg).toString('utf8');	12,648✔
84	this.logDebug(	12,648✔
85	`: socket:data message:${replaceControlCharacters(decryptedMsg)}`,
86	);
87
88	resolve(decryptedMsg);	12,648✔
89	} catch (err) {
90	this.log.error(	×
91	`Error processing UDP message: From:[%j] SO_RCVBUF:[%d]${'\n'} msg:[%o]${'\n'} decrypted:[${replaceControlCharacters(
92	decryptedMsg,
93	)}]`,
94	rinfo,
95	socket.getRecvBufferSize(),
96	msg,
97	);
NEW 98	reject(err);	×
99	}
100	});
101
102	socket.on('close', () => {	12,648✔
103	try {	8,523✔
104	this.logDebug(': socket:close');	8,523✔
105	setSocketTimeout(0);	8,523✔
106	} finally {
107	reject(new Error('UDP Socket Closed'));	8,523✔
108	}
109	});
110
111	socket.on('error', (err) => {	12,648✔
112	this.logDebug(': socket:error');	×
113	setSocketTimeout(0);	×
114	reject(err);	×
115	});
116
117	const encryptedPayload = encrypt(payload);	12,648✔
118	this.logDebug(': socket:send payload.length', encryptedPayload.length);	12,648✔
119
120	socket.send(	12,648✔
121	encryptedPayload,
122	0,
123	encryptedPayload.length,
124	port,
125	host,
126	(err) => {
127	if (err) {	12,648!
128	try {	×
129	this.logDebug(	×
130	`: socket:send socket:error length: ${
131	encryptedPayload.length
132	} SO_SNDBUF:${socket.getSendBufferSize()} `,
133	err,
134	);
135	if (this.isBound) this.close();	×
136	} finally {
137	reject(err);	×
138	}
139	return;	×
140	}
141	this.logDebug(': socket:send sent');	12,648✔
142	},
143	);
144	});
145	}
146	}

plasticrake / tplink-smarthome-api / 6807485112

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous