mirror of
https://github.com/openai/codex.git
synced 2026-11-18 22:20:48 +00:00
Stream partial thread search results and support cancellation (#62132)
## Why Clients using `thread/search` have to wait for the search to finish before they can show any matches. A search can also outlive the query that triggered it, such as when a user changes their task mention query. ## What changed - Add experimental `thread/search/stream` with best-effort `thread/search/partial` notifications. Each notification carries the original `requestId` and a batch of verified matches. Clients replace provisional matches with the final page, which determines results, ordering, and cursors. - Support connection-scoped cancellation through `thread/search/stream/cancel` and `thread/search/cancel` for their respective search methods. Disconnecting also stops active searches and reaps their search subprocesses. - Cancel superseded or timed-out TUI task mention searches without delaying available title matches. ## Testing Add coverage for incremental results and final-page parity, slow clients, connection-scoped cancellation and subprocess cleanup, and TUI task search cancellation. GitOrigin-RevId: b58abf7a1df424f191c8ede806d1d5266d299548
This commit is contained in:
committed by
copyberry
parent
c90234de95
commit
3bf4e138fe
@@ -6570,6 +6570,40 @@
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchPartialNotification": {
|
||||
"description": "A best-effort incremental batch for `thread/search/stream`. Match `requestId` to the request on this connection. Only a small subset of verified matches may be emitted; rows are unique and arrive in discovery order, but may be dropped under load or fall outside the final sorted page. Thread fields use stored metadata and the current watched status; live thread settings are enriched in the final response. Replace provisional rows with the authoritative final response. No partials follow it or an error.",
|
||||
"properties": {
|
||||
"data": {
|
||||
"items": {
|
||||
"$ref": "#/definitions/ThreadSearchResult"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"requestId": {
|
||||
"$ref": "#/definitions/RequestId"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data",
|
||||
"requestId"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchResult": {
|
||||
"properties": {
|
||||
"snippet": {
|
||||
"type": "string"
|
||||
},
|
||||
"thread": {
|
||||
"$ref": "#/definitions/Thread"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"snippet",
|
||||
"thread"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSection": {
|
||||
"description": "An independently persisted, user-visible thread section.",
|
||||
"properties": {
|
||||
@@ -8417,6 +8451,26 @@
|
||||
"title": "Process/outputDeltaNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
"method": {
|
||||
"enum": [
|
||||
"thread/search/partial"
|
||||
],
|
||||
"title": "Thread/search/partialNotificationMethod",
|
||||
"type": "string"
|
||||
},
|
||||
"params": {
|
||||
"$ref": "#/definitions/ThreadSearchPartialNotification"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"method",
|
||||
"params"
|
||||
],
|
||||
"title": "Thread/search/partialNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"description": "Final exit notification for a `process/spawn` session.",
|
||||
"properties": {
|
||||
|
||||
+41
@@ -5541,6 +5541,26 @@
|
||||
"title": "Process/outputDeltaNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
"method": {
|
||||
"enum": [
|
||||
"thread/search/partial"
|
||||
],
|
||||
"title": "Thread/search/partialNotificationMethod",
|
||||
"type": "string"
|
||||
},
|
||||
"params": {
|
||||
"$ref": "#/definitions/v2/ThreadSearchPartialNotification"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"method",
|
||||
"params"
|
||||
],
|
||||
"title": "Thread/search/partialNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"description": "Final exit notification for a `process/spawn` session.",
|
||||
"properties": {
|
||||
@@ -26456,6 +26476,27 @@
|
||||
"title": "ThreadRevertedNotification",
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchPartialNotification": {
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"description": "A best-effort incremental batch for `thread/search/stream`. Match `requestId` to the request on this connection. Only a small subset of verified matches may be emitted; rows are unique and arrive in discovery order, but may be dropped under load or fall outside the final sorted page. Thread fields use stored metadata and the current watched status; live thread settings are enriched in the final response. Replace provisional rows with the authoritative final response. No partials follow it or an error.",
|
||||
"properties": {
|
||||
"data": {
|
||||
"items": {
|
||||
"$ref": "#/definitions/v2/ThreadSearchResult"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"requestId": {
|
||||
"$ref": "#/definitions/v2/RequestId"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data",
|
||||
"requestId"
|
||||
],
|
||||
"title": "ThreadSearchPartialNotification",
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchResult": {
|
||||
"properties": {
|
||||
"snippet": {
|
||||
|
||||
+41
@@ -18715,6 +18715,26 @@
|
||||
"title": "Process/outputDeltaNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
"method": {
|
||||
"enum": [
|
||||
"thread/search/partial"
|
||||
],
|
||||
"title": "Thread/search/partialNotificationMethod",
|
||||
"type": "string"
|
||||
},
|
||||
"params": {
|
||||
"$ref": "#/definitions/ThreadSearchPartialNotification"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"method",
|
||||
"params"
|
||||
],
|
||||
"title": "Thread/search/partialNotification",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"description": "Final exit notification for a `process/spawn` session.",
|
||||
"properties": {
|
||||
@@ -24152,6 +24172,27 @@
|
||||
"title": "ThreadRevertedNotification",
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchPartialNotification": {
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"description": "A best-effort incremental batch for `thread/search/stream`. Match `requestId` to the request on this connection. Only a small subset of verified matches may be emitted; rows are unique and arrive in discovery order, but may be dropped under load or fall outside the final sorted page. Thread fields use stored metadata and the current watched status; live thread settings are enriched in the final response. Replace provisional rows with the authoritative final response. No partials follow it or an error.",
|
||||
"properties": {
|
||||
"data": {
|
||||
"items": {
|
||||
"$ref": "#/definitions/ThreadSearchResult"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"requestId": {
|
||||
"$ref": "#/definitions/RequestId"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"data",
|
||||
"requestId"
|
||||
],
|
||||
"title": "ThreadSearchPartialNotification",
|
||||
"type": "object"
|
||||
},
|
||||
"ThreadSearchResult": {
|
||||
"properties": {
|
||||
"snippet": {
|
||||
|
||||
+3255
File diff suppressed because it is too large
Load Diff
BIN
Binary file not shown.
BIN
Binary file not shown.
File diff suppressed because one or more lines are too long
+2
-1
File diff suppressed because one or more lines are too long
+15
@@ -0,0 +1,15 @@
|
||||
// GENERATED CODE! DO NOT MODIFY BY HAND!
|
||||
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { RequestId } from "../RequestId";
|
||||
import type { ThreadSearchResult } from "./ThreadSearchResult";
|
||||
|
||||
/**
|
||||
* A best-effort incremental batch for `thread/search/stream`. Match `requestId` to the request
|
||||
* on this connection. Only a small subset of verified matches may be emitted; rows are unique
|
||||
* and arrive in discovery order, but may be dropped under load or fall outside the final sorted
|
||||
* page. Thread fields use stored metadata
|
||||
* and the current watched status; live thread settings are enriched in the final response.
|
||||
* Replace provisional rows with the authoritative final response. No partials follow it or an error.
|
||||
*/
|
||||
export type ThreadSearchPartialNotification = { requestId: RequestId, data: Array<ThreadSearchResult>, };
|
||||
@@ -611,6 +611,7 @@ export type { ThreadResumeResponse } from "./ThreadResumeResponse";
|
||||
export type { ThreadRevertParams } from "./ThreadRevertParams";
|
||||
export type { ThreadRevertResponse } from "./ThreadRevertResponse";
|
||||
export type { ThreadRevertedNotification } from "./ThreadRevertedNotification";
|
||||
export type { ThreadSearchPartialNotification } from "./ThreadSearchPartialNotification";
|
||||
export type { ThreadSearchResult } from "./ThreadSearchResult";
|
||||
export type { ThreadSearchSortKey } from "./ThreadSearchSortKey";
|
||||
export type { ThreadSection } from "./ThreadSection";
|
||||
|
||||
@@ -885,6 +885,29 @@ client_request_definitions! {
|
||||
serialization: None,
|
||||
response: v2::ThreadSearchResponse,
|
||||
},
|
||||
#[experimental("thread/search/stream")]
|
||||
/// Search with best-effort incremental `thread/search/partial` notifications. The final
|
||||
/// response is authoritative for results, ordering, and cursors.
|
||||
ThreadSearchStream => "thread/search/stream" {
|
||||
params: v2::ThreadSearchParams,
|
||||
serialization: None,
|
||||
manual_payload_conversion: manual,
|
||||
response: v2::ThreadSearchResponse,
|
||||
},
|
||||
#[experimental("thread/search/cancel")]
|
||||
ThreadSearchCancel => "thread/search/cancel" {
|
||||
params: v2::ThreadSearchCancelParams,
|
||||
serialization: None,
|
||||
response: v2::ThreadSearchCancelResponse,
|
||||
},
|
||||
#[experimental("thread/search/stream/cancel")]
|
||||
/// Cancel a `thread/search/stream` request on this connection.
|
||||
ThreadSearchStreamCancel => "thread/search/stream/cancel" {
|
||||
params: v2::ThreadSearchCancelParams,
|
||||
serialization: None,
|
||||
manual_payload_conversion: manual,
|
||||
response: v2::ThreadSearchCancelResponse,
|
||||
},
|
||||
#[experimental("thread/searchOccurrences")]
|
||||
ThreadSearchOccurrences => "thread/searchOccurrences" {
|
||||
params: v2::ThreadSearchOccurrencesParams,
|
||||
@@ -2109,6 +2132,8 @@ server_notification_definitions! {
|
||||
/// Stream base64-encoded stdout/stderr chunks for a running `process/spawn` session.
|
||||
#[experimental("process/outputDelta")]
|
||||
ProcessOutputDelta => "process/outputDelta" (v2::ProcessOutputDeltaNotification),
|
||||
#[experimental("thread/search/partial")]
|
||||
ThreadSearchPartial => "thread/search/partial" (v2::ThreadSearchPartialNotification),
|
||||
/// Final exit notification for a `process/spawn` session.
|
||||
#[experimental("process/exited")]
|
||||
ProcessExited => "process/exited" (v2::ProcessExitedNotification),
|
||||
|
||||
@@ -19,6 +19,7 @@ use super::TurnStatus;
|
||||
use super::UserInput;
|
||||
use super::shared::v2_enum_from_core;
|
||||
use crate::JsonSchema;
|
||||
use crate::RequestId;
|
||||
use crate::TS;
|
||||
use codex_experimental_api_macros::ExperimentalApi;
|
||||
pub use codex_protocol::capabilities::CapabilityRootLocation;
|
||||
@@ -1573,7 +1574,8 @@ pub struct ThreadSearchParams {
|
||||
/// If false or null, only non-archived threads are returned.
|
||||
#[ts(optional = nullable)]
|
||||
pub archived: Option<bool>,
|
||||
/// Required substring/full-text query for thread search.
|
||||
/// Required substring/full-text query. `thread/search/stream` limits this to 65,536
|
||||
/// UTF-8 bytes after trimming surrounding whitespace.
|
||||
pub search_term: String,
|
||||
}
|
||||
|
||||
@@ -1671,6 +1673,37 @@ pub struct ThreadSearchResponse {
|
||||
pub backwards_cursor: Option<String>,
|
||||
}
|
||||
|
||||
/// A best-effort incremental batch for `thread/search/stream`. Match `requestId` to the request
|
||||
/// on this connection. Only a small subset of verified matches may be emitted; rows are unique
|
||||
/// and arrive in discovery order, but may be dropped under load or fall outside the final sorted
|
||||
/// page. Thread fields use stored metadata
|
||||
/// and the current watched status; live thread settings are enriched in the final response.
|
||||
/// Replace provisional rows with the authoritative final response. No partials follow it or an error.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export_to = "v2/")]
|
||||
pub struct ThreadSearchPartialNotification {
|
||||
pub request_id: RequestId,
|
||||
pub data: Vec<ThreadSearchResult>,
|
||||
}
|
||||
|
||||
/// Request cancellation on the same connection. `thread/search/cancel` targets only
|
||||
/// `thread/search`; `thread/search/stream/cancel` targets only `thread/search/stream`.
|
||||
/// Cancellation is idempotent: the cancel response acknowledges the request, and an interrupted
|
||||
/// search completes with an error after its subprocess is stopped and reaped. If completion races
|
||||
/// cancellation, the original search may still succeed. An already-completed search is unaffected.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export_to = "v2/")]
|
||||
pub struct ThreadSearchCancelParams {
|
||||
pub request_id: RequestId,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export_to = "v2/")]
|
||||
pub struct ThreadSearchCancelResponse {}
|
||||
|
||||
/// Parameters for searching visible message occurrences within one paginated thread.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
|
||||
Reference in New Issue
Block a user