Skip to content

feat: bots ask structured questions that people answer from a card #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sercada wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: bots ask structured questions that people answer from a card #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions apps/api/internal/httpapi/direct.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,18 +129,20 @@ func (s *Server) listDirectMessages(w http.ResponseWriter, r *http.Request) {
}

func (s *Server) createDirectMessage(w http.ResponseWriter, r *http.Request) {
w.Header().Set(store.QuestionCapabilityHeader, store.QuestionCapabilityHeaderValue)
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
return
}
var body struct {
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
UploadID string `json:"upload_id"`
Kind string `json:"kind"`
TurnID string `json:"turn_id"`
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
UploadID string `json:"upload_id"`
Kind string `json:"kind"`
TurnID string `json:"turn_id"`
Question *store.QuestionSpec `json:"question"`
}
if err := readJSON(w, r, &body); err != nil {
writeError(w, http.StatusBadRequest, err)
Expand All @@ -154,13 +156,16 @@ func (s *Server) createDirectMessage(w http.ResponseWriter, r *http.Request) {
if !ok {
return
}
if !requireQuestionAuthor(w, act, body.Question, kind) {
return
}
if !s.requireBotDirectWorkspace(w, r, act, chi.URLParam(r, "conversation_id")) {
return
}
if !s.requireCreateUpload(w, r, act, body.UploadID, body.Nonce, "", chi.URLParam(r, "conversation_id")) {
return
}
message, event, err := s.store.CreateDirectMessage(r.Context(), store.CreateDirectMessageInput{ConversationID: chi.URLParam(r, "conversation_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce, UploadID: body.UploadID, Kind: kind, TurnID: turnID})
message, event, err := s.store.CreateDirectMessage(r.Context(), store.CreateDirectMessageInput{ConversationID: chi.URLParam(r, "conversation_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce, UploadID: body.UploadID, Kind: kind, TurnID: turnID, Question: body.Question})
if err == nil && event.ID != "" {
s.publishEvent(r.Context(), event)
if !store.IsActivityMessageKind(message.Kind) {
Expand Down
34 changes: 22 additions & 12 deletions apps/api/internal/httpapi/messages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func (s *Server) listMessages(w http.ResponseWriter, r *http.Request) {
}

func (s *Server) createMessage(w http.ResponseWriter, r *http.Request) {
w.Header().Set(store.QuestionCapabilityHeader, store.QuestionCapabilityHeaderValue)
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
Expand All @@ -52,13 +53,14 @@ func (s *Server) createMessage(w http.ResponseWriter, r *http.Request) {
return
}
var body struct {
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
TopicID string `json:"topic_id"`
UploadID string `json:"upload_id"`
Kind string `json:"kind"`
TurnID string `json:"turn_id"`
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
TopicID string `json:"topic_id"`
UploadID string `json:"upload_id"`
Kind string `json:"kind"`
TurnID string `json:"turn_id"`
Question *store.QuestionSpec `json:"question"`
}
if err := readJSON(w, r, &body); err != nil {
writeError(w, http.StatusBadRequest, err)
Expand All @@ -68,13 +70,16 @@ func (s *Server) createMessage(w http.ResponseWriter, r *http.Request) {
if !ok {
return
}
if !requireQuestionAuthor(w, act, body.Question, kind) {
return
}
if !s.requireBotChannelWorkspace(w, r, act, chi.URLParam(r, "channel_id")) {
return
}
if !s.requireCreateUpload(w, r, act, body.UploadID, body.Nonce, chi.URLParam(r, "channel_id"), "") {
return
}
message, event, err := s.store.CreateMessage(r.Context(), store.CreateMessageInput{ChannelID: chi.URLParam(r, "channel_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce, TopicID: body.TopicID, UploadID: body.UploadID, Kind: kind, TurnID: turnID})
message, event, err := s.store.CreateMessage(r.Context(), store.CreateMessageInput{ChannelID: chi.URLParam(r, "channel_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce, TopicID: body.TopicID, UploadID: body.UploadID, Kind: kind, TurnID: turnID, Question: body.Question})
if err == nil && event.ID != "" {
s.publishEvent(r.Context(), event)
if !store.IsActivityMessageKind(message.Kind) {
Expand Down Expand Up @@ -245,6 +250,7 @@ func (s *Server) getThread(w http.ResponseWriter, r *http.Request) {
}

func (s *Server) createThreadReply(w http.ResponseWriter, r *http.Request) {
w.Header().Set(store.QuestionCapabilityHeader, store.QuestionCapabilityHeaderValue)
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
Expand All @@ -255,18 +261,22 @@ func (s *Server) createThreadReply(w http.ResponseWriter, r *http.Request) {
return
}
var body struct {
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
Body string `json:"body"`
QuotedMessageID string `json:"quoted_message_id"`
Nonce string `json:"nonce"`
Question *store.QuestionSpec `json:"question"`
}
if err := readJSON(w, r, &body); err != nil {
writeError(w, http.StatusBadRequest, err)
return
}
if !requireQuestionAuthor(w, act, body.Question, "") {
return
}
if _, ok := s.requireBotMessageResource(w, r, act, chi.URLParam(r, "message_id"), "dms:write"); !ok {
return
}
message, state, events, err := s.store.CreateThreadReply(r.Context(), store.CreateThreadReplyInput{RootMessageID: chi.URLParam(r, "message_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce})
message, state, events, err := s.store.CreateThreadReply(r.Context(), store.CreateThreadReplyInput{RootMessageID: chi.URLParam(r, "message_id"), AuthorID: act.user.ID, Body: body.Body, QuotedMessageID: optionalString(body.QuotedMessageID), Nonce: body.Nonce, Question: body.Question})
if err == nil && len(events) > 0 {
s.publishEvents(r.Context(), events)
s.notifyMessageCreated(r.Context(), message, messageEventMentionedUserIDs(events))
Expand Down
181 changes: 181 additions & 0 deletions apps/api/internal/httpapi/questions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
package httpapi

import (
"database/sql"
"errors"
"fmt"
"net/http"
"strconv"
"strings"

"github.com/go-chi/chi/v5"
"github.com/openclaw/clickclack/apps/api/internal/store"
)

// requireQuestionAuthor admits questions from bot tokens only; people answer them.
// Agent activity rows fold into progress blocks, so they cannot carry one.
func requireQuestionAuthor(w http.ResponseWriter, act actor, question *store.QuestionSpec, kind string) bool {
if question == nil {
return true
}
if act.botTokenID == "" {
writeError(w, http.StatusForbidden, errors.New("questions require a bot token"))
return false
}
if store.IsActivityMessageKind(kind) {
writeError(w, http.StatusBadRequest, errors.New("questions attach only to ordinary messages"))
return false
}
return true
}

func (s *Server) answerQuestion(w http.ResponseWriter, r *http.Request) {
w.Header().Set(store.QuestionCapabilityHeader, store.QuestionCapabilityHeaderValue)
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
return
}
if act.botTokenID != "" {
writeError(w, http.StatusForbidden, errors.New("bot tokens cannot answer questions"))
return
}
if err := act.requireScope("messages:write"); err != nil {
writeError(w, http.StatusForbidden, err)
return
}
var body struct {
Answers map[string][]string `json:"answers"`
Skip bool `json:"skip"`
Nonce string `json:"nonce"`
ExpectedVersion *int64 `json:"expected_version"`
}
if err := readJSON(w, r, &body); err != nil {
writeError(w, http.StatusBadRequest, err)
return
}
if body.Skip && len(body.Answers) > 0 {
writeError(w, http.StatusBadRequest, errors.New("send answers or skip, not both"))
return
}
message, events, err := s.store.AnswerQuestion(r.Context(), store.AnswerQuestionInput{
MessageID: chi.URLParam(r, "message_id"),
UserID: act.user.ID,
Answers: body.Answers,
Skip: body.Skip,
Nonce: body.Nonce,
ExpectedVersion: body.ExpectedVersion,
})
if err != nil {
writeQuestionError(w, err)
return
}
s.publishEvents(r.Context(), events)
writeJSON(w, http.StatusOK, map[string]any{"message": message, "events": nonNilEvents(events)})
}

func (s *Server) resolveQuestion(w http.ResponseWriter, r *http.Request) {
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
return
}
if act.botTokenID == "" {
writeError(w, http.StatusForbidden, errors.New("only the bot that asked a question can resolve it"))
return
}
if err := act.requireScope("messages:write"); err != nil {
writeError(w, http.StatusForbidden, err)
return
}
var body struct {
Status string `json:"status"`
Note string `json:"note"`
Answers map[string][]string `json:"answers"`
ExpectedVersion *int64 `json:"expected_version"`
}
if err := readJSON(w, r, &body); err != nil {
writeError(w, http.StatusBadRequest, err)
return
}
if _, ok := s.requireBotMessageResource(w, r, act, chi.URLParam(r, "message_id"), "dms:write"); !ok {
return
}
message, event, err := s.store.ResolveQuestion(r.Context(), store.ResolveQuestionInput{
MessageID: chi.URLParam(r, "message_id"),
BotUserID: act.user.ID,
Status: body.Status,
Note: body.Note,
Answers: body.Answers,
ExpectedVersion: body.ExpectedVersion,
})
if err != nil {
writeQuestionError(w, err)
return
}
response := map[string]any{"message": message}
if event.ID != "" {
s.publishEvent(r.Context(), event)
response["event"] = event
}
writeJSON(w, http.StatusOK, response)
}

func (s *Server) listBotQuestions(w http.ResponseWriter, r *http.Request) {
act, err := s.currentActor(r)
if err != nil {
writeError(w, http.StatusUnauthorized, err)
return
}
if act.botTokenID == "" {
writeError(w, http.StatusForbidden, errors.New("bot tokens only"))
return
}
if err := act.requireScope("messages:read"); err != nil {
writeError(w, http.StatusForbidden, err)
return
}
limit := 100
if raw := strings.TrimSpace(r.URL.Query().Get("limit")); raw != "" {
parsed, err := strconv.Atoi(raw)
if err != nil || parsed < 1 || parsed > store.MaxBotQuestionPageSize {
writeError(w, http.StatusBadRequest, fmt.Errorf("limit must be between 1 and %d", store.MaxBotQuestionPageSize))
return
}
limit = parsed
}
// Direct-message questions stay behind the same scope as direct messages.
includeDirect := act.requireScope("dms:read") == nil
questions, err := s.store.ListBotUnresolvedQuestions(r.Context(), act.workspaceID, act.user.ID, strings.TrimSpace(r.URL.Query().Get("after")), includeDirect, limit+1)
if err != nil {
writeStoreError(w, err)
return
}
var next *string
if len(questions) > limit {
questions = questions[:limit]
cursor := questions[limit-1].MessageID
next = &cursor
}
writeJSON(w, http.StatusOK, map[string]any{"questions": questions, "next_cursor": next})
}

func writeQuestionError(w http.ResponseWriter, err error) {
switch {
case errors.Is(err, sql.ErrNoRows):
writeError(w, http.StatusNotFound, errors.New("question not found"))
case errors.Is(err, store.ErrQuestionClosed), errors.Is(err, store.ErrQuestionConflict):
writeError(w, http.StatusConflict, err)
case errors.Is(err, store.ErrQuestionResponderRequired), errors.Is(err, store.ErrQuestionAuthorRequired):
writeError(w, http.StatusForbidden, err)
default:
writeStoreError(w, err)
}
}

func nonNilEvents(events []store.Event) []store.Event {
if events == nil {
return []store.Event{}
}
return events
}
Loading