feat: add allowBots filter parameter

Author: shiftinv

README.md

@@ -29,6 +29,11 @@ Additional options can be configured per URL:
   - This is case-sensitive and supports regex
   - Only full matches are considered, i.e. no substrings; `abc.*xyz` is equivalent to
     `/^(abc.*xyz)$/`
+- `allowBots`: Forward events from bots
+  - Accepts a bool (`1`, `0`, `true`, `false`) or a regex (see `allowBranches` for supported values)
+  - If unset, ignores events only from common CI bots[^1], unless the branch is explicitly allowed
 - `hideTags`: Ignore tag updates
 - `commentBurstLimit`: Ignore burst PR review comments in a short timespan, only showing the first x
   comments per review
+
+[^1]: `coveralls[bot]`, `netlify[bot]`, `pre-commit-ci[bot]`, `dependabot[bot]`

src/filter.ts

@@ -3,6 +3,8 @@ import { getAndIncrementKV } from "./kv.ts";
 import { UrlConfig } from "./types.d.ts";
 import { wildcardMatch } from "./util.ts";
 
+const COMMON_CI_BOTS = ["coveralls[bot]", "netlify[bot]", "pre-commit-ci[bot]", "dependabot[bot]"];
+
 export default async function filter(
     headers: Record<string, string>,
     json: any,
@@ -101,15 +103,19 @@ export default async function filter(
         }
     }
 
-    // ignore bots
-    if (
-        !isExplicitlyAllowedBranch && // show bot pushes on allowed branches
-        login &&
-        ["coveralls[bot]", "netlify[bot]", "pre-commit-ci[bot]", "dependabot[bot]"].some((n) =>
-            login.includes(n)
-        )
-    ) {
-        return "bot";
+    if (login && login.endsWith("[bot]")) {
+        if (config.allowBots !== undefined) {
+            // ignore bot if matching
+            if (!wildcardMatch(config.allowBots, login.slice(0, -5))) {
+                return `bot '${login}' does not match ${JSON.stringify(config.allowBots)}`;
+            }
+        } else if (
+            // ignore some CI bots if not explicitly allowed
+            !isExplicitlyAllowedBranch && // show bot pushes on allowed branches
+            COMMON_CI_BOTS.some((n) => login.includes(n))
+        ) {
+            return "bot";
+        }
     }
 
     return null;

src/handler.ts

@@ -42,6 +42,15 @@ function getUrlConfig(params: Record<string, string>): UrlConfig {
             case "allowBranches":
                 config.allowBranches = value;
                 break;
+            case "allowBots": {
+                const bool = parseBool(value, false);
+                if (bool === undefined) {
+                    config.allowBots = value;
+                } else {
+                    config.allowBots = bool ? ".*" : "";
+                }
+                break;
+            }
             case "hideTags":
                 config.hideTags = parseBool(value);
                 break;

src/types.d.ts

@@ -1,5 +1,6 @@
 export interface UrlConfig {
     allowBranches?: string;
+    allowBots?: string;
     hideTags?: boolean;
     commentBurstLimit?: number;
 }

src/util.ts

@@ -1,7 +1,14 @@
 import type { Context } from "@hono/hono";
 
-export function parseBool(s: string): boolean {
-    return ["1", "true", "on", "y", "yes"].includes(s.toLowerCase());
+export function parseBool(s: string, strict: false): boolean | undefined;
+export function parseBool(s: string, strict?: true): boolean;
+export function parseBool(s: string, strict: boolean = true): boolean | undefined {
+    s = s.toLowerCase();
+    if (["1", "true", "on", "y", "yes"].includes(s)) return true;
+    else if (["0", "false", "off", "n", "no"].includes(s)) return false;
+
+    if (strict) throw new Error(`invalid bool value: ${s}`);
+    return undefined;
 }
 
 export function sleep(ms: number): Promise<void> {