feat(client): children frames property

ulixee · Dec 10, 2021 · 28709e5 · 28709e5
1 parent 6078b95
commit 28709e5
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 7 deletions.
diff --git a/client/lib/CoreFrameEnvironment.ts b/client/lib/CoreFrameEnvironment.ts
@@ -17,12 +17,18 @@ export default class CoreFrameEnvironment {
   public frameId: number;
   public sessionId: string;
   public commandQueue: CoreCommandQueue;
+  public parentFrameId: number;
 
-  constructor(meta: ISessionMeta & { sessionName: string }, commandQueue: CoreCommandQueue) {
+  constructor(
+    meta: ISessionMeta & { sessionName: string },
+    parentFrameId: number,
+    commandQueue: CoreCommandQueue,
+  ) {
     const { tabId, sessionId, frameId, sessionName } = meta;
     this.tabId = tabId;
     this.sessionId = sessionId;
     this.frameId = frameId;
+    this.parentFrameId = parentFrameId;
     const queueMeta = {
       sessionId,
       tabId,

diff --git a/client/lib/CoreTab.ts b/client/lib/CoreTab.ts
@@ -49,10 +49,18 @@ export default class CoreTab implements IJsPathEventTarget {
       sessionName,
     };
     this.connection = connection;
-    this.commandQueue = new CoreCommandQueue(this.meta, coreSession.mode, connection, coreSession as ICommandCounter);
+    this.commandQueue = new CoreCommandQueue(
+      this.meta,
+      coreSession.mode,
+      connection,
+      coreSession as ICommandCounter,
+    );
     this.coreSession = coreSession;
     this.eventHeap = new CoreEventHeap(this.meta, connection, coreSession as ICommandCounter);
-    this.frameEnvironmentsById.set(frameId, new CoreFrameEnvironment(meta, this.commandQueue));
+    this.frameEnvironmentsById.set(
+      frameId,
+      new CoreFrameEnvironment(meta, null, this.commandQueue),
+    );
 
     const resolvedThis = Promise.resolve(this);
     this.eventHeap.registerEventInterceptors({
@@ -75,7 +83,7 @@ export default class CoreTab implements IJsPathEventTarget {
       meta.frameId = frameMeta.id;
       this.frameEnvironmentsById.set(
         frameMeta.id,
-        new CoreFrameEnvironment(meta, this.commandQueue),
+        new CoreFrameEnvironment(meta, frameMeta.parentFrameId, this.commandQueue),
       );
     }
     return this.frameEnvironmentsById.get(frameMeta.id);

diff --git a/client/lib/FrameEnvironment.ts b/client/lib/FrameEnvironment.ts
@@ -99,6 +99,21 @@ export default class FrameEnvironment {
     return getCoreFrameEnvironment(this).then(x => x.frameId);
   }
 
+  public get children(): Promise<FrameEnvironment[]> {
+    return getState(this).tab.frameEnvironments.then(async frames => {
+      const frameId = await this.frameId;
+
+      const childFrames: FrameEnvironment[] = [];
+      for (const frame of frames) {
+        const parentFrameId = await frame.parentFrameId;
+        if (parentFrameId === frameId) {
+          childFrames.push(frame);
+        }
+      }
+      return childFrames;
+    });
+  }
+
   public get url(): Promise<string> {
     return getCoreFrameEnvironment(this).then(x => x.getUrl());
   }
@@ -122,9 +137,7 @@ export default class FrameEnvironment {
   }
 
   public get parentFrameId(): Promise<number | null> {
-    return getCoreFrameEnvironment(this)
-      .then(x => x.getFrameMeta())
-      .then(x => x.parentFrameId);
+    return getCoreFrameEnvironment(this).then(x => x.parentFrameId);
   }
 
   public get cookieStorage(): CookieStorage {

diff --git a/docs/main/BasicInterfaces/FrameEnvironment.md b/docs/main/BasicInterfaces/FrameEnvironment.md
@@ -8,6 +8,12 @@ Frames cannot be constructed in Hero. They're made available through the [tab.fr
 
 ## Properties
 
+### frameEnvironment.children {#child-frames}
+
+Returns child FrameEnvironments for this frame.
+
+#### **Type**: Promise<[`FrameEnvironment`](/docs/basic-interfaces/tab#frame-environments)[]>
+
 ### frameEnvironment.cookieStorage {#cookie-storage}
 
 Returns a [CookieStorage](/docs/advanced/cookie-storage) instance to get/set/delete cookies.