Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

2.0 KB
Raw Blame
import { describe, expect, it } from "vitest";
import { detectBot } from "./headerHeuristics.js";

const browserUserAgent =
  "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";

describe("header heuristic bot detection", () => {
  it("detects scripting framework user agents", () => {
    const result = detectBot({}, "python-requests/2.31.0");

    expect(result).toEqual({
      isBot: true,
      score: 5,
      reason: "bot_framework:python-requests",
    });
  });

  it("detects default OkHttp React Native requests as scripting framework traffic", () => {
    const result = detectBot({}, "okhttp/4.12.0");

    expect(result).toEqual({
      isBot: true,
      score: 5,
      reason: "bot_framework:okhttp",
    });
  });

  it("does not block React Native SDK requests that send SDK HTTP headers", () => {
    const result = detectBot(
      {
        accept: "application/json",
        "accept-language": "en-US,en;q=0.9",
      },
      "Mozilla/5.0 (Linux; Android 36) AppleWebKit/537.36 (KHTML, like Gecko) RybbitReactNative/0.1.1"
    );

    expect(result).toEqual({
      isBot: false,
      score: 2,
      reason: "missing_accept_encoding",
    });
  });

  it("scores missing browser headers", () => {
    const result = detectBot({}, browserUserAgent);

    expect(result).toMatchObject({
      isBot: true,
      score: 9,
    });
    expect(result.reason).toContain("missing_accept_language");
    expect(result.reason).toContain("missing_accept");
    expect(result.reason).toContain("missing_accept_encoding");
    expect(result.reason).toContain("missing_sec_fetch_site");
  });

  it("does not score complete browser fetch headers", () => {
    const browserHeaders = {
      accept: "*/*",
      "accept-encoding": "gzip, br",
      "accept-language": "en-US,en;q=0.9",
      "sec-fetch-site": "cross-site",
    };

    expect(detectBot(browserHeaders, browserUserAgent)).toEqual({
      isBot: false,
      score: 0,
      reason: undefined,
    });
  });
});