feat(Instagram): adds browserInstance option

Author: goooseman

src/api/api.ts

@@ -1,4 +1,5 @@
 import {Type} from "io-ts";
+import {Browser} from "puppeteer";
 import * as winston from "winston";
 import {DType, IPlugin} from "../../plugins";
 import {Instagram} from "./instagram";
@@ -59,6 +60,10 @@ export interface IOptionsCommon {
 
     // Custom io-ts validator
     validator?: Type<unknown>;
+
+    // Pass puppeter Browser instance from outside.
+    // Be careful to close Browser by yourself, when there is no need in it anymore.
+    browserInstance?: Browser;
 }
 
 export interface IOptionsFullApi extends IOptionsCommon {

src/api/instagram.ts

@@ -107,6 +107,8 @@ export class Instagram<PostType> {
     // Puppeteer state
     private browser: Browser;
     private browserDisconnected: boolean = true;
+    /** Browser instance passed from outside */
+    private readonly browserInstance?: Browser;
     private readonly headless: boolean;
 
     // Array of scraped posts and lock
@@ -207,6 +209,7 @@ export class Instagram<PostType> {
         this.total = options.total;
         this.pageQuery = pageQuery;
         this.edgeQuery = edgeQuery;
+        this.browserInstance = options.browserInstance;
         this.headless = options.headless;
         this.logger = options.logger;
         this.silent = options.silent;
@@ -357,7 +360,11 @@ export class Instagram<PostType> {
             await this.page.close();
         }
 
-        if (this.finished && !this.browserDisconnected) {
+        if (
+            this.finished &&
+            !this.browserDisconnected &&
+            !this.browserInstance
+        ) {
             await this.browser.close();
         }
     }
@@ -705,7 +712,15 @@ export class Instagram<PostType> {
         }
 
         // Launch browser
-        if (!this.sameBrowser || (this.sameBrowser && !this.started)) {
+        if (this.browserInstance) {
+            await this.progress(Progress.LAUNCHING);
+            this.browser = this.browserInstance;
+            this.browserDisconnected = !this.browser.isConnected();
+            this.browser.on(
+                "disconnected",
+                () => (this.browserDisconnected = true),
+            );
+        } else if (!this.sameBrowser || (this.sameBrowser && !this.started)) {
             await this.progress(Progress.LAUNCHING);
             this.browser = await launch(options);
             this.browserDisconnected = false;

tests/test.spec.ts

@@ -1,5 +1,5 @@
 import * as t from "io-ts";
-import {Overrides, Request} from "puppeteer";
+import {launch, Overrides, Request} from "puppeteer";
 import * as winston from "winston";
 import {createApi, IPlugin} from "..";
 import {plugins} from "..";
@@ -626,3 +626,36 @@ describe("Plugins", () => {
         }
     });
 });
+
+describe("Browser instance passed from outside", () => {
+    const browserOptions = {
+        headless: true,
+    };
+    testWrapper("Should re-use this browser instance", async () => {
+        const browser = await launch(browserOptions);
+
+        const hashtagGenerator = createApi("hashtag", hashtags[0], {
+            browserInstance: browser,
+        }).generator();
+        await hashtagGenerator.next();
+
+        const pages = await browser.pages();
+
+        expect(pages.length).toBe(2);
+
+        await browser.close();
+    });
+
+    testWrapper("Should not close browser instance", async () => {
+        const browser = await launch(browserOptions);
+
+        const searchGenerator = createApi("search", "therock", {
+            browserInstance: browser,
+        }).generator();
+        await searchGenerator.next();
+
+        expect(browser.isConnected()).toBe(true);
+
+        await browser.close();
+    });
+});