Let outside services and computers' browser notifications give bots work
A bot hook (bot_hooks) is a secret URL, POST /api/hooks/<token>, whose calls queue the hook's brief plus the raw body as a task, per user and bot like a routine. Only the token's hash is kept (shown once, rotatable); an optional HMAC-SHA256 signing secret is stored encrypted. Calls are rate limited per address and per hook, recorded in bot_hook_events (pruned daily), deduplicated by delivery id, and a call while the last run still waits joins its brief instead of queueing another. The payload is fenced data and HookRunNote tells the bot never to take instructions from it; failed runs retry like routines. A hook can instead watch a computer's browser notifications: the app installs a small watcher that owns org.freedesktop.Notifications on the sandbox's session bus, so Chrome hands it every notification (it only looks for that service at start-up, so Chrome is restarted once, never mid-task), and it posts each one to its hooks, optionally filtered. Computers reach the app at COMPUTER_APP_URL or the app container's name. Users make hooks in the conversation's Hooks modal and manage them all on /admin/routines; bots never create or change hooks. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
@@ -0,0 +1,280 @@
|
||||
import { useState } from "react";
|
||||
import Checkbox from "@moduletrace/twui/form/Checkbox";
|
||||
import Form from "@moduletrace/twui/form/Form";
|
||||
import Input from "@moduletrace/twui/form/Input";
|
||||
import Select from "@moduletrace/twui/form/Select";
|
||||
import CodeEditor from "@/src/components/general/code-editor";
|
||||
import {
|
||||
BotHookSignatureFormats,
|
||||
BotHookSources,
|
||||
type BotHookSignatureFormat,
|
||||
type BotHookSource,
|
||||
} from "@/src/dict/bot-hook-dict";
|
||||
import postAdminApi from "@/src/layouts/bots/(functions)/post-admin-api";
|
||||
import AddFormActions from "@/src/layouts/bots/(partials)/add-form-actions";
|
||||
import type {
|
||||
BotHookWithNames,
|
||||
BotHookWithToken,
|
||||
NotifyWatchSync,
|
||||
} from "@/src/types";
|
||||
|
||||
type Props = {
|
||||
/**
|
||||
* The hook to edit; left out to make one for `bot_id` there.
|
||||
*/
|
||||
hook?: BotHookWithNames;
|
||||
bot_id: number;
|
||||
workspace_id?: number | null;
|
||||
/**
|
||||
* The bot's computers there, for a new browser-notification hook. Left
|
||||
* out (or empty), only URL hooks can be made.
|
||||
*/
|
||||
computers?: { id?: number | ""; name?: string }[];
|
||||
onCancel: () => void;
|
||||
/**
|
||||
* `token` only for a new URL hook: its URL, shown once. `watch` for a
|
||||
* new notification hook: how setting up its computer went. `msg` is
|
||||
* what the save said.
|
||||
*/
|
||||
onSaved: (params: {
|
||||
hook: BotHookWithNames;
|
||||
token?: string;
|
||||
watch?: NotifyWatchSync;
|
||||
msg?: string;
|
||||
}) => void;
|
||||
};
|
||||
|
||||
/**
|
||||
* A hook's name and brief, what calls it (its URL, or a computer's browser
|
||||
* notifications, chosen once when it's made), and then either whether its
|
||||
* calls must be signed (the secret, the header it comes in and how it's
|
||||
* written) or which notifications it takes. Makes a hook or edits one; a
|
||||
* saved secret is never shown again, so leaving it blank keeps it.
|
||||
*/
|
||||
export default function HookForm({
|
||||
hook,
|
||||
bot_id,
|
||||
workspace_id,
|
||||
computers = [],
|
||||
onCancel,
|
||||
onSaved,
|
||||
}: Props) {
|
||||
const [source, setSource] = useState<BotHookSource>(
|
||||
(hook?.source as BotHookSource) || "url",
|
||||
);
|
||||
const [watch_computer_id, setWatchComputerId] = useState(
|
||||
hook?.watch_computer_id
|
||||
? Number(hook.watch_computer_id)
|
||||
: Number(computers[0]?.id) || 0,
|
||||
);
|
||||
const [watch_filter, setWatchFilter] = useState(hook?.watch_filter || "");
|
||||
const [title, setTitle] = useState(hook?.title || "");
|
||||
const [instructions, setInstructions] = useState(hook?.instructions || "");
|
||||
const [signed, setSigned] = useState(Boolean(hook?.has_signing_secret));
|
||||
const [secret, setSecret] = useState("");
|
||||
const [header, setHeader] = useState(
|
||||
hook?.signature_header || "X-Hub-Signature-256",
|
||||
);
|
||||
const [format, setFormat] = useState<BotHookSignatureFormat>(
|
||||
(hook?.signature_format as BotHookSignatureFormat) || "sha256=hex",
|
||||
);
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [error, setError] = useState<string>();
|
||||
|
||||
const watching = source == "browser_notifications";
|
||||
|
||||
const signing = (() => {
|
||||
if (watching) return {};
|
||||
if (!signed)
|
||||
return hook?.has_signing_secret ? { signing_secret: null } : {};
|
||||
|
||||
return {
|
||||
...(secret.trim() ? { signing_secret: secret } : {}),
|
||||
signature_header: header,
|
||||
signature_format: format,
|
||||
};
|
||||
})();
|
||||
|
||||
const submit = async () => {
|
||||
if (loading) return;
|
||||
if (!window.confirm(`Save ${title || "this hook"}?`)) return;
|
||||
|
||||
setLoading(true);
|
||||
setError(undefined);
|
||||
|
||||
const res = hook
|
||||
? await postAdminApi<BotHookWithNames>({
|
||||
path: "hooks/update-hook",
|
||||
body: {
|
||||
hook_id: hook.id,
|
||||
title,
|
||||
instructions,
|
||||
...signing,
|
||||
...(watching ? { watch_filter } : {}),
|
||||
},
|
||||
})
|
||||
: await postAdminApi<BotHookWithToken>({
|
||||
path: "hooks/create-hook",
|
||||
body: {
|
||||
bot_id,
|
||||
workspace_id: workspace_id || null,
|
||||
title,
|
||||
instructions,
|
||||
source,
|
||||
...signing,
|
||||
...(watching ? { watch_computer_id, watch_filter } : {}),
|
||||
},
|
||||
});
|
||||
|
||||
setLoading(false);
|
||||
|
||||
if (!res.success || !res.singleRes) {
|
||||
setError(res.msg || "Couldn't save the hook.");
|
||||
return;
|
||||
}
|
||||
|
||||
if ("hook" in res.singleRes) {
|
||||
onSaved({
|
||||
hook: res.singleRes.hook,
|
||||
token: res.singleRes.token,
|
||||
watch: res.singleRes.watch,
|
||||
msg: res.msg,
|
||||
});
|
||||
} else {
|
||||
onSaved({ hook: res.singleRes, msg: res.msg });
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<Form
|
||||
className="w-full gap-4! items-stretch pt-4 overflow-hidden px-1"
|
||||
onSubmit={submit}
|
||||
>
|
||||
<Input
|
||||
id="hook-title"
|
||||
title="Name"
|
||||
label="Name"
|
||||
showLabel
|
||||
autoComplete="off"
|
||||
placeholder="New GitHub issues"
|
||||
defaultValue={title}
|
||||
onChange={(e) => setTitle(e.target.value)}
|
||||
/>
|
||||
<CodeEditor
|
||||
mode="markdown"
|
||||
className="h-40"
|
||||
title="Brief"
|
||||
content={instructions}
|
||||
info="What the bot does with each call. What the caller sends is added below this as data, never as instructions."
|
||||
onChange={(value) => setInstructions(value)}
|
||||
/>
|
||||
{hook ? null : (
|
||||
<Select
|
||||
id="hook-source"
|
||||
title="What calls it"
|
||||
label="What calls it"
|
||||
showLabel
|
||||
options={BotHookSources.filter(
|
||||
(s) => s.value == "url" || computers.length,
|
||||
).map((s) => ({
|
||||
value: s.value,
|
||||
title: s.title,
|
||||
default: s.value == source,
|
||||
}))}
|
||||
changeHandler={(value) =>
|
||||
setSource(String(value) as BotHookSource)
|
||||
}
|
||||
/>
|
||||
)}
|
||||
{watching && !hook ? (
|
||||
<Select
|
||||
id="hook-watch-computer"
|
||||
title="Computer"
|
||||
label="Computer"
|
||||
showLabel
|
||||
options={computers.map((c) => ({
|
||||
value: String(c.id),
|
||||
title: c.name || `Computer ${c.id}`,
|
||||
default: Number(c.id) == watch_computer_id,
|
||||
}))}
|
||||
changeHandler={(value) => setWatchComputerId(Number(value))}
|
||||
/>
|
||||
) : null}
|
||||
{watching ? (
|
||||
<Input
|
||||
id="hook-watch-filter"
|
||||
title="Only notifications with"
|
||||
label="Only notifications with"
|
||||
showLabel
|
||||
autoComplete="off"
|
||||
placeholder="mail.google.com, invoice"
|
||||
defaultValue={watch_filter}
|
||||
info="Words in the site, title or text, comma-separated: any one is enough. Empty takes every notification. The site has to be allowed to send notifications in that computer's browser."
|
||||
onChange={(e) => setWatchFilter(e.target.value)}
|
||||
/>
|
||||
) : null}
|
||||
{watching ? null : (
|
||||
<>
|
||||
<Checkbox
|
||||
title="Check signatures"
|
||||
label="Only take calls signed with a secret (HMAC-SHA256 of the body, as GitHub and Stripe send)"
|
||||
checked={signed}
|
||||
changeHandler={setSigned}
|
||||
labelProps={{
|
||||
className: "w-full line-clamp-1 overflow-ellipsis",
|
||||
}}
|
||||
/>
|
||||
{signed ? (
|
||||
<>
|
||||
<Input
|
||||
id="hook-secret"
|
||||
title="Signing secret"
|
||||
label="Signing secret"
|
||||
showLabel
|
||||
type="password"
|
||||
autoComplete="new-password"
|
||||
placeholder={
|
||||
hook?.has_signing_secret
|
||||
? "Leave blank to keep the current secret"
|
||||
: ""
|
||||
}
|
||||
onChange={(e) => setSecret(e.target.value)}
|
||||
/>
|
||||
<Input
|
||||
id="hook-signature-header"
|
||||
title="Signature header"
|
||||
label="Signature header"
|
||||
showLabel
|
||||
autoComplete="off"
|
||||
defaultValue={header}
|
||||
onChange={(e) => setHeader(e.target.value)}
|
||||
/>
|
||||
<Select
|
||||
id="hook-signature-format"
|
||||
title="Signature format"
|
||||
label="Signature format"
|
||||
showLabel
|
||||
options={BotHookSignatureFormats.map((f) => ({
|
||||
value: f.value,
|
||||
title: f.title,
|
||||
default: f.value == format,
|
||||
}))}
|
||||
changeHandler={(value) =>
|
||||
setFormat(
|
||||
String(value) as BotHookSignatureFormat,
|
||||
)
|
||||
}
|
||||
/>
|
||||
</>
|
||||
) : null}
|
||||
</>
|
||||
)}
|
||||
<AddFormActions
|
||||
submit_label={hook ? "Save" : "Make hook"}
|
||||
loading={loading}
|
||||
error={error}
|
||||
onCancel={onCancel}
|
||||
/>
|
||||
</Form>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user