telegram-e2e-userbot

Files (56)

• SKILL.md
• openai.yaml · agents/
• README.md · features/
• basic-turns.md · features/
• delivery-lifecycle.md · features/
• dm-topics.md · features/
• private-yield-reply-policy.md · features/
• reaction-lifecycle.md · features/
• restart-attribution.md · features/
• runtime-reference.md · features/
• botfather-threaded-mode.mjs · scripts/
• botfather-threaded-mode.test.mjs · scripts/
• followup-drain-control-preload.mjs · scripts/
• followup-drain-control-preload.test.mjs · scripts/
• node-test-children.mjs · scripts/
• published-upgrade-artifact.mjs · scripts/
• published-upgrade-scenario.mjs · scripts/
• qa-credential-lease.mjs · scripts/
• qa-credential-lease.test.mjs · scripts/
• reply-policy-checkpoint.mjs · scripts/
• reply-policy-mock.mjs · scripts/
• run-mock-sut-user-e2e.mjs · scripts/
• run-mock-sut-user-e2e.test.mjs · scripts/
• run-published-upgrade-user-e2e.mjs · scripts/
• run-published-upgrade-user-e2e.test.mjs · scripts/
• run-reply-policy-user-e2e.mjs · scripts/
• scenario.mjs · scripts/
• scenario.test.mjs · scripts/
• telegram-api-ignore-abort-preload.mjs · scripts/
• telegram-api-ignore-abort-preload.test.mjs · scripts/
• telegram-binding-checkpoint.mjs · scripts/
• telegram-binding-checkpoint.test.mjs · scripts/
• telegram-binding-forum.py · scripts/
• telegram-binding-upgrade-verdict.mjs · scripts/
• telegram-run-composition.test.mjs · scripts/
• telegram-run-scope.mjs · scripts/
• telegram-runtime.mjs · scripts/
• telegram-runtime.test.mjs · scripts/
• telegram-test-api-proxy.mjs · scripts/
• telegram-test-api-proxy.test.mjs · scripts/
• telegram-test-credential.mjs · scripts/
• telegram-test-credential.test.mjs · scripts/
• telegram-test-doctor.mjs · scripts/
• telegram-test-doctor.test.mjs · scripts/
• telegram-test-group.mjs · scripts/
• telegram-test-group.test.mjs · scripts/
• telegram-test-recover.mjs · scripts/
• telegram-test-recover.test.mjs · scripts/
• telegram-test-scenario.test.mjs · scripts/
• triage-mock-openai.mjs · scripts/
• triage-mock-openai.test.mjs · scripts/
• user-driver.py · scripts/
• user-driver.test.py · scripts/
• user-proof-ownership.test.py · scripts/
• user-record.py · scripts/
• user-record.test.py · scripts/

SKILL.md (first lines)

# Telegram E2E (Userbot)

Prove the requested behavior as a dedicated Telegram Test Server user. TDLib
records edits, deletions, reactions, and typing that a second bot cannot observe.
For visual claims, also inspect actual Telegram client screenshots; a reconstructed
chat image or event log is not visual proof.

Each Convex credential contains one SUT bot and an independent authorization for
the QA user. The runner owns that lease through readiness, proof, and cleanup.
Pool creation, account authorization repair, and credential publication remain
owner-only. Reversible test-chat setup with the leased QA user is ordinary proof
work; preserve shared fixtures and other runs.

## 1. Prepare

Run from the OpenClaw checkout and ref under test, using its repository skill:

```bash
TELEGRAM_E2E_SKILL_DIR="${TELEGRAM_E2E_SKILL_DIR:-$PWD/.agents/skills/telegram-e2e-userbot}"
export TELEGRAM_E2E_SKILL_DIR
```

Verify `node`, `uv`, and a dependency-ready runtime for the exact ref before
leasing a credential. The runner uses built `dist/entry.js`; `--source-gateway`
uses the repository's development launcher when a dependency-ready source run
is appropriate. It runs core and the Telegram plugin from TypeScript source;
other plugins, including the model provider, use built output when it exists,
so rebuild before claiming their changes. The live run must not implicitly
install or build. Only the `mock` backend needs
`scripts/e2e/mock-openai-server.mjs`.

Convex access can come from either:

- An existing authenticated CLI with access to the published broker deployment.
  From `qa/convex-credential-broker`, discovery tries `convex`, then
  `bunx --no-install convex`, then `npx --offline --no --ignore-scripts convex`.
  Each launcher gets one 15-second `env --deployment <broker> get` lookup for
  the CI secret. The helper uses the repository's existing broker binding;
  no local `CONVEX_DEPLOYMENT`, project-selection file, or dashboard lookup is needed.
  The secret stays in process memory.
- Both `OPENCLAW_QA_CONVEX_SITE_URL` and `OPENCLAW_QA_CONVEX_SECRET_CI`, supplied
  privately to the doctor or runner process by the existing credential owner.

Check available launchers, existing authentication, and broker-project access
before declaring credentials missing. An authenticated launcher with
no CI variable needs broker configuration, not another login. Ask the user for
authentication only when no existing launcher can authenticate and the broker
pair is unavailable. Do not install or log in on the user's behalf. A timeout or
network failure is not evidence that credentials are missing.
Bun's `--no-install` missing-binary error means that launcher is unavailable;
discovery continues to the next installed launcher.

The standalone doctor needs no local HTTP listener, Gateway build, or model
backend: it checks the leased TDLib user and calls Telegram’s official Test Bot
API directly over HTTPS. The full scenario still needs local networking for its
Gateway and Test Bot API adapter (including hold/reject controls), plus the mock
provider when selected. A passing doctor does not qualify those local services.

For a full scenario on shared hosts, select two unused ports and pass them
explicitly; the runner does not read port environment variables:

```bash
: "${TELEGRAM_GATEWAY_PORT:?set an unused Gateway port}"
: "${TELEGRAM_MOCK_PORT:?set an unused provider port}"
```

## 2. Select the proof

Read [the verification map](features/README.md), then only the recipe for the
behavior under test. Prefer a DM; use groups for group policy, mentions,
commands, group topics, or reactions. For a group-topic proof without a prepared
forum, `--create-forum` gives the scenario a run-owned topic that cleanup deletes.
A generic success turn does not prove formatting, media, timing, or lifecycle
behavior.

Extend the harness when its current actions or recorder fields cannot expose the
claim. Scenario `command` actions can inspect the leased TDLib state, private
credential file, Test Bot API proxy, and Gateway state. Use the
[runtime reference](features/runtime-reference.md) for timed scenarios, forums,
photo/reply actions, non-default backends, manual operation, or failed-run recovery.

## 3. Check readiness and run

The scenario checks its actual user, bot, transport, and selected chat on its own
lease before starting the Gateway. DMs do not depend on unrelated groups. Group
runs verify bot membership, privacy, and tester text permissions, preserving a
suitable selected group or preparing a run-owned one when needed. Readiness from
a released lease never qualifies a later run.

For a standalone diagnostic, use:

```bash
node "$TELEGRAM_E2E_SKILL_DIR/scripts/telegram-test-doctor.mjs"
```

Require `ok: true`, `botApiTransport: "direct-https"`, and `botApiProxy: false`.
The doctor defaults to DM readiness; `--chat <target>` checks a selected group
through the same direct Test Bot API route. It releases its diagnostic lease
and does not start product
proof. Preserve setup failures and repair their cause before trying again;
rotating unchanged credentials to hunt for a pass is not a repair.

Create a durable proof directory outside runner scratch:

```bash
TELEGRAM_E2E_PROOF_DIR="$(mktemp -d /tmp/telegram-e2e-proof.XXXXXX)"
node "$TELEGRAM_E2E_SKILL_DIR/scripts/run-mock-sut-user-e2e.mjs" \
  --gateway-port "$TELEGRAM_GATEWAY_PORT" --mock-port "$TELEGRAM_MOCK_PORT" \
  --dm --text 'Please answer with OPENCLAW_E2E_OK only.' \
  --record "$TELEGRAM_E2E_PROOF_DIR/events.ndjson" \
  --output "$TELEGRAM_E2E_PROOF_DIR/summary.json"
```

The runner owns the lease, proxy, fresh Gateway, provider, user actions, recorder,
and teardown. Recording captures facts and rejects probe assertions such as
`--expect` and `--any-sut-reply`. A send-confirmation timeout can follow an accepted
send: preserve observed events and reconcile them, rather than blindly resending.

## 4. Judge and clean up

From openclaw/openclaw, MIT.

More from openclaw/openclaw