fix(mitm): bubble proxy errors properly to client

chore(all): eslint rule to disallow async without await
fix for #98

Author: blakebyrnes

.eslintrc.js

@@ -49,7 +49,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['*client/**/*.ts', '*interfaces/**/*.ts', 'commons/**/*.ts'],
+      files: ['*client/**/*.ts', '*interfaces/**/*.ts', 'commons/**/*.ts', 'mitm*/**/*.ts'],
       rules: {
         '@typescript-eslint/explicit-function-return-type': [
           'error',
@@ -63,6 +63,12 @@ module.exports = {
         'no-console': 'off',
       },
     },
+    {
+      files: 'emulate-browsers/**/*.ts',
+      rules: {
+        'require-await': 'off', // Turn off while waiting
+      },
+    },
     {
       files: [
         '**/injected-scripts/**/*.js',
@@ -75,6 +81,7 @@ module.exports = {
         'prefer-rest-params': 'off',
         'max-classes-per-file': 'off',
         'func-names': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
       },
     },
     {
@@ -91,6 +98,7 @@ module.exports = {
       rules: {
         'promise/valid-params': 'off',
         '@typescript-eslint/explicit-function-return-type': 'off',
+        'require-await': 'off',
       },
     },
     {
@@ -164,6 +172,8 @@ module.exports = {
     'class-methods-use-this': 'off',
     'consistent-return': ['off', { treatUndefinedAsUnspecified: true }],
     'spaced-comment': ['error', 'always', { markers: ['/////'] }],
+    'require-await': 'error',
+    'jest/no-conditional-expect': 'off',
     '@typescript-eslint/no-implied-eval': 'off', // false positives for setTimeout with bind fn
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
@@ -174,6 +184,10 @@ module.exports = {
     '@typescript-eslint/no-empty-interface': 'off',
     '@typescript-eslint/no-namespace': 'off',
     '@typescript-eslint/ordered-imports': 'off',
+    '@typescript-eslint/no-shadow': [
+      'error',
+      { ignoreTypeValueShadow: true, ignoreFunctionTypeParameterNameValueShadow: true },
+    ],
     '@typescript-eslint/object-literal-shorthand': 'off',
     '@typescript-eslint/object-shorthand-properties-first': 'off',
     '@typescript-eslint/no-var-requires': 'off',

client/index.ts

@@ -216,7 +216,7 @@ export function SecretAgentClientGenerator(
 
     /////// METHODS THAT DELEGATE TO ACTIVE TAB //////////////////////////////////////////////////////////////////////////
 
-    public async goto(href: string): Promise<Resource> {
+    public goto(href: string): Promise<Resource> {
       return this.activeTab.goto(href);
     }
 

client/lib/CoreCommandQueue.ts

@@ -21,7 +21,7 @@ export default class CoreCommandQueue {
     }
   }
 
-  public async run<T>(command: string, ...args: any[]): Promise<T> {
+  public run<T>(command: string, ...args: any[]): Promise<T> {
     const { resolve, reject, promise } = createPromise<T>();
     this.items.push({
       resolve,

client/lib/CoreTab.ts

@@ -51,7 +51,7 @@ export default class CoreTab {
     }
   }
 
-  public async getResourceProperty<T = any>(id: number, propertyPath: string): Promise<T> {
+  public getResourceProperty<T = any>(id: number, propertyPath: string): Promise<T> {
     return this.commandQueue.run('getResourceProperty', id, propertyPath);
   }
 

client/lib/Request.ts

@@ -16,6 +16,7 @@ const { getState, setState } = StateMachine<FetchRequest, IState>();
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export default function RequestGenerator(coreTab: Promise<CoreTab>) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   return class Request extends FetchRequest {
     constructor(input: IRequestInfo, init?: IRequestInit) {
       super(input, init);

client/lib/SetupAwaitedHandler.ts

@@ -87,7 +87,7 @@ export function construct<TClass>(self: AwaitedHandler<TClass>): TClass {
   throw new NotImplementedError(`${self.className} constructor not implemented`);
 }
 
-async function execJsPath<TClass, T>(
+function execJsPath<TClass, T>(
   self: AwaitedHandler<TClass>,
   coreTab: CoreTab,
   instance: TClass,

client/lib/Tab.ts

@@ -141,7 +141,7 @@ export default class Tab extends AwaitedEventTarget<IEventType, IState> {
     await coreTab.waitForLoad(status);
   }
 
-  public async waitForResource(
+  public waitForResource(
     filter: IWaitForResourceFilter,
     options?: IWaitForResourceOptions,
   ): Promise<(Resource | WebsocketResource)[]> {
@@ -172,15 +172,15 @@ export default class Tab extends AwaitedEventTarget<IEventType, IState> {
     await coreTab.waitForWebSocket(url);
   }
 
-  public async focus(): Promise<void> {
+  public focus(): Promise<void> {
     const { secretAgent, coreTab } = getState(this);
     agentState.setState(secretAgent, {
       activeTab: this,
     });
     return coreTab.then(x => x.focusTab());
   }
 
-  public async close(): Promise<void> {
+  public close(): Promise<void> {
     const { secretAgent, coreTab } = getState(this);
     const { tabs } = agentState.getState(secretAgent);
     const updatedTabs = tabs.filter(x => x !== this);

commons/decodeBuffer.ts

@@ -1,9 +1,9 @@
 import zlib from 'zlib';
 import { createPromise } from './utils';
 
-export default async function decodeBuffer(buffer: Buffer, encoding: string): Promise<Buffer> {
+export default function decodeBuffer(buffer: Buffer, encoding: string): Promise<Buffer> {
   if (!buffer) return null;
-  if (!encoding) return buffer;
+  if (!encoding) return Promise.resolve(buffer);
 
   const promise = createPromise<Buffer>();
   const handler = (error, result): void => {

commons/eventUtils.ts

@@ -86,7 +86,7 @@ export class TypedEventEmitter<T> extends EventEmitter implements ITypedEventEmi
     this.eventsToLog = new Set<string | symbol>(events);
   }
 
-  public async waitOn<K extends keyof T & (string | symbol)>(
+  public waitOn<K extends keyof T & (string | symbol)>(
     eventType: K,
     listenerFn?: (this: this, event?: T[K]) => boolean,
     timeoutMillis = 30e3,

core-interfaces/INetworkInterceptorDelegate.ts

@@ -11,6 +11,7 @@ export default interface INetworkInterceptorDelegate {
   };
   dns?: {
     dnsOverTlsConnection: ConnectionOptions;
+    useUpstreamProxy?: boolean;
   };
   connections?: {
     socketsPerOrigin: number;