feat: support header overrides in EndpointClient

Author: rossiam

src/endpoint-client.ts

@@ -54,6 +54,12 @@ export interface ItemsList {
 	}
 }
 
+export interface EndpointClientRequestOptions <T> {
+	headerOverrides?: HttpClientHeaders
+	dryRun?: boolean
+	dryRunReturnValue?: T
+}
+
 export class EndpointClient {
 	private logger: Logger
 
@@ -90,7 +96,7 @@ export class EndpointClient {
 
 	/* eslint-disable @typescript-eslint/no-explicit-any */
 	public async request<T = any, R = AxiosResponse<T>>(method: HttpClientMethod, path?: string,
-			data?: any, params?: HttpClientParams): Promise<T> {
+			data?: any, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
 		const headers: HttpClientHeaders = this.config.headers ? { ...this.config.headers } : {}
 
 		if (this.config.loggingId) {
@@ -111,7 +117,7 @@ export class EndpointClient {
 		let axiosConfig: AxiosRequestConfig = {
 			url: this.url(path),
 			method,
-			headers,
+			headers: options?.headerOverrides ? { ...headers, ...options.headerOverrides } : headers,
 			params,
 			data,
 			paramsSerializer: params => qs.stringify(params, { indices: false }),
@@ -122,6 +128,12 @@ export class EndpointClient {
 		if (this.logger.isDebugEnabled()) {
 			this.logger.debug(`making axios request: ${JSON.stringify(axiosConfig)}`)
 		}
+		if (options?.dryRun) {
+			if (options.dryRunReturnValue) {
+				return options.dryRunReturnValue
+			}
+			throw new Error('skipping request; dry run mode')
+		}
 		let response
 		try {
 			response = await axios.request(axiosConfig)

test/unit/endpoint-client.test.ts

@@ -60,6 +60,28 @@ describe('Endpoint Client',  () => {
 		axios.request.mockReset()
 	})
 
+	it('request with header overrides', async () => {
+		axios.request.mockImplementationOnce(() => Promise.resolve({ status: 200, data: { status: 'ok' } }))
+		const headerOverrides = { 'Content-Type': 'overridden content type'}
+		const response = await client.request('POST', 'mypath', { name: 'Bob' }, undefined, { headerOverrides })
+		expect(axios.request).toHaveBeenCalledTimes(1)
+		expect(axios.request).toHaveBeenCalledWith({
+			'url': 'https://api.smartthings.com/basepath/mypath',
+			'method': 'POST',
+			'headers': {
+				'Content-Type': 'overridden content type',
+				'Accept': 'application/json',
+				'Authorization': 'Bearer asdfghjkl',
+				'X-ST-CORRELATION': 'AAABBBCCC',
+			},
+			'data': { name: 'Bob' },
+			'params': undefined,
+			'paramsSerializer': expect.anything(),
+		})
+		expect(response.status).toBe('ok')
+		axios.request.mockReset()
+	})
+
 	it('get', async () => {
 		axios.request.mockImplementationOnce(() => Promise.resolve({ status: 200, data: { status: 'ok' } }))
 		const response = await client.get('path2')