Anonymous Web Scraping with Node.js, Tor, Puppeteer and cheerio

Anonymous Web Scraping with Node.js, Tor, Puppeteer and cheerio
Anonymous Web Scraping with Node.js, Tor, Puppeteer and cheerio.This article was intended to provide you with a gentle introduction to Web Scraping. Thank you for taking time to read it.

Web Scraping is the technique of extracting data from websites. The term is used typically for automated data extraction. Today, I am going to show you how to crawl websites anonymously. The reason why you want to hide your identity is due to the fact that many web servers apply rules to websites which ban IPs after a certain amount of continuous requests. We are going to use Puppeteer for accessing web pages, cheerio for HTML parsing, and Tor to run each request from a different IP address.

While the legal aspects of Web Scraping vary, with many grey zones, remember to always respect the Terms of Service of each web page you scrape. Ben Bernard has wrote a nice article about those legal issues.

Setting Up Tor

First things first, we have to install our Tor client by using the following command.

sudo apt-get install tor

Configure Tor

Next, we are going to configure our Tor client. The default Tor configuration uses a SOCKS port to provide us with one circuit to a single exit node (i.e. one IP address). This is handy for everyday use, like browsing, but for our specific scenario we need multiple IP addresses, so that we can switch between them while scraping.

To do this, we’ll simply open additional ports to listen for SOCKS connections. This is done by adding multiple SocksPort options to main configuration file under /etc/tor.

Open /etc/tor/torrc file with your preferred editor and add the next lines in the end of the file.

# Open 4 SOCKS ports, each providing a new Tor circuit.
SocksPort 9050
SocksPort 9052
SocksPort 9053
SocksPort 9054

torrc

There a couple of things to notice here:

  • The value of each SocksPort is a number, the port that Tor will listen for connections from SOCKS-speaking applications, like browsers.
  • Because SocksPort value is a port to be open, the port must not already be used by another process.
  • The initial port starts with value 9050 . This is the default SOCKS of the Tor client.
  • We bypass value **9051** . This port is used by Tor to allow external applications who are connected to this port to control Tor process.
  • As a simple convention, to open more ports, we increment each value after 9051 by one.

Restart the tor client to apply the new changes.

sudo /etc/init.d/tor restart

Create a new Node project

Create a new directory for your project, I’ll call it superWebScraping.

mkdir superWebScraping

Navigate to superWebScraping and initialize an empty Node project.

cd superWebScraping && npm init -y

Install the required dependencies.

npm i --save puppeteer cheerio

Browse with Puppeteer

Puppeteer is a headless browser that uses DevTools Protocol to communicate with Chrome or Chromium. The reason why we don’t use a request library, like tor-request, is due to the fact that request libraries cannot process SPA websites that load their content dynamically.

Create an index.js file and add the below script. The statements are documented inline.

/**
 * Require the puppeteer library.
 */
const puppeteer = require('puppeteer');

/**
 * Inside the main function we'll place all the required code
 * that will be used in the scraping process.
 * The reason why we create an async function is to use
 * the power of async programming  that comes with puppeteer.
 */
async function main() {
  /**
   * Launch Chromium. By setting `headless` key to false,
   * we can see the browser UI.
   */
  const browser = await puppeteer.launch({
    headless: false
  });

  /**
   * Create a new page.
   */
  const page = await browser.newPage();

  /**
   * Using the newly created page, navigate to https://api.ipify.org
   */
  await page.goto('https://api.ipify.org');

  /**
   * Wait 3 seconds and then close the browser instance.
   */
  setTimeout(() => {
    browser.close();
  }, 3000);
}

/**
 * Start the script by calling main().
 */
main();

index.js

Run the script with

node index.js

You should see the Chromium browser navigating to https://api.ipify.org like the following screenshot

This is image title

There is a reason why I chose the specific web page in my example. https://api.ipify.org is able to send us our public IP address. This is the IP you are browsing the web, without using Tor.

Change the above code by adding the following key in puppeteer.launch statement:

node index.js

We provide the --proxy-server argument to our browser. The value of this argument tells the browser to use a socks5 proxy in our local machine on top of port 9050 . The value of the port is one of the values we provided earlier in torrc file.

Now run again the script.
This time you should see a different IP address. This is the IP that comes with Tor circuit.

This is image title

Mine is 144.217.7.33, but you might have a different one. Note that if you run the script again on the same port 9050 you’ll get the same IP address as before.

This is image title

This is the reason why we opened many ports in our Tor configuration. Try to use another port, like 9053. The IP will not be the same.

Scrape content with Cheerio

Now that we have a nice way to get our pages, it’s time to scrape them. We are going to use the cheerio library. Cheerio is an HTML parser designed to use the same API as jQuery. Our task is to scrape the last 5 post titles of Hacker News.

Let’s navigate to Hacker News.

This is image title

We want to scrape the first 5 titles (“HAKMEM (1972), “Larry Roberts has died”, etc). Inspecting the title of an article using my browser’s DevTools I can see that each article is being wrapped with an HTML link element which has storylink class.

This is image title

The procedure we are going to follow can be denoted by the bellow list:

  • Launch a browser instance in headless mode with Tor proxy
  • Create a new page
  • Navigate to https://news.ycombinator.com/
  • Get page HTML content
  • Load the HTML content in Cheerio
  • Create an array to save the article titles.
  • Access all the elements that have storylink class
  • Get only the first 5 such elements, using Cherrio’s slice() method.
  • Iterate through those 5 elements using Cherrio’s each() method.
  • Append each article title in the array.
const puppeteer = require('puppeteer');

/**
 * Require the cheerio library.
 */
const cheerio = require('cheerio');

async function main() {
  const browser = await puppeteer.launch({
    /**
     * Use the default headless mode (don't show the browser).
     */
    headless: true,
    args: ['--proxy-server=socks5://127.0.0.1:9050']
  });

  const page = await browser.newPage();

  await page.goto('https://news.ycombinator.com/');

  /**
   * Get page content as HTML.
   */
  const content = await page.content();

  /**
   * Load content in cheerio.
   */
  const $ = cheerio.load(content);


  /**
   * Create an array to save the article titles.
   */
  const titles = [];

  /**
   * Access `storylink` class. slice() is used to access
   * only he first 5 HTML elements that have `storylink` class.
   * We iterate each of those 5 elements using each() method.
   */
  $('.storylink').slice(0, 5).each((idx, elem) => {
    /**
     * Get the inner HTML which corresponds to the title in text format.
     */
    const title = $(elem).text();
  
    /**
     * Push the title in titles array.
     */
    titles.push(title);
  })

  browser.close();
  
  /**
   * Log the array of titles.
   */
  console.log(titles);
}

main();

index.js

And here is the output of the above code.

This is image title

Continuous scraping with different IP

The last thing to consider is to take advantage of all the SOCKS ports we defined in torrc file. This is quite easy. We’ll define an array with each item to be a different port number. Then we’ll rename main() to scrape() and we will define a new main() function that will call scrape() each time with a different port.

Here is the complete code.

const puppeteer = require('puppeteer');
const cheerio = require('cheerio');

async function scrape(port) {
  const browser = await puppeteer.launch({
    args: ['--proxy-server=socks5://127.0.0.1:' + port]
  });

  const page = await browser.newPage();
  await page.goto('https://news.ycombinator.com/');
  const content = await page.content();

  const $ = cheerio.load(content);

  const titles = [];

  $('.storylink').slice(0, 5).each((idx, elem) => {
    const title = $(elem).text();
    titles.push(title);
  });

  browser.close();
  return titles;
}

async function main() {
  /**
   * Tor SOCKS ports that we defined in torrc file. 
   */
  const ports = [
    '9050',
    '9052',
    '9053',
    '9054'
  ];
  
  /**
   * Scrape forever...
   */
  while (true) {
    for (const port of ports) {
      /**
       * ...each time with different port.
       */
      console.log(await scrape(port));
    }
  }
}

main();

index.js

Conclusion

This article was intended to provide you with a gentle introduction to Web Scraping. Thank you for taking time to read it. 🙏

Suggest:

☞ JavaScript Programming Tutorial Full Course for Beginners

☞ Learn JavaScript - Become a Zero to Hero

☞ Top 10 JavaScript Questions

☞ E-Commerce JavaScript Tutorial - Shopping Cart from Scratch

☞ JavaScript Substring Method in 5 Minutes

☞ Javascript Project Tutorial: Budget App