extra params for old/new

Author: David Blackman

src/api-diff/api-diff.ts

@@ -53,7 +53,10 @@ async function compareQuery({
   // otherwise run it against the old server
   const oldResponse = query.baselineResponse
     ? ({ data: query.baselineResponse } as AxiosResponse<unknown>)
-    : await runQuery(oldApiEnv, query, {
+    : await runQuery(oldApiEnv, {
+      ...query,
+      params: { ...query.params, ...oldApiEnv.extraParams },
+    }, {
       timeout: argv.timeout,
       retries: argv.retries,
     }).catch((e) => {
@@ -62,7 +65,10 @@ async function compareQuery({
     });
 
   const newResponse = newApiEnv
-    ? await runQuery(newApiEnv, query, {
+    ? await runQuery(newApiEnv, {
+      ...query,
+      params: { ...query.params, ...newApiEnv.extraParams },
+    }, {
       timeout: argv.timeout,
       retries: argv.retries,
     }).catch((e) => {

src/apiEnv.ts

@@ -4,6 +4,7 @@
  * both for constructing the command line flags to specify one, and for interpreting the
  * values of those command line flags into an ApiEnv object
  */
+import * as queryString from 'querystring';
 import * as _ from 'lodash';
 import yargs from 'yargs';
 import * as os from 'os';
@@ -23,6 +24,7 @@ export interface ApiEnv {
   host: string;
   keyEnv: string;
   keyType?: string;
+  extraParams?: Record<string, string>;
 }
 
 type YargsOptionMapping = Record<string, yargs.Options>;
@@ -39,6 +41,12 @@ const apiEnvCommandLineOptions: YargsOptionMapping = {
     description:
       'Authorization key, if not specified will try to find one in the env or in ~/.api-keys.env',
   },
+  extra_params: {
+    type: 'array',
+    default: [],
+    description:
+      'Extra static parameters that will be added to each query sent to this host, used for testing differences caused by slightly different query params',
+  },
 };
 
 /**
@@ -142,6 +150,9 @@ export function argvToApiEnv(
   if (argv.keyType) {
     apiEnv.keyType = argv.key_type;
   }
+  if (argv.extra_params) {
+    apiEnv.extraParams = queryString.parse(argv.extra_params.join('&')) as Record<string, string>;
+  }
 
   let aliasedHostEntry: ConfigHostEntry;
   _.forEach(config.hosts, (hostEntry: ConfigHostEntry, hostKey: string) => {