thread.rs

  1use std::sync::Arc;
  2
  3use anyhow::Result;
  4use assistant_tool::ToolWorkingSet;
  5use chrono::{DateTime, Utc};
  6use collections::HashMap;
  7use futures::future::Shared;
  8use futures::{FutureExt as _, StreamExt as _};
  9use gpui::{AppContext, EventEmitter, ModelContext, SharedString, Task};
 10use language_model::{
 11    LanguageModel, LanguageModelCompletionEvent, LanguageModelRegistry, LanguageModelRequest,
 12    LanguageModelRequestMessage, LanguageModelToolResult, LanguageModelToolUse,
 13    LanguageModelToolUseId, MessageContent, Role, StopReason,
 14};
 15use language_models::provider::cloud::{MaxMonthlySpendReachedError, PaymentRequiredError};
 16use serde::{Deserialize, Serialize};
 17use util::{post_inc, TryFutureExt as _};
 18use uuid::Uuid;
 19
 20use crate::context::{Context, ContextKind};
 21
 22#[derive(Debug, Clone, Copy)]
 23pub enum RequestKind {
 24    Chat,
 25}
 26
 27#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Serialize, Deserialize)]
 28pub struct ThreadId(Arc<str>);
 29
 30impl ThreadId {
 31    pub fn new() -> Self {
 32        Self(Uuid::new_v4().to_string().into())
 33    }
 34}
 35
 36impl std::fmt::Display for ThreadId {
 37    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 38        write!(f, "{}", self.0)
 39    }
 40}
 41
 42#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
 43pub struct MessageId(usize);
 44
 45impl MessageId {
 46    fn post_inc(&mut self) -> Self {
 47        Self(post_inc(&mut self.0))
 48    }
 49}
 50
 51/// A message in a [`Thread`].
 52#[derive(Debug, Clone)]
 53pub struct Message {
 54    pub id: MessageId,
 55    pub role: Role,
 56    pub text: String,
 57}
 58
 59/// A thread of conversation with the LLM.
 60pub struct Thread {
 61    id: ThreadId,
 62    updated_at: DateTime<Utc>,
 63    summary: Option<SharedString>,
 64    pending_summary: Task<Option<()>>,
 65    messages: Vec<Message>,
 66    next_message_id: MessageId,
 67    context_by_message: HashMap<MessageId, Vec<Context>>,
 68    completion_count: usize,
 69    pending_completions: Vec<PendingCompletion>,
 70    tools: Arc<ToolWorkingSet>,
 71    tool_uses_by_message: HashMap<MessageId, Vec<LanguageModelToolUse>>,
 72    tool_results_by_message: HashMap<MessageId, Vec<LanguageModelToolResult>>,
 73    pending_tool_uses_by_id: HashMap<LanguageModelToolUseId, PendingToolUse>,
 74}
 75
 76impl Thread {
 77    pub fn new(tools: Arc<ToolWorkingSet>, _cx: &mut ModelContext<Self>) -> Self {
 78        Self {
 79            id: ThreadId::new(),
 80            updated_at: Utc::now(),
 81            summary: None,
 82            pending_summary: Task::ready(None),
 83            messages: Vec::new(),
 84            next_message_id: MessageId(0),
 85            context_by_message: HashMap::default(),
 86            completion_count: 0,
 87            pending_completions: Vec::new(),
 88            tools,
 89            tool_uses_by_message: HashMap::default(),
 90            tool_results_by_message: HashMap::default(),
 91            pending_tool_uses_by_id: HashMap::default(),
 92        }
 93    }
 94
 95    pub fn id(&self) -> &ThreadId {
 96        &self.id
 97    }
 98
 99    pub fn is_empty(&self) -> bool {
100        self.messages.is_empty()
101    }
102
103    pub fn updated_at(&self) -> DateTime<Utc> {
104        self.updated_at
105    }
106
107    pub fn touch_updated_at(&mut self) {
108        self.updated_at = Utc::now();
109    }
110
111    pub fn summary(&self) -> Option<SharedString> {
112        self.summary.clone()
113    }
114
115    pub fn set_summary(&mut self, summary: impl Into<SharedString>, cx: &mut ModelContext<Self>) {
116        self.summary = Some(summary.into());
117        cx.emit(ThreadEvent::SummaryChanged);
118    }
119
120    pub fn message(&self, id: MessageId) -> Option<&Message> {
121        self.messages.iter().find(|message| message.id == id)
122    }
123
124    pub fn messages(&self) -> impl Iterator<Item = &Message> {
125        self.messages.iter()
126    }
127
128    pub fn tools(&self) -> &Arc<ToolWorkingSet> {
129        &self.tools
130    }
131
132    pub fn context_for_message(&self, id: MessageId) -> Option<&Vec<Context>> {
133        self.context_by_message.get(&id)
134    }
135
136    pub fn pending_tool_uses(&self) -> Vec<&PendingToolUse> {
137        self.pending_tool_uses_by_id.values().collect()
138    }
139
140    pub fn insert_user_message(
141        &mut self,
142        text: impl Into<String>,
143        context: Vec<Context>,
144        cx: &mut ModelContext<Self>,
145    ) {
146        let message_id = self.insert_message(Role::User, text, cx);
147        self.context_by_message.insert(message_id, context);
148    }
149
150    pub fn insert_message(
151        &mut self,
152        role: Role,
153        text: impl Into<String>,
154        cx: &mut ModelContext<Self>,
155    ) -> MessageId {
156        let id = self.next_message_id.post_inc();
157        self.messages.push(Message {
158            id,
159            role,
160            text: text.into(),
161        });
162        self.touch_updated_at();
163        cx.emit(ThreadEvent::MessageAdded(id));
164        id
165    }
166
167    pub fn to_completion_request(
168        &self,
169        _request_kind: RequestKind,
170        _cx: &AppContext,
171    ) -> LanguageModelRequest {
172        let mut request = LanguageModelRequest {
173            messages: vec![],
174            tools: Vec::new(),
175            stop: Vec::new(),
176            temperature: None,
177        };
178
179        for message in &self.messages {
180            let mut request_message = LanguageModelRequestMessage {
181                role: message.role,
182                content: Vec::new(),
183                cache: false,
184            };
185
186            if let Some(tool_results) = self.tool_results_by_message.get(&message.id) {
187                for tool_result in tool_results {
188                    request_message
189                        .content
190                        .push(MessageContent::ToolResult(tool_result.clone()));
191                }
192            }
193
194            if let Some(context) = self.context_for_message(message.id) {
195                let mut file_context = String::new();
196                let mut fetch_context = String::new();
197                let mut thread_context = String::new();
198
199                for context in context.iter() {
200                    match context.kind {
201                        ContextKind::File => {
202                            file_context.push_str(&context.text);
203                            file_context.push('\n');
204                        }
205                        ContextKind::FetchedUrl => {
206                            fetch_context.push_str(&context.name);
207                            fetch_context.push('\n');
208                            fetch_context.push_str(&context.text);
209                            fetch_context.push('\n');
210                        }
211                        ContextKind::Thread => {
212                            thread_context.push_str(&context.name);
213                            thread_context.push('\n');
214                            thread_context.push_str(&context.text);
215                            thread_context.push('\n');
216                        }
217                    }
218                }
219
220                let mut context_text = String::new();
221                if !file_context.is_empty() {
222                    context_text.push_str("The following files are available:\n");
223                    context_text.push_str(&file_context);
224                }
225
226                if !fetch_context.is_empty() {
227                    context_text.push_str("The following fetched results are available\n");
228                    context_text.push_str(&fetch_context);
229                }
230
231                if !thread_context.is_empty() {
232                    context_text
233                        .push_str("The following previous conversation threads are available\n");
234                    context_text.push_str(&thread_context);
235                }
236
237                request_message
238                    .content
239                    .push(MessageContent::Text(context_text))
240            }
241
242            if !message.text.is_empty() {
243                request_message
244                    .content
245                    .push(MessageContent::Text(message.text.clone()));
246            }
247
248            if let Some(tool_uses) = self.tool_uses_by_message.get(&message.id) {
249                for tool_use in tool_uses {
250                    request_message
251                        .content
252                        .push(MessageContent::ToolUse(tool_use.clone()));
253                }
254            }
255
256            request.messages.push(request_message);
257        }
258
259        request
260    }
261
262    pub fn stream_completion(
263        &mut self,
264        request: LanguageModelRequest,
265        model: Arc<dyn LanguageModel>,
266        cx: &mut ModelContext<Self>,
267    ) {
268        let pending_completion_id = post_inc(&mut self.completion_count);
269
270        let task = cx.spawn(|thread, mut cx| async move {
271            let stream = model.stream_completion(request, &cx);
272            let stream_completion = async {
273                let mut events = stream.await?;
274                let mut stop_reason = StopReason::EndTurn;
275
276                while let Some(event) = events.next().await {
277                    let event = event?;
278
279                    thread.update(&mut cx, |thread, cx| {
280                        match event {
281                            LanguageModelCompletionEvent::StartMessage { .. } => {
282                                thread.insert_message(Role::Assistant, String::new(), cx);
283                            }
284                            LanguageModelCompletionEvent::Stop(reason) => {
285                                stop_reason = reason;
286                            }
287                            LanguageModelCompletionEvent::Text(chunk) => {
288                                if let Some(last_message) = thread.messages.last_mut() {
289                                    if last_message.role == Role::Assistant {
290                                        last_message.text.push_str(&chunk);
291                                        cx.emit(ThreadEvent::StreamedAssistantText(
292                                            last_message.id,
293                                            chunk,
294                                        ));
295                                    }
296                                }
297                            }
298                            LanguageModelCompletionEvent::ToolUse(tool_use) => {
299                                if let Some(last_assistant_message) = thread
300                                    .messages
301                                    .iter()
302                                    .rfind(|message| message.role == Role::Assistant)
303                                {
304                                    thread
305                                        .tool_uses_by_message
306                                        .entry(last_assistant_message.id)
307                                        .or_default()
308                                        .push(tool_use.clone());
309
310                                    thread.pending_tool_uses_by_id.insert(
311                                        tool_use.id.clone(),
312                                        PendingToolUse {
313                                            assistant_message_id: last_assistant_message.id,
314                                            id: tool_use.id,
315                                            name: tool_use.name,
316                                            input: tool_use.input,
317                                            status: PendingToolUseStatus::Idle,
318                                        },
319                                    );
320                                }
321                            }
322                        }
323
324                        thread.touch_updated_at();
325                        cx.emit(ThreadEvent::StreamedCompletion);
326                        cx.notify();
327                    })?;
328
329                    smol::future::yield_now().await;
330                }
331
332                thread.update(&mut cx, |thread, cx| {
333                    thread
334                        .pending_completions
335                        .retain(|completion| completion.id != pending_completion_id);
336
337                    if thread.summary.is_none() && thread.messages.len() >= 2 {
338                        thread.summarize(cx);
339                    }
340                })?;
341
342                anyhow::Ok(stop_reason)
343            };
344
345            let result = stream_completion.await;
346
347            thread
348                .update(&mut cx, |_thread, cx| match result.as_ref() {
349                    Ok(stop_reason) => match stop_reason {
350                        StopReason::ToolUse => {
351                            cx.emit(ThreadEvent::UsePendingTools);
352                        }
353                        StopReason::EndTurn => {}
354                        StopReason::MaxTokens => {}
355                    },
356                    Err(error) => {
357                        if error.is::<PaymentRequiredError>() {
358                            cx.emit(ThreadEvent::ShowError(ThreadError::PaymentRequired));
359                        } else if error.is::<MaxMonthlySpendReachedError>() {
360                            cx.emit(ThreadEvent::ShowError(ThreadError::MaxMonthlySpendReached));
361                        } else {
362                            let error_message = error
363                                .chain()
364                                .map(|err| err.to_string())
365                                .collect::<Vec<_>>()
366                                .join("\n");
367                            cx.emit(ThreadEvent::ShowError(ThreadError::Message(
368                                SharedString::from(error_message.clone()),
369                            )));
370                        }
371                    }
372                })
373                .ok();
374        });
375
376        self.pending_completions.push(PendingCompletion {
377            id: pending_completion_id,
378            _task: task,
379        });
380    }
381
382    pub fn summarize(&mut self, cx: &mut ModelContext<Self>) {
383        let Some(provider) = LanguageModelRegistry::read_global(cx).active_provider() else {
384            return;
385        };
386        let Some(model) = LanguageModelRegistry::read_global(cx).active_model() else {
387            return;
388        };
389
390        if !provider.is_authenticated(cx) {
391            return;
392        }
393
394        let mut request = self.to_completion_request(RequestKind::Chat, cx);
395        request.messages.push(LanguageModelRequestMessage {
396            role: Role::User,
397            content: vec![
398                "Generate a concise 3-7 word title for this conversation, omitting punctuation. Go straight to the title, without any preamble and prefix like `Here's a concise suggestion:...` or `Title:`"
399                    .into(),
400            ],
401            cache: false,
402        });
403
404        self.pending_summary = cx.spawn(|this, mut cx| {
405            async move {
406                let stream = model.stream_completion_text(request, &cx);
407                let mut messages = stream.await?;
408
409                let mut new_summary = String::new();
410                while let Some(message) = messages.stream.next().await {
411                    let text = message?;
412                    let mut lines = text.lines();
413                    new_summary.extend(lines.next());
414
415                    // Stop if the LLM generated multiple lines.
416                    if lines.next().is_some() {
417                        break;
418                    }
419                }
420
421                this.update(&mut cx, |this, cx| {
422                    if !new_summary.is_empty() {
423                        this.summary = Some(new_summary.into());
424                    }
425
426                    cx.emit(ThreadEvent::SummaryChanged);
427                })?;
428
429                anyhow::Ok(())
430            }
431            .log_err()
432        });
433    }
434
435    pub fn insert_tool_output(
436        &mut self,
437        assistant_message_id: MessageId,
438        tool_use_id: LanguageModelToolUseId,
439        output: Task<Result<String>>,
440        cx: &mut ModelContext<Self>,
441    ) {
442        let insert_output_task = cx.spawn(|thread, mut cx| {
443            let tool_use_id = tool_use_id.clone();
444            async move {
445                let output = output.await;
446                thread
447                    .update(&mut cx, |thread, cx| {
448                        // The tool use was requested by an Assistant message,
449                        // so we want to attach the tool results to the next
450                        // user message.
451                        let next_user_message = MessageId(assistant_message_id.0 + 1);
452
453                        let tool_results = thread
454                            .tool_results_by_message
455                            .entry(next_user_message)
456                            .or_default();
457
458                        match output {
459                            Ok(output) => {
460                                tool_results.push(LanguageModelToolResult {
461                                    tool_use_id: tool_use_id.to_string(),
462                                    content: output,
463                                    is_error: false,
464                                });
465
466                                cx.emit(ThreadEvent::ToolFinished { tool_use_id });
467                            }
468                            Err(err) => {
469                                tool_results.push(LanguageModelToolResult {
470                                    tool_use_id: tool_use_id.to_string(),
471                                    content: err.to_string(),
472                                    is_error: true,
473                                });
474
475                                if let Some(tool_use) =
476                                    thread.pending_tool_uses_by_id.get_mut(&tool_use_id)
477                                {
478                                    tool_use.status = PendingToolUseStatus::Error(err.to_string());
479                                }
480                            }
481                        }
482                    })
483                    .ok();
484            }
485        });
486
487        if let Some(tool_use) = self.pending_tool_uses_by_id.get_mut(&tool_use_id) {
488            tool_use.status = PendingToolUseStatus::Running {
489                _task: insert_output_task.shared(),
490            };
491        }
492    }
493}
494
495#[derive(Debug, Clone)]
496pub enum ThreadError {
497    PaymentRequired,
498    MaxMonthlySpendReached,
499    Message(SharedString),
500}
501
502#[derive(Debug, Clone)]
503pub enum ThreadEvent {
504    ShowError(ThreadError),
505    StreamedCompletion,
506    StreamedAssistantText(MessageId, String),
507    MessageAdded(MessageId),
508    SummaryChanged,
509    UsePendingTools,
510    ToolFinished {
511        #[allow(unused)]
512        tool_use_id: LanguageModelToolUseId,
513    },
514}
515
516impl EventEmitter<ThreadEvent> for Thread {}
517
518struct PendingCompletion {
519    id: usize,
520    _task: Task<()>,
521}
522
523#[derive(Debug, Clone)]
524pub struct PendingToolUse {
525    pub id: LanguageModelToolUseId,
526    /// The ID of the Assistant message in which the tool use was requested.
527    pub assistant_message_id: MessageId,
528    pub name: String,
529    pub input: serde_json::Value,
530    pub status: PendingToolUseStatus,
531}
532
533#[derive(Debug, Clone)]
534pub enum PendingToolUseStatus {
535    Idle,
536    Running { _task: Shared<Task<()>> },
537    Error(#[allow(unused)] String),
538}
539
540impl PendingToolUseStatus {
541    pub fn is_idle(&self) -> bool {
542        matches!(self, PendingToolUseStatus::Idle)
543    }
544}