ready
" { + t.Fatalf("rich_message = %#v", gotBody["rich_message"]) + } + if _, exists := rich["skip_entity_detection"]; exists { + t.Fatalf("rich_message unexpectedly disables entity detection: %#v", rich) + } +} + +func TestRichAnswerRejectsInvalidBlocksWithoutRequest(t *testing.T) { + client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) { + t.Fatal("unexpected HTTP request") + return nil, nil + })} + api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client)) + defer func() { _ = api.Close() }() + ctx := &MessageContext{ + API: api, + Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}}, + Logger: sneklog.NewLogger(), + } + + if answer := ctx.RichAnswer(tgrich.H(tgrich.Text("invalid"), 0)); answer != nil { + t.Fatal("RichAnswer() returned an answer for an invalid heading") + } +} + func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) { var gotBody map[string]any diff --git a/observer.go b/observer.go index 4ea52e1..eb37bc7 100644 --- a/observer.go +++ b/observer.go @@ -16,6 +16,8 @@ const ( HandlerCommandKind HandlerEventKind = "command" // HandlerMessageKind identifies a message fallback handler. HandlerMessageKind HandlerEventKind = "message" + // HandlerMiddlewareKind identifies middleware execution. + HandlerMiddlewareKind HandlerEventKind = "middleware" // HandlerPayloadKind identifies a callback payload handler. HandlerPayloadKind HandlerEventKind = "payload" // HandlerUpdateKind identifies a generic update handler. @@ -41,6 +43,24 @@ type Event interface { isEvent() } +func emitContextError(ctx *MessageContext, event ErrorEvent) { + if ctx == nil { + return + } + if ctx.Logger != nil { + ctx.Logger.Errorln(event.Err) + } + if ctx.observer == nil { + return + } + defer func() { + if recovered := recover(); recovered != nil && ctx.Logger != nil { + ctx.Logger.Errorln(fmt.Sprintf("panic in observer: %v", recovered)) + } + }() + ctx.observer.OnError(ctx.Context(), event) +} + // UpdateReceivedEvent describes an update entering the bot runtime. type UpdateReceivedEvent struct { UpdateID int @@ -162,9 +182,15 @@ func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) { } defer func() { if r := recover(); r != nil { - bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r)) + if bot.logger != nil { + bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r)) + } } }() + bot.emitEvent(ctx, event) +} + +func (bot *Bot[T]) emitEvent(ctx context.Context, event Event) { switch e := event.(type) { case UpdateReceivedEvent: bot.observer.OnUpdateReceived(ctx, e) diff --git a/plugins.go b/plugins.go index 122a137..7f759d0 100644 --- a/plugins.go +++ b/plugins.go @@ -2,6 +2,7 @@ package laniakea import ( "errors" + "fmt" "git.scuroneko.dev/scuroneko/extypes" "git.scuroneko.dev/scuroneko/laniakea/tgapi" @@ -292,6 +293,9 @@ func (p *Plugin[T]) executeMiddlewares(ctx *MessageContext, db T) bool { // If async, return value is ignored. type MiddlewareExecutor[T AppData] func(ctx *MessageContext, db T) bool +// ErrMiddlewareExecutorNil reports an attempt to execute middleware without a callback. +var ErrMiddlewareExecutorNil = errors.New("middleware executor is nil") + // Middleware represents a reusable execution interceptor. // Can be synchronous (blocking) or asynchronous (non-blocking). type Middleware[T AppData] struct { @@ -306,7 +310,7 @@ func NewMiddleware[T AppData](name string, executor MiddlewareExecutor[T]) Middl return Middleware[T]{name, executor, 0, false} } -// SetOrder sets the execution order (currently ignored). +// SetOrder sets the bot-level middleware execution order. func (m Middleware[T]) SetOrder(order int) Middleware[T] { m.order = order return m @@ -330,12 +334,38 @@ func (m Middleware[T]) SetAsync(async bool) Middleware[T] { // must treat those fields as read-only — mutating them races the sync chain // that mutates the same context concurrently. func (m Middleware[T]) Execute(ctx *MessageContext, db T) bool { + if m.executor == nil { + reportMiddlewareError(ctx, m.name, ErrMiddlewareExecutorNil) + return false + } if m.async { ctxCopy := *ctx go func(ctx MessageContext) { + defer func() { + if recovered := recover(); recovered != nil { + reportMiddlewareError(&ctx, m.name, fmt.Errorf("middleware %q panicked: %v", m.name, recovered)) + } + }() m.executor(&ctx, db) }(ctxCopy) return true } return m.executor(ctx, db) } + +func reportMiddlewareError(ctx *MessageContext, name string, err error) { + event := ErrorEvent{ + Plugin: "bot", + HandlerKind: HandlerMiddlewareKind, + HandlerName: name, + Err: err, + UserFacing: false, + } + if ctx != nil { + event.UpdateID = ctx.Update.UpdateID + event.UpdateType = ctx.Update.Type + event.FromID = ctx.FromID + event.ChatID = ctx.ChatID + } + emitContextError(ctx, event) +} diff --git a/plugins_test.go b/plugins_test.go index 037b4a3..b02216f 100644 --- a/plugins_test.go +++ b/plugins_test.go @@ -1,10 +1,65 @@ package laniakea import ( + "context" "errors" "testing" + "time" + + "git.scuroneko.dev/scuroneko/laniakea/tgapi" ) +type middlewareErrorObserver struct { + testObserver + errors chan ErrorEvent +} + +func (o *middlewareErrorObserver) OnError(_ context.Context, event ErrorEvent) { + o.errors <- event +} + +func TestAsyncMiddlewareRecoversPanic(t *testing.T) { + observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)} + ctx := &MessageContext{ + Update: tgapi.Update{UpdateID: 7, Type: tgapi.UpdateTypeMessage}, + FromID: 42, + ChatID: 100, + observer: observer, + } + middleware := NewMiddleware[NoData]("panic", func(ctx *MessageContext, db NoData) bool { + panic("boom") + }).SetAsync(true) + + if !middleware.Execute(ctx, NoData{}) { + t.Fatal("async middleware blocked execution") + } + select { + case event := <-observer.errors: + if event.HandlerKind != HandlerMiddlewareKind || event.HandlerName != "panic" { + t.Fatalf("unexpected error event: %#v", event) + } + if event.Err == nil { + t.Fatal("panic error was not reported") + } + case <-time.After(time.Second): + t.Fatal("timed out waiting for async middleware error") + } +} + +func TestMiddlewareRejectsNilExecutor(t *testing.T) { + observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)} + ctx := &MessageContext{observer: observer} + middleware := NewMiddleware[NoData]("nil", nil) + + if middleware.Execute(ctx, NoData{}) { + t.Fatal("nil middleware executor was accepted") + } + event := <-observer.errors + if !errors.Is(event.Err, ErrMiddlewareExecutorNil) { + t.Fatalf("error = %v, want ErrMiddlewareExecutorNil", event.Err) + } +} + func TestValidateArgsRequiresFullMatch(t *testing.T) { intCmd := NewCommand("int", func(ctx *MessageContext, db NoData) error { return nil }, NewCommandArg("n").SetValueType(CommandValueInt).SetRequired()) if err := intCmd.validateArgs([]string{"123"}); err != nil { diff --git a/runners.go b/runners.go index f6ec4a1..91d2f5c 100644 --- a/runners.go +++ b/runners.go @@ -2,6 +2,7 @@ package laniakea import ( "context" + "fmt" "time" ) @@ -27,6 +28,18 @@ type Runner[T AppData] struct { fn RunnerFn[T] // The function to execute } +func executeRunner[T AppData](runner Runner[T], bot *Bot[T]) (err error) { + defer func() { + if recovered := recover(); recovered != nil { + err = fmt.Errorf("runner %q panicked: %v", runner.name, recovered) + } + }() + if runner.fn == nil { + return fmt.Errorf("runner %q has no function", runner.name) + } + return runner.fn(bot) +} + // NewRunner creates a new Runner with the given name and function. // // The default configuration is async=true and every=0, i.e. a one-shot @@ -34,12 +47,7 @@ type Runner[T AppData] struct { // to customize this. Do not call builder methods concurrently or after the // bot runtime has begun executing runners. func NewRunner[T AppData](name string, fn RunnerFn[T]) Runner[T] { - return Runner[T]{ - name: name, - fn: fn, - async: true, - every: 0, - } + return Runner[T]{name: name, fn: fn, async: true, every: 0} } // Async sets whether the runner executes synchronously or asynchronously. @@ -89,7 +97,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) { go func(r Runner[T]) { defer bot.runnerOnceWG.Done() startedAt := time.Now() - err := r.fn(bot) + err := executeRunner(r, bot) bot.safeEmitEvent(ctx, RunnerFinishedEvent{ Name: r.name, Duration: time.Since(startedAt), @@ -109,7 +117,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) { } else if runner.every == 0 && !runner.async { // One-time sync: block until done t := time.Now() - err := runner.fn(bot) + err := executeRunner(runner, bot) elapsed := time.Since(t) bot.safeEmitEvent(ctx, RunnerFinishedEvent{ Name: runner.name, @@ -150,7 +158,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) { return } startedAt := time.Now() - err := r.fn(bot) + err := executeRunner(r, bot) bot.safeEmitEvent(ctx, RunnerFinishedEvent{ Name: r.name, Duration: time.Since(startedAt), diff --git a/runners_test.go b/runners_test.go index 496df4d..fe423c8 100644 --- a/runners_test.go +++ b/runners_test.go @@ -95,3 +95,30 @@ func TestExecRunnersEmitObserverEvents(t *testing.T) { t.Fatalf("unexpected runner error event: %#v", got) } } + +func TestExecRunnersRecoversRunnerPanic(t *testing.T) { + observer := &runnerObserver{} + bot := &Bot[NoData]{ + logger: sneklog.NewLogger(), + observer: observer, + runners: []Runner[NoData]{ + NewRunner("panic", func(*Bot[NoData]) error { + panic("boom") + }).Async(false), + }, + } + defer func() { + if err := bot.logger.Close(); err != nil { + t.Fatalf("Close returned error: %v", err) + } + }() + + bot.ExecRunners(context.Background()) + + if len(observer.runners) != 1 || observer.runners[0].Err == nil { + t.Fatalf("expected recovered panic in runner event, got %#v", observer.runners) + } + if len(observer.errors) != 1 || observer.errors[0].Err == nil { + t.Fatalf("expected recovered panic in error event, got %#v", observer.errors) + } +} diff --git a/scene.go b/scene.go index 1bd17a4..baad8fd 100644 --- a/scene.go +++ b/scene.go @@ -1,6 +1,7 @@ package laniakea import ( + "bytes" "encoding/json" "maps" "sync" @@ -131,18 +132,17 @@ type SceneSession struct { Scene string // Step is the current step name inside the active scene. Step string - // data stores opaque session payload bytes, typically JSON. data []byte } // SetData stores arbitrary opaque session data. func (s *SceneSession) SetData(data []byte) { - s.data = data + s.data = bytes.Clone(data) } // GetData returns the raw session data payload. func (s *SceneSession) GetData() []byte { - return s.data + return bytes.Clone(s.data) } // HasData reports whether the session has a non-empty data payload. @@ -198,6 +198,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) { s.mu.RLock() defer s.mu.RUnlock() if session, ok := s.store[key]; ok { + session.data = bytes.Clone(session.data) return session, nil } return SceneSession{}, nil @@ -205,6 +206,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) { // Set stores session under key. func (s *MemorySessionStore) Set(key string, session SceneSession) error { + session.data = bytes.Clone(session.data) s.mu.Lock() s.store[key] = session s.mu.Unlock() diff --git a/scene_locks.go b/scene_locks.go new file mode 100644 index 0000000..5b01f0d --- /dev/null +++ b/scene_locks.go @@ -0,0 +1,80 @@ +package laniakea + +import ( + "sort" + "sync" +) + +type sceneLockEntry struct { + mu sync.Mutex + refs int +} + +type sceneKeyLocker struct { + mu sync.Mutex + entries map[string]*sceneLockEntry +} + +func (l *sceneKeyLocker) lock(keys []string) func() { + keys = uniqueSortedStrings(keys) + if len(keys) == 0 { + return func() {} + } + + l.mu.Lock() + if l.entries == nil { + l.entries = make(map[string]*sceneLockEntry) + } + entries := make([]*sceneLockEntry, len(keys)) + for i, key := range keys { + entry := l.entries[key] + if entry == nil { + entry = new(sceneLockEntry) + l.entries[key] = entry + } + entry.refs++ + entries[i] = entry + } + l.mu.Unlock() + + for _, entry := range entries { + entry.mu.Lock() + } + + return func() { + for i := len(entries) - 1; i >= 0; i-- { + entries[i].mu.Unlock() + } + + l.mu.Lock() + for i, key := range keys { + entries[i].refs-- + if entries[i].refs == 0 { + delete(l.entries, key) + } + } + l.mu.Unlock() + } +} + +func uniqueSortedStrings(values []string) []string { + sort.Strings(values) + result := values[:0] + for _, value := range values { + if value == "" || len(result) > 0 && result[len(result)-1] == value { + continue + } + result = append(result, value) + } + return result +} + +func sceneKeysForContext(ctx *MessageContext) []string { + keys := make([]string, 0, 3) + for _, scope := range []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser} { + if key, ok := buildSceneKey(scope, ctx); ok { + keys = append(keys, key) + } + } + return keys +} diff --git a/scene_test.go b/scene_test.go index db34f82..25e44da 100644 --- a/scene_test.go +++ b/scene_test.go @@ -3,7 +3,10 @@ package laniakea import ( "context" "errors" + "sync" + "sync/atomic" "testing" + "time" "git.scuroneko.dev/scuroneko/laniakea/tgapi" "git.scuroneko.dev/scuroneko/sneklog/v2" @@ -41,6 +44,114 @@ func TestPluginAddSceneRegistersScene(t *testing.T) { } } +func TestBotAddPluginsSkipsDuplicateSceneNames(t *testing.T) { + first := NewPlugin[NoData]("first") + first.Scene("shared") + second := NewPlugin[NoData]("second") + second.Scene("shared") + + bot := &Bot[NoData]{logger: sneklog.NewLogger()} + bot.AddPlugins(first, second) + + if _, ok := bot.plugins[0].scenes["shared"]; !ok { + t.Fatal("first registered scene was removed") + } + if _, ok := bot.plugins[1].scenes["shared"]; ok { + t.Fatal("duplicate scene was registered") + } +} + +func TestSceneUpdatesForSameSessionAreSerialized(t *testing.T) { + entered := make(chan int, 2) + releaseFirst := make(chan struct{}) + var calls atomic.Int64 + + plugin := NewPlugin[NoData]("wizard") + plugin.Scene("counter"). + SetEntry("start"). + OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) { + var value int + if err := ctx.BindData(&value); err != nil { + return SceneResult{}, err + } + call := int(calls.Add(1)) + entered <- call + if call == 1 { + <-releaseFirst + } + value++ + if err := ctx.SaveData(value); err != nil { + return SceneResult{}, err + } + return ctx.Stay(), nil + }) + + bot := &Bot[NoData]{ + logger: sneklog.NewLogger(), + prefixes: []string{"/"}, + sessionStore: NewMemorySessionStore(), + sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser}, + } + bot.AddPlugins(plugin) + key := "user_id:42:chat_id:100" + session := SceneSession{Scene: "counter", Step: "start"} + if err := session.SaveData(0); err != nil { + t.Fatalf("SaveData returned error: %v", err) + } + if err := bot.sessionStore.Set(key, session); err != nil { + t.Fatalf("Set returned error: %v", err) + } + + update := func(id int) *tgapi.Update { + return &tgapi.Update{ + UpdateID: id, + Type: tgapi.UpdateTypeMessage, + Message: &tgapi.Message{ + MessageID: id, + Text: "increment", + Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}, + From: &tgapi.User{ID: 42}, + }, + } + } + + var wg sync.WaitGroup + wg.Add(2) + go func() { + defer wg.Done() + bot.handle(context.Background(), update(1)) + }() + if got := <-entered; got != 1 { + t.Fatalf("first handler call = %d, want 1", got) + } + go func() { + defer wg.Done() + bot.handle(context.Background(), update(2)) + }() + select { + case call := <-entered: + t.Fatalf("second handler entered before first completed: call %d", call) + case <-time.After(50 * time.Millisecond): + } + close(releaseFirst) + if got := <-entered; got != 2 { + t.Fatalf("second handler call = %d, want 2", got) + } + wg.Wait() + + got, err := bot.sessionStore.Get(key) + if err != nil { + t.Fatalf("Get returned error: %v", err) + } + var value int + if err := got.BindData(&value); err != nil { + t.Fatalf("BindData returned error: %v", err) + } + if value != 2 { + t.Fatalf("session value = %d, want 2", value) + } +} + func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) { called := false @@ -836,6 +947,36 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) { } } +func TestMemorySessionStoreDoesNotAliasSessionData(t *testing.T) { + store := NewMemorySessionStore() + input := []byte("initial") + session := SceneSession{Scene: "signup"} + session.SetData(input) + + input[0] = 'X' + if got := string(session.GetData()); got != "initial" { + t.Fatalf("SetData retained caller slice: got %q", got) + } + if err := store.Set("user:1", session); err != nil { + t.Fatalf("Set returned error: %v", err) + } + + first, err := store.Get("user:1") + if err != nil { + t.Fatalf("Get returned error: %v", err) + } + data := first.GetData() + data[0] = 'X' + + second, err := store.Get("user:1") + if err != nil { + t.Fatalf("second Get returned error: %v", err) + } + if got := string(second.GetData()); got != "initial" { + t.Fatalf("Get exposed stored data for mutation: got %q", got) + } +} + func TestFindSceneSessionSupportsUserScopeWithoutMessage(t *testing.T) { bot := &Bot[NoData]{ logger: sneklog.NewLogger(), diff --git a/tgapi/api.go b/tgapi/api.go index ae4e8f6..4261fc8 100644 --- a/tgapi/api.go +++ b/tgapi/api.go @@ -236,7 +236,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro req.Body = io.NopCloser(buf) req.ContentLength = int64(len(reqData)) - api.logger.Debugln("REQ", url, string(reqData)) + api.logger.Debugln("REQ", url, redactRequestLog(reqData)) resp, err := api.client.Do(req) if err != nil { return zero, fmt.Errorf("HTTP request failed: %w", err) @@ -248,7 +248,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro return zero, fmt.Errorf("failed to read response body: %w", err) } - api.logger.Debugln("RES", r.method, string(respData)) + api.logger.Debugln("RES", responseLogSummary(r.method, len(respData))) response, err := parseBody[R](respData) if err != nil { @@ -269,7 +269,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro // Apply cooldown to global or chat-specific limiter if api.Limiter != nil { - if r.chatID > 0 { + if r.chatID != 0 { api.Limiter.SetChatLock(r.chatID, after) } else { api.Limiter.SetGlobalLock(after) diff --git a/tgapi/api101_test.go b/tgapi/api101_test.go index d21549c..05b4ca9 100644 --- a/tgapi/api101_test.go +++ b/tgapi/api101_test.go @@ -64,6 +64,100 @@ func TestInputRichMessageContentMarshal(t *testing.T) { } } +func TestInputRichMessageMediaMarshal(t *testing.T) { + message := InputRichMessage{ + HTML: ``, + Media: []InputRichMessageMedia{{ + ID: "intro", + Media: InputMedia{Type: InputMediaTypeVideo, Media: "attach://intro"}, + }}, + } + data, err := json.Marshal(message) + if err != nil { + t.Fatalf("Marshal returned error: %v", err) + } + + var got struct { + Media []struct { + ID string `json:"id"` + Media InputMedia `json:"media"` + } `json:"media"` + } + if err := json.Unmarshal(data, &got); err != nil { + t.Fatalf("Unmarshal returned error: %v", err) + } + if len(got.Media) != 1 || got.Media[0].ID != "intro" { + t.Fatalf("unexpected media: %+v", got.Media) + } + if got.Media[0].Media.Type != InputMediaTypeVideo || got.Media[0].Media.Media != "attach://intro" { + t.Fatalf("unexpected embedded media: %+v", got.Media[0].Media) + } +} + +func TestEphemeralMethodsMarshalReceiverUserID(t *testing.T) { + cases := []struct { + name string + params any + }{ + {"edit text", EditEphemeralMessageText{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Text: "updated"}}, + {"edit media", EditEphemeralMessageMedia{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Media: InputMedia{Type: InputMediaTypePhoto, Media: "photo-id"}}}, + {"edit caption", EditEphemeralMessageCaption{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Caption: "updated"}}, + {"edit markup", EditEphemeralMessageReplyMarkup{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}}, + {"delete", DeleteEphemeralMessage{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}}, + } + + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + data, err := json.Marshal(tt.params) + if err != nil { + t.Fatalf("Marshal returned error: %v", err) + } + var fields map[string]json.RawMessage + if err := json.Unmarshal(data, &fields); err != nil { + t.Fatalf("Unmarshal returned error: %v", err) + } + if _, ok := fields["receiver_user_id"]; !ok { + t.Fatalf("receiver_user_id is missing from %s", data) + } + if _, ok := fields["reciever_user_id"]; ok { + t.Fatalf("misspelled receiver_user_id is present in %s", data) + } + }) + } +} + +func TestEphemeralSendParametersMarshal(t *testing.T) { + cases := []struct { + name string + params any + }{ + {"message", SendMessage{ChatID: 1, Text: "text", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"animation", SendAnimation{ChatID: 1, Animation: "animation", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"audio", SendAudio{ChatID: 1, Audio: "audio", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"document", SendDocument{ChatID: 1, Document: "document", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"photo", SendPhoto{ChatID: 1, Photo: "photo", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"sticker", SendSticker{ChatID: 1, Sticker: "sticker", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"video", SendVideo{ChatID: 1, Video: "video", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"video note", SendVideoNote{ChatID: 1, VideoNote: "video-note", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"voice", SendVoice{ChatID: 1, Voice: "voice", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"contact", SendContact{ChatID: 1, PhoneNumber: "+10000000000", FirstName: "A", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"location", SendLocation{ChatID: 1, Latitude: 1, Longitude: 2, ReceiverUserID: 2, CallbackQueryID: "callback"}}, + {"venue", SendVenue{ChatID: 1, Latitude: 1, Longitude: 2, Title: "Venue", Address: "Address", ReceiverUserID: 2, CallbackQueryID: "callback"}}, + } + + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + data, err := json.Marshal(tt.params) + if err != nil { + t.Fatalf("Marshal returned error: %v", err) + } + if !strings.Contains(string(data), `"receiver_user_id":2`) || !strings.Contains(string(data), `"callback_query_id":"callback"`) { + t.Fatalf("missing ephemeral parameters in %s", data) + } + }) + } +} + func TestInputPollOptionMediaLinkMarshal(t *testing.T) { media := InputPollOptionMedia{Type: "link", URL: "https://example.com"} data, err := json.Marshal(media) diff --git a/tgapi/attachments_methods.go b/tgapi/attachments_methods.go index dfe0ee2..504a116 100644 --- a/tgapi/attachments_methods.go +++ b/tgapi/attachments_methods.go @@ -10,6 +10,10 @@ type SendPhoto struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Photo string `json:"photo"` Caption string `json:"caption,omitempty"` @@ -53,6 +57,10 @@ type SendAudio struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Audio string `json:"audio"` Caption string `json:"caption,omitempty"` @@ -98,6 +106,10 @@ type SendDocument struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Document string `json:"document"` Thumbnail string `json:"thumbnail,omitempty"` @@ -141,6 +153,10 @@ type SendVideo struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Video string `json:"video"` Thumbnail string `json:"thumbnail,omitempty"` @@ -192,6 +208,10 @@ type SendAnimation struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Animation string `json:"animation"` Thumbnail string `json:"thumbnail,omitempty"` @@ -239,6 +259,10 @@ type SendVoice struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 Voice string `json:"voice"` Caption string `json:"caption,omitempty"` @@ -280,6 +304,10 @@ type SendVideoNote struct { ChatID int64 `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 VideoNote string `json:"video_note"` Thumbnail string `json:"thumbnail,omitempty"` @@ -397,7 +425,13 @@ type SendLivePhoto struct { MessageThreadID int `json:"message_thread_id,omitempty"` DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"` - LivePhoto string `json:"live_photo"` + // ReceiverUserID identifies the user who can see the ephemeral message. + ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2 + // CallbackQueryID identifies the callback query that triggered an ephemeral response. + CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2 + LivePhoto string `json:"live_photo"` + // Photo contains or identifies the associated photo. + Photo string `json:"photo"` Caption string `json:"caption,omitempty"` ParseMode ParseMode `json:"parse_mode,omitempty"` CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` diff --git a/tgapi/attachments_types.go b/tgapi/attachments_types.go index b6ac278..f8c42b6 100644 --- a/tgapi/attachments_types.go +++ b/tgapi/attachments_types.go @@ -112,9 +112,13 @@ type PaidMediaInfo struct { type PaidMediaType string const ( - PaidMediaPreviewType PaidMediaType = "preview" - PaidMediaPhotoType PaidMediaType = "photo" - PaidMediaVideoType PaidMediaType = "video" + // PaidMediaPreviewType identifies a paid-media preview. + PaidMediaPreviewType PaidMediaType = "preview" + // PaidMediaPhotoType identifies a paid photo. + PaidMediaPhotoType PaidMediaType = "photo" + // PaidMediaVideoType identifies a paid video. + PaidMediaVideoType PaidMediaType = "video" + // PaidMediaLivePhotoType identifies a paid live photo. PaidMediaLivePhotoType PaidMediaType = "live_photo" // Since: Bot API 10.0 ) @@ -172,7 +176,8 @@ type PollOption struct { type InputPollOptionMedia struct { Type string `json:"type"` Media string `json:"media,omitempty"` - URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link" + // URL contains the HTTP URL. + URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link" } // InputPollOption contains information about one answer option in a poll to be sent. @@ -226,8 +231,8 @@ const ( // See https://core.telegram.org/bots/api#pollanswer type PollAnswer struct { PollID string `json:"poll_id"` - VoterChat Chat `json:"voter_chat"` // Since: Bot API 6.8 - User User `json:"user"` + VoterChat Chat `json:"voter_chat,omitempty"` // Since: Bot API 6.8 + User User `json:"user,omitempty"` // FIXME: Pointer in v2 OptionIDs []int `json:"option_ids"` OptionPersistentIDs []string `json:"option_persistent_ids"` // Since: Bot API 9.6 } @@ -264,15 +269,17 @@ type Poll struct { // Since: Bot API 10.1 // See https://core.telegram.org/bots/api#link type Link struct { + // URL contains the HTTP URL. URL string `json:"url"` } // PollMedia represents media attached to a poll. // Since: Bot API 10.0 type PollMedia struct { - Animation *Animation `json:"animation,omitempty"` - Audio *Audio `json:"audio,omitempty"` - Document *Document `json:"document,omitempty"` + Animation *Animation `json:"animation,omitempty"` + Audio *Audio `json:"audio,omitempty"` + Document *Document `json:"document,omitempty"` + // Link contains link media attached to the poll. Link *Link `json:"link,omitempty"` // Since: Bot API 10.1 LivePhoto *LivePhoto `json:"live_photo,omitempty"` Location *Location `json:"location,omitempty"` @@ -352,10 +359,18 @@ const ( InputMediaTypeVideo InputMediaType = "video" // InputMediaTypeAudio is an audio file. InputMediaTypeAudio InputMediaType = "audio" + // InputMediaTypeVoiceNote is a voice message. + // + // Since: Bot API 10.2 + InputMediaTypeVoiceNote InputMediaType = "voice_note" - InputMediaTypeSticker InputMediaType = "sticker" - InputMediaTypeLocation InputMediaType = "location" - InputMediaTypeVenue InputMediaType = "venue" + // InputMediaTypeSticker is a sticker. + InputMediaTypeSticker InputMediaType = "sticker" + // InputMediaTypeLocation is a location. + InputMediaTypeLocation InputMediaType = "location" + // InputMediaTypeVenue is a venue. + InputMediaTypeVenue InputMediaType = "venue" + // InputMediaTypeLivePhoto is a live photo. InputMediaTypeLivePhoto InputMediaType = "live_photo" // Since: Bot API 10.0 ) diff --git a/tgapi/bot_types.go b/tgapi/bot_types.go index c1f6e55..30059bf 100644 --- a/tgapi/bot_types.go +++ b/tgapi/bot_types.go @@ -6,6 +6,8 @@ package tgapi type BotCommand struct { Command string `json:"command"` Description string `json:"description"` + // IsEphemeral marks the command as visible only in ephemeral command contexts. + IsEphemeral bool `json:"is_ephemeral,omitempty"` // Since: Bot API 10.2 } // BotCommandScopeType indicates the type of a command scope. diff --git a/tgapi/chat_methods.go b/tgapi/chat_methods.go index 37d6349..00fd3ef 100644 --- a/tgapi/chat_methods.go +++ b/tgapi/chat_methods.go @@ -498,8 +498,10 @@ const ( // Since: Bot API 10.1 // See https://core.telegram.org/bots/api#answerchatjoinrequestquery type AnswerChatJoinRequestQuery struct { - ChatJoinRequestQueryID string `json:"chat_join_request_query_id"` - Result ChatJoinRequestQueryResult `json:"result"` + // ChatJoinRequestQueryID identifies the chat join request query. + ChatJoinRequestQueryID string `json:"chat_join_request_query_id"` + // Result contains the decision for the join request query. + Result ChatJoinRequestQueryResult `json:"result"` } // AnswerChatJoinRequestQuery processes a received chat join request query. @@ -524,8 +526,10 @@ func (api *API) AnswerChatJoinRequestQueryWithContext(ctx context.Context, param // Since: Bot API 10.1 // See https://core.telegram.org/bots/api#sendchatjoinrequestwebapp type SendChatJoinRequestWebApp struct { + // ChatJoinRequestQueryID identifies the chat join request query. ChatJoinRequestQueryID string `json:"chat_join_request_query_id"` - WebAppURL string `json:"web_app_url"` + // WebAppURL is the HTTPS URL of the Mini App to open. + WebAppURL string `json:"web_app_url"` } // SendChatJoinRequestWebApp shows a Mini App to the user before deciding a diff --git a/tgapi/chat_types.go b/tgapi/chat_types.go index 8ff5522..12616af 100644 --- a/tgapi/chat_types.go +++ b/tgapi/chat_types.go @@ -52,7 +52,6 @@ type ChatFullInfo struct { PersonalChat *Chat `json:"personal_chat,omitempty"` ParentChat *Chat `json:"parent_chat,omitempty"` // Since: Bot API 9.2 - GuardBot *User `json:"guard_bot,omitempty"` // Since: Bot API 10.1; visible to chat administrators only AvailableReaction []ReactionType `json:"available_reaction,omitempty"` @@ -92,6 +91,10 @@ type ChatFullInfo struct { FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"` // Since: Bot API 9.4 UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"` // Since: Bot API 9.3 PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` // Since: Bot API 9.3 + // GuardBot contains the guard bot visible to chat administrators. + GuardBot *User `json:"guard_bot,omitempty"` // Since: Bot API 10.1; visible to chat administrators only + // Community contains information about the affected community. + Community *Community `json:"community,omitempty"` // Since: Bot API 10.2 } // ChatPhoto represents a chat photo. @@ -318,3 +321,26 @@ type ChatBoostRemoved struct { RemoveDate int `json:"remove_date"` Source ChatBoostSource `json:"source"` } + +// Community represents a group of chats. +// +// Since: Bot API 10.2 +type Community struct { + // ID uniquely identifies the value within its containing object. + ID int64 `json:"id"` + // Name is the user-facing or reference name of the value. + Name string `json:"name"` +} + +// CommunityChatAdded describes a service message about a chat joining a community. +// +// Since: Bot API 10.2 +type CommunityChatAdded struct { + // Community contains information about the affected community. + Community Community `json:"community"` +} + +// CommunityChatRemoved describes a service message about a chat leaving a community. +// +// Since: Bot API 10.2 +type CommunityChatRemoved struct{} diff --git a/tgapi/errors.go b/tgapi/errors.go index 8eb7cda..f7f599f 100644 --- a/tgapi/errors.go +++ b/tgapi/errors.go @@ -14,6 +14,11 @@ var ErrPoolQueueFull = errors.New("worker pool queue full") // ErrPoolStopped reports that a request was submitted after the worker pool stopped. var ErrPoolStopped = errors.New("worker pool stopped") +// ErrRichMessageDraftUploadUnsupported reports a direct file upload attempted for a rich draft. +// +// Since: Bot API 10.2 +var ErrRichMessageDraftUploadUnsupported = errors.New("sendRichMessageDraft does not support direct file uploads") + // ResponseError reports an unsuccessful Telegram API response. type ResponseError struct { Code int diff --git a/tgapi/inline_types.go b/tgapi/inline_types.go index 032d359..6b02051 100644 --- a/tgapi/inline_types.go +++ b/tgapi/inline_types.go @@ -20,6 +20,7 @@ type InlineQueryResultsButton struct { // Since: Bot API 10.1 // See https://core.telegram.org/bots/api#inputrichmessagecontent type InputRichMessageContent struct { + // RichMessage contains structured rich-message content. RichMessage InputRichMessage `json:"rich_message"` } diff --git a/tgapi/log_redaction.go b/tgapi/log_redaction.go new file mode 100644 index 0000000..a7f4a07 --- /dev/null +++ b/tgapi/log_redaction.go @@ -0,0 +1,57 @@ +package tgapi + +import ( + "encoding/json" + "fmt" + "strings" +) + +const redactedLogValue = "tag. +// +// Since: Bot API 10.2 +type InputRichBlockParagraph struct { + // Type is the Bot API type discriminator. + Type InputRichType `json:"type"` + // Text contains the formatted or plain text content. + Text RichText `json:"text"` +} + +func (InputRichBlockParagraph) isInputRichBlock() {} + +// InputRichBlockSectionHeading is a section heading corresponding to an HTML
and tags.
+//
+// Since: Bot API 10.2
+type InputRichBlockPreformatted struct {
+ // Type is the Bot API type discriminator.
+ Type InputRichType `json:"type"`
+ // Text contains the formatted or plain text content.
+ Text RichText `json:"text"`
+ // Language identifies the programming language used for syntax highlighting.
+ Language string `json:"language,omitempty"`
+}
+
+func (InputRichBlockPreformatted) isInputRichBlock() {}
+
+// InputRichBlockFooter is a footer corresponding to the HTML