Sign inSign up

cenk1cenk2/hermes-bridge-gitlab

By cenk1cenk2

•Updated 7 days ago

Bridges GitLab merge request and note hooks to Hermes runs.

Image
0

1.0K

cenk1cenk2/hermes-bridge-gitlab repository overview

⁠hermes-bridge-gitlab

Bridges GitLab merge request and note webhooks that address the bot to Hermes runs, one thread per merge request or issue, and answers in the merge request or issue: an award, one status note edited in place and a reply in each discussion that asked. Talks directly to a Hermes⁠ API server — any deployment that exposes /v1/runs.

⁠Image

docker run --rm -p 8080:8080 cenk1cenk2/hermes-bridge-gitlab:latest
TagSource
latestThe latest release.
v<version>The release @kilic.dev/hermes-bridge-gitlab@<version> created by semantic-release.

⁠Environment

Durations are milliseconds unless noted.

VariableDefaultDescription
PORT8080Port the HTTP server binds to.
AGENT_NAMEHermesName the agent goes by in its status notes and replies, e.g. labrat.
LOG_LEVELinfoLowest level logged: error, warn, info, debug or verbose.
LOG_FORMATjsonjson for one JSON object per line, text for readable local lines.
REDIS_URLrequiredRedis or Valkey holding every queue and all shared state.
QUEUE_PREFIXhermes-bridge-gitlabPrefix of every Redis key and queue.
QUEUE_RETENTION_COMPLETED3600Seconds a completed job is kept.
QUEUE_RETENTION_FAILED86400Seconds a failed job is kept.
QUEUE_TRANSACTION_RETRIES10Attempts of a Redis transaction that keeps conflicting.
GITLAB_URLrequiredBase URL of the GitLab instance, e.g. https://gitlab.example.com.
GITLAB_TOKENrequiredPersonal access token of the bot (api scope) for awards, notes and merge request reads.
GITLAB_WEBHOOK_TOKENrequiredSecret token of the project hooks, compared with X-Gitlab-Token.
GITLAB_BOT_IDrequiredGitLab user id of the bot; its own notes and merge request events are dropped, and it is the assignee or reviewer that starts a fix or a review.
GITLAB_BOT_USERNAMErequiredUsername a note mentions to address the bot, and @<username> stop stops its thread.
GITLAB_WEBHOOK_TIMEOUT4000Time a webhook may spend queueing its event before it answers 503.
GITLAB_WEBHOOK_TTL86400000Lifetime of seen deliveries and stops.
GITLAB_WEBHOOK_INSTRUCTIONS_DEFAULTnoneInstructions of an input whose kind has none of its own.
GITLAB_WEBHOOK_INSTRUCTIONS_REVIEWnoneInstructions of a review input.
GITLAB_WEBHOOK_INSTRUCTIONS_FIXnoneInstructions of a fix input.
GITLAB_WEBHOOK_INSTRUCTIONS_MENTIONnoneInstructions of a mention input.
GITLAB_WEBHOOK_ALLOWED_USERSComma-separated GitLab usernames allowed to trigger the bot by a mention, an assignment, a review request or @<username> stop. Anyone else is dropped without an award, a note or a run. Empty allows everyone.
GITLAB_CLIENT_TIMEOUT10000Timeout of one GitLab API call.
GITLAB_CLIENT_PAGES10Pages of 100 discussions searched for a note whose hook carried no discussion_id.
GITLAB_NOTE_RATE_LIMIT_MAX1Awards, notes and edits posted per rate limit window, across replicas.
GITLAB_NOTE_RATE_LIMIT_DURATION1000Length of the rate limit window.
GITLAB_NOTE_DEBOUNCE10000Delay that collects progress and the streamed answer into one edit of the status note.
GITLAB_DISCUSSION_TTL86400000Lifetime of a status note's state, a thread's progress and its last stop note.
GITLAB_RECOVERY_AGE86400000Age of the oldest open status note the boot sweep resumes or closes.
GITLAB_RECOVERY_GRACE60000Age a status note needs before the boot sweep touches it.
HERMES_URLrequiredBase URL of the Hermes API server, e.g. https://hermes.example.com/v1.
HERMES_API_KEYrequiredKey sent to the Hermes API server.
HERMES_INSTRUCTIONSnoneInstructions of a run whose input carries none, that is when neither GITLAB_WEBHOOK_INSTRUCTIONS_<KIND> nor GITLAB_WEBHOOK_INSTRUCTIONS_DEFAULT is set.
HERMES_EVENTS_IDLE_TIMEOUT120000Silence on a run event stream before it is dropped and the run is polled.
DRIVER_SEEN_TTL86400000Lifetime of a seen idempotency key.
DRIVER_QUEUE_LOCK_TTL30000Lifetime of a thread lock.
DRIVER_QUEUE_LOCK_RENEW_INTERVAL10000Renewal interval of a held thread lock.
DRIVER_QUEUE_SWEEP_INTERVAL1000Interval of the sweep for threads with due work.
DRIVER_BACKOFF_INITIAL5000First retry delay while a run create gets 429, a 5xx or no connection.
DRIVER_BACKOFF_MAX60000Largest retry delay.
DRIVER_POLICY_BATCHtrueJoin the inputs queued behind a run into one run.
DRIVER_POLICY_STEERtrueSteer a follow-up into the running run instead of queueing it.
DRIVER_POLICY_RESUBMIT_MAX0New runs in the same Hermes session for a run that ends interrupted.
DRIVER_POLICY_BACKOFF_WINDOW600000Time Hermes may stay busy or unavailable before the thread fails.
DRIVER_POLICY_APPROVALdeny-stopdeny-stop stops a run after denying its approval request, deny-continue lets it go on.
DRIVER_FOLLOW_LEASE_TTL30000Lifetime of a run lease; another replica takes the run over once it expires.
DRIVER_FOLLOW_LEASE_RENEW_INTERVAL10000Renewal interval of a held run lease.
DRIVER_FOLLOW_SWEEP_INTERVAL5000Interval of the sweep for runs nobody follows.
DRIVER_FOLLOW_POLL_INTERVAL5000Interval between polls of a run without a stream.
DRIVER_FOLLOW_RETENTION86400000Time a finished run's record is kept.
DRIVER_HEARTBEAT_IDLE1200000Silence in a thread before it reports idle.
DRIVER_HEARTBEAT_SWEEP_INTERVAL60000Interval of the idle sweep.

⁠Routes

MethodPathDescription
GET/healthzLiveness: answers 200 ok.
GET/readyzReadiness: answers 200 ok, and 503 once a shutdown starts draining.
POST/v1/hooks/gitlabGitLab project hooks for merge request and note events: 400 on a wrong X-Gitlab-Token or a payload that fails the schema, 503 when the event could not be queued, else 200.
anyany otherAnswers 404.

⁠Events

Every event of the bot itself (GITLAB_BOT_ID) is dropped first, so nothing the bot writes starts a run. A delivery is handled once per Idempotency-Key (or webhook-id) header, and each input is sent once per note or merge request update.

EventConditionKind
Notenot create, a system note, not on a merge request or an issue, or no @<bot> in itdropped
Noteexactly @<bot> stopstop, never sent to Hermes
Notementions @<bot>mention
Merge requestclosed or mergedstop, when the thread has a run
Merge requestnot open, the bot newly an assignee or a reviewer, or its review re-requesteddropped, with a notice
Merge requestnot opendropped
Merge requestthe bot newly an assigneefix
Merge requestthe bot newly a reviewer, or its review re-requestedreview
Merge requestthe bot taken off and neither assignee nor reviewerstop, when the thread has a run

Each merge request or issue is one thread, gitlab-<project>-mr-<iid> or gitlab-<project>-issue-<iid>, which is also the Hermes session. An input carries the instructions of its kind, GITLAB_WEBHOOK_INSTRUCTIONS_<KIND> or else GITLAB_WEBHOOK_INSTRUCTIONS_DEFAULT; kinds with different instructions are never steered into each other's runs, and its meta {projectId, noteableType, iid, discussionId, noteId, kind} says where to answer.

⁠Feedback

Every call to GitLab goes through one BullMQ queue with a global concurrency of 1 and a shared rate limit, so replicas never race each other on a merge request.

  • A note that addresses the bot gets an eyes award at once, a stop note too.
  • Asking the bot for a fix or a review on a closed or merged merge request starts no run; it leaves a notice note instead, This merge request is <state>, so no <kind> run was started, once per update.
  • When a run is accepted, the thread opens one status note: a reply in the note's discussion for a mention, a new discussion for a review or a fix. The note is one sentence naming the ids to trace the thread by, <agent> has <state> the session through gitlab bridge, with key <key>, running in harness in session <session id> | run <run id>., where <agent> is AGENT_NAME, <key> is the thread key without its gitlab- prefix and <state> is accepted, turning failed or stopped when the run ends so. The answer, as Hermes streams it, follows that sentence and edits the note in place behind GITLAB_NOTE_DEBOUNCE, since edits notify nobody. A queued run, tool calls, todos and heartbeats stay off the note. A run a replica takes over is polled, so its note jumps from the partial answer to the final one.
  • The run's answer is a reply in the discussion of each of its inputs, once per discussion, and in the status discussion for a review or a fix, Done. for a run without one; the status note keeps only its sentence. A failure, a denied command and a stop are replies too, ending in the same sentence with failed (a denied command too) or stopped, and leave the partial answer below the sentence of the status note; a stop is also answered in the discussion of the stop note, and a stop of a run whose input has no discussion opens the status note to reply in. A stop note with nothing running is answered Nothing is running..
  • When the run ends, the bridge resolves the status discussion it started on a merge request, so it never blocks a merge; it never resolves a discussion an input came from, and issues have none to resolve. Review posts, Fixed in <sha>. replies, pushes and the resolution of review threads stay with the agent.
  • On boot, every status note left open is handed back to the driver; one whose run cannot be resumed gets a restart reply and is closed, once across replicas and restarts.

⁠Logs

Every line carries a message that is a complete sentence fixed per event, its source class as context, and its ids, numbers and reasons as fields at the root of the JSON object ({"level":"log","message":"Created a run for the thread.","context":"DriverThreadService","run":"...","thread":"...","replayed":false}); text prints the same fields inline. Durations are durationMs; tokens and bodies are never logged.

  • info: one line per HTTP request (method, path, status, duration, remote address; /healthz and /readyz only at debug), webhook verification or rejection with the Idempotency-Key and X-Gitlab-Event headers, each routed event and each dropped one with its reason (and, for a merge request that is not open, the kind it would have started and its state), queued notices, acknowledgement and thread input, skipped redeliveries, stops, opened status notes, posted replies, notices and awards, run creation, busy backoff, steers, follows and takeovers, finished runs with status and duration, Redis connections, the recovery sweep summary, the drain on shutdown and the runs and threads it hands over.
  • debug: every run stream event, Hermes and GitLab call (method, path, status, duration), queued award, note and edit, status note edit, thread lock and run lease acquire, renew and release, and Redis transaction retry.
  • warn and error: anything retried, dropped or failed, with its error.

⁠Fixtures

Run from apps/gitlab, tests/post-fixture.ts posts a fixture from tests/testdata to the webhook URL given as its second argument, with the webhook token, a fresh note id or updated_at and a fresh Idempotency-Key header. It runs on Node 26 as is, since Node strips the types:

GITLAB_WEBHOOK_TOKEN=... node tests/post-fixture.ts tests/testdata/note-merge-request.json https://bridge.example.com/v1/hooks/gitlab

⁠Development

The application lives in apps/gitlab of the workspace and runs on the shared core in packages/core; see the repository README.

pnpm install
pnpm lint
pnpm test
pnpm build
pnpm --filter @kilic.dev/hermes-bridge-gitlab start

Tag summary

Content type

Image

Digest

sha256:01e207697…

Size

74.3 MB

Last updated

7 days ago

docker pull cenk1cenk2/hermes-bridge-gitlab