Skip to content

notification-system.md

Latest commit

 

History

History
213 lines (152 loc) · 7.23 KB

notification-system.md

File metadata and controls

213 lines (152 loc) · 7.23 KB
title Notification System

Status

Implemented -- internal/channel/notifier.go, internal/channel/notify_tool.go, internal/channel/telegram/telegram.go.

Overview

Anna supports proactive notifications so the agent, scheduled jobs, and other internal triggers can push messages to users without waiting for a request. The system uses a multi-channel dispatcher that routes notifications to one or more configured channels (Telegram, QQ, WeChat, with Slack/Discord planned).

Architecture

+-------------------+
|  Agent (notify     |--+
|  tool call)        |  |
+-------------------+  |
                        |   Notification{Channel, ChatID, Text, Silent}
+-------------------+  |           |
|  Scheduler job result |--+----------v------------------+
+-------------------+  |      Dispatcher              |
                        |  +----------------------+   |
+-------------------+  |  | Route by Channel     |   |
|  Future triggers   |--+  | or broadcast all     |   |
+-------------------+     +----------+-----------+   |
                                     |               |
                        +------------+----------+    |
                        |            |          |    |
                        v            v          v    |
                  +----------+ +--------+ +-------+  |
                  | Telegram | | Slack  | |Discord|  |
                  | Channel  | |(future)| |(future)| |
                  +----------+ +--------+ +-------+  |

Key Types

channel.Notification

type Notification struct {
    Channel string // optional: route to specific backend ("telegram", "slack")
    ChatID  string // target chat/channel within the backend
    Text    string // markdown content
    Silent  bool   // send without notification sound
}
  • Channel empty -- broadcast to all registered channels
  • Channel set -- route to that specific channel only
  • ChatID empty -- resolved from auth identities via NotifyUser, or channel-specific fallback

channel.Channel

Interface that all messaging platforms implement:

type Channel interface {
    Name() string
    Start(ctx context.Context) error
    Stop()
    Notify(ctx context.Context, n Notification) error
}

Currently implemented: telegram.Bot, qq.Bot, weixin.Bot.

channel.Dispatcher

Routes notifications to registered channels:

d := channel.NewDispatcher()
d.Register(tgBot)   // telegram channel
d.Register(qqBot)   // qq channel

// Broadcast to all channels:
d.Notify(ctx, channel.Notification{Text: "hello"})

// Route to specific channel:
d.Notify(ctx, channel.Notification{Channel: "telegram", Text: "hello"})

// Specify target chat:
d.Notify(ctx, channel.Notification{Channel: "telegram", ChatID: "999", Text: "hello"})

Partial failures: if one channel fails during broadcast, the others still receive the notification. Errors are joined via errors.Join.

channel.NotifyTool

Agent-facing tool that wraps the dispatcher:

tool := channel.NewNotifyTool(dispatcher)

The LLM can call it with:

{
  "message": "Build finished, 3 tests failed",
  "channel": "telegram",
  "chat_id": "136345060",
  "silent": false
}
  • message (required) -- the notification text
  • channel (optional) -- target a specific channel; omit to broadcast
  • chat_id (optional) -- override the channel's default target
  • silent (optional) -- suppress notification sound

Wiring

Startup Flow (main.go)

setup()
  +-- Create Dispatcher
  +-- Create NotifyTool(dispatcher) -> builtinTools
  +-- Create runner factory with builtinTools
  +-- Create PoolManager

runGateway()
  +-- Create telegram.Bot
  +-- dispatcher.Register(tgBot)              <- channel registered
  +-- wireSchedulerNotifier(schedulerSvc, poolManager, dispatcher) <- scheduler output -> dispatcher
  +-- tgBot.Start(ctx)                        <- begin polling

The dispatcher is created early (in setup) so the notify tool can reference it. Channels are registered later (in runGateway) when they are created. This avoids circular dependencies. The wireSchedulerNotifier function routes through PoolManager rather than a single pool.

Cron to Notification

When a scheduled job fires:

  1. The job runs through PoolManager.Chat() using the job's agent_id and user_id to reach the correct agent
  2. The full response text is collected
  3. The text is broadcast via dispatcher.Notify() to all channels

No Channels Mode

When no notification channels are registered, the notify tool is not exposed to the agent. This avoids a broken tool path.

Configuration

Channel configuration is managed through the admin panel. Each channel's settings (tokens, chat IDs, group modes, allowed IDs) are stored as JSON in the database. Configure notification channels from the admin panel UI rather than editing configuration files directly.

Notify Target Resolution

For user-owned jobs, NotifyUser() resolves the target via auth_identities — each user's linked platform identity provides the chat ID. For system jobs, Notify() broadcasts to all registered channels using the explicit ChatID in the notification.

Adding a New Channel

To add Slack, Discord, or any other channel:

  1. Implement channel.Channel:
// channel/slack/slack.go
type Bot struct { ... }

func (b *Bot) Name() string                                          { return "slack" }
func (b *Bot) Start(ctx context.Context) error                       { /* start listening */ }
func (b *Bot) Stop()                                                 { /* graceful shutdown */ }
func (b *Bot) Notify(ctx context.Context, n channel.Notification) error {
    // Send n.Text to n.ChatID via Slack API
}

Use channel.NewCommander(pool, listFn, switchFn) for shared /new, /compact, /model command logic. /whoami is handled per-channel since each platform returns different ID formats. Use channel.SplitMessage() and channel.FormatDuration() for shared utilities.

  1. Register in runGateway():
if slackCfg.Token != "" {
    slackBot := slack.New(slackCfg)
    channels = append(channels, slackBot)
    s.notifier.Register(slackBot)
}
  1. Add channel config via the admin panel. Channel configuration is stored as JSON in the database settings table.

No changes needed to the dispatcher, notify tool, or scheduler wiring -- they work through the Channel interface.

Telegram-Specific Features

Group Support

The bot can operate in Telegram groups with configurable behavior:

  • mention (default) -- respond only when @mentioned or replied to
  • always -- respond to every message in the group
  • disabled -- ignore all group messages (including commands)

Session ID for groups = group chat ID (shared context per group).

Access Control

Access control is managed through the RBAC system. Users are authenticated via auth_identities when they send messages, and agent access is enforced by the policy engine. Use the admin panel to manage user roles and agent assignments.

Notification Delivery

telegram.Bot.Notify() supports:

  • Numeric chat IDs ("136345060")
  • Channel usernames ("@my_channel")
  • Markdown rendering with MarkdownV2 fallback to plain text
  • Message splitting at 4000-char boundaries
  • Silent mode (DisableNotification)