663/mk/standardize op client requests

packages/open-payments/src/client/requests.test.ts

@@ -2,7 +2,11 @@
 import { createAxiosInstance, deleteRequest, get, post } from './requests'
 import { generateKeyPairSync } from 'crypto'
 import nock from 'nock'
-import { mockOpenApiResponseValidators, silentLogger } from '../test/helpers'
+import {
+  mockOpenApiResponseValidators,
+  silentLogger,
+  withEnvVariableOverride
+} from '../test/helpers'
 
 describe('requests', (): void => {
   const logger = silentLogger
@@ -194,6 +198,51 @@ describe('requests', (): void => {
         )
       ).rejects.toThrow(/Failed to validate OpenApi response/)
     })
+
+    test(
+      'keeps https protocol for request if non-development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'production' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const scope = nock(httpsUrl).get('/').reply(200)
+
+          await get(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.get).toHaveBeenCalledWith(httpsUrl, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
+
+    test(
+      'uses http protocol for request if development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'development' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const httpUrl = httpsUrl.replace('https', 'http')
+          const scope = nock(httpUrl).get('/').reply(200)
+
+          await get(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.get).toHaveBeenCalledWith(httpUrl, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
   })
 
   describe('post', (): void => {
@@ -364,6 +413,51 @@ describe('requests', (): void => {
         )
       ).rejects.toThrow(/Failed to validate OpenApi response/)
     })
+
+    test(
+      'keeps https protocol for request if non-development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'production' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const scope = nock(httpsUrl).post('/').reply(200)
+
+          await post(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.post).toHaveBeenCalledWith(httpsUrl, undefined, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
+
+    test(
+      'uses http protocol for request if development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'development' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const httpUrl = httpsUrl.replace('https', 'http')
+          const scope = nock(httpUrl).post('/').reply(200)
+
+          await post(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.post).toHaveBeenCalledWith(httpUrl, undefined, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
   })
 
   describe('delete', (): void => {
@@ -501,5 +595,50 @@ describe('requests', (): void => {
         )
       ).rejects.toThrow(/Failed to validate OpenApi response/)
     })
+
+    test(
+      'keeps https protocol for request if non-development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'production' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const scope = nock(httpsUrl).delete('/').reply(200)
+
+          await deleteRequest(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.delete).toHaveBeenCalledWith(httpsUrl, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
+
+    test(
+      'uses http protocol for request if development environment',
+      withEnvVariableOverride(
+        { NODE_ENV: 'development' },
+        async (): Promise<void> => {
+          const httpsUrl = 'https://localhost:1000/'
+          const httpUrl = httpsUrl.replace('https', 'http')
+          const scope = nock(httpUrl).delete('/').reply(200)
+
+          await deleteRequest(
+            { axiosInstance, logger },
+            { url: httpsUrl },
+            responseValidators.successfulValidator
+          )
+
+          expect(axiosInstance.delete).toHaveBeenCalledWith(httpUrl, {
+            headers: {}
+          })
+          scope.done()
+        }
+      )
+    )
   })
 })

packages/open-payments/src/test/helpers.ts

@@ -31,6 +31,23 @@ export const defaultAxiosInstance = createAxiosInstance({
   privateKey: generateKeyPairSync('ed25519').privateKey
 })
 
+export const withEnvVariableOverride = (
+  override: Record<string, string>,
+  testCallback: () => Promise<void>
+): (() => Promise<void>) => {
+  return async () => {
+    const savedEnvVars = Object.assign({}, process.env)
+
+    for (const key in override) {
+      process.env[key] = override[key]
+    }
+
+    await testCallback()
+
+    process.env = savedEnvVars
+  }
+}
+
 export const mockOpenApiResponseValidators = () => ({
   successfulValidator: ((data: unknown): data is unknown =>
     // eslint-disable-next-line @typescript-eslint/no-explicit-any