feat(emulators): drive devtools from emulator

Author: blakebyrnes

commons/test/TypeSerializer.test.ts

@@ -41,9 +41,11 @@ test('should be able to serialize and deserialize in a browser window', async ()
     await puppet.start();
     const context = await puppet.newContext(
       {
-        userAgent: 'Page tests',
-        proxyPassword: '',
-        viewport: { width: 1920, height: 800 } as any,
+        userAgentString: 'Page tests',
+        configuration: {},
+        async onNewPuppetPage(): Promise<any> {
+          return null;
+        },
       } as any,
       log,
     );

core-interfaces/IBrowserEmulator.ts

@@ -1,21 +1,20 @@
-import { IPuppetWorker } from '@secret-agent/puppet-interfaces/IPuppetWorker';
+import { IPuppetPage } from '@secret-agent/core-interfaces/IPuppetPage';
+import { IPuppetWorker } from '@secret-agent/core-interfaces/IPuppetWorker';
 import INetworkEmulation from './INetworkEmulation';
-import IUserProfile from './IUserProfile';
-import INewDocumentInjectedScript from './INewDocumentInjectedScript';
 import IWindowFraming from './IWindowFraming';
+import IBrowserEmulatorConfiguration from './IBrowserEmulatorConfiguration';
 
 export default interface IBrowserEmulator extends INetworkEmulation {
   readonly userAgentString: string;
   readonly osPlatform: string;
   readonly canPolyfill: boolean;
   readonly windowFramingBase?: IWindowFraming;
   readonly windowFraming?: IWindowFraming;
-  locale: string;
-  userProfile: IUserProfile;
-  sessionId?: string;
+  configuration: IBrowserEmulatorConfiguration;
+  sessionId: string;
 
-  newDocumentInjectedScripts(): Promise<INewDocumentInjectedScript[]>;
-  newWorkerInjectedScripts(
-    workerType: IPuppetWorker['type'],
-  ): Promise<INewDocumentInjectedScript[]>;
+  configure(options: IBrowserEmulatorConfiguration): Promise<void>;
+
+  onNewPuppetPage(page: IPuppetPage): Promise<any>;
+  onNewPuppetWorker?(worker: IPuppetWorker): Promise<any>;
 }

core-interfaces/IBrowserEmulatorClass.ts

@@ -1,12 +1,13 @@
 import IBrowserEmulator from './IBrowserEmulator';
 import IBrowserEngine from './IBrowserEngine';
 import IUserAgentMatchMeta from './IUserAgentMatchMeta';
+import IBrowserEmulatorConfiguration from './IBrowserEmulatorConfiguration';
 
 export default interface IBrowserEmulatorClass {
   id: string;
   roundRobinPercent: number;
   engine: IBrowserEngine;
-  new (matchMeta?: IUserAgentMatchMeta): IBrowserEmulator;
+  new (options: IBrowserEmulatorConfiguration, matchMeta?: IUserAgentMatchMeta): IBrowserEmulator;
   isMatch: (matchMeta: IUserAgentMatchMeta) => boolean;
 }
 

core-interfaces/IBrowserEmulatorConfiguration.ts

@@ -0,0 +1,9 @@
+import IUserProfile from './IUserProfile';
+import IViewport from './IViewport';
+
+export default interface IBrowserEmulatorConfiguration {
+  userProfile?: IUserProfile;
+  viewport?: IViewport;
+  timezoneId?: string;
+  locale?: string;
+}

core-interfaces/IBrowserEmulatorHooks.ts

@@ -0,0 +1,15 @@
+import ITypedEventEmitter from './ITypedEventEmitter';
+
+export default interface IConnectionTransport
+  extends ITypedEventEmitter<IConnectionTransportEvents> {
+  url?: string;
+  send(body: string);
+  close();
+  clone(): IConnectionTransport;
+  waitForOpen: Promise<void>;
+}
+
+export interface IConnectionTransportEvents {
+  close: void;
+  message: string;
+}

core-interfaces/IConnectionTransport.ts

@@ -6,8 +6,8 @@ import IViewport from './IViewport';
 export default interface ICreateSessionOptions extends ISessionOptions {
   sessionName?: string;
   browserEmulatorId?: string;
-  userProfile?: IUserProfile;
   scriptInstanceMeta?: IScriptInstanceMeta;
+  userProfile?: IUserProfile;
   viewport?: IViewport;
   timezoneId?: string;
   locale?: string;

core-interfaces/ICreateSessionOptions.ts

@@ -0,0 +1,25 @@
+import { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping';
+
+export default interface IDevtoolsSession {
+  id: string;
+  send<T extends keyof ProtocolMapping.Commands>(
+    method: T,
+    params: ProtocolMapping.Commands[T]['paramsType'][0],
+    sendInitiator?: object,
+  ): Promise<ProtocolMapping.Commands[T]['returnType']>;
+
+  onMessage(object: IDevtoolsResponseMessage & IDevtoolsEventMessage): void;
+}
+
+export interface IDevtoolsResponseMessage {
+  sessionId: string;
+  id: number;
+  error?: { message: string; data: any };
+  result?: any;
+}
+
+export interface IDevtoolsEventMessage {
+  sessionId: string;
+  method: string;
+  params: object;
+}