chore: Remove deprecated request library in favour of got

Author: PeterC89

doc/architecture_notes.md

@@ -138,7 +138,7 @@ This might be an option to explore further if other approaches are unsuccessful.
 A simple Node.js application has been written ([`cli_bund.js`](../scratch/cli_bund.js)) that allows interaction with the an MSE to change the text of a lower third overlay, _take-in_ the graphic, wait ten seconds and _take-out_ the graphic. This will be the basis of ongoing development, using the following modules:
 
 - [`ws`](https://www.npmjs.com/package/ws) to connect to the MSE over webscockets with PepTalk. Used for reading and writing data and monitoring events.
-- [`request-promise-native`](https://www.npmjs.com/package/request-promise-native) to POST commands to the REST interface of the MSE.
+- [`got`](https://www.npmjs.com/package/got) to POST commands to the REST interface of the MSE.
 
 So as to work with the XML structures in a Javascript-like format, the following library will be used:
 

package.json

@@ -114,8 +114,7 @@
 		"/LICENSE"
 	],
 	"dependencies": {
-		"request": "^2.88.2",
-		"request-promise-native": "^1.0.9",
+		"got": "11.8.6",
 		"uuid": "^8.3.2",
 		"ws": "^7.4.6",
 		"xml2js": "^0.4.23"
@@ -126,8 +125,6 @@
 		"@types/koa": "^2.11.6",
 		"@types/koa-bodyparser": "^4.3.0",
 		"@types/node": "^12.19.15",
-		"@types/request": "^2.48.5",
-		"@types/request-promise-native": "^1.0.17",
 		"@types/uuid": "^8.3.0",
 		"@types/ws": "^7.4.0",
 		"@types/xml2js": "^0.4.8",

scratch/cli_bund.js

@@ -1,4 +1,4 @@
-const request = require('request-promise-native')
+const got = require('got')
 const ws = require('ws')
 
 let webby = new ws('ws://1d8dab0e.ngrok.io/')
@@ -19,18 +19,18 @@ webby.on('open', () => {
 	)
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/take',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/take',
 			body: '/storage/shows/{239F365A-5671-43F3-AD44-D44EB7C4F206}/elements/100_NYHEDERNE-TEST.SOFIE.VIZ-ELEMENTER_271DB363_0',
 		})
 		console.log('>>> Take requested')
 	}, 500)
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/out',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/out',
 			body: '/storage/shows/{239F365A-5671-43F3-AD44-D44EB7C4F206}/elements/100_NYHEDERNE-TEST.SOFIE.VIZ-ELEMENTER_271DB363_0',
 		})
 		console.log('>>> Out requested')

scratch/experiments/cli_other.js

@@ -1,4 +1,4 @@
-const request = require('request-promise-native')
+const got = require('got')
 const ws = require('ws')
 
 let webby = new ws('ws://1d8dab0e.ngrok.io/')
@@ -17,18 +17,18 @@ webby.on('open', () => {
 	)
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/take',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/take',
 			body: '/storage/shows/{66E45216-9476-4BDC-9556-C3DB487ED9DF}/elements/SUPERFLY',
 		})
 		console.log('>>> Take requested')
 	}, 500)
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/out',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/out',
 			body: '/storage/shows/{66E45216-9476-4BDC-9556-C3DB487ED9DF}/elements/SUPERFLY',
 		})
 		console.log('>>> Out requested')

scratch/experiments/cli_sm_gfx.js

@@ -1,4 +1,4 @@
-const request = require('request-promise-native')
+const got = require('got')
 const ws = require('ws')
 
 let webby = new ws('ws://1d8dab0e.ngrok.io/')
@@ -15,18 +15,18 @@ webby.on('open', () => {
 	// webby.send(`3 replace {76}/storage/shows/{66E45216-9476-4BDC-9556-C3DB487ED9DF}/elements/SUPERFLY/data {${change.length}}${change}\n\n`);
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/take',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/take',
 			body: '/storage/shows/{66E45216-9476-4BDC-9556-C3DB487ED9DF}/elements/SUPERFLY2',
 		})
 		console.log('>>> Take requested')
 	}, 500)
 
 	setTimeout(() => {
-		request.post({
+		got({
 			method: 'POST',
-			uri: 'http://62918c05.ngrok.io/profiles/MOSART/out',
+			url: 'http://62918c05.ngrok.io/profiles/MOSART/out',
 			body: '/storage/shows/{66E45216-9476-4BDC-9556-C3DB487ED9DF}/elements/SUPERFLY2',
 		})
 		console.log('>>> Out requested')

src/__tests__/msehttp.spec.ts

@@ -1,6 +1,6 @@
 import * as Koa from 'koa'
 import * as bodyParser from 'koa-bodyparser'
-import * as request from 'request-promise-native'
+import got from 'got'
 import * as http from 'http'
 import * as uuid from 'uuid'
 import { createHTTPContext, HttpMSEClient } from '../msehttp'
@@ -99,8 +99,8 @@ describe('MSE HTTP library when happy', () => {
 	})
 
 	test('Basic connection test', async () => {
-		const fromMe = await request(`http://localhost:${testPort}`)
-		expect(fromMe).toBe('Look at me')
+		const fromMe = await got(`http://localhost:${testPort}`)
+		expect(fromMe.body).toBe('Look at me')
 	})
 
 	test('Ping test', async () => {
@@ -196,7 +196,9 @@ describe('MSE HTTP library when happy', () => {
 	test('Trigger timeout', async () => {
 		msehttp.setHTTPTimeout(300)
 		expect(msehttp.timeout).toBe(300)
-		await expect(msehttp.command('timeout', '/running/out/of/time')).rejects.toThrow('ESOCKETTIMEDOUT')
+		await expect(msehttp.command('timeout', '/running/out/of/time')).rejects.toThrow(
+			"Timeout awaiting 'request' for 300ms"
+		)
 		msehttp.setHTTPTimeout(3000)
 		expect(msehttp.timeout).toBe(3000)
 	})

src/msehttp.ts

@@ -4,7 +4,7 @@
  */
 
 import { URL } from 'url'
-import * as request from 'request-promise-native'
+import got from 'got'
 import { ServerResponse } from 'http'
 
 export const uuidRe = /[a-fA-f0-9]{8}-[a-fA-f0-9]{4}-[a-fA-f0-9]{4}-[a-fA-f0-9]{4}-[a-fA-f0-9]{12}/
@@ -233,18 +233,18 @@ class MSEHTTP implements HttpMSEClient {
 	async command(path: string | URL, body: string): Promise<CommandResult> {
 		try {
 			if (typeof path === 'string') {
-				const response = await request({
+				const response = await got({
 					method: 'POST',
-					uri: `${this.baseURL}/${path}`,
+					url: `${this.baseURL}/${path}`,
 					body,
 					timeout: this.timeout,
 					headers: {
 						'Content-Type': 'text/plain',
 					},
 				})
-				return { status: 200, response: response.toString() } as CommandResult
+				return { status: 200, response: response.body.toString() } as CommandResult
 			} else {
-				const response = await request({
+				const response = await got({
 					method: 'POST',
 					url: path.toString(),
 					body,
@@ -253,7 +253,7 @@ class MSEHTTP implements HttpMSEClient {
 						'Content-Type': 'text/plain',
 					},
 				})
-				return { status: 200, response: response.toString() } as CommandResult
+				return { status: 200, response: response.body.toString() } as CommandResult
 			}
 		} catch (err) {
 			throw this.processError(err, typeof path === 'string' ? `${this.baseURL}/${path}` : path.toString(), body)
@@ -303,9 +303,9 @@ class MSEHTTP implements HttpMSEClient {
 
 	async ping(): Promise<CommandResult> {
 		try {
-			await request.get({
+			await got({
 				method: 'GET',
-				uri: this.baseURL,
+				url: this.baseURL,
 				timeout: this.timeout,
 			})
 			return { status: 200, response: 'PONG!' } as CommandResult