Add geo location support (#17)

Author: azhong-git

README.md

@@ -26,7 +26,7 @@ npm install @lightfeed/browser-agent
 
 ### Serverless
 
-Perfect for AWS Lambda and other serverless environments. Uses [@sparticuz/chromium](https://github.com/Sparticuz/chromium) to run Chrome in serverless environments with minimal cold start times and memory usage.
+Perfect for AWS Lambda and other serverless environments. Uses [@sparticuz/chromium](https://github.com/Sparticuz/chromium) to run Chrome in serverless environments with minimal cold start times and memory usage. Supports proxy configuration for geo-tracking and unblocking.
 
 > [!IMPORTANT]
 > This project uses Playwright, which ships with a specific version of Chromium. You need to install the matching version of `@sparticuz/chromium`. For example, we are using [Playwright 1.52](https://playwright.dev/docs/release-notes#version-152) (which supports to Chromium 136), you should install `@sparticuz/chromium@136`.

scripts/test-geolocation-local.ts

@@ -0,0 +1,32 @@
+import { BrowserAgent } from "../src/agent";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const agent = new BrowserAgent({
+  browserProvider: "Local",
+  debug: true,
+  localConfig: {
+    proxy: {
+      host: process.env.PROXY_HOST,
+      port: parseInt(process.env.PROXY_PORT!),
+      auth: {
+        username: process.env.PROXY_USERNAME,
+        password: process.env.PROXY_PASSWORD,
+      },
+    },
+  },
+});
+
+(async () => {
+  const page = await agent.newPage();
+  await page.goto(
+    "https://geo.brdtest.com/welcome.txt?product=resi&method=native"
+  );
+  try {
+    await page.waitForLoadState("networkidle", { timeout: 10000 });
+  } catch {
+    console.log("Network idle timeout, continuing...");
+  }
+  page.ai("Discard warning and click the button to continue", { maxSteps: 2 });
+})();

scripts/test-geolocation-remote.ts

@@ -0,0 +1,35 @@
+import { BrowserAgent } from "../src/agent";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const agent = new BrowserAgent({
+  browserProvider: "Remote",
+  remoteConfig: {
+    wsEndpoint: process.env.REMOTE_BROWSER_WS_ENDPOINT,
+  },
+  debug: true,
+});
+
+(async () => {
+  const page = await agent.newPage();
+  // White Rock, BC
+  const lat = 49.019917;
+  const lon = -122.802612;
+  const client = await page.context().newCDPSession(page);
+  await client.send("Proxy.setLocation", {
+    lat,
+    lon,
+    distance: 50,
+    strict: true,
+  });
+  await page.goto(
+    "https://geo.brdtest.com/welcome.txt?product=resi&method=native"
+  );
+  try {
+    await page.waitForLoadState("networkidle", { timeout: 10000 });
+  } catch {
+    console.log("Network idle timeout, continuing...");
+  }
+  page.ai("Discard warning and click the button to continue", { maxSteps: 2 });
+})();

src/agent/index.ts

@@ -81,7 +81,7 @@ export class BrowserAgent<T extends BrowserProviders = "Local"> {
         ? new ServerlessBrowserProvider(params.serverlessConfig!)
         : this.browserProviderType === "Remote"
           ? new RemoteBrowserProvider(params.remoteConfig!)
-          : new LocalBrowserProvider(params.localConfig)
+          : new LocalBrowserProvider(params.localConfig ?? {})
     ) as T extends "Serverless"
       ? ServerlessBrowserProvider
       : T extends "Remote"

src/browser-providers/local.ts

@@ -1,12 +1,19 @@
 import { chromium, Browser, LaunchOptions } from "playwright";
 import BrowserProvider from "@/types/browser-providers/types";
+import { AxiosProxyConfig } from "axios";
 
 export class LocalBrowserProvider extends BrowserProvider<Browser> {
   options: Omit<Omit<LaunchOptions, "headless">, "channel"> | undefined;
   session: Browser | undefined;
-  constructor(options?: Omit<Omit<LaunchOptions, "headless">, "channel">) {
+  proxy: AxiosProxyConfig | null;
+
+  constructor(params: {
+    options?: Omit<Omit<LaunchOptions, "headless">, "channel">;
+    proxy?: AxiosProxyConfig;
+  }) {
     super();
-    this.options = options;
+    this.options = params.options;
+    this.proxy = params.proxy ?? null;
   }
   async start(): Promise<Browser> {
     const launchArgs = this.options?.args ?? [];
@@ -15,6 +22,15 @@ export class LocalBrowserProvider extends BrowserProvider<Browser> {
       channel: "chrome",
       headless: false,
       args: ["--disable-blink-features=AutomationControlled", ...launchArgs],
+      ...(this.proxy == null
+        ? {}
+        : {
+            proxy: {
+              server: `http://${this.proxy.host}:${this.proxy.port}`,
+              username: this.proxy.auth?.username,
+              password: this.proxy.auth?.password,
+            },
+          }),
     });
     this.session = browser;
     return this.session;