Bump version 2.1.0

Co-authored-by: Simon <simon@perols.dev>

Dockerfile

@@ -5,9 +5,9 @@ ARG TARGETPLATFORM
 ARG BUILDPLATFORM
 RUN printf "I am running on ${BUILDPLATFORM:-linux/amd64}, building for ${TARGETPLATFORM:-linux/amd64}\n$(uname -a)\n"
 
-# Install the web browser (package firefox is available too)
+# Install the web browser (package firefox-esr is available too)
 RUN apk update && \
-    apk add --no-cache firefox-esr dumb-init && \
+    apk add --no-cache firefox dumb-init && \
     rm -Rf /var/cache
 
 # Copy FlareSolverr code
@@ -28,7 +28,7 @@ RUN npm install && \
 
 EXPOSE 8191
 ENTRYPOINT ["/usr/bin/dumb-init", "--"]
-CMD ["npm", "start"]
+CMD ["node", "./dist/server.js"]
 
 # docker build -t flaresolverr:custom .
 # docker run -p 8191:8191 -e LOG_LEVEL=debug flaresolverr:custom

README.md

@@ -5,8 +5,8 @@
 [![GitHub issues](https://img.shields.io/github/issues/FlareSolverr/FlareSolverr)](https://github.com/FlareSolverr/FlareSolverr/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/FlareSolverr/FlareSolverr)](https://github.com/FlareSolverr/FlareSolverr/pulls)
 [![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X5NJLLX5GLTV6&source=url)
-[![Donate Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg)](https://www.buymeacoffee.com/ngosang)
-[![Donate Bitcoin](https://img.shields.io/badge/Donate-Bitcoin-orange.svg)](https://en.cryptobadges.io/donate/13Hcv77AdnFWEUZ9qUpoPBttQsUT7q9TTh)
+[![Donate Bitcoin](https://en.cryptobadges.io/badge/micro/13Hcv77AdnFWEUZ9qUpoPBttQsUT7q9TTh)](https://en.cryptobadges.io/donate/13Hcv77AdnFWEUZ9qUpoPBttQsUT7q9TTh)
+[![Donate Ethereum](https://en.cryptobadges.io/badge/micro/0x0D1549BbB00926BF3D92c1A8A58695e982f1BE2E)](https://en.cryptobadges.io/donate/0x0D1549BbB00926BF3D92c1A8A58695e982f1BE2E)
 
 FlareSolverr is a proxy server to bypass Cloudflare protection.
 
@@ -141,7 +141,7 @@ session | Optional. Will send the request from and existing browser instance. If
 maxTimeout | Optional, default value 60000. Max timeout to solve the challenge in milliseconds.
 cookies | Optional. Will be used by the headless browser. Follow [this](https://github.com/puppeteer/puppeteer/blob/v3.3.0/docs/api.md#pagesetcookiecookies) format.
 returnOnlyCookies | Optional, default false. Only returns the cookies. Response data, headers and other parts of the response are removed.
-proxy | Optional, default disabled. Eg: `"proxy": {"url": "http://127.0.0.1:8888"}`. Authorization (username/password) is not supported.
+proxy | Optional, default disabled. Eg: `"proxy": {"url": "http://127.0.0.1:8888"}`. You must include the proxy schema in the URL: `http://`, `socks4://` or `socks5://`. Authorization (username/password) is not supported.
 
 :warning: If you want to use Cloudflare clearance cookie in your scripts, make sure you use the FlareSolverr User-Agent too. If they don't match you will see the challenge.
 
@@ -210,7 +210,7 @@ This is the same as `request.get` but it takes one more param:
 
 Parameter | Notes
 |--|--|
-postData | Must be a string with `application/x-www-form-urlencoded`. Eg: `postData": "a=b&c=d"`
+postData | Must be a string with `application/x-www-form-urlencoded`. Eg: `a=b&c=d`
 
 ## Environment variables
 
@@ -221,6 +221,8 @@ LOG_HTML | false | Only for debugging. If `true` all HTML that passes through th
 CAPTCHA_SOLVER | none | Captcha solving method. It is used when a captcha is encountered. See the Captcha Solvers section.
 TZ | UTC | Timezone used in the logs and the web browser. Example: `TZ=Europe/London`.
 HEADLESS | true | Only for debugging. To run the web browser in headless mode or visible.
+BROWSER_TIMEOUT | 30000 | If you are experiencing errors/timeouts because your system is slow, you can try to increase this value. Remember to increase the `maxTimeout` parameter too.
+TEST_URL | https://www.google.com | FlareSolverr makes a request on start to make sure the web browser is working. You can change that URL if it is blocked in your country.
 PORT | 8191 | Listening port. You don't need to change this if you are running on Docker.
 HOST | 0.0.0.0 | Listening interface. You don't need to change this if you are running on Docker.
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "flaresolverr",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "flaresolverr",
-      "version": "2.0.0",
+      "version": "2.0.2",
       "license": "MIT",
       "dependencies": {
         "await-timeout": "^1.1.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "flaresolverr",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Proxy server to bypass Cloudflare protection.",
   "scripts": {
     "start": "node ./dist/server.js",

src/providers/cloudflare.ts

@@ -6,7 +6,7 @@ import log from "../services/log";
  *  This class contains the logic to solve protections provided by CloudFlare
  **/
 
-const BAN_SELECTORS = ['span[data-translate="error"]'];
+const BAN_SELECTORS = ['.text-gray-600'];
 const CHALLENGE_SELECTORS = ['#trk_jschal_js', '.ray_id', '.attack-box', '#cf-please-wait'];
 const CAPTCHA_SELECTORS = ['input[name="cf_captcha_kind"]'];
 

src/server.ts

@@ -46,4 +46,13 @@ testWebBrowserInstallation().then(() => {
   app.listen(serverPort, serverHost, () => {
     log.info(`Listening on http://${serverHost}:${serverPort}`);
   })
+}).catch(function(e) {
+  log.error(e);
+  const msg: string = "" + e;
+  if (msg.includes('while trying to connect to the browser!')) {
+    log.error(`It seems that the system is too slow to run FlareSolverr. 
+    If you are running with Docker, try to remove CPU limits in the container. 
+    If not, try setting the 'BROWSER_TIMEOUT' environment variable and the 'maxTimeout' parameter to higher values.`);
+  }
+  process.exit(1);
 })

src/services/sessions.ts

@@ -5,6 +5,8 @@ import {SetCookie, Browser} from 'puppeteer'
 import log from './log'
 import {Proxy} from "../controllers/v1";
 
+const os = require('os');
+const fs = require('fs');
 const puppeteer = require('puppeteer');
 
 export interface SessionsCacheItem {
@@ -44,27 +46,49 @@ function buildExtraPrefsFirefox(proxy: Proxy): object {
     "startup.homepage_welcome_url": "about:blank",
     "startup.homepage_welcome_url.additional": "",
 
-    // Disable images to speed up load
-    "permissions.default.image": 2
+    // Detected !
+    // // Disable images to speed up load
+    // "permissions.default.image": 2,
+
+    // Limit content processes to 1
+    "dom.ipc.processCount": 1
   }
 
   // proxy.url format => http://<host>:<port>
   if (proxy && proxy.url) {
-    const [host, portStr] = proxy.url.replace(/https?:\/\//g, '').split(':');
+    const [host, portStr] = proxy.url.replace(/.+:\/\//g, '').split(':');
     const port = parseInt(portStr);
 
     const proxyPrefs = {
-      // Proxy configuration
+      "network.proxy.type": 1,
+      "network.proxy.share_proxy_settings": true
+    }
+    if (proxy.url.indexOf("socks") != -1) {
+      // SOCKSv4 & SOCKSv5
+      Object.assign(proxyPrefs, {
+        "network.proxy.socks": host,
+        "network.proxy.socks_port": port,
+        "network.proxy.socks_remote_dns": true
+      });
+      if (proxy.url.indexOf("socks4") != -1) {
+        Object.assign(proxyPrefs, {
+          "network.proxy.socks_version": 4
+        });
+      } else {
+        Object.assign(proxyPrefs, {
+          "network.proxy.socks_version": 5
+        });
+      }
+    } else {
+      // HTTP
+      Object.assign(proxyPrefs, {
         "network.proxy.ftp": host,
         "network.proxy.ftp_port": port,
         "network.proxy.http": host,
         "network.proxy.http_port": port,
-      "network.proxy.share_proxy_settings": true,
-      "network.proxy.socks": host,
-      "network.proxy.socks_port": port,
         "network.proxy.ssl": host,
-      "network.proxy.ssl_port": port,
-      "network.proxy.type": 1
+        "network.proxy.ssl_port": port
+      });
     }
 
     // merge objects
@@ -80,16 +104,25 @@ export function getUserAgent() {
 
 export async function testWebBrowserInstallation(): Promise<void> {
   log.info("Testing web browser installation...")
+
+  // check user home dir. this dir will be used by Firefox
+  const homeDir = os.homedir();
+  fs.accessSync(homeDir, fs.constants.F_OK | fs.constants.R_OK | fs.constants.W_OK | fs.constants.X_OK);
+  log.debug("FlareSolverr user home directory is OK: " + homeDir)
+
+  // test web browser
+  const testUrl = process.env.TEST_URL || "https://www.google.com";
+  log.debug("Test URL: " + testUrl)
   const session = await create(null, {
     oneTimeSession: true
   })
   const page = await session.browser.newPage()
-  await page.goto("https://www.google.com")
+  await page.goto(testUrl)
   webBrowserUserAgent = await page.evaluate(() => navigator.userAgent)
 
   // replace Linux ARM user-agent because it's detected
-  if (webBrowserUserAgent.toLocaleLowerCase().includes('linux arm')) {
-    webBrowserUserAgent = webBrowserUserAgent.replace(/linux arm[^;]+;/i, 'Linux x86_64;')
+  if (["arm", "aarch64"].some(arch => webBrowserUserAgent.toLocaleLowerCase().includes('linux ' + arch))) {
+    webBrowserUserAgent = webBrowserUserAgent.replace(/linux \w+;/i, 'Linux x86_64;')
   }
 
   log.info("FlareSolverr User-Agent: " + webBrowserUserAgent)
@@ -107,6 +140,7 @@ export async function create(session: string, options: SessionCreateOptions): Pr
   const puppeteerOptions: any = {
     product: 'firefox',
     headless: process.env.HEADLESS !== 'false',
+    timeout: process.env.BROWSER_TIMEOUT || 30000
   }
 
   puppeteerOptions.extraPrefsFirefox = buildExtraPrefsFirefox(options.proxy)

src/tests/app.test.ts

@@ -9,6 +9,7 @@ const sessions = require('../services/sessions');
 const version: string = 'v' + require('../../package.json').version
 
 const proxyUrl = "http://127.0.0.1:8888"
+const proxySocksUrl = "socks5://127.0.0.1:1080"
 const googleUrl = "https://www.google.com";
 const postUrl = "https://ptsv2.com/t/qv4j3-1634496523";
 const cfUrl = "https://pirateiro.com/torrents/?search=harry";
@@ -221,7 +222,7 @@ describe("Test '/v1' path", () => {
         expect(solution.userAgent).toBe(null)
     });
 
-    test("Cmd 'request.get' should return OK with 'proxy' param", async () => {
+    test("Cmd 'request.get' should return OK with HTTP 'proxy' param", async () => {
         /*
         To configure TinyProxy in local:
            * sudo vim /etc/tinyproxy/tinyproxy.conf
@@ -249,7 +250,7 @@ describe("Test '/v1' path", () => {
     });
 
     // todo: credentials are not working
-    test.skip("Cmd 'request.get' should return OK with 'proxy' param with credentials", async () => {
+    test.skip("Cmd 'request.get' should return OK with HTTP 'proxy' param with credentials", async () => {
         /*
         To configure TinyProxy in local:
            * sudo vim /etc/tinyproxy/tinyproxy.conf
@@ -279,6 +280,32 @@ describe("Test '/v1' path", () => {
         expect(solution.status).toContain(200)
     });
 
+    test("Cmd 'request.get' should return OK with SOCKSv5 'proxy' param", async () => {
+        /*
+        To configure Dante in local:
+           * https://linuxhint.com/set-up-a-socks5-proxy-on-ubuntu-with-dante/
+           * sudo vim /etc/sockd.conf
+           * sudo systemctl restart sockd.service
+           * curl --socks5 socks5://127.0.0.1:1080 https://www.google.com
+        */
+        const payload = {
+            "cmd": "request.get",
+            "url": googleUrl,
+            "proxy": {
+                "url": proxySocksUrl
+            }
+        }
+        const response: Response = await request(app).post("/v1").send(payload);
+        expect(response.statusCode).toBe(200);
+
+        const apiResponse: V1ResponseSolution = response.body;
+        expect(apiResponse.status).toBe("ok");
+
+        const solution = apiResponse.solution;
+        expect(solution.url).toContain(googleUrl)
+        expect(solution.status).toBe(200);
+    });
+
     test("Cmd 'request.get' should fail with wrong 'proxy' param", async () => {
         const payload = {
             "cmd": "request.get",