@extra/humanize v4.2.1-next.613

@extra/humanize

A plugin for playwright-extra & puppeteer-extra to humanize input (mouse movements, etc)

Install

yarn add @extra/humanize
# - or -
npm install @extra/humanize

• v4
  • Initial public release

Support

Learn more at Playwright vs Puppeteer

Usage

The plugin augments APIs like page.click() to use realistic human input behavior behind the scenes.

Playwright

If this is your first playwright-extra plugin here's everything you need:

yarn add playwright playwright-extra @extra/humanize
# - or -
npm install playwright playwright-extra @extra/humanize

// playwright-extra is a drop-in replacement for playwright,
// it augments the installed playwright with plugin functionality
// Note: Instead of firefox you can use chromium and webkit as well.
const { firefox } = require('playwright-extra')

// Add humanize plugin
const HumanizePlugin = require('@extra/humanize')
firefox.use(
  HumanizePlugin({
    mouse: {
      showCursor: true // Show the cursor (meant for testing)
    }
  })
)

// playwright usage as normal
firefox.launch({ headless: false }).then(async browser => {
  const page = await browser.newPage()
  await page.goto('https://example.com', { waitUntil: 'domcontentloaded' })
  await page.waitForSelector('a')

  // This regular API will automatically be humanized 🎉
  await page.click('a')

  await page.waitForTimeout(5 * 1000)
  await browser.close()
})

Puppeteer

If this is your first puppeteer-extra plugin here's everything you need:

yarn add puppeteer puppeteer-extra @extra/humanize
# - or -
npm install puppeteer puppeteer-extra @extra/humanize

The code is basically the same as in the playwright example :-) Just use this import instead:

const puppeteer = require('puppeteer-extra')
// (...)
puppeteer.launch()
// (...)

The plugin framework as well as this plugin are written in TS, hence you get perfect type support out of the box :)

If you'd like to see debug output just run your script like so:

DEBUG=automation-extra,automation-extra-plugin:* node myscript.js

Human robots

This plugin is heavily based on the work of @Xetera and @Niek with ghost-cursor. It's using generated bezier curves to mimic and spoof realistic human mouse movements while navigating a site and clicking on elements.

Current features

• Augments page.click() with human like mouse movements (move cursor to the element and click it)
• Supports Playwright & Puppeteer and all browsers
• Can be enabled/disabled on the fly with plugin.disable() and plugin.enable()

Plugin Options

export interface MouseOpts {
  /** Enable human mouse movements when clicking */
  enabled: boolean // default: true
  /** Show a visible cursor (for testing, not for production) */
  showCursor: boolean // default: false
}

export interface HumanizePluginOpts {
  mouse: Partial<MouseOpts>
}

Todo

(This plugin can be considered in beta stage)

• Mouse movements
  • Playwright: Improve frame support
  • Playwright: Support random starting point
  • Use and implement native ClickOptions (delay and the like)
  • More mouse options (waitForElement, etc)
  • Consider augmenting elementHandle.click() as well
• Keyboard/typing
  • Add human typing behavior (random delays, backspace probability, etc)
• General
  • More documentation
  • Generate API docs
  • Code cleanup
  • Expose more options and configurations

License

Copyright © 2018 - 2021, berstend̡̲̫̹̠̖͚͓̔̄̓̐̄͛̀͘. Released under the MIT License.