README
- ::outputNotifyError::output
- ::to_reprNotifyError::to_repr
- ::to_stringNotifyError::to_string
- ::to_reprSmtpFailed::to_repr
- ::defaultContext::default
- ::to_reprContext::to_repr
T
DedupeEntry
- ::to_reprDelivery::to_repr
- ::equalEmitOutcome::equal
- ::not_equalEmitOutcome::not_equal
- ::to_reprEmitOutcome::to_repr
- ::droppedEngine::dropped
- ::emitEngine::emit
- ::newEngine::new
- ::pumpEngine::pump
- ::queuedEngine::queued
- ::newMessage::new
- ::to_reprMessage::to_repr
- ::equalPumpOutcome::equal
- ::not_equalPumpOutcome::not_equal
- ::to_reprPumpOutcome::to_repr
- ::to_reprPumpReport::to_repr
T
Queued
- ::to_reprTarget::to_repr
V
deliver
V
deliver_all
V
smtp_deliver

notify

MoonBit 通知库:多平台 webhook(飞书/钉钉/企业微信/Slack/Discord)、通用 webhook、SMTP 邮件,含去重/限流/重试引擎

notify

webhook

feishu

dingtalk

smtp

Download zip

Author

chensuiyi

Version

0.3.0

License

MIT

Repository

github.com/chenbimo/moonbit

Last updated

8 hours ago

Downloads

Dependencies

moonbitlang/async0.22.4
moonbitlang/x0.5.1

#chensuiyi/notify

MoonBit 多平台通知库 · Multi-platform notification library for MoonBit

#简介

一个库覆盖通知的完整链路:消息模型、七种平台预设、HTTP/SMTP 投递,以及可选的去重/限流/重试引擎。

设计约定:

凭据不泄露——失败原因永不包含 url / secret / password,可放心打进日志
时间由调用方注入——库不读时钟,完全可测
不写日志不落盘——只投递并返回结构化结果

#Intro

One library for the whole notification path: a message model, seven platform presets, HTTP/SMTP delivery, and an optional dedupe / rate-limit / retry engine.

Design contract:

Credential-free failures — failure reasons never contain url / secret / password, safe to log
Caller-injected time — the library never reads a clock, fully testable
No logging, no disk — delivers and returns structured results

#平台 Platforms

preset	平台 Platform	传输 Transport
feishu	飞书	HTTPS(可选签名)
dingtalk	钉钉	HTTPS(HMAC 签名)
wecom	企业微信	HTTPS
slack	Slack	HTTPS
discord	Discord	HTTPS
webhook	通用 webhook	HTTPS(Bearer)
email	邮件	SMTP(STARTTLS / smtps)

#用法 Usage

// 一次性投递:None = 成功,Some(reason) = 失败原因(不含凭据)
let failure = deliver(target, msg, 5000, { host: "prod-1", product: "myapp" })

// 可选引擎:去重 → 限流 → 队列 → 失败退避重试
let engine = Engine::new({ host: "prod-1", product: "myapp" })
engine.emit(
  now, "crash|api", "api", msg, targets, 5000,
  dedupe_window_s=3600, rate_per_minute=30, queue_limit=128,
)
let report = engine.pump(now) // 每 tick 调用一次

#API

接口	说明
deliver(target, msg, timeout_ms, ctx)	投递一条消息到单个目标
deliver_all(targets, msg, timeout_ms, ctx)	逐个投递,返回 (name, failure) 列表
Engine::new(ctx, max_attempts?)	创建引擎
Engine::emit(...)	入队一条消息,返回 Queued / Deduped / RateLimited / QueueFull
Engine::pump(now)	投递队首消息,返回 remaining / outcome / owner
Engine::dropped() / Engine::queued()	丢弃与排队计数

限流窗口按 owner 独立,计数发生在入队时——失败端点不会绕过限流。

#依赖 Dependencies

moonbitlang/async@0.22.4(HTTP / SMTP / 超时)
moonbitlang/x@0.5.1(HMAC 签名)

License: MIT

NotifyError

source

pub suberror NotifyError {
  InvalidPreset(String)
} derive(@moonbitlang/core/debug.Debug
Debug)

impl Show for NotifyError

NotifyError::output

source

fn NotifyError::output(self : NotifyError, logger : &Logger) -> Unit

NotifyError::to_repr

source

fn NotifyError::to_repr(NotifyError) -> @moonbitlang/core/debug.Repr
Repr

NotifyError::to_string

source

fn NotifyError::to_string(self : NotifyError) -> String

SmtpFailed

source

type SmtpFailed derive(@moonbitlang/core/debug.Debug
Debug)

SMTP-level failures. Messages never contain credentials: they carry the stage and the server's status line, which is what an operator needs.

SmtpFailed::to_repr

source

fn SmtpFailed::to_repr(SmtpFailed) -> @moonbitlang/core/debug.Repr
Repr

Context

source

pub(all) struct Context {
  host : String
  product : String
} derive(@moonbitlang/core/debug.Debug
Debug)

Who is sending: appears in message footers (product @ host) and in the SMTP EHLO greeting. Passed in by the caller so the library stays platform-agnostic.

Context::default

source

fn Context::default() -> Context

The default context for callers that do not care about branding.

Context::to_repr

source

fn Context::to_repr(Context) -> @moonbitlang/core/debug.Repr
Repr

DedupeEntry

source

type DedupeEntry

Delivery

source

pub(all) struct Delivery {
  url : String
  http_method : String
  content_type : String?
  headers : Array[(String, String)]
  body : String
  mail : String?
} derive(@moonbitlang/core/debug.Debug
Debug)

A rendered request: what the transport hands to the network. Kept separate from the message so one message can be rendered per target.

Delivery::to_repr

source

fn Delivery::to_repr(Delivery) -> @moonbitlang/core/debug.Repr
Repr

EmitOutcome

source

pub(all) enum EmitOutcome {
  Queued
  Deduped(count~ : Int)
  RateLimited
  QueueFull
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What happened to one emit call.

EmitOutcome::equal

source

fn EmitOutcome::equal(EmitOutcome, EmitOutcome) -> Bool

EmitOutcome::not_equal

source

fn EmitOutcome::not_equal(x : EmitOutcome, y : EmitOutcome) -> Bool

EmitOutcome::to_repr

source

fn EmitOutcome::to_repr(EmitOutcome) -> @moonbitlang/core/debug.Repr
Repr

Engine

source

pub struct Engine {
  ctx : Context
  max_attempts : Int
  queue : Array[Queued]
  dropped : Int
  rate_window : Map[String, (UInt64, Int)]
  dedupe : Map[String, DedupeEntry]
  next_attempt_ms : UInt64
  attempts : Int
}

Engine::dropped

source

fn Engine::dropped(self : Engine) -> Int

Messages dropped since the engine was created: queue overflow plus rate limiting.

Engine::emit

source

fn Engine::emit(self : Engine, now : UInt64, key : String, owner : String, msg : Message, targets : Array[Target], timeout_ms : Int, dedupe_window_s? : Int, rate_per_minute? : Int, queue_limit? : Int) -> EmitOutcome

Queue one message. Deduplication, rate limiting and queue accounting are all driven by the parameters — the engine keeps no policy of its own.

key deduplicates identical conditions inside dedupe_window_s.
owner + queue_limit keep a burst from one group from starving others: once queue_limit messages of owner are queued, further ones drop.
rate_per_minute caps emissions per rolling 60s window (0 = unlimited).

Engine::new

source

fn Engine::new(ctx : Context, max_attempts? : Int) -> Engine

Create an engine. ctx brands the outgoing messages (footer and EHLO name); max_attempts is how many delivery passes one message gets before it is dropped.

Engine::pump

source

async fn Engine::pump(self : Engine, now : UInt64) -> PumpReport

One pass of the engine: deliver at most one queued message.

Engine::queued

source

fn Engine::queued(self : Engine) -> Int

Number of messages still queued.

Message

source

pub(all) struct Message {
  event : String
  level : String
  title : String
  body : String
  fields : Array[(String, String)]
  ts_ms : UInt64
  key : String
} derive(@moonbitlang/core/debug.Debug
Debug)

One notification. key is what deduplication keys on; event is the logical event name carried through to generic webhook payloads.

Message::new

source

fn Message::new(event : String, level : String, title : String, body : String, key : String, ts_ms : UInt64, fields? : Array[(String, String)]) -> Message

Message::to_repr

source

fn Message::to_repr(Message) -> @moonbitlang/core/debug.Repr
Repr

PumpOutcome

source

pub(all) enum PumpOutcome {
  Idle
  Delivered
  Partial
  Failed(attempt~ : Int)
  Exhausted
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What one pump pass did with the head of the queue.

PumpOutcome::equal

source

fn PumpOutcome::equal(PumpOutcome, PumpOutcome) -> Bool

PumpOutcome::not_equal

source

fn PumpOutcome::not_equal(x : PumpOutcome, y : PumpOutcome) -> Bool

PumpOutcome::to_repr

source

fn PumpOutcome::to_repr(PumpOutcome) -> @moonbitlang/core/debug.Repr
Repr

PumpReport

source

pub(all) struct PumpReport {
  remaining : Int
  outcome : PumpOutcome
  owner : String?
} derive(@moonbitlang/core/debug.Debug
Debug)

PumpReport::to_repr

source

fn PumpReport::to_repr(PumpReport) -> @moonbitlang/core/debug.Repr
Repr

Queued

source

type Queued

Target

source

pub(all) struct Target {
  name : String
  preset : String
  url : String
  secret : String?
  format : String?
  from : String?
  to : Array[String]?
  username : String?
  password : String?
} derive(@moonbitlang/core/debug.Debug
Debug)

One delivery destination. preset selects the payload shape (a closed set: feishu / dingtalk / wecom / slack / discord / webhook / email); the rest are endpoint and credential fields.

Target::to_repr

source

fn Target::to_repr(Target) -> @moonbitlang/core/debug.Repr
Repr

deliver

source

async fn deliver(target : Target, msg : Message, timeout_ms : Int, ctx : Context) -> String?

Deliver one message to one target.

deliver_all

source

async fn deliver_all(targets : Array[Target], msg : Message, timeout_ms : Int, ctx : Context) -> Array[(String, String?)]

Deliver one message to many targets, one request each, sequentially. Returns (target name, failure) pairs in input order.

smtp_deliver

source

async fn smtp_deliver(target : Target, delivery : Delivery, mail : String, ehlo_name : String, timeout_ms : Int) -> String?

Deliver one RFC5322 message over SMTP with STARTTLS (or implicit TLS for smtps://). None on acceptance; Some carries a credential-free reason.

Source Files

Site source Report issue Packages Build queue Skills Statistics

notify

#chensuiyi/notify

#简介

#Intro

#平台 Platforms

#用法 Usage

#API

#依赖 Dependencies

#NotifyError

#NotifyError::output

#NotifyError::to_repr

#NotifyError::to_string

#SmtpFailed

#SmtpFailed::to_repr

#Context

#Context::default

#Context::to_repr

#DedupeEntry

#Delivery

#Delivery::to_repr

#EmitOutcome

#EmitOutcome::equal

#EmitOutcome::not_equal

#EmitOutcome::to_repr

#Engine

#Engine::dropped

#Engine::emit

#Engine::new

#Engine::pump

#Engine::queued

#Message

#Message::new

#Message::to_repr

#PumpOutcome

#PumpOutcome::equal

#PumpOutcome::not_equal

#PumpOutcome::to_repr

#PumpReport

#PumpReport::to_repr

#Queued

#Target

#Target::to_repr

#deliver

#deliver_all

#smtp_deliver

Source Files

NotifyError

NotifyError::output

NotifyError::to_repr

NotifyError::to_string

SmtpFailed

SmtpFailed::to_repr

Context

Context::default

Context::to_repr

DedupeEntry

Delivery

Delivery::to_repr

EmitOutcome

EmitOutcome::equal

EmitOutcome::not_equal

EmitOutcome::to_repr

Engine

Engine::dropped

Engine::emit

Engine::new

Engine::pump

Engine::queued

Message

Message::new

Message::to_repr

PumpOutcome

PumpOutcome::equal

PumpOutcome::not_equal

PumpOutcome::to_repr

PumpReport

PumpReport::to_repr

Queued

Target

Target::to_repr

deliver

deliver_all

smtp_deliver