nstbrowser-sdk-node/examples/v2/cdpEndpoints/connectOnceBrowser.js

nst browser node sdk

/**
 * Example demonstrating how to connect to a once-off browser using Chrome DevTools Protocol
 * and control it using puppeteer-core.
 */

import { NstBrowserV2 } from 'nstbrowser-sdk-node';

import puppeteer from 'puppeteer-core'

async function getCdpWebsocketUrl() {
  const apiKey = process.env.NSTBROWSER_API_KEY || 'your_api_key';
  const config = {
    name: 'testProfile',
    platform: 'Windows',
    kernelMilestone: '132',
    autoClose: false,
    timedCloseSec: 30,
    headless: false,
    incognito: false,
    // proxy: 'http://admin:123456@127.0.0.1:8000',
    skipProxyChecking: true,
    fingerprint: {
      flags: {
        audio: 'Noise',
        battery: 'Masked',
        canvas: 'Noise',
        clientRect: 'Noise',
        fonts: 'Masked',
        geolocation: 'Custom',
        geolocationPopup: 'Prompt',
        gpu: 'Allow',
        localization: 'Custom',
        screen: 'Custom',
        speech: 'Masked',
        timezone: 'Custom',
        webgl: 'Noise',
        webrtc: 'Custom',
      },
      userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.45 Safari/537.36',
      deviceMemory: 8,
      hardwareConcurrency: 16,
      disableImageLoading: true,
      doNotTrack: true,
      localization: {
        language: 'zh-HK',
        languages: ['zh-HK', 'en-US', 'en'],
        timezone: 'Asia/Hong_Kong',
      },
      screen: { width: 1280, height: 1024 },
      geolocation: {
        latitude: '31.2333',
        longitude: '121.469',
        accuracy: '603',
      },
      webrtc: { publicIp: '111.111.111.111' },
    },
    startupUrls: ['https://www.nstbrowser.io'],
    args: {
      '--remote-debugging-port': 34543,
      'disable-backgrounding-occluded-windows': true,
    },
  };

  try {
    // Initialize the client
    const client = new NstBrowserV2(apiKey);
    console.log('Initialized NstBrowserV2, connecting to once-off browser');

    // Connect to the browser
    const response = await client.cdpEndpoints().connectOnceBrowser(config);
    console.log('Successfully connected to once-off browser');

    // Extract WebSocket endpoint if available
    if (response?.data?.webSocketDebuggerUrl) {
      const wsEndpoint = response.data.webSocketDebuggerUrl;
      console.log(`WebSocket endpoint: ${wsEndpoint}`);
      return wsEndpoint;
    } else {
      console.log('WebSocket endpoint not found in response');
      if (response?.data) {
        console.log(`Available data keys: ${Object.keys(response.data)}`);
      }
      return null;
    }
  } catch (error) {
    console.error('Failed to connect to once-off browser:', error);
    return null;
  }
}

async function controlBrowserWithPuppeteer(websocketUrl) {
  try {
    console.log('\nConnecting to browser with puppeteer-core...');
    const browser = await puppeteer.connect({
      browserWSEndpoint: websocketUrl,
      defaultViewport: null,
    });

    // Get the default page or create a new one
    const pages = await browser.pages();
    const page = pages[0] || await browser.newPage();

    console.log('Navigating to example.com...');
    await page.goto('https://example.com');

    const title = await page.title();
    console.log(`Page title: ${title}`);

    console.log('Taking screenshot...');
    await page.screenshot({ path: 'example_screenshot.png' });
    console.log('Screenshot saved to example_screenshot.png');

    const content = await page.$eval('h1', (el) => el.textContent);
    console.log(`H1 content: ${content}`);

    console.log('Waiting for 3 seconds...');
    await new Promise(resolve => setTimeout(resolve, 3000));

    // Close the connection
    await page.close();
    await browser.disconnect();
    console.log('Puppeteer connection closed');
  } catch (error) {
    if (error.code === 'MODULE_NOT_FOUND') {
      console.log('puppeteer-core is not installed. Please install it with: npm install puppeteer-core');
    } else {
      console.error('Error during Puppeteer automation:', error);
    }
  }
}

async function main() {
  // Step 1: Get the CDP WebSocket URL
  const websocketUrl = await getCdpWebsocketUrl();

  // Step 2: Use the WebSocket URL with Puppeteer if available
  if (websocketUrl) {
    console.log('\nStarting Puppeteer automation...');
    await controlBrowserWithPuppeteer(websocketUrl);
  } else {
    console.log('Cannot proceed with Puppeteer automation: WebSocket URL not available');
  }
}

// Execute the example
main();