aboutsummaryrefslogtreecommitdiff
path: root/src/api
diff options
context:
space:
mode:
Diffstat (limited to 'src/api')
-rw-r--r--src/api/schema/events.rs14
-rw-r--r--src/api/schema/panes.rs9
-rw-r--r--src/api/schema/tests.rs33
-rw-r--r--src/api/server.rs1
-rw-r--r--src/api/subscriptions.rs115
5 files changed, 167 insertions, 5 deletions
diff --git a/src/api/schema/events.rs b/src/api/schema/events.rs
index aff3d2a2..41b9907d 100644
--- a/src/api/schema/events.rs
+++ b/src/api/schema/events.rs
@@ -3,7 +3,7 @@ use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use super::common::{AgentStatus, ReadSource};
-use super::panes::{PaneInfo, PaneReadResult};
+use super::panes::{PaneInfo, PaneReadResult, PaneScrollInfo};
use super::tabs::TabInfo;
use super::workspaces::WorkspaceInfo;
use super::worktrees::WorktreeInfo;
@@ -72,6 +72,8 @@ pub enum Subscription {
#[serde(default, skip_serializing_if = "Option::is_none")]
agent_status: Option<AgentStatus>,
},
+ #[serde(rename = "pane.scroll_changed")]
+ PaneScrollChanged { pane_id: String },
#[serde(rename = "layout.updated")]
LayoutUpdated {},
}
@@ -350,6 +352,8 @@ pub enum SubscriptionEventKind {
PaneOutputMatched,
#[serde(rename = "pane.agent_status_changed")]
PaneAgentStatusChanged,
+ #[serde(rename = "pane.scroll_changed")]
+ ScrollChanged,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
@@ -363,6 +367,7 @@ pub struct SubscriptionEventEnvelope {
pub enum SubscriptionEventData {
PaneOutputMatched(PaneOutputMatchedEvent),
PaneAgentStatusChanged(PaneAgentStatusChangedEvent),
+ ScrollChanged(PaneScrollChangedEvent),
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
@@ -389,6 +394,13 @@ pub struct PaneAgentStatusChangedEvent {
pub state_labels: HashMap<String, String>,
}
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
+pub struct PaneScrollChangedEvent {
+ pub pane_id: String,
+ pub workspace_id: String,
+ pub scroll: PaneScrollInfo,
+}
+
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum EventData {
diff --git a/src/api/schema/panes.rs b/src/api/schema/panes.rs
index ef45a7ca..42a640ef 100644
--- a/src/api/schema/panes.rs
+++ b/src/api/schema/panes.rs
@@ -364,9 +364,18 @@ pub struct PaneInfo {
pub state_labels: HashMap<String, String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub agent_session: Option<AgentSessionInfo>,
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ pub scroll: Option<PaneScrollInfo>,
pub revision: u64,
}
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
+pub struct PaneScrollInfo {
+ pub offset_from_bottom: u64,
+ pub max_offset_from_bottom: u64,
+ pub viewport_rows: u64,
+}
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
pub struct PaneProcessInfo {
pub pane_id: String,
diff --git a/src/api/schema/tests.rs b/src/api/schema/tests.rs
index 8bb876d0..5f603a18 100644
--- a/src/api/schema/tests.rs
+++ b/src/api/schema/tests.rs
@@ -430,6 +430,10 @@ fn subscribe_request_parses_parameterized_subscriptions() {
"type": "pane.agent_status_changed",
"pane_id": "p_1_1",
"agent_status": "done"
+ },
+ {
+ "type": "pane.scroll_changed",
+ "pane_id": "p_1_1"
}
]
}
@@ -440,7 +444,7 @@ fn subscribe_request_parses_parameterized_subscriptions() {
let Method::EventsSubscribe(params) = request.method else {
panic!("wrong method parsed");
};
- assert_eq!(params.subscriptions.len(), 2);
+ assert_eq!(params.subscriptions.len(), 3);
assert!(matches!(
&params.subscriptions[0],
Subscription::PaneOutputMatched {
@@ -458,6 +462,10 @@ fn subscribe_request_parses_parameterized_subscriptions() {
agent_status: Some(AgentStatus::Done),
} if pane_id == "p_1_1"
));
+ assert!(matches!(
+ &params.subscriptions[2],
+ Subscription::PaneScrollChanged { pane_id } if pane_id == "p_1_1"
+ ));
}
#[test]
@@ -487,6 +495,27 @@ fn subscription_event_envelope_round_trips() {
}
#[test]
+fn scroll_changed_subscription_event_round_trips() {
+ let event = SubscriptionEventEnvelope {
+ event: SubscriptionEventKind::ScrollChanged,
+ data: SubscriptionEventData::ScrollChanged(PaneScrollChangedEvent {
+ pane_id: "p_1_1".into(),
+ workspace_id: "w_1".into(),
+ scroll: PaneScrollInfo {
+ offset_from_bottom: 12,
+ max_offset_from_bottom: 240,
+ viewport_rows: 30,
+ },
+ }),
+ };
+
+ let json = serde_json::to_string(&event).unwrap();
+ assert!(json.contains("\"event\":\"pane.scroll_changed\""));
+ let restored: SubscriptionEventEnvelope = serde_json::from_str(&json).unwrap();
+ assert_eq!(restored, event);
+}
+
+#[test]
fn success_response_round_trips() {
let response = SuccessResponse {
id: "req_1".into(),
@@ -600,6 +629,7 @@ fn worktree_request_and_response_round_trip() {
custom_status: None,
state_labels: HashMap::new(),
agent_session: None,
+ scroll: None,
revision: 0,
},
worktree: WorktreeInfo {
@@ -1007,6 +1037,7 @@ fn create_response_round_trips_with_root_pane() {
custom_status: None,
state_labels: HashMap::new(),
agent_session: None,
+ scroll: None,
revision: 0,
},
},
diff --git a/src/api/server.rs b/src/api/server.rs
index df0f8fc3..67093c72 100644
--- a/src/api/server.rs
+++ b/src/api/server.rs
@@ -674,6 +674,7 @@ mod tests {
custom_status: None,
state_labels: HashMap::new(),
agent_session: None,
+ scroll: None,
revision: 0,
}
}
diff --git a/src/api/subscriptions.rs b/src/api/subscriptions.rs
index 73586b99..b3a369c2 100644
--- a/src/api/subscriptions.rs
+++ b/src/api/subscriptions.rs
@@ -1,8 +1,9 @@
use regex::Regex;
use crate::api::schema::{
- ErrorBody, ErrorResponse, Method, PaneAgentStatusChangedEvent, PaneOutputMatchedEvent, Request,
- Subscription, SubscriptionEventData, SubscriptionEventEnvelope, SubscriptionEventKind,
+ ErrorBody, ErrorResponse, Method, PaneAgentStatusChangedEvent, PaneOutputMatchedEvent,
+ PaneScrollChangedEvent, PaneScrollInfo, Request, Subscription, SubscriptionEventData,
+ SubscriptionEventEnvelope, SubscriptionEventKind,
};
use crate::api::server::{dispatch_to_app_with_timeout, APP_RESPONSE_TIMEOUT};
use crate::api::{ApiRequestSender, EventHub};
@@ -55,6 +56,12 @@ pub(super) struct ActiveAgentStatusChangedSubscription {
request_prefix: String,
}
+pub(super) struct ActiveScrollChangedSubscription {
+ pane_id: String,
+ last_scroll: Option<PaneScrollInfo>,
+ request_prefix: String,
+}
+
#[derive(Debug, Clone, PartialEq, Eq)]
struct PanePresentationSnapshot {
title: Option<String>,
@@ -97,6 +104,7 @@ pub(super) enum ActiveSubscription {
Event(ActiveEventSubscription),
OutputMatched(ActiveOutputMatchedSubscription),
AgentStatusChanged(Box<ActiveAgentStatusChangedSubscription>),
+ ScrollChanged(ActiveScrollChangedSubscription),
}
impl ActiveSubscription {
@@ -269,6 +277,15 @@ impl ActiveSubscription {
},
)))
}
+ Subscription::PaneScrollChanged { pane_id } => {
+ let probe = pane_get(format!("{request_id}:sub:{index}:probe"), &pane_id, api_tx)?;
+
+ Ok(Self::ScrollChanged(ActiveScrollChangedSubscription {
+ pane_id: probe.pane_id,
+ last_scroll: probe.scroll,
+ request_prefix: format!("{request_id}:sub:{index}"),
+ }))
+ }
}
}
@@ -285,6 +302,9 @@ impl ActiveSubscription {
Self::AgentStatusChanged(subscription) => {
serde_json::to_value(subscription.poll(api_tx, event_hub)?).ok()
}
+ Self::ScrollChanged(subscription) => {
+ serde_json::to_value(subscription.poll(api_tx)?).ok()
+ }
}
}
}
@@ -466,6 +486,39 @@ impl ActiveAgentStatusChangedSubscription {
}
}
+impl ActiveScrollChangedSubscription {
+ fn poll(&mut self, api_tx: &ApiRequestSender) -> Option<SubscriptionEventEnvelope> {
+ let pane = pane_get(
+ format!("{}:pane", self.request_prefix),
+ &self.pane_id,
+ api_tx,
+ )
+ .ok()?;
+ self.event_from_snapshot(pane)
+ }
+
+ fn event_from_snapshot(
+ &mut self,
+ pane: crate::api::schema::PaneInfo,
+ ) -> Option<SubscriptionEventEnvelope> {
+ let scroll = pane.scroll;
+ if self.last_scroll == scroll {
+ return None;
+ }
+ self.last_scroll = scroll;
+ let scroll = scroll?;
+
+ Some(SubscriptionEventEnvelope {
+ event: SubscriptionEventKind::ScrollChanged,
+ data: SubscriptionEventData::ScrollChanged(PaneScrollChangedEvent {
+ pane_id: pane.pane_id,
+ workspace_id: pane.workspace_id,
+ scroll,
+ }),
+ })
+ }
+}
+
fn pane_read(
request_id: String,
pane_id: &str,
@@ -558,7 +611,7 @@ mod tests {
use std::collections::HashMap;
use super::*;
- use crate::api::schema::{AgentStatus, EventData, EventEnvelope, EventKind};
+ use crate::api::schema::{AgentStatus, EventData, EventEnvelope, EventKind, PaneInfo};
fn status_event(custom_status: Option<&str>) -> EventEnvelope {
EventEnvelope {
@@ -576,6 +629,62 @@ mod tests {
}
}
+ fn pane_info_with_scroll(scroll: Option<PaneScrollInfo>) -> PaneInfo {
+ PaneInfo {
+ pane_id: "pane_1".into(),
+ terminal_id: "terminal_1".into(),
+ workspace_id: "workspace_1".into(),
+ tab_id: "tab_1".into(),
+ focused: true,
+ cwd: None,
+ foreground_cwd: None,
+ label: None,
+ agent: None,
+ title: None,
+ display_agent: None,
+ agent_status: AgentStatus::Unknown,
+ custom_status: None,
+ state_labels: HashMap::new(),
+ agent_session: None,
+ scroll,
+ revision: 0,
+ }
+ }
+
+ #[test]
+ fn scroll_subscription_emits_when_scroll_snapshot_changes() {
+ let at_bottom = PaneScrollInfo {
+ offset_from_bottom: 0,
+ max_offset_from_bottom: 40,
+ viewport_rows: 20,
+ };
+ let scrolled_back = PaneScrollInfo {
+ offset_from_bottom: 8,
+ max_offset_from_bottom: 40,
+ viewport_rows: 20,
+ };
+ let mut subscription = ActiveScrollChangedSubscription {
+ pane_id: "pane_1".into(),
+ last_scroll: Some(at_bottom),
+ request_prefix: "test".into(),
+ };
+
+ assert!(subscription
+ .event_from_snapshot(pane_info_with_scroll(Some(at_bottom)))
+ .is_none());
+
+ let event = subscription
+ .event_from_snapshot(pane_info_with_scroll(Some(scrolled_back)))
+ .expect("scroll event");
+ assert_eq!(event.event, SubscriptionEventKind::ScrollChanged);
+ let SubscriptionEventData::ScrollChanged(data) = event.data else {
+ panic!("wrong event data");
+ };
+ assert_eq!(data.pane_id, "pane_1");
+ assert_eq!(data.workspace_id, "workspace_1");
+ assert_eq!(data.scroll, scrolled_back);
+ }
+
#[test]
fn agent_status_subscription_replays_queued_metadata_set_and_expiry_events() {
let event_hub = EventHub::default();
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-06 23:02:41 +0000