Deprecate trustAdditionalCAs in favour of additionalTrustedCAs

This makes the passthrough options consistent with the proxy config
options, and more consistent with option naming elsewhere.

Author: pimterry

src/rules/passthrough-handling-definitions.ts

@@ -66,6 +66,13 @@ export interface PassThroughHandlerConnectionOptions {
      * or buffer value containing the PEM certificate, or a `certPath` key and a
      * string value containing the local path to the PEM certificate.
      */
+    additionalTrustedCAs?: Array<CADefinition>;
+
+    /**
+     * Deprecated alias for `additionalTrustedCAs`
+     *
+     * @deprecated
+     */
     trustAdditionalCAs?: Array<CADefinition>;
 
     /**

src/rules/passthrough-handling.ts

@@ -103,7 +103,7 @@ export async function getTrustedCAs(
     trustedCAs: Array<string | CADefinition> | undefined,
     additionalTrustedCAs: Array<CADefinition> | undefined
 ): Promise<Array<string> | undefined> {
-    if (trustedCAs && additionalTrustedCAs) {
+    if (trustedCAs && additionalTrustedCAs?.length) {
         throw new Error(`trustedCAs and additionalTrustedCAs options are mutually exclusive`);
     }
 

src/rules/requests/request-handler-definitions.ts

@@ -34,6 +34,7 @@ import {
 } from '../../serialization/body-serialization';
 import { ProxyConfig } from '../proxy-config';
 import {
+    CADefinition,
     ForwardingOptions,
     PassThroughHandlerConnectionOptions,
     PassThroughLookupOptions
@@ -771,7 +772,7 @@ export class PassThroughHandlerDefinition extends Serializable implements Reques
         [host: string]: { pfx: Buffer, passphrase?: string }
     };
 
-    public readonly extraCACertificates: Array<{ cert: string | Buffer } | { certPath: string }> = [];
+    public readonly extraCACertificates: Array<CADefinition> = [];
 
     public readonly transformRequest?: RequestTransform;
     public readonly transformResponse?: ResponseTransform;
@@ -820,7 +821,11 @@ export class PassThroughHandlerDefinition extends Serializable implements Reques
         this.proxyConfig = options.proxyConfig;
         this.simulateConnectionErrors = !!options.simulateConnectionErrors;
 
-        this.extraCACertificates = options.trustAdditionalCAs || [];
+        this.extraCACertificates =
+            options.additionalTrustedCAs ||
+            options.trustAdditionalCAs ||
+            [];
+
         this.clientCertificateHostMap = options.clientCertificateHostMap || {};
 
         if (options.beforeRequest && options.transformRequest && !_.isEmpty(options.transformRequest)) {

src/rules/requests/request-handlers.ts

@@ -1271,7 +1271,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
             lookupOptions: data.lookupOptions,
             simulateConnectionErrors: !!data.simulateConnectionErrors,
             ignoreHostHttpsErrors: data.ignoreHostCertificateErrors,
-            trustAdditionalCAs: data.extraCACertificates,
+            additionalTrustedCAs: data.extraCACertificates,
             clientCertificateHostMap: _.mapValues(data.clientCertificateHostMap,
                 ({ pfx, passphrase }) => ({ pfx: deserializeBuffer(pfx), passphrase })
             ),

src/rules/websockets/websocket-handler-definitions.ts

@@ -16,7 +16,8 @@ import { ProxyConfig } from '../proxy-config';
 import {
     PassThroughHandlerConnectionOptions,
     ForwardingOptions,
-    PassThroughLookupOptions
+    PassThroughLookupOptions,
+    CADefinition
 } from '../passthrough-handling-definitions';
 import {
     CloseConnectionHandlerDefinition,
@@ -69,7 +70,7 @@ export class PassThroughWebSocketHandlerDefinition extends Serializable implemen
         [host: string]: { pfx: Buffer, passphrase?: string }
     };
 
-    public readonly extraCACertificates: Array<{ cert: string | Buffer } | { certPath: string }> = [];
+    public readonly extraCACertificates: Array<CADefinition> = [];
 
     constructor(options: PassThroughWebSocketHandlerOptions = {}) {
         super();
@@ -98,7 +99,10 @@ export class PassThroughWebSocketHandlerDefinition extends Serializable implemen
         this.lookupOptions = options.lookupOptions;
         this.proxyConfig = options.proxyConfig;
 
-        this.extraCACertificates = options.trustAdditionalCAs || [];
+        this.extraCACertificates =
+            options.additionalTrustedCAs ||
+            options.trustAdditionalCAs ||
+            [];
         this.clientCertificateHostMap = options.clientCertificateHostMap || {};
     }
 

test/integration/proxying/https-proxying.spec.ts

@@ -222,7 +222,7 @@ nodeOnly(() => {
                     await badServer.forAnyRequest().thenReply(200);
 
                     await server.forAnyRequest().thenPassThrough({
-                        trustAdditionalCAs: [{ cert }]
+                        additionalTrustedCAs: [{ cert }]
                     });
 
                     let response = await request.get(badServer.url, {
@@ -237,7 +237,7 @@ nodeOnly(() => {
                     await badServer.forAnyRequest().thenReply(200);
 
                     await server.forAnyRequest().thenPassThrough({
-                        trustAdditionalCAs: [{ certPath }]
+                        additionalTrustedCAs: [{ certPath }]
                     });
 
                     let response = await request.get(badServer.url, {