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
198                for context in context.iter() {
199                    match context.kind {
200                        ContextKind::File => {
201                            file_context.push_str(&context.text);
202                            file_context.push('\n');
203                        }
204                        ContextKind::FetchedUrl => {
205                            fetch_context.push_str(&context.name);
206                            fetch_context.push('\n');
207                            fetch_context.push_str(&context.text);
208                            fetch_context.push('\n');
209                        }
210                    }
211                }
212
213                let mut context_text = String::new();
214                if !file_context.is_empty() {
215                    context_text.push_str("The following files are available:\n");
216                    context_text.push_str(&file_context);
217                }
218
219                if !fetch_context.is_empty() {
220                    context_text.push_str("The following fetched results are available\n");
221                    context_text.push_str(&fetch_context);
222                }
223
224                request_message
225                    .content
226                    .push(MessageContent::Text(context_text))
227            }
228
229            if !message.text.is_empty() {
230                request_message
231                    .content
232                    .push(MessageContent::Text(message.text.clone()));
233            }
234
235            if let Some(tool_uses) = self.tool_uses_by_message.get(&message.id) {
236                for tool_use in tool_uses {
237                    request_message
238                        .content
239                        .push(MessageContent::ToolUse(tool_use.clone()));
240                }
241            }
242
243            request.messages.push(request_message);
244        }
245
246        request
247    }
248
249    pub fn stream_completion(
250        &mut self,
251        request: LanguageModelRequest,
252        model: Arc<dyn LanguageModel>,
253        cx: &mut ModelContext<Self>,
254    ) {
255        let pending_completion_id = post_inc(&mut self.completion_count);
256
257        let task = cx.spawn(|thread, mut cx| async move {
258            let stream = model.stream_completion(request, &cx);
259            let stream_completion = async {
260                let mut events = stream.await?;
261                let mut stop_reason = StopReason::EndTurn;
262
263                while let Some(event) = events.next().await {
264                    let event = event?;
265
266                    thread.update(&mut cx, |thread, cx| {
267                        match event {
268                            LanguageModelCompletionEvent::StartMessage { .. } => {
269                                thread.insert_message(Role::Assistant, String::new(), cx);
270                            }
271                            LanguageModelCompletionEvent::Stop(reason) => {
272                                stop_reason = reason;
273                            }
274                            LanguageModelCompletionEvent::Text(chunk) => {
275                                if let Some(last_message) = thread.messages.last_mut() {
276                                    if last_message.role == Role::Assistant {
277                                        last_message.text.push_str(&chunk);
278                                        cx.emit(ThreadEvent::StreamedAssistantText(
279                                            last_message.id,
280                                            chunk,
281                                        ));
282                                    }
283                                }
284                            }
285                            LanguageModelCompletionEvent::ToolUse(tool_use) => {
286                                if let Some(last_assistant_message) = thread
287                                    .messages
288                                    .iter()
289                                    .rfind(|message| message.role == Role::Assistant)
290                                {
291                                    thread
292                                        .tool_uses_by_message
293                                        .entry(last_assistant_message.id)
294                                        .or_default()
295                                        .push(tool_use.clone());
296
297                                    thread.pending_tool_uses_by_id.insert(
298                                        tool_use.id.clone(),
299                                        PendingToolUse {
300                                            assistant_message_id: last_assistant_message.id,
301                                            id: tool_use.id,
302                                            name: tool_use.name,
303                                            input: tool_use.input,
304                                            status: PendingToolUseStatus::Idle,
305                                        },
306                                    );
307                                }
308                            }
309                        }
310
311                        thread.touch_updated_at();
312                        cx.emit(ThreadEvent::StreamedCompletion);
313                        cx.notify();
314                    })?;
315
316                    smol::future::yield_now().await;
317                }
318
319                thread.update(&mut cx, |thread, cx| {
320                    thread
321                        .pending_completions
322                        .retain(|completion| completion.id != pending_completion_id);
323
324                    if thread.summary.is_none() && thread.messages.len() >= 2 {
325                        thread.summarize(cx);
326                    }
327                })?;
328
329                anyhow::Ok(stop_reason)
330            };
331
332            let result = stream_completion.await;
333
334            thread
335                .update(&mut cx, |_thread, cx| match result.as_ref() {
336                    Ok(stop_reason) => match stop_reason {
337                        StopReason::ToolUse => {
338                            cx.emit(ThreadEvent::UsePendingTools);
339                        }
340                        StopReason::EndTurn => {}
341                        StopReason::MaxTokens => {}
342                    },
343                    Err(error) => {
344                        if error.is::<PaymentRequiredError>() {
345                            cx.emit(ThreadEvent::ShowError(ThreadError::PaymentRequired));
346                        } else if error.is::<MaxMonthlySpendReachedError>() {
347                            cx.emit(ThreadEvent::ShowError(ThreadError::MaxMonthlySpendReached));
348                        } else {
349                            let error_message = error
350                                .chain()
351                                .map(|err| err.to_string())
352                                .collect::<Vec<_>>()
353                                .join("\n");
354                            cx.emit(ThreadEvent::ShowError(ThreadError::Message(
355                                SharedString::from(error_message.clone()),
356                            )));
357                        }
358                    }
359                })
360                .ok();
361        });
362
363        self.pending_completions.push(PendingCompletion {
364            id: pending_completion_id,
365            _task: task,
366        });
367    }
368
369    pub fn summarize(&mut self, cx: &mut ModelContext<Self>) {
370        let Some(provider) = LanguageModelRegistry::read_global(cx).active_provider() else {
371            return;
372        };
373        let Some(model) = LanguageModelRegistry::read_global(cx).active_model() else {
374            return;
375        };
376
377        if !provider.is_authenticated(cx) {
378            return;
379        }
380
381        let mut request = self.to_completion_request(RequestKind::Chat, cx);
382        request.messages.push(LanguageModelRequestMessage {
383            role: Role::User,
384            content: vec![
385                "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:`"
386                    .into(),
387            ],
388            cache: false,
389        });
390
391        self.pending_summary = cx.spawn(|this, mut cx| {
392            async move {
393                let stream = model.stream_completion_text(request, &cx);
394                let mut messages = stream.await?;
395
396                let mut new_summary = String::new();
397                while let Some(message) = messages.stream.next().await {
398                    let text = message?;
399                    let mut lines = text.lines();
400                    new_summary.extend(lines.next());
401
402                    // Stop if the LLM generated multiple lines.
403                    if lines.next().is_some() {
404                        break;
405                    }
406                }
407
408                this.update(&mut cx, |this, cx| {
409                    if !new_summary.is_empty() {
410                        this.summary = Some(new_summary.into());
411                    }
412
413                    cx.emit(ThreadEvent::SummaryChanged);
414                })?;
415
416                anyhow::Ok(())
417            }
418            .log_err()
419        });
420    }
421
422    pub fn insert_tool_output(
423        &mut self,
424        assistant_message_id: MessageId,
425        tool_use_id: LanguageModelToolUseId,
426        output: Task<Result<String>>,
427        cx: &mut ModelContext<Self>,
428    ) {
429        let insert_output_task = cx.spawn(|thread, mut cx| {
430            let tool_use_id = tool_use_id.clone();
431            async move {
432                let output = output.await;
433                thread
434                    .update(&mut cx, |thread, cx| {
435                        // The tool use was requested by an Assistant message,
436                        // so we want to attach the tool results to the next
437                        // user message.
438                        let next_user_message = MessageId(assistant_message_id.0 + 1);
439
440                        let tool_results = thread
441                            .tool_results_by_message
442                            .entry(next_user_message)
443                            .or_default();
444
445                        match output {
446                            Ok(output) => {
447                                tool_results.push(LanguageModelToolResult {
448                                    tool_use_id: tool_use_id.to_string(),
449                                    content: output,
450                                    is_error: false,
451                                });
452
453                                cx.emit(ThreadEvent::ToolFinished { tool_use_id });
454                            }
455                            Err(err) => {
456                                tool_results.push(LanguageModelToolResult {
457                                    tool_use_id: tool_use_id.to_string(),
458                                    content: err.to_string(),
459                                    is_error: true,
460                                });
461
462                                if let Some(tool_use) =
463                                    thread.pending_tool_uses_by_id.get_mut(&tool_use_id)
464                                {
465                                    tool_use.status = PendingToolUseStatus::Error(err.to_string());
466                                }
467                            }
468                        }
469                    })
470                    .ok();
471            }
472        });
473
474        if let Some(tool_use) = self.pending_tool_uses_by_id.get_mut(&tool_use_id) {
475            tool_use.status = PendingToolUseStatus::Running {
476                _task: insert_output_task.shared(),
477            };
478        }
479    }
480}
481
482#[derive(Debug, Clone)]
483pub enum ThreadError {
484    PaymentRequired,
485    MaxMonthlySpendReached,
486    Message(SharedString),
487}
488
489#[derive(Debug, Clone)]
490pub enum ThreadEvent {
491    ShowError(ThreadError),
492    StreamedCompletion,
493    StreamedAssistantText(MessageId, String),
494    MessageAdded(MessageId),
495    SummaryChanged,
496    UsePendingTools,
497    ToolFinished {
498        #[allow(unused)]
499        tool_use_id: LanguageModelToolUseId,
500    },
501}
502
503impl EventEmitter<ThreadEvent> for Thread {}
504
505struct PendingCompletion {
506    id: usize,
507    _task: Task<()>,
508}
509
510#[derive(Debug, Clone)]
511pub struct PendingToolUse {
512    pub id: LanguageModelToolUseId,
513    /// The ID of the Assistant message in which the tool use was requested.
514    pub assistant_message_id: MessageId,
515    pub name: String,
516    pub input: serde_json::Value,
517    pub status: PendingToolUseStatus,
518}
519
520#[derive(Debug, Clone)]
521pub enum PendingToolUseStatus {
522    Idle,
523    Running { _task: Shared<Task<()>> },
524    Error(#[allow(unused)] String),
525}
526
527impl PendingToolUseStatus {
528    pub fn is_idle(&self) -> bool {
529        matches!(self, PendingToolUseStatus::Idle)
530    }
531}