refactor: add parentSession() to CDPSession

puppeteer · Aug 8, 2023 · 364d304 · 364d304
1 parent 2dec12f
commit 364d304
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 3 deletions.
diff --git a/packages/puppeteer-core/src/common/Connection.ts b/packages/puppeteer-core/src/common/Connection.ts
@@ -307,14 +307,15 @@ export class Connection extends EventEmitter {
     const object = JSON.parse(message);
     if (object.method === 'Target.attachedToTarget') {
       const sessionId = object.params.sessionId;
+      const parentSession = this.#sessions.get(object.sessionId);
       const session = new CDPSessionImpl(
         this,
         object.params.targetInfo.type,
-        sessionId
+        sessionId,
+        parentSession
       );
       this.#sessions.set(sessionId, session);
       this.emit('sessionattached', session);
-      const parentSession = this.#sessions.get(object.sessionId);
       if (parentSession) {
         parentSession.emit('sessionattached', session);
       }
@@ -470,6 +471,15 @@ export class CDPSession extends EventEmitter {
     throw new Error('Not implemented');
   }
 
+  /**
+   * Parent session in terms of CDP's auto-attach mechanism.
+   *
+   * @internal
+   */
+  parentSession(): CDPSession | undefined {
+    return undefined;
+  }
+
   send<T extends keyof ProtocolMapping.Commands>(
     method: T,
     ...paramArgs: ProtocolMapping.Commands[T]['paramsType']
@@ -504,21 +514,32 @@ export class CDPSessionImpl extends CDPSession {
   #targetType: string;
   #callbacks = new CallbackRegistry();
   #connection?: Connection;
+  #parentSession?: CDPSessionImpl;
 
   /**
    * @internal
    */
-  constructor(connection: Connection, targetType: string, sessionId: string) {
+  constructor(
+    connection: Connection,
+    targetType: string,
+    sessionId: string,
+    parentSession: CDPSessionImpl | undefined
+  ) {
     super();
     this.#connection = connection;
     this.#targetType = targetType;
     this.#sessionId = sessionId;
+    this.#parentSession = parentSession;
   }
 
   override connection(): Connection | undefined {
     return this.#connection;
   }
 
+  override parentSession(): CDPSessionImpl | undefined {
+    return this.#parentSession;
+  }
+
   override send<T extends keyof ProtocolMapping.Commands>(
     method: T,
     ...paramArgs: ProtocolMapping.Commands[T]['paramsType']

diff --git a/packages/puppeteer-core/src/common/DeviceRequestPrompt.test.ts b/packages/puppeteer-core/src/common/DeviceRequestPrompt.test.ts
@@ -36,6 +36,9 @@ class MockCDPSession extends EventEmitter {
   id() {
     return '1';
   }
+  parentSession() {
+    return undefined;
+  }
 }
 
 describe('DeviceRequestPrompt', function () {

diff --git a/packages/puppeteer-core/src/common/NetworkManager.test.ts b/packages/puppeteer-core/src/common/NetworkManager.test.ts
@@ -37,6 +37,9 @@ class MockCDPSession extends EventEmitter {
   id() {
     return '1';
   }
+  parentSession() {
+    return undefined;
+  }
 }
 
 describe('NetworkManager', () => {

diff --git a/test/src/CDPSession.spec.ts b/test/src/CDPSession.spec.ts
@@ -38,6 +38,12 @@ describe('Target.createCDPSession', function () {
     expect(foo).toBe('bar');
   });
 
+  it('should return parent session', async () => {
+    const {page} = await getTestState();
+    const client = await page.createCDPSession();
+    expect(client.parentSession).toBeDefined();
+  });
+
   it('should not report created targets for custom CDP sessions', async () => {
     const {browser} = await getTestState();
     let called = 0;