assistant_context.rs

   1#[cfg(test)]
   2mod assistant_context_tests;
   3mod context_store;
   4
   5use agent_settings::{AgentSettings, SUMMARIZE_THREAD_PROMPT};
   6use anyhow::{Context as _, Result, bail};
   7use assistant_slash_command::{
   8    SlashCommandContent, SlashCommandEvent, SlashCommandLine, SlashCommandOutputSection,
   9    SlashCommandResult, SlashCommandWorkingSet,
  10};
  11use assistant_slash_commands::FileCommandMetadata;
  12use client::{self, Client, ModelRequestUsage, RequestUsage, proto, telemetry::Telemetry};
  13use clock::ReplicaId;
  14use cloud_llm_client::{CompletionIntent, CompletionRequestStatus, UsageLimit};
  15use collections::{HashMap, HashSet};
  16use fs::{Fs, RenameOptions};
  17use futures::{FutureExt, StreamExt, future::Shared};
  18use gpui::{
  19    App, AppContext as _, Context, Entity, EventEmitter, RenderImage, SharedString, Subscription,
  20    Task,
  21};
  22use language::{AnchorRangeExt, Bias, Buffer, LanguageRegistry, OffsetRangeExt, Point, ToOffset};
  23use language_model::{
  24    LanguageModel, LanguageModelCacheConfiguration, LanguageModelCompletionEvent,
  25    LanguageModelImage, LanguageModelRegistry, LanguageModelRequest, LanguageModelRequestMessage,
  26    LanguageModelToolUseId, MessageContent, PaymentRequiredError, Role, StopReason,
  27    report_assistant_event,
  28};
  29use open_ai::Model as OpenAiModel;
  30use paths::contexts_dir;
  31use project::Project;
  32use prompt_store::PromptBuilder;
  33use serde::{Deserialize, Serialize};
  34use settings::Settings;
  35use smallvec::SmallVec;
  36use std::{
  37    cmp::{Ordering, max},
  38    fmt::{Debug, Write as _},
  39    iter, mem,
  40    ops::Range,
  41    path::Path,
  42    sync::Arc,
  43    time::{Duration, Instant},
  44};
  45use telemetry_events::{AssistantEventData, AssistantKind, AssistantPhase};
  46use text::{BufferSnapshot, ToPoint};
  47use ui::IconName;
  48use util::{ResultExt, TryFutureExt, post_inc};
  49use uuid::Uuid;
  50
  51pub use crate::context_store::*;
  52
  53pub fn init(client: Arc<Client>, _: &mut App) {
  54    context_store::init(&client.into());
  55}
  56
  57#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
  58pub struct ContextId(String);
  59
  60impl ContextId {
  61    pub fn new() -> Self {
  62        Self(Uuid::new_v4().to_string())
  63    }
  64
  65    pub fn from_proto(id: String) -> Self {
  66        Self(id)
  67    }
  68
  69    pub fn to_proto(&self) -> String {
  70        self.0.clone()
  71    }
  72}
  73
  74#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
  75pub struct MessageId(pub clock::Lamport);
  76
  77impl MessageId {
  78    pub fn as_u64(self) -> u64 {
  79        self.0.as_u64()
  80    }
  81}
  82
  83#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
  84pub enum MessageStatus {
  85    Pending,
  86    Done,
  87    Error(SharedString),
  88    Canceled,
  89}
  90
  91impl MessageStatus {
  92    pub fn from_proto(status: proto::ContextMessageStatus) -> MessageStatus {
  93        match status.variant {
  94            Some(proto::context_message_status::Variant::Pending(_)) => MessageStatus::Pending,
  95            Some(proto::context_message_status::Variant::Done(_)) => MessageStatus::Done,
  96            Some(proto::context_message_status::Variant::Error(error)) => {
  97                MessageStatus::Error(error.message.into())
  98            }
  99            Some(proto::context_message_status::Variant::Canceled(_)) => MessageStatus::Canceled,
 100            None => MessageStatus::Pending,
 101        }
 102    }
 103
 104    pub fn to_proto(&self) -> proto::ContextMessageStatus {
 105        match self {
 106            MessageStatus::Pending => proto::ContextMessageStatus {
 107                variant: Some(proto::context_message_status::Variant::Pending(
 108                    proto::context_message_status::Pending {},
 109                )),
 110            },
 111            MessageStatus::Done => proto::ContextMessageStatus {
 112                variant: Some(proto::context_message_status::Variant::Done(
 113                    proto::context_message_status::Done {},
 114                )),
 115            },
 116            MessageStatus::Error(message) => proto::ContextMessageStatus {
 117                variant: Some(proto::context_message_status::Variant::Error(
 118                    proto::context_message_status::Error {
 119                        message: message.to_string(),
 120                    },
 121                )),
 122            },
 123            MessageStatus::Canceled => proto::ContextMessageStatus {
 124                variant: Some(proto::context_message_status::Variant::Canceled(
 125                    proto::context_message_status::Canceled {},
 126                )),
 127            },
 128        }
 129    }
 130}
 131
 132#[derive(Clone, Debug)]
 133pub enum ContextOperation {
 134    InsertMessage {
 135        anchor: MessageAnchor,
 136        metadata: MessageMetadata,
 137        version: clock::Global,
 138    },
 139    UpdateMessage {
 140        message_id: MessageId,
 141        metadata: MessageMetadata,
 142        version: clock::Global,
 143    },
 144    UpdateSummary {
 145        summary: ContextSummaryContent,
 146        version: clock::Global,
 147    },
 148    SlashCommandStarted {
 149        id: InvokedSlashCommandId,
 150        output_range: Range<language::Anchor>,
 151        name: String,
 152        version: clock::Global,
 153    },
 154    SlashCommandFinished {
 155        id: InvokedSlashCommandId,
 156        timestamp: clock::Lamport,
 157        error_message: Option<String>,
 158        version: clock::Global,
 159    },
 160    SlashCommandOutputSectionAdded {
 161        timestamp: clock::Lamport,
 162        section: SlashCommandOutputSection<language::Anchor>,
 163        version: clock::Global,
 164    },
 165    ThoughtProcessOutputSectionAdded {
 166        timestamp: clock::Lamport,
 167        section: ThoughtProcessOutputSection<language::Anchor>,
 168        version: clock::Global,
 169    },
 170    BufferOperation(language::Operation),
 171}
 172
 173impl ContextOperation {
 174    pub fn from_proto(op: proto::ContextOperation) -> Result<Self> {
 175        match op.variant.context("invalid variant")? {
 176            proto::context_operation::Variant::InsertMessage(insert) => {
 177                let message = insert.message.context("invalid message")?;
 178                let id = MessageId(language::proto::deserialize_timestamp(
 179                    message.id.context("invalid id")?,
 180                ));
 181                Ok(Self::InsertMessage {
 182                    anchor: MessageAnchor {
 183                        id,
 184                        start: language::proto::deserialize_anchor(
 185                            message.start.context("invalid anchor")?,
 186                        )
 187                        .context("invalid anchor")?,
 188                    },
 189                    metadata: MessageMetadata {
 190                        role: Role::from_proto(message.role),
 191                        status: MessageStatus::from_proto(
 192                            message.status.context("invalid status")?,
 193                        ),
 194                        timestamp: id.0,
 195                        cache: None,
 196                    },
 197                    version: language::proto::deserialize_version(&insert.version),
 198                })
 199            }
 200            proto::context_operation::Variant::UpdateMessage(update) => Ok(Self::UpdateMessage {
 201                message_id: MessageId(language::proto::deserialize_timestamp(
 202                    update.message_id.context("invalid message id")?,
 203                )),
 204                metadata: MessageMetadata {
 205                    role: Role::from_proto(update.role),
 206                    status: MessageStatus::from_proto(update.status.context("invalid status")?),
 207                    timestamp: language::proto::deserialize_timestamp(
 208                        update.timestamp.context("invalid timestamp")?,
 209                    ),
 210                    cache: None,
 211                },
 212                version: language::proto::deserialize_version(&update.version),
 213            }),
 214            proto::context_operation::Variant::UpdateSummary(update) => Ok(Self::UpdateSummary {
 215                summary: ContextSummaryContent {
 216                    text: update.summary,
 217                    done: update.done,
 218                    timestamp: language::proto::deserialize_timestamp(
 219                        update.timestamp.context("invalid timestamp")?,
 220                    ),
 221                },
 222                version: language::proto::deserialize_version(&update.version),
 223            }),
 224            proto::context_operation::Variant::SlashCommandStarted(message) => {
 225                Ok(Self::SlashCommandStarted {
 226                    id: InvokedSlashCommandId(language::proto::deserialize_timestamp(
 227                        message.id.context("invalid id")?,
 228                    )),
 229                    output_range: language::proto::deserialize_anchor_range(
 230                        message.output_range.context("invalid range")?,
 231                    )?,
 232                    name: message.name,
 233                    version: language::proto::deserialize_version(&message.version),
 234                })
 235            }
 236            proto::context_operation::Variant::SlashCommandOutputSectionAdded(message) => {
 237                let section = message.section.context("missing section")?;
 238                Ok(Self::SlashCommandOutputSectionAdded {
 239                    timestamp: language::proto::deserialize_timestamp(
 240                        message.timestamp.context("missing timestamp")?,
 241                    ),
 242                    section: SlashCommandOutputSection {
 243                        range: language::proto::deserialize_anchor_range(
 244                            section.range.context("invalid range")?,
 245                        )?,
 246                        icon: section.icon_name.parse()?,
 247                        label: section.label.into(),
 248                        metadata: section
 249                            .metadata
 250                            .and_then(|metadata| serde_json::from_str(&metadata).log_err()),
 251                    },
 252                    version: language::proto::deserialize_version(&message.version),
 253                })
 254            }
 255            proto::context_operation::Variant::SlashCommandCompleted(message) => {
 256                Ok(Self::SlashCommandFinished {
 257                    id: InvokedSlashCommandId(language::proto::deserialize_timestamp(
 258                        message.id.context("invalid id")?,
 259                    )),
 260                    timestamp: language::proto::deserialize_timestamp(
 261                        message.timestamp.context("missing timestamp")?,
 262                    ),
 263                    error_message: message.error_message,
 264                    version: language::proto::deserialize_version(&message.version),
 265                })
 266            }
 267            proto::context_operation::Variant::ThoughtProcessOutputSectionAdded(message) => {
 268                let section = message.section.context("missing section")?;
 269                Ok(Self::ThoughtProcessOutputSectionAdded {
 270                    timestamp: language::proto::deserialize_timestamp(
 271                        message.timestamp.context("missing timestamp")?,
 272                    ),
 273                    section: ThoughtProcessOutputSection {
 274                        range: language::proto::deserialize_anchor_range(
 275                            section.range.context("invalid range")?,
 276                        )?,
 277                    },
 278                    version: language::proto::deserialize_version(&message.version),
 279                })
 280            }
 281            proto::context_operation::Variant::BufferOperation(op) => Ok(Self::BufferOperation(
 282                language::proto::deserialize_operation(
 283                    op.operation.context("invalid buffer operation")?,
 284                )?,
 285            )),
 286        }
 287    }
 288
 289    pub fn to_proto(&self) -> proto::ContextOperation {
 290        match self {
 291            Self::InsertMessage {
 292                anchor,
 293                metadata,
 294                version,
 295            } => proto::ContextOperation {
 296                variant: Some(proto::context_operation::Variant::InsertMessage(
 297                    proto::context_operation::InsertMessage {
 298                        message: Some(proto::ContextMessage {
 299                            id: Some(language::proto::serialize_timestamp(anchor.id.0)),
 300                            start: Some(language::proto::serialize_anchor(&anchor.start)),
 301                            role: metadata.role.to_proto() as i32,
 302                            status: Some(metadata.status.to_proto()),
 303                        }),
 304                        version: language::proto::serialize_version(version),
 305                    },
 306                )),
 307            },
 308            Self::UpdateMessage {
 309                message_id,
 310                metadata,
 311                version,
 312            } => proto::ContextOperation {
 313                variant: Some(proto::context_operation::Variant::UpdateMessage(
 314                    proto::context_operation::UpdateMessage {
 315                        message_id: Some(language::proto::serialize_timestamp(message_id.0)),
 316                        role: metadata.role.to_proto() as i32,
 317                        status: Some(metadata.status.to_proto()),
 318                        timestamp: Some(language::proto::serialize_timestamp(metadata.timestamp)),
 319                        version: language::proto::serialize_version(version),
 320                    },
 321                )),
 322            },
 323            Self::UpdateSummary { summary, version } => proto::ContextOperation {
 324                variant: Some(proto::context_operation::Variant::UpdateSummary(
 325                    proto::context_operation::UpdateSummary {
 326                        summary: summary.text.clone(),
 327                        done: summary.done,
 328                        timestamp: Some(language::proto::serialize_timestamp(summary.timestamp)),
 329                        version: language::proto::serialize_version(version),
 330                    },
 331                )),
 332            },
 333            Self::SlashCommandStarted {
 334                id,
 335                output_range,
 336                name,
 337                version,
 338            } => proto::ContextOperation {
 339                variant: Some(proto::context_operation::Variant::SlashCommandStarted(
 340                    proto::context_operation::SlashCommandStarted {
 341                        id: Some(language::proto::serialize_timestamp(id.0)),
 342                        output_range: Some(language::proto::serialize_anchor_range(
 343                            output_range.clone(),
 344                        )),
 345                        name: name.clone(),
 346                        version: language::proto::serialize_version(version),
 347                    },
 348                )),
 349            },
 350            Self::SlashCommandOutputSectionAdded {
 351                timestamp,
 352                section,
 353                version,
 354            } => proto::ContextOperation {
 355                variant: Some(
 356                    proto::context_operation::Variant::SlashCommandOutputSectionAdded(
 357                        proto::context_operation::SlashCommandOutputSectionAdded {
 358                            timestamp: Some(language::proto::serialize_timestamp(*timestamp)),
 359                            section: Some({
 360                                let icon_name: &'static str = section.icon.into();
 361                                proto::SlashCommandOutputSection {
 362                                    range: Some(language::proto::serialize_anchor_range(
 363                                        section.range.clone(),
 364                                    )),
 365                                    icon_name: icon_name.to_string(),
 366                                    label: section.label.to_string(),
 367                                    metadata: section.metadata.as_ref().and_then(|metadata| {
 368                                        serde_json::to_string(metadata).log_err()
 369                                    }),
 370                                }
 371                            }),
 372                            version: language::proto::serialize_version(version),
 373                        },
 374                    ),
 375                ),
 376            },
 377            Self::SlashCommandFinished {
 378                id,
 379                timestamp,
 380                error_message,
 381                version,
 382            } => proto::ContextOperation {
 383                variant: Some(proto::context_operation::Variant::SlashCommandCompleted(
 384                    proto::context_operation::SlashCommandCompleted {
 385                        id: Some(language::proto::serialize_timestamp(id.0)),
 386                        timestamp: Some(language::proto::serialize_timestamp(*timestamp)),
 387                        error_message: error_message.clone(),
 388                        version: language::proto::serialize_version(version),
 389                    },
 390                )),
 391            },
 392            Self::ThoughtProcessOutputSectionAdded {
 393                timestamp,
 394                section,
 395                version,
 396            } => proto::ContextOperation {
 397                variant: Some(
 398                    proto::context_operation::Variant::ThoughtProcessOutputSectionAdded(
 399                        proto::context_operation::ThoughtProcessOutputSectionAdded {
 400                            timestamp: Some(language::proto::serialize_timestamp(*timestamp)),
 401                            section: Some({
 402                                proto::ThoughtProcessOutputSection {
 403                                    range: Some(language::proto::serialize_anchor_range(
 404                                        section.range.clone(),
 405                                    )),
 406                                }
 407                            }),
 408                            version: language::proto::serialize_version(version),
 409                        },
 410                    ),
 411                ),
 412            },
 413            Self::BufferOperation(operation) => proto::ContextOperation {
 414                variant: Some(proto::context_operation::Variant::BufferOperation(
 415                    proto::context_operation::BufferOperation {
 416                        operation: Some(language::proto::serialize_operation(operation)),
 417                    },
 418                )),
 419            },
 420        }
 421    }
 422
 423    fn timestamp(&self) -> clock::Lamport {
 424        match self {
 425            Self::InsertMessage { anchor, .. } => anchor.id.0,
 426            Self::UpdateMessage { metadata, .. } => metadata.timestamp,
 427            Self::UpdateSummary { summary, .. } => summary.timestamp,
 428            Self::SlashCommandStarted { id, .. } => id.0,
 429            Self::SlashCommandOutputSectionAdded { timestamp, .. }
 430            | Self::SlashCommandFinished { timestamp, .. }
 431            | Self::ThoughtProcessOutputSectionAdded { timestamp, .. } => *timestamp,
 432            Self::BufferOperation(_) => {
 433                panic!("reading the timestamp of a buffer operation is not supported")
 434            }
 435        }
 436    }
 437
 438    /// Returns the current version of the context operation.
 439    pub fn version(&self) -> &clock::Global {
 440        match self {
 441            Self::InsertMessage { version, .. }
 442            | Self::UpdateMessage { version, .. }
 443            | Self::UpdateSummary { version, .. }
 444            | Self::SlashCommandStarted { version, .. }
 445            | Self::SlashCommandOutputSectionAdded { version, .. }
 446            | Self::SlashCommandFinished { version, .. }
 447            | Self::ThoughtProcessOutputSectionAdded { version, .. } => version,
 448            Self::BufferOperation(_) => {
 449                panic!("reading the version of a buffer operation is not supported")
 450            }
 451        }
 452    }
 453}
 454
 455#[derive(Debug, Clone)]
 456pub enum ContextEvent {
 457    ShowAssistError(SharedString),
 458    ShowPaymentRequiredError,
 459    MessagesEdited,
 460    SummaryChanged,
 461    SummaryGenerated,
 462    PathChanged {
 463        old_path: Option<Arc<Path>>,
 464        new_path: Arc<Path>,
 465    },
 466    StreamedCompletion,
 467    StartedThoughtProcess(Range<language::Anchor>),
 468    EndedThoughtProcess(language::Anchor),
 469    InvokedSlashCommandChanged {
 470        command_id: InvokedSlashCommandId,
 471    },
 472    ParsedSlashCommandsUpdated {
 473        removed: Vec<Range<language::Anchor>>,
 474        updated: Vec<ParsedSlashCommand>,
 475    },
 476    SlashCommandOutputSectionAdded {
 477        section: SlashCommandOutputSection<language::Anchor>,
 478    },
 479    Operation(ContextOperation),
 480}
 481
 482#[derive(Clone, Debug, Eq, PartialEq)]
 483pub enum ContextSummary {
 484    Pending,
 485    Content(ContextSummaryContent),
 486    Error,
 487}
 488
 489#[derive(Default, Clone, Debug, Eq, PartialEq)]
 490pub struct ContextSummaryContent {
 491    pub text: String,
 492    pub done: bool,
 493    pub timestamp: clock::Lamport,
 494}
 495
 496impl ContextSummary {
 497    pub const DEFAULT: &str = "New Text Thread";
 498
 499    pub fn or_default(&self) -> SharedString {
 500        self.unwrap_or(Self::DEFAULT)
 501    }
 502
 503    pub fn unwrap_or(&self, message: impl Into<SharedString>) -> SharedString {
 504        self.content()
 505            .map_or_else(|| message.into(), |content| content.text.clone().into())
 506    }
 507
 508    pub fn content(&self) -> Option<&ContextSummaryContent> {
 509        match self {
 510            ContextSummary::Content(content) => Some(content),
 511            ContextSummary::Pending | ContextSummary::Error => None,
 512        }
 513    }
 514
 515    fn content_as_mut(&mut self) -> Option<&mut ContextSummaryContent> {
 516        match self {
 517            ContextSummary::Content(content) => Some(content),
 518            ContextSummary::Pending | ContextSummary::Error => None,
 519        }
 520    }
 521
 522    fn content_or_set_empty(&mut self) -> &mut ContextSummaryContent {
 523        match self {
 524            ContextSummary::Content(content) => content,
 525            ContextSummary::Pending | ContextSummary::Error => {
 526                let content = ContextSummaryContent::default();
 527                *self = ContextSummary::Content(content);
 528                self.content_as_mut().unwrap()
 529            }
 530        }
 531    }
 532
 533    pub fn is_pending(&self) -> bool {
 534        matches!(self, ContextSummary::Pending)
 535    }
 536
 537    fn timestamp(&self) -> Option<clock::Lamport> {
 538        match self {
 539            ContextSummary::Content(content) => Some(content.timestamp),
 540            ContextSummary::Pending | ContextSummary::Error => None,
 541        }
 542    }
 543}
 544
 545impl PartialOrd for ContextSummary {
 546    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 547        self.timestamp().partial_cmp(&other.timestamp())
 548    }
 549}
 550
 551#[derive(Clone, Debug, Eq, PartialEq)]
 552pub struct MessageAnchor {
 553    pub id: MessageId,
 554    pub start: language::Anchor,
 555}
 556
 557#[derive(Clone, Debug, Eq, PartialEq)]
 558pub enum CacheStatus {
 559    Pending,
 560    Cached,
 561}
 562
 563#[derive(Clone, Debug, Eq, PartialEq)]
 564pub struct MessageCacheMetadata {
 565    pub is_anchor: bool,
 566    pub is_final_anchor: bool,
 567    pub status: CacheStatus,
 568    pub cached_at: clock::Global,
 569}
 570
 571#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
 572pub struct MessageMetadata {
 573    pub role: Role,
 574    pub status: MessageStatus,
 575    pub timestamp: clock::Lamport,
 576    #[serde(skip)]
 577    pub cache: Option<MessageCacheMetadata>,
 578}
 579
 580impl From<&Message> for MessageMetadata {
 581    fn from(message: &Message) -> Self {
 582        Self {
 583            role: message.role,
 584            status: message.status.clone(),
 585            timestamp: message.id.0,
 586            cache: message.cache.clone(),
 587        }
 588    }
 589}
 590
 591impl MessageMetadata {
 592    pub fn is_cache_valid(&self, buffer: &BufferSnapshot, range: &Range<usize>) -> bool {
 593        let result = match &self.cache {
 594            Some(MessageCacheMetadata { cached_at, .. }) => !buffer.has_edits_since_in_range(
 595                cached_at,
 596                Range {
 597                    start: buffer.anchor_at(range.start, Bias::Right),
 598                    end: buffer.anchor_at(range.end, Bias::Left),
 599                },
 600            ),
 601            _ => false,
 602        };
 603        result
 604    }
 605}
 606
 607#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
 608pub struct ThoughtProcessOutputSection<T> {
 609    pub range: Range<T>,
 610}
 611
 612impl ThoughtProcessOutputSection<language::Anchor> {
 613    pub fn is_valid(&self, buffer: &language::TextBuffer) -> bool {
 614        self.range.start.is_valid(buffer) && !self.range.to_offset(buffer).is_empty()
 615    }
 616}
 617
 618#[derive(Clone, Debug)]
 619pub struct Message {
 620    pub offset_range: Range<usize>,
 621    pub index_range: Range<usize>,
 622    pub anchor_range: Range<language::Anchor>,
 623    pub id: MessageId,
 624    pub role: Role,
 625    pub status: MessageStatus,
 626    pub cache: Option<MessageCacheMetadata>,
 627}
 628
 629#[derive(Debug, Clone)]
 630pub enum Content {
 631    Image {
 632        anchor: language::Anchor,
 633        image_id: u64,
 634        render_image: Arc<RenderImage>,
 635        image: Shared<Task<Option<LanguageModelImage>>>,
 636    },
 637}
 638
 639impl Content {
 640    fn range(&self) -> Range<language::Anchor> {
 641        match self {
 642            Self::Image { anchor, .. } => *anchor..*anchor,
 643        }
 644    }
 645
 646    fn cmp(&self, other: &Self, buffer: &BufferSnapshot) -> Ordering {
 647        let self_range = self.range();
 648        let other_range = other.range();
 649        if self_range.end.cmp(&other_range.start, buffer).is_lt() {
 650            Ordering::Less
 651        } else if self_range.start.cmp(&other_range.end, buffer).is_gt() {
 652            Ordering::Greater
 653        } else {
 654            Ordering::Equal
 655        }
 656    }
 657}
 658
 659struct PendingCompletion {
 660    id: usize,
 661    assistant_message_id: MessageId,
 662    _task: Task<()>,
 663}
 664
 665#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
 666pub struct InvokedSlashCommandId(clock::Lamport);
 667
 668pub struct AssistantContext {
 669    id: ContextId,
 670    timestamp: clock::Lamport,
 671    version: clock::Global,
 672    pending_ops: Vec<ContextOperation>,
 673    operations: Vec<ContextOperation>,
 674    buffer: Entity<Buffer>,
 675    parsed_slash_commands: Vec<ParsedSlashCommand>,
 676    invoked_slash_commands: HashMap<InvokedSlashCommandId, InvokedSlashCommand>,
 677    edits_since_last_parse: language::Subscription,
 678    slash_commands: Arc<SlashCommandWorkingSet>,
 679    slash_command_output_sections: Vec<SlashCommandOutputSection<language::Anchor>>,
 680    thought_process_output_sections: Vec<ThoughtProcessOutputSection<language::Anchor>>,
 681    message_anchors: Vec<MessageAnchor>,
 682    contents: Vec<Content>,
 683    messages_metadata: HashMap<MessageId, MessageMetadata>,
 684    summary: ContextSummary,
 685    summary_task: Task<Option<()>>,
 686    completion_count: usize,
 687    pending_completions: Vec<PendingCompletion>,
 688    token_count: Option<u64>,
 689    pending_token_count: Task<Option<()>>,
 690    pending_save: Task<Result<()>>,
 691    pending_cache_warming_task: Task<Option<()>>,
 692    path: Option<Arc<Path>>,
 693    _subscriptions: Vec<Subscription>,
 694    telemetry: Option<Arc<Telemetry>>,
 695    language_registry: Arc<LanguageRegistry>,
 696    project: Option<Entity<Project>>,
 697    prompt_builder: Arc<PromptBuilder>,
 698    completion_mode: agent_settings::CompletionMode,
 699}
 700
 701trait ContextAnnotation {
 702    fn range(&self) -> &Range<language::Anchor>;
 703}
 704
 705impl ContextAnnotation for ParsedSlashCommand {
 706    fn range(&self) -> &Range<language::Anchor> {
 707        &self.source_range
 708    }
 709}
 710
 711impl EventEmitter<ContextEvent> for AssistantContext {}
 712
 713impl AssistantContext {
 714    pub fn local(
 715        language_registry: Arc<LanguageRegistry>,
 716        project: Option<Entity<Project>>,
 717        telemetry: Option<Arc<Telemetry>>,
 718        prompt_builder: Arc<PromptBuilder>,
 719        slash_commands: Arc<SlashCommandWorkingSet>,
 720        cx: &mut Context<Self>,
 721    ) -> Self {
 722        Self::new(
 723            ContextId::new(),
 724            ReplicaId::default(),
 725            language::Capability::ReadWrite,
 726            language_registry,
 727            prompt_builder,
 728            slash_commands,
 729            project,
 730            telemetry,
 731            cx,
 732        )
 733    }
 734
 735    pub fn completion_mode(&self) -> agent_settings::CompletionMode {
 736        self.completion_mode
 737    }
 738
 739    pub fn set_completion_mode(&mut self, completion_mode: agent_settings::CompletionMode) {
 740        self.completion_mode = completion_mode;
 741    }
 742
 743    pub fn new(
 744        id: ContextId,
 745        replica_id: ReplicaId,
 746        capability: language::Capability,
 747        language_registry: Arc<LanguageRegistry>,
 748        prompt_builder: Arc<PromptBuilder>,
 749        slash_commands: Arc<SlashCommandWorkingSet>,
 750        project: Option<Entity<Project>>,
 751        telemetry: Option<Arc<Telemetry>>,
 752        cx: &mut Context<Self>,
 753    ) -> Self {
 754        let buffer = cx.new(|_cx| {
 755            let buffer = Buffer::remote(
 756                language::BufferId::new(1).unwrap(),
 757                replica_id,
 758                capability,
 759                "",
 760            );
 761            buffer.set_language_registry(language_registry.clone());
 762            buffer
 763        });
 764        let edits_since_last_slash_command_parse =
 765            buffer.update(cx, |buffer, _| buffer.subscribe());
 766        let mut this = Self {
 767            id,
 768            timestamp: clock::Lamport::new(replica_id),
 769            version: clock::Global::new(),
 770            pending_ops: Vec::new(),
 771            operations: Vec::new(),
 772            message_anchors: Default::default(),
 773            contents: Default::default(),
 774            messages_metadata: Default::default(),
 775            parsed_slash_commands: Vec::new(),
 776            invoked_slash_commands: HashMap::default(),
 777            slash_command_output_sections: Vec::new(),
 778            thought_process_output_sections: Vec::new(),
 779            edits_since_last_parse: edits_since_last_slash_command_parse,
 780            summary: ContextSummary::Pending,
 781            summary_task: Task::ready(None),
 782            completion_count: Default::default(),
 783            pending_completions: Default::default(),
 784            token_count: None,
 785            pending_token_count: Task::ready(None),
 786            pending_cache_warming_task: Task::ready(None),
 787            _subscriptions: vec![cx.subscribe(&buffer, Self::handle_buffer_event)],
 788            pending_save: Task::ready(Ok(())),
 789            completion_mode: AgentSettings::get_global(cx).preferred_completion_mode,
 790            path: None,
 791            buffer,
 792            telemetry,
 793            project,
 794            language_registry,
 795            slash_commands,
 796            prompt_builder,
 797        };
 798
 799        let first_message_id = MessageId(clock::Lamport {
 800            replica_id: 0,
 801            value: 0,
 802        });
 803        let message = MessageAnchor {
 804            id: first_message_id,
 805            start: language::Anchor::MIN,
 806        };
 807        this.messages_metadata.insert(
 808            first_message_id,
 809            MessageMetadata {
 810                role: Role::User,
 811                status: MessageStatus::Done,
 812                timestamp: first_message_id.0,
 813                cache: None,
 814            },
 815        );
 816        this.message_anchors.push(message);
 817
 818        this.set_language(cx);
 819        this.count_remaining_tokens(cx);
 820        this
 821    }
 822
 823    pub(crate) fn serialize(&self, cx: &App) -> SavedContext {
 824        let buffer = self.buffer.read(cx);
 825        SavedContext {
 826            id: Some(self.id.clone()),
 827            zed: "context".into(),
 828            version: SavedContext::VERSION.into(),
 829            text: buffer.text(),
 830            messages: self
 831                .messages(cx)
 832                .map(|message| SavedMessage {
 833                    id: message.id,
 834                    start: message.offset_range.start,
 835                    metadata: self.messages_metadata[&message.id].clone(),
 836                })
 837                .collect(),
 838            summary: self
 839                .summary
 840                .content()
 841                .map(|summary| summary.text.clone())
 842                .unwrap_or_default(),
 843            slash_command_output_sections: self
 844                .slash_command_output_sections
 845                .iter()
 846                .filter_map(|section| {
 847                    if section.is_valid(buffer) {
 848                        let range = section.range.to_offset(buffer);
 849                        Some(assistant_slash_command::SlashCommandOutputSection {
 850                            range,
 851                            icon: section.icon,
 852                            label: section.label.clone(),
 853                            metadata: section.metadata.clone(),
 854                        })
 855                    } else {
 856                        None
 857                    }
 858                })
 859                .collect(),
 860            thought_process_output_sections: self
 861                .thought_process_output_sections
 862                .iter()
 863                .filter_map(|section| {
 864                    if section.is_valid(buffer) {
 865                        let range = section.range.to_offset(buffer);
 866                        Some(ThoughtProcessOutputSection { range })
 867                    } else {
 868                        None
 869                    }
 870                })
 871                .collect(),
 872        }
 873    }
 874
 875    pub fn deserialize(
 876        saved_context: SavedContext,
 877        path: Arc<Path>,
 878        language_registry: Arc<LanguageRegistry>,
 879        prompt_builder: Arc<PromptBuilder>,
 880        slash_commands: Arc<SlashCommandWorkingSet>,
 881        project: Option<Entity<Project>>,
 882        telemetry: Option<Arc<Telemetry>>,
 883        cx: &mut Context<Self>,
 884    ) -> Self {
 885        let id = saved_context.id.clone().unwrap_or_else(ContextId::new);
 886        let mut this = Self::new(
 887            id,
 888            ReplicaId::default(),
 889            language::Capability::ReadWrite,
 890            language_registry,
 891            prompt_builder,
 892            slash_commands,
 893            project,
 894            telemetry,
 895            cx,
 896        );
 897        this.path = Some(path);
 898        this.buffer.update(cx, |buffer, cx| {
 899            buffer.set_text(saved_context.text.as_str(), cx)
 900        });
 901        let operations = saved_context.into_ops(&this.buffer, cx);
 902        this.apply_ops(operations, cx);
 903        this
 904    }
 905
 906    pub fn id(&self) -> &ContextId {
 907        &self.id
 908    }
 909
 910    pub fn replica_id(&self) -> ReplicaId {
 911        self.timestamp.replica_id
 912    }
 913
 914    pub fn version(&self, cx: &App) -> ContextVersion {
 915        ContextVersion {
 916            context: self.version.clone(),
 917            buffer: self.buffer.read(cx).version(),
 918        }
 919    }
 920
 921    pub fn slash_commands(&self) -> &Arc<SlashCommandWorkingSet> {
 922        &self.slash_commands
 923    }
 924
 925    pub fn set_capability(&mut self, capability: language::Capability, cx: &mut Context<Self>) {
 926        self.buffer
 927            .update(cx, |buffer, cx| buffer.set_capability(capability, cx));
 928    }
 929
 930    fn next_timestamp(&mut self) -> clock::Lamport {
 931        let timestamp = self.timestamp.tick();
 932        self.version.observe(timestamp);
 933        timestamp
 934    }
 935
 936    pub fn serialize_ops(
 937        &self,
 938        since: &ContextVersion,
 939        cx: &App,
 940    ) -> Task<Vec<proto::ContextOperation>> {
 941        let buffer_ops = self
 942            .buffer
 943            .read(cx)
 944            .serialize_ops(Some(since.buffer.clone()), cx);
 945
 946        let mut context_ops = self
 947            .operations
 948            .iter()
 949            .filter(|op| !since.context.observed(op.timestamp()))
 950            .cloned()
 951            .collect::<Vec<_>>();
 952        context_ops.extend(self.pending_ops.iter().cloned());
 953
 954        cx.background_spawn(async move {
 955            let buffer_ops = buffer_ops.await;
 956            context_ops.sort_unstable_by_key(|op| op.timestamp());
 957            buffer_ops
 958                .into_iter()
 959                .map(|op| proto::ContextOperation {
 960                    variant: Some(proto::context_operation::Variant::BufferOperation(
 961                        proto::context_operation::BufferOperation {
 962                            operation: Some(op),
 963                        },
 964                    )),
 965                })
 966                .chain(context_ops.into_iter().map(|op| op.to_proto()))
 967                .collect()
 968        })
 969    }
 970
 971    pub fn apply_ops(
 972        &mut self,
 973        ops: impl IntoIterator<Item = ContextOperation>,
 974        cx: &mut Context<Self>,
 975    ) {
 976        let mut buffer_ops = Vec::new();
 977        for op in ops {
 978            match op {
 979                ContextOperation::BufferOperation(buffer_op) => buffer_ops.push(buffer_op),
 980                op @ _ => self.pending_ops.push(op),
 981            }
 982        }
 983        self.buffer
 984            .update(cx, |buffer, cx| buffer.apply_ops(buffer_ops, cx));
 985        self.flush_ops(cx);
 986    }
 987
 988    fn flush_ops(&mut self, cx: &mut Context<AssistantContext>) {
 989        let mut changed_messages = HashSet::default();
 990        let mut summary_generated = false;
 991
 992        self.pending_ops.sort_unstable_by_key(|op| op.timestamp());
 993        for op in mem::take(&mut self.pending_ops) {
 994            if !self.can_apply_op(&op, cx) {
 995                self.pending_ops.push(op);
 996                continue;
 997            }
 998
 999            let timestamp = op.timestamp();
1000            match op.clone() {
1001                ContextOperation::InsertMessage {
1002                    anchor, metadata, ..
1003                } => {
1004                    if self.messages_metadata.contains_key(&anchor.id) {
1005                        // We already applied this operation.
1006                    } else {
1007                        changed_messages.insert(anchor.id);
1008                        self.insert_message(anchor, metadata, cx);
1009                    }
1010                }
1011                ContextOperation::UpdateMessage {
1012                    message_id,
1013                    metadata: new_metadata,
1014                    ..
1015                } => {
1016                    let metadata = self.messages_metadata.get_mut(&message_id).unwrap();
1017                    if new_metadata.timestamp > metadata.timestamp {
1018                        *metadata = new_metadata;
1019                        changed_messages.insert(message_id);
1020                    }
1021                }
1022                ContextOperation::UpdateSummary {
1023                    summary: new_summary,
1024                    ..
1025                } => {
1026                    if self.summary.timestamp().map_or(true, |current_timestamp| {
1027                        new_summary.timestamp > current_timestamp
1028                    }) {
1029                        self.summary = ContextSummary::Content(new_summary);
1030                        summary_generated = true;
1031                    }
1032                }
1033                ContextOperation::SlashCommandStarted {
1034                    id,
1035                    output_range,
1036                    name,
1037                    ..
1038                } => {
1039                    self.invoked_slash_commands.insert(
1040                        id,
1041                        InvokedSlashCommand {
1042                            name: name.into(),
1043                            range: output_range,
1044                            run_commands_in_ranges: Vec::new(),
1045                            status: InvokedSlashCommandStatus::Running(Task::ready(())),
1046                            transaction: None,
1047                            timestamp: id.0,
1048                        },
1049                    );
1050                    cx.emit(ContextEvent::InvokedSlashCommandChanged { command_id: id });
1051                }
1052                ContextOperation::SlashCommandOutputSectionAdded { section, .. } => {
1053                    let buffer = self.buffer.read(cx);
1054                    if let Err(ix) = self
1055                        .slash_command_output_sections
1056                        .binary_search_by(|probe| probe.range.cmp(&section.range, buffer))
1057                    {
1058                        self.slash_command_output_sections
1059                            .insert(ix, section.clone());
1060                        cx.emit(ContextEvent::SlashCommandOutputSectionAdded { section });
1061                    }
1062                }
1063                ContextOperation::ThoughtProcessOutputSectionAdded { section, .. } => {
1064                    let buffer = self.buffer.read(cx);
1065                    if let Err(ix) = self
1066                        .thought_process_output_sections
1067                        .binary_search_by(|probe| probe.range.cmp(&section.range, buffer))
1068                    {
1069                        self.thought_process_output_sections
1070                            .insert(ix, section.clone());
1071                    }
1072                }
1073                ContextOperation::SlashCommandFinished {
1074                    id,
1075                    error_message,
1076                    timestamp,
1077                    ..
1078                } => {
1079                    if let Some(slash_command) = self.invoked_slash_commands.get_mut(&id)
1080                        && timestamp > slash_command.timestamp {
1081                            slash_command.timestamp = timestamp;
1082                            match error_message {
1083                                Some(message) => {
1084                                    slash_command.status =
1085                                        InvokedSlashCommandStatus::Error(message.into());
1086                                }
1087                                None => {
1088                                    slash_command.status = InvokedSlashCommandStatus::Finished;
1089                                }
1090                            }
1091                            cx.emit(ContextEvent::InvokedSlashCommandChanged { command_id: id });
1092                        }
1093                }
1094                ContextOperation::BufferOperation(_) => unreachable!(),
1095            }
1096
1097            self.version.observe(timestamp);
1098            self.timestamp.observe(timestamp);
1099            self.operations.push(op);
1100        }
1101
1102        if !changed_messages.is_empty() {
1103            self.message_roles_updated(changed_messages, cx);
1104            cx.emit(ContextEvent::MessagesEdited);
1105            cx.notify();
1106        }
1107
1108        if summary_generated {
1109            cx.emit(ContextEvent::SummaryChanged);
1110            cx.emit(ContextEvent::SummaryGenerated);
1111            cx.notify();
1112        }
1113    }
1114
1115    fn can_apply_op(&self, op: &ContextOperation, cx: &App) -> bool {
1116        if !self.version.observed_all(op.version()) {
1117            return false;
1118        }
1119
1120        match op {
1121            ContextOperation::InsertMessage { anchor, .. } => self
1122                .buffer
1123                .read(cx)
1124                .version
1125                .observed(anchor.start.timestamp),
1126            ContextOperation::UpdateMessage { message_id, .. } => {
1127                self.messages_metadata.contains_key(message_id)
1128            }
1129            ContextOperation::UpdateSummary { .. } => true,
1130            ContextOperation::SlashCommandStarted { output_range, .. } => {
1131                self.has_received_operations_for_anchor_range(output_range.clone(), cx)
1132            }
1133            ContextOperation::SlashCommandOutputSectionAdded { section, .. } => {
1134                self.has_received_operations_for_anchor_range(section.range.clone(), cx)
1135            }
1136            ContextOperation::ThoughtProcessOutputSectionAdded { section, .. } => {
1137                self.has_received_operations_for_anchor_range(section.range.clone(), cx)
1138            }
1139            ContextOperation::SlashCommandFinished { .. } => true,
1140            ContextOperation::BufferOperation(_) => {
1141                panic!("buffer operations should always be applied")
1142            }
1143        }
1144    }
1145
1146    fn has_received_operations_for_anchor_range(
1147        &self,
1148        range: Range<text::Anchor>,
1149        cx: &App,
1150    ) -> bool {
1151        let version = &self.buffer.read(cx).version;
1152        let observed_start = range.start == language::Anchor::MIN
1153            || range.start == language::Anchor::MAX
1154            || version.observed(range.start.timestamp);
1155        let observed_end = range.end == language::Anchor::MIN
1156            || range.end == language::Anchor::MAX
1157            || version.observed(range.end.timestamp);
1158        observed_start && observed_end
1159    }
1160
1161    fn push_op(&mut self, op: ContextOperation, cx: &mut Context<Self>) {
1162        self.operations.push(op.clone());
1163        cx.emit(ContextEvent::Operation(op));
1164    }
1165
1166    pub fn buffer(&self) -> &Entity<Buffer> {
1167        &self.buffer
1168    }
1169
1170    pub fn language_registry(&self) -> Arc<LanguageRegistry> {
1171        self.language_registry.clone()
1172    }
1173
1174    pub fn project(&self) -> Option<Entity<Project>> {
1175        self.project.clone()
1176    }
1177
1178    pub fn prompt_builder(&self) -> Arc<PromptBuilder> {
1179        self.prompt_builder.clone()
1180    }
1181
1182    pub fn path(&self) -> Option<&Arc<Path>> {
1183        self.path.as_ref()
1184    }
1185
1186    pub fn summary(&self) -> &ContextSummary {
1187        &self.summary
1188    }
1189
1190    pub fn parsed_slash_commands(&self) -> &[ParsedSlashCommand] {
1191        &self.parsed_slash_commands
1192    }
1193
1194    pub fn invoked_slash_command(
1195        &self,
1196        command_id: &InvokedSlashCommandId,
1197    ) -> Option<&InvokedSlashCommand> {
1198        self.invoked_slash_commands.get(command_id)
1199    }
1200
1201    pub fn slash_command_output_sections(&self) -> &[SlashCommandOutputSection<language::Anchor>] {
1202        &self.slash_command_output_sections
1203    }
1204
1205    pub fn thought_process_output_sections(
1206        &self,
1207    ) -> &[ThoughtProcessOutputSection<language::Anchor>] {
1208        &self.thought_process_output_sections
1209    }
1210
1211    pub fn contains_files(&self, cx: &App) -> bool {
1212        let buffer = self.buffer.read(cx);
1213        self.slash_command_output_sections.iter().any(|section| {
1214            section.is_valid(buffer)
1215                && section
1216                    .metadata
1217                    .as_ref()
1218                    .and_then(|metadata| {
1219                        serde_json::from_value::<FileCommandMetadata>(metadata.clone()).ok()
1220                    })
1221                    .is_some()
1222        })
1223    }
1224
1225    fn set_language(&mut self, cx: &mut Context<Self>) {
1226        let markdown = self.language_registry.language_for_name("Markdown");
1227        cx.spawn(async move |this, cx| {
1228            let markdown = markdown.await?;
1229            this.update(cx, |this, cx| {
1230                this.buffer
1231                    .update(cx, |buffer, cx| buffer.set_language(Some(markdown), cx));
1232            })
1233        })
1234        .detach_and_log_err(cx);
1235    }
1236
1237    fn handle_buffer_event(
1238        &mut self,
1239        _: Entity<Buffer>,
1240        event: &language::BufferEvent,
1241        cx: &mut Context<Self>,
1242    ) {
1243        match event {
1244            language::BufferEvent::Operation {
1245                operation,
1246                is_local: true,
1247            } => cx.emit(ContextEvent::Operation(ContextOperation::BufferOperation(
1248                operation.clone(),
1249            ))),
1250            language::BufferEvent::Edited => {
1251                self.count_remaining_tokens(cx);
1252                self.reparse(cx);
1253                cx.emit(ContextEvent::MessagesEdited);
1254            }
1255            _ => {}
1256        }
1257    }
1258
1259    pub fn token_count(&self) -> Option<u64> {
1260        self.token_count
1261    }
1262
1263    pub(crate) fn count_remaining_tokens(&mut self, cx: &mut Context<Self>) {
1264        // Assume it will be a Chat request, even though that takes fewer tokens (and risks going over the limit),
1265        // because otherwise you see in the UI that your empty message has a bunch of tokens already used.
1266        let Some(model) = LanguageModelRegistry::read_global(cx).default_model() else {
1267            return;
1268        };
1269        let request = self.to_completion_request(Some(&model.model), cx);
1270        let debounce = self.token_count.is_some();
1271        self.pending_token_count = cx.spawn(async move |this, cx| {
1272            async move {
1273                if debounce {
1274                    cx.background_executor()
1275                        .timer(Duration::from_millis(200))
1276                        .await;
1277                }
1278
1279                let token_count = cx
1280                    .update(|cx| model.model.count_tokens(request, cx))?
1281                    .await?;
1282                this.update(cx, |this, cx| {
1283                    this.token_count = Some(token_count);
1284                    this.start_cache_warming(&model.model, cx);
1285                    cx.notify()
1286                })
1287            }
1288            .log_err()
1289            .await
1290        });
1291    }
1292
1293    pub fn mark_cache_anchors(
1294        &mut self,
1295        cache_configuration: &Option<LanguageModelCacheConfiguration>,
1296        speculative: bool,
1297        cx: &mut Context<Self>,
1298    ) -> bool {
1299        let cache_configuration =
1300            cache_configuration
1301                .as_ref()
1302                .unwrap_or(&LanguageModelCacheConfiguration {
1303                    max_cache_anchors: 0,
1304                    should_speculate: false,
1305                    min_total_token: 0,
1306                });
1307
1308        let messages: Vec<Message> = self.messages(cx).collect();
1309
1310        let mut sorted_messages = messages.clone();
1311        if speculative {
1312            // Avoid caching the last message if this is a speculative cache fetch as
1313            // it's likely to change.
1314            sorted_messages.pop();
1315        }
1316        sorted_messages.retain(|m| m.role == Role::User);
1317        sorted_messages.sort_by(|a, b| b.offset_range.len().cmp(&a.offset_range.len()));
1318
1319        let cache_anchors = if self.token_count.unwrap_or(0) < cache_configuration.min_total_token {
1320            // If we have't hit the minimum threshold to enable caching, don't cache anything.
1321            0
1322        } else {
1323            // Save 1 anchor for the inline assistant to use.
1324            max(cache_configuration.max_cache_anchors, 1) - 1
1325        };
1326        sorted_messages.truncate(cache_anchors);
1327
1328        let anchors: HashSet<MessageId> = sorted_messages
1329            .into_iter()
1330            .map(|message| message.id)
1331            .collect();
1332
1333        let buffer = self.buffer.read(cx).snapshot();
1334        let invalidated_caches: HashSet<MessageId> = messages
1335            .iter()
1336            .scan(false, |encountered_invalid, message| {
1337                let message_id = message.id;
1338                let is_invalid = self
1339                    .messages_metadata
1340                    .get(&message_id)
1341                    .map_or(true, |metadata| {
1342                        !metadata.is_cache_valid(&buffer, &message.offset_range)
1343                            || *encountered_invalid
1344                    });
1345                *encountered_invalid |= is_invalid;
1346                Some(if is_invalid { Some(message_id) } else { None })
1347            })
1348            .flatten()
1349            .collect();
1350
1351        let last_anchor = messages.iter().rev().find_map(|message| {
1352            if anchors.contains(&message.id) {
1353                Some(message.id)
1354            } else {
1355                None
1356            }
1357        });
1358
1359        let mut new_anchor_needs_caching = false;
1360        let current_version = &buffer.version;
1361        // If we have no anchors, mark all messages as not being cached.
1362        let mut hit_last_anchor = last_anchor.is_none();
1363
1364        for message in messages.iter() {
1365            if hit_last_anchor {
1366                self.update_metadata(message.id, cx, |metadata| metadata.cache = None);
1367                continue;
1368            }
1369
1370            if let Some(last_anchor) = last_anchor
1371                && message.id == last_anchor {
1372                    hit_last_anchor = true;
1373                }
1374
1375            new_anchor_needs_caching = new_anchor_needs_caching
1376                || (invalidated_caches.contains(&message.id) && anchors.contains(&message.id));
1377
1378            self.update_metadata(message.id, cx, |metadata| {
1379                let cache_status = if invalidated_caches.contains(&message.id) {
1380                    CacheStatus::Pending
1381                } else {
1382                    metadata
1383                        .cache
1384                        .as_ref()
1385                        .map_or(CacheStatus::Pending, |cm| cm.status.clone())
1386                };
1387                metadata.cache = Some(MessageCacheMetadata {
1388                    is_anchor: anchors.contains(&message.id),
1389                    is_final_anchor: hit_last_anchor,
1390                    status: cache_status,
1391                    cached_at: current_version.clone(),
1392                });
1393            });
1394        }
1395        new_anchor_needs_caching
1396    }
1397
1398    fn start_cache_warming(&mut self, model: &Arc<dyn LanguageModel>, cx: &mut Context<Self>) {
1399        let cache_configuration = model.cache_configuration();
1400
1401        if !self.mark_cache_anchors(&cache_configuration, true, cx) {
1402            return;
1403        }
1404        if !self.pending_completions.is_empty() {
1405            return;
1406        }
1407        if let Some(cache_configuration) = cache_configuration
1408            && !cache_configuration.should_speculate {
1409                return;
1410            }
1411
1412        let request = {
1413            let mut req = self.to_completion_request(Some(model), cx);
1414            // Skip the last message because it's likely to change and
1415            // therefore would be a waste to cache.
1416            req.messages.pop();
1417            req.messages.push(LanguageModelRequestMessage {
1418                role: Role::User,
1419                content: vec!["Respond only with OK, nothing else.".into()],
1420                cache: false,
1421            });
1422            req
1423        };
1424
1425        let model = Arc::clone(model);
1426        self.pending_cache_warming_task = cx.spawn(async move |this, cx| {
1427            async move {
1428                match model.stream_completion(request, cx).await {
1429                    Ok(mut stream) => {
1430                        stream.next().await;
1431                        log::info!("Cache warming completed successfully");
1432                    }
1433                    Err(e) => {
1434                        log::warn!("Cache warming failed: {}", e);
1435                    }
1436                };
1437                this.update(cx, |this, cx| {
1438                    this.update_cache_status_for_completion(cx);
1439                })
1440                .ok();
1441                anyhow::Ok(())
1442            }
1443            .log_err()
1444            .await
1445        });
1446    }
1447
1448    pub fn update_cache_status_for_completion(&mut self, cx: &mut Context<Self>) {
1449        let cached_message_ids: Vec<MessageId> = self
1450            .messages_metadata
1451            .iter()
1452            .filter_map(|(message_id, metadata)| {
1453                metadata.cache.as_ref().and_then(|cache| {
1454                    if cache.status == CacheStatus::Pending {
1455                        Some(*message_id)
1456                    } else {
1457                        None
1458                    }
1459                })
1460            })
1461            .collect();
1462
1463        for message_id in cached_message_ids {
1464            self.update_metadata(message_id, cx, |metadata| {
1465                if let Some(cache) = &mut metadata.cache {
1466                    cache.status = CacheStatus::Cached;
1467                }
1468            });
1469        }
1470        cx.notify();
1471    }
1472
1473    pub fn reparse(&mut self, cx: &mut Context<Self>) {
1474        let buffer = self.buffer.read(cx).text_snapshot();
1475        let mut row_ranges = self
1476            .edits_since_last_parse
1477            .consume()
1478            .into_iter()
1479            .map(|edit| {
1480                let start_row = buffer.offset_to_point(edit.new.start).row;
1481                let end_row = buffer.offset_to_point(edit.new.end).row + 1;
1482                start_row..end_row
1483            })
1484            .peekable();
1485
1486        let mut removed_parsed_slash_command_ranges = Vec::new();
1487        let mut updated_parsed_slash_commands = Vec::new();
1488        while let Some(mut row_range) = row_ranges.next() {
1489            while let Some(next_row_range) = row_ranges.peek() {
1490                if row_range.end >= next_row_range.start {
1491                    row_range.end = next_row_range.end;
1492                    row_ranges.next();
1493                } else {
1494                    break;
1495                }
1496            }
1497
1498            let start = buffer.anchor_before(Point::new(row_range.start, 0));
1499            let end = buffer.anchor_after(Point::new(
1500                row_range.end - 1,
1501                buffer.line_len(row_range.end - 1),
1502            ));
1503
1504            self.reparse_slash_commands_in_range(
1505                start..end,
1506                &buffer,
1507                &mut updated_parsed_slash_commands,
1508                &mut removed_parsed_slash_command_ranges,
1509                cx,
1510            );
1511            self.invalidate_pending_slash_commands(&buffer, cx);
1512        }
1513
1514        if !updated_parsed_slash_commands.is_empty()
1515            || !removed_parsed_slash_command_ranges.is_empty()
1516        {
1517            cx.emit(ContextEvent::ParsedSlashCommandsUpdated {
1518                removed: removed_parsed_slash_command_ranges,
1519                updated: updated_parsed_slash_commands,
1520            });
1521        }
1522    }
1523
1524    fn reparse_slash_commands_in_range(
1525        &mut self,
1526        range: Range<text::Anchor>,
1527        buffer: &BufferSnapshot,
1528        updated: &mut Vec<ParsedSlashCommand>,
1529        removed: &mut Vec<Range<text::Anchor>>,
1530        cx: &App,
1531    ) {
1532        let old_range = self.pending_command_indices_for_range(range.clone(), cx);
1533
1534        let mut new_commands = Vec::new();
1535        let mut lines = buffer.text_for_range(range).lines();
1536        let mut offset = lines.offset();
1537        while let Some(line) = lines.next() {
1538            if let Some(command_line) = SlashCommandLine::parse(line) {
1539                let name = &line[command_line.name.clone()];
1540                let arguments = command_line
1541                    .arguments
1542                    .iter()
1543                    .filter_map(|argument_range| {
1544                        if argument_range.is_empty() {
1545                            None
1546                        } else {
1547                            line.get(argument_range.clone())
1548                        }
1549                    })
1550                    .map(ToOwned::to_owned)
1551                    .collect::<SmallVec<_>>();
1552                if let Some(command) = self.slash_commands.command(name, cx)
1553                    && (!command.requires_argument() || !arguments.is_empty()) {
1554                        let start_ix = offset + command_line.name.start - 1;
1555                        let end_ix = offset
1556                            + command_line
1557                                .arguments
1558                                .last()
1559                                .map_or(command_line.name.end, |argument| argument.end);
1560                        let source_range =
1561                            buffer.anchor_after(start_ix)..buffer.anchor_after(end_ix);
1562                        let pending_command = ParsedSlashCommand {
1563                            name: name.to_string(),
1564                            arguments,
1565                            source_range,
1566                            status: PendingSlashCommandStatus::Idle,
1567                        };
1568                        updated.push(pending_command.clone());
1569                        new_commands.push(pending_command);
1570                    }
1571            }
1572
1573            offset = lines.offset();
1574        }
1575
1576        let removed_commands = self.parsed_slash_commands.splice(old_range, new_commands);
1577        removed.extend(removed_commands.map(|command| command.source_range));
1578    }
1579
1580    fn invalidate_pending_slash_commands(
1581        &mut self,
1582        buffer: &BufferSnapshot,
1583        cx: &mut Context<Self>,
1584    ) {
1585        let mut invalidated_command_ids = Vec::new();
1586        for (&command_id, command) in self.invoked_slash_commands.iter_mut() {
1587            if !matches!(command.status, InvokedSlashCommandStatus::Finished)
1588                && (!command.range.start.is_valid(buffer) || !command.range.end.is_valid(buffer))
1589            {
1590                command.status = InvokedSlashCommandStatus::Finished;
1591                cx.emit(ContextEvent::InvokedSlashCommandChanged { command_id });
1592                invalidated_command_ids.push(command_id);
1593            }
1594        }
1595
1596        for command_id in invalidated_command_ids {
1597            let version = self.version.clone();
1598            let timestamp = self.next_timestamp();
1599            self.push_op(
1600                ContextOperation::SlashCommandFinished {
1601                    id: command_id,
1602                    timestamp,
1603                    error_message: None,
1604                    version: version.clone(),
1605                },
1606                cx,
1607            );
1608        }
1609    }
1610
1611    pub fn pending_command_for_position(
1612        &mut self,
1613        position: language::Anchor,
1614        cx: &mut Context<Self>,
1615    ) -> Option<&mut ParsedSlashCommand> {
1616        let buffer = self.buffer.read(cx);
1617        match self
1618            .parsed_slash_commands
1619            .binary_search_by(|probe| probe.source_range.end.cmp(&position, buffer))
1620        {
1621            Ok(ix) => Some(&mut self.parsed_slash_commands[ix]),
1622            Err(ix) => {
1623                let cmd = self.parsed_slash_commands.get_mut(ix)?;
1624                if position.cmp(&cmd.source_range.start, buffer).is_ge()
1625                    && position.cmp(&cmd.source_range.end, buffer).is_le()
1626                {
1627                    Some(cmd)
1628                } else {
1629                    None
1630                }
1631            }
1632        }
1633    }
1634
1635    pub fn pending_commands_for_range(
1636        &self,
1637        range: Range<language::Anchor>,
1638        cx: &App,
1639    ) -> &[ParsedSlashCommand] {
1640        let range = self.pending_command_indices_for_range(range, cx);
1641        &self.parsed_slash_commands[range]
1642    }
1643
1644    fn pending_command_indices_for_range(
1645        &self,
1646        range: Range<language::Anchor>,
1647        cx: &App,
1648    ) -> Range<usize> {
1649        self.indices_intersecting_buffer_range(&self.parsed_slash_commands, range, cx)
1650    }
1651
1652    fn indices_intersecting_buffer_range<T: ContextAnnotation>(
1653        &self,
1654        all_annotations: &[T],
1655        range: Range<language::Anchor>,
1656        cx: &App,
1657    ) -> Range<usize> {
1658        let buffer = self.buffer.read(cx);
1659        let start_ix = match all_annotations
1660            .binary_search_by(|probe| probe.range().end.cmp(&range.start, buffer))
1661        {
1662            Ok(ix) | Err(ix) => ix,
1663        };
1664        let end_ix = match all_annotations
1665            .binary_search_by(|probe| probe.range().start.cmp(&range.end, buffer))
1666        {
1667            Ok(ix) => ix + 1,
1668            Err(ix) => ix,
1669        };
1670        start_ix..end_ix
1671    }
1672
1673    pub fn insert_command_output(
1674        &mut self,
1675        command_source_range: Range<language::Anchor>,
1676        name: &str,
1677        output: Task<SlashCommandResult>,
1678        ensure_trailing_newline: bool,
1679        cx: &mut Context<Self>,
1680    ) {
1681        let version = self.version.clone();
1682        let command_id = InvokedSlashCommandId(self.next_timestamp());
1683
1684        const PENDING_OUTPUT_END_MARKER: &str = "";
1685
1686        let (command_range, command_source_range, insert_position, first_transaction) =
1687            self.buffer.update(cx, |buffer, cx| {
1688                let command_source_range = command_source_range.to_offset(buffer);
1689                let mut insertion = format!("\n{PENDING_OUTPUT_END_MARKER}");
1690                if ensure_trailing_newline {
1691                    insertion.push('\n');
1692                }
1693
1694                buffer.finalize_last_transaction();
1695                buffer.start_transaction();
1696                buffer.edit(
1697                    [(
1698                        command_source_range.end..command_source_range.end,
1699                        insertion,
1700                    )],
1701                    None,
1702                    cx,
1703                );
1704                let first_transaction = buffer.end_transaction(cx).unwrap();
1705                buffer.finalize_last_transaction();
1706
1707                let insert_position = buffer.anchor_after(command_source_range.end + 1);
1708                let command_range = buffer.anchor_after(command_source_range.start)
1709                    ..buffer.anchor_before(
1710                        command_source_range.end + 1 + PENDING_OUTPUT_END_MARKER.len(),
1711                    );
1712                let command_source_range = buffer.anchor_before(command_source_range.start)
1713                    ..buffer.anchor_before(command_source_range.end + 1);
1714                (
1715                    command_range,
1716                    command_source_range,
1717                    insert_position,
1718                    first_transaction,
1719                )
1720            });
1721        self.reparse(cx);
1722
1723        let insert_output_task = cx.spawn(async move |this, cx| {
1724            let run_command = async {
1725                let mut stream = output.await?;
1726
1727                struct PendingSection {
1728                    start: language::Anchor,
1729                    icon: IconName,
1730                    label: SharedString,
1731                    metadata: Option<serde_json::Value>,
1732                }
1733
1734                let mut pending_section_stack: Vec<PendingSection> = Vec::new();
1735                let mut last_role: Option<Role> = None;
1736                let mut last_section_range = None;
1737
1738                while let Some(event) = stream.next().await {
1739                    let event = event?;
1740                    this.update(cx, |this, cx| {
1741                        this.buffer.update(cx, |buffer, _cx| {
1742                            buffer.finalize_last_transaction();
1743                            buffer.start_transaction()
1744                        });
1745
1746                        match event {
1747                            SlashCommandEvent::StartMessage {
1748                                role,
1749                                merge_same_roles,
1750                            } => {
1751                                if !merge_same_roles && Some(role) != last_role {
1752                                    let buffer = this.buffer.read(cx);
1753                                    let offset = insert_position.to_offset(buffer);
1754                                    this.insert_message_at_offset(
1755                                        offset,
1756                                        role,
1757                                        MessageStatus::Pending,
1758                                        cx,
1759                                    );
1760                                }
1761
1762                                last_role = Some(role);
1763                            }
1764                            SlashCommandEvent::StartSection {
1765                                icon,
1766                                label,
1767                                metadata,
1768                            } => {
1769                                this.buffer.update(cx, |buffer, cx| {
1770                                    let insert_point = insert_position.to_point(buffer);
1771                                    if insert_point.column > 0 {
1772                                        buffer.edit([(insert_point..insert_point, "\n")], None, cx);
1773                                    }
1774
1775                                    pending_section_stack.push(PendingSection {
1776                                        start: buffer.anchor_before(insert_position),
1777                                        icon,
1778                                        label,
1779                                        metadata,
1780                                    });
1781                                });
1782                            }
1783                            SlashCommandEvent::Content(SlashCommandContent::Text {
1784                                text,
1785                                run_commands_in_text,
1786                            }) => {
1787                                let start = this.buffer.read(cx).anchor_before(insert_position);
1788
1789                                this.buffer.update(cx, |buffer, cx| {
1790                                    buffer.edit(
1791                                        [(insert_position..insert_position, text)],
1792                                        None,
1793                                        cx,
1794                                    )
1795                                });
1796
1797                                let end = this.buffer.read(cx).anchor_before(insert_position);
1798                                if run_commands_in_text
1799                                    && let Some(invoked_slash_command) =
1800                                        this.invoked_slash_commands.get_mut(&command_id)
1801                                    {
1802                                        invoked_slash_command
1803                                            .run_commands_in_ranges
1804                                            .push(start..end);
1805                                    }
1806                            }
1807                            SlashCommandEvent::EndSection => {
1808                                if let Some(pending_section) = pending_section_stack.pop() {
1809                                    let offset_range = (pending_section.start..insert_position)
1810                                        .to_offset(this.buffer.read(cx));
1811                                    if !offset_range.is_empty() {
1812                                        let range = this.buffer.update(cx, |buffer, _cx| {
1813                                            buffer.anchor_after(offset_range.start)
1814                                                ..buffer.anchor_before(offset_range.end)
1815                                        });
1816                                        this.insert_slash_command_output_section(
1817                                            SlashCommandOutputSection {
1818                                                range: range.clone(),
1819                                                icon: pending_section.icon,
1820                                                label: pending_section.label,
1821                                                metadata: pending_section.metadata,
1822                                            },
1823                                            cx,
1824                                        );
1825                                        last_section_range = Some(range);
1826                                    }
1827                                }
1828                            }
1829                        }
1830
1831                        this.buffer.update(cx, |buffer, cx| {
1832                            if let Some(event_transaction) = buffer.end_transaction(cx) {
1833                                buffer.merge_transactions(event_transaction, first_transaction);
1834                            }
1835                        });
1836                    })?;
1837                }
1838
1839                this.update(cx, |this, cx| {
1840                    this.buffer.update(cx, |buffer, cx| {
1841                        buffer.finalize_last_transaction();
1842                        buffer.start_transaction();
1843
1844                        let mut deletions = vec![(command_source_range.to_offset(buffer), "")];
1845                        let insert_position = insert_position.to_offset(buffer);
1846                        let command_range_end = command_range.end.to_offset(buffer);
1847
1848                        if buffer.contains_str_at(insert_position, PENDING_OUTPUT_END_MARKER) {
1849                            deletions.push((
1850                                insert_position..insert_position + PENDING_OUTPUT_END_MARKER.len(),
1851                                "",
1852                            ));
1853                        }
1854
1855                        if ensure_trailing_newline
1856                            && buffer.contains_str_at(command_range_end, "\n")
1857                        {
1858                            let newline_offset = insert_position.saturating_sub(1);
1859                            if buffer.contains_str_at(newline_offset, "\n")
1860                                && last_section_range.map_or(true, |last_section_range| {
1861                                    !last_section_range
1862                                        .to_offset(buffer)
1863                                        .contains(&newline_offset)
1864                                })
1865                            {
1866                                deletions.push((command_range_end..command_range_end + 1, ""));
1867                            }
1868                        }
1869
1870                        buffer.edit(deletions, None, cx);
1871
1872                        if let Some(deletion_transaction) = buffer.end_transaction(cx) {
1873                            buffer.merge_transactions(deletion_transaction, first_transaction);
1874                        }
1875                    });
1876                })?;
1877
1878                debug_assert!(pending_section_stack.is_empty());
1879
1880                anyhow::Ok(())
1881            };
1882
1883            let command_result = run_command.await;
1884
1885            this.update(cx, |this, cx| {
1886                let version = this.version.clone();
1887                let timestamp = this.next_timestamp();
1888                let Some(invoked_slash_command) = this.invoked_slash_commands.get_mut(&command_id)
1889                else {
1890                    return;
1891                };
1892                let mut error_message = None;
1893                match command_result {
1894                    Ok(()) => {
1895                        invoked_slash_command.status = InvokedSlashCommandStatus::Finished;
1896                    }
1897                    Err(error) => {
1898                        let message = error.to_string();
1899                        invoked_slash_command.status =
1900                            InvokedSlashCommandStatus::Error(message.clone().into());
1901                        error_message = Some(message);
1902                    }
1903                }
1904
1905                cx.emit(ContextEvent::InvokedSlashCommandChanged { command_id });
1906                this.push_op(
1907                    ContextOperation::SlashCommandFinished {
1908                        id: command_id,
1909                        timestamp,
1910                        error_message,
1911                        version,
1912                    },
1913                    cx,
1914                );
1915            })
1916            .ok();
1917        });
1918
1919        self.invoked_slash_commands.insert(
1920            command_id,
1921            InvokedSlashCommand {
1922                name: name.to_string().into(),
1923                range: command_range.clone(),
1924                run_commands_in_ranges: Vec::new(),
1925                status: InvokedSlashCommandStatus::Running(insert_output_task),
1926                transaction: Some(first_transaction),
1927                timestamp: command_id.0,
1928            },
1929        );
1930        cx.emit(ContextEvent::InvokedSlashCommandChanged { command_id });
1931        self.push_op(
1932            ContextOperation::SlashCommandStarted {
1933                id: command_id,
1934                output_range: command_range,
1935                name: name.to_string(),
1936                version,
1937            },
1938            cx,
1939        );
1940    }
1941
1942    fn insert_slash_command_output_section(
1943        &mut self,
1944        section: SlashCommandOutputSection<language::Anchor>,
1945        cx: &mut Context<Self>,
1946    ) {
1947        let buffer = self.buffer.read(cx);
1948        let insertion_ix = match self
1949            .slash_command_output_sections
1950            .binary_search_by(|probe| probe.range.cmp(&section.range, buffer))
1951        {
1952            Ok(ix) | Err(ix) => ix,
1953        };
1954        self.slash_command_output_sections
1955            .insert(insertion_ix, section.clone());
1956        cx.emit(ContextEvent::SlashCommandOutputSectionAdded {
1957            section: section.clone(),
1958        });
1959        let version = self.version.clone();
1960        let timestamp = self.next_timestamp();
1961        self.push_op(
1962            ContextOperation::SlashCommandOutputSectionAdded {
1963                timestamp,
1964                section,
1965                version,
1966            },
1967            cx,
1968        );
1969    }
1970
1971    fn insert_thought_process_output_section(
1972        &mut self,
1973        section: ThoughtProcessOutputSection<language::Anchor>,
1974        cx: &mut Context<Self>,
1975    ) {
1976        let buffer = self.buffer.read(cx);
1977        let insertion_ix = match self
1978            .thought_process_output_sections
1979            .binary_search_by(|probe| probe.range.cmp(&section.range, buffer))
1980        {
1981            Ok(ix) | Err(ix) => ix,
1982        };
1983        self.thought_process_output_sections
1984            .insert(insertion_ix, section.clone());
1985        // cx.emit(ContextEvent::ThoughtProcessOutputSectionAdded {
1986        //     section: section.clone(),
1987        // });
1988        let version = self.version.clone();
1989        let timestamp = self.next_timestamp();
1990        self.push_op(
1991            ContextOperation::ThoughtProcessOutputSectionAdded {
1992                timestamp,
1993                section,
1994                version,
1995            },
1996            cx,
1997        );
1998    }
1999
2000    pub fn completion_provider_changed(&mut self, cx: &mut Context<Self>) {
2001        self.count_remaining_tokens(cx);
2002    }
2003
2004    fn get_last_valid_message_id(&self, cx: &Context<Self>) -> Option<MessageId> {
2005        self.message_anchors.iter().rev().find_map(|message| {
2006            message
2007                .start
2008                .is_valid(self.buffer.read(cx))
2009                .then_some(message.id)
2010        })
2011    }
2012
2013    pub fn assist(&mut self, cx: &mut Context<Self>) -> Option<MessageAnchor> {
2014        let model_registry = LanguageModelRegistry::read_global(cx);
2015        let model = model_registry.default_model()?;
2016        let last_message_id = self.get_last_valid_message_id(cx)?;
2017
2018        if !model.provider.is_authenticated(cx) {
2019            log::info!("completion provider has no credentials");
2020            return None;
2021        }
2022
2023        let model = model.model;
2024
2025        // Compute which messages to cache, including the last one.
2026        self.mark_cache_anchors(&model.cache_configuration(), false, cx);
2027
2028        let request = self.to_completion_request(Some(&model), cx);
2029
2030        let assistant_message = self
2031            .insert_message_after(last_message_id, Role::Assistant, MessageStatus::Pending, cx)
2032            .unwrap();
2033
2034        // Queue up the user's next reply.
2035        let user_message = self
2036            .insert_message_after(assistant_message.id, Role::User, MessageStatus::Done, cx)
2037            .unwrap();
2038
2039        let pending_completion_id = post_inc(&mut self.completion_count);
2040
2041        let task = cx.spawn({
2042            async move |this, cx| {
2043                let stream = model.stream_completion(request, cx);
2044                let assistant_message_id = assistant_message.id;
2045                let mut response_latency = None;
2046                let stream_completion = async {
2047                    let request_start = Instant::now();
2048                    let mut events = stream.await?;
2049                    let mut stop_reason = StopReason::EndTurn;
2050                    let mut thought_process_stack = Vec::new();
2051
2052                    const THOUGHT_PROCESS_START_MARKER: &str = "<think>\n";
2053                    const THOUGHT_PROCESS_END_MARKER: &str = "\n</think>";
2054
2055                    while let Some(event) = events.next().await {
2056                        if response_latency.is_none() {
2057                            response_latency = Some(request_start.elapsed());
2058                        }
2059                        let event = event?;
2060
2061                        let mut context_event = None;
2062                        let mut thought_process_output_section = None;
2063
2064                        this.update(cx, |this, cx| {
2065                            let message_ix = this
2066                                .message_anchors
2067                                .iter()
2068                                .position(|message| message.id == assistant_message_id)?;
2069                            this.buffer.update(cx, |buffer, cx| {
2070                                let message_old_end_offset = this.message_anchors[message_ix + 1..]
2071                                    .iter()
2072                                    .find(|message| message.start.is_valid(buffer))
2073                                    .map_or(buffer.len(), |message| {
2074                                        message.start.to_offset(buffer).saturating_sub(1)
2075                                    });
2076
2077                                match event {
2078                                    LanguageModelCompletionEvent::StatusUpdate(status_update) => {
2079                                        match status_update {
2080                                            CompletionRequestStatus::UsageUpdated { amount, limit } => {
2081                                                this.update_model_request_usage(
2082                                                    amount as u32,
2083                                                    limit,
2084                                                    cx,
2085                                                );
2086                                            }
2087                                            _ => {}
2088                                        }
2089                                    }
2090                                    LanguageModelCompletionEvent::StartMessage { .. } => {}
2091                                    LanguageModelCompletionEvent::Stop(reason) => {
2092                                        stop_reason = reason;
2093                                    }
2094                                    LanguageModelCompletionEvent::Thinking { text: chunk, .. } => {
2095                                        if thought_process_stack.is_empty() {
2096                                            let start =
2097                                                buffer.anchor_before(message_old_end_offset);
2098                                            thought_process_stack.push(start);
2099                                            let chunk =
2100                                                format!("{THOUGHT_PROCESS_START_MARKER}{chunk}{THOUGHT_PROCESS_END_MARKER}");
2101                                            let chunk_len = chunk.len();
2102                                            buffer.edit(
2103                                                [(
2104                                                    message_old_end_offset..message_old_end_offset,
2105                                                    chunk,
2106                                                )],
2107                                                None,
2108                                                cx,
2109                                            );
2110                                            let end = buffer
2111                                                .anchor_before(message_old_end_offset + chunk_len);
2112                                            context_event = Some(
2113                                                ContextEvent::StartedThoughtProcess(start..end),
2114                                            );
2115                                        } else {
2116                                            // This ensures that all the thinking chunks are inserted inside the thinking tag
2117                                            let insertion_position =
2118                                                message_old_end_offset - THOUGHT_PROCESS_END_MARKER.len();
2119                                            buffer.edit(
2120                                                [(insertion_position..insertion_position, chunk)],
2121                                                None,
2122                                                cx,
2123                                            );
2124                                        }
2125                                    }
2126                                    LanguageModelCompletionEvent::RedactedThinking { .. } => {},
2127                                    LanguageModelCompletionEvent::Text(mut chunk) => {
2128                                        if let Some(start) = thought_process_stack.pop() {
2129                                            let end = buffer.anchor_before(message_old_end_offset);
2130                                            context_event =
2131                                                Some(ContextEvent::EndedThoughtProcess(end));
2132                                            thought_process_output_section =
2133                                                Some(ThoughtProcessOutputSection {
2134                                                    range: start..end,
2135                                                });
2136                                            chunk.insert_str(0, "\n\n");
2137                                        }
2138
2139                                        buffer.edit(
2140                                            [(
2141                                                message_old_end_offset..message_old_end_offset,
2142                                                chunk,
2143                                            )],
2144                                            None,
2145                                            cx,
2146                                        );
2147                                    }
2148                                    LanguageModelCompletionEvent::ToolUse(_) |
2149                                    LanguageModelCompletionEvent::ToolUseJsonParseError { .. } |
2150                                    LanguageModelCompletionEvent::UsageUpdate(_) => {}
2151                                }
2152                            });
2153
2154                            if let Some(section) = thought_process_output_section.take() {
2155                                this.insert_thought_process_output_section(section, cx);
2156                            }
2157                            if let Some(context_event) = context_event.take() {
2158                                cx.emit(context_event);
2159                            }
2160
2161                            cx.emit(ContextEvent::StreamedCompletion);
2162
2163                            Some(())
2164                        })?;
2165                        smol::future::yield_now().await;
2166                    }
2167                    this.update(cx, |this, cx| {
2168                        this.pending_completions
2169                            .retain(|completion| completion.id != pending_completion_id);
2170                        this.summarize(false, cx);
2171                        this.update_cache_status_for_completion(cx);
2172                    })?;
2173
2174                    anyhow::Ok(stop_reason)
2175                };
2176
2177                let result = stream_completion.await;
2178
2179                this.update(cx, |this, cx| {
2180                    let error_message = if let Some(error) = result.as_ref().err() {
2181                        if error.is::<PaymentRequiredError>() {
2182                            cx.emit(ContextEvent::ShowPaymentRequiredError);
2183                            this.update_metadata(assistant_message_id, cx, |metadata| {
2184                                metadata.status = MessageStatus::Canceled;
2185                            });
2186                            Some(error.to_string())
2187                        } else {
2188                            let error_message = error
2189                                .chain()
2190                                .map(|err| err.to_string())
2191                                .collect::<Vec<_>>()
2192                                .join("\n");
2193                            cx.emit(ContextEvent::ShowAssistError(SharedString::from(
2194                                error_message.clone(),
2195                            )));
2196                            this.update_metadata(assistant_message_id, cx, |metadata| {
2197                                metadata.status =
2198                                    MessageStatus::Error(SharedString::from(error_message.clone()));
2199                            });
2200                            Some(error_message)
2201                        }
2202                    } else {
2203                        this.update_metadata(assistant_message_id, cx, |metadata| {
2204                            metadata.status = MessageStatus::Done;
2205                        });
2206                        None
2207                    };
2208
2209                    let language_name = this
2210                        .buffer
2211                        .read(cx)
2212                        .language()
2213                        .map(|language| language.name());
2214                    report_assistant_event(
2215                        AssistantEventData {
2216                            conversation_id: Some(this.id.0.clone()),
2217                            kind: AssistantKind::Panel,
2218                            phase: AssistantPhase::Response,
2219                            message_id: None,
2220                            model: model.telemetry_id(),
2221                            model_provider: model.provider_id().to_string(),
2222                            response_latency,
2223                            error_message,
2224                            language_name: language_name.map(|name| name.to_proto()),
2225                        },
2226                        this.telemetry.clone(),
2227                        cx.http_client(),
2228                        model.api_key(cx),
2229                        cx.background_executor(),
2230                    );
2231
2232                    if let Ok(stop_reason) = result {
2233                        match stop_reason {
2234                            StopReason::ToolUse => {}
2235                            StopReason::EndTurn => {}
2236                            StopReason::MaxTokens => {}
2237                            StopReason::Refusal => {}
2238                        }
2239                    }
2240                })
2241                .ok();
2242            }
2243        });
2244
2245        self.pending_completions.push(PendingCompletion {
2246            id: pending_completion_id,
2247            assistant_message_id: assistant_message.id,
2248            _task: task,
2249        });
2250
2251        Some(user_message)
2252    }
2253
2254    pub fn to_xml(&self, cx: &App) -> String {
2255        let mut output = String::new();
2256        let buffer = self.buffer.read(cx);
2257        for message in self.messages(cx) {
2258            if message.status != MessageStatus::Done {
2259                continue;
2260            }
2261
2262            writeln!(&mut output, "<{}>", message.role).unwrap();
2263            for chunk in buffer.text_for_range(message.offset_range) {
2264                output.push_str(chunk);
2265            }
2266            if !output.ends_with('\n') {
2267                output.push('\n');
2268            }
2269            writeln!(&mut output, "</{}>", message.role).unwrap();
2270        }
2271        output
2272    }
2273
2274    pub fn to_completion_request(
2275        &self,
2276        model: Option<&Arc<dyn LanguageModel>>,
2277        cx: &App,
2278    ) -> LanguageModelRequest {
2279        let buffer = self.buffer.read(cx);
2280
2281        let mut contents = self.contents(cx).peekable();
2282
2283        fn collect_text_content(buffer: &Buffer, range: Range<usize>) -> Option<String> {
2284            let text: String = buffer.text_for_range(range.clone()).collect();
2285            if text.trim().is_empty() {
2286                None
2287            } else {
2288                Some(text)
2289            }
2290        }
2291
2292        let mut completion_request = LanguageModelRequest {
2293            thread_id: None,
2294            prompt_id: None,
2295            intent: Some(CompletionIntent::UserPrompt),
2296            mode: None,
2297            messages: Vec::new(),
2298            tools: Vec::new(),
2299            tool_choice: None,
2300            stop: Vec::new(),
2301            temperature: model.and_then(|model| AgentSettings::temperature_for_model(model, cx)),
2302            thinking_allowed: true,
2303        };
2304        for message in self.messages(cx) {
2305            if message.status != MessageStatus::Done {
2306                continue;
2307            }
2308
2309            let mut offset = message.offset_range.start;
2310            let mut request_message = LanguageModelRequestMessage {
2311                role: message.role,
2312                content: Vec::new(),
2313                cache: message
2314                    .cache
2315                    .as_ref()
2316                    .map_or(false, |cache| cache.is_anchor),
2317            };
2318
2319            while let Some(content) = contents.peek() {
2320                if content
2321                    .range()
2322                    .end
2323                    .cmp(&message.anchor_range.end, buffer)
2324                    .is_lt()
2325                {
2326                    let content = contents.next().unwrap();
2327                    let range = content.range().to_offset(buffer);
2328                    request_message.content.extend(
2329                        collect_text_content(buffer, offset..range.start).map(MessageContent::Text),
2330                    );
2331
2332                    match content {
2333                        Content::Image { image, .. } => {
2334                            if let Some(image) = image.clone().now_or_never().flatten() {
2335                                request_message
2336                                    .content
2337                                    .push(language_model::MessageContent::Image(image));
2338                            }
2339                        }
2340                    }
2341
2342                    offset = range.end;
2343                } else {
2344                    break;
2345                }
2346            }
2347
2348            request_message.content.extend(
2349                collect_text_content(buffer, offset..message.offset_range.end)
2350                    .map(MessageContent::Text),
2351            );
2352
2353            if !request_message.contents_empty() {
2354                completion_request.messages.push(request_message);
2355            }
2356        }
2357        let supports_burn_mode = if let Some(model) = model {
2358            model.supports_burn_mode()
2359        } else {
2360            false
2361        };
2362
2363        if supports_burn_mode {
2364            completion_request.mode = Some(self.completion_mode.into());
2365        }
2366        completion_request
2367    }
2368
2369    pub fn cancel_last_assist(&mut self, cx: &mut Context<Self>) -> bool {
2370        if let Some(pending_completion) = self.pending_completions.pop() {
2371            self.update_metadata(pending_completion.assistant_message_id, cx, |metadata| {
2372                if metadata.status == MessageStatus::Pending {
2373                    metadata.status = MessageStatus::Canceled;
2374                }
2375            });
2376            true
2377        } else {
2378            false
2379        }
2380    }
2381
2382    pub fn cycle_message_roles(&mut self, ids: HashSet<MessageId>, cx: &mut Context<Self>) {
2383        for id in &ids {
2384            if let Some(metadata) = self.messages_metadata.get(id) {
2385                let role = metadata.role.cycle();
2386                self.update_metadata(*id, cx, |metadata| metadata.role = role);
2387            }
2388        }
2389
2390        self.message_roles_updated(ids, cx);
2391    }
2392
2393    fn message_roles_updated(&mut self, ids: HashSet<MessageId>, cx: &mut Context<Self>) {
2394        let mut ranges = Vec::new();
2395        for message in self.messages(cx) {
2396            if ids.contains(&message.id) {
2397                ranges.push(message.anchor_range.clone());
2398            }
2399        }
2400    }
2401
2402    pub fn update_metadata(
2403        &mut self,
2404        id: MessageId,
2405        cx: &mut Context<Self>,
2406        f: impl FnOnce(&mut MessageMetadata),
2407    ) {
2408        let version = self.version.clone();
2409        let timestamp = self.next_timestamp();
2410        if let Some(metadata) = self.messages_metadata.get_mut(&id) {
2411            f(metadata);
2412            metadata.timestamp = timestamp;
2413            let operation = ContextOperation::UpdateMessage {
2414                message_id: id,
2415                metadata: metadata.clone(),
2416                version,
2417            };
2418            self.push_op(operation, cx);
2419            cx.emit(ContextEvent::MessagesEdited);
2420            cx.notify();
2421        }
2422    }
2423
2424    pub fn insert_message_after(
2425        &mut self,
2426        message_id: MessageId,
2427        role: Role,
2428        status: MessageStatus,
2429        cx: &mut Context<Self>,
2430    ) -> Option<MessageAnchor> {
2431        if let Some(prev_message_ix) = self
2432            .message_anchors
2433            .iter()
2434            .position(|message| message.id == message_id)
2435        {
2436            // Find the next valid message after the one we were given.
2437            let mut next_message_ix = prev_message_ix + 1;
2438            while let Some(next_message) = self.message_anchors.get(next_message_ix) {
2439                if next_message.start.is_valid(self.buffer.read(cx)) {
2440                    break;
2441                }
2442                next_message_ix += 1;
2443            }
2444
2445            let buffer = self.buffer.read(cx);
2446            let offset = self
2447                .message_anchors
2448                .get(next_message_ix)
2449                .map_or(buffer.len(), |message| {
2450                    buffer.clip_offset(message.start.to_offset(buffer) - 1, Bias::Left)
2451                });
2452            Some(self.insert_message_at_offset(offset, role, status, cx))
2453        } else {
2454            None
2455        }
2456    }
2457
2458    fn insert_message_at_offset(
2459        &mut self,
2460        offset: usize,
2461        role: Role,
2462        status: MessageStatus,
2463        cx: &mut Context<Self>,
2464    ) -> MessageAnchor {
2465        let start = self.buffer.update(cx, |buffer, cx| {
2466            buffer.edit([(offset..offset, "\n")], None, cx);
2467            buffer.anchor_before(offset + 1)
2468        });
2469
2470        let version = self.version.clone();
2471        let anchor = MessageAnchor {
2472            id: MessageId(self.next_timestamp()),
2473            start,
2474        };
2475        let metadata = MessageMetadata {
2476            role,
2477            status,
2478            timestamp: anchor.id.0,
2479            cache: None,
2480        };
2481        self.insert_message(anchor.clone(), metadata.clone(), cx);
2482        self.push_op(
2483            ContextOperation::InsertMessage {
2484                anchor: anchor.clone(),
2485                metadata,
2486                version,
2487            },
2488            cx,
2489        );
2490        anchor
2491    }
2492
2493    pub fn insert_content(&mut self, content: Content, cx: &mut Context<Self>) {
2494        let buffer = self.buffer.read(cx);
2495        let insertion_ix = match self
2496            .contents
2497            .binary_search_by(|probe| probe.cmp(&content, buffer))
2498        {
2499            Ok(ix) => {
2500                self.contents.remove(ix);
2501                ix
2502            }
2503            Err(ix) => ix,
2504        };
2505        self.contents.insert(insertion_ix, content);
2506        cx.emit(ContextEvent::MessagesEdited);
2507    }
2508
2509    pub fn contents<'a>(&'a self, cx: &'a App) -> impl 'a + Iterator<Item = Content> {
2510        let buffer = self.buffer.read(cx);
2511        self.contents
2512            .iter()
2513            .filter(|content| {
2514                let range = content.range();
2515                range.start.is_valid(buffer) && range.end.is_valid(buffer)
2516            })
2517            .cloned()
2518    }
2519
2520    pub fn split_message(
2521        &mut self,
2522        range: Range<usize>,
2523        cx: &mut Context<Self>,
2524    ) -> (Option<MessageAnchor>, Option<MessageAnchor>) {
2525        let start_message = self.message_for_offset(range.start, cx);
2526        let end_message = self.message_for_offset(range.end, cx);
2527        if let Some((start_message, end_message)) = start_message.zip(end_message) {
2528            // Prevent splitting when range spans multiple messages.
2529            if start_message.id != end_message.id {
2530                return (None, None);
2531            }
2532
2533            let message = start_message;
2534            let at_end = range.end >= message.offset_range.end.saturating_sub(1);
2535            let role_after = if range.start == range.end || at_end {
2536                Role::User
2537            } else {
2538                message.role
2539            };
2540            let role = message.role;
2541            let mut edited_buffer = false;
2542
2543            let mut suffix_start = None;
2544
2545            // TODO: why did this start panicking?
2546            if range.start > message.offset_range.start
2547                && range.end < message.offset_range.end.saturating_sub(1)
2548            {
2549                if self.buffer.read(cx).chars_at(range.end).next() == Some('\n') {
2550                    suffix_start = Some(range.end + 1);
2551                } else if self.buffer.read(cx).reversed_chars_at(range.end).next() == Some('\n') {
2552                    suffix_start = Some(range.end);
2553                }
2554            }
2555
2556            let version = self.version.clone();
2557            let suffix = if let Some(suffix_start) = suffix_start {
2558                MessageAnchor {
2559                    id: MessageId(self.next_timestamp()),
2560                    start: self.buffer.read(cx).anchor_before(suffix_start),
2561                }
2562            } else {
2563                self.buffer.update(cx, |buffer, cx| {
2564                    buffer.edit([(range.end..range.end, "\n")], None, cx);
2565                });
2566                edited_buffer = true;
2567                MessageAnchor {
2568                    id: MessageId(self.next_timestamp()),
2569                    start: self.buffer.read(cx).anchor_before(range.end + 1),
2570                }
2571            };
2572
2573            let suffix_metadata = MessageMetadata {
2574                role: role_after,
2575                status: MessageStatus::Done,
2576                timestamp: suffix.id.0,
2577                cache: None,
2578            };
2579            self.insert_message(suffix.clone(), suffix_metadata.clone(), cx);
2580            self.push_op(
2581                ContextOperation::InsertMessage {
2582                    anchor: suffix.clone(),
2583                    metadata: suffix_metadata,
2584                    version,
2585                },
2586                cx,
2587            );
2588
2589            let new_messages =
2590                if range.start == range.end || range.start == message.offset_range.start {
2591                    (None, Some(suffix))
2592                } else {
2593                    let mut prefix_end = None;
2594                    if range.start > message.offset_range.start
2595                        && range.end < message.offset_range.end - 1
2596                    {
2597                        if self.buffer.read(cx).chars_at(range.start).next() == Some('\n') {
2598                            prefix_end = Some(range.start + 1);
2599                        } else if self.buffer.read(cx).reversed_chars_at(range.start).next()
2600                            == Some('\n')
2601                        {
2602                            prefix_end = Some(range.start);
2603                        }
2604                    }
2605
2606                    let version = self.version.clone();
2607                    let selection = if let Some(prefix_end) = prefix_end {
2608                        MessageAnchor {
2609                            id: MessageId(self.next_timestamp()),
2610                            start: self.buffer.read(cx).anchor_before(prefix_end),
2611                        }
2612                    } else {
2613                        self.buffer.update(cx, |buffer, cx| {
2614                            buffer.edit([(range.start..range.start, "\n")], None, cx)
2615                        });
2616                        edited_buffer = true;
2617                        MessageAnchor {
2618                            id: MessageId(self.next_timestamp()),
2619                            start: self.buffer.read(cx).anchor_before(range.end + 1),
2620                        }
2621                    };
2622
2623                    let selection_metadata = MessageMetadata {
2624                        role,
2625                        status: MessageStatus::Done,
2626                        timestamp: selection.id.0,
2627                        cache: None,
2628                    };
2629                    self.insert_message(selection.clone(), selection_metadata.clone(), cx);
2630                    self.push_op(
2631                        ContextOperation::InsertMessage {
2632                            anchor: selection.clone(),
2633                            metadata: selection_metadata,
2634                            version,
2635                        },
2636                        cx,
2637                    );
2638
2639                    (Some(selection), Some(suffix))
2640                };
2641
2642            if !edited_buffer {
2643                cx.emit(ContextEvent::MessagesEdited);
2644            }
2645            new_messages
2646        } else {
2647            (None, None)
2648        }
2649    }
2650
2651    fn insert_message(
2652        &mut self,
2653        new_anchor: MessageAnchor,
2654        new_metadata: MessageMetadata,
2655        cx: &mut Context<Self>,
2656    ) {
2657        cx.emit(ContextEvent::MessagesEdited);
2658
2659        self.messages_metadata.insert(new_anchor.id, new_metadata);
2660
2661        let buffer = self.buffer.read(cx);
2662        let insertion_ix = self
2663            .message_anchors
2664            .iter()
2665            .position(|anchor| {
2666                let comparison = new_anchor.start.cmp(&anchor.start, buffer);
2667                comparison.is_lt() || (comparison.is_eq() && new_anchor.id > anchor.id)
2668            })
2669            .unwrap_or(self.message_anchors.len());
2670        self.message_anchors.insert(insertion_ix, new_anchor);
2671    }
2672
2673    pub fn summarize(&mut self, mut replace_old: bool, cx: &mut Context<Self>) {
2674        let Some(model) = LanguageModelRegistry::read_global(cx).default_model() else {
2675            return;
2676        };
2677
2678        if replace_old || (self.message_anchors.len() >= 2 && self.summary.is_pending()) {
2679            if !model.provider.is_authenticated(cx) {
2680                return;
2681            }
2682
2683            let mut request = self.to_completion_request(Some(&model.model), cx);
2684            request.messages.push(LanguageModelRequestMessage {
2685                role: Role::User,
2686                content: vec![SUMMARIZE_THREAD_PROMPT.into()],
2687                cache: false,
2688            });
2689
2690            // If there is no summary, it is set with `done: false` so that "Loading Summary…" can
2691            // be displayed.
2692            match self.summary {
2693                ContextSummary::Pending | ContextSummary::Error => {
2694                    self.summary = ContextSummary::Content(ContextSummaryContent {
2695                        text: "".to_string(),
2696                        done: false,
2697                        timestamp: clock::Lamport::default(),
2698                    });
2699                    replace_old = true;
2700                }
2701                ContextSummary::Content(_) => {}
2702            }
2703
2704            self.summary_task = cx.spawn(async move |this, cx| {
2705                let result = async {
2706                    let stream = model.model.stream_completion_text(request, cx);
2707                    let mut messages = stream.await?;
2708
2709                    let mut replaced = !replace_old;
2710                    while let Some(message) = messages.stream.next().await {
2711                        let text = message?;
2712                        let mut lines = text.lines();
2713                        this.update(cx, |this, cx| {
2714                            let version = this.version.clone();
2715                            let timestamp = this.next_timestamp();
2716                            let summary = this.summary.content_or_set_empty();
2717                            if !replaced && replace_old {
2718                                summary.text.clear();
2719                                replaced = true;
2720                            }
2721                            summary.text.extend(lines.next());
2722                            summary.timestamp = timestamp;
2723                            let operation = ContextOperation::UpdateSummary {
2724                                summary: summary.clone(),
2725                                version,
2726                            };
2727                            this.push_op(operation, cx);
2728                            cx.emit(ContextEvent::SummaryChanged);
2729                            cx.emit(ContextEvent::SummaryGenerated);
2730                        })?;
2731
2732                        // Stop if the LLM generated multiple lines.
2733                        if lines.next().is_some() {
2734                            break;
2735                        }
2736                    }
2737
2738                    this.read_with(cx, |this, _cx| {
2739                        if let Some(summary) = this.summary.content()
2740                            && summary.text.is_empty() {
2741                                bail!("Model generated an empty summary");
2742                            }
2743                        Ok(())
2744                    })??;
2745
2746                    this.update(cx, |this, cx| {
2747                        let version = this.version.clone();
2748                        let timestamp = this.next_timestamp();
2749                        if let Some(summary) = this.summary.content_as_mut() {
2750                            summary.done = true;
2751                            summary.timestamp = timestamp;
2752                            let operation = ContextOperation::UpdateSummary {
2753                                summary: summary.clone(),
2754                                version,
2755                            };
2756                            this.push_op(operation, cx);
2757                            cx.emit(ContextEvent::SummaryChanged);
2758                            cx.emit(ContextEvent::SummaryGenerated);
2759                        }
2760                    })?;
2761
2762                    anyhow::Ok(())
2763                }
2764                .await;
2765
2766                if let Err(err) = result {
2767                    this.update(cx, |this, cx| {
2768                        this.summary = ContextSummary::Error;
2769                        cx.emit(ContextEvent::SummaryChanged);
2770                    })
2771                    .log_err();
2772                    log::error!("Error generating context summary: {}", err);
2773                }
2774
2775                Some(())
2776            });
2777        }
2778    }
2779
2780    fn message_for_offset(&self, offset: usize, cx: &App) -> Option<Message> {
2781        self.messages_for_offsets([offset], cx).pop()
2782    }
2783
2784    pub fn messages_for_offsets(
2785        &self,
2786        offsets: impl IntoIterator<Item = usize>,
2787        cx: &App,
2788    ) -> Vec<Message> {
2789        let mut result = Vec::new();
2790
2791        let mut messages = self.messages(cx).peekable();
2792        let mut offsets = offsets.into_iter().peekable();
2793        let mut current_message = messages.next();
2794        while let Some(offset) = offsets.next() {
2795            // Locate the message that contains the offset.
2796            while current_message.as_ref().map_or(false, |message| {
2797                !message.offset_range.contains(&offset) && messages.peek().is_some()
2798            }) {
2799                current_message = messages.next();
2800            }
2801            let Some(message) = current_message.as_ref() else {
2802                break;
2803            };
2804
2805            // Skip offsets that are in the same message.
2806            while offsets.peek().map_or(false, |offset| {
2807                message.offset_range.contains(offset) || messages.peek().is_none()
2808            }) {
2809                offsets.next();
2810            }
2811
2812            result.push(message.clone());
2813        }
2814        result
2815    }
2816
2817    fn messages_from_anchors<'a>(
2818        &'a self,
2819        message_anchors: impl Iterator<Item = &'a MessageAnchor> + 'a,
2820        cx: &'a App,
2821    ) -> impl 'a + Iterator<Item = Message> {
2822        let buffer = self.buffer.read(cx);
2823
2824        Self::messages_from_iters(buffer, &self.messages_metadata, message_anchors.enumerate())
2825    }
2826
2827    pub fn messages<'a>(&'a self, cx: &'a App) -> impl 'a + Iterator<Item = Message> {
2828        self.messages_from_anchors(self.message_anchors.iter(), cx)
2829    }
2830
2831    pub fn messages_from_iters<'a>(
2832        buffer: &'a Buffer,
2833        metadata: &'a HashMap<MessageId, MessageMetadata>,
2834        messages: impl Iterator<Item = (usize, &'a MessageAnchor)> + 'a,
2835    ) -> impl 'a + Iterator<Item = Message> {
2836        let mut messages = messages.peekable();
2837
2838        iter::from_fn(move || {
2839            if let Some((start_ix, message_anchor)) = messages.next() {
2840                let metadata = metadata.get(&message_anchor.id)?;
2841
2842                let message_start = message_anchor.start.to_offset(buffer);
2843                let mut message_end = None;
2844                let mut end_ix = start_ix;
2845                while let Some((_, next_message)) = messages.peek() {
2846                    if next_message.start.is_valid(buffer) {
2847                        message_end = Some(next_message.start);
2848                        break;
2849                    } else {
2850                        end_ix += 1;
2851                        messages.next();
2852                    }
2853                }
2854                let message_end_anchor = message_end.unwrap_or(language::Anchor::MAX);
2855                let message_end = message_end_anchor.to_offset(buffer);
2856
2857                return Some(Message {
2858                    index_range: start_ix..end_ix,
2859                    offset_range: message_start..message_end,
2860                    anchor_range: message_anchor.start..message_end_anchor,
2861                    id: message_anchor.id,
2862                    role: metadata.role,
2863                    status: metadata.status.clone(),
2864                    cache: metadata.cache.clone(),
2865                });
2866            }
2867            None
2868        })
2869    }
2870
2871    pub fn save(
2872        &mut self,
2873        debounce: Option<Duration>,
2874        fs: Arc<dyn Fs>,
2875        cx: &mut Context<AssistantContext>,
2876    ) {
2877        if self.replica_id() != ReplicaId::default() {
2878            // Prevent saving a remote context for now.
2879            return;
2880        }
2881
2882        self.pending_save = cx.spawn(async move |this, cx| {
2883            if let Some(debounce) = debounce {
2884                cx.background_executor().timer(debounce).await;
2885            }
2886
2887            let (old_path, summary) = this.read_with(cx, |this, _| {
2888                let path = this.path.clone();
2889                let summary = if let Some(summary) = this.summary.content() {
2890                    if summary.done {
2891                        Some(summary.text.clone())
2892                    } else {
2893                        None
2894                    }
2895                } else {
2896                    None
2897                };
2898                (path, summary)
2899            })?;
2900
2901            if let Some(summary) = summary {
2902                let context = this.read_with(cx, |this, cx| this.serialize(cx))?;
2903                let mut discriminant = 1;
2904                let mut new_path;
2905                loop {
2906                    new_path = contexts_dir().join(&format!(
2907                        "{} - {}.zed.json",
2908                        summary.trim(),
2909                        discriminant
2910                    ));
2911                    if fs.is_file(&new_path).await {
2912                        discriminant += 1;
2913                    } else {
2914                        break;
2915                    }
2916                }
2917
2918                fs.create_dir(contexts_dir().as_ref()).await?;
2919
2920                // rename before write ensures that only one file exists
2921                if let Some(old_path) = old_path.as_ref()
2922                    && new_path.as_path() != old_path.as_ref() {
2923                        fs.rename(
2924                            old_path,
2925                            &new_path,
2926                            RenameOptions {
2927                                overwrite: true,
2928                                ignore_if_exists: true,
2929                            },
2930                        )
2931                        .await?;
2932                    }
2933
2934                // update path before write in case it fails
2935                this.update(cx, {
2936                    let new_path: Arc<Path> = new_path.clone().into();
2937                    move |this, cx| {
2938                        this.path = Some(new_path.clone());
2939                        cx.emit(ContextEvent::PathChanged { old_path, new_path });
2940                    }
2941                })
2942                .ok();
2943
2944                fs.atomic_write(new_path, serde_json::to_string(&context).unwrap())
2945                    .await?;
2946            }
2947
2948            Ok(())
2949        });
2950    }
2951
2952    pub fn set_custom_summary(&mut self, custom_summary: String, cx: &mut Context<Self>) {
2953        let timestamp = self.next_timestamp();
2954        let summary = self.summary.content_or_set_empty();
2955        summary.timestamp = timestamp;
2956        summary.done = true;
2957        summary.text = custom_summary;
2958        cx.emit(ContextEvent::SummaryChanged);
2959    }
2960
2961    fn update_model_request_usage(&self, amount: u32, limit: UsageLimit, cx: &mut App) {
2962        let Some(project) = &self.project else {
2963            return;
2964        };
2965        project.read(cx).user_store().update(cx, |user_store, cx| {
2966            user_store.update_model_request_usage(
2967                ModelRequestUsage(RequestUsage {
2968                    amount: amount as i32,
2969                    limit,
2970                }),
2971                cx,
2972            )
2973        });
2974    }
2975}
2976
2977#[derive(Debug, Default)]
2978pub struct ContextVersion {
2979    context: clock::Global,
2980    buffer: clock::Global,
2981}
2982
2983impl ContextVersion {
2984    pub fn from_proto(proto: &proto::ContextVersion) -> Self {
2985        Self {
2986            context: language::proto::deserialize_version(&proto.context_version),
2987            buffer: language::proto::deserialize_version(&proto.buffer_version),
2988        }
2989    }
2990
2991    pub fn to_proto(&self, context_id: ContextId) -> proto::ContextVersion {
2992        proto::ContextVersion {
2993            context_id: context_id.to_proto(),
2994            context_version: language::proto::serialize_version(&self.context),
2995            buffer_version: language::proto::serialize_version(&self.buffer),
2996        }
2997    }
2998}
2999
3000#[derive(Debug, Clone)]
3001pub struct ParsedSlashCommand {
3002    pub name: String,
3003    pub arguments: SmallVec<[String; 3]>,
3004    pub status: PendingSlashCommandStatus,
3005    pub source_range: Range<language::Anchor>,
3006}
3007
3008#[derive(Debug)]
3009pub struct InvokedSlashCommand {
3010    pub name: SharedString,
3011    pub range: Range<language::Anchor>,
3012    pub run_commands_in_ranges: Vec<Range<language::Anchor>>,
3013    pub status: InvokedSlashCommandStatus,
3014    pub transaction: Option<language::TransactionId>,
3015    timestamp: clock::Lamport,
3016}
3017
3018#[derive(Debug)]
3019pub enum InvokedSlashCommandStatus {
3020    Running(Task<()>),
3021    Error(SharedString),
3022    Finished,
3023}
3024
3025#[derive(Debug, Clone)]
3026pub enum PendingSlashCommandStatus {
3027    Idle,
3028    Running { _task: Shared<Task<()>> },
3029    Error(String),
3030}
3031
3032#[derive(Debug, Clone)]
3033pub struct PendingToolUse {
3034    pub id: LanguageModelToolUseId,
3035    pub name: String,
3036    pub input: serde_json::Value,
3037    pub status: PendingToolUseStatus,
3038    pub source_range: Range<language::Anchor>,
3039}
3040
3041#[derive(Debug, Clone)]
3042pub enum PendingToolUseStatus {
3043    Idle,
3044    Running { _task: Shared<Task<()>> },
3045    Error(String),
3046}
3047
3048impl PendingToolUseStatus {
3049    pub fn is_idle(&self) -> bool {
3050        matches!(self, PendingToolUseStatus::Idle)
3051    }
3052}
3053
3054#[derive(Serialize, Deserialize)]
3055pub struct SavedMessage {
3056    pub id: MessageId,
3057    pub start: usize,
3058    pub metadata: MessageMetadata,
3059}
3060
3061#[derive(Serialize, Deserialize)]
3062pub struct SavedContext {
3063    pub id: Option<ContextId>,
3064    pub zed: String,
3065    pub version: String,
3066    pub text: String,
3067    pub messages: Vec<SavedMessage>,
3068    pub summary: String,
3069    pub slash_command_output_sections:
3070        Vec<assistant_slash_command::SlashCommandOutputSection<usize>>,
3071    #[serde(default)]
3072    pub thought_process_output_sections: Vec<ThoughtProcessOutputSection<usize>>,
3073}
3074
3075impl SavedContext {
3076    pub const VERSION: &'static str = "0.4.0";
3077
3078    pub fn from_json(json: &str) -> Result<Self> {
3079        let saved_context_json = serde_json::from_str::<serde_json::Value>(json)?;
3080        match saved_context_json
3081            .get("version")
3082            .context("version not found")?
3083        {
3084            serde_json::Value::String(version) => match version.as_str() {
3085                SavedContext::VERSION => {
3086                    Ok(serde_json::from_value::<SavedContext>(saved_context_json)?)
3087                }
3088                SavedContextV0_3_0::VERSION => {
3089                    let saved_context =
3090                        serde_json::from_value::<SavedContextV0_3_0>(saved_context_json)?;
3091                    Ok(saved_context.upgrade())
3092                }
3093                SavedContextV0_2_0::VERSION => {
3094                    let saved_context =
3095                        serde_json::from_value::<SavedContextV0_2_0>(saved_context_json)?;
3096                    Ok(saved_context.upgrade())
3097                }
3098                SavedContextV0_1_0::VERSION => {
3099                    let saved_context =
3100                        serde_json::from_value::<SavedContextV0_1_0>(saved_context_json)?;
3101                    Ok(saved_context.upgrade())
3102                }
3103                _ => anyhow::bail!("unrecognized saved context version: {version:?}"),
3104            },
3105            _ => anyhow::bail!("version not found on saved context"),
3106        }
3107    }
3108
3109    fn into_ops(
3110        self,
3111        buffer: &Entity<Buffer>,
3112        cx: &mut Context<AssistantContext>,
3113    ) -> Vec<ContextOperation> {
3114        let mut operations = Vec::new();
3115        let mut version = clock::Global::new();
3116        let mut next_timestamp = clock::Lamport::new(ReplicaId::default());
3117
3118        let mut first_message_metadata = None;
3119        for message in self.messages {
3120            if message.id == MessageId(clock::Lamport::default()) {
3121                first_message_metadata = Some(message.metadata);
3122            } else {
3123                operations.push(ContextOperation::InsertMessage {
3124                    anchor: MessageAnchor {
3125                        id: message.id,
3126                        start: buffer.read(cx).anchor_before(message.start),
3127                    },
3128                    metadata: MessageMetadata {
3129                        role: message.metadata.role,
3130                        status: message.metadata.status,
3131                        timestamp: message.metadata.timestamp,
3132                        cache: None,
3133                    },
3134                    version: version.clone(),
3135                });
3136                version.observe(message.id.0);
3137                next_timestamp.observe(message.id.0);
3138            }
3139        }
3140
3141        if let Some(metadata) = first_message_metadata {
3142            let timestamp = next_timestamp.tick();
3143            operations.push(ContextOperation::UpdateMessage {
3144                message_id: MessageId(clock::Lamport::default()),
3145                metadata: MessageMetadata {
3146                    role: metadata.role,
3147                    status: metadata.status,
3148                    timestamp,
3149                    cache: None,
3150                },
3151                version: version.clone(),
3152            });
3153            version.observe(timestamp);
3154        }
3155
3156        let buffer = buffer.read(cx);
3157        for section in self.slash_command_output_sections {
3158            let timestamp = next_timestamp.tick();
3159            operations.push(ContextOperation::SlashCommandOutputSectionAdded {
3160                timestamp,
3161                section: SlashCommandOutputSection {
3162                    range: buffer.anchor_after(section.range.start)
3163                        ..buffer.anchor_before(section.range.end),
3164                    icon: section.icon,
3165                    label: section.label,
3166                    metadata: section.metadata,
3167                },
3168                version: version.clone(),
3169            });
3170
3171            version.observe(timestamp);
3172        }
3173
3174        for section in self.thought_process_output_sections {
3175            let timestamp = next_timestamp.tick();
3176            operations.push(ContextOperation::ThoughtProcessOutputSectionAdded {
3177                timestamp,
3178                section: ThoughtProcessOutputSection {
3179                    range: buffer.anchor_after(section.range.start)
3180                        ..buffer.anchor_before(section.range.end),
3181                },
3182                version: version.clone(),
3183            });
3184
3185            version.observe(timestamp);
3186        }
3187
3188        let timestamp = next_timestamp.tick();
3189        operations.push(ContextOperation::UpdateSummary {
3190            summary: ContextSummaryContent {
3191                text: self.summary,
3192                done: true,
3193                timestamp,
3194            },
3195            version: version.clone(),
3196        });
3197        version.observe(timestamp);
3198
3199        operations
3200    }
3201}
3202
3203#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
3204struct SavedMessageIdPreV0_4_0(usize);
3205
3206#[derive(Serialize, Deserialize)]
3207struct SavedMessagePreV0_4_0 {
3208    id: SavedMessageIdPreV0_4_0,
3209    start: usize,
3210}
3211
3212#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
3213struct SavedMessageMetadataPreV0_4_0 {
3214    role: Role,
3215    status: MessageStatus,
3216}
3217
3218#[derive(Serialize, Deserialize)]
3219struct SavedContextV0_3_0 {
3220    id: Option<ContextId>,
3221    zed: String,
3222    version: String,
3223    text: String,
3224    messages: Vec<SavedMessagePreV0_4_0>,
3225    message_metadata: HashMap<SavedMessageIdPreV0_4_0, SavedMessageMetadataPreV0_4_0>,
3226    summary: String,
3227    slash_command_output_sections: Vec<assistant_slash_command::SlashCommandOutputSection<usize>>,
3228}
3229
3230impl SavedContextV0_3_0 {
3231    const VERSION: &'static str = "0.3.0";
3232
3233    fn upgrade(self) -> SavedContext {
3234        SavedContext {
3235            id: self.id,
3236            zed: self.zed,
3237            version: SavedContext::VERSION.into(),
3238            text: self.text,
3239            messages: self
3240                .messages
3241                .into_iter()
3242                .filter_map(|message| {
3243                    let metadata = self.message_metadata.get(&message.id)?;
3244                    let timestamp = clock::Lamport {
3245                        replica_id: ReplicaId::default(),
3246                        value: message.id.0 as u32,
3247                    };
3248                    Some(SavedMessage {
3249                        id: MessageId(timestamp),
3250                        start: message.start,
3251                        metadata: MessageMetadata {
3252                            role: metadata.role,
3253                            status: metadata.status.clone(),
3254                            timestamp,
3255                            cache: None,
3256                        },
3257                    })
3258                })
3259                .collect(),
3260            summary: self.summary,
3261            slash_command_output_sections: self.slash_command_output_sections,
3262            thought_process_output_sections: Vec::new(),
3263        }
3264    }
3265}
3266
3267#[derive(Serialize, Deserialize)]
3268struct SavedContextV0_2_0 {
3269    id: Option<ContextId>,
3270    zed: String,
3271    version: String,
3272    text: String,
3273    messages: Vec<SavedMessagePreV0_4_0>,
3274    message_metadata: HashMap<SavedMessageIdPreV0_4_0, SavedMessageMetadataPreV0_4_0>,
3275    summary: String,
3276}
3277
3278impl SavedContextV0_2_0 {
3279    const VERSION: &'static str = "0.2.0";
3280
3281    fn upgrade(self) -> SavedContext {
3282        SavedContextV0_3_0 {
3283            id: self.id,
3284            zed: self.zed,
3285            version: SavedContextV0_3_0::VERSION.to_string(),
3286            text: self.text,
3287            messages: self.messages,
3288            message_metadata: self.message_metadata,
3289            summary: self.summary,
3290            slash_command_output_sections: Vec::new(),
3291        }
3292        .upgrade()
3293    }
3294}
3295
3296#[derive(Serialize, Deserialize)]
3297struct SavedContextV0_1_0 {
3298    id: Option<ContextId>,
3299    zed: String,
3300    version: String,
3301    text: String,
3302    messages: Vec<SavedMessagePreV0_4_0>,
3303    message_metadata: HashMap<SavedMessageIdPreV0_4_0, SavedMessageMetadataPreV0_4_0>,
3304    summary: String,
3305    api_url: Option<String>,
3306    model: OpenAiModel,
3307}
3308
3309impl SavedContextV0_1_0 {
3310    const VERSION: &'static str = "0.1.0";
3311
3312    fn upgrade(self) -> SavedContext {
3313        SavedContextV0_2_0 {
3314            id: self.id,
3315            zed: self.zed,
3316            version: SavedContextV0_2_0::VERSION.to_string(),
3317            text: self.text,
3318            messages: self.messages,
3319            message_metadata: self.message_metadata,
3320            summary: self.summary,
3321        }
3322        .upgrade()
3323    }
3324}
3325
3326#[derive(Debug, Clone)]
3327pub struct SavedContextMetadata {
3328    pub title: SharedString,
3329    pub path: Arc<Path>,
3330    pub mtime: chrono::DateTime<chrono::Local>,
3331}