дзеркало
https://github.com/l0ng-ai/openidea.git
синхронізовано 2026-11-17 15:15:40 +02:00
Порівняти коміти
106
Коміти
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
2fd5833321 | ||
|
|
53495fbc26 | ||
|
|
224099992a | ||
|
|
0dafd649da | ||
|
|
d2c5532ccb | ||
|
|
a03923f744 | ||
|
|
8668fdd731 | ||
|
|
17e7b98cfc | ||
|
|
77e6679701 | ||
|
|
5a0bd7d1fc | ||
|
|
e6daffae76 | ||
|
|
2b69d64055 | ||
|
|
6c9556ef54 | ||
|
|
64ee712401 | ||
|
|
0ff491cce8 | ||
|
|
4ce661ee1f | ||
|
|
55e89eac1a | ||
|
|
fcc8467657 | ||
|
|
489dd408bb | ||
|
|
4010f61453 | ||
|
|
00bbc474c0 | ||
|
|
2f68c83bcd | ||
|
|
567e45f830 | ||
|
|
245679cef8 | ||
|
|
3f3ad03d7c | ||
|
|
03ee687353 | ||
|
|
2e9e2c1699 | ||
|
|
d84d8829c4 | ||
|
|
38dfa37c88 | ||
|
|
447560e505 | ||
|
|
9bf1f320eb | ||
|
|
921378d531 | ||
|
|
1531220eea | ||
|
|
96e80f2028 | ||
|
|
e4ac29486c | ||
|
|
540094d1ae | ||
|
|
a9ec26aa08 | ||
|
|
8b6c71095a | ||
|
|
abe7c58cb9 | ||
|
|
d3d799b8fe | ||
|
|
122d7f3d0f | ||
|
|
6cdb2f1f1e | ||
|
|
dbf6de6d24 | ||
|
|
80cb458395 | ||
|
|
612cca2ec9 | ||
|
|
458286b046 | ||
|
|
043584b7de | ||
|
|
ab1a4db606 | ||
|
|
2d85e745e7 | ||
|
|
741730b7e0 | ||
|
|
026b493e93 | ||
|
|
711ef3ec96 | ||
|
|
b35bf882b5 | ||
|
|
a816a57004 | ||
|
|
52017a1172 | ||
|
|
80f50ccdfa | ||
|
|
ec76dcde7f | ||
|
|
3c624ccb22 | ||
|
|
5a000983c7 | ||
|
|
03ad6c12ca | ||
|
|
1dbd2847b9 | ||
|
|
c9f5ac9cd5 | ||
|
|
06c7127b6b | ||
|
|
635ec2d7bd | ||
|
|
ac3c564249 | ||
|
|
f76ac263a0 | ||
|
|
7a97fba491 | ||
|
|
205b4bcc5f | ||
|
|
cd574a3e28 | ||
|
|
8aed4156f4 | ||
|
|
0221034936 | ||
|
|
0d432bf1a6 | ||
|
|
cbac930a6f | ||
|
|
33f082e32f | ||
|
|
0bbf5568cd | ||
|
|
2277c1cdfd | ||
|
|
a537223233 | ||
|
|
19c7947fc4 | ||
|
|
98f9fc0063 | ||
|
|
0d5ef48a94 | ||
|
|
444b620985 | ||
|
|
0c45a96d84 | ||
|
|
fd8f8d6dd0 | ||
|
|
c1bec5182c | ||
|
|
dcb4835a87 | ||
|
|
f74bc7abac | ||
|
|
c871c164c1 | ||
|
|
db65b12afe | ||
|
|
0cc873565a | ||
|
|
7cc100367d | ||
|
|
39c0f6676e | ||
|
|
f19d5dc3f9 | ||
|
|
0a8df16941 | ||
|
|
6dcece3081 | ||
|
|
5c59566897 | ||
|
|
6b3edb6cf5 | ||
|
|
e598936529 | ||
|
|
8b7318e59a | ||
|
|
faa9a91953 | ||
|
|
c805173467 | ||
|
|
94b72c271a | ||
|
|
610d68ee41 | ||
|
|
c6bd809d08 | ||
|
|
401d66d850 | ||
|
|
4561ae05b2 | ||
|
|
34c81a61e4 |
No files matched your search
Створено
+59
-44
@@ -4144,7 +4144,7 @@ checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954"
|
||||
|
||||
[[package]]
|
||||
name = "ide-agent"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"dunce",
|
||||
@@ -4169,7 +4169,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-analysis"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ast-grep-core",
|
||||
"ide-core",
|
||||
@@ -4183,7 +4183,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-android"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"serde",
|
||||
@@ -4194,7 +4194,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-build"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"chardetng",
|
||||
@@ -4212,7 +4212,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-cli"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dirs 6.0.0",
|
||||
"serde",
|
||||
@@ -4226,7 +4226,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-clipboard"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"gtk",
|
||||
"objc2 0.6.5",
|
||||
@@ -4237,7 +4237,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-core"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"encoding_rs",
|
||||
@@ -4254,7 +4254,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-coverage"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-run",
|
||||
@@ -4268,7 +4268,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-dap"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"futures",
|
||||
@@ -4297,7 +4297,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-db"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"bb8",
|
||||
@@ -4333,7 +4333,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-docker"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"serde",
|
||||
@@ -4346,7 +4346,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-extension"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"blake3",
|
||||
@@ -4367,7 +4367,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-fonts"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"objc2-core-foundation",
|
||||
"objc2-core-text",
|
||||
@@ -4379,7 +4379,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-github"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-vcs",
|
||||
@@ -4392,7 +4392,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-heap"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"criterion",
|
||||
"ide-core",
|
||||
@@ -4410,7 +4410,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-host"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"blake3",
|
||||
@@ -4435,6 +4435,7 @@ dependencies = [
|
||||
"ide-index",
|
||||
"ide-jsonrpc",
|
||||
"ide-jvm-attach",
|
||||
"ide-jvm-inspect",
|
||||
"ide-language",
|
||||
"ide-lsp",
|
||||
"ide-mcp",
|
||||
@@ -4447,6 +4448,7 @@ dependencies = [
|
||||
"ide-search",
|
||||
"ide-spell",
|
||||
"ide-ssh",
|
||||
"ide-streams",
|
||||
"ide-syntax",
|
||||
"ide-terminal",
|
||||
"ide-text",
|
||||
@@ -4481,7 +4483,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-http"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-vfs",
|
||||
@@ -4500,7 +4502,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-index"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"criterion",
|
||||
@@ -4522,7 +4524,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-jdwp"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-jvm-inspect",
|
||||
"proptest",
|
||||
@@ -4534,7 +4536,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-jsonrpc"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"encoding_rs",
|
||||
"futures",
|
||||
@@ -4551,7 +4553,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-jvm-attach"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"tempfile",
|
||||
@@ -4560,7 +4562,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-jvm-inspect"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"futures",
|
||||
"serde",
|
||||
@@ -4571,7 +4573,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-language"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"criterion",
|
||||
@@ -4629,7 +4631,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-lsp"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"encoding_rs",
|
||||
@@ -4657,7 +4659,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-mcp"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"bytes",
|
||||
"dunce",
|
||||
@@ -4676,7 +4678,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-notebook"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"futures",
|
||||
"ide-core",
|
||||
@@ -4699,7 +4701,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-plugin"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"dunce",
|
||||
@@ -4722,7 +4724,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-profiler"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-jvm-attach",
|
||||
@@ -4736,7 +4738,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-remote"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"futures",
|
||||
@@ -4756,7 +4758,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-run"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"encoding_rs",
|
||||
@@ -4780,7 +4782,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-scaffold"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-tools",
|
||||
@@ -4796,7 +4798,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-sdk"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"flate2",
|
||||
@@ -4819,7 +4821,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-search"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"criterion",
|
||||
"encoding_rs",
|
||||
@@ -4840,7 +4842,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-spell"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"parking_lot",
|
||||
@@ -4853,7 +4855,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-ssh"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dirs 6.0.0",
|
||||
"flate2",
|
||||
@@ -4876,9 +4878,22 @@ dependencies = [
|
||||
"uuid",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ide-streams"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-language",
|
||||
"ide-syntax",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"specta",
|
||||
"tree-sitter",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ide-syntax"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"ide-language",
|
||||
@@ -4893,7 +4908,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-terminal"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"ide-core",
|
||||
"libc",
|
||||
@@ -4906,7 +4921,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-text"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"criterion",
|
||||
"ide-core",
|
||||
@@ -4919,7 +4934,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-tools"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"flate2",
|
||||
"hex",
|
||||
@@ -4940,7 +4955,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-vcs"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"dunce",
|
||||
@@ -4961,7 +4976,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-vfs"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"chardetng",
|
||||
"dunce",
|
||||
@@ -4987,7 +5002,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-web"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"dirs 6.0.0",
|
||||
"ide-core",
|
||||
@@ -5003,7 +5018,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ide-workspace"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"blake3",
|
||||
"dunce",
|
||||
@@ -6632,7 +6647,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "openidea"
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"blake3",
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@ members = ["crates/*", "src-tauri"]
|
||||
exclude = ["sdk", "plugins"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.1.45"
|
||||
version = "0.1.46"
|
||||
edition = "2024"
|
||||
rust-version = "1.96"
|
||||
license = "Apache-2.0"
|
||||
@@ -52,6 +52,7 @@ ide-jvm-attach = { path = "crates/ide-jvm-attach" }
|
||||
ide-jvm-inspect = { path = "crates/ide-jvm-inspect" }
|
||||
ide-jdwp = { path = "crates/ide-jdwp" }
|
||||
ide-heap = { path = "crates/ide-heap" }
|
||||
ide-streams = { path = "crates/ide-streams" }
|
||||
|
||||
# serialization & IPC typing
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
`src/ui/brands/*.svg` use the unmodified logo paths from
|
||||
[Simple Icons](https://github.com/simple-icons/simple-icons), retrieved through
|
||||
Iconify (`simple-icons:angular`, `simple-icons:astro`, `simple-icons:cplusplus`, `simple-icons:dart`, `simple-icons:django`, `simple-icons:dotnet`, `simple-icons:elixir`, `simple-icons:express`, `simple-icons:fastapi`, `simple-icons:flask`, `simple-icons:flutter`, `simple-icons:go`, `simple-icons:haskell`, `simple-icons:html5`, `simple-icons:kotlin`, `simple-icons:ktor`, `simple-icons:laravel`, `simple-icons:nestjs`, `simple-icons:nextdotjs`, `simple-icons:nodedotjs`, `simple-icons:nuxt`, `simple-icons:openjdk`, `simple-icons:phoenixframework`, `simple-icons:php`, `simple-icons:python`, `simple-icons:quarkus`, `simple-icons:ruby`, `simple-icons:rubyonrails`, `simple-icons:rust`, `simple-icons:scala`, `simple-icons:springboot`, `simple-icons:svelte`, `simple-icons:swift`, `simple-icons:symfony`, `simple-icons:vite`, `simple-icons:zig`) and filled with the brand colors (the standard icon grey for black logos). Licensed under [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md).
|
||||
Iconify (`simple-icons:angular`, `simple-icons:astro`, `simple-icons:cplusplus`, `simple-icons:dart`, `simple-icons:deepseek`, `simple-icons:django`, `simple-icons:dotnet`, `simple-icons:elixir`, `simple-icons:express`, `simple-icons:fastapi`, `simple-icons:flask`, `simple-icons:flutter`, `simple-icons:go`, `simple-icons:haskell`, `simple-icons:html5`, `simple-icons:kotlin`, `simple-icons:ktor`, `simple-icons:laravel`, `simple-icons:nestjs`, `simple-icons:nextdotjs`, `simple-icons:nodedotjs`, `simple-icons:nuxt`, `simple-icons:openjdk`, `simple-icons:phoenixframework`, `simple-icons:php`, `simple-icons:python`, `simple-icons:quarkus`, `simple-icons:ruby`, `simple-icons:rubyonrails`, `simple-icons:rust`, `simple-icons:scala`, `simple-icons:springboot`, `simple-icons:svelte`, `simple-icons:swift`, `simple-icons:symfony`, `simple-icons:vite`, `simple-icons:zig`) and filled with the brand colors (the standard icon grey for black logos). Licensed under [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md).
|
||||
|
||||
## Project Lombok
|
||||
|
||||
|
||||
@@ -14,20 +14,21 @@ use std::collections::BTreeMap;
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
const CONFIG_UPDATE_TIMEOUT: Duration = if cfg!(test) { Duration::from_millis(100) } else { Duration::from_secs(5) };
|
||||
const DISCOVER_TIMEOUT: Duration = if cfg!(test) { Duration::from_secs(3) } else { Duration::from_secs(120) };
|
||||
|
||||
/// Opens `session/new`, reads `configOptions`, and records the `thought_level` choices of the
|
||||
/// session's model: they describe that model only, and other models may offer different ones.
|
||||
pub(crate) async fn run(shared: &Arc<Shared>, spec: &ProviderSpec) -> Result<Discovered, String> {
|
||||
pub(crate) async fn run(shared: &Arc<Shared>, spec: &ProviderSpec, model: Option<&str>) -> Result<Discovered, String> {
|
||||
let prefer_stored = crate::provider::prefer_stored_copilot_auth();
|
||||
match run_once(shared, spec, prefer_stored).await {
|
||||
match run_once(shared, spec, prefer_stored, model).await {
|
||||
Err(err)
|
||||
if !prefer_stored
|
||||
&& crate::provider::is_copilot_provider(&spec.id)
|
||||
&& crate::provider::has_unconfigured_copilot_ambient_token(&spec.env)
|
||||
&& super::auth_required(0, &err) =>
|
||||
{
|
||||
let retry = run_once(shared, spec, true).await;
|
||||
let retry = run_once(shared, spec, true, model).await;
|
||||
if retry.is_ok() {
|
||||
crate::provider::mark_prefer_stored_copilot_auth();
|
||||
}
|
||||
@@ -37,7 +38,12 @@ pub(crate) async fn run(shared: &Arc<Shared>, spec: &ProviderSpec) -> Result<Dis
|
||||
}
|
||||
}
|
||||
|
||||
async fn run_once(shared: &Arc<Shared>, spec: &ProviderSpec, strip_ambient: bool) -> Result<Discovered, String> {
|
||||
async fn run_once(
|
||||
shared: &Arc<Shared>,
|
||||
spec: &ProviderSpec,
|
||||
strip_ambient: bool,
|
||||
selected_model: Option<&str>,
|
||||
) -> Result<Discovered, String> {
|
||||
let root = shared.paths.project_root.clone();
|
||||
let launch = spec.clone();
|
||||
let launch = tokio::task::spawn_blocking({
|
||||
@@ -47,28 +53,63 @@ async fn run_once(shared: &Arc<Shared>, spec: &ProviderSpec, strip_ambient: bool
|
||||
.await
|
||||
.map_err(|e| e.to_string())?;
|
||||
let cwd = dunce::canonicalize(&root).unwrap_or(root);
|
||||
let updates = Arc::new(DiscoveryUpdates { provider: spec.id.clone(), commands: Mutex::new(None) });
|
||||
let updates = Arc::new(DiscoveryUpdates { provider: spec.id.clone(), ..Default::default() });
|
||||
let client = Dialect::wrap(updates.clone());
|
||||
let on_stderr: Box<dyn Fn(String) + Send + Sync> = Box::new(|_| {});
|
||||
let peer = (shared.connector)(&launch, &cwd, client.clone(), on_stderr)
|
||||
.map_err(|e| format!("Couldn't start {} (`{}`): {e}", launch.name, launch.command))?;
|
||||
.map_err(|e| format!("Couldn't start {} for model discovery: {e}", launch.name))?;
|
||||
let _stop = crate::catalogs::KillPeer(peer.clone());
|
||||
let conn = Conn::new(peer.clone(), client);
|
||||
let work = async {
|
||||
conn.initialize(&client_info()).await.map_err(|e| e.to_string())?;
|
||||
conn.initialize(&client_info()).await.map_err(discovery_error)?;
|
||||
let cwd_s = cwd.to_string_lossy().into_owned();
|
||||
// No project MCP during discovery: Cursor can spend a long time spawning servers.
|
||||
let new: Value = conn
|
||||
.request("session/new", json!({ "cwd": cwd_s, "mcpServers": [] }), None)
|
||||
.await
|
||||
.map_err(|e| e.to_string())?;
|
||||
.map_err(discovery_error)?;
|
||||
let mut options = config::options_of(&new);
|
||||
config::add_client_options(&launch.id, &mut options);
|
||||
let model = options.iter().find(|o| o.category.as_deref() == Some("model")).and_then(|o| o.current.clone());
|
||||
let levels = match (model, levels_for_model_from_slice(&options)) {
|
||||
(Some(model), Some(effort)) => BTreeMap::from([(model, effort)]),
|
||||
_ => BTreeMap::new(),
|
||||
};
|
||||
let model_option = options.iter().find(|o| o.category.as_deref() == Some("model"));
|
||||
let mut levels = BTreeMap::new();
|
||||
if new.get("configOptions").is_some_and(Value::is_array)
|
||||
&& let Some(model) = model_option.and_then(|o| o.current.as_ref())
|
||||
{
|
||||
levels.insert(model.clone(), levels_for_model_from_slice(&options));
|
||||
}
|
||||
if let Some(selected) = selected_model
|
||||
&& let Some(option) = model_option.filter(|o| o.values.iter().any(|v| v.value == selected))
|
||||
&& !levels.contains_key(selected)
|
||||
{
|
||||
let session =
|
||||
new.get("sessionId").and_then(Value::as_str).ok_or("The agent did not return a session ID")?;
|
||||
let (method, mut params) = config::set_request(option, selected);
|
||||
params["sessionId"] = json!(session);
|
||||
updates.config.lock().session = Some(session.to_owned());
|
||||
let response: Value = conn.request(method, params, None).await.map_err(discovery_error)?;
|
||||
let settings = if let Some(settings) = selected_settings(&response, selected) {
|
||||
settings
|
||||
} else {
|
||||
tokio::time::timeout(CONFIG_UPDATE_TIMEOUT, async {
|
||||
loop {
|
||||
let notified = updates.changed.notified();
|
||||
if let Some(settings) = updates
|
||||
.config
|
||||
.lock()
|
||||
.options
|
||||
.as_ref()
|
||||
.and_then(|options| selected_settings(options, selected))
|
||||
{
|
||||
return settings;
|
||||
}
|
||||
notified.await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.map_err(|_| "The agent did not report settings for the selected model".to_owned())?
|
||||
};
|
||||
levels.insert(selected.to_owned(), levels_for_model_from_slice(&settings));
|
||||
}
|
||||
let commands = updates
|
||||
.commands
|
||||
.lock()
|
||||
@@ -88,16 +129,38 @@ async fn run_once(shared: &Arc<Shared>, spec: &ProviderSpec, strip_ambient: bool
|
||||
struct DiscoveryUpdates {
|
||||
provider: String,
|
||||
commands: Mutex<Option<Vec<crate::AgentCommand>>>,
|
||||
config: Mutex<DiscoveryConfig>,
|
||||
changed: tokio::sync::Notify,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct DiscoveryConfig {
|
||||
session: Option<String>,
|
||||
options: Option<Value>,
|
||||
}
|
||||
|
||||
impl ide_jsonrpc::Handler for DiscoveryUpdates {
|
||||
fn on_notification(&self, method: &str, params: Value) {
|
||||
if method == "session/update"
|
||||
&& let Some(update) = params.get("update")
|
||||
&& update["sessionUpdate"] == "available_commands_update"
|
||||
{
|
||||
// Commands are protocol data, not stderr (which may contain credentials).
|
||||
*self.commands.lock() = Some(config::commands_of(update, &self.provider));
|
||||
if method != "session/update" {
|
||||
return;
|
||||
}
|
||||
let Some(update) = params.get("update") else { return };
|
||||
match update["sessionUpdate"].as_str() {
|
||||
Some("available_commands_update") => {
|
||||
// Commands are protocol data, not stderr (which may contain credentials).
|
||||
*self.commands.lock() = Some(config::commands_of(update, &self.provider));
|
||||
}
|
||||
Some("config_option_update") => {
|
||||
let mut config = self.config.lock();
|
||||
if config.session.as_deref() == params.get("sessionId").and_then(Value::as_str)
|
||||
&& config.session.is_some()
|
||||
&& update.get("configOptions").is_some_and(Value::is_array)
|
||||
{
|
||||
config.options = Some(update.clone());
|
||||
self.changed.notify_one();
|
||||
}
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -106,8 +169,24 @@ impl ide_jsonrpc::Handler for DiscoveryUpdates {
|
||||
}
|
||||
}
|
||||
|
||||
fn levels_for_model_from_slice(options: &[AgentConfigOption]) -> Option<Vec<AgentConfigOption>> {
|
||||
let levels: Vec<_> = options
|
||||
fn discovery_error(error: ide_jsonrpc::RpcError) -> String {
|
||||
match error {
|
||||
ide_jsonrpc::RpcError::Server { code, message, .. } if super::auth_required(code, &message) => {
|
||||
"Sign in required: the agent could not authenticate model discovery".into()
|
||||
}
|
||||
other => format!("The agent could not complete model discovery: {other}"),
|
||||
}
|
||||
}
|
||||
|
||||
fn selected_settings(response: &Value, model: &str) -> Option<Vec<AgentConfigOption>> {
|
||||
response.get("configOptions")?.as_array()?;
|
||||
let options = config::options_of(response);
|
||||
let current = options.iter().find(|o| o.category.as_deref() == Some("model")).and_then(|o| o.current.as_deref());
|
||||
current.is_none_or(|current| current == model).then_some(options)
|
||||
}
|
||||
|
||||
fn levels_for_model_from_slice(options: &[AgentConfigOption]) -> Vec<AgentConfigOption> {
|
||||
options
|
||||
.iter()
|
||||
.filter(|o| config::is_per_model_option(o))
|
||||
.cloned()
|
||||
@@ -121,6 +200,5 @@ fn levels_for_model_from_slice(options: &[AgentConfigOption]) -> Option<Vec<Agen
|
||||
}
|
||||
o
|
||||
})
|
||||
.collect();
|
||||
(!levels.is_empty()).then_some(levels)
|
||||
.collect()
|
||||
}
|
||||
@@ -27,7 +27,7 @@ use serde::de::DeserializeOwned;
|
||||
use serde_json::{Value, json};
|
||||
use std::collections::HashMap;
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::{AtomicU8, Ordering};
|
||||
use std::sync::atomic::{AtomicBool, AtomicU8, Ordering};
|
||||
use tokio::sync::oneshot;
|
||||
|
||||
/// ACP's error code for a request that needs the user to sign in.
|
||||
@@ -162,9 +162,16 @@ impl Negotiated {
|
||||
Self { generation: 2, capabilities, agent_info: response.get("info").cloned(), auth_methods, meta }
|
||||
}
|
||||
|
||||
/// Whether a saved session can be reopened (`session/load` on v1, `session/resume` on v2).
|
||||
/// Whether a saved session can be reopened: `loadSession`, or a v1 agent's
|
||||
/// `sessionCapabilities.resume` (DeepSeek Harness), which stands in for it.
|
||||
pub fn load_session(&self) -> bool {
|
||||
self.capabilities.get("loadSession").and_then(Value::as_bool) == Some(true)
|
||||
self.capabilities.get("loadSession").and_then(Value::as_bool) == Some(true) || self.session("resume")
|
||||
}
|
||||
|
||||
/// Whether `session/load` must be sent as `session/resume`: a v1 agent that advertises
|
||||
/// `sessionCapabilities.resume` instead of `loadSession` (DeepSeek Harness).
|
||||
pub fn resume_instead_of_load(&self) -> bool {
|
||||
self.capabilities.get("loadSession").and_then(Value::as_bool) != Some(true) && self.session("resume")
|
||||
}
|
||||
|
||||
/// `promptCapabilities.<name>` (`image`, `audio`, `embeddedContext`).
|
||||
@@ -205,6 +212,8 @@ pub(crate) struct Dialect {
|
||||
inner: Arc<dyn Handler>,
|
||||
/// 0 until `initialize` answers; then 1 or 2.
|
||||
generation: AtomicU8,
|
||||
/// Set by `initialize`: a v1 agent's `session/load` is sent as `session/resume`.
|
||||
resume_load: AtomicBool,
|
||||
normalizer: Mutex<Normalizer>,
|
||||
/// Running v2 prompts, by session id.
|
||||
turns: Mutex<HashMap<String, Turn>>,
|
||||
@@ -222,6 +231,7 @@ impl Dialect {
|
||||
Arc::new(Self {
|
||||
inner,
|
||||
generation: AtomicU8::new(0),
|
||||
resume_load: AtomicBool::new(false),
|
||||
normalizer: Mutex::new(Normalizer::default()),
|
||||
turns: Mutex::new(HashMap::new()),
|
||||
})
|
||||
@@ -231,6 +241,10 @@ impl Dialect {
|
||||
self.generation.load(Ordering::Acquire)
|
||||
}
|
||||
|
||||
fn resume_load(&self) -> bool {
|
||||
self.resume_load.load(Ordering::Acquire)
|
||||
}
|
||||
|
||||
fn v2(&self) -> bool {
|
||||
self.generation() == 2
|
||||
}
|
||||
@@ -380,6 +394,7 @@ impl Conn {
|
||||
let response: Value = self.peer.request("initialize", initialize_params(client_info), None).await?;
|
||||
let negotiated = Negotiated::from_initialize(&response);
|
||||
self.dialect.generation.store(negotiated.generation, Ordering::Release);
|
||||
self.dialect.resume_load.store(negotiated.resume_instead_of_load(), Ordering::Release);
|
||||
Ok(negotiated)
|
||||
}
|
||||
|
||||
@@ -393,6 +408,9 @@ impl Conn {
|
||||
let params = serde_json::to_value(params).map_err(|e| RpcError::Protocol(e.to_string()))?;
|
||||
let value = if self.dialect.v2() {
|
||||
self.request_v2(method, params, cancel).await?
|
||||
} else if method == "session/load" && self.dialect.resume_load() {
|
||||
// Same request shape, without a replay and without v2's setup translation.
|
||||
self.peer.request("session/resume", params, cancel).await?
|
||||
} else {
|
||||
self.peer.request(method, params, cancel).await?
|
||||
};
|
||||
|
||||
@@ -180,6 +180,7 @@ async fn discovery_reads_effort_and_fast_from_session_new_then_stops_the_agent()
|
||||
fn a_v2_initialize_response_reads_as_v1_capabilities() {
|
||||
let n = Negotiated::from_initialize(&result(TURN, 1));
|
||||
assert_eq!(n.generation, 2);
|
||||
assert!(!n.resume_instead_of_load(), "v2 maps `session/load` itself");
|
||||
assert!(n.load_session());
|
||||
assert!(n.prompt("image") && n.prompt("embeddedContext") && !n.prompt("audio"));
|
||||
assert!(n.session("fork") && n.session("resume") && n.session("close") && n.session("delete"));
|
||||
@@ -681,3 +682,87 @@ fn stdio_mcp_is_v1_baseline_and_negotiated_in_v2() {
|
||||
.mcp_stdio()
|
||||
);
|
||||
}
|
||||
|
||||
/// A v1 agent that answers `initialize` with `init` and records every request it gets.
|
||||
/// Keeps its own `Peer` so the duplex stays open while the client sends.
|
||||
struct V1Agent {
|
||||
init: Value,
|
||||
peer: std::sync::OnceLock<Peer>,
|
||||
requests: parking_lot::Mutex<Vec<(String, Value)>>,
|
||||
}
|
||||
|
||||
impl Handler for V1Agent {
|
||||
fn on_notification(&self, _: &str, _: Value) {}
|
||||
|
||||
fn on_request(&self, method: &str, params: Value) -> Result<Value, (i64, String)> {
|
||||
self.requests.lock().push((method.to_owned(), params));
|
||||
Ok(if method == "initialize" { self.init.clone() } else { json!({}) })
|
||||
}
|
||||
}
|
||||
|
||||
async fn connect_v1(agent: Arc<V1Agent>) -> (Conn, Negotiated) {
|
||||
let (a, b) = tokio::io::duplex(1 << 20);
|
||||
let (ar, aw) = tokio::io::split(a);
|
||||
let (br, bw) = tokio::io::split(b);
|
||||
let _ = agent.peer.set(Peer::connect_framed(br, bw, agent.clone(), Framing::Lines));
|
||||
let dialect = Dialect::wrap(Arc::new(Recorder::default()));
|
||||
let conn = Conn::new(Peer::connect_framed(ar, aw, dialect.clone(), Framing::Lines), dialect);
|
||||
let n = conn.initialize(&json!({ "name": "OpenIDEA", "version": "0" })).await.unwrap();
|
||||
assert_eq!((n.generation, conn.generation()), (1, 1));
|
||||
(conn, n)
|
||||
}
|
||||
|
||||
fn v1_agent(init: Value) -> Arc<V1Agent> {
|
||||
Arc::new(V1Agent { init, peer: Default::default(), requests: Default::default() })
|
||||
}
|
||||
|
||||
/// A v1 agent that advertises `sessionCapabilities.resume` instead of `loadSession`
|
||||
/// (DeepSeek Harness) can reopen a saved session, but only through `session/resume`.
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn a_v1_agent_with_resume_instead_of_load_reopens_through_session_resume() {
|
||||
let agent = v1_agent(json!({
|
||||
"protocolVersion": 1,
|
||||
"agentInfo": { "name": "deepseek-harness-acp", "version": "0.0.1" },
|
||||
"agentCapabilities": { "sessionCapabilities": { "close": {}, "list": {}, "resume": {} } },
|
||||
}));
|
||||
let (conn, n) = connect_v1(agent.clone()).await;
|
||||
assert!(n.load_session(), "a resume-only agent is reloadable");
|
||||
assert!(n.resume_instead_of_load());
|
||||
assert!(n.session("resume"));
|
||||
|
||||
let params = json!({ "sessionId": "s1", "cwd": "/p", "mcpServers": [] });
|
||||
let _: Value = conn.request("session/load", params.clone(), None).await.unwrap();
|
||||
let requests = agent.requests.lock().clone();
|
||||
assert_eq!(requests.iter().map(|(m, _)| m.as_str()).collect::<Vec<_>>(), ["initialize", "session/resume"]);
|
||||
assert_eq!(requests[1].1, params, "same request shape as `session/load`");
|
||||
}
|
||||
|
||||
/// Every other v1 agent is untouched: `loadSession` still sends `session/load`, and an
|
||||
/// agent advertising neither capability is not treated as loadable.
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn v1_agents_that_do_not_advertise_resume_keep_session_load() {
|
||||
for (init, loadable) in [
|
||||
(json!({ "protocolVersion": 1, "agentCapabilities": { "loadSession": true } }), true),
|
||||
(json!({ "protocolVersion": 1, "agentCapabilities": { "loadSession": false } }), false),
|
||||
(json!({ "protocolVersion": 1, "agentCapabilities": { "sessionCapabilities": { "resume": null } } }), false),
|
||||
(json!({ "protocolVersion": 1 }), false),
|
||||
] {
|
||||
let agent = v1_agent(init);
|
||||
let (conn, n) = connect_v1(agent.clone()).await;
|
||||
assert_eq!(n.load_session(), loadable);
|
||||
assert!(!n.resume_instead_of_load());
|
||||
let _: Value = conn.request("session/load", json!({ "sessionId": "s1" }), None).await.unwrap();
|
||||
let methods: Vec<String> = agent.requests.lock().iter().map(|(m, _)| m.clone()).collect();
|
||||
assert_eq!(methods, ["initialize", "session/load"]);
|
||||
}
|
||||
// `loadSession: true` wins over a resume-only advertisement.
|
||||
let agent = v1_agent(json!({
|
||||
"protocolVersion": 1,
|
||||
"agentCapabilities": { "loadSession": true, "sessionCapabilities": { "resume": {} } },
|
||||
}));
|
||||
let (conn, n) = connect_v1(agent.clone()).await;
|
||||
assert!(n.load_session() && !n.resume_instead_of_load());
|
||||
let _: Value = conn.request("session/load", json!({ "sessionId": "s1" }), None).await.unwrap();
|
||||
let methods: Vec<String> = agent.requests.lock().iter().map(|(m, _)| m.clone()).collect();
|
||||
assert_eq!(methods, ["initialize", "session/load"]);
|
||||
}
|
||||
@@ -45,9 +45,18 @@ struct Entry {
|
||||
error: Option<String>,
|
||||
flight: Option<watch::Receiver<bool>>,
|
||||
abort: Option<tokio::task::AbortHandle>,
|
||||
flight_model: Option<String>,
|
||||
requested_model: Option<String>,
|
||||
model_failures: HashMap<String, ModelFailure>,
|
||||
catalog: Option<CatalogData>,
|
||||
}
|
||||
|
||||
struct ModelFailure {
|
||||
completed: Instant,
|
||||
retry_at_ms: f64,
|
||||
error: String,
|
||||
}
|
||||
|
||||
#[derive(Clone, Default, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub(crate) struct CatalogData {
|
||||
@@ -204,6 +213,24 @@ impl AgentCatalogs {
|
||||
.unwrap_or_else(|| Self::fallback(shared, provider))
|
||||
}
|
||||
|
||||
pub(crate) fn levels(&self, shared: &Shared, provider: &str, model: &str) -> Option<Vec<AgentConfigOption>> {
|
||||
let state = self.state.lock();
|
||||
if let Some(catalog) = state.entries.get(&Self::key(shared, provider)).and_then(|entry| entry.catalog.as_ref())
|
||||
{
|
||||
return catalog.thought_levels.get(model).cloned();
|
||||
}
|
||||
drop(state);
|
||||
let cache = shared.known.lock();
|
||||
let known = cache.get(provider)?;
|
||||
known
|
||||
.catalogs
|
||||
.get(&shared.root_key())
|
||||
.map(|saved| &saved.catalog.thought_levels)
|
||||
.unwrap_or(&known.thought_levels)
|
||||
.get(model)
|
||||
.cloned()
|
||||
}
|
||||
|
||||
pub(crate) fn evict_if_idle(&self, shared: &Shared, provider: &str) {
|
||||
let key = Self::key(shared, provider);
|
||||
let mut state = self.state.lock();
|
||||
@@ -214,16 +241,27 @@ impl AgentCatalogs {
|
||||
|
||||
fn snapshot(&self, shared: &Shared, provider: &str, entry: &Entry) -> AgentModelCatalog {
|
||||
let catalog = entry.catalog.clone().unwrap_or_else(|| Self::fallback(shared, provider));
|
||||
let model_failure = entry.requested_model.as_ref().and_then(|model| entry.model_failures.get(model));
|
||||
let unknown_model = entry
|
||||
.requested_model
|
||||
.as_deref()
|
||||
.is_some_and(|model| catalog.lists(model) && !catalog.thought_levels.contains_key(model));
|
||||
AgentModelCatalog {
|
||||
provider: provider.to_owned(),
|
||||
config: shared.config_for_new_task(catalog.config, provider),
|
||||
thought_levels: catalog.thought_levels,
|
||||
refreshing: entry.flight.is_some(),
|
||||
refreshed_at_ms: catalog.refreshed_at_ms,
|
||||
retry_at_ms: entry
|
||||
.retry_at_ms
|
||||
.filter(|_| entry.completed.is_some_and(|at| self.now().duration_since(at) < COOLDOWN)),
|
||||
error: entry.error.clone(),
|
||||
retry_at_ms: model_failure
|
||||
.filter(|failure| self.now().duration_since(failure.completed) < COOLDOWN)
|
||||
.map(|failure| failure.retry_at_ms)
|
||||
.or_else(|| {
|
||||
(!unknown_model)
|
||||
.then_some(entry.retry_at_ms)
|
||||
.flatten()
|
||||
.filter(|_| entry.completed.is_some_and(|at| self.now().duration_since(at) < COOLDOWN))
|
||||
}),
|
||||
error: model_failure.map(|failure| failure.error.clone()).or_else(|| entry.error.clone()),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -233,6 +271,7 @@ impl AgentCatalogs {
|
||||
shared: &Arc<Shared>,
|
||||
spec: provider::ProviderSpec,
|
||||
force: bool,
|
||||
model: Option<&str>,
|
||||
) -> (AgentModelCatalog, Option<watch::Receiver<bool>>) {
|
||||
let key = Self::key(shared, &spec.id);
|
||||
let context = LaunchContext::new(spec.clone(), &shared.paths.project_root);
|
||||
@@ -264,6 +303,7 @@ impl AgentCatalogs {
|
||||
let mut catalog = saved.catalog;
|
||||
if !matching {
|
||||
catalog.refreshed_at_ms = None;
|
||||
catalog.thought_levels.clear();
|
||||
}
|
||||
catalog
|
||||
});
|
||||
@@ -279,31 +319,73 @@ impl AgentCatalogs {
|
||||
error: None,
|
||||
flight: None,
|
||||
abort: None,
|
||||
flight_model: None,
|
||||
requested_model: None,
|
||||
model_failures: HashMap::new(),
|
||||
},
|
||||
);
|
||||
}
|
||||
let fallback =
|
||||
state.entries.get(&key).filter(|entry| entry.catalog.is_none()).map(|_| Self::fallback(shared, &spec.id));
|
||||
state.generation += 1;
|
||||
let generation = state.generation;
|
||||
let entry = state.entries.get_mut(&key).expect("catalog entry");
|
||||
let cooling = entry.completed.is_some_and(|at| now.duration_since(at) < COOLDOWN);
|
||||
let catalog = entry.catalog.as_ref().or(fallback.as_ref()).expect("cached catalog");
|
||||
let fresh = entry.successful.is_some_and(|at| now.duration_since(at) < FRESH_FOR);
|
||||
let target = model
|
||||
.filter(|model| {
|
||||
(catalog.lists(model) && !catalog.thought_levels.contains_key(*model))
|
||||
|| (!fresh && catalog.model_option().is_none())
|
||||
})
|
||||
.map(str::to_owned);
|
||||
if model.is_some() && entry.requested_model.as_deref() != model {
|
||||
entry.requested_model = model.map(str::to_owned);
|
||||
}
|
||||
let superseded = model.is_some()
|
||||
&& entry.flight.is_some()
|
||||
&& (entry.flight_model.is_some() || target.is_some())
|
||||
&& entry.flight_model.as_deref() != target.as_deref();
|
||||
if superseded {
|
||||
if let Some(abort) = entry.abort.take() {
|
||||
abort.abort();
|
||||
}
|
||||
entry.flight = None;
|
||||
entry.generation = generation;
|
||||
entry.flight_model = None;
|
||||
}
|
||||
let cooling = match target.as_ref() {
|
||||
Some(model) => entry.model_failures.get(model).is_some_and(|f| now.duration_since(f.completed) < COOLDOWN),
|
||||
None => entry.completed.is_some_and(|at| now.duration_since(at) < COOLDOWN),
|
||||
};
|
||||
let eligible = !cooling && (target.is_some() || force || !fresh);
|
||||
let mut start = None;
|
||||
if entry.flight.is_none() && !cooling && (force || !fresh) {
|
||||
if entry.flight.is_none() && eligible {
|
||||
let (done, ready) = watch::channel(false);
|
||||
entry.flight = Some(ready);
|
||||
entry.flight_model = target.clone();
|
||||
entry.error = None;
|
||||
if let Some(model) = target.as_ref() {
|
||||
entry.model_failures.remove(model);
|
||||
}
|
||||
entry.retry_at_ms = None;
|
||||
start = Some((entry.generation, done));
|
||||
// Every flight has its own generation, including superseded model selections.
|
||||
entry.generation = generation;
|
||||
start = Some((entry.generation, target, done));
|
||||
}
|
||||
let snapshot = self.snapshot(shared, &spec.id, entry);
|
||||
let flight = entry.flight.clone();
|
||||
drop(state);
|
||||
if let Some((generation, done)) = start {
|
||||
if superseded && start.is_none() {
|
||||
self.broadcast(shared, &snapshot);
|
||||
}
|
||||
if let Some((generation, model, done)) = start {
|
||||
self.broadcast(shared, &snapshot);
|
||||
let coordinator = self.clone();
|
||||
let shared = shared.clone();
|
||||
let flight_key = key.clone();
|
||||
let task = shared.runtime.clone().spawn(async move {
|
||||
let result = discover(&shared, spec).await;
|
||||
coordinator.complete(&shared, flight_key, generation, result);
|
||||
let result = discover(&shared, spec, model.as_deref()).await;
|
||||
coordinator.complete(&shared, flight_key, generation, model, result);
|
||||
let _ = done.send(true);
|
||||
});
|
||||
// A subscriber can re-enter and change configuration during the start event.
|
||||
@@ -319,7 +401,14 @@ impl AgentCatalogs {
|
||||
(snapshot, flight)
|
||||
}
|
||||
|
||||
fn complete(&self, shared: &Shared, key: Key, generation: u64, result: Result<Discovered, String>) {
|
||||
fn complete(
|
||||
&self,
|
||||
shared: &Shared,
|
||||
key: Key,
|
||||
generation: u64,
|
||||
model: Option<String>,
|
||||
result: Result<Discovered, String>,
|
||||
) {
|
||||
let current = provider::load(shared.paths.custom_agents_dir.as_deref(), shared.env_secrets())
|
||||
.into_iter()
|
||||
.find(|spec| spec.id == key.2)
|
||||
@@ -330,6 +419,7 @@ impl AgentCatalogs {
|
||||
if current.as_ref() != Some(&entry.context) {
|
||||
entry.flight = None;
|
||||
entry.abort = None;
|
||||
entry.flight_model = None;
|
||||
entry.completed = None;
|
||||
entry.retry_at_ms = None;
|
||||
entry.error = None;
|
||||
@@ -340,12 +430,16 @@ impl AgentCatalogs {
|
||||
return;
|
||||
}
|
||||
let now = self.now();
|
||||
entry.completed = Some(now);
|
||||
entry.retry_at_ms = Some(self.epoch_ms() + COOLDOWN.as_millis() as f64);
|
||||
if model.is_none() {
|
||||
entry.completed = Some(now);
|
||||
entry.retry_at_ms = Some(self.epoch_ms() + COOLDOWN.as_millis() as f64);
|
||||
}
|
||||
entry.flight = None;
|
||||
entry.abort = None;
|
||||
entry.flight_model = None;
|
||||
let success = match result {
|
||||
Ok(found) => {
|
||||
let previous = entry.catalog.take().unwrap_or_else(|| Self::fallback(shared, &key.2));
|
||||
let mut cache = shared.known.lock();
|
||||
let known = cache.entry(key.2.clone()).or_default();
|
||||
let mut catalog = CatalogData {
|
||||
@@ -354,7 +448,7 @@ impl AgentCatalogs {
|
||||
refreshed_at_ms: Some(self.epoch_ms()),
|
||||
};
|
||||
// Efforts sessions reported for models discovery doesn't read stay while listed.
|
||||
for (model, levels) in entry.catalog.take().map(|old| old.thought_levels).unwrap_or_default() {
|
||||
for (model, levels) in previous.thought_levels {
|
||||
if catalog.lists(&model) && !catalog.thought_levels.contains_key(&model) {
|
||||
catalog.thought_levels.insert(model, levels);
|
||||
}
|
||||
@@ -373,11 +467,30 @@ impl AgentCatalogs {
|
||||
entry.catalog = Some(catalog);
|
||||
shared.persist_known(&cache);
|
||||
entry.successful = Some(now);
|
||||
entry.completed = Some(now);
|
||||
entry.retry_at_ms = Some(self.epoch_ms() + COOLDOWN.as_millis() as f64);
|
||||
entry.model_failures.retain(|model, _| {
|
||||
entry
|
||||
.catalog
|
||||
.as_ref()
|
||||
.is_some_and(|catalog| catalog.lists(model) && !catalog.thought_levels.contains_key(model))
|
||||
});
|
||||
entry.error = None;
|
||||
true
|
||||
}
|
||||
Err(error) => {
|
||||
entry.error = Some(error);
|
||||
if let Some(model) = model {
|
||||
entry.model_failures.insert(
|
||||
model,
|
||||
ModelFailure {
|
||||
completed: now,
|
||||
retry_at_ms: self.epoch_ms() + COOLDOWN.as_millis() as f64,
|
||||
error,
|
||||
},
|
||||
);
|
||||
} else {
|
||||
entry.error = Some(error);
|
||||
}
|
||||
false
|
||||
}
|
||||
};
|
||||
@@ -448,18 +561,22 @@ impl AgentCatalogs {
|
||||
|
||||
impl crate::AgentManager {
|
||||
/// Return cached choices immediately and schedule discovery when eligible.
|
||||
pub fn refresh_models(&self, provider: &str, force: bool) -> IdeResult<AgentModelCatalog> {
|
||||
pub fn refresh_models(&self, provider: &str, force: bool, model: Option<&str>) -> IdeResult<AgentModelCatalog> {
|
||||
// Settings and environment secrets can change while this window is open.
|
||||
*self.shared.providers.write() =
|
||||
provider::load(self.shared.paths.custom_agents_dir.as_deref(), self.shared.env_secrets());
|
||||
let spec = self.shared.spec(provider).ok_or_else(|| IdeError::invalid(format!("unknown agent {provider}")))?;
|
||||
Ok(self.shared.paths.catalogs.request(&self.shared, spec, force).0)
|
||||
Ok(self.shared.paths.catalogs.request(&self.shared, spec, force, model).0)
|
||||
}
|
||||
}
|
||||
|
||||
async fn discover(shared: &Arc<Shared>, spec: provider::ProviderSpec) -> Result<Discovered, String> {
|
||||
async fn discover(
|
||||
shared: &Arc<Shared>,
|
||||
spec: provider::ProviderSpec,
|
||||
model: Option<&str>,
|
||||
) -> Result<Discovered, String> {
|
||||
match spec.driver {
|
||||
provider::Driver::Acp => acp::discover::run(shared, &spec).await,
|
||||
provider::Driver::Acp => acp::discover::run(shared, &spec, model).await,
|
||||
provider::Driver::Codex => native::codex::discover(spec, shared.paths.project_root.clone()).await,
|
||||
provider::Driver::Claude => {
|
||||
let found = native::claude::discover(spec.clone(), shared.paths.project_root.clone()).await?;
|
||||
@@ -484,7 +601,7 @@ async fn discover(shared: &Arc<Shared>, spec: provider::ProviderSpec) -> Result<
|
||||
provider::Driver::Copilot => {
|
||||
if shared.uses_copilot_acp_fallback(&spec) {
|
||||
let acp_spec = native::copilot::acp_fallback_spec(&spec);
|
||||
return acp::discover::run(shared, &acp_spec).await;
|
||||
return acp::discover::run(shared, &acp_spec, model).await;
|
||||
}
|
||||
match native::copilot::discover(spec.clone(), shared.paths.project_root.clone()).await {
|
||||
Ok(found) => Ok(Discovered {
|
||||
@@ -513,7 +630,7 @@ async fn discover(shared: &Arc<Shared>, spec: provider::ProviderSpec) -> Result<
|
||||
);
|
||||
shared.mark_copilot_acp_fallback(&spec);
|
||||
let acp_spec = native::copilot::acp_fallback_spec(&spec);
|
||||
acp::discover::run(shared, &acp_spec).await
|
||||
acp::discover::run(shared, &acp_spec, model).await
|
||||
}
|
||||
Err(err) => Err(err.message),
|
||||
}
|
||||
|
||||
@@ -11,8 +11,10 @@ const PROVIDER: &str = "catalog-test";
|
||||
|
||||
#[derive(Debug)]
|
||||
struct Pending {
|
||||
method: String,
|
||||
params: Value,
|
||||
reply: oneshot::Sender<Result<Value, String>>,
|
||||
notifications: mpsc::UnboundedSender<Value>,
|
||||
}
|
||||
|
||||
struct Harness {
|
||||
@@ -31,6 +33,10 @@ impl Drop for Live {
|
||||
|
||||
impl Harness {
|
||||
fn new() -> Self {
|
||||
Self::with_initialize(json!({ "protocolVersion": 1, "agentCapabilities": {}, "authMethods": [] }))
|
||||
}
|
||||
|
||||
fn with_initialize(initialize: Value) -> Self {
|
||||
let (pending_tx, pending) = mpsc::unbounded_channel();
|
||||
let launches = Arc::new(AtomicUsize::new(0));
|
||||
let live = Arc::new(AtomicUsize::new(0));
|
||||
@@ -42,26 +48,53 @@ impl Harness {
|
||||
live.fetch_add(1, Ordering::SeqCst);
|
||||
let guard = Live(live.clone());
|
||||
let pending = pending_tx.clone();
|
||||
let initialize = initialize.clone();
|
||||
let (notifications_tx, mut notifications) = mpsc::unbounded_channel::<Value>();
|
||||
let (client_io, server_io) = tokio::io::duplex(1 << 16);
|
||||
let (read, mut write) = tokio::io::split(server_io);
|
||||
tokio::spawn(async move {
|
||||
let _guard = guard;
|
||||
let mut lines = BufReader::new(read).lines();
|
||||
while let Some(line) = lines.next_line().await.unwrap() {
|
||||
loop {
|
||||
let line = tokio::select! {
|
||||
line = lines.next_line() => match line.unwrap() {
|
||||
Some(line) => line,
|
||||
None => break,
|
||||
},
|
||||
Some(notification) = notifications.recv() => {
|
||||
if write.write_all(format!("{notification}\n").as_bytes()).await.is_err() {
|
||||
break;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
};
|
||||
let request: Value = serde_json::from_str(&line).unwrap();
|
||||
let id = &request["id"];
|
||||
if id.is_null() {
|
||||
continue;
|
||||
}
|
||||
let response = match request["method"].as_str().unwrap() {
|
||||
"initialize" => json!({ "id": id, "jsonrpc": "2.0", "result": {
|
||||
"protocolVersion": 1, "agentCapabilities": {}, "authMethods": [] } }),
|
||||
"session/new" => {
|
||||
let (reply, result) = oneshot::channel();
|
||||
pending.send(Pending { params: request["params"].clone(), reply }).unwrap();
|
||||
let result = tokio::select! {
|
||||
result = result => result.unwrap(),
|
||||
_ = lines.next_line() => break,
|
||||
"initialize" => json!({ "id": id, "jsonrpc": "2.0", "result": initialize }),
|
||||
"session/new" | "session/set_config_option" | "session/set_model" => {
|
||||
let (reply, mut result) = oneshot::channel();
|
||||
pending
|
||||
.send(Pending {
|
||||
method: request["method"].as_str().unwrap().to_owned(),
|
||||
params: request["params"].clone(),
|
||||
reply,
|
||||
notifications: notifications_tx.clone(),
|
||||
})
|
||||
.unwrap();
|
||||
let result = loop {
|
||||
tokio::select! {
|
||||
result = &mut result => break result.unwrap(),
|
||||
_ = lines.next_line() => return,
|
||||
Some(notification) = notifications.recv() => {
|
||||
if write.write_all(format!("{notification}\n").as_bytes()).await.is_err() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
match result {
|
||||
Ok(result) => json!({ "id": id, "jsonrpc": "2.0", "result": result }),
|
||||
@@ -190,7 +223,7 @@ async fn successful_refresh_replaces_models_and_efforts_and_old_sessions_cannot_
|
||||
let mut events = events(&manager);
|
||||
let old = config::options_of(&response(&["old", "retained"], &["low", "high"]));
|
||||
manager.shared.remember(PROVIDER, Some(&old), None, Some("old"));
|
||||
let cached = manager.refresh_models(PROVIDER, false).unwrap();
|
||||
let cached = manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert!(cached.refreshing);
|
||||
assert_eq!(model_values(&cached), ["old", "retained"]);
|
||||
assert!(cached.refreshed_at_ms.is_none(), "session reports are not fresh discovery");
|
||||
@@ -204,13 +237,13 @@ async fn successful_refresh_replaces_models_and_efforts_and_old_sessions_cannot_
|
||||
assert_eq!(fresh.thought_levels["retained"][0].values[0].value, "medium");
|
||||
assert!(fresh.refreshed_at_ms.is_some() && fresh.retry_at_ms.is_some());
|
||||
manager.shared.remember(PROVIDER, Some(&old), None, Some("old"));
|
||||
assert_eq!(manager.refresh_models(PROVIDER, false).unwrap().config, fresh.config);
|
||||
assert_eq!(manager.refresh_models(PROVIDER, false, None).unwrap().config, fresh.config);
|
||||
let provider = manager.providers().into_iter().find(|p| p.id == PROVIDER).unwrap();
|
||||
assert_eq!(provider.config, fresh.config);
|
||||
let persisted = std::fs::read_to_string(tmp.path().join("models.json")).unwrap();
|
||||
assert!(!persisted.contains("secret-one") && !persisted.contains("TOKEN"));
|
||||
let restored = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let restored_snapshot = restored.refresh_models(PROVIDER, false).unwrap();
|
||||
let restored_snapshot = restored.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert!(!restored_snapshot.refreshing, "matching persisted launch context remains fresh");
|
||||
assert_eq!(restored_snapshot.refreshed_at_ms, fresh.refreshed_at_ms);
|
||||
let provider = restored.providers().into_iter().find(|p| p.id == PROVIDER).unwrap();
|
||||
@@ -229,7 +262,7 @@ async fn a_session_adds_the_efforts_of_a_model_discovery_did_not_read() {
|
||||
let catalogs = Arc::new(AgentCatalogs::default());
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["first", "second"], &["low", "high"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
// A session on "second" reports its own efforts; one on a model the catalog lacks, or on
|
||||
@@ -241,16 +274,16 @@ async fn a_session_adds_the_efforts_of_a_model_discovery_did_not_read() {
|
||||
let efforts = |catalog: &AgentModelCatalog, model: &str| -> Vec<String> {
|
||||
catalog.thought_levels[model][0].values.iter().map(|v| v.value.clone()).collect()
|
||||
};
|
||||
let catalog = manager.refresh_models(PROVIDER, false).unwrap();
|
||||
let catalog = manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert_eq!(catalog.thought_levels.keys().map(String::as_str).collect::<Vec<_>>(), ["first", "second"]);
|
||||
assert_eq!(efforts(&catalog, "first"), ["low", "high"]);
|
||||
assert_eq!(efforts(&catalog, "second"), ["off", "auto"]);
|
||||
let restored = make_manager(tmp.path(), Arc::default(), &harness).refresh_models(PROVIDER, false).unwrap();
|
||||
let restored = make_manager(tmp.path(), Arc::default(), &harness).refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert_eq!(efforts(&restored, "second"), ["off", "auto"], "persisted with the project's catalog");
|
||||
// Discovery again reads "first" only; "second" keeps what its session reported.
|
||||
advance(&catalogs, 60);
|
||||
while events.try_recv().is_ok() {}
|
||||
manager.refresh_models(PROVIDER, true).unwrap();
|
||||
manager.refresh_models(PROVIDER, true, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["first", "second"], &["medium"]))).unwrap();
|
||||
let fresh = completed(&mut events).await;
|
||||
assert_eq!(efforts(&fresh, "first"), ["medium"]);
|
||||
@@ -273,7 +306,7 @@ async fn legacy_cache_loads_without_claiming_authoritative_freshness() {
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let mut events = events(&manager);
|
||||
let cached = manager.refresh_models(PROVIDER, false).unwrap();
|
||||
let cached = manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert_eq!(model_values(&cached), ["legacy"]);
|
||||
assert!(cached.refreshing && cached.refreshed_at_ms.is_none());
|
||||
harness.next().await.reply.send(Err("Sign in required".into())).unwrap();
|
||||
@@ -292,11 +325,11 @@ async fn concurrent_windows_commands_and_manual_requests_share_one_flight_and_co
|
||||
let second = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut first_events = events(&first);
|
||||
let mut second_events = events(&second);
|
||||
assert!(first.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(first.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
let pending = harness.next().await;
|
||||
for _ in 0..10 {
|
||||
assert!(second.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(first.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(second.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
assert!(first.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
}
|
||||
let commands = tokio::spawn({
|
||||
let first = first.clone();
|
||||
@@ -309,21 +342,21 @@ async fn concurrent_windows_commands_and_manual_requests_share_one_flight_and_co
|
||||
assert_eq!(completed(&mut second_events).await, done);
|
||||
commands.await.unwrap().unwrap();
|
||||
for force in [false, true, false, true] {
|
||||
assert!(!second.refresh_models(PROVIDER, force).unwrap().refreshing);
|
||||
assert!(!second.refresh_models(PROVIDER, force, None).unwrap().refreshing);
|
||||
}
|
||||
advance(&catalogs, 29);
|
||||
assert!(!first.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(!first.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
advance(&catalogs, 1);
|
||||
assert!(!first.refresh_models(PROVIDER, false).unwrap().refreshing, "automatic refresh remains fresh");
|
||||
assert!(first.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(!first.refresh_models(PROVIDER, false, None).unwrap().refreshing, "automatic refresh remains fresh");
|
||||
assert!(first.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["two"], &["high"]))).unwrap();
|
||||
let newer = completed(&mut first_events).await;
|
||||
assert_eq!(model_values(&newer), ["two"]);
|
||||
assert_eq!(completed(&mut second_events).await, newer);
|
||||
advance(&catalogs, 15 * 60 - 1);
|
||||
assert!(!second.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(!second.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
advance(&catalogs, 1);
|
||||
assert!(second.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(second.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["three"], &["low"]))).unwrap();
|
||||
completed(&mut first_events).await;
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 3);
|
||||
@@ -337,25 +370,25 @@ async fn failure_keeps_successful_choices_and_throttles_manual_and_auto_retries(
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, true).unwrap();
|
||||
manager.refresh_models(PROVIDER, true, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["cached"], &["low"]))).unwrap();
|
||||
let success = completed(&mut events).await;
|
||||
let disk = std::fs::read(tmp.path().join("models.json")).unwrap();
|
||||
advance(&catalogs, 15 * 60);
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Err("Authentication expired".into())).unwrap();
|
||||
let failed = completed(&mut events).await;
|
||||
assert_eq!(failed.config, success.config);
|
||||
assert_eq!(failed.thought_levels, success.thought_levels);
|
||||
assert_eq!(failed.refreshed_at_ms, success.refreshed_at_ms);
|
||||
assert!(failed.error.as_deref().unwrap().contains("Authentication expired"));
|
||||
assert!(failed.error.as_deref().unwrap().contains("Sign in required"));
|
||||
assert_eq!(std::fs::read(tmp.path().join("models.json")).unwrap(), disk);
|
||||
assert!(!manager.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
advance(&catalogs, 29);
|
||||
assert!(!manager.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
advance(&catalogs, 1);
|
||||
assert!(manager.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(manager.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["recovered"], &["high"]))).unwrap();
|
||||
let recovered = completed(&mut events).await;
|
||||
assert_eq!(model_values(&recovered), ["recovered"]);
|
||||
@@ -370,21 +403,21 @@ async fn timeout_cleans_up_and_enters_the_same_failure_cooldown() {
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let pending = harness.next().await;
|
||||
tokio::time::pause();
|
||||
tokio::time::advance(Duration::from_secs(4)).await;
|
||||
let failed = completed(&mut events).await;
|
||||
assert!(failed.error.as_deref().unwrap().contains("time"));
|
||||
assert!(failed.retry_at_ms.is_some());
|
||||
assert!(!manager.refresh_models(PROVIDER, true).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, true, None).unwrap().refreshing);
|
||||
assert!(!manager.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
tokio::time::resume();
|
||||
stopped(&harness).await;
|
||||
assert_eq!(harness.live.load(Ordering::SeqCst), 0, "timed-out connection must close");
|
||||
assert!(pending.reply.is_closed());
|
||||
advance(&catalogs, 30);
|
||||
assert!(manager.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(manager.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["retry"], &["low"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
}
|
||||
@@ -398,16 +431,16 @@ async fn changed_effective_config_supersedes_old_completion_without_queueing() {
|
||||
let first = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let second = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&second);
|
||||
first.refresh_models(PROVIDER, false).unwrap();
|
||||
first.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let obsolete = harness.next().await;
|
||||
configure(tmp.path(), "two");
|
||||
assert!(second.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(second.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
let latest = harness.next().await;
|
||||
latest.reply.send(Ok(response(&["latest"], &["high"]))).unwrap();
|
||||
let fresh = completed(&mut events).await;
|
||||
let _ = obsolete.reply.send(Ok(response(&["obsolete"], &["low"])));
|
||||
stopped(&harness).await;
|
||||
let shown = first.refresh_models(PROVIDER, false).unwrap();
|
||||
let shown = first.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert_eq!(shown.config, fresh.config);
|
||||
assert_eq!(shown.refreshed_at_ms, fresh.refreshed_at_ms);
|
||||
assert!(!shown.refreshing);
|
||||
@@ -415,7 +448,7 @@ async fn changed_effective_config_supersedes_old_completion_without_queueing() {
|
||||
assert!(!std::fs::read_to_string(tmp.path().join("models.json")).unwrap().contains("obsolete"));
|
||||
// A changed configuration also invalidates successful freshness/cooldown.
|
||||
configure(tmp.path(), "three");
|
||||
assert!(first.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(first.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["new-config"], &["medium"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
}
|
||||
@@ -425,7 +458,7 @@ async fn invalid_provider_is_a_request_error_and_does_not_launch() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
assert!(manager.refresh_models("missing-provider", true).is_err());
|
||||
assert!(manager.refresh_models("missing-provider", true, None).is_err());
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
|
||||
@@ -437,18 +470,18 @@ async fn replacing_the_executable_at_the_same_path_invalidates_freshness_and_obs
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs, &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let obsolete = harness.next().await;
|
||||
std::fs::write(tmp.path().join("catalog-test-bin"), "replacement executable with different size").unwrap();
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let latest = harness.next().await;
|
||||
latest.reply.send(Ok(response(&["updated"], &["high"]))).unwrap();
|
||||
let fresh = completed(&mut events).await;
|
||||
let _ = obsolete.reply.send(Ok(response(&["obsolete"], &["low"])));
|
||||
stopped(&harness).await;
|
||||
assert_eq!(manager.refresh_models(PROVIDER, false).unwrap().config, fresh.config);
|
||||
assert_eq!(manager.refresh_models(PROVIDER, false, None).unwrap().config, fresh.config);
|
||||
std::fs::write(tmp.path().join("catalog-test-bin"), "another executable").unwrap();
|
||||
assert!(manager.refresh_models(PROVIDER, false).unwrap().refreshing);
|
||||
assert!(manager.refresh_models(PROVIDER, false, None).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&["new-install"], &["medium"]))).unwrap();
|
||||
assert_eq!(model_values(&completed(&mut events).await), ["new-install"]);
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 3);
|
||||
@@ -468,18 +501,18 @@ async fn project_catalogs_and_persisted_freshness_do_not_leak_between_contexts()
|
||||
let second = make_manager_at(&b, &models_file, catalogs, &harness);
|
||||
let mut first_events = events(&first);
|
||||
let mut second_events = events(&second);
|
||||
first.refresh_models(PROVIDER, false).unwrap();
|
||||
first.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["account-a-model"], &["low"]))).unwrap();
|
||||
let a_catalog = completed(&mut first_events).await;
|
||||
second.refresh_models(PROVIDER, false).unwrap();
|
||||
second.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["account-b-model"], &["high"]))).unwrap();
|
||||
let b_catalog = completed(&mut second_events).await;
|
||||
assert_eq!(first.refresh_models(PROVIDER, false).unwrap().config, a_catalog.config);
|
||||
assert_eq!(second.refresh_models(PROVIDER, false).unwrap().config, b_catalog.config);
|
||||
assert_eq!(first.refresh_models(PROVIDER, false, None).unwrap().config, a_catalog.config);
|
||||
assert_eq!(second.refresh_models(PROVIDER, false, None).unwrap().config, b_catalog.config);
|
||||
assert_eq!(first.providers().into_iter().find(|p| p.id == PROVIDER).unwrap().config, a_catalog.config);
|
||||
for (root, expected) in [(&a, &a_catalog), (&b, &b_catalog)] {
|
||||
let restored = make_manager_at(root, &models_file, Arc::default(), &harness);
|
||||
let cached = restored.refresh_models(PROVIDER, false).unwrap();
|
||||
let cached = restored.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert!(!cached.refreshing, "matching persisted context should retain freshness");
|
||||
assert_eq!(cached.config, expected.config);
|
||||
assert_eq!(cached.refreshed_at_ms, expected.refreshed_at_ms);
|
||||
@@ -488,7 +521,7 @@ async fn project_catalogs_and_persisted_freshness_do_not_leak_between_contexts()
|
||||
configure(&a, "new-account");
|
||||
let changed = make_manager_at(&a, &models_file, Arc::default(), &harness);
|
||||
let mut events = events(&changed);
|
||||
let stale = changed.refresh_models(PROVIDER, false).unwrap();
|
||||
let stale = changed.refresh_models(PROVIDER, false, None).unwrap();
|
||||
assert!(stale.refreshing, "a different launch environment cannot reuse persisted freshness");
|
||||
assert!(stale.refreshed_at_ms.is_none());
|
||||
assert_eq!(stale.config, a_catalog.config, "stale cached choices remain selectable");
|
||||
@@ -505,7 +538,7 @@ async fn configuration_changed_without_another_request_also_discards_old_discove
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let obsolete = harness.next().await;
|
||||
configure(tmp.path(), "after");
|
||||
obsolete.reply.send(Ok(response(&["obsolete"], &["low"]))).unwrap();
|
||||
@@ -513,7 +546,7 @@ async fn configuration_changed_without_another_request_also_discards_old_discove
|
||||
assert!(model_values(&discarded).is_empty());
|
||||
assert!(discarded.refreshed_at_ms.is_none());
|
||||
assert!(!tmp.path().join("models.json").exists());
|
||||
manager.refresh_models(PROVIDER, false).unwrap();
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["current"], &["high"]))).unwrap();
|
||||
assert_eq!(model_values(&completed(&mut events).await), ["current"]);
|
||||
}
|
||||
@@ -526,13 +559,269 @@ async fn successful_empty_catalog_removes_all_previous_models_and_efforts() {
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, true).unwrap();
|
||||
manager.refresh_models(PROVIDER, true, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["removed"], &["low"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
advance(&catalogs, 30);
|
||||
manager.refresh_models(PROVIDER, true).unwrap();
|
||||
manager.refresh_models(PROVIDER, true, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&[], &[]))).unwrap();
|
||||
let empty = completed(&mut events).await;
|
||||
assert!(model_values(&empty).is_empty() && empty.thought_levels.is_empty());
|
||||
assert!(empty.refreshed_at_ms.is_some() && empty.error.is_none());
|
||||
}
|
||||
|
||||
fn selected_response(model: &str, effort: &[&str]) -> Value {
|
||||
let mut result = response(&[model], effort);
|
||||
if effort.is_empty() {
|
||||
result["configOptions"].as_array_mut().unwrap().retain(|option| option["id"] != "effort");
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
fn config_notification(session: &str, result: &Value) -> Value {
|
||||
json!({ "jsonrpc": "2.0", "method": "session/update", "params": {
|
||||
"sessionId": session,
|
||||
"update": { "sessionUpdate": "config_option_update", "configOptions": result["configOptions"] }
|
||||
} })
|
||||
}
|
||||
|
||||
fn efforts<'a>(catalog: &'a AgentModelCatalog, model: &str) -> Vec<&'a str> {
|
||||
catalog.thought_levels[model]
|
||||
.iter()
|
||||
.filter(|option| option.category.as_deref() == Some("thought_level"))
|
||||
.flat_map(|option| option.values.iter().map(|value| value.value.as_str()))
|
||||
.collect()
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn selected_models_report_their_own_controls_before_any_task_or_prompt() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let catalogs = Arc::new(AgentCatalogs::default());
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
let models = ["default", "second", "plain", "unknown"];
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low", "high"]))).unwrap();
|
||||
let original = completed(&mut events).await;
|
||||
assert!(!original.thought_levels.contains_key("second"));
|
||||
|
||||
// A fresh catalog and its global cooldown must not delay an unknown selection.
|
||||
assert!(manager.refresh_models(PROVIDER, false, Some("second")).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low", "high"]))).unwrap();
|
||||
let pending = harness.next().await;
|
||||
assert_eq!(pending.method, "session/set_config_option");
|
||||
assert_eq!(pending.params, json!({ "sessionId": "discovery-only", "configId": "model", "value": "second" }));
|
||||
let mut second = selected_response("second", &["off", "auto", "max"]);
|
||||
second["configOptions"].as_array_mut().unwrap().push(json!({
|
||||
"id": "context_tier", "type": "select", "currentValue": "large",
|
||||
"options": [{ "value": "normal" }, { "value": "large" }]
|
||||
}));
|
||||
pending.reply.send(Ok(second)).unwrap();
|
||||
let learned = completed(&mut events).await;
|
||||
assert_eq!(learned.config, original.config, "selection discovery never changes the default model");
|
||||
assert_eq!(efforts(&learned, "default"), ["low", "high"]);
|
||||
assert_eq!(efforts(&learned, "second"), ["off", "auto", "max"]);
|
||||
assert!(learned.thought_levels["second"].iter().any(|option| option.id == "context_tier"));
|
||||
assert!(!learned.thought_levels.contains_key("unknown"));
|
||||
|
||||
manager.refresh_models(PROVIDER, false, Some("plain")).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low", "high"]))).unwrap();
|
||||
harness.next().await.reply.send(Ok(selected_response("plain", &[]))).unwrap();
|
||||
let plain = completed(&mut events).await;
|
||||
assert!(plain.thought_levels["plain"].is_empty(), "an authoritative no-control result is cached");
|
||||
for model in ["default", "second", "plain"] {
|
||||
assert!(!manager.refresh_models(PROVIDER, false, Some(model)).unwrap().refreshing);
|
||||
}
|
||||
let restored = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let cached = restored.refresh_models(PROVIDER, false, Some("plain")).unwrap();
|
||||
assert!(!cached.refreshing);
|
||||
assert!(cached.thought_levels["plain"].is_empty());
|
||||
assert_eq!(efforts(&cached, "second"), ["off", "auto", "max"]);
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 3, "never iterate unselected models");
|
||||
assert!(!tmp.path().join("store").exists(), "no task or prompt is needed");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn missing_or_failed_selected_settings_remain_unknown_and_have_model_scoped_retry_cooldowns() {
|
||||
for reply in [Ok(json!({})), Ok(selected_response("default", &["wrong"])), Err("token=secret-one".into())] {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let catalogs = Arc::new(AgentCatalogs::default());
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
let models = ["default", "unsupported", "other"];
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
let original = completed(&mut events).await;
|
||||
manager.refresh_models(PROVIDER, false, Some("unsupported")).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
harness.next().await.reply.send(reply).unwrap();
|
||||
let failed = completed(&mut events).await;
|
||||
assert_eq!(failed.config, original.config);
|
||||
assert!(!failed.thought_levels.contains_key("unsupported"));
|
||||
assert!(failed.error.is_some() && failed.retry_at_ms.is_some());
|
||||
assert!(!failed.error.as_deref().unwrap().contains("secret-one"));
|
||||
assert!(!manager.refresh_models(PROVIDER, true, Some("unsupported")).unwrap().refreshing);
|
||||
// The failed model cannot block another model, and its cooldown survives that success.
|
||||
assert!(manager.refresh_models(PROVIDER, false, Some("other")).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
harness.next().await.reply.send(Ok(selected_response("other", &[]))).unwrap();
|
||||
assert!(completed(&mut events).await.error.is_none());
|
||||
assert!(!manager.refresh_models(PROVIDER, false, Some("unsupported")).unwrap().refreshing);
|
||||
advance(&catalogs, 30);
|
||||
assert!(manager.refresh_models(PROVIDER, true, Some("unsupported")).unwrap().refreshing);
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
harness.next().await.reply.send(Ok(selected_response("unsupported", &["high"]))).unwrap();
|
||||
let retried = completed(&mut events).await;
|
||||
assert_eq!(efforts(&retried, "unsupported"), ["high"]);
|
||||
assert!(retried.error.is_none());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn rapid_model_selections_share_the_current_flight_and_discard_superseded_results() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let catalogs = Arc::new(AgentCatalogs::default());
|
||||
let mut harness = Harness::new();
|
||||
let first = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let second = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&first);
|
||||
let models = ["default", "second", "third"];
|
||||
first.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
first.refresh_models(PROVIDER, false, Some("second")).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
let obsolete = harness.next().await;
|
||||
for _ in 0..5 {
|
||||
assert!(second.refresh_models(PROVIDER, false, Some("second")).unwrap().refreshing);
|
||||
}
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 2);
|
||||
second.refresh_models(PROVIDER, false, Some("third")).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&models, &["low"]))).unwrap();
|
||||
let current = harness.next().await;
|
||||
assert_eq!(current.params["value"], "third");
|
||||
current.reply.send(Ok(selected_response("third", &["max"]))).unwrap();
|
||||
let fresh = completed(&mut events).await;
|
||||
let _ = obsolete.reply.send(Ok(selected_response("second", &["obsolete"])));
|
||||
stopped(&harness).await;
|
||||
let cached = first.refresh_models(PROVIDER, false, Some("third")).unwrap();
|
||||
assert_eq!(cached, fresh);
|
||||
assert_eq!(efforts(&cached, "third"), ["max"]);
|
||||
assert!(!cached.thought_levels.contains_key("second"));
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 3, "no stale requests are queued");
|
||||
assert!(!std::fs::read_to_string(tmp.path().join("models.json")).unwrap().contains("obsolete"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn switching_back_to_a_known_model_cancels_the_unknown_model_flight() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["default", "second"], &["low"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
manager.refresh_models(PROVIDER, false, Some("second")).unwrap();
|
||||
let obsolete = harness.next().await;
|
||||
let known = manager.refresh_models(PROVIDER, false, Some("default")).unwrap();
|
||||
assert!(!known.refreshing);
|
||||
assert_eq!(completed(&mut events).await, known, "other subscribers also leave loading state");
|
||||
let _ = obsolete.reply.send(Err("late failure".into()));
|
||||
stopped(&harness).await;
|
||||
let cached = manager.refresh_models(PROVIDER, false, Some("default")).unwrap();
|
||||
assert!(cached.error.is_none() && !cached.thought_levels.contains_key("second"));
|
||||
assert_eq!(harness.launches.load(Ordering::SeqCst), 2);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn selected_model_uses_legacy_set_model_and_authoritative_notifications() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let mut events = events(&manager);
|
||||
// No cache is needed: the selected model is resolved in the same short-lived session.
|
||||
manager.refresh_models(PROVIDER, false, Some("second")).unwrap();
|
||||
harness
|
||||
.next()
|
||||
.await
|
||||
.reply
|
||||
.send(Ok(json!({
|
||||
"sessionId": "discovery-only",
|
||||
"models": { "currentModelId": "default", "availableModels": [
|
||||
{ "modelId": "default", "name": "Default" }, { "modelId": "second", "name": "Second" }
|
||||
] }
|
||||
})))
|
||||
.unwrap();
|
||||
let selected = harness.next().await;
|
||||
assert_eq!(selected.method, "session/set_model");
|
||||
assert_eq!(selected.params, json!({ "sessionId": "discovery-only", "modelId": "second" }));
|
||||
let notifications = selected.notifications;
|
||||
selected.reply.send(Ok(json!({}))).unwrap();
|
||||
notifications.send(config_notification("different-session", &selected_response("second", &["wrong"]))).unwrap();
|
||||
notifications
|
||||
.send(config_notification("discovery-only", &selected_response("second", &["medium", "high"])))
|
||||
.unwrap();
|
||||
let catalog = completed(&mut events).await;
|
||||
assert_eq!(efforts(&catalog, "second"), ["medium", "high"]);
|
||||
assert_eq!(catalog.config.iter().find(|option| option.id == "model").unwrap().current.as_deref(), Some("default"));
|
||||
assert!(!catalog.thought_levels.contains_key("default"), "legacy model lists alone do not assert no controls");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_replacement_removes_selected_metadata_for_models_no_longer_listed() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let catalogs = Arc::new(AgentCatalogs::default());
|
||||
let mut harness = Harness::new();
|
||||
let manager = make_manager(tmp.path(), catalogs.clone(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false, Some("second")).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["default", "second"], &["low"]))).unwrap();
|
||||
harness.next().await.reply.send(Ok(selected_response("second", &["max"]))).unwrap();
|
||||
completed(&mut events).await;
|
||||
advance(&catalogs, 30);
|
||||
manager.refresh_models(PROVIDER, true, None).unwrap();
|
||||
harness.next().await.reply.send(Ok(response(&["default", "new"], &["medium"]))).unwrap();
|
||||
let replaced = completed(&mut events).await;
|
||||
assert_eq!(model_values(&replaced), ["default", "new"]);
|
||||
assert_eq!(efforts(&replaced, "default"), ["medium"]);
|
||||
assert!(!replaced.thought_levels.contains_key("second") && !replaced.thought_levels.contains_key("new"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn selected_model_discovery_uses_the_negotiated_v2_wire_format_and_config_updates() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
configure(tmp.path(), "one");
|
||||
let mut harness = Harness::with_initialize(json!({
|
||||
"protocolVersion": 2, "info": { "name": "V2 Catalog Test" }, "capabilities": { "session": {} }
|
||||
}));
|
||||
let manager = make_manager(tmp.path(), Arc::default(), &harness);
|
||||
let mut events = events(&manager);
|
||||
manager.refresh_models(PROVIDER, false, Some("second")).unwrap();
|
||||
let mut initial = response(&["default", "second"], &["low"]);
|
||||
for option in initial["configOptions"].as_array_mut().unwrap() {
|
||||
option["configId"] = option.as_object_mut().unwrap().remove("id").unwrap();
|
||||
}
|
||||
harness.next().await.reply.send(Ok(initial)).unwrap();
|
||||
let selected = harness.next().await;
|
||||
assert_eq!(selected.method, "session/set_config_option");
|
||||
assert_eq!(
|
||||
selected.params,
|
||||
json!({
|
||||
"sessionId": "discovery-only", "configId": "model", "value": "second", "type": "id"
|
||||
})
|
||||
);
|
||||
// Notifications may arrive before the request response as well as after it.
|
||||
selected.notifications.send(config_notification("discovery-only", &selected_response("second", &[]))).unwrap();
|
||||
selected.reply.send(Ok(json!({}))).unwrap();
|
||||
let catalog = completed(&mut events).await;
|
||||
assert!(catalog.thought_levels["second"].is_empty());
|
||||
assert_eq!(efforts(&catalog, "default"), ["low"]);
|
||||
}
|
||||
+214
-292
@@ -70,6 +70,8 @@ pub(crate) const LIMITS_UPDATE: &str = "openidea_limits";
|
||||
/// A native agent's own update: the background tasks its session runs
|
||||
/// (see [`TaskState::background_tasks`]).
|
||||
pub(crate) const BACKGROUND_TASKS_UPDATE: &str = "openidea_background_tasks";
|
||||
/// A native agent's diagnostic, including warnings emitted before a session exists.
|
||||
pub(crate) const WARNING_NOTIFICATION: &str = "_openidea/warning";
|
||||
/// Referenced files up to this size are embedded in the prompt (when the agent takes it).
|
||||
const MAX_EMBED: u64 = 256 * 1024;
|
||||
/// How long a probe waits for the agent to answer `initialize`.
|
||||
@@ -208,20 +210,23 @@ impl Shared {
|
||||
}
|
||||
}
|
||||
|
||||
/// The MCP servers passed to a session, and the names of the ones off for it.
|
||||
fn mcp_servers_for_session(
|
||||
&self,
|
||||
provider: &str,
|
||||
init: &acp::Negotiated,
|
||||
overrides: &BTreeMap<String, bool>,
|
||||
) -> Vec<Value> {
|
||||
let mut servers = if overrides.get(mcp::BUILTIN_MCP_NAME) == Some(&false) {
|
||||
Vec::new()
|
||||
} else {
|
||||
mcp_servers_for(init.mcp_stdio(), &self.paths.project_root)
|
||||
};
|
||||
) -> McpForSession {
|
||||
let builtin_off = overrides.get(mcp::BUILTIN_MCP_NAME) == Some(&false);
|
||||
let mut servers =
|
||||
if builtin_off { Vec::new() } else { mcp_servers_for(init.mcp_stdio(), &self.paths.project_root) };
|
||||
let configured = self.mcp_servers_hook.read().as_ref().map(|hook| hook()).unwrap_or_default();
|
||||
servers.extend(mcp::acp_mcp_servers(&configured, provider, init, overrides));
|
||||
servers
|
||||
let mut off = mcp::servers_off(&configured, overrides);
|
||||
if builtin_off {
|
||||
off.push(BUILTIN_SERVER.to_owned());
|
||||
}
|
||||
McpForSession { servers, off }
|
||||
}
|
||||
|
||||
fn known_config(&self, provider: &str) -> Vec<AgentConfigOption> {
|
||||
@@ -358,6 +363,7 @@ struct TaskState {
|
||||
session_id: Option<String>,
|
||||
conversation: Conversation,
|
||||
wanted: Vec<AgentConfigChoice>,
|
||||
model_choice: u64,
|
||||
before: Arc<BTreeMap<String, worktree::Stamp>>,
|
||||
saved: Option<String>,
|
||||
/// See `TaskFile::touched`.
|
||||
@@ -367,11 +373,6 @@ struct TaskState {
|
||||
title_renamed: bool,
|
||||
/// A turn is running or about to (prompts arriving now are queued).
|
||||
busy: bool,
|
||||
/// A temporary side conversation: lives in memory only, never persisted.
|
||||
ephemeral: bool,
|
||||
/// The conversation a temporary side conversation starts with, sent to the agent with
|
||||
/// its first real message; the task's own entries hold only the questions.
|
||||
ephemeral_context: Option<String>,
|
||||
/// Background tasks the agent reported as running (`run_in_background` commands and
|
||||
/// the like), as it sent them: unlike a turn they outlive it, so an idle release
|
||||
/// waits for the last one. A (re)started process runs nothing yet.
|
||||
@@ -498,14 +499,8 @@ impl AgentManager {
|
||||
}
|
||||
|
||||
/// Routes events to `sink` (replacing the previous subscriber); returns every task.
|
||||
/// Ephemeral tasks belonged to the previous page session: a fresh one starts without them.
|
||||
pub fn subscribe(&self, sink: AgentSink) -> Vec<AgentTask> {
|
||||
*self.shared.sink.write() = Some(sink);
|
||||
let stale: Vec<Arc<Task>> = self.tasks.read().values().filter(|t| t.state.lock().ephemeral).cloned().collect();
|
||||
for task in &stale {
|
||||
self.drop_in_memory(task);
|
||||
self.shared.emit(AgentEvent::Removed { id: task.id.clone() });
|
||||
}
|
||||
let mut tasks: Vec<AgentTask> = self.tasks.read().values().map(|t| t.state.lock().task.clone()).collect();
|
||||
tasks.sort_by(|a, b| b.updated_ms.total_cmp(&a.updated_ms));
|
||||
tasks
|
||||
@@ -627,7 +622,7 @@ impl AgentManager {
|
||||
.into_iter()
|
||||
.find(|spec| spec.id == provider)
|
||||
{
|
||||
let (_, flight) = self.shared.paths.catalogs.request(&self.shared, spec, false);
|
||||
let (_, flight) = self.shared.paths.catalogs.request(&self.shared, spec, false, None);
|
||||
if let Some(mut ready) = flight {
|
||||
while !*ready.borrow_and_update() {
|
||||
if ready.changed().await.is_err() {
|
||||
@@ -637,14 +632,9 @@ impl AgentManager {
|
||||
}
|
||||
offered = self.shared.known_commands(&provider);
|
||||
}
|
||||
for &(name, description) in builtin_commands(&provider) {
|
||||
if !offered.iter().any(|c| c.name == name) {
|
||||
offered.push(AgentCommand {
|
||||
name: name.to_owned(),
|
||||
description: description.to_owned(),
|
||||
hint: None,
|
||||
source: AgentCommandSource::Command,
|
||||
});
|
||||
for command in builtin_commands(&provider) {
|
||||
if !offered.iter().any(|c| c.name == command.name) {
|
||||
offered.push(command);
|
||||
}
|
||||
}
|
||||
if provider != "claude" && provider != "claude-acp" {
|
||||
@@ -737,7 +727,7 @@ impl AgentManager {
|
||||
background: Box::default(),
|
||||
mcp_overrides: BTreeMap::new(),
|
||||
};
|
||||
let handle = self.register(TaskFile {
|
||||
let file = TaskFile {
|
||||
task: task.clone(),
|
||||
session_id: Some(session_id.to_owned()),
|
||||
entries: Vec::new(),
|
||||
@@ -748,7 +738,9 @@ impl AgentManager {
|
||||
subagents: Vec::new(),
|
||||
pending_rollback: 0,
|
||||
title_renamed: true,
|
||||
});
|
||||
};
|
||||
let handle = Task::restore(file, self.shared.clone());
|
||||
self.tasks.write().insert(task.id.clone(), handle.clone());
|
||||
handle.emit_task();
|
||||
handle.persist();
|
||||
Ok(task)
|
||||
@@ -786,8 +778,27 @@ impl AgentManager {
|
||||
(root, None, base, commit, before)
|
||||
}
|
||||
};
|
||||
// The session's settings: what the agent offered last time, with the choices applied.
|
||||
let config = self.merged_config(&spec.id, &req.config);
|
||||
// Until the session reports its own, show what the agent offered last time with the choices applied.
|
||||
let catalog = self.shared.paths.catalogs.cached(&self.shared, &spec.id);
|
||||
let mut levels = catalog.thought_levels;
|
||||
let mut config = self.shared.config_for_new_task(catalog.config, &spec.id);
|
||||
for choice in &req.config {
|
||||
if let Some(o) = config.iter_mut().find(|o| o.id == choice.id) {
|
||||
o.current = Some(choice.value.clone());
|
||||
}
|
||||
}
|
||||
if let Some(model) = model_of(&config)
|
||||
&& let Some(levels) = levels.remove(&model)
|
||||
{
|
||||
config.extend(levels.into_iter().map(|mut o| {
|
||||
if let Some(choice) =
|
||||
req.config.iter().find(|c| c.id == o.id && o.values.iter().any(|v| v.value == c.value))
|
||||
{
|
||||
o.current = Some(choice.value.clone());
|
||||
}
|
||||
o
|
||||
}));
|
||||
}
|
||||
let now = now_ms();
|
||||
let id = uuid::Uuid::new_v4().simple().to_string();
|
||||
// Copies of the files the user had changed already, for rolling back the task's changes to them.
|
||||
@@ -829,7 +840,7 @@ impl AgentManager {
|
||||
background: Box::default(),
|
||||
mcp_overrides: req.mcp_overrides,
|
||||
};
|
||||
let handle = self.register(TaskFile {
|
||||
let file = TaskFile {
|
||||
task: task.clone(),
|
||||
session_id: None,
|
||||
entries: Vec::new(),
|
||||
@@ -840,118 +851,16 @@ impl AgentManager {
|
||||
subagents: Vec::new(),
|
||||
pending_rollback: 0,
|
||||
title_renamed: false,
|
||||
});
|
||||
};
|
||||
let handle = Task::restore(file, self.shared.clone());
|
||||
handle.state.lock().busy = true;
|
||||
self.tasks.write().insert(task.id.clone(), handle.clone());
|
||||
handle.emit_task();
|
||||
handle.persist();
|
||||
self.shared.runtime.spawn(async move { handle.run(prompt).await });
|
||||
Ok(task)
|
||||
}
|
||||
|
||||
/// Builds the in-memory handle of a fresh task, registers it and announces it. The
|
||||
/// caller decides what else its life starts with (a persisted file, a session, a run).
|
||||
fn register(&self, file: TaskFile) -> Arc<Task> {
|
||||
let handle = Task::restore(file, self.shared.clone());
|
||||
self.tasks.write().insert(handle.id.clone(), handle.clone());
|
||||
handle.emit_task();
|
||||
handle
|
||||
}
|
||||
|
||||
/// The session's settings: what the agent offered last time, with the request's
|
||||
/// choices — and the chosen model's thought levels — applied.
|
||||
fn merged_config(&self, provider: &str, req: &[AgentConfigChoice]) -> Vec<AgentConfigOption> {
|
||||
let catalog = self.shared.paths.catalogs.cached(&self.shared, provider);
|
||||
let mut levels = catalog.thought_levels;
|
||||
let mut config = self.shared.config_for_new_task(catalog.config, provider);
|
||||
for choice in req {
|
||||
if let Some(o) = config.iter_mut().find(|o| o.id == choice.id) {
|
||||
o.current = Some(choice.value.clone());
|
||||
}
|
||||
}
|
||||
if let Some(model) = model_of(&config)
|
||||
&& let Some(levels) = levels.remove(&model)
|
||||
{
|
||||
config.extend(levels.into_iter().map(|mut o| {
|
||||
if let Some(choice) = req.iter().find(|c| c.id == o.id && o.values.iter().any(|v| v.value == c.value)) {
|
||||
o.current = Some(choice.value.clone());
|
||||
}
|
||||
o
|
||||
}));
|
||||
}
|
||||
config
|
||||
}
|
||||
|
||||
/// Creates a temporary side conversation of `source`: an in-memory task that is never
|
||||
/// persisted, whose session starts with its first real message (`prompt` only names
|
||||
/// the title). `source`'s conversation rides along as the context of that message.
|
||||
/// The task is read-only: its settings are pushed to a mode that asks before anything,
|
||||
/// and requests that would change the project are denied regardless. Fails for an
|
||||
/// agent that offers no way to ask.
|
||||
pub async fn create_ephemeral(&self, req: NewAgentTask, source: &str) -> IdeResult<AgentTask> {
|
||||
let spec = self
|
||||
.shared
|
||||
.spec(&req.provider)
|
||||
.ok_or_else(|| IdeError::invalid(format!("unknown agent {}", req.provider)))?;
|
||||
let prompt = clean(req.prompt).ok_or_else(|| IdeError::invalid("describe the topic first"))?;
|
||||
let title = title_of(&prompt);
|
||||
let mut config = self.merged_config(&spec.id, &req.config);
|
||||
config::ask_for_approvals(&mut config);
|
||||
if config::bypass_approvals(&config) {
|
||||
return Err(IdeError::invalid(
|
||||
"this agent has no mode that asks before changing things, so it can't run a side conversation",
|
||||
));
|
||||
}
|
||||
let read_only = !config::bypass_approvals(&config);
|
||||
let context = context_transcript(&self.task(source)?.state.lock().conversation.main.entries);
|
||||
let root = self.shared.paths.project_root.clone();
|
||||
let before = blocking(move || Ok(worktree::snapshot(&root).unwrap_or_default())).await?;
|
||||
let now = now_ms();
|
||||
let mut capabilities = self.shared.probes.lock().get(&spec.id).map(|p| p.capabilities).unwrap_or_default();
|
||||
capabilities.read_only = read_only;
|
||||
let task = AgentTask {
|
||||
project_root: Some(IpcPath(self.shared.paths.project_root.clone())),
|
||||
id: uuid::Uuid::new_v4().simple().to_string(),
|
||||
title,
|
||||
provider: spec.id.clone(),
|
||||
model: model_of(&config),
|
||||
status: AgentStatus::Ready,
|
||||
isolation: Isolation::Local,
|
||||
cwd: IpcPath(self.shared.paths.project_root.clone()),
|
||||
branch: None,
|
||||
base: None,
|
||||
base_commit: None,
|
||||
error: None,
|
||||
created_ms: now,
|
||||
updated_ms: now,
|
||||
commands: self.shared.known_commands(&spec.id),
|
||||
usage: None,
|
||||
queue: Vec::new(),
|
||||
capabilities,
|
||||
resets_ms: None,
|
||||
retry: None,
|
||||
background: Box::default(),
|
||||
mcp_overrides: req.mcp_overrides,
|
||||
config,
|
||||
};
|
||||
let handle = self.register(TaskFile {
|
||||
task: task.clone(),
|
||||
session_id: None,
|
||||
entries: Vec::new(),
|
||||
wanted: req.config,
|
||||
before,
|
||||
saved: None,
|
||||
touched: None,
|
||||
subagents: Vec::new(),
|
||||
pending_rollback: 0,
|
||||
title_renamed: false,
|
||||
});
|
||||
{
|
||||
let mut s = handle.state.lock();
|
||||
s.ephemeral = true;
|
||||
s.ephemeral_context = Some(context);
|
||||
}
|
||||
Ok(task)
|
||||
}
|
||||
|
||||
/// Sends a message. While the agent works it is queued, or with `now` the current turn
|
||||
/// is cancelled and the message goes next.
|
||||
pub async fn prompt(&self, id: &str, prompt: AgentPrompt, now: bool) -> IdeResult<()> {
|
||||
@@ -1046,19 +955,36 @@ impl AgentManager {
|
||||
/// Changes a session setting (model, mode…): right away when the agent runs, else when it next starts.
|
||||
pub async fn set_config(&self, id: &str, option: &str, value: String) -> IdeResult<()> {
|
||||
let task = self.task(id)?;
|
||||
let target = {
|
||||
let s = task.state.lock();
|
||||
let o =
|
||||
s.task.config.iter().find(|o| o.id == option).ok_or_else(|| IdeError::not_found("no such setting"))?;
|
||||
if !o.values.iter().any(|v| v.value == value) {
|
||||
return Err(IdeError::invalid(format!("{} has no value {value}", o.name)));
|
||||
let (target, model_choice, previous_levels) = {
|
||||
let mut s = task.state.lock();
|
||||
let target = s
|
||||
.task
|
||||
.config
|
||||
.iter()
|
||||
.find(|o| o.id == option)
|
||||
.ok_or_else(|| IdeError::not_found("no such setting"))?
|
||||
.clone();
|
||||
if !target.values.iter().any(|v| v.value == value) {
|
||||
return Err(IdeError::invalid(format!("{} has no value {value}", target.name)));
|
||||
}
|
||||
o.clone()
|
||||
if target.category.as_deref() == Some("model") {
|
||||
s.model_choice += 1;
|
||||
}
|
||||
let previous_levels =
|
||||
if target.category.as_deref() == Some("model") && target.current.as_deref() != Some(value.as_str()) {
|
||||
Some(s.task.config.extract_if(.., |o| config::is_per_model_option(o)).collect::<Vec<_>>())
|
||||
} else {
|
||||
None
|
||||
};
|
||||
s.wanted.retain(|c| c.id != option);
|
||||
s.wanted.push(AgentConfigChoice { id: option.to_owned(), value: value.clone() });
|
||||
s.task.config.iter_mut().find(|o| o.id == option).expect("selected setting").current = Some(value.clone());
|
||||
s.task.model = model_of(&s.task.config).or(s.task.model.take());
|
||||
(target, s.model_choice, previous_levels)
|
||||
};
|
||||
let previous = target.current.clone();
|
||||
// Cursor's `session/set_config_option` (Fast, effort) can take seconds. Show the
|
||||
// choice first so the switch and slider move immediately.
|
||||
apply_config_choice(&task, option, &value);
|
||||
task.persist();
|
||||
task.emit_task();
|
||||
|
||||
@@ -1068,36 +994,77 @@ impl AgentManager {
|
||||
let mut model_options = (target.category.as_deref() != Some("model")
|
||||
|| previous.as_deref() == Some(value.as_str()))
|
||||
&& task.state.lock().task.config.iter().any(config::is_per_model_option);
|
||||
if live.is_none()
|
||||
&& target.category.as_deref() == Some("model")
|
||||
&& (previous.as_deref() != Some(value.as_str()) || !model_options)
|
||||
{
|
||||
let provider = task.state.lock().task.provider.clone();
|
||||
let mut levels = self.shared.paths.catalogs.levels(&self.shared, &provider, &value);
|
||||
let mut error = None;
|
||||
if levels.is_none()
|
||||
&& let Some(spec) = self.shared.spec(&provider)
|
||||
{
|
||||
let (catalog, flight) = self.shared.paths.catalogs.request(&self.shared, spec, false, Some(&value));
|
||||
error = catalog.error;
|
||||
if let Some(mut ready) = flight {
|
||||
while !*ready.borrow_and_update() {
|
||||
if ready.changed().await.is_err() {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
levels = self.shared.paths.catalogs.levels(&self.shared, &provider, &value);
|
||||
}
|
||||
// Another selection may have superseded this discovery while it was waiting.
|
||||
if task.state.lock().model_choice != model_choice {
|
||||
return Ok(());
|
||||
}
|
||||
let Some(levels) = levels else {
|
||||
restore_config_choice(&task, &target, &value, previous.as_deref(), model_choice, previous_levels);
|
||||
task.persist();
|
||||
task.emit_task();
|
||||
return Err(IdeError::unavailable(
|
||||
error.unwrap_or_else(|| "The agent did not report settings for the selected model".into()),
|
||||
));
|
||||
};
|
||||
let mut s = task.state.lock();
|
||||
if s.model_choice != model_choice {
|
||||
return Ok(());
|
||||
}
|
||||
s.task.config.retain(|o| !config::is_per_model_option(o));
|
||||
s.task.config.extend(levels);
|
||||
model_options = true;
|
||||
}
|
||||
if let Some(live) = live.filter(|_| option != config::CURSOR_APPROVAL) {
|
||||
let (method, mut params) = config::set_request(&target, &value);
|
||||
params["sessionId"] = json!(live.session);
|
||||
let reply: Value = match live.peer.request(method, params, None).await {
|
||||
Ok(reply) => reply,
|
||||
Err(e) => {
|
||||
{
|
||||
let mut s = task.state.lock();
|
||||
s.wanted.retain(|c| c.id != option);
|
||||
if let Some(prev) = previous.clone() {
|
||||
s.wanted.push(AgentConfigChoice { id: option.to_owned(), value: prev });
|
||||
}
|
||||
if let Some(o) = s.task.config.iter_mut().find(|o| o.id == option) {
|
||||
o.current = previous.clone();
|
||||
}
|
||||
s.task.model = model_of(&s.task.config).or(s.task.model.take());
|
||||
}
|
||||
restore_config_choice(&task, &target, &value, previous.as_deref(), model_choice, previous_levels);
|
||||
task.persist();
|
||||
task.emit_task();
|
||||
return Err(IdeError::internal(task.describe(e)));
|
||||
}
|
||||
};
|
||||
if target.category.as_deref() == Some("model") && task.state.lock().model_choice != model_choice {
|
||||
return Ok(());
|
||||
}
|
||||
if let Some(options) = reply.get("configOptions") {
|
||||
config::merge_update(&mut task.state.lock().task.config, options);
|
||||
model_options = true;
|
||||
} else if target.category.as_deref() == Some("model") {
|
||||
// Old model controls were removed above, so these came from an update
|
||||
// that preceded the response.
|
||||
model_options = task.state.lock().task.config.iter().any(config::is_per_model_option);
|
||||
}
|
||||
}
|
||||
{
|
||||
let mut s = task.state.lock();
|
||||
if !model_options {
|
||||
if target.category.as_deref() == Some("model") && s.model_choice != model_choice {
|
||||
return Ok(());
|
||||
}
|
||||
if !model_options && target.category.as_deref() == Some("model") {
|
||||
s.task.config.retain(|o| !config::is_per_model_option(o));
|
||||
}
|
||||
if let Some(o) = s.task.config.iter_mut().find(|o| o.id == option) {
|
||||
@@ -1141,7 +1108,11 @@ impl AgentManager {
|
||||
.peer
|
||||
.request(
|
||||
"session/fork",
|
||||
json!({ "sessionId": live.session, "cwd": cwd_s, "mcpServers": mcp_servers }),
|
||||
{
|
||||
let mut params = session_params(&cwd_s, &mcp_servers);
|
||||
params["sessionId"] = json!(live.session);
|
||||
params
|
||||
},
|
||||
None,
|
||||
)
|
||||
.await
|
||||
@@ -1412,15 +1383,6 @@ impl AgentManager {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Removes a task from the manager's table and stops its agent. The disk (its file,
|
||||
/// its worktree) is the caller's business.
|
||||
fn drop_in_memory(&self, task: &Arc<Task>) {
|
||||
task.kill();
|
||||
self.tasks.write().remove(&task.id);
|
||||
*task.deleted.lock() = true;
|
||||
let _ = std::fs::remove_file(self.shared.paths.store_dir.join(format!("{}.json", task.id)));
|
||||
}
|
||||
|
||||
/// Returns an archived task to the active list without starting the agent.
|
||||
pub fn unarchive(&self, id: &str) -> IdeResult<()> {
|
||||
let task = self.task(id)?;
|
||||
@@ -1680,14 +1642,13 @@ impl Task {
|
||||
session_id: file.session_id,
|
||||
conversation,
|
||||
wanted: file.wanted,
|
||||
model_choice: 0,
|
||||
before: Arc::new(file.before),
|
||||
saved: file.saved,
|
||||
touched: file.touched.map(Arc::new),
|
||||
pending_rollback: file.pending_rollback,
|
||||
title_renamed: file.title_renamed,
|
||||
busy: false,
|
||||
ephemeral: false,
|
||||
ephemeral_context: None,
|
||||
background_tasks: Vec::new(),
|
||||
}),
|
||||
live: Mutex::new(None),
|
||||
@@ -1847,9 +1808,6 @@ impl Task {
|
||||
if *deleted {
|
||||
return;
|
||||
}
|
||||
if self.state.lock().ephemeral {
|
||||
return;
|
||||
}
|
||||
let bytes = {
|
||||
let s = self.state.lock();
|
||||
serde_json::to_vec(&TaskFile {
|
||||
@@ -2119,20 +2077,7 @@ impl Task {
|
||||
if !prompt.images.is_empty() && !live.capabilities.images {
|
||||
return Err(Failure::from("This agent can't read images.".to_owned()));
|
||||
}
|
||||
// A temporary side conversation's context rides with its first real message; the
|
||||
// conversation itself records only the question (and whatever comes after).
|
||||
let prompt = {
|
||||
let context = self.state.lock().ephemeral_context.take();
|
||||
match context {
|
||||
Some(context) => {
|
||||
let mut owned = prompt.clone();
|
||||
owned.text = format!("{context}\n\n---\n\n{}", owned.text);
|
||||
owned
|
||||
}
|
||||
None => prompt.clone(),
|
||||
}
|
||||
};
|
||||
let mut content = self.content(&live, &prompt).await;
|
||||
let mut content = self.content(&live, prompt).await;
|
||||
let mut result: Result<Value, RpcError> =
|
||||
live.peer.request("session/prompt", json!({ "sessionId": live.session, "prompt": content }), None).await;
|
||||
if live.driver == provider::Driver::Copilot
|
||||
@@ -2154,7 +2099,7 @@ impl Task {
|
||||
if !prompt.images.is_empty() && !live.capabilities.images {
|
||||
return Err(Failure::from("This agent can't read images.".to_owned()));
|
||||
}
|
||||
content = self.content(&live, &prompt).await;
|
||||
content = self.content(&live, prompt).await;
|
||||
result = live
|
||||
.peer
|
||||
.request("session/prompt", json!({ "sessionId": live.session, "prompt": content }), None)
|
||||
@@ -2314,7 +2259,8 @@ impl Task {
|
||||
let mut session = None;
|
||||
if let (Some(id), true) = (saved, can_load) {
|
||||
self.replaying.store(true, Ordering::Release);
|
||||
let params = json!({ "sessionId": &id, "cwd": &cwd_s, "mcpServers": &mcp_servers });
|
||||
let mut params = session_params(&cwd_s, &mcp_servers);
|
||||
params["sessionId"] = json!(&id);
|
||||
let loaded = self.request_with_auth(&peer, &init, &mut tried_auth, "session/load", params).await;
|
||||
tokio::time::sleep(REPLAY_GRACE).await;
|
||||
self.replaying.store(false, Ordering::Release);
|
||||
@@ -2327,7 +2273,7 @@ impl Task {
|
||||
let (session_id, result) = match session {
|
||||
Some(s) => s,
|
||||
None => {
|
||||
let params = json!({ "cwd": &cwd_s, "mcpServers": &mcp_servers });
|
||||
let params = session_params(&cwd_s, &mcp_servers);
|
||||
let v = self.request_with_auth(&peer, &init, &mut tried_auth, "session/new", params).await.map_err(
|
||||
|e| match self.sign_in_error(&e, Some(&sign_in_message)) {
|
||||
Some(msg) => SessionOpenError { message: msg, allow_acp_fallback: false },
|
||||
@@ -2368,7 +2314,9 @@ impl Task {
|
||||
}
|
||||
let (mut options, mut wanted) = {
|
||||
let s = self.state.lock();
|
||||
(if known { reported } else { s.task.config.clone() }, s.wanted.clone())
|
||||
let options = if known { reported } else { s.task.config.clone() };
|
||||
let wanted = s.wanted.clone();
|
||||
(options, wanted)
|
||||
};
|
||||
config::add_client_options(provider_id, &mut options);
|
||||
// Changing model can replace the effort / context-tier choices; validate those only afterwards.
|
||||
@@ -2558,11 +2506,20 @@ impl Task {
|
||||
if let Some(title) = title {
|
||||
// Check and write under one lock: a rename landing between them would be lost.
|
||||
let mut s = self.state.lock();
|
||||
if !s.title_renamed && s.task.title != title {
|
||||
let user_named = update.get("userNamed").and_then(Value::as_bool) == Some(true);
|
||||
let flag_changed = user_named && !s.title_renamed;
|
||||
if user_named {
|
||||
s.title_renamed = true;
|
||||
}
|
||||
if (user_named || !s.title_renamed) && s.task.title != title {
|
||||
s.task.title = title.to_owned();
|
||||
drop(s);
|
||||
self.persist();
|
||||
self.emit_task();
|
||||
} else if flag_changed {
|
||||
drop(s);
|
||||
self.persist();
|
||||
self.emit_task();
|
||||
}
|
||||
}
|
||||
return;
|
||||
@@ -2667,30 +2624,6 @@ impl Task {
|
||||
.collect()
|
||||
})
|
||||
.unwrap_or_default();
|
||||
// A side conversation is read-only: deny anything that would change the project
|
||||
// (its task is deleted when its pane closes, leaving nothing to review or revert).
|
||||
if self.state.lock().ephemeral
|
||||
&& params
|
||||
.pointer("/toolCall/kind")
|
||||
.or_else(|| params.pointer("/subject/toolCall/kind"))
|
||||
.and_then(Value::as_str)
|
||||
.is_some_and(|kind| matches!(kind, "edit" | "delete" | "move" | "execute"))
|
||||
{
|
||||
let reject = options.iter().find(|o| o.kind.starts_with("reject")).cloned();
|
||||
let _ = self.push_entry(AgentEntry::Permission {
|
||||
id,
|
||||
title,
|
||||
command: None,
|
||||
options,
|
||||
questions: Vec::new(),
|
||||
form: None,
|
||||
chosen: Some("Denied: side conversations are read-only".to_owned()),
|
||||
});
|
||||
return match reject {
|
||||
Some(option) => json!({ "outcome": { "outcome": "selected", "optionId": option.id } }),
|
||||
None => json!({ "outcome": { "outcome": "cancelled" } }),
|
||||
};
|
||||
}
|
||||
let asked: Vec<String> = questions
|
||||
.iter()
|
||||
.map(|question| question.answer_key.clone().unwrap_or_else(|| question.question.clone()))
|
||||
@@ -2912,6 +2845,15 @@ struct Client {
|
||||
|
||||
impl Handler for Client {
|
||||
fn on_notification(&self, method: &str, params: Value) {
|
||||
if method == WARNING_NOTIFICATION {
|
||||
if let Some(task) = self.task.upgrade()
|
||||
&& let Some(message) = params.get("message").and_then(Value::as_str).filter(|s| !s.trim().is_empty())
|
||||
{
|
||||
task.push_entry(AgentEntry::Error { message: message.to_owned() });
|
||||
task.persist();
|
||||
}
|
||||
return;
|
||||
}
|
||||
if method == "session/update"
|
||||
&& let (Some(task), Some(update)) = (self.task.upgrade(), params.get("update"))
|
||||
{
|
||||
@@ -2943,72 +2885,6 @@ fn clean(mut prompt: AgentPrompt) -> Option<AgentPrompt> {
|
||||
(!prompt.text.is_empty() || !prompt.images.is_empty() || !prompt.files.is_empty()).then_some(prompt)
|
||||
}
|
||||
|
||||
/// The character budget of a side conversation's context: the newest entries win, the
|
||||
/// oldest are dropped first. Leaves room for the question and the agent's answer.
|
||||
const CONTEXT_BUDGET: usize = 100_000;
|
||||
|
||||
/// A long tool output trimmed to its first and last few lines, with the elided middle noted.
|
||||
fn trimmed_output(output: &str) -> String {
|
||||
const KEPT: usize = 4;
|
||||
let lines: Vec<&str> = output.lines().collect();
|
||||
if lines.len() <= KEPT * 2 + 1 {
|
||||
return output.to_owned();
|
||||
}
|
||||
let omitted = lines.len() - KEPT * 2;
|
||||
let mut out = lines[..KEPT].join("\n");
|
||||
out.push_str(&format!("\n… {omitted} lines omitted …\n"));
|
||||
out.push_str(&lines[lines.len() - KEPT..].join("\n"));
|
||||
out
|
||||
}
|
||||
|
||||
fn context_entry(e: &AgentEntry) -> Option<String> {
|
||||
match e {
|
||||
AgentEntry::User { text, .. } => Some(format!("User: {text}")),
|
||||
AgentEntry::Agent { text, .. } if !text.trim().is_empty() => Some(format!("Agent: {text}")),
|
||||
AgentEntry::Thought { text, .. } if !text.trim().is_empty() => Some(format!("Thought: {text}")),
|
||||
AgentEntry::Tool { title, output, .. } => match output.as_deref() {
|
||||
Some(output) if !output.trim().is_empty() => Some(format!("Tool: {title}\n{}", trimmed_output(output))),
|
||||
_ => Some(format!("Tool: {title}")),
|
||||
},
|
||||
AgentEntry::Error { message, .. } => Some(format!("Error: {message}")),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// The conversation as the context a temporary side conversation starts with: what was
|
||||
/// said, what was done (tool calls with trimmed output), errors and the agent's reasoning,
|
||||
/// oldest first, within [`CONTEXT_BUDGET`].
|
||||
fn context_transcript(entries: &[AgentEntry]) -> String {
|
||||
// Newest wins: walk back until the budget is spent, dropping the oldest entries first.
|
||||
let mut lines: Vec<String> = Vec::new();
|
||||
let mut used = 0usize;
|
||||
for e in entries.iter().rev() {
|
||||
let Some(line) = context_entry(e) else { continue };
|
||||
if used + line.len() > CONTEXT_BUDGET {
|
||||
if lines.is_empty() {
|
||||
// Even the newest entry alone exceeds the budget: keep its head.
|
||||
lines.push(line.chars().take(CONTEXT_BUDGET).collect());
|
||||
}
|
||||
break;
|
||||
}
|
||||
used += line.len();
|
||||
lines.push(line);
|
||||
}
|
||||
lines.reverse();
|
||||
let dropped = entries.iter().rev().filter_map(context_entry).count() - lines.len();
|
||||
let mut context = String::from(
|
||||
"You are answering a side question in a temporary conversation. The conversation so far is below, \
|
||||
for context only; answer the new question after the marker, and do not continue the main task \
|
||||
unless asked.\n\n<conversation>\n",
|
||||
);
|
||||
if dropped > 0 {
|
||||
context.push_str(&format!("(The {dropped} oldest entries are omitted.)\n\n"));
|
||||
}
|
||||
context.push_str(&lines.join("\n\n"));
|
||||
context.push_str("\n</conversation>");
|
||||
context
|
||||
}
|
||||
|
||||
fn permission_title(params: &Value) -> String {
|
||||
let call = ¶ms["toolCall"];
|
||||
let title = call.get("title").and_then(Value::as_str).filter(|t| !t.is_empty());
|
||||
@@ -3227,7 +3103,6 @@ fn capabilities_of(init: &acp::Negotiated) -> (AgentCapabilities, bool) {
|
||||
rollback: meta("/openidea/rollback"),
|
||||
steer: steer_method(init).is_some(),
|
||||
background_tasks: meta("/openidea/backgroundTasks"),
|
||||
read_only: false,
|
||||
};
|
||||
(capabilities, init.prompt("embeddedContext"))
|
||||
}
|
||||
@@ -3242,6 +3117,23 @@ fn turn_starts(entries: &[AgentEntry]) -> Vec<usize> {
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The MCP servers of a session, and the names of the ones off for it.
|
||||
struct McpForSession {
|
||||
servers: Vec<Value>,
|
||||
off: Vec<String>,
|
||||
}
|
||||
|
||||
/// The session parameters `session/new`, `session/load` and `session/fork` share: the MCP
|
||||
/// servers, and the ones off for this session, so an agent that also loads its own
|
||||
/// configuration (Claude Code) can keep a same-named server of it off too.
|
||||
fn session_params(cwd: &str, mcp: &McpForSession) -> Value {
|
||||
let mut params = json!({ "cwd": cwd, "mcpServers": mcp.servers });
|
||||
if !mcp.off.is_empty() {
|
||||
params["_meta"] = json!({ "openidea": { "mcpServersOff": mcp.off } });
|
||||
}
|
||||
params
|
||||
}
|
||||
|
||||
fn is_false(b: &bool) -> bool {
|
||||
!*b
|
||||
}
|
||||
@@ -3261,12 +3153,32 @@ fn retry_of(update: &Value, now: f64) -> Option<AgentRetry> {
|
||||
})
|
||||
}
|
||||
|
||||
fn apply_config_choice(task: &Task, option: &str, value: &str) {
|
||||
fn restore_config_choice(
|
||||
task: &Task,
|
||||
target: &AgentConfigOption,
|
||||
value: &str,
|
||||
previous: Option<&str>,
|
||||
model_choice: u64,
|
||||
previous_levels: Option<Vec<AgentConfigOption>>,
|
||||
) {
|
||||
let option = target.id.as_str();
|
||||
let is_model = target.category.as_deref() == Some("model");
|
||||
let mut s = task.state.lock();
|
||||
if (is_model && s.model_choice != model_choice)
|
||||
|| !s.task.config.iter().any(|o| o.id == option && o.current.as_deref() == Some(value))
|
||||
{
|
||||
return;
|
||||
}
|
||||
s.wanted.retain(|c| c.id != option);
|
||||
s.wanted.push(AgentConfigChoice { id: option.to_owned(), value: value.to_owned() });
|
||||
if let Some(previous) = previous {
|
||||
s.wanted.push(AgentConfigChoice { id: option.to_owned(), value: previous.to_owned() });
|
||||
}
|
||||
if let Some(o) = s.task.config.iter_mut().find(|o| o.id == option) {
|
||||
o.current = Some(value.to_owned());
|
||||
o.current = previous.map(str::to_owned);
|
||||
}
|
||||
if let Some(levels) = previous_levels {
|
||||
s.task.config.retain(|o| !config::is_per_model_option(o));
|
||||
s.task.config.extend(levels);
|
||||
}
|
||||
s.task.model = model_of(&s.task.config).or(s.task.model.take());
|
||||
}
|
||||
@@ -3275,13 +3187,20 @@ fn model_of(config: &[AgentConfigOption]) -> Option<String> {
|
||||
config.iter().find(|o| o.category.as_deref() == Some("model")).and_then(|o| o.current.clone())
|
||||
}
|
||||
|
||||
/// Commands the agent implements on its own and never lists in `availableCommands` —
|
||||
/// its CLI builtins, passed through as prompt text (e.g. `/compact`). `(name, description)`.
|
||||
fn builtin_commands(provider: &str) -> &'static [(&'static str, &'static str)] {
|
||||
/// Commands the agent implements on its own and never lists in `availableCommands`.
|
||||
fn builtin_commands(provider: &str) -> Vec<AgentCommand> {
|
||||
match provider {
|
||||
// Codex app-server has no command-list API, so the native adapter supplies its
|
||||
// stable builtins and merges the session's dynamic skills separately.
|
||||
"codex" => native::codex::builtin_commands(),
|
||||
// OpenCode ACP handles `/compact` via session.summarize but omits it from its command list.
|
||||
"opencode" => &[("compact", "compact the conversation")],
|
||||
_ => &[],
|
||||
"opencode" => vec![AgentCommand {
|
||||
name: "compact".into(),
|
||||
description: "compact the conversation".into(),
|
||||
hint: None,
|
||||
source: AgentCommandSource::Command,
|
||||
}],
|
||||
_ => Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3343,6 +3262,9 @@ mod replay_tests;
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
/// The name agents know the built-in server by (its tools are `mcp__OpenIDEA__…` in Claude Code).
|
||||
const BUILTIN_SERVER: &str = "OpenIDEA";
|
||||
|
||||
// The desktop advertises its relay only while the built-in server is listening.
|
||||
static MCP_EXECUTABLE: parking_lot::RwLock<Option<std::path::PathBuf>> = parking_lot::RwLock::new(None);
|
||||
|
||||
@@ -3357,7 +3279,7 @@ fn mcp_servers_for(supported: bool, root: &std::path::Path) -> Vec<Value> {
|
||||
fn stdio_mcp_servers(executable: Option<&std::path::Path>, supported: bool, root: &std::path::Path) -> Vec<Value> {
|
||||
let Some(executable) = executable.filter(|_| supported) else { return Vec::new() };
|
||||
let command = ide_mcp::stdio_command(executable, root);
|
||||
vec![json!({ "name": "OpenIDEA", "command": command[0], "args": command[1..], "env": [] })]
|
||||
vec![json!({ "name": BUILTIN_SERVER, "command": command[0], "args": command[1..], "env": [] })]
|
||||
}
|
||||
|
||||
/// What was sent of a streaming message: its first `bytes` (`utf16` UTF-16 units), which
|
||||
|
||||
@@ -86,6 +86,29 @@ fn matches_agent(agents: &[String], provider: &str) -> bool {
|
||||
})
|
||||
}
|
||||
|
||||
/// The configured servers off for this session: off by default and not switched on for it, or
|
||||
/// switched off for it. Named so an agent that also loads its own configuration can keep a
|
||||
/// same-named server of it off too. Workspace entries take precedence, as in [`acp_mcp_servers`].
|
||||
pub(crate) fn servers_off(all: &[McpServer], overrides: &BTreeMap<String, bool>) -> Vec<String> {
|
||||
let mut seen = HashSet::new();
|
||||
let ordered =
|
||||
all.iter().filter(|s| s.scope == McpScope::Workspace).chain(all.iter().filter(|s| s.scope == McpScope::User));
|
||||
let configured: Vec<String> = ordered
|
||||
.filter(|s| seen.insert(s.name.as_str()))
|
||||
.filter(|s| !overrides.get(&s.name).copied().unwrap_or(s.enabled))
|
||||
.map(|s| s.name.clone())
|
||||
.collect();
|
||||
// A server switched off that the IDE doesn't configure may still be the agent's own.
|
||||
let switched = overrides
|
||||
.iter()
|
||||
.filter(|(name, on)| !**on && name.as_str() != BUILTIN_MCP_NAME && !seen.contains(name.as_str()))
|
||||
.map(|(name, _)| name.clone());
|
||||
let mut off: Vec<String> = configured.into_iter().chain(switched).collect();
|
||||
off.sort();
|
||||
off.dedup();
|
||||
off
|
||||
}
|
||||
|
||||
/// Builds the ACP `mcpServers` array for `session/new`, `session/load`, and `session/fork`.
|
||||
/// Workspace entries take precedence over User entries with the same name. Per-session
|
||||
/// `overrides` (`server_name` -> `enabled`) can enable a disabled server or disable an enabled one
|
||||
@@ -1016,6 +1039,44 @@ fn parse_key_values_map(val: Option<&Value>) -> BTreeMap<String, String> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn configured(name: &str, scope: McpScope, enabled: bool) -> McpServer {
|
||||
McpServer {
|
||||
id: format!("{scope:?}:{name}"),
|
||||
name: name.into(),
|
||||
scope,
|
||||
transport: McpTransport::Stdio,
|
||||
enabled,
|
||||
command: Some("x".into()),
|
||||
args: Vec::new(),
|
||||
env: Vec::new(),
|
||||
url: None,
|
||||
headers: Vec::new(),
|
||||
agents: Vec::new(),
|
||||
unapproved: false,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn servers_off_follow_the_effective_state() {
|
||||
let all = [
|
||||
configured("default-off", McpScope::User, false),
|
||||
configured("switched-on", McpScope::User, false),
|
||||
configured("on", McpScope::User, true),
|
||||
configured("switched-off", McpScope::User, true),
|
||||
// The workspace entry decides for its name.
|
||||
configured("both", McpScope::User, true),
|
||||
configured("both", McpScope::Workspace, false),
|
||||
];
|
||||
let overrides = BTreeMap::from([
|
||||
("switched-on".to_owned(), true),
|
||||
("switched-off".to_owned(), false),
|
||||
("agent-own".to_owned(), false),
|
||||
(BUILTIN_MCP_NAME.to_owned(), false),
|
||||
]);
|
||||
assert_eq!(servers_off(&all, &overrides), ["agent-own", "both", "default-off", "switched-off"]);
|
||||
assert_eq!(servers_off(&all[2..4], &BTreeMap::new()), Vec::<String>::new());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn crud_and_acp_filtering_by_scope_agent_and_transport() {
|
||||
let mut user = BTreeMap::new();
|
||||
|
||||
@@ -45,9 +45,6 @@ pub struct AgentCapabilities {
|
||||
pub steer: bool,
|
||||
/// It reports its background tasks and stops them one by one.
|
||||
pub background_tasks: bool,
|
||||
/// The task runs read-only: it asks before anything, and requests that would change
|
||||
/// the project are denied (a temporary side conversation).
|
||||
pub read_only: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
|
||||
@@ -170,6 +170,8 @@ struct Session {
|
||||
id: String,
|
||||
cwd: PathBuf,
|
||||
mcp_config: Option<tempfile::TempPath>,
|
||||
/// MCP servers switched off for this session (`--disallowedTools`), its own config's too.
|
||||
mcp_off: Vec<String>,
|
||||
shim: Weak<Shim>,
|
||||
st: Mutex<State>,
|
||||
/// Serializes (re)starting the process.
|
||||
@@ -344,9 +346,10 @@ impl Shim {
|
||||
cwd: PathBuf,
|
||||
start: Start,
|
||||
pending: bool,
|
||||
mcp_config: Option<String>,
|
||||
params: &Value,
|
||||
) -> Arc<Session> {
|
||||
let mcp_config = mcp_config.and_then(|json| match write_mcp_config(&json) {
|
||||
let mcp_off = mcp_off(params);
|
||||
let mcp_config = mcp_config(params).and_then(|json| match write_mcp_config(&json) {
|
||||
Ok(path) => Some(path),
|
||||
Err(e) => {
|
||||
tracing::warn!("Claude Code session {id}: cannot write its MCP configuration: {e}");
|
||||
@@ -356,6 +359,7 @@ impl Shim {
|
||||
let session = Arc::new(Session {
|
||||
id: id.to_owned(),
|
||||
mcp_config,
|
||||
mcp_off,
|
||||
shim: Arc::downgrade(self),
|
||||
st: Mutex::new(State {
|
||||
proc: None,
|
||||
@@ -411,13 +415,8 @@ impl Shim {
|
||||
}
|
||||
"session/new" => {
|
||||
let id = new_uuid(false);
|
||||
let session = self.add_session(
|
||||
&id,
|
||||
self.cwd_of(¶ms),
|
||||
Start::New { id: id.clone() },
|
||||
false,
|
||||
mcp_config(¶ms),
|
||||
);
|
||||
let session =
|
||||
self.add_session(&id, self.cwd_of(¶ms), Start::New { id: id.clone() }, false, ¶ms);
|
||||
rt.block_on(session.ensure()).map_err(|e| self.start_error(&session, e))?;
|
||||
session.announce_commands();
|
||||
Ok(json!({ "sessionId": id, "configOptions": session.st.lock().settings.options() }))
|
||||
@@ -433,7 +432,7 @@ impl Shim {
|
||||
None => return Err(invalid(format!("no Claude Code session {id} in {}", cwd.display()))),
|
||||
};
|
||||
let chain = self.base_chain(&cwd, &start).map_err(internal)?;
|
||||
let session = self.add_session(id, cwd, start, pending, mcp_config(¶ms));
|
||||
let session = self.add_session(id, cwd, start, pending, ¶ms);
|
||||
rt.block_on(session.ensure()).map_err(|e| self.start_error(&session, e))?;
|
||||
if method == "session/load" {
|
||||
session.replay(&chain);
|
||||
@@ -459,7 +458,7 @@ impl Shim {
|
||||
(start, st.settings.clone())
|
||||
};
|
||||
self.save_pending(&id, Some(&start));
|
||||
let session = self.add_session(&id, source.cwd.clone(), start, true, mcp_config(¶ms));
|
||||
let session = self.add_session(&id, source.cwd.clone(), start, true, ¶ms);
|
||||
session.st.lock().settings = settings;
|
||||
let options = session.st.lock().settings.options();
|
||||
Ok(json!({ "sessionId": id, "configOptions": options }))
|
||||
@@ -666,6 +665,9 @@ impl Session {
|
||||
if let Some(config) = &self.mcp_config {
|
||||
args.extend(["--mcp-config".to_owned(), config.to_string_lossy().into_owned()]);
|
||||
}
|
||||
if !self.mcp_off.is_empty() {
|
||||
args.extend(["--disallowedTools".to_owned(), self.mcp_off.join(",")]);
|
||||
}
|
||||
args.extend(start.args());
|
||||
let launch =
|
||||
Launch { program: shim.config.program.clone(), args, cwd: self.cwd.clone(), env: shim.config.env.clone() };
|
||||
@@ -1497,6 +1499,24 @@ fn write_mcp_config(json: &str) -> std::io::Result<tempfile::TempPath> {
|
||||
Ok(file.into_temp_path())
|
||||
}
|
||||
|
||||
/// The servers switched off for the session (`_meta.openidea.mcpServersOff`) as Claude Code
|
||||
/// permission rules that deny all of a server's tools (`mcp__<server>`), so a server of
|
||||
/// Claude Code's own configuration stays off too.
|
||||
fn mcp_off(params: &Value) -> Vec<String> {
|
||||
params
|
||||
.pointer("/_meta/openidea/mcpServersOff")
|
||||
.and_then(Value::as_array)
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.filter_map(Value::as_str)
|
||||
.map(|name| {
|
||||
let name: String =
|
||||
name.chars().map(|c| if c.is_ascii_alphanumeric() || c == '_' || c == '-' { c } else { '_' }).collect();
|
||||
format!("mcp__{name}")
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// ACP `mcpServers` as Claude Code's `--mcp-config` JSON (`None` when there are none).
|
||||
fn mcp_config(params: &Value) -> Option<String> {
|
||||
let servers = params.get("mcpServers")?.as_array()?;
|
||||
|
||||
@@ -48,10 +48,17 @@ impl Settings {
|
||||
.filter_map(|m| {
|
||||
let s = |k: &str| m.get(k).and_then(Value::as_str).map(str::to_owned);
|
||||
let value = s("value")?;
|
||||
let resolved = s("resolvedModel");
|
||||
// The default entry follows the account's default model, so "Default
|
||||
// (recommended)" hides what actually runs: name the model it resolves to.
|
||||
let name = match (value.as_str(), resolved.as_deref()) {
|
||||
("default", Some(r)) if !r.is_empty() => format!("Default ({r})"),
|
||||
_ => s("displayName").unwrap_or_else(|| value.clone()),
|
||||
};
|
||||
Some(Model {
|
||||
name: s("displayName").unwrap_or_else(|| value.clone()),
|
||||
name,
|
||||
description: s("description"),
|
||||
resolved: s("resolvedModel"),
|
||||
resolved,
|
||||
efforts: if m.get("supportsEffort").and_then(Value::as_bool) == Some(true) {
|
||||
m.get("supportedEffortLevels")
|
||||
.and_then(Value::as_array)
|
||||
@@ -230,6 +237,19 @@ mod tests {
|
||||
assert_eq!(s.model, "claude-x-1");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_default_entry_is_named_by_the_model_it_runs() {
|
||||
let s = Settings::from_cli(&init(), &json!({"applied": {"model": "claude-sonnet-5-5"}}));
|
||||
let names: Vec<_> = s.models.iter().map(|m| m.name.as_str()).collect();
|
||||
assert_eq!(names, ["Default (claude-sonnet-5-5)", "Opus", "Haiku 4.5"]);
|
||||
// Without a resolved model, the agent's own name stands.
|
||||
let s = Settings::from_cli(
|
||||
&json!({"models": [{"value": "default", "displayName": "Default (recommended)"}]}),
|
||||
&json!({}),
|
||||
);
|
||||
assert_eq!(s.models[0].name, "Default (recommended)");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn options_follow_the_model() {
|
||||
let mut s = Settings::from_cli(&init(), &json!({"applied": {"model": "claude-sonnet-5-5", "effort": "high"}}));
|
||||
|
||||
@@ -1243,6 +1243,13 @@ async fn skipped_questions_have_no_answers() {
|
||||
assert_eq!(cancelled, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn servers_switched_off_become_disallowed_tools() {
|
||||
assert!(mcp_off(&json!({})).is_empty());
|
||||
let off = mcp_off(&json!({ "_meta": { "openidea": { "mcpServersOff": ["github", "my server.v2"] } } }));
|
||||
assert_eq!(off, ["mcp__github", "mcp__my_server_v2"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mcp_servers_become_an_mcp_config() {
|
||||
assert_eq!(mcp_config(&json!({ "mcpServers": [] })), None);
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
//! Codex's built-in slash commands. `codex app-server` has no command-list API, so the
|
||||
//! native adapter owns this stable compatibility table; skills stay dynamic via `skills/list`.
|
||||
|
||||
use serde_json::Value;
|
||||
|
||||
/// Menu metadata shared by agent_commands and the prompt dispatcher.
|
||||
pub(crate) struct BuiltinCommandSpec {
|
||||
pub name: &'static str,
|
||||
pub description: &'static str,
|
||||
pub hint: Option<&'static str>,
|
||||
}
|
||||
|
||||
pub(crate) const BUILTIN_COMMANDS: &[BuiltinCommandSpec] = &[
|
||||
BuiltinCommandSpec { name: "plan", description: "Turn plan mode on or off.", hint: None },
|
||||
BuiltinCommandSpec {
|
||||
name: "mcp",
|
||||
description: "Show the status of the MCP servers, or reconnect them.",
|
||||
hint: Some("[reconnect]"),
|
||||
},
|
||||
BuiltinCommandSpec { name: "skills", description: "List available skills.", hint: None },
|
||||
BuiltinCommandSpec { name: "status", description: "Display session configuration and token usage.", hint: None },
|
||||
BuiltinCommandSpec {
|
||||
name: "review",
|
||||
description: "Review uncommitted changes, or review with custom instructions.",
|
||||
hint: Some("optional review instructions"),
|
||||
},
|
||||
BuiltinCommandSpec {
|
||||
name: "review-branch",
|
||||
description: "Review changes relative to a base branch.",
|
||||
hint: Some("branch name"),
|
||||
},
|
||||
BuiltinCommandSpec { name: "review-commit", description: "Review a specific commit.", hint: Some("commit sha") },
|
||||
BuiltinCommandSpec {
|
||||
name: "compact",
|
||||
description: "Summarize conversation to avoid hitting the context limit.",
|
||||
hint: None,
|
||||
},
|
||||
BuiltinCommandSpec {
|
||||
name: "goal",
|
||||
description: "Set a goal to keep pursuing.",
|
||||
hint: Some("[<objective>|clear|pause|resume]"),
|
||||
},
|
||||
BuiltinCommandSpec { name: "rename", description: "Rename the current session.", hint: Some("new name") },
|
||||
BuiltinCommandSpec {
|
||||
name: "logout",
|
||||
description: "Sign out of Codex. This option is available when you are logged in via ChatGPT.",
|
||||
hint: None,
|
||||
},
|
||||
];
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub(super) enum BuiltinCommand {
|
||||
Plan,
|
||||
Mcp,
|
||||
Skills,
|
||||
Status,
|
||||
Review,
|
||||
ReviewBranch,
|
||||
ReviewCommit,
|
||||
Compact,
|
||||
Goal,
|
||||
Rename,
|
||||
Logout,
|
||||
}
|
||||
|
||||
impl BuiltinCommand {
|
||||
fn from_name(name: &str) -> Option<Self> {
|
||||
Some(match name {
|
||||
"plan" => Self::Plan,
|
||||
"mcp" => Self::Mcp,
|
||||
"skills" => Self::Skills,
|
||||
"status" => Self::Status,
|
||||
"review" => Self::Review,
|
||||
"review-branch" => Self::ReviewBranch,
|
||||
"review-commit" => Self::ReviewCommit,
|
||||
"compact" => Self::Compact,
|
||||
"goal" => Self::Goal,
|
||||
"rename" => Self::Rename,
|
||||
"logout" => Self::Logout,
|
||||
_ => return None,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub(super) struct ParsedCommand {
|
||||
pub command: BuiltinCommand,
|
||||
/// Everything after the command name, trimmed but otherwise unchanged.
|
||||
pub rest: String,
|
||||
}
|
||||
|
||||
impl ParsedCommand {
|
||||
/// Commands that Codex completes as a turn. Missing review arguments stay local so the
|
||||
/// adapter can print the command's usage without starting an unnecessary model request.
|
||||
pub fn starts_turn(&self) -> bool {
|
||||
matches!(self.command, BuiltinCommand::Compact | BuiltinCommand::Review)
|
||||
|| (matches!(self.command, BuiltinCommand::ReviewBranch | BuiltinCommand::ReviewCommit)
|
||||
&& !self.rest.is_empty())
|
||||
}
|
||||
}
|
||||
|
||||
/// A recognized Codex builtin at the start of the prompt. Unknown slash commands and
|
||||
/// `$skill` invocations return `None`, so they continue through Codex as ordinary prompts.
|
||||
pub(super) fn parse(prompt: &Value) -> Option<ParsedCommand> {
|
||||
let text = prompt.as_array()?.first()?.get("text")?.as_str()?.trim();
|
||||
let command_text = text.strip_prefix('/')?.trim();
|
||||
let (name, rest) = command_text.split_once(char::is_whitespace).unwrap_or((command_text, ""));
|
||||
let command = BuiltinCommand::from_name(&name.to_ascii_lowercase())?;
|
||||
Some(ParsedCommand { command, rest: rest.trim().to_owned() })
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use serde_json::json;
|
||||
|
||||
fn text(value: &str) -> Value {
|
||||
json!([{ "type": "text", "text": value }])
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_builtin_is_registered_and_parsed() {
|
||||
let expected = [
|
||||
"plan",
|
||||
"mcp",
|
||||
"skills",
|
||||
"status",
|
||||
"review",
|
||||
"review-branch",
|
||||
"review-commit",
|
||||
"compact",
|
||||
"goal",
|
||||
"rename",
|
||||
"logout",
|
||||
];
|
||||
assert_eq!(BUILTIN_COMMANDS.iter().map(|c| c.name).collect::<Vec<_>>(), expected);
|
||||
for name in expected {
|
||||
assert!(parse(&text(&format!("/{name}"))).is_some(), "{name}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parsing_keeps_arguments_and_leaves_non_builtins_alone() {
|
||||
let parsed = parse(&text(" /review-branch origin/main ")).unwrap();
|
||||
assert_eq!(parsed.command, BuiltinCommand::ReviewBranch);
|
||||
assert_eq!(parsed.rest, "origin/main");
|
||||
assert!(parsed.starts_turn());
|
||||
assert!(!parse(&text("/review-branch")).unwrap().starts_turn());
|
||||
assert!(parse(&text("/$review check this")).is_none());
|
||||
assert!(parse(&text("review")).is_none());
|
||||
|
||||
let prompt = json!([{ "type": "text", "text": "/compact" }, { "type": "image", "data": "AA==" }]);
|
||||
assert_eq!(parse(&prompt).unwrap().command, BuiltinCommand::Compact);
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,11 @@
|
||||
//! translated to and from ACP. A codex thread is an ACP session; a subagent's thread is
|
||||
//! a subagent session of the thread that spawned it.
|
||||
|
||||
mod commands;
|
||||
mod translate;
|
||||
mod trust;
|
||||
|
||||
pub(crate) use commands::BUILTIN_COMMANDS;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
@@ -10,6 +14,8 @@ mod tests;
|
||||
use super::Shim;
|
||||
use crate::acp::AUTH_REQUIRED;
|
||||
use crate::provider::ProviderSpec;
|
||||
use crate::{AgentCommand, AgentCommandSource};
|
||||
use commands::{BuiltinCommand, ParsedCommand};
|
||||
use ide_jsonrpc::{Framing, Handler, Peer, RpcError, codes};
|
||||
use parking_lot::Mutex;
|
||||
use serde_json::{Value, json};
|
||||
@@ -32,6 +38,19 @@ const EXIT_GRACE: Duration = Duration::from_millis(100);
|
||||
const NAME_PROMPT: &str = "Name this conversation for a list of tasks: a short title of at most six words, in the \
|
||||
language the user writes in. Reply with the title only, without quotes or a closing period.";
|
||||
|
||||
/// Slash-command metadata for provider discovery and sessions without an advertised list.
|
||||
pub(crate) fn builtin_commands() -> Vec<AgentCommand> {
|
||||
BUILTIN_COMMANDS
|
||||
.iter()
|
||||
.map(|command| AgentCommand {
|
||||
name: command.name.to_owned(),
|
||||
description: command.description.to_owned(),
|
||||
hint: command.hint.map(str::to_owned),
|
||||
source: AgentCommandSource::Command,
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
pub(crate) fn connect(
|
||||
spec: &ProviderSpec,
|
||||
cwd: &Path,
|
||||
@@ -183,6 +202,8 @@ struct State {
|
||||
threads: HashMap<String, Thread>,
|
||||
/// The last `account/rateLimits/updated` snapshot.
|
||||
rate_limits: Option<Value>,
|
||||
/// Project trust has been checked (and, when needed, asked about) on this connection.
|
||||
trust_checked: HashSet<String>,
|
||||
/// Codex exited.
|
||||
gone: bool,
|
||||
}
|
||||
@@ -215,6 +236,8 @@ struct Thread {
|
||||
early_cancel: Option<Instant>,
|
||||
/// The latest agent message (a subagent's answer).
|
||||
answer: String,
|
||||
/// The latest `thread/tokenUsage/updated` payload, for the `/status` command.
|
||||
token_usage: Option<Value>,
|
||||
/// The thread has a name.
|
||||
named: bool,
|
||||
/// A name is being asked for.
|
||||
@@ -320,6 +343,12 @@ impl CodexShim {
|
||||
self.codex().request(method, params, None).await.map_err(from_codex)
|
||||
}
|
||||
|
||||
fn warning(&self, message: impl Into<String>) {
|
||||
if let Some(client) = self.client.get() {
|
||||
let _ = client.notify(crate::WARNING_NOTIFICATION, json!({ "message": message.into() }));
|
||||
}
|
||||
}
|
||||
|
||||
async fn handle(&self, method: &str, params: Value) -> Result<Value, ResponseError> {
|
||||
match method {
|
||||
"initialize" => self.initialize().await,
|
||||
@@ -403,6 +432,7 @@ impl CodexShim {
|
||||
|
||||
async fn new_session(&self, params: &Value) -> Result<Value, ResponseError> {
|
||||
let models = self.models().await?;
|
||||
self.prepare_project_trust(params).await;
|
||||
let mut request = json!({ "cwd": params.get("cwd") });
|
||||
if let Some(config) = translate::mcp_config(params) {
|
||||
request["config"] = config;
|
||||
@@ -420,6 +450,7 @@ impl CodexShim {
|
||||
async fn load_session(&self, params: &Value) -> Result<Value, ResponseError> {
|
||||
let id = str_param(params, "sessionId")?;
|
||||
let models = self.models().await?;
|
||||
self.prepare_project_trust(params).await;
|
||||
let mut request = json!({ "threadId": id, "cwd": params.get("cwd") });
|
||||
if let Some(config) = translate::mcp_config(params) {
|
||||
request["config"] = config;
|
||||
@@ -438,6 +469,7 @@ impl CodexShim {
|
||||
async fn fork_session(&self, params: &Value) -> Result<Value, ResponseError> {
|
||||
let source = str_param(params, "sessionId")?;
|
||||
let models = self.models().await?;
|
||||
self.prepare_project_trust(params).await;
|
||||
let settings = self.state.lock().threads.get(source).and_then(|t| t.settings.clone());
|
||||
let mut request = json!({ "threadId": source, "cwd": params.get("cwd") });
|
||||
if let Some(config) = translate::mcp_config(params) {
|
||||
@@ -471,11 +503,18 @@ impl CodexShim {
|
||||
|
||||
async fn prompt(&self, params: &Value) -> Result<Value, ResponseError> {
|
||||
let session = str_param(params, "sessionId")?.to_owned();
|
||||
let input = translate::user_input(params.get("prompt").unwrap_or(&Value::Null));
|
||||
let prompt = params.get("prompt").unwrap_or(&Value::Null);
|
||||
let command = commands::parse(prompt);
|
||||
if let Some(command) = command.as_ref()
|
||||
&& !command.starts_turn()
|
||||
{
|
||||
return self.local_command(&session, command).await;
|
||||
}
|
||||
let input = translate::user_input(prompt);
|
||||
if input.is_empty() {
|
||||
return Err(invalid("empty prompt"));
|
||||
}
|
||||
let models = self.models().await?;
|
||||
let models = if command.is_none() { Some(self.models().await?) } else { None };
|
||||
let (done, ended) = oneshot::channel();
|
||||
let settings = {
|
||||
let mut state = self.state.lock();
|
||||
@@ -491,33 +530,213 @@ impl CodexShim {
|
||||
t.error = None;
|
||||
t.settings.clone()
|
||||
};
|
||||
let mut request = json!({ "threadId": session, "input": input, "summary": "auto" });
|
||||
if let Some(s) = settings {
|
||||
request["model"] = json!(s.model_slug(&models));
|
||||
request["approvalPolicy"] = json!(s.mode.approval_policy());
|
||||
request["sandboxPolicy"] = s.mode.sandbox_policy();
|
||||
if let Some(effort) = &s.effort {
|
||||
request["effort"] = json!(effort);
|
||||
let started = match command.as_ref() {
|
||||
Some(command) => match command.command {
|
||||
BuiltinCommand::Compact => {
|
||||
// Codex reports compaction as its own turn, using the same started/completed
|
||||
// notifications that finish the pending session/prompt above.
|
||||
self.call("thread/compact/start", json!({ "threadId": session })).await
|
||||
}
|
||||
BuiltinCommand::Review | BuiltinCommand::ReviewBranch | BuiltinCommand::ReviewCommit => {
|
||||
self.call("review/start", json!({ "threadId": session, "target": review_target(command) })).await
|
||||
}
|
||||
_ => unreachable!("local commands return before a pending turn is created"),
|
||||
},
|
||||
None => {
|
||||
let models = models.expect("ordinary prompts load the model catalog");
|
||||
let mut request = json!({ "threadId": session, "input": input, "summary": "auto" });
|
||||
if let Some(s) = &settings {
|
||||
request["model"] = json!(s.model_slug(&models));
|
||||
request["approvalPolicy"] = json!(s.mode.approval_policy());
|
||||
request["sandboxPolicy"] = s.mode.sandbox_policy();
|
||||
// Omit the default so older app-server versions keep accepting normal
|
||||
// turns; selecting Plan opts into this newer request field.
|
||||
if s.collaboration_mode == translate::PLAN_COLLABORATION_MODE
|
||||
|| s.collaboration_mode_override.is_some()
|
||||
{
|
||||
request["collaborationMode"] = translate::collaboration_mode(s, &models);
|
||||
}
|
||||
if let Some(effort) = &s.effort {
|
||||
request["effort"] = json!(effort);
|
||||
}
|
||||
}
|
||||
self.call("turn/start", request).await
|
||||
}
|
||||
};
|
||||
if let Ok(started) = &started
|
||||
&& let Some(turn) = started.pointer("/turn/id").and_then(Value::as_str)
|
||||
{
|
||||
self.turn_known(&session, turn, false);
|
||||
}
|
||||
match self.call("turn/start", request).await {
|
||||
Ok(started) => {
|
||||
if let Some(turn) = started.pointer("/turn/id").and_then(Value::as_str) {
|
||||
self.turn_known(&session, turn, false);
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
if let Some(t) = self.state.lock().threads.get_mut(&session) {
|
||||
t.prompt = None;
|
||||
}
|
||||
return Err(e);
|
||||
if started.is_ok()
|
||||
&& command.is_none()
|
||||
&& let Some(thread) = self.state.lock().threads.get_mut(&session)
|
||||
&& let Some(settings) = thread.settings.as_mut()
|
||||
{
|
||||
// A Default override is needed only for the first turn that resets a resumed
|
||||
// Plan thread; omitting it afterwards preserves compatibility with older Codex.
|
||||
settings.collaboration_mode_override = None;
|
||||
}
|
||||
if let Err(e) = started {
|
||||
if let Some(t) = self.state.lock().threads.get_mut(&session) {
|
||||
t.prompt = None;
|
||||
}
|
||||
return Err(e);
|
||||
}
|
||||
let (turn, last_error) = ended.await.map_err(|_| error(codes::INTERNAL_ERROR, "Codex exited"))?;
|
||||
let rate_limits = self.state.lock().rate_limits.clone();
|
||||
stop_reason(&turn, last_error, rate_limits.as_ref())
|
||||
}
|
||||
|
||||
/// Runs commands that codex-acp historically handled locally: configuration, status,
|
||||
/// inventory, naming and account actions. They complete without starting a model turn.
|
||||
async fn local_command(&self, session: &str, command: &ParsedCommand) -> Result<Value, ResponseError> {
|
||||
let (settings, cwd, token_usage, rate_limits) = {
|
||||
let state = self.state.lock();
|
||||
if state.gone {
|
||||
return Err(error(codes::INTERNAL_ERROR, "Codex exited"));
|
||||
}
|
||||
let thread = state.threads.get(session).ok_or_else(|| invalid(format!("no session {session}")))?;
|
||||
if thread.prompt.is_some() || thread.turn.is_some() {
|
||||
return Err(invalid("a turn is already running"));
|
||||
}
|
||||
(thread.settings.clone(), thread.cwd.clone(), thread.token_usage.clone(), state.rate_limits.clone())
|
||||
};
|
||||
|
||||
match command.command {
|
||||
BuiltinCommand::Plan => {
|
||||
if !command.rest.is_empty() {
|
||||
self.say(session, command_usage(BuiltinCommand::Plan));
|
||||
return Ok(json!({ "stopReason": "end_turn" }));
|
||||
}
|
||||
let models = self.models().await?;
|
||||
let options = {
|
||||
let mut state = self.state.lock();
|
||||
let thread =
|
||||
state.threads.get_mut(session).ok_or_else(|| invalid(format!("no session {session}")))?;
|
||||
let settings = thread.settings.as_mut().ok_or_else(|| invalid(format!("no session {session}")))?;
|
||||
settings.collaboration_mode = if settings.collaboration_mode == translate::PLAN_COLLABORATION_MODE {
|
||||
translate::DEFAULT_COLLABORATION_MODE.to_owned()
|
||||
} else {
|
||||
translate::PLAN_COLLABORATION_MODE.to_owned()
|
||||
};
|
||||
settings.collaboration_mode_override = Some(settings.collaboration_mode.clone());
|
||||
translate::config_options(&models, settings)
|
||||
};
|
||||
self.emit(session, json!({ "sessionUpdate": "config_option_update", "configOptions": options }));
|
||||
}
|
||||
BuiltinCommand::Status => {
|
||||
let text =
|
||||
status_text(session, settings.as_ref(), cwd.as_deref(), token_usage.as_ref(), rate_limits.as_ref());
|
||||
self.say(session, text);
|
||||
}
|
||||
BuiltinCommand::Skills => {
|
||||
let cwd = cwd.ok_or_else(|| invalid(format!("no session {session}")))?;
|
||||
let found = self.call("skills/list", json!({ "cwds": [cwd] })).await?;
|
||||
self.say(session, skills_text(&found));
|
||||
}
|
||||
BuiltinCommand::Mcp => match command.rest.as_str() {
|
||||
"" => self.say(session, self.mcp_text(session).await?),
|
||||
rest if rest.eq_ignore_ascii_case("reconnect") => {
|
||||
self.call("config/mcpServer/reload", json!({})).await?;
|
||||
self.say(session, self.mcp_text(session).await?);
|
||||
}
|
||||
_ => self.say(session, command_usage(BuiltinCommand::Mcp)),
|
||||
},
|
||||
BuiltinCommand::Rename => {
|
||||
if command.rest.is_empty() {
|
||||
self.say(session, command_usage(BuiltinCommand::Rename));
|
||||
} else {
|
||||
self.call("thread/name/set", json!({ "threadId": session, "name": command.rest })).await?;
|
||||
// User commands are authoritative over the automatic title, so the manager
|
||||
// must retain this title through later generated-name updates.
|
||||
self.emit(
|
||||
session,
|
||||
json!({ "sessionUpdate": "session_info_update", "title": command.rest, "userNamed": true }),
|
||||
);
|
||||
}
|
||||
}
|
||||
BuiltinCommand::Logout => {
|
||||
self.call("account/logout", Value::Null).await?;
|
||||
self.say(session, "Logged out from Codex account.");
|
||||
}
|
||||
BuiltinCommand::Goal => self.goal_command(session, &command.rest).await?,
|
||||
BuiltinCommand::ReviewBranch | BuiltinCommand::ReviewCommit if command.rest.is_empty() => {
|
||||
self.say(session, command_usage(command.command));
|
||||
}
|
||||
BuiltinCommand::ReviewBranch | BuiltinCommand::ReviewCommit => {
|
||||
return Err(invalid("review command did not start a turn"));
|
||||
}
|
||||
BuiltinCommand::Review | BuiltinCommand::Compact => {
|
||||
return Err(invalid("turn command reached the local command path"));
|
||||
}
|
||||
}
|
||||
Ok(json!({ "stopReason": "end_turn" }))
|
||||
}
|
||||
|
||||
async fn goal_command(&self, session: &str, rest: &str) -> Result<(), ResponseError> {
|
||||
let argument = rest.trim();
|
||||
if argument.is_empty() {
|
||||
self.say(session, command_usage(BuiltinCommand::Goal));
|
||||
return Ok(());
|
||||
}
|
||||
match argument.to_ascii_lowercase().as_str() {
|
||||
"clear" => {
|
||||
self.call("thread/goal/clear", json!({ "threadId": session })).await?;
|
||||
self.say(session, "Goal cleared.");
|
||||
}
|
||||
"pause" => {
|
||||
let response = self
|
||||
.call("thread/goal/set", json!({ "threadId": session, "status": "paused", "origin": "user" }))
|
||||
.await?;
|
||||
self.say(
|
||||
session,
|
||||
format!(
|
||||
"Goal is now {}.",
|
||||
response.pointer("/goal/status").and_then(Value::as_str).unwrap_or("paused")
|
||||
),
|
||||
);
|
||||
}
|
||||
"resume" => {
|
||||
let response = self
|
||||
.call("thread/goal/set", json!({ "threadId": session, "status": "active", "origin": "user" }))
|
||||
.await?;
|
||||
self.say(
|
||||
session,
|
||||
format!(
|
||||
"Goal is now {}.",
|
||||
response.pointer("/goal/status").and_then(Value::as_str).unwrap_or("active")
|
||||
),
|
||||
);
|
||||
}
|
||||
_ if argument.chars().count() > 4000 => {
|
||||
self.say(session, "Command \"/goal\" requires goal text of at most 4000 characters.");
|
||||
}
|
||||
_ => {
|
||||
let response = self
|
||||
.call(
|
||||
"thread/goal/set",
|
||||
json!({ "threadId": session, "objective": argument, "status": "active", "origin": "user" }),
|
||||
)
|
||||
.await?;
|
||||
let status = response.pointer("/goal/status").and_then(Value::as_str).unwrap_or("active");
|
||||
self.say(session, format!("Goal set and {status}."));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn mcp_text(&self, session: &str) -> Result<String, ResponseError> {
|
||||
let response = self
|
||||
.call("mcpServerStatus/list", json!({ "threadId": session, "detail": "toolsAndAuthOnly", "limit": 100 }))
|
||||
.await?;
|
||||
Ok(mcp_text(&response))
|
||||
}
|
||||
|
||||
fn say(&self, session: &str, text: impl AsRef<str>) {
|
||||
self.emit(session, translate::chunk("agent_message_chunk", text.as_ref()));
|
||||
}
|
||||
|
||||
async fn steer(&self, params: &Value) -> Result<Value, ResponseError> {
|
||||
let session = str_param(params, "sessionId")?;
|
||||
let turn = self.state.lock().threads.get(session).and_then(|t| t.turn.clone());
|
||||
@@ -643,6 +862,25 @@ impl CodexShim {
|
||||
fn on_codex_notification(self: &Arc<Self>, method: &str, params: &Value) {
|
||||
let thread = params.get("threadId").and_then(Value::as_str).unwrap_or_default();
|
||||
match method {
|
||||
"configWarning" => {
|
||||
let Some(summary) = params.get("summary").and_then(Value::as_str).filter(|s| !s.trim().is_empty())
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let mut message = summary.trim().to_owned();
|
||||
for key in ["details", "path"] {
|
||||
if let Some(value) = params.get(key).and_then(Value::as_str).filter(|s| !s.trim().is_empty()) {
|
||||
message.push_str("\n\n");
|
||||
message.push_str(value.trim());
|
||||
}
|
||||
}
|
||||
self.warning(message);
|
||||
}
|
||||
"warning" => {
|
||||
if let Some(message) = params.get("message").and_then(Value::as_str).filter(|s| !s.trim().is_empty()) {
|
||||
self.warning(message);
|
||||
}
|
||||
}
|
||||
"skills/changed" => {
|
||||
let shim = self.clone();
|
||||
let sessions: Vec<String> = self
|
||||
@@ -693,7 +931,12 @@ impl CodexShim {
|
||||
t.last_chunk = None;
|
||||
Some(translate::plan(params))
|
||||
}),
|
||||
"thread/tokenUsage/updated" => self.with_thread(thread, |_, _| translate::usage(params)),
|
||||
"thread/tokenUsage/updated" => self.with_thread(thread, |t, _| {
|
||||
if let Some(usage) = params.get("tokenUsage") {
|
||||
t.token_usage = Some(usage.clone());
|
||||
}
|
||||
translate::usage(params)
|
||||
}),
|
||||
"thread/name/updated" => self.with_thread(thread, |t, _| {
|
||||
let title = params.get("threadName").and_then(Value::as_str)?;
|
||||
t.named = true;
|
||||
@@ -1182,3 +1425,114 @@ fn stop_reason(turn: &Value, last_error: Option<Value>, rate_limits: Option<&Val
|
||||
};
|
||||
Ok(json!({ "stopReason": stop }))
|
||||
}
|
||||
|
||||
/// The `review/start` target of a parsed review command.
|
||||
fn review_target(command: &ParsedCommand) -> Value {
|
||||
match command.command {
|
||||
BuiltinCommand::Review if command.rest.is_empty() => json!({ "type": "uncommittedChanges" }),
|
||||
BuiltinCommand::Review => json!({ "type": "custom", "instructions": command.rest }),
|
||||
BuiltinCommand::ReviewBranch => json!({ "type": "baseBranch", "branch": command.rest }),
|
||||
BuiltinCommand::ReviewCommit => json!({ "type": "commit", "sha": command.rest, "title": null }),
|
||||
_ => unreachable!("only review commands have review targets"),
|
||||
}
|
||||
}
|
||||
|
||||
fn command_usage(command: BuiltinCommand) -> String {
|
||||
match command {
|
||||
BuiltinCommand::Plan => "Command \"/plan\" accepts no arguments.".to_owned(),
|
||||
BuiltinCommand::Mcp => "Command \"/mcp\" accepts no arguments, or `reconnect`.".to_owned(),
|
||||
BuiltinCommand::ReviewBranch => "Command \"/review-branch\" requires branch name.".to_owned(),
|
||||
BuiltinCommand::ReviewCommit => "Command \"/review-commit\" requires commit sha.".to_owned(),
|
||||
BuiltinCommand::Goal => "Command \"/goal\" requires [<objective>|clear|pause|resume].".to_owned(),
|
||||
BuiltinCommand::Rename => "Command \"/rename\" requires new name.".to_owned(),
|
||||
_ => "This command does not accept arguments.".to_owned(),
|
||||
}
|
||||
}
|
||||
|
||||
fn status_text(
|
||||
session: &str,
|
||||
settings: Option<&Settings>,
|
||||
cwd: Option<&str>,
|
||||
token_usage: Option<&Value>,
|
||||
rate_limits: Option<&Value>,
|
||||
) -> String {
|
||||
let mut lines = Vec::new();
|
||||
if let Some(settings) = settings {
|
||||
lines.push(format!("**Model:** {}", settings.model));
|
||||
lines.push(format!("**Collaboration:** {}", settings.collaboration_mode));
|
||||
lines.push(format!("**Approval:** {}", settings.mode.approval_policy()));
|
||||
lines.push(format!("**Sandbox:** {}", settings.mode.sandbox_mode()));
|
||||
}
|
||||
if let Some(cwd) = cwd {
|
||||
lines.push(format!("**Directory:** {cwd}"));
|
||||
}
|
||||
lines.push(format!("**Session:** `{session}`"));
|
||||
if let Some(usage) = token_usage {
|
||||
let total = usage.pointer("/total/totalTokens").and_then(Value::as_u64);
|
||||
let used = usage.pointer("/last/totalTokens").and_then(Value::as_u64);
|
||||
let window = usage.get("modelContextWindow").and_then(Value::as_u64).filter(|window| *window > 0);
|
||||
if let (Some(total), Some(used), Some(window)) = (total, used, window) {
|
||||
let percent = (used.saturating_mul(100) + window / 2) / window;
|
||||
lines.push(format!("**Token usage:** {total} total"));
|
||||
lines.push(format!("**Context window:** {used} / {window} ({percent}%)"));
|
||||
}
|
||||
}
|
||||
if let Some(primary) = rate_limits.and_then(|r| r.get("primary"))
|
||||
&& let Some(used) = primary.get("usedPercent").and_then(Value::as_f64)
|
||||
{
|
||||
lines.push(format!("**Rate limit:** {used:.0}% used"));
|
||||
}
|
||||
lines.join(" \n")
|
||||
}
|
||||
|
||||
fn skills_text(response: &Value) -> String {
|
||||
let mut seen = HashSet::new();
|
||||
let names: Vec<String> = response
|
||||
.get("data")
|
||||
.and_then(Value::as_array)
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.filter_map(|entry| entry.get("skills").and_then(Value::as_array))
|
||||
.flatten()
|
||||
.filter(|skill| skill.get("enabled") != Some(&Value::Bool(false)))
|
||||
.filter_map(|skill| {
|
||||
let name = skill.get("name").and_then(Value::as_str)?.trim();
|
||||
if name.is_empty() || !seen.insert(name.to_owned()) {
|
||||
return None;
|
||||
}
|
||||
let description = skill
|
||||
.pointer("/interface/shortDescription")
|
||||
.or_else(|| skill.get("shortDescription"))
|
||||
.or_else(|| skill.get("description"))
|
||||
.and_then(Value::as_str)
|
||||
.unwrap_or_default();
|
||||
Some(if description.is_empty() { name.to_owned() } else { format!("{name}: {description}") })
|
||||
})
|
||||
.collect();
|
||||
if names.is_empty() {
|
||||
"No skills configured.".to_owned()
|
||||
} else {
|
||||
format!("Available skills:\n{}", names.iter().map(|name| format!("- {name}")).collect::<Vec<_>>().join("\n"))
|
||||
}
|
||||
}
|
||||
|
||||
fn mcp_text(response: &Value) -> String {
|
||||
let servers = response.get("data").and_then(Value::as_array).map(Vec::as_slice).unwrap_or_default();
|
||||
if servers.is_empty() {
|
||||
return "No MCP servers configured.".to_owned();
|
||||
}
|
||||
let lines = servers
|
||||
.iter()
|
||||
.filter_map(|server| {
|
||||
let name = server.get("name").and_then(Value::as_str)?;
|
||||
let status = server
|
||||
.get("runtimeStatus")
|
||||
.and_then(Value::as_str)
|
||||
.or_else(|| server.get("authStatus").and_then(Value::as_str))
|
||||
.unwrap_or("unknown");
|
||||
let tools = server.get("tools").and_then(Value::as_object).map_or(0, serde_json::Map::len);
|
||||
Some(format!("- {name}: {status}, {tools} tools"))
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
format!("MCP servers:\n{}", lines.join("\n"))
|
||||
}
|
||||
@@ -180,24 +180,38 @@ fn settings_follow_the_thread_and_the_models() {
|
||||
let result = json!({"model": "big", "reasoningEffort": null, "approvalPolicy": "untrusted",
|
||||
"sandbox": {"type": "workspaceWrite"}});
|
||||
let mut s = Settings::of(&result, &models);
|
||||
assert_eq!(s, Settings { model: "big".into(), effort: Some("low".into()), mode: Mode::Ask });
|
||||
assert_eq!(
|
||||
s,
|
||||
Settings {
|
||||
model: "big".into(),
|
||||
effort: Some("low".into()),
|
||||
mode: Mode::Ask,
|
||||
collaboration_mode: DEFAULT_COLLABORATION_MODE.into(),
|
||||
collaboration_mode_override: None,
|
||||
}
|
||||
);
|
||||
|
||||
let options = config_options(&models, &s);
|
||||
let ids: Vec<&str> = options.as_array().unwrap().iter().map(|o| o["id"].as_str().unwrap()).collect();
|
||||
assert_eq!(ids, [MODEL, EFFORT, MODE]);
|
||||
assert_eq!(ids, [MODEL, EFFORT, MODE, COLLABORATION_MODE]);
|
||||
assert_eq!(options[0]["options"].as_array().unwrap().len(), 2, "hidden models are left out");
|
||||
assert_eq!(options[1]["category"], "thought_level");
|
||||
assert_eq!(options[1]["options"][1]["name"], "Extra high");
|
||||
assert_eq!(options[2]["currentValue"], "ask");
|
||||
assert_eq!(options[3]["currentValue"], "default");
|
||||
|
||||
// A model without efforts drops the option; its slug is what codex gets.
|
||||
s.set(&models, MODEL, "plain").unwrap();
|
||||
assert_eq!((s.effort.as_deref(), s.model_slug(&models).as_str()), (None, "plain-slug"));
|
||||
assert_eq!(config_options(&models, &s).as_array().unwrap().len(), 2);
|
||||
assert_eq!(config_options(&models, &s).as_array().unwrap().len(), 3);
|
||||
assert!(s.set(&models, EFFORT, "low").is_err());
|
||||
assert!(s.set(&models, MODEL, "nope").is_err());
|
||||
s.set(&models, MODE, "full-access").unwrap();
|
||||
assert_eq!((s.mode.approval_policy(), s.mode.sandbox_policy()), ("never", json!({"type": "dangerFullAccess"})));
|
||||
s.set(&models, COLLABORATION_MODE, PLAN_COLLABORATION_MODE).unwrap();
|
||||
assert_eq!(collaboration_mode(&s, &models)["mode"], PLAN_COLLABORATION_MODE);
|
||||
s.set(&models, COLLABORATION_MODE, DEFAULT_COLLABORATION_MODE).unwrap();
|
||||
assert_eq!(collaboration_mode(&s, &models)["mode"], DEFAULT_COLLABORATION_MODE);
|
||||
|
||||
// A model codex runs that it doesn't list is still offered.
|
||||
let s = Settings::of(&json!({"model": "custom", "sandbox": {"type": "readOnly"}}), &models);
|
||||
@@ -226,6 +240,18 @@ fn prompts_become_user_input() {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compact_is_recognized_with_completion_whitespace_and_attachments() {
|
||||
// Completion leaves trailing whitespace and images can remain in the prompt. The first
|
||||
// text block still names the command; unknown slash-shaped text continues normally.
|
||||
assert_eq!(commands::parse(&text("/compact")).unwrap().command, BuiltinCommand::Compact);
|
||||
assert_eq!(commands::parse(&text(" /compact \n")).unwrap().command, BuiltinCommand::Compact);
|
||||
assert_eq!(commands::parse(&text("/compact now")).unwrap().rest, "now");
|
||||
let prompt = json!([{"type": "text", "text": "/compact"}, {"type": "image", "data": "AA=="}]);
|
||||
assert_eq!(commands::parse(&prompt).unwrap().command, BuiltinCommand::Compact);
|
||||
assert!(commands::parse(&text("x/compact")).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn commands_are_titled_by_what_they_do() {
|
||||
let cmd = |actions: Value| {
|
||||
@@ -453,6 +479,7 @@ fn history_replays_turns() {
|
||||
#[derive(Default)]
|
||||
struct Client {
|
||||
updates: Mutex<Vec<Value>>,
|
||||
warnings: Mutex<Vec<Value>>,
|
||||
asked: Mutex<Vec<Value>>,
|
||||
/// Option ids to choose; `None` (or none left) cancels.
|
||||
answers: Mutex<VecDeque<Option<&'static str>>>,
|
||||
@@ -462,6 +489,8 @@ impl Handler for Client {
|
||||
fn on_notification(&self, method: &str, params: Value) {
|
||||
if method == "session/update" {
|
||||
self.updates.lock().push(params);
|
||||
} else if method == "_openidea/warning" {
|
||||
self.warnings.lock().push(params);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -527,6 +556,10 @@ async fn questions_share_one_card_and_keep_their_ids() {
|
||||
#[derive(Clone, Copy, Debug, PartialEq)]
|
||||
enum Scenario {
|
||||
AuthFailure,
|
||||
Command(&'static str),
|
||||
Compact,
|
||||
PlanThenPrompt,
|
||||
PlanToggleThenPrompt,
|
||||
Interrupt,
|
||||
Resume,
|
||||
Steer,
|
||||
@@ -541,6 +574,10 @@ impl Scenario {
|
||||
fn file(self) -> &'static str {
|
||||
match self {
|
||||
Scenario::AuthFailure => "auth_failure",
|
||||
Scenario::Command(_) => "simple",
|
||||
Scenario::Compact => "simple",
|
||||
Scenario::PlanThenPrompt => "simple",
|
||||
Scenario::PlanToggleThenPrompt => "simple",
|
||||
Scenario::Interrupt => "interrupt",
|
||||
Scenario::Resume => "resume",
|
||||
Scenario::Steer => "steer",
|
||||
@@ -598,6 +635,21 @@ async fn drive(scenario: Scenario, acp: &Peer, client: &Client, cwd: &str, threa
|
||||
Scenario::AuthFailure | Scenario::Simple | Scenario::UsageLimit | Scenario::Subagent => {
|
||||
out.push(("prompt", request(acp, "session/prompt", prompt("Reply with the single word: hi")).await));
|
||||
}
|
||||
Scenario::Compact => {
|
||||
out.push(("prompt", request(acp, "session/prompt", prompt("/compact")).await));
|
||||
}
|
||||
Scenario::Command(command) => {
|
||||
out.push(("prompt", request(acp, "session/prompt", prompt(command)).await));
|
||||
}
|
||||
Scenario::PlanThenPrompt => {
|
||||
out.push(("plan", request(acp, "session/prompt", prompt("/plan")).await));
|
||||
out.push(("prompt", request(acp, "session/prompt", prompt("Reply with the single word: hi")).await));
|
||||
}
|
||||
Scenario::PlanToggleThenPrompt => {
|
||||
out.push(("plan", request(acp, "session/prompt", prompt("/plan")).await));
|
||||
out.push(("default", request(acp, "session/prompt", prompt("/plan")).await));
|
||||
out.push(("prompt", request(acp, "session/prompt", prompt("Reply with the single word: hi")).await));
|
||||
}
|
||||
Scenario::Interrupt => {
|
||||
out.push(("mode", request(acp, "session/set_config_option", set(MODE, "read-only")).await));
|
||||
let running = {
|
||||
@@ -665,6 +717,37 @@ fn load(name: &str) -> Transcript {
|
||||
Transcript { meta, frames }
|
||||
}
|
||||
|
||||
/// The simple fixture through session setup. Local commands add only the app-server calls
|
||||
/// they need after it; turn commands keep the fixture's turn notifications.
|
||||
fn command_transcript(calls: &[(&'static str, Value)]) -> Transcript {
|
||||
let mut transcript = load(Scenario::Simple.file());
|
||||
let prompt = transcript
|
||||
.frames
|
||||
.iter()
|
||||
.position(|(out, frame)| *out && frame["method"] == "turn/start")
|
||||
.expect("the scenario starts a turn");
|
||||
transcript.frames.truncate(prompt);
|
||||
transcript.frames.push((true, json!({ "id": 4, "method": "skills/list" })));
|
||||
transcript.frames.push((false, json!({ "id": 4, "result": { "data": [] } })));
|
||||
for (index, (method, result)) in calls.iter().enumerate() {
|
||||
let id = 10 + index;
|
||||
transcript.frames.push((true, json!({ "id": id, "method": method })));
|
||||
transcript.frames.push((false, json!({ "id": id, "result": result })));
|
||||
}
|
||||
transcript
|
||||
}
|
||||
|
||||
fn turn_command_transcript(method: &str) -> Transcript {
|
||||
let mut transcript = load(Scenario::Simple.file());
|
||||
let start = transcript
|
||||
.frames
|
||||
.iter_mut()
|
||||
.find(|(out, frame)| *out && frame["method"] == "turn/start")
|
||||
.expect("the scenario starts a turn");
|
||||
start.1["method"] = json!(method);
|
||||
transcript
|
||||
}
|
||||
|
||||
/// Plays codex: waits for each frame the shim should send, sends what codex sent.
|
||||
/// Returns the frames the shim sent.
|
||||
async fn play<R: AsyncRead + Unpin, W: AsyncWrite + Unpin>(
|
||||
@@ -684,10 +767,10 @@ async fn play<R: AsyncRead + Unpin, W: AsyncWrite + Unpin>(
|
||||
.unwrap()
|
||||
.unwrap_or_else(|| panic!("the shim closed before {frame}"));
|
||||
let actual: Value = serde_json::from_str(&line).unwrap();
|
||||
// Older recordings predate skill discovery and thread naming; play an
|
||||
// Older recordings predate config inspection, skill discovery and thread naming; play an
|
||||
// unsupported server.
|
||||
let method = actual["method"].as_str().unwrap_or_default();
|
||||
if matches!(method, "skills/list" | "thread/sample") && frame["method"] != method {
|
||||
if matches!(method, "config/read" | "skills/list" | "thread/sample") && frame["method"] != method {
|
||||
let reply = json!({ "id": actual["id"], "error": { "code": -32601, "message": "unsupported" } });
|
||||
write.write_all(format!("{reply}\n").as_bytes()).await.unwrap();
|
||||
continue;
|
||||
@@ -760,6 +843,149 @@ fn session_of(results: &Results, label: &str) -> String {
|
||||
result(results, label).as_ref().unwrap()["sessionId"].as_str().unwrap().to_owned()
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn configuration_warnings_before_a_session_and_runtime_warnings_reach_the_client() {
|
||||
let mut transcript = load(Scenario::Simple.file());
|
||||
transcript.frames.insert(
|
||||
0,
|
||||
(
|
||||
false,
|
||||
json!({"method": "configWarning", "params": {
|
||||
"summary": "Project-local config is disabled until the project is trusted.",
|
||||
"details": "Update the project's trust setting.", "path": "/work/.codex/config.toml"
|
||||
}}),
|
||||
),
|
||||
);
|
||||
let at = transcript.frames.iter().position(|(out, f)| *out && f["method"] == "turn/start").unwrap();
|
||||
transcript
|
||||
.frames
|
||||
.insert(at, (false, json!({"method": "warning", "params": {"message": "MCP server unavailable"}})));
|
||||
let (results, client, frames, _, _codex) = replay_transcript(Scenario::Simple, transcript).await;
|
||||
assert!(result(&results, "new").is_ok());
|
||||
assert_eq!(
|
||||
*client.warnings.lock(),
|
||||
[
|
||||
json!({"message": "Project-local config is disabled until the project is trusted.\n\nUpdate the project's trust setting.\n\n/work/.codex/config.toml"}),
|
||||
json!({"message": "MCP server unavailable"}),
|
||||
]
|
||||
);
|
||||
assert!(sent(&frames, "config/value/write").is_empty());
|
||||
assert!(sent(&frames, "config/batchWrite").is_empty());
|
||||
}
|
||||
|
||||
struct TrustServer {
|
||||
cwd: String,
|
||||
disabled: bool,
|
||||
other_project: bool,
|
||||
write_error: bool,
|
||||
overridden: bool,
|
||||
calls: Mutex<Vec<(String, Value)>>,
|
||||
}
|
||||
|
||||
impl Handler for TrustServer {
|
||||
fn on_notification(&self, _: &str, _: Value) {}
|
||||
|
||||
fn on_request(&self, method: &str, params: Value) -> Result<Value, (i64, String)> {
|
||||
self.calls.lock().push((method.to_owned(), params));
|
||||
match method {
|
||||
"initialize" => Ok(json!({})),
|
||||
"model/list" => Ok(json!({"data": []})),
|
||||
"config/read" => {
|
||||
let cwd =
|
||||
if self.other_project { Path::new(&self.cwd).join("other") } else { PathBuf::from(&self.cwd) };
|
||||
Ok(json!({"layers": [
|
||||
{"name": {"type": "user", "profile": null}, "version": "original"},
|
||||
{"name": {"type": "project", "dotCodexFolder": cwd.join(".codex")},
|
||||
"disabledReason": self.disabled.then_some("Project config is disabled until trusted.")}
|
||||
]}))
|
||||
}
|
||||
"config/value/write" if self.write_error => Err((-32001, "Config changed concurrently".into())),
|
||||
"config/value/write" => Ok(json!({"status": if self.overridden {"okOverridden"} else {"ok"}})),
|
||||
"thread/start" | "thread/resume" | "thread/fork" => {
|
||||
Ok(json!({"thread": {"id": "s", "turns": []}, "cwd": self.cwd}))
|
||||
}
|
||||
"skills/list" => Ok(json!({"data": []})),
|
||||
_ => Err((codes::METHOD_NOT_FOUND, method.to_owned())),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn project_trust_is_confirmed_before_new_resumed_and_forked_sessions() {
|
||||
for method in ["session/new", "session/load", "session/fork"] {
|
||||
for (answer, disabled, other_project, write_error, overridden) in [
|
||||
(Some("codex-trust-project"), true, false, false, false),
|
||||
(Some("codex-keep-untrusted"), true, false, false, false),
|
||||
(None, true, false, false, false),
|
||||
(Some("codex-trust-project"), false, false, false, false),
|
||||
(Some("codex-trust-project"), true, true, false, false),
|
||||
(Some("codex-trust-project"), true, false, true, false),
|
||||
(Some("codex-trust-project"), true, false, false, true),
|
||||
] {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let cwd = tmp.path().join("project.with.dots-项目").to_string_lossy().into_owned();
|
||||
let server = Arc::new(TrustServer {
|
||||
cwd: cwd.clone(),
|
||||
disabled,
|
||||
other_project,
|
||||
write_error,
|
||||
overridden,
|
||||
calls: Mutex::default(),
|
||||
});
|
||||
let client = Arc::new(Client::default());
|
||||
client.answers.lock().push_back(answer);
|
||||
let (ours, theirs) = tokio::io::duplex(1 << 16);
|
||||
let (read, write) = tokio::io::split(theirs);
|
||||
let native = Peer::connect_framed(read, write, server.clone(), Framing::Lines);
|
||||
let acp = attach(client.clone(), |events| {
|
||||
let (read, write) = tokio::io::split(ours);
|
||||
Ok(Peer::connect_framed(read, write, events, Framing::Lines))
|
||||
})
|
||||
.unwrap();
|
||||
request(&acp, "initialize", json!({})).await.unwrap();
|
||||
let params = json!({"cwd": cwd, "sessionId": "source", "mcpServers": []});
|
||||
request(&acp, method, params.clone()).await.unwrap();
|
||||
// The same connection must not ask repeatedly after a decline.
|
||||
request(&acp, method, params).await.unwrap();
|
||||
let approved = answer == Some("codex-trust-project") && disabled && !other_project;
|
||||
{
|
||||
let asked = client.asked.lock();
|
||||
assert_eq!(asked.len(), usize::from(disabled && !other_project));
|
||||
if let Some(permission) = asked.first() {
|
||||
assert!(permission["toolCall"]["title"].as_str().unwrap().contains(&cwd));
|
||||
assert_eq!(
|
||||
permission["toolCall"]["kind"], "edit",
|
||||
"side conversations must deny persistent trust changes"
|
||||
);
|
||||
assert_eq!(
|
||||
permission["options"][0]["kind"], "allow_always",
|
||||
"task bypass must not grant permanent trust"
|
||||
);
|
||||
}
|
||||
let calls = server.calls.lock();
|
||||
let writes: Vec<_> = calls.iter().filter(|(m, _)| m == "config/value/write").collect();
|
||||
assert_eq!(writes.len(), usize::from(approved));
|
||||
if let Some((_, write)) = writes.first() {
|
||||
assert_eq!(
|
||||
*write,
|
||||
json!({"keyPath": format!("projects.{}.trust_level", json!(cwd)), "value": "trusted", "mergeStrategy": "replace", "expectedVersion": "original"})
|
||||
);
|
||||
let written = calls.iter().position(|(m, _)| m == "config/value/write").unwrap();
|
||||
let started = calls.iter().position(|(m, _)| m.starts_with("thread/")).unwrap();
|
||||
assert!(written < started, "the session must load config after the write");
|
||||
}
|
||||
}
|
||||
// Drain notifications sent before the last response.
|
||||
tokio::time::sleep(Duration::from_millis(20)).await;
|
||||
if approved && (write_error || overridden) {
|
||||
assert!(!client.warnings.lock().is_empty());
|
||||
}
|
||||
acp.kill();
|
||||
native.kill();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn auth_failure_names_auth() {
|
||||
let (results, _client, frames, _) = replay(Scenario::AuthFailure).await;
|
||||
@@ -771,7 +997,7 @@ async fn auth_failure_names_auth() {
|
||||
let categories: Vec<&str> =
|
||||
new["configOptions"].as_array().unwrap().iter().map(|o| o["category"].as_str().unwrap()).collect();
|
||||
// The model the user's codex config names; codex doesn't list it, so its efforts are unknown.
|
||||
assert_eq!(categories, ["model", "mode"]);
|
||||
assert_eq!(categories, ["model", "mode", "collaboration_mode"]);
|
||||
let model = new["configOptions"][0]["currentValue"].as_str().unwrap();
|
||||
assert_eq!(model, "gpt-6-luna");
|
||||
assert!(new["configOptions"][0]["options"].as_array().unwrap().iter().any(|o| o["value"] == model));
|
||||
@@ -1011,6 +1237,7 @@ async fn settings_apply_to_the_next_turn() {
|
||||
(starts[0]["params"]["model"].as_str(), starts[0]["params"]["effort"].as_str()),
|
||||
(Some("gpt-5.6-luna"), Some("medium"))
|
||||
);
|
||||
assert!(starts[0]["params"].get("collaborationMode").is_none());
|
||||
assert_eq!(
|
||||
(starts[1]["params"]["model"].as_str(), starts[1]["params"]["effort"].as_str()),
|
||||
(Some("gpt-5.5"), Some("high"))
|
||||
@@ -1019,6 +1246,192 @@ async fn settings_apply_to_the_next_turn() {
|
||||
assert_eq!(client.text(&session, "agent_message_chunk"), "oneOn it.\n\ntwo");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn compact_is_started_through_its_app_server_method() {
|
||||
// Play the ordinary-turn fixture with the request swapped: the notifications are the
|
||||
// same, while this pins the user-visible command to `thread/compact/start`, not a prompt.
|
||||
let mut transcript = load(Scenario::Simple.file());
|
||||
let start = transcript
|
||||
.frames
|
||||
.iter_mut()
|
||||
.find(|(out, frame)| *out && frame["method"] == "turn/start")
|
||||
.expect("the scenario starts a turn");
|
||||
start.1["method"] = json!("thread/compact/start");
|
||||
let (results, _client, frames, _meta, _codex) = replay_transcript(Scenario::Compact, transcript).await;
|
||||
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({"stopReason": "end_turn"}));
|
||||
assert!(sent(&frames, "turn/start").is_empty());
|
||||
assert_eq!(sent(&frames, "thread/compact/start").len(), 1);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn review_commands_start_the_matching_review_target() {
|
||||
for (prompt, target) in [
|
||||
("/review", json!({ "type": "uncommittedChanges" })),
|
||||
("/review focus on errors", json!({ "type": "custom", "instructions": "focus on errors" })),
|
||||
("/review-branch origin/main", json!({ "type": "baseBranch", "branch": "origin/main" })),
|
||||
("/review-commit abc123", json!({ "type": "commit", "sha": "abc123", "title": null })),
|
||||
] {
|
||||
let (results, _client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command(prompt), turn_command_transcript("review/start")).await;
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }), "{prompt}");
|
||||
assert!(sent(&frames, "turn/start").is_empty(), "{prompt}");
|
||||
assert_eq!(sent(&frames, "review/start")[0]["params"]["target"], target, "{prompt}");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn plan_toggles_collaboration_mode_and_updates_the_composer() {
|
||||
let (results, client, _frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command("/plan"), command_transcript(&[])).await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
let update = client.of(&session).into_iter().find(|u| u["sessionUpdate"] == "config_option_update").unwrap();
|
||||
let plan =
|
||||
update["configOptions"].as_array().unwrap().iter().find(|o| o["category"] == "collaboration_mode").unwrap();
|
||||
assert_eq!(plan["currentValue"], "plan");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn plan_applies_to_the_next_normal_turn() {
|
||||
let (results, _client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::PlanThenPrompt, load(Scenario::Simple.file())).await;
|
||||
assert_eq!(result(&results, "plan").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
let start = sent(&frames, "turn/start")[0];
|
||||
assert_eq!(start["params"]["collaborationMode"]["mode"], "plan");
|
||||
assert_eq!(start["params"]["collaborationMode"]["settings"]["model"], "gpt-5.6-luna");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn toggling_plan_off_sends_an_explicit_default_once() {
|
||||
let (results, _client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::PlanToggleThenPrompt, load(Scenario::Simple.file())).await;
|
||||
assert_eq!(result(&results, "default").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
let start = sent(&frames, "turn/start")[0];
|
||||
assert_eq!(start["params"]["collaborationMode"]["mode"], "default");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn informational_commands_report_skills_mcp_and_status() {
|
||||
let skills = json!({ "data": [{ "skills": [
|
||||
{ "name": "review", "enabled": true, "description": "Review changes" },
|
||||
{ "name": "hidden", "enabled": false, "description": "Hidden" }
|
||||
] }] });
|
||||
let servers = json!({ "data": [
|
||||
{ "name": "github", "runtimeStatus": "connected", "authStatus": "oAuth", "tools": { "search": {} } },
|
||||
{ "name": "docs", "runtimeStatus": "failed", "authStatus": "unknown", "tools": {} }
|
||||
] });
|
||||
for (prompt, method, response, expected) in [
|
||||
("/skills", "skills/list", skills, "Available skills:\n- review: Review changes"),
|
||||
(
|
||||
"/mcp",
|
||||
"mcpServerStatus/list",
|
||||
servers,
|
||||
"MCP servers:\n- github: connected, 1 tools\n- docs: failed, 0 tools",
|
||||
),
|
||||
("/status", "", Value::Null, "**Session:**"),
|
||||
] {
|
||||
let calls: &[(&str, Value)] = if method.is_empty() { &[] } else { &[(method, response)] };
|
||||
let calls: Vec<(&'static str, Value)> = calls
|
||||
.iter()
|
||||
.map(|(method, response)| {
|
||||
let method = match *method {
|
||||
"skills/list" => "skills/list",
|
||||
"mcpServerStatus/list" => "mcpServerStatus/list",
|
||||
other => panic!("unexpected method {other}"),
|
||||
};
|
||||
(method, response.clone())
|
||||
})
|
||||
.collect();
|
||||
let (results, client, _frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command(prompt), command_transcript(&calls)).await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
assert!(client.text(&session, "agent_message_chunk").contains(expected), "{prompt}");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn rename_and_logout_use_their_app_server_actions() {
|
||||
let (results, client, frames, _meta, _codex) = replay_transcript(
|
||||
Scenario::Command("/rename Better name"),
|
||||
command_transcript(&[("thread/name/set", json!({}))]),
|
||||
)
|
||||
.await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(sent(&frames, "thread/name/set")[0]["params"], json!({ "threadId": session, "name": "Better name" }));
|
||||
let info = client.of(&session).into_iter().find(|u| u["sessionUpdate"] == "session_info_update").unwrap();
|
||||
assert_eq!((info["title"].as_str(), info["userNamed"].as_bool()), (Some("Better name"), Some(true)));
|
||||
|
||||
let (results, client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command("/logout"), command_transcript(&[("account/logout", json!({}))])).await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(sent(&frames, "account/logout").len(), 1);
|
||||
assert_eq!(client.text(&session, "agent_message_chunk"), "Logged out from Codex account.");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn goal_commands_set_pause_resume_and_clear_through_app_server() {
|
||||
for (prompt, method, params, result) in [
|
||||
(
|
||||
"/goal fix the failing tests",
|
||||
"thread/goal/set",
|
||||
json!({ "threadId": "s", "objective": "fix the failing tests", "status": "active", "origin": "user" }),
|
||||
json!({ "goal": { "status": "active" } }),
|
||||
),
|
||||
(
|
||||
"/goal pause",
|
||||
"thread/goal/set",
|
||||
json!({ "threadId": "s", "status": "paused", "origin": "user" }),
|
||||
json!({ "goal": { "status": "paused" } }),
|
||||
),
|
||||
(
|
||||
"/goal resume",
|
||||
"thread/goal/set",
|
||||
json!({ "threadId": "s", "status": "active", "origin": "user" }),
|
||||
json!({ "goal": { "status": "active" } }),
|
||||
),
|
||||
("/goal clear", "thread/goal/clear", json!({ "threadId": "s" }), json!({ "cleared": true })),
|
||||
] {
|
||||
let (results, _client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command(prompt), command_transcript(&[(method, result)])).await;
|
||||
let session = session_of(&results, "new");
|
||||
let sent = sent(&frames, method);
|
||||
assert_eq!(sent.len(), 1, "{prompt}");
|
||||
let mut expected = params;
|
||||
expected["threadId"] = json!(session);
|
||||
assert_eq!(sent[0]["params"], expected, "{prompt}");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn missing_review_arguments_print_usage_without_starting_a_turn() {
|
||||
for prompt in ["/review-branch", "/review-commit", "/rename", "/goal"] {
|
||||
let (results, client, frames, _meta, _codex) =
|
||||
replay_transcript(Scenario::Command(prompt), command_transcript(&[])).await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(result(&results, "prompt").as_ref().unwrap(), &json!({ "stopReason": "end_turn" }));
|
||||
assert!(sent(&frames, "turn/start").is_empty());
|
||||
assert!(client.text(&session, "agent_message_chunk").starts_with("Command \""), "{prompt}");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn mcp_reconnect_reloads_before_reporting_status() {
|
||||
let servers =
|
||||
json!({ "data": [{ "name": "github", "runtimeStatus": "connected", "authStatus": "oAuth", "tools": {} }] });
|
||||
let (results, client, frames, _meta, _codex) = replay_transcript(
|
||||
Scenario::Command("/mcp reconnect"),
|
||||
command_transcript(&[("config/mcpServer/reload", json!({})), ("mcpServerStatus/list", servers)]),
|
||||
)
|
||||
.await;
|
||||
let session = session_of(&results, "new");
|
||||
assert_eq!(sent(&frames, "config/mcpServer/reload").len(), 1);
|
||||
assert_eq!(sent(&frames, "mcpServerStatus/list").len(), 1);
|
||||
assert!(client.text(&session, "agent_message_chunk").contains("github: connected"));
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn approvals_are_asked_and_answered() {
|
||||
let (results, client, frames, _) = replay(Scenario::Approvals).await;
|
||||
|
||||
@@ -138,6 +138,12 @@ pub(super) struct Settings {
|
||||
pub model: String,
|
||||
pub effort: Option<String>,
|
||||
pub mode: Mode,
|
||||
/// Codex's Default/Plan collaboration mode. It is sent with each turn because it is
|
||||
/// part of the turn contract rather than the sandbox permission mode above.
|
||||
pub collaboration_mode: String,
|
||||
/// A mode just chosen by the user, sent once even when it is Default so a resumed Plan
|
||||
/// thread is explicitly reset. Subsequent default turns can omit the field again.
|
||||
pub collaboration_mode_override: Option<String>,
|
||||
}
|
||||
|
||||
impl Settings {
|
||||
@@ -156,6 +162,12 @@ impl Settings {
|
||||
result.get("approvalPolicy").unwrap_or(&Value::Null),
|
||||
result.get("sandbox").unwrap_or(&Value::Null),
|
||||
),
|
||||
collaboration_mode: result
|
||||
.pointer("/collaborationMode/mode")
|
||||
.and_then(Value::as_str)
|
||||
.unwrap_or(DEFAULT_COLLABORATION_MODE)
|
||||
.to_owned(),
|
||||
collaboration_mode_override: None,
|
||||
};
|
||||
s.fit_effort(models);
|
||||
s
|
||||
@@ -194,6 +206,13 @@ impl Settings {
|
||||
self.effort = Some(value.to_owned());
|
||||
}
|
||||
MODE => self.mode = Mode::parse(value).ok_or_else(|| format!("unknown mode {value}"))?,
|
||||
COLLABORATION_MODE => {
|
||||
if !matches!(value, DEFAULT_COLLABORATION_MODE | PLAN_COLLABORATION_MODE) {
|
||||
return Err(format!("unknown collaboration mode {value}"));
|
||||
}
|
||||
self.collaboration_mode = value.to_owned();
|
||||
self.collaboration_mode_override = Some(value.to_owned());
|
||||
}
|
||||
_ => return Err(format!("unknown setting {option}")),
|
||||
}
|
||||
Ok(())
|
||||
@@ -203,6 +222,9 @@ impl Settings {
|
||||
pub(super) const MODEL: &str = "model";
|
||||
pub(super) const EFFORT: &str = "reasoning_effort";
|
||||
pub(super) const MODE: &str = "mode";
|
||||
pub(super) const COLLABORATION_MODE: &str = "collaboration_mode";
|
||||
pub(super) const DEFAULT_COLLABORATION_MODE: &str = "default";
|
||||
pub(super) const PLAN_COLLABORATION_MODE: &str = "plan";
|
||||
|
||||
/// ACP `configOptions`: model, reasoning effort (for models that have it) and mode.
|
||||
pub(super) fn config_options(models: &[ModelInfo], s: &Settings) -> Value {
|
||||
@@ -235,9 +257,32 @@ pub(super) fn config_options(models: &[ModelInfo], s: &Settings) -> Value {
|
||||
"id": MODE, "name": "Mode", "category": "mode", "type": "select", "currentValue": s.mode.id(),
|
||||
"options": Mode::ALL.iter().map(|m| select_value(m.id(), m.name(), Some(m.description()))).collect::<Vec<_>>(),
|
||||
}));
|
||||
out.push(json!({
|
||||
"id": COLLABORATION_MODE,
|
||||
"name": "Collaboration mode",
|
||||
"category": "collaboration_mode",
|
||||
"type": "select",
|
||||
"currentValue": s.collaboration_mode,
|
||||
"options": [
|
||||
select_value(DEFAULT_COLLABORATION_MODE, "Default", Some("Execute changes directly")),
|
||||
select_value(PLAN_COLLABORATION_MODE, "Plan", Some("Plan before making changes")),
|
||||
],
|
||||
}));
|
||||
Value::Array(out)
|
||||
}
|
||||
|
||||
/// `turn/start.collaborationMode`: the preset plus the selected model settings.
|
||||
pub(super) fn collaboration_mode(settings: &Settings, models: &[ModelInfo]) -> Value {
|
||||
json!({
|
||||
"mode": settings.collaboration_mode_override.as_deref().unwrap_or(&settings.collaboration_mode),
|
||||
"settings": {
|
||||
"model": settings.model_slug(models),
|
||||
"reasoning_effort": settings.effort,
|
||||
"developer_instructions": null,
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
fn select_value(value: &str, name: &str, description: Option<&str>) -> Value {
|
||||
let mut v = json!({ "value": value, "name": name });
|
||||
if let Some(d) = description {
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
//! A project trusted by the IDE may still be untrusted by Codex. Ask before changing
|
||||
//! Codex's own decision; only its config API writes the current project's trust entry.
|
||||
|
||||
use super::*;
|
||||
|
||||
fn disabled_project<'a>(config: &'a Value, cwd: &str) -> Option<&'a Value> {
|
||||
let folder = Path::new(cwd).join(".codex");
|
||||
config.get("layers")?.as_array()?.iter().find(|layer| {
|
||||
layer.pointer("/name/type").and_then(Value::as_str) == Some("project")
|
||||
&& layer
|
||||
.pointer("/name/dotCodexFolder")
|
||||
.and_then(Value::as_str)
|
||||
.is_some_and(|path| Path::new(path) == folder)
|
||||
&& layer.get("disabledReason").and_then(Value::as_str).is_some_and(|reason| !reason.trim().is_empty())
|
||||
})
|
||||
}
|
||||
|
||||
impl CodexShim {
|
||||
pub(super) async fn prepare_project_trust(&self, params: &Value) {
|
||||
let Some(cwd) = params.get("cwd").and_then(Value::as_str) else { return };
|
||||
if !self.state.lock().trust_checked.insert(cwd.to_owned()) {
|
||||
return;
|
||||
}
|
||||
// Old app-servers may not expose config layers. Their warnings still reach the UI.
|
||||
let Ok(Ok(config)) = tokio::time::timeout(
|
||||
Duration::from_secs(5),
|
||||
self.call("config/read", json!({ "cwd": cwd, "includeLayers": true })),
|
||||
)
|
||||
.await
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let Some(layer) = disabled_project(&config, cwd) else { return };
|
||||
let Some(client) = self.client.get() else { return };
|
||||
let title = format!(
|
||||
"Trust project in Codex: {cwd}? This saves trust in your Codex user configuration and allows \
|
||||
this project's MCP servers, hooks and exec policies to load."
|
||||
);
|
||||
let permission = json!({
|
||||
"sessionId": params.get("sessionId").and_then(Value::as_str).unwrap_or_default(),
|
||||
"toolCall": {
|
||||
"toolCallId": format!("codex-project-trust:{cwd}"),
|
||||
"title": title, "kind": "edit",
|
||||
"rawInput": { "project": cwd },
|
||||
},
|
||||
"options": [
|
||||
// Permanent trust must never be auto-approved by the task's allow-once bypass.
|
||||
{ "optionId": "codex-trust-project", "name": "Trust Project in Codex", "kind": "allow_always" },
|
||||
{ "optionId": "codex-keep-untrusted", "name": "Keep Untrusted", "kind": "reject_once" },
|
||||
],
|
||||
});
|
||||
let answer: Result<Value, RpcError> = client.request("session/request_permission", permission, None).await;
|
||||
let approved = answer.as_ref().is_ok_and(|answer| {
|
||||
answer.pointer("/outcome/outcome").and_then(Value::as_str) == Some("selected")
|
||||
&& answer.pointer("/outcome/optionId").and_then(Value::as_str) == Some("codex-trust-project")
|
||||
});
|
||||
if !approved {
|
||||
if let Some(reason) = layer.get("disabledReason").and_then(Value::as_str) {
|
||||
self.warning(reason);
|
||||
}
|
||||
return;
|
||||
}
|
||||
// Quote the path as one key segment: dots and Windows backslashes are literal.
|
||||
let mut write = json!({
|
||||
"keyPath": format!("projects.{}.trust_level", json!(cwd)),
|
||||
"value": "trusted", "mergeStrategy": "replace",
|
||||
});
|
||||
if let Some(version) = config["layers"]
|
||||
.as_array()
|
||||
.and_then(|layers| {
|
||||
layers.iter().find(|layer| {
|
||||
layer.pointer("/name/type").and_then(Value::as_str) == Some("user")
|
||||
&& layer.pointer("/name/profile").is_none_or(Value::is_null)
|
||||
})
|
||||
})
|
||||
.and_then(|layer| layer.get("version"))
|
||||
.filter(|version| version.is_string())
|
||||
{
|
||||
write["expectedVersion"] = version.clone();
|
||||
}
|
||||
match self.call("config/value/write", write).await {
|
||||
Err(error) => self.warning(format!("Codex could not save trust for {cwd}: {}", error.message)),
|
||||
Ok(reply) if reply["status"] == "okOverridden" => {
|
||||
self.warning(format!(
|
||||
"Codex saved trust for {cwd}, but a higher-priority configuration overrides it. \
|
||||
Project configuration may remain disabled; check the Codex configuration or contact your administrator."
|
||||
));
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
// start/resume/fork now load the updated config before creating the thread.
|
||||
}
|
||||
}
|
||||
@@ -56,6 +56,13 @@ const BUILTIN: &[(&str, &str, Driver, &[&str], &str)] = &[
|
||||
&["npx", "-y", "@agentclientprotocol/[email protected]"],
|
||||
"Run `codex login` in a terminal.",
|
||||
),
|
||||
(
|
||||
"deepseek-harness",
|
||||
"DeepSeek Harness",
|
||||
Driver::Acp,
|
||||
&["dsh", "--profile", "acp"],
|
||||
"Run `dsh` in a terminal and sign in.",
|
||||
),
|
||||
("gemini", "Gemini CLI", Driver::Acp, &["gemini", "--experimental-acp"], "Run `gemini` in a terminal and sign in."),
|
||||
(
|
||||
"copilot",
|
||||
|
||||
@@ -51,6 +51,7 @@ struct FakeAgent {
|
||||
/// Config options `session/new` reports after the model one (per-model efforts, say).
|
||||
extra_options: Mutex<Vec<Value>>,
|
||||
model_options: Mutex<HashMap<String, Vec<Value>>>,
|
||||
model_config_gate: Mutex<Option<std::sync::mpsc::Receiver<()>>>,
|
||||
/// Advertises steering as OMP does (`_meta.steering` at the top of `initialize`)
|
||||
/// instead of `_meta.openidea.steer`.
|
||||
session_steering: bool,
|
||||
@@ -231,6 +232,12 @@ impl Handler for FakeAgent {
|
||||
std::thread::sleep(self.delay_config);
|
||||
}
|
||||
self.calls.lock().push(format!("{method} {}", params.get("value").or(params.get("modeId")).unwrap()));
|
||||
if params["configId"] == "model" {
|
||||
let gate = self.model_config_gate.lock().take();
|
||||
if let Some(gate) = gate {
|
||||
gate.recv().unwrap();
|
||||
}
|
||||
}
|
||||
if params["configId"] == "model" && !self.model_options.lock().is_empty() {
|
||||
return Ok(json!({"configOptions": self.options_for(params["value"].as_str().unwrap())}));
|
||||
}
|
||||
@@ -590,6 +597,7 @@ for line in sys.stdin:
|
||||
assert_eq!(names, ["compact", "clear", "model", "context", "triage"]);
|
||||
assert_eq!(first[0].hint.as_deref(), Some("[instructions]"));
|
||||
let restored = manager(root, Arc::new(FakeAgent::default()));
|
||||
restored.set_builtin_command("claude", Some(script.to_string_lossy().into_owned())).unwrap();
|
||||
assert_eq!(first, restored.commands("claude", None).await.unwrap());
|
||||
// The same handshake lists the models, so the composer has them before any task.
|
||||
for mgr in [&mgr, &restored] {
|
||||
@@ -909,8 +917,23 @@ async fn commands_are_remembered_per_project_and_merged_with_skills_on_disk() {
|
||||
wait_for(&mgr_a, &task.id, AgentStatus::NeedsInput).await;
|
||||
assert_eq!(names(mgr_a.commands("claude", None).await.unwrap()), ["review", "triage"]);
|
||||
assert_eq!(names(mgr_a.commands("claude", Some(&task.id)).await.unwrap()), ["review", "triage"]);
|
||||
// Other agents get only what they offered.
|
||||
assert!(mgr_a.commands("codex", None).await.unwrap().is_empty());
|
||||
// Other agents get only what they offered, plus verified native builtins.
|
||||
assert_eq!(
|
||||
names(mgr_a.commands("codex", None).await.unwrap()),
|
||||
[
|
||||
"plan",
|
||||
"mcp",
|
||||
"skills",
|
||||
"status",
|
||||
"review",
|
||||
"review-branch",
|
||||
"review-commit",
|
||||
"compact",
|
||||
"goal",
|
||||
"rename",
|
||||
"logout",
|
||||
]
|
||||
);
|
||||
mgr_a.cancel(&task.id, None).unwrap();
|
||||
wait_for(&mgr_a, &task.id, AgentStatus::Ready).await;
|
||||
mgr_a.shutdown();
|
||||
@@ -930,9 +953,27 @@ async fn builtin_commands_only_fill_verified_gaps_and_preserve_advertised_metada
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
let mgr = manager_at(tmp.path(), &tmp.path().join("models.json"), agent);
|
||||
for provider in ["claude", "claude-acp", "opencode2", "codex", "custom"] {
|
||||
for provider in ["claude", "claude-acp", "opencode2", "custom"] {
|
||||
assert!(mgr.commands(provider, None).await.unwrap().is_empty(), "{provider}");
|
||||
}
|
||||
let commands = mgr.commands("codex", None).await.unwrap();
|
||||
assert_eq!(
|
||||
commands.iter().map(|c| c.name.as_str()).collect::<Vec<_>>(),
|
||||
[
|
||||
"plan",
|
||||
"mcp",
|
||||
"skills",
|
||||
"status",
|
||||
"review",
|
||||
"review-branch",
|
||||
"review-commit",
|
||||
"compact",
|
||||
"goal",
|
||||
"rename",
|
||||
"logout",
|
||||
]
|
||||
);
|
||||
assert_eq!(commands[1].hint.as_deref(), Some("[reconnect]"));
|
||||
let commands = mgr.commands("opencode", None).await.unwrap();
|
||||
assert_eq!(commands.iter().map(|c| c.name.as_str()).collect::<Vec<_>>(), ["compact"]);
|
||||
let task = mgr
|
||||
@@ -1603,6 +1644,12 @@ async fn renamed_titles_survive_updates_forks_and_restart() {
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
let handle = mgr.task(&task.id).unwrap();
|
||||
// `/rename` reports an explicit title through the same update; later automatic names
|
||||
// must not replace it even though AgentManager.rename was not called.
|
||||
handle
|
||||
.on_update(None, &json!({"sessionUpdate": "session_info_update", "title": "Command title", "userNamed": true}));
|
||||
handle.on_update(None, &json!({"sessionUpdate": "session_info_update", "title": "Automatic title"}));
|
||||
assert_eq!(handle.state.lock().task.title, "Command title");
|
||||
assert!(mgr.rename(&task.id, " ").is_err());
|
||||
let initial = handle.state.lock().task.title.clone();
|
||||
for title in [initial, "My task".to_owned(), "名".repeat(205)] {
|
||||
@@ -1623,6 +1670,65 @@ async fn renamed_titles_survive_updates_forks_and_restart() {
|
||||
restored.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn startup_warnings_survive_replay_and_restart_without_failing_the_task() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let task = mgr
|
||||
.create(NewAgentTask { provider: "claude".into(), prompt: text("again"), ..Default::default() })
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
let handle = mgr.task(&task.id).unwrap();
|
||||
handle.replaying.store(true, Ordering::Release);
|
||||
handle.turn_started.store(false, Ordering::Release);
|
||||
let client = Client { task: Arc::downgrade(&handle) };
|
||||
client.on_notification(WARNING_NOTIFICATION, json!({"message": "Project MCP config is disabled until trusted."}));
|
||||
client.on_notification(WARNING_NOTIFICATION, json!({"message": " "}));
|
||||
client.on_notification(WARNING_NOTIFICATION, json!({}));
|
||||
assert_eq!(handle.state.lock().task.status, AgentStatus::Ready);
|
||||
assert!(!handle.turn_started.load(Ordering::Acquire));
|
||||
mgr.shutdown();
|
||||
let restored = manager(tmp.path(), agent);
|
||||
let handle = restored.task(&task.id).unwrap();
|
||||
assert_eq!(handle.state.lock().conversation.main.entries.iter().filter(|entry| matches!(entry, AgentEntry::Error {message} if message == "Project MCP config is disabled until trusted.")).count(), 1);
|
||||
restored.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn persistent_project_trust_needs_confirmation_even_with_bypass() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mgr = manager(tmp.path(), Arc::new(FakeAgent::default()));
|
||||
let task = mgr
|
||||
.create(NewAgentTask { provider: "claude".into(), prompt: text("again"), ..Default::default() })
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
let handle = mgr.task(&task.id).unwrap();
|
||||
handle.state.lock().task.config = config::options_of(&json!({"configOptions": [{
|
||||
"id": "mode", "category": "mode", "type": "select", "currentValue": "full-access",
|
||||
"options": [{"value": "full-access", "name": "Full Access"}]
|
||||
}]}));
|
||||
assert!(config::bypass_approvals(&handle.state.lock().task.config));
|
||||
let params = json!({"toolCall": {"toolCallId": "trust", "kind": "edit", "title": "Trust Project in Codex"},
|
||||
"options": [
|
||||
{"optionId": "codex-trust-project", "name": "Trust Project in Codex", "kind": "allow_always"},
|
||||
{"optionId": "codex-keep-untrusted", "name": "Keep Untrusted", "kind": "reject_once"}
|
||||
]});
|
||||
let asking = {
|
||||
let handle = handle.clone();
|
||||
let params = params.clone();
|
||||
tokio::task::spawn_blocking(move || handle.ask_permission(¶ms))
|
||||
};
|
||||
wait_for(&mgr, &task.id, AgentStatus::NeedsInput).await;
|
||||
assert!(!asking.is_finished());
|
||||
let id = *handle.permissions.lock().keys().next().unwrap();
|
||||
mgr.respond(&task.id, id, Some("codex-keep-untrusted".into())).unwrap();
|
||||
assert_eq!(asking.await.unwrap()["outcome"]["optionId"], "codex-keep-untrusted");
|
||||
mgr.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn forks_rollbacks_and_steering() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
@@ -1833,8 +1939,7 @@ async fn thinking_levels_are_remembered_per_provider_and_model() {
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn changing_an_idle_tasks_settings_keeps_its_models_effort_levels() {
|
||||
// After a model switch no session reported, picking that model again or changing
|
||||
// another setting must not record the task's effort-less copy as the model's levels.
|
||||
// Idle selections use cached model controls or discover them before the next prompt.
|
||||
for (option, value) in [("mode", "code"), ("model", "big")] {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
@@ -1847,7 +1952,7 @@ async fn changing_an_idle_tasks_settings_keeps_its_models_effort_levels() {
|
||||
.create(NewAgentTask {
|
||||
project_root: None,
|
||||
prompt: text("again"),
|
||||
provider: "claude".into(),
|
||||
provider: "claude-acp".into(),
|
||||
config: vec![],
|
||||
isolation: Isolation::Local,
|
||||
base: None,
|
||||
@@ -1859,18 +1964,165 @@ async fn changing_an_idle_tasks_settings_keeps_its_models_effort_levels() {
|
||||
mgr.shutdown();
|
||||
let restored = manager(tmp.path(), agent);
|
||||
restored.set_config(&task.id, "model", "small".into()).await.unwrap();
|
||||
{
|
||||
let small = restored.task(&task.id).unwrap();
|
||||
let small = small.state.lock();
|
||||
let effort = small.task.config.iter().find(|option| option.id == "effort").unwrap();
|
||||
assert_eq!(
|
||||
effort.values.iter().map(|value| value.value.as_str()).collect::<Vec<_>>(),
|
||||
["minimal", "medium"]
|
||||
);
|
||||
}
|
||||
restored.set_config(&task.id, "model", "big".into()).await.unwrap();
|
||||
restored.set_config(&task.id, option, value.into()).await.unwrap();
|
||||
let p = restored.providers().into_iter().find(|p| p.id == "claude").unwrap();
|
||||
let p = restored.providers().into_iter().find(|p| p.id == "claude-acp").unwrap();
|
||||
let big = p.thought_levels.get("big").and_then(|levels| levels.first());
|
||||
assert_eq!(big.map(|o| o.values.len()), Some(2), "{option}: {:?}", p.thought_levels);
|
||||
let saved: HashMap<String, Known> =
|
||||
serde_json::from_slice(&std::fs::read(&restored.shared.paths.models_file).unwrap()).unwrap();
|
||||
assert_eq!(saved["claude"].thought_levels, p.thought_levels, "{option}");
|
||||
assert_eq!(saved["claude-acp"].thought_levels, p.thought_levels, "{option}");
|
||||
restored.shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn idle_model_switches_discover_controls_and_no_control_models_without_another_prompt() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
*agent.model_options.lock() = HashMap::from([
|
||||
("big".into(), effort_options(&["low", "high"], "high")),
|
||||
("small".into(), effort_options(&["minimal", "medium"], "minimal")),
|
||||
("plain".into(), vec![]),
|
||||
]);
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let task = mgr
|
||||
.create(NewAgentTask {
|
||||
prompt: text("again"),
|
||||
provider: "claude-acp".into(),
|
||||
isolation: Isolation::Local,
|
||||
..Default::default()
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
mgr.shutdown();
|
||||
let restored = manager(tmp.path(), agent.clone());
|
||||
assert!(
|
||||
!restored.shared.paths.catalogs.cached(&restored.shared, "claude-acp").thought_levels.contains_key("small")
|
||||
);
|
||||
agent.calls.lock().clear();
|
||||
restored.set_config(&task.id, "model", "small".into()).await.unwrap();
|
||||
let current = restored.task(&task.id).unwrap();
|
||||
let config = current.state.lock().task.config.clone();
|
||||
let effort = config.iter().find(|option| option.id == "effort").unwrap();
|
||||
assert_eq!(effort.values.iter().map(|value| value.value.as_str()).collect::<Vec<_>>(), ["minimal", "medium"]);
|
||||
restored.set_config(&task.id, "effort", "medium".into()).await.unwrap();
|
||||
restored.set_config(&task.id, "model", "plain".into()).await.unwrap();
|
||||
assert!(!current.state.lock().task.config.iter().any(config::is_per_model_option));
|
||||
let known = restored.shared.paths.catalogs.cached(&restored.shared, "claude-acp");
|
||||
assert!(known.thought_levels["plain"].is_empty());
|
||||
assert_eq!(known.config.iter().find(|option| option.id == "model").unwrap().current.as_deref(), Some("big"));
|
||||
{
|
||||
let mut calls = agent.calls.lock();
|
||||
assert!(!calls.iter().any(|call| call == "session/prompt" || call == "session/load"));
|
||||
assert_eq!(calls.iter().filter(|call| *call == "session/new").count(), 2);
|
||||
calls.clear();
|
||||
}
|
||||
restored.set_config(&task.id, "model", "small".into()).await.unwrap();
|
||||
assert!(agent.calls.lock().is_empty(), "a known model remains a cache-only selection");
|
||||
assert!(current.live.lock().is_none(), "discovery never mutates a task's live session");
|
||||
restored.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn idle_model_discovery_failure_restores_the_previous_choice_without_claiming_no_controls() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
*agent.extra_options.lock() = effort_options(&["low", "high"], "low");
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let task = mgr
|
||||
.create(NewAgentTask {
|
||||
prompt: text("again"),
|
||||
provider: "claude-acp".into(),
|
||||
isolation: Isolation::Local,
|
||||
..Default::default()
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
mgr.shutdown();
|
||||
let restored = manager(tmp.path(), agent.clone());
|
||||
agent.calls.lock().clear();
|
||||
assert!(restored.set_config(&task.id, "model", "small".into()).await.is_err());
|
||||
let current = restored.task(&task.id).unwrap();
|
||||
assert_eq!(current.state.lock().task.model.as_deref(), Some("big"));
|
||||
assert!(current.state.lock().task.config.iter().any(|option| option.id == "effort"));
|
||||
assert!(
|
||||
!restored.shared.paths.catalogs.cached(&restored.shared, "claude-acp").thought_levels.contains_key("small")
|
||||
);
|
||||
assert!(!agent.calls.lock().iter().any(|call| call == "session/prompt"));
|
||||
restored.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn rapid_idle_model_switches_share_discovery_and_never_apply_a_stale_completion() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
*agent.model_options.lock() = HashMap::from([
|
||||
("big".into(), effort_options(&["low", "high"], "high")),
|
||||
("small".into(), effort_options(&["minimal", "medium"], "minimal")),
|
||||
("plain".into(), vec![]),
|
||||
]);
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let task = mgr
|
||||
.create(NewAgentTask {
|
||||
prompt: text("again"),
|
||||
provider: "claude-acp".into(),
|
||||
isolation: Isolation::Local,
|
||||
..Default::default()
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
mgr.shutdown();
|
||||
let restored = Arc::new(manager(tmp.path(), agent.clone()));
|
||||
agent.calls.lock().clear();
|
||||
let (release, gate) = std::sync::mpsc::channel();
|
||||
*agent.model_config_gate.lock() = Some(gate);
|
||||
let first = tokio::spawn({
|
||||
let restored = restored.clone();
|
||||
let id = task.id.clone();
|
||||
async move { restored.set_config(&id, "model", "small".into()).await }
|
||||
});
|
||||
tokio::time::timeout(Duration::from_secs(5), async {
|
||||
while agent.model_config_gate.lock().is_some() {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
let duplicate = restored.set_config(&task.id, "model", "small".into());
|
||||
tokio::pin!(duplicate);
|
||||
tokio::select! {
|
||||
biased;
|
||||
result = &mut duplicate => panic!("duplicate selection must join the pending discovery: {result:?}"),
|
||||
_ = tokio::task::yield_now() => {}
|
||||
}
|
||||
restored.set_config(&task.id, "model", "plain".into()).await.unwrap();
|
||||
release.send(()).unwrap();
|
||||
first.await.unwrap().unwrap();
|
||||
duplicate.await.unwrap();
|
||||
let current = restored.task(&task.id).unwrap();
|
||||
assert_eq!(current.state.lock().task.model.as_deref(), Some("plain"));
|
||||
assert!(!current.state.lock().task.config.iter().any(config::is_per_model_option));
|
||||
let catalog = restored.shared.paths.catalogs.cached(&restored.shared, "claude-acp");
|
||||
assert!(catalog.thought_levels["plain"].is_empty());
|
||||
assert!(!catalog.thought_levels.contains_key("small"), "obsolete discovery cannot populate model settings");
|
||||
assert_eq!(agent.calls.lock().iter().filter(|call| *call == "session/new").count(), 2);
|
||||
assert!(!agent.calls.lock().iter().any(|call| call == "session/prompt"));
|
||||
restored.shutdown();
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn upfront_effort_is_validated_after_changing_model_before_the_prompt() {
|
||||
for (effort, applied) in [("medium", true), ("high", false)] {
|
||||
@@ -3493,199 +3745,6 @@ async fn security_policy_never_auto_approves_a_request_that_only_reads_like_a_co
|
||||
);
|
||||
}
|
||||
|
||||
/// A temporary side conversation is created ready, without starting its session and
|
||||
/// without writing anything to the store; a fresh subscriber (a reloaded page) sweeps
|
||||
/// it, and deleting it just drops it from memory.
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn ephemeral_tasks_stay_in_memory_only() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let source = mgr
|
||||
.create(NewAgentTask {
|
||||
project_root: None,
|
||||
prompt: text("hello"),
|
||||
provider: "claude".into(),
|
||||
config: vec![],
|
||||
isolation: Isolation::Local,
|
||||
base: None,
|
||||
..Default::default()
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &source.id, AgentStatus::NeedsInput).await;
|
||||
let calls_before = agent.calls.lock().len();
|
||||
let task = mgr
|
||||
.create_ephemeral(
|
||||
NewAgentTask {
|
||||
project_root: None,
|
||||
prompt: text("What changed in this file?"),
|
||||
provider: "claude".into(),
|
||||
config: vec![],
|
||||
isolation: Isolation::Local,
|
||||
base: None,
|
||||
..Default::default()
|
||||
},
|
||||
&source.id,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
// Registering it starts nothing: the session waits for its first real message.
|
||||
assert_eq!(agent.calls.lock().len(), calls_before);
|
||||
assert_eq!(mgr.task(&task.id).unwrap().state.lock().task.status, AgentStatus::Ready);
|
||||
assert!(!tmp.path().join("store").join(format!("{}.json", task.id)).exists());
|
||||
|
||||
// Its first message starts the session like any task's, and still saves nothing: the
|
||||
// conversation records the question, not the context that rode along to the agent.
|
||||
// The fake agent's turn asks to change something, which a side conversation denies by
|
||||
// itself, so the turn ends without waiting for the user.
|
||||
mgr.prompt(&task.id, text("Why?"), false).await.unwrap();
|
||||
wait_for(&mgr, &task.id, AgentStatus::Ready).await;
|
||||
let entries = mgr.entries(&task.id, None).unwrap();
|
||||
let question = entries.iter().find_map(|e| match e {
|
||||
AgentEntry::User { text, .. } => Some(text.clone()),
|
||||
_ => None,
|
||||
});
|
||||
assert_eq!(question.as_deref(), Some("Why?"));
|
||||
assert!(
|
||||
entries.iter().any(|e| matches!(e, AgentEntry::Permission { chosen: Some(c), .. } if c.contains("read-only"))),
|
||||
"its `cargo test` request was denied: {entries:?}"
|
||||
);
|
||||
assert!(!tmp.path().join("store").join(format!("{}.json", task.id)).exists());
|
||||
|
||||
// A fresh subscriber (a reloaded page) sweeps it: it never reaches the task list.
|
||||
let events: Arc<Mutex<Vec<AgentEvent>>> = Arc::new(Mutex::new(Vec::new()));
|
||||
let sink_events = events.clone();
|
||||
let tasks = mgr.subscribe(Arc::new(move |e| sink_events.lock().push(e)));
|
||||
assert!(!tasks.iter().any(|t| t.id == task.id));
|
||||
assert!(mgr.task(&task.id).is_err());
|
||||
assert!(events.lock().iter().any(|e| matches!(e, AgentEvent::Removed { id } if *id == task.id)));
|
||||
mgr.shutdown();
|
||||
}
|
||||
|
||||
/// A side conversation's context stays within its budget: long tool outputs are cut to
|
||||
/// their head and tail, and entries that no longer fit are dropped oldest first.
|
||||
#[test]
|
||||
fn side_conversation_context_is_bounded() {
|
||||
let long_output = (0..400).map(|i| format!("line {i}")).collect::<Vec<_>>().join(
|
||||
"
|
||||
",
|
||||
);
|
||||
// Each reply alone is well inside the budget; together they are past it.
|
||||
let reply = |n: usize| AgentEntry::Agent { text: format!("reply {n} {}", "x".repeat(30_000)) };
|
||||
let entries = vec![
|
||||
AgentEntry::User {
|
||||
text: "oldest question".into(),
|
||||
attachments: vec![],
|
||||
images: vec![],
|
||||
sent_ms: None,
|
||||
done_ms: None,
|
||||
steered: false,
|
||||
},
|
||||
reply(1),
|
||||
reply(2),
|
||||
reply(3),
|
||||
reply(4),
|
||||
AgentEntry::Tool {
|
||||
id: "t1".into(),
|
||||
title: "grep".into(),
|
||||
kind: "search".into(),
|
||||
status: AgentToolStatus::Completed,
|
||||
locations: vec![],
|
||||
output: Some(long_output),
|
||||
diffs: vec![],
|
||||
},
|
||||
AgentEntry::User {
|
||||
text: "newest question".into(),
|
||||
attachments: vec![],
|
||||
images: vec![],
|
||||
sent_ms: None,
|
||||
done_ms: None,
|
||||
steered: false,
|
||||
},
|
||||
];
|
||||
let transcript = context_transcript(&entries);
|
||||
assert!(transcript.contains("newest question"), "the newest entry is always kept");
|
||||
assert!(transcript.contains("lines omitted"), "a long tool output is trimmed");
|
||||
assert!(transcript.contains("line 0") && transcript.contains("line 399"), "its head and tail stay");
|
||||
assert!(!transcript.contains("oldest question"), "entries past the budget are dropped oldest first");
|
||||
assert!(transcript.contains("oldest entries are omitted"));
|
||||
}
|
||||
|
||||
/// An ephemeral task denies a permission request that would change the project.
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn ephemeral_tasks_deny_write_permissions() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let agent = Arc::new(FakeAgent::default());
|
||||
let mgr = manager(tmp.path(), agent.clone());
|
||||
let source = mgr
|
||||
.create(NewAgentTask {
|
||||
project_root: None,
|
||||
prompt: text("Something with a conversation to reuse"),
|
||||
provider: "claude".into(),
|
||||
config: vec![],
|
||||
isolation: Isolation::Local,
|
||||
base: None,
|
||||
..Default::default()
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
wait_for(&mgr, &source.id, AgentStatus::NeedsInput).await;
|
||||
let pending = mgr
|
||||
.entries(&source.id, None)
|
||||
.unwrap()
|
||||
.iter()
|
||||
.find_map(|e| match e {
|
||||
AgentEntry::Permission { id, chosen: None, .. } => Some(*id),
|
||||
_ => None,
|
||||
})
|
||||
.unwrap_or_else(|| panic!("no pending permission request"));
|
||||
mgr.respond(&source.id, pending, Some("no".into())).unwrap();
|
||||
wait_for(&mgr, &source.id, AgentStatus::Ready).await;
|
||||
|
||||
let task = mgr
|
||||
.create_ephemeral(
|
||||
NewAgentTask {
|
||||
project_root: None,
|
||||
prompt: text("What changed in this file?"),
|
||||
provider: "claude".into(),
|
||||
config: vec![],
|
||||
isolation: Isolation::Local,
|
||||
base: None,
|
||||
..Default::default()
|
||||
},
|
||||
&source.id,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(mgr.task(&task.id).unwrap().state.lock().task.capabilities.read_only);
|
||||
|
||||
let answer = mgr
|
||||
.task(&task.id)
|
||||
.unwrap()
|
||||
.ask_permission(&json!({
|
||||
"sessionId": "c1",
|
||||
"toolCall": {"toolCallId": "c1-t2", "title": "Edit main.rs", "kind": "edit"},
|
||||
"options": [
|
||||
{"optionId": "yes", "name": "Allow", "kind": "allow_once"},
|
||||
{"optionId": "no", "name": "Reject", "kind": "reject_once"}
|
||||
]
|
||||
}))
|
||||
.pointer("/outcome/optionId")
|
||||
.and_then(Value::as_str)
|
||||
.unwrap_or("none")
|
||||
.to_owned();
|
||||
assert_eq!(answer, "no", "the write request is denied");
|
||||
let entries = mgr.entries(&task.id, None).unwrap();
|
||||
assert!(
|
||||
entries
|
||||
.iter()
|
||||
.any(|e| matches!(e, AgentEntry::Permission { chosen: Some(chosen), .. } if chosen.contains("read-only"))),
|
||||
"{entries:?}"
|
||||
);
|
||||
mgr.shutdown();
|
||||
}
|
||||
|
||||
fn attention_reasons(events: &[AgentEvent]) -> Vec<AgentAttentionReason> {
|
||||
events
|
||||
.iter()
|
||||
@@ -4138,3 +4197,14 @@ done
|
||||
);
|
||||
mgr.shutdown();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn session_params_name_the_servers_off() {
|
||||
let mcp = McpForSession { servers: vec![json!({ "name": "docs" })], off: vec!["github".into()] };
|
||||
let params = session_params("/p", &mcp);
|
||||
assert_eq!(params["cwd"], "/p");
|
||||
assert_eq!(params["mcpServers"][0]["name"], "docs");
|
||||
assert_eq!(params["_meta"]["openidea"]["mcpServersOff"], json!(["github"]));
|
||||
let none = McpForSession { servers: Vec::new(), off: Vec::new() };
|
||||
assert!(session_params("/p", &none).get("_meta").is_none());
|
||||
}
|
||||
@@ -548,7 +548,7 @@ impl PathMap {
|
||||
}
|
||||
|
||||
/// Removes `.` and resolvable `..` components without touching the file system.
|
||||
fn normalize(p: &Path) -> PathBuf {
|
||||
pub(crate) fn normalize(p: &Path) -> PathBuf {
|
||||
use std::path::Component;
|
||||
let mut out = PathBuf::new();
|
||||
for c in p.components() {
|
||||
|
||||
@@ -40,6 +40,18 @@ pub fn structure_outputs(root: &Path, ps: &ProjectStructureSettings) -> (PathBuf
|
||||
(main, test)
|
||||
}
|
||||
|
||||
/// Whether Rebuild may delete the output folder `dir`: never the project folder or one above
|
||||
/// it, nor a folder that holds or lies inside a source, test or resource root.
|
||||
fn deletable_output(dir: &Path, root: &Path, roots: &StructureRoots) -> bool {
|
||||
let dir = normalize(dir);
|
||||
let overlaps = |r: &PathBuf| {
|
||||
let r = normalize(r);
|
||||
r.starts_with(&dir) || dir.starts_with(&r)
|
||||
};
|
||||
!normalize(root).starts_with(&dir)
|
||||
&& !roots.sources.iter().chain(&roots.tests).chain(&roots.resources).chain(&roots.test_resources).any(overlaps)
|
||||
}
|
||||
|
||||
fn module_name(root: &Path) -> String {
|
||||
root.file_name().map_or_else(|| "project".to_owned(), |n| n.to_string_lossy().into_owned())
|
||||
}
|
||||
@@ -207,7 +219,11 @@ pub fn structure_plan(
|
||||
|
||||
let mut steps = Vec::new();
|
||||
if kind == BuildKind::Rebuild {
|
||||
steps.push(BuildStep::action(Action::Clean(vec![main_out.clone(), test_out.clone()]), root));
|
||||
let dirs: Vec<PathBuf> =
|
||||
[&main_out, &test_out].into_iter().filter(|d| deletable_output(d, root, roots)).cloned().collect();
|
||||
if !dirs.is_empty() {
|
||||
steps.push(BuildStep::action(Action::Clean(dirs), root));
|
||||
}
|
||||
}
|
||||
let main_cp = library_entries(root, ps, false);
|
||||
let compile = |name: &str, sources: &[PathBuf], out: &Path, cp: &[String]| -> IdeResult<BuildStep> {
|
||||
@@ -310,6 +326,8 @@ fn artifact_steps(
|
||||
.find(|f| f.module == artifact.module || f.module.is_empty() && artifact.module == ".")
|
||||
.or_else(|| ps.facets.iter().find(|f| f.kind == "web"));
|
||||
let staging = cache.join("artifacts").join(file_name(&artifact.name));
|
||||
// What the last build laid out in a folder the user chose, so the next one replaces only that.
|
||||
let record = cache.join("artifacts").join(format!("{}.files", file_name(&artifact.name)));
|
||||
let mut steps = Vec::new();
|
||||
match (artifact.kind, war) {
|
||||
(ArtifactKind::Jar, None) => {
|
||||
@@ -324,7 +342,11 @@ fn artifact_steps(
|
||||
manifest.push_str(&format!("Class-Path: {}\r\n", names.join(" ")));
|
||||
}
|
||||
steps.push(BuildStep::action(
|
||||
Action::Layout { into: staging.clone(), entries: vec![(classes.to_path_buf(), PathBuf::new())] },
|
||||
Action::Layout {
|
||||
into: staging.clone(),
|
||||
entries: vec![(classes.to_path_buf(), PathBuf::new())],
|
||||
record: None,
|
||||
},
|
||||
root,
|
||||
));
|
||||
// The jar's Class-Path names the libraries next to it.
|
||||
@@ -332,6 +354,7 @@ fn artifact_steps(
|
||||
Action::Layout {
|
||||
into: out.clone(),
|
||||
entries: libraries.iter().map(|l| (l.clone(), file_of(l))).collect(),
|
||||
record: Some(record),
|
||||
},
|
||||
root,
|
||||
));
|
||||
@@ -353,7 +376,9 @@ fn artifact_steps(
|
||||
for lib in &libraries {
|
||||
entries.push((lib.clone(), Path::new("WEB-INF/lib").join(file_of(lib))));
|
||||
}
|
||||
steps.push(BuildStep::action(Action::Layout { into: exploded.clone(), entries }, root));
|
||||
// The exploded output may be a folder the user chose; the staging folder is the IDE's own.
|
||||
let record = (exploded != staging).then_some(record);
|
||||
steps.push(BuildStep::action(Action::Layout { into: exploded.clone(), entries, record }, root));
|
||||
let archive = war
|
||||
.map(Path::to_path_buf)
|
||||
.or_else(|| (kind != ArtifactKind::WarExploded).then(|| artifact_file(root, artifact)));
|
||||
@@ -407,8 +432,10 @@ pub(crate) enum Action {
|
||||
/// relative paths; files that are already up to date are left alone.
|
||||
CopyResources { from: Vec<PathBuf>, to: PathBuf },
|
||||
/// Lays out an artifact in `into`: each folder's content or file goes to its relative
|
||||
/// place (`""` = the top). What is no longer laid out is removed.
|
||||
Layout { into: PathBuf, entries: Vec<(PathBuf, PathBuf)> },
|
||||
/// place (`""` = the top). What is no longer laid out is removed: without `record`, `into`
|
||||
/// is the IDE's own folder and is laid out afresh; with it, `into` is a folder the user chose
|
||||
/// and only the files the previous layout recorded there are removed, never anything else.
|
||||
Layout { into: PathBuf, entries: Vec<(PathBuf, PathBuf)>, record: Option<PathBuf> },
|
||||
/// Zips the folder `from` into the archive `to`, with this manifest first.
|
||||
Archive { from: PathBuf, to: PathBuf, manifest: Option<String> },
|
||||
}
|
||||
@@ -441,29 +468,39 @@ impl Action {
|
||||
}
|
||||
Ok(format!("{copied} resource file(s) copied"))
|
||||
}
|
||||
Action::Layout { into, entries } => {
|
||||
// A fresh layout: files dropped from the sources must not linger in the artifact.
|
||||
Action::Layout { into, entries, record } => {
|
||||
if entries.iter().any(|(from, _)| from.starts_with(into)) {
|
||||
return Err(IdeError::invalid(format!(
|
||||
"The artifact output folder {} holds files the artifact is made of",
|
||||
into.display()
|
||||
)));
|
||||
}
|
||||
if into.exists() {
|
||||
if record.is_none() && into.exists() {
|
||||
fs::remove_dir_all(into)
|
||||
.map_err(|e| IdeError::internal(format!("cannot delete {} ({e})", into.display())))?;
|
||||
}
|
||||
let mut copied = 0;
|
||||
let mut written = Vec::new();
|
||||
for (from, to) in entries {
|
||||
let target = into.join(to);
|
||||
// The folders of the output it goes into (and a folder entry's own) are
|
||||
// never links; a file in a link's place replaces the link.
|
||||
let mut at = into.to_path_buf();
|
||||
let folders = to.components().count().saturating_sub(usize::from(!from.is_dir()));
|
||||
for c in to.components().take(folders) {
|
||||
at.push(c);
|
||||
refuse_link(&at)?;
|
||||
}
|
||||
if from.is_dir() {
|
||||
copied += copy_tree(from, &target, cancel)?;
|
||||
copy_tree(from, &target, &mut written, cancel)?;
|
||||
} else if from.is_file() {
|
||||
copy_file(from, &target)?;
|
||||
copied += 1;
|
||||
written.push(target);
|
||||
}
|
||||
}
|
||||
Ok(format!("{copied} file(s) laid out"))
|
||||
if let Some(record) = record {
|
||||
replace_recorded(into, record, &written)?;
|
||||
}
|
||||
Ok(format!("{} file(s) laid out", written.len()))
|
||||
}
|
||||
Action::Archive { from, to, manifest } => {
|
||||
archive(from, to, manifest.as_deref(), cancel)?;
|
||||
@@ -474,6 +511,10 @@ impl Action {
|
||||
}
|
||||
|
||||
fn copy_file(from: &Path, to: &Path) -> IdeResult<()> {
|
||||
// A link in the artifact's place is replaced, not written through.
|
||||
if fs::symlink_metadata(to).is_ok_and(|m| m.file_type().is_symlink()) {
|
||||
fs::remove_file(to).map_err(|e| IdeError::internal(format!("cannot replace {} ({e})", to.display())))?;
|
||||
}
|
||||
if let Some(parent) = to.parent() {
|
||||
fs::create_dir_all(parent)
|
||||
.map_err(|e| IdeError::internal(format!("cannot create {} ({e})", parent.display())))?;
|
||||
@@ -482,23 +523,80 @@ fn copy_file(from: &Path, to: &Path) -> IdeResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn copy_tree(from: &Path, to: &Path, cancel: &CancellationToken) -> IdeResult<usize> {
|
||||
fn refuse_link(folder: &Path) -> IdeResult<()> {
|
||||
if fs::symlink_metadata(folder).is_ok_and(|m| m.file_type().is_symlink()) {
|
||||
return Err(IdeError::invalid(format!(
|
||||
"{} links to another folder; the artifact is not laid out through it",
|
||||
folder.display()
|
||||
)));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn copy_tree(from: &Path, to: &Path, written: &mut Vec<PathBuf>, cancel: &CancellationToken) -> IdeResult<()> {
|
||||
if cancel.is_cancelled() {
|
||||
return Err(IdeError::cancelled());
|
||||
}
|
||||
let Ok(entries) = fs::read_dir(from) else { return Ok(0) };
|
||||
let mut copied = 0;
|
||||
let Ok(entries) = fs::read_dir(from) else { return Ok(()) };
|
||||
for e in entries.flatten() {
|
||||
let Ok(t) = e.file_type() else { continue };
|
||||
let target = to.join(e.file_name());
|
||||
if t.is_dir() {
|
||||
copied += copy_tree(&e.path(), &target, cancel)?;
|
||||
refuse_link(&target)?;
|
||||
copy_tree(&e.path(), &target, written, cancel)?;
|
||||
} else if t.is_file() {
|
||||
copy_file(&e.path(), &target)?;
|
||||
copied += 1;
|
||||
written.push(target);
|
||||
}
|
||||
}
|
||||
Ok(copied)
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Removes the files the previous layout recorded in `into` that this one didn't write
|
||||
/// (and the folders that leaves empty), then records `written` for the next layout.
|
||||
fn replace_recorded(into: &Path, record: &Path, written: &[PathBuf]) -> IdeResult<()> {
|
||||
let now: std::collections::HashSet<PathBuf> =
|
||||
written.iter().filter_map(|p| p.strip_prefix(into).ok().map(Path::to_path_buf)).collect();
|
||||
let before = fs::read_to_string(record).unwrap_or_default();
|
||||
let mut lines = before.lines();
|
||||
// The record names its folder first: one made for another output folder removes nothing.
|
||||
let same = lines.next().is_some_and(|dir| Path::new(dir) == into);
|
||||
for rel in lines.filter(|_| same).map(PathBuf::from) {
|
||||
// Only plain relative paths inside `into`: a damaged record must not reach elsewhere.
|
||||
if rel.as_os_str().is_empty()
|
||||
|| now.contains(&rel)
|
||||
|| rel.components().any(|c| !matches!(c, std::path::Component::Normal(_)))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
let file = into.join(&rel);
|
||||
// Never through a link: a folder of the output that now links elsewhere (or a file that
|
||||
// is a link) leads out of what the layout wrote.
|
||||
let mut at = into.to_path_buf();
|
||||
let linked = rel.components().any(|c| {
|
||||
at.push(c);
|
||||
fs::symlink_metadata(&at).is_ok_and(|m| m.file_type().is_symlink())
|
||||
});
|
||||
if !linked && file.is_file() {
|
||||
let _ = fs::remove_file(&file);
|
||||
let mut dir = file.parent();
|
||||
while let Some(d) = dir.filter(|d| *d != into && d.starts_with(into)) {
|
||||
if fs::remove_dir(d).is_err() {
|
||||
break;
|
||||
}
|
||||
dir = d.parent();
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut list: Vec<String> = now.iter().map(|p| p.to_string_lossy().into_owned()).collect();
|
||||
list.sort();
|
||||
list.insert(0, into.to_string_lossy().into_owned());
|
||||
if let Some(parent) = record.parent() {
|
||||
fs::create_dir_all(parent)
|
||||
.map_err(|e| IdeError::internal(format!("cannot create {} ({e})", parent.display())))?;
|
||||
}
|
||||
fs::write(record, list.join("\n"))
|
||||
.map_err(|e| IdeError::internal(format!("cannot write {} ({e})", record.display())))
|
||||
}
|
||||
|
||||
fn archive(from: &Path, to: &Path, manifest: Option<&str>, cancel: &CancellationToken) -> IdeResult<()> {
|
||||
@@ -698,6 +796,37 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rebuild_never_cleans_an_output_folder_over_the_project_or_its_sources() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let root = tmp.path().join("p");
|
||||
write(&root.join("src/A.java"), "class A {}");
|
||||
let roots = StructureRoots { sources: vec![root.join("src")], ..Default::default() };
|
||||
for (main, test) in [(".", "bin"), ("src", "src/../test-out"), ("src/classes", ".."), ("", "")] {
|
||||
let mut ps = ProjectStructureSettings::default();
|
||||
ps.modules.insert(
|
||||
".".into(),
|
||||
ModuleStructureSettings {
|
||||
compiler_output: main.into(),
|
||||
test_compiler_output: test.into(),
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
let plan = structure_plan(&root, &ps, &roots, None, "17", BuildKind::Rebuild, &tmp.path().join("c"))
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
let clean: Vec<String> =
|
||||
plan.steps.iter().map(BuildStep::display).filter(|s| s.starts_with("Clean")).collect();
|
||||
let expected: &[&str] = match main {
|
||||
"." => &["Clean bin"],
|
||||
"src" => &["Clean src/../test-out"],
|
||||
"src/classes" => &[],
|
||||
_ => &["Clean out/production/p, out/test/p"],
|
||||
};
|
||||
assert_eq!(clean, expected, "{main} / {test}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_plan_without_java_sources() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
@@ -812,8 +941,71 @@ mod tests {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let web = tmp.path().join("WebRoot");
|
||||
write(&web.join("a.jsp"), "");
|
||||
let action = Action::Layout { into: tmp.path().to_path_buf(), entries: vec![(web.clone(), PathBuf::new())] };
|
||||
let action = Action::Layout {
|
||||
into: tmp.path().to_path_buf(),
|
||||
entries: vec![(web.clone(), PathBuf::new())],
|
||||
record: None,
|
||||
};
|
||||
assert!(action.run(&CancellationToken::new()).is_err());
|
||||
assert!(web.join("a.jsp").is_file());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_chosen_output_folder_keeps_what_the_artifact_did_not_put_there() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let project = tmp.path().join("project");
|
||||
write(&project.join("src/A.java"), "class A {}");
|
||||
write(&project.join(".git/HEAD"), "ref: refs/heads/main");
|
||||
let libs = tmp.path().join("libs");
|
||||
write(&libs.join("a.jar"), "a");
|
||||
write(&libs.join("b.jar"), "b");
|
||||
let record = tmp.path().join("cache/artifacts/app.files");
|
||||
let layout = |names: &[&str]| Action::Layout {
|
||||
into: project.clone(),
|
||||
entries: names.iter().map(|n| (libs.join(n), PathBuf::from(n))).collect(),
|
||||
record: Some(record.clone()),
|
||||
};
|
||||
layout(&["a.jar", "b.jar"]).run(&CancellationToken::new()).unwrap();
|
||||
assert!(project.join("a.jar").is_file() && project.join("b.jar").is_file());
|
||||
// A library dropped from the artifact goes; the project's own files stay.
|
||||
layout(&["a.jar"]).run(&CancellationToken::new()).unwrap();
|
||||
assert!(project.join("a.jar").is_file() && !project.join("b.jar").exists());
|
||||
assert!(project.join("src/A.java").is_file() && project.join(".git/HEAD").is_file());
|
||||
// A damaged record never reaches outside the folder.
|
||||
write(&record, &format!("{}\n../outside.txt", project.display()));
|
||||
write(&tmp.path().join("outside.txt"), "x");
|
||||
layout(&["a.jar"]).run(&CancellationToken::new()).unwrap();
|
||||
assert!(tmp.path().join("outside.txt").is_file());
|
||||
// Nor through a folder of the output that now links elsewhere.
|
||||
#[cfg(unix)]
|
||||
{
|
||||
write(&project.join("assets/x.txt"), "laid out");
|
||||
write(&record, &format!("{}\nassets/x.txt", project.display()));
|
||||
fs::remove_dir_all(project.join("assets")).unwrap();
|
||||
std::os::unix::fs::symlink(project.join("src"), project.join("assets")).unwrap();
|
||||
write(&project.join("src/x.txt"), "source");
|
||||
layout(&["a.jar"]).run(&CancellationToken::new()).unwrap();
|
||||
assert!(project.join("src/x.txt").is_file());
|
||||
}
|
||||
// An entry's own folder that links elsewhere stops the layout instead of copying through it.
|
||||
#[cfg(unix)]
|
||||
{
|
||||
fs::remove_file(project.join("assets")).unwrap();
|
||||
std::os::unix::fs::symlink(project.join("src"), project.join("classes")).unwrap();
|
||||
write(&tmp.path().join("out/A.class"), "compiled");
|
||||
let into_link = Action::Layout {
|
||||
into: project.clone(),
|
||||
entries: vec![(tmp.path().join("out"), PathBuf::from("classes"))],
|
||||
record: Some(record.clone()),
|
||||
};
|
||||
assert!(into_link.run(&CancellationToken::new()).is_err());
|
||||
assert!(!project.join("src/A.class").exists());
|
||||
fs::remove_file(project.join("classes")).unwrap();
|
||||
}
|
||||
// Nor does one made for another output folder.
|
||||
write(&project.join("c.jar"), "mine");
|
||||
write(&record, "/elsewhere\nc.jar");
|
||||
layout(&["a.jar"]).run(&CancellationToken::new()).unwrap();
|
||||
assert!(project.join("c.jar").is_file());
|
||||
}
|
||||
}
|
||||
@@ -1,13 +1,16 @@
|
||||
//! A Gradle project's resolved dependencies for the Dependency Analyzer:
|
||||
//! `gradle <project>:dependencies --configuration <name>`, parsed from its tree report.
|
||||
//! The reports it read are kept per build ([`save_gradle_report`]) until a build file
|
||||
//! changes, for readers that must not run Gradle themselves (plugins).
|
||||
|
||||
use crate::gradle;
|
||||
use crate::process;
|
||||
use crate::sync::{SyncOptions, error_summary};
|
||||
use crate::sync::{self, SyncOptions, error_summary};
|
||||
use ide_core::{CancellationToken, IdeError, IdeResult};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
use std::path::Path;
|
||||
use std::sync::Mutex;
|
||||
|
||||
/// One line of the report: an occurrence of a dependency where it is requested.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
@@ -158,6 +161,54 @@ pub fn gradle_dependencies(
|
||||
Ok(parse_report(&out.text))
|
||||
}
|
||||
|
||||
/// A `dependencies` report of one project of a build for one configuration.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct GradleReport {
|
||||
/// Gradle path of the project (`:`, `:app`).
|
||||
pub project: String,
|
||||
pub configuration: String,
|
||||
pub dependencies: Vec<GradleDependency>,
|
||||
}
|
||||
|
||||
#[derive(Default, Serialize, Deserialize)]
|
||||
struct ReportCache {
|
||||
/// The build files the reports were read with ([`sync::hash_gradle_files`]).
|
||||
hash: String,
|
||||
reports: Vec<GradleReport>,
|
||||
}
|
||||
|
||||
const REPORT_CACHE: &str = "gradle-dependencies.json";
|
||||
|
||||
/// Keeps `report` with the build's other reports (`cache_dir` is the build's cache
|
||||
/// directory), replacing an earlier one of the same project and configuration. Reports
|
||||
/// read before a build file changed are dropped.
|
||||
pub fn save_gradle_report(
|
||||
root: &Path,
|
||||
cache_dir: &Path,
|
||||
model: &gradle::GradleModel,
|
||||
report: &GradleReport,
|
||||
) -> IdeResult<()> {
|
||||
// Reports of several configurations may finish together: one read-modify-write at a time.
|
||||
static SAVING: Mutex<()> = Mutex::new(());
|
||||
let _saving = SAVING.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let hash = sync::hash_gradle_files(&gradle::build_files(root, model));
|
||||
let mut cache = sync::read_cache::<ReportCache>(cache_dir, REPORT_CACHE)
|
||||
.filter(|c| c.hash == hash)
|
||||
.unwrap_or_else(|| ReportCache { hash, reports: Vec::new() });
|
||||
cache.reports.retain(|r| (&r.project, &r.configuration) != (&report.project, &report.configuration));
|
||||
cache.reports.push(report.clone());
|
||||
sync::write_cache(cache_dir, REPORT_CACHE, &cache)
|
||||
}
|
||||
|
||||
/// The reports kept for the build, unless a build file changed since they were read.
|
||||
pub fn gradle_reports(root: &Path, cache_dir: &Path, model: &gradle::GradleModel) -> Vec<GradleReport> {
|
||||
let Some(cache) = sync::read_cache::<ReportCache>(cache_dir, REPORT_CACHE) else { return Vec::new() };
|
||||
if cache.hash != sync::hash_gradle_files(&gradle::build_files(root, model)) {
|
||||
return Vec::new();
|
||||
}
|
||||
cache.reports
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -234,6 +285,37 @@ runtimeClasspath - Runtime classpath of source set 'main'.
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reports_are_kept_per_project_and_configuration_until_a_build_file_changes() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let root = tmp.path();
|
||||
let cache = root.join("cache");
|
||||
std::fs::write(root.join("settings.gradle"), "include 'app'").unwrap();
|
||||
std::fs::write(root.join("build.gradle"), "").unwrap();
|
||||
let model = gradle::load(root).unwrap();
|
||||
assert!(gradle_reports(root, &cache, &model).is_empty());
|
||||
let report = |project: &str, configuration: &str, version: &str| GradleReport {
|
||||
project: project.into(),
|
||||
configuration: configuration.into(),
|
||||
dependencies: vec![dep("org.a", "b", Some(version))],
|
||||
};
|
||||
save_gradle_report(root, &cache, &model, &report(":app", "runtimeClasspath", "1.0")).unwrap();
|
||||
save_gradle_report(root, &cache, &model, &report(":app", "compileClasspath", "1.0")).unwrap();
|
||||
// Reading a report again replaces what was read before.
|
||||
save_gradle_report(root, &cache, &model, &report(":app", "runtimeClasspath", "2.0")).unwrap();
|
||||
assert_eq!(
|
||||
gradle_reports(root, &cache, &model),
|
||||
[report(":app", "compileClasspath", "1.0"), report(":app", "runtimeClasspath", "2.0")]
|
||||
);
|
||||
// A comment changes nothing Gradle reads; a dependency does.
|
||||
std::fs::write(root.join("build.gradle"), "// notes").unwrap();
|
||||
assert_eq!(gradle_reports(root, &cache, &model).len(), 2);
|
||||
std::fs::write(root.join("build.gradle"), "dependencies { implementation 'org.a:b:3.0' }").unwrap();
|
||||
assert!(gradle_reports(root, &cache, &model).is_empty());
|
||||
save_gradle_report(root, &cache, &model, &report(":", "compileClasspath", "3.0")).unwrap();
|
||||
assert_eq!(gradle_reports(root, &cache, &model), [report(":", "compileClasspath", "3.0")]);
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn runs_the_report_of_the_project_and_configuration() {
|
||||
|
||||
@@ -19,7 +19,7 @@ pub mod web;
|
||||
mod xml;
|
||||
|
||||
pub use gradle::{GradleModel, GradleProject, GradleTask};
|
||||
pub use gradle_deps::{GradleDependency, gradle_dependencies};
|
||||
pub use gradle_deps::{GradleDependency, GradleReport, gradle_dependencies, gradle_reports, save_gradle_report};
|
||||
pub use maven::{MavenDependency, MavenModel, MavenPlugin, MavenProfile, MavenProject, Omission};
|
||||
pub use sbt::{SbtBuild, SbtProject};
|
||||
pub use sync::{
|
||||
@@ -127,10 +127,22 @@ pub fn gradle_external_roots(
|
||||
gradle::external_roots(root, dirs.iter().map(String::as_str))
|
||||
}
|
||||
|
||||
/// Directories of Maven POMs linked from outside `root`, outermost only.
|
||||
/// Reads just those explicit paths (no POM parse and no directory walk).
|
||||
pub fn maven_external_roots(root: &Path, linked: &[String]) -> Vec<PathBuf> {
|
||||
let dirs = maven::external_pom_dirs(root, linked);
|
||||
/// Directories outside `root`, outermost only, of Maven POMs linked from there and, in a
|
||||
/// trusted project, of the modules its reactor lists there (`<module>../service-a</module>`):
|
||||
/// extra content roots, as IDEA imports such modules with content roots of their own.
|
||||
/// Linked POMs are read as explicit paths; the reactor's POMs are parsed, but not their
|
||||
/// parents, and nothing walks directories. `cache_dir` holds the profiles chosen at the last sync.
|
||||
pub fn maven_external_roots(
|
||||
root: &Path,
|
||||
cache_dir: &Path,
|
||||
settings: &ide_core::settings::MavenSettings,
|
||||
trusted: bool,
|
||||
) -> Vec<PathBuf> {
|
||||
let mut dirs = maven::external_pom_dirs(root, &settings.linked_projects);
|
||||
if trusted {
|
||||
let profiles = settings.profiles(&sync::maven_profiles(cache_dir));
|
||||
dirs.extend(maven::reactor_external_dirs(root, &profiles, &settings.unlinked_projects));
|
||||
}
|
||||
let owned: Vec<String> = dirs.iter().map(|dir| dir.to_string_lossy().into_owned()).collect();
|
||||
gradle::external_roots(root, owned.iter().map(String::as_str))
|
||||
}
|
||||
@@ -251,6 +263,59 @@ mod tests {
|
||||
assert!(gradle_external_roots(&root, &temp.path().join("cache"), &settings).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reactor_modules_outside_the_root_are_content_roots_of_a_trusted_project() {
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
let base = dunce::canonicalize(temp.path()).unwrap();
|
||||
let root = base.join("workspace");
|
||||
let cache = base.join("cache");
|
||||
let write = |rel: &str, text: &str| {
|
||||
let path = base.join(rel).join("pom.xml");
|
||||
std::fs::create_dir_all(path.parent().unwrap()).unwrap();
|
||||
std::fs::write(path, format!("<project><artifactId>{rel}</artifactId>{text}</project>")).unwrap();
|
||||
};
|
||||
let reactor = |modules: &str| {
|
||||
format!(
|
||||
"<packaging>pom</packaging><modules>{modules}</modules>\
|
||||
<profiles><profile><id>extra</id><modules><module>../service-c</module></modules></profile></profiles>"
|
||||
)
|
||||
};
|
||||
let all = "<module>core</module><module>../service-a</module><module>..</module>";
|
||||
write("workspace", &reactor(all));
|
||||
write("workspace/core", "<modules><module>../../service-d</module></modules>");
|
||||
write("service-a", "<modules><module>impl</module><module>../service-e</module></modules>");
|
||||
for module in ["service-a/impl", "service-c", "service-d", "service-e", "unrelated"] {
|
||||
write(module, "");
|
||||
}
|
||||
// The folder holding the project is not a module beside it, nor are its other modules.
|
||||
write("", "<modules><module>workspace</module><module>unrelated</module></modules>");
|
||||
|
||||
let mut settings = ide_core::settings::MavenSettings::default();
|
||||
let roots = |settings: &ide_core::settings::MavenSettings, trusted| {
|
||||
maven_external_roots(&root, &cache, settings, trusted)
|
||||
};
|
||||
let (a, c, d, e) =
|
||||
(base.join("service-a"), base.join("service-c"), base.join("service-d"), base.join("service-e"));
|
||||
assert_eq!(roots(&settings, true), [a.clone(), d.clone(), e.clone()]);
|
||||
assert!(roots(&settings, false).is_empty(), "Restricted Mode does not widen the index");
|
||||
|
||||
settings.active_profiles = "extra".into();
|
||||
assert_eq!(roots(&settings, true), [a.clone(), c.clone(), d.clone(), e.clone()]);
|
||||
save_maven_profiles(&cache, &["!extra".into()]).unwrap();
|
||||
assert_eq!(roots(&settings, true), [a.clone(), d.clone(), e.clone()]);
|
||||
|
||||
settings.unlinked_projects = vec![a.join("pom.xml").to_string_lossy().replace('\\', "/")];
|
||||
assert_eq!(roots(&settings, true), std::slice::from_ref(&d));
|
||||
settings.unlinked_projects.clear();
|
||||
|
||||
write("workspace", &reactor("<module>core</module>"));
|
||||
assert_eq!(roots(&settings, true), std::slice::from_ref(&d));
|
||||
write("workspace/core", "");
|
||||
assert!(roots(&settings, true).is_empty());
|
||||
write("workspace", &reactor(all));
|
||||
assert_eq!(roots(&settings, true), [a, e]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn settings_profiles_and_checkbox_choices_control_modules_before_sync() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
|
||||
@@ -1235,6 +1235,86 @@ pub fn external_pom_dirs(root: &Path, linked: &[String]) -> Vec<PathBuf> {
|
||||
out
|
||||
}
|
||||
|
||||
type FileStamp = Option<(Option<std::time::SystemTime>, u64)>;
|
||||
|
||||
fn file_stamp(path: &Path) -> FileStamp {
|
||||
std::fs::metadata(path).ok().map(|m| (m.modified().ok(), m.len()))
|
||||
}
|
||||
|
||||
/// The POM files a reactor walk read or looked for, and the module folders it found outside the root.
|
||||
struct ReactorScan {
|
||||
stamps: Vec<(PathBuf, FileStamp)>,
|
||||
dirs: Vec<PathBuf>,
|
||||
}
|
||||
|
||||
/// Folders of the modules that the reactor of `root/pom.xml` lists outside `root`
|
||||
/// (`<module>../service-a</module>`), with their own modules in turn, including those of
|
||||
/// the active `profiles`. An `unlinked` POM leaves out its modules too. A folder that
|
||||
/// holds `root` (`<module>..</module>`) is not a module beside the project and is skipped.
|
||||
/// Callers keep the outermost directory only. Memoized on the POMs' modification times and
|
||||
/// sizes: content roots are read on hot paths (every references search, Find in Files).
|
||||
pub fn reactor_external_dirs(root: &Path, profiles: &[String], unlinked: &[String]) -> Vec<PathBuf> {
|
||||
type Memo = HashMap<(PathBuf, Vec<String>, Vec<String>), ReactorScan>;
|
||||
static MEMO: std::sync::LazyLock<Mutex<Memo>> = std::sync::LazyLock::new(Default::default);
|
||||
let key = (root.to_path_buf(), profiles.to_vec(), unlinked.to_vec());
|
||||
if let Some(scan) = MEMO.lock().unwrap_or_else(|e| e.into_inner()).get(&key)
|
||||
&& scan.stamps.iter().all(|(path, stamp)| file_stamp(path) == *stamp)
|
||||
{
|
||||
return scan.dirs.clone();
|
||||
}
|
||||
let scan = scan_reactor(root, profiles, unlinked);
|
||||
let dirs = scan.dirs.clone();
|
||||
MEMO.lock().unwrap_or_else(|e| e.into_inner()).insert(key, scan);
|
||||
dirs
|
||||
}
|
||||
|
||||
/// Reads only the POMs the reactor lists (no parent resolution and no directory walk).
|
||||
fn scan_reactor(root: &Path, profiles: &[String], unlinked: &[String]) -> ReactorScan {
|
||||
let canonical_root = dunce::canonicalize(root).unwrap_or_else(|_| root.to_path_buf());
|
||||
let chosen = Resolver::new(None, profiles);
|
||||
let unlinked: HashSet<String> = unlinked.iter().map(|p| normalized_pom(p.trim())).collect();
|
||||
let first = root.join("pom.xml");
|
||||
let mut scan = ReactorScan { stamps: vec![(first.clone(), file_stamp(&first))], dirs: Vec::new() };
|
||||
let mut seen: HashSet<PathBuf> = HashSet::new();
|
||||
let mut pending = vec![first];
|
||||
while let Some(path) = pending.pop() {
|
||||
if seen.len() >= MAX_PROJECTS {
|
||||
break;
|
||||
}
|
||||
let canonical = dunce::canonicalize(&path).unwrap_or_else(|_| path.clone());
|
||||
if !seen.insert(canonical.clone()) || unlinked.contains(&project_rel(&canonical_root, &canonical)) {
|
||||
continue;
|
||||
}
|
||||
let Some(pom) = xml::read_text(&path).as_deref().and_then(parse_pom) else { continue };
|
||||
let dir = path.parent().unwrap_or(root).to_path_buf();
|
||||
let dir_canon = dunce::canonicalize(&dir).unwrap_or_else(|_| dir.clone());
|
||||
if !dir_canon.starts_with(&canonical_root) {
|
||||
if canonical_root.starts_with(&dir_canon) {
|
||||
continue;
|
||||
}
|
||||
scan.dirs.push(dir_canon);
|
||||
}
|
||||
let active: Vec<&RawProfile> = chosen.active(&pom.profiles).collect();
|
||||
let props: HashMap<String, String> =
|
||||
pom.properties.iter().chain(active.iter().flat_map(|p| &p.properties)).cloned().collect();
|
||||
for module in pom.modules.iter().chain(active.iter().flat_map(|p| &p.modules)) {
|
||||
let module = interpolate(module, &props);
|
||||
if module.contains("${") {
|
||||
continue;
|
||||
}
|
||||
let mut mp = crate::gradle::normalize(&dir.join(module));
|
||||
if mp.is_dir() || mp.extension().is_none_or(|e| e != "xml") {
|
||||
mp.push("pom.xml");
|
||||
}
|
||||
scan.stamps.push((mp.clone(), file_stamp(&mp)));
|
||||
if mp.is_file() {
|
||||
pending.push(mp);
|
||||
}
|
||||
}
|
||||
}
|
||||
scan
|
||||
}
|
||||
|
||||
/// Whether `root` holds a Maven build or the settings link one inside it.
|
||||
pub fn has_projects(root: &Path, settings: &ide_core::settings::MavenSettings) -> bool {
|
||||
is_maven_project(root) || !linked_poms(root, &settings.linked_projects).is_empty()
|
||||
@@ -2479,8 +2559,12 @@ mod tests {
|
||||
assert_eq!(normalized[0], dunce::canonicalize(b.join("pom.xml")).unwrap().to_string_lossy().replace('\\', "/"));
|
||||
assert_eq!(normalized[1], "pom.xml");
|
||||
assert_eq!(normalized[2], "stub/pom.xml");
|
||||
assert_eq!(crate::maven_external_roots(&a, &normalized), vec![b.clone()]);
|
||||
assert_eq!(crate::maven_external_roots(&a, &stored), vec![b.clone()]);
|
||||
let external_roots = |linked: &[String]| {
|
||||
let settings = ide_core::settings::MavenSettings { linked_projects: linked.to_vec(), ..Default::default() };
|
||||
crate::maven_external_roots(&a, &base.join("cache"), &settings, true)
|
||||
};
|
||||
assert_eq!(external_roots(&normalized), vec![b.clone()]);
|
||||
assert_eq!(external_roots(&stored), vec![b.clone()]);
|
||||
|
||||
let removed = load_with_linked(&a, None, &[], &[]);
|
||||
assert!(removed.projects.iter().all(|p| p.artifact_id != "b"));
|
||||
|
||||
@@ -136,11 +136,11 @@ pub fn save_maven_profiles(cache_dir: &Path, profiles: &[String]) -> IdeResult<b
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
fn read_cache<T: DeserializeOwned>(dir: &Path, name: &str) -> Option<T> {
|
||||
pub(crate) fn read_cache<T: DeserializeOwned>(dir: &Path, name: &str) -> Option<T> {
|
||||
serde_json::from_slice(&std::fs::read(dir.join(name)).ok()?).ok()
|
||||
}
|
||||
|
||||
fn write_cache<T: Serialize>(dir: &Path, name: &str, value: &T) -> IdeResult<()> {
|
||||
pub(crate) fn write_cache<T: Serialize>(dir: &Path, name: &str, value: &T) -> IdeResult<()> {
|
||||
std::fs::create_dir_all(dir)?;
|
||||
let json = serde_json::to_vec(value).map_err(|e| IdeError::internal(e.to_string()))?;
|
||||
let tmp = dir.join(format!("{name}.tmp"));
|
||||
@@ -156,7 +156,7 @@ fn hash_files(files: &[PathBuf]) -> String {
|
||||
|
||||
/// Like IDEA's auto-import CRC: editing a comment or reformatting a build script
|
||||
/// does not make the last sync stale.
|
||||
fn hash_gradle_files(files: &[PathBuf]) -> String {
|
||||
pub(crate) fn hash_gradle_files(files: &[PathBuf]) -> String {
|
||||
hash_contents(files, |f| {
|
||||
let text = std::fs::read_to_string(f).unwrap_or_default();
|
||||
let script = f.extension().is_some_and(|e| e == "gradle" || e == "kts");
|
||||
|
||||
@@ -343,6 +343,8 @@ pub struct InlayHintsSettings {
|
||||
/// Hints of other kinds (chaining, closing labels…).
|
||||
pub other: bool,
|
||||
pub disabled_languages: Vec<String>,
|
||||
/// Code vision as a whole (usages, author and language-server lenses); the switches below apply while it is on.
|
||||
pub code_vision: bool,
|
||||
/// Code vision: usages above declarations.
|
||||
pub code_vision_usages: bool,
|
||||
/// Code vision: last author of a declaration (VCS blame) beside its usages.
|
||||
@@ -373,6 +375,7 @@ impl Default for InlayHintsSettings {
|
||||
parameters: true,
|
||||
other: true,
|
||||
disabled_languages: Vec::new(),
|
||||
code_vision: true,
|
||||
code_vision_usages: true,
|
||||
code_vision_author: true,
|
||||
code_vision_no_usages: true,
|
||||
|
||||
@@ -38,6 +38,11 @@ pub enum IdeEvent {
|
||||
WindowGroupsChanged,
|
||||
/// A window entered or left full screen, itself or as a member of a full-screen window group.
|
||||
WindowFullscreenChanged,
|
||||
/// This remote window's connection to its host ended on its own (network loss, the host or
|
||||
/// its server went away); the window's project is unreachable until it reconnects.
|
||||
RemoteConnectionLost {
|
||||
host: String,
|
||||
},
|
||||
ProjectTrustChanged {
|
||||
root: crate::IpcPath,
|
||||
trusted: bool,
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
|
||||
/// The Windows OS build used by ConPTY; unavailable on other platforms or on query failure.
|
||||
#[cfg(windows)]
|
||||
pub fn windows_build_number() -> Option<u32> {
|
||||
@@ -16,6 +19,61 @@ pub fn windows_build_number() -> Option<u32> {
|
||||
None
|
||||
}
|
||||
|
||||
/// A caption button of a frameless window's title bar.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum WindowButton {
|
||||
Minimize,
|
||||
Maximize,
|
||||
Close,
|
||||
}
|
||||
|
||||
/// Which caption buttons the title bar shows on each side, in order from left to right.
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct WindowButtonLayout {
|
||||
pub left: Vec<WindowButton>,
|
||||
pub right: Vec<WindowButton>,
|
||||
}
|
||||
|
||||
impl Default for WindowButtonLayout {
|
||||
/// Minimise, maximise, close on the right (Windows, and Linux when the desktop says nothing).
|
||||
fn default() -> Self {
|
||||
Self { left: Vec::new(), right: vec![WindowButton::Minimize, WindowButton::Maximize, WindowButton::Close] }
|
||||
}
|
||||
}
|
||||
|
||||
impl WindowButtonLayout {
|
||||
/// Reads GTK's `gtk-decoration-layout` (also GNOME's `button-layout`): button names separated
|
||||
/// by commas, the left side before the colon, e.g. `close,maximize,minimize:icon`. Names other
|
||||
/// than the three caption buttons (`icon`, `menu`, `appmenu`, `spacer`) are skipped, as are
|
||||
/// repeats. A value without any caption button is unusable for a frameless window: `None`.
|
||||
pub fn from_gtk_decoration_layout(layout: &str) -> Option<Self> {
|
||||
let mut seen = Vec::new();
|
||||
let mut side = |part: Option<&str>| {
|
||||
let mut buttons = Vec::new();
|
||||
for name in part.unwrap_or_default().split(',') {
|
||||
let button = match name.trim() {
|
||||
"minimize" => WindowButton::Minimize,
|
||||
"maximize" => WindowButton::Maximize,
|
||||
"close" => WindowButton::Close,
|
||||
_ => continue,
|
||||
};
|
||||
if !seen.contains(&button) {
|
||||
seen.push(button);
|
||||
buttons.push(button);
|
||||
}
|
||||
}
|
||||
buttons
|
||||
};
|
||||
// GTK splits at the first colon only; without one, every button is on the left.
|
||||
let mut parts = layout.splitn(2, ':');
|
||||
let left = side(parts.next());
|
||||
let right = side(parts.next());
|
||||
(!left.is_empty() || !right.is_empty()).then_some(Self { left, right })
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
@@ -26,4 +84,42 @@ mod tests {
|
||||
#[cfg(not(windows))]
|
||||
assert_eq!(build, None);
|
||||
}
|
||||
|
||||
use super::{WindowButton::*, WindowButtonLayout};
|
||||
|
||||
fn layout(left: &[super::WindowButton], right: &[super::WindowButton]) -> Option<WindowButtonLayout> {
|
||||
Some(WindowButtonLayout { left: left.to_vec(), right: right.to_vec() })
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reads_gtk_decoration_layouts() {
|
||||
let cases = [
|
||||
// KDE Plasma with `ButtonsOnLeft=XAIS` (#3794).
|
||||
("close,maximize,minimize:icon", layout(&[Close, Maximize, Minimize], &[])),
|
||||
("close,minimize,maximize:", layout(&[Close, Minimize, Maximize], &[])),
|
||||
(":minimize,maximize,close", layout(&[], &[Minimize, Maximize, Close])),
|
||||
// GNOME's default.
|
||||
("appmenu:close", layout(&[], &[Close])),
|
||||
("menu:minimize,close", layout(&[], &[Minimize, Close])),
|
||||
("icon,close:minimize,maximize", layout(&[Close], &[Minimize, Maximize])),
|
||||
(" close , spacer : minimize ", layout(&[Close], &[Minimize])),
|
||||
// No colon: GTK puts everything on the left.
|
||||
("close,minimize", layout(&[Close, Minimize], &[])),
|
||||
// Only the first colon separates the sides; a button appears once.
|
||||
("close:minimize:maximize", layout(&[Close], &[])),
|
||||
("close,close:close,minimize", layout(&[Close], &[Minimize])),
|
||||
("", None),
|
||||
(":", None),
|
||||
("appmenu:", None),
|
||||
("garbage", None),
|
||||
];
|
||||
for (value, expected) in cases {
|
||||
assert_eq!(WindowButtonLayout::from_gtk_decoration_layout(value), expected, "{value:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn default_layout_is_on_the_right() {
|
||||
assert_eq!(WindowButtonLayout::default(), layout(&[], &[Minimize, Maximize, Close]).unwrap());
|
||||
}
|
||||
}
|
||||
@@ -653,6 +653,10 @@ pub struct NotificationSettings {
|
||||
/// Mirror balloon notifications to the OS when no OpenIDEA window is focused.
|
||||
#[serde(default = "default_true")]
|
||||
pub system_notifications: bool,
|
||||
/// Terminal command completions (#3712): `off` | `longRunning` | `all`.
|
||||
pub terminal_completion: String,
|
||||
/// `longRunning`: the run time a finished command must reach, in seconds.
|
||||
pub terminal_threshold_seconds: u32,
|
||||
/// Group id → display; groups not listed use their default.
|
||||
pub groups: BTreeMap<String, NotificationGroupSettings>,
|
||||
}
|
||||
@@ -661,9 +665,24 @@ fn default_true() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn default_terminal_completion() -> String {
|
||||
"longRunning".to_owned()
|
||||
}
|
||||
|
||||
fn default_terminal_threshold_seconds() -> u32 {
|
||||
10
|
||||
}
|
||||
|
||||
impl Default for NotificationSettings {
|
||||
fn default() -> Self {
|
||||
Self { balloons: true, sound: false, system_notifications: true, groups: BTreeMap::new() }
|
||||
Self {
|
||||
balloons: true,
|
||||
sound: false,
|
||||
system_notifications: true,
|
||||
terminal_completion: default_terminal_completion(),
|
||||
terminal_threshold_seconds: default_terminal_threshold_seconds(),
|
||||
groups: BTreeMap::new(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -741,6 +760,9 @@ pub struct AppearanceSettings {
|
||||
pub main_menu_style: String,
|
||||
/// A lone Alt press focuses or opens the main menu (IDEA `ide.windows.main.menu.focus.on.alt`).
|
||||
pub main_menu_alt: bool,
|
||||
/// Settings open in a native window of their own (IDEA parity); off opens them
|
||||
/// as a dialog inside the project window, which needs no new webview.
|
||||
pub settings_in_separate_window: bool,
|
||||
/// `subpixel` | `greyscale` | `none`
|
||||
pub ide_antialiasing: String,
|
||||
pub editor_antialiasing: String,
|
||||
@@ -840,6 +862,7 @@ impl Default for AppearanceSettings {
|
||||
menu_icons: true,
|
||||
main_menu_style: "hamburger".into(),
|
||||
main_menu_alt: true,
|
||||
settings_in_separate_window: true,
|
||||
ide_antialiasing: "greyscale".into(),
|
||||
editor_antialiasing: "greyscale".into(),
|
||||
show_tool_window_bars: true,
|
||||
@@ -892,7 +915,13 @@ pub struct EditorSettings {
|
||||
pub docstring_format: String,
|
||||
/// Color Scheme › Language Defaults › Rainbow brackets: `()`, `[]`, `{}` coloured by depth.
|
||||
pub rainbow_brackets: bool,
|
||||
/// The bracket kinds rainbow brackets colour.
|
||||
pub rainbow_bracket_kinds: RainbowBracketKinds,
|
||||
/// Colours the rainbow bracket depth cycles through (2–5).
|
||||
pub rainbow_bracket_colors: u32,
|
||||
pub ligatures: bool,
|
||||
/// Editor › Font and Tools › Terminal › Font: the font pickers list only monospaced fonts.
|
||||
pub only_monospaced_fonts: bool,
|
||||
/// Fallback font for glyphs the main font lacks; empty = none.
|
||||
pub fallback_font: String,
|
||||
/// Typography Settings › Main font weight (CSS 100–900), as IDEA.
|
||||
@@ -936,7 +965,10 @@ impl Default for EditorSettings {
|
||||
semantic_highlighting: false,
|
||||
docstring_format: "rest".into(),
|
||||
rainbow_brackets: false,
|
||||
rainbow_bracket_kinds: RainbowBracketKinds::default(),
|
||||
rainbow_bracket_colors: 3,
|
||||
ligatures: false,
|
||||
only_monospaced_fonts: true,
|
||||
fallback_font: String::new(),
|
||||
font_weight: 400,
|
||||
bold_font_weight: 700,
|
||||
@@ -959,6 +991,23 @@ impl Default for EditorSettings {
|
||||
}
|
||||
}
|
||||
|
||||
/// Color Scheme › Language Defaults › Rainbow brackets: which delimiters are coloured.
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(default, rename_all = "camelCase")]
|
||||
pub struct RainbowBracketKinds {
|
||||
pub round: bool,
|
||||
pub square: bool,
|
||||
pub curly: bool,
|
||||
/// Type argument / parameter delimiters and markup tags, where the syntax tree marks them.
|
||||
pub angle: bool,
|
||||
}
|
||||
|
||||
impl Default for RainbowBracketKinds {
|
||||
fn default() -> Self {
|
||||
Self { round: true, square: true, curly: true, angle: false }
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Type)]
|
||||
#[serde(default, rename_all = "camelCase")]
|
||||
pub struct FileSettings {
|
||||
@@ -1751,6 +1800,41 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rainbow_bracket_options_default_and_round_trip() {
|
||||
let old: Settings = serde_json::from_str(r#"{"editor":{"rainbowBrackets":true}}"#).unwrap();
|
||||
assert!(old.editor.rainbow_brackets);
|
||||
assert_eq!(old.editor.rainbow_bracket_kinds, RainbowBracketKinds::default());
|
||||
assert_eq!(old.editor.rainbow_bracket_colors, 3);
|
||||
let defaults = Settings::default().editor;
|
||||
assert!(!defaults.rainbow_brackets);
|
||||
let kinds = defaults.rainbow_bracket_kinds;
|
||||
assert!(kinds.round && kinds.square && kinds.curly && !kinds.angle);
|
||||
|
||||
let mut settings = Settings::default();
|
||||
settings.editor.rainbow_bracket_kinds =
|
||||
RainbowBracketKinds { round: false, square: true, curly: true, angle: true };
|
||||
settings.editor.rainbow_bracket_colors = 5;
|
||||
let json = serde_json::to_value(&settings).unwrap();
|
||||
assert_eq!(json["editor"]["rainbowBracketKinds"]["angle"], true);
|
||||
assert_eq!(json["editor"]["rainbowBracketColors"], 5);
|
||||
let restored: Settings = serde_json::from_value(json).unwrap();
|
||||
assert_eq!(restored.editor.rainbow_bracket_kinds, settings.editor.rainbow_bracket_kinds);
|
||||
assert_eq!(restored.editor.rainbow_bracket_colors, 5);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_monospaced_fonts_defaults_on_and_round_trips() {
|
||||
let old: Settings = serde_json::from_str(r#"{"editor":{"ligatures":true}}"#).unwrap();
|
||||
assert!(old.editor.only_monospaced_fonts);
|
||||
let mut settings = Settings::default();
|
||||
settings.editor.only_monospaced_fonts = false;
|
||||
let json = serde_json::to_value(&settings).unwrap();
|
||||
assert_eq!(json["editor"]["onlyMonospacedFonts"], false);
|
||||
let restored: Settings = serde_json::from_value(json).unwrap();
|
||||
assert!(!restored.editor.only_monospaced_fonts);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn docstring_format_defaults_and_round_trips() {
|
||||
let old: Settings = serde_json::from_str(r#"{"editor":{"semanticHighlighting":true}}"#).unwrap();
|
||||
@@ -1849,6 +1933,15 @@ mod tests {
|
||||
assert_eq!(serde_json::to_value(off).unwrap()["appearance"]["mainMenuAlt"], false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn settings_open_in_a_separate_window_unless_turned_off() {
|
||||
let old: Settings = serde_json::from_str(r#"{"appearance":{"compactMode":true}}"#).unwrap();
|
||||
assert!(old.appearance.settings_in_separate_window);
|
||||
let off: Settings = serde_json::from_str(r#"{"appearance":{"settingsInSeparateWindow":false}}"#).unwrap();
|
||||
assert!(!off.appearance.settings_in_separate_window);
|
||||
assert_eq!(serde_json::to_value(off).unwrap()["appearance"]["settingsInSeparateWindow"], false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn editor_font_weights_default_to_regular_and_bold() {
|
||||
let json = serde_json::to_value(Settings::default()).unwrap();
|
||||
|
||||
@@ -43,6 +43,9 @@ impl Default for VcsSettings {
|
||||
pub struct GitSettings {
|
||||
/// Show blame after the current editor line.
|
||||
pub inline_blame: bool,
|
||||
/// A click (or Enter / Space) on the inline blame label opens its commit; off, the
|
||||
/// label is plain text and a click on it places the caret as past the line end.
|
||||
pub inline_blame_clickable: bool,
|
||||
pub show_branch_in_project_view: bool,
|
||||
/// Path to the git executable; empty = auto-detect.
|
||||
pub executable: String,
|
||||
@@ -54,6 +57,8 @@ pub struct GitSettings {
|
||||
pub warn_detached_head: bool,
|
||||
/// Background check for incoming commits: `auto` | `always` | `never`.
|
||||
pub incoming_check: String,
|
||||
/// Minutes between background checks for incoming commits.
|
||||
pub incoming_check_interval: u32,
|
||||
/// Branch name globs, `;`/`,`-separated; force push to them is prohibited.
|
||||
pub protected_branches: String,
|
||||
/// Initial state of Commit Options › Sign-off Commit.
|
||||
@@ -78,6 +83,7 @@ impl Default for GitSettings {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
inline_blame: false,
|
||||
inline_blame_clickable: true,
|
||||
show_branch_in_project_view: false,
|
||||
executable: String::new(),
|
||||
update_method: "merge".into(),
|
||||
@@ -85,6 +91,7 @@ impl Default for GitSettings {
|
||||
warn_crlf: true,
|
||||
warn_detached_head: true,
|
||||
incoming_check: "auto".into(),
|
||||
incoming_check_interval: 15,
|
||||
protected_branches: "master; main".into(),
|
||||
sign_off: false,
|
||||
warn_large_files: true,
|
||||
|
||||
@@ -216,6 +216,11 @@ fn settle<T>(result: Result<T, InspectError>) -> IdeResult<Result<T, JvmInspectU
|
||||
InspectError::TimedOut => U::TimedOut,
|
||||
InspectError::Closed => U::BackendClosed,
|
||||
InspectError::Failed(message) => return Err(IdeError::internal(format!("JVM inspector: {message}"))),
|
||||
// Only the stream trace commands answer these, never the memory view's.
|
||||
other @ (InspectError::NoSession
|
||||
| InspectError::NotAtChainStart(_)
|
||||
| InspectError::Busy
|
||||
| InspectError::NoTrace) => return Err(IdeError::internal(format!("JVM inspector: {other}"))),
|
||||
}))
|
||||
}
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ use std::time::Duration;
|
||||
|
||||
pub use heap::*;
|
||||
pub use inspect::{JvmFieldsResult, JvmInspectUnavailable, JvmInstancesResult, JvmObjectRef, JvmReferrersResult};
|
||||
pub(crate) use inspect::{fields, instances, referrers, set_inspector, watch_link};
|
||||
pub(crate) use inspect::{fields, instances, referrers, set_inspector, vm_target, watch_link};
|
||||
#[cfg(all(test, unix))]
|
||||
pub(crate) use scan::watch_for_attached_jvm;
|
||||
pub(crate) use scan::{JvmFinder, attach_target, find_attached_jvm, find_local_jvm, local_jdwp_port};
|
||||
|
||||
@@ -19,6 +19,7 @@ mod jvm_memory;
|
||||
pub mod kotlin;
|
||||
pub mod kotlin_lsp;
|
||||
mod session;
|
||||
mod stream_trace;
|
||||
pub mod unity;
|
||||
|
||||
use adapter::{AdapterLauncher, AdapterSpec, ProcessLauncher};
|
||||
@@ -39,6 +40,7 @@ use std::path::{Path, PathBuf};
|
||||
use std::sync::atomic::Ordering;
|
||||
use std::sync::{Arc, Weak};
|
||||
use std::time::Duration;
|
||||
pub use stream_trace::{TracePhase, TraceProgress, TraceRun, TraceUnavailable};
|
||||
|
||||
#[derive(Clone, Debug, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
@@ -146,6 +148,9 @@ pub struct DebugCapabilities {
|
||||
pub js_page: bool,
|
||||
/// The adapter evaluates expressions while the program runs, without a stack frame.
|
||||
pub live_evaluate: bool,
|
||||
/// A stream chain can be traced while the program runs it ([`DebugManager::stream_trace`]).
|
||||
/// Can change during the session, like `jvm_instances`.
|
||||
pub stream_trace: bool,
|
||||
}
|
||||
|
||||
/// Result of [`DebugManager::redefine_classes`].
|
||||
@@ -602,6 +607,7 @@ pub(crate) fn capabilities_from(caps: &Value) -> DebugCapabilities {
|
||||
jvm_heap: false,
|
||||
js_page: false,
|
||||
live_evaluate: false,
|
||||
stream_trace: false,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -613,6 +619,7 @@ pub(crate) fn session_capabilities(session: &Session) -> DebugCapabilities {
|
||||
caps.jvm_heap = JVM_MEMORY_ADAPTERS.contains(&session.adapter.as_str());
|
||||
caps.js_page = js_debug::is_page(session);
|
||||
caps.live_evaluate = session.adapter == js_debug::ADAPTER;
|
||||
caps.stream_trace = stream_trace::available(session);
|
||||
caps
|
||||
}
|
||||
|
||||
@@ -1873,6 +1880,42 @@ impl DebugManager {
|
||||
jvm_memory::referrers(&*self.session(s)?, object, limit).await
|
||||
}
|
||||
|
||||
/// Gives the session the backend for [`Self::stream_trace`] (used by java-debug sessions
|
||||
/// only); the UI is told to reload the session's capabilities.
|
||||
pub fn set_stream_tracer(
|
||||
&self,
|
||||
s: DebugSessionId,
|
||||
tracer: Arc<dyn ide_jvm_inspect::StreamTracer>,
|
||||
) -> IdeResult<()> {
|
||||
let session = self.session(s)?;
|
||||
if session.ended.is_cancelled() {
|
||||
return Err(no_session(s));
|
||||
}
|
||||
stream_trace::set_tracer(&session, tracer);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Traces the stream chain `plan` (the JSON of `ide_streams::RealRunPlan`) while the program
|
||||
/// runs it, from `thread_id` stopped where the chain starts. Leaves the thread stopped right
|
||||
/// after the chain's terminal operation. `cancel` stops keeping records; the program runs on.
|
||||
pub async fn stream_trace(
|
||||
&self,
|
||||
s: DebugSessionId,
|
||||
thread_id: i64,
|
||||
plan: Value,
|
||||
cancel: ide_core::CancellationToken,
|
||||
progress: impl Fn(TraceProgress) + Send + Sync,
|
||||
) -> IdeResult<TraceRun> {
|
||||
let session = self.session(s)?;
|
||||
Ok(stream_trace::run(self, &session, thread_id, &plan, &cancel, &progress).await)
|
||||
}
|
||||
|
||||
/// Ends the running terminal operation by interrupting its thread, then by throwing into it.
|
||||
/// `None` when no trace runs.
|
||||
pub async fn stream_trace_abort(&self, s: DebugSessionId) -> IdeResult<Option<ide_jvm_inspect::AbortState>> {
|
||||
stream_trace::abort(&*self.session(s)?).await
|
||||
}
|
||||
|
||||
/// HotSwap: reloads the classes compiled since the session started (or since the
|
||||
/// last reload) into the debuggee (java-debug `redefineClasses`).
|
||||
pub async fn redefine_classes(&self, s: DebugSessionId) -> IdeResult<HotSwapResult> {
|
||||
|
||||
@@ -114,6 +114,8 @@ pub(crate) struct Session {
|
||||
pub jvm_located: watch::Sender<bool>,
|
||||
pub kotlin_mirror: Mutex<Option<crate::kotlin::SourceMirror>>,
|
||||
pub jvm_memory: tokio::sync::Mutex<crate::JvmMemoryState>,
|
||||
pub stream_tracer: parking_lot::Mutex<Option<Arc<dyn ide_jvm_inspect::StreamTracer>>>,
|
||||
pub(crate) stream_trace: parking_lot::Mutex<Option<crate::stream_trace::ActiveTrace>>,
|
||||
/// Used only by a kotlin-lsp session: see [`Session::kotlin_lsp_quirks`].
|
||||
pub(crate) quirks: kotlin_lsp::Quirks,
|
||||
pub(crate) unity_startup_activity: Mutex<Instant>,
|
||||
@@ -195,6 +197,13 @@ impl Suspension {
|
||||
self.0.lock().ticket
|
||||
}
|
||||
|
||||
/// The ticket of a stop of `thread` (its own or every thread's) taken after ticket `after`.
|
||||
pub fn stopped_since(&self, thread: i64, after: u64) -> Option<u64> {
|
||||
let stops = self.0.lock();
|
||||
let own = stops.threads.iter().find(|&&(id, _)| id == thread).map(|&(_, ticket)| ticket);
|
||||
own.max(stops.all).filter(|&ticket| ticket > after)
|
||||
}
|
||||
|
||||
/// After a successful resume-like request for `thread`; `all`: every thread ran.
|
||||
pub fn resumed(&self, ticket: u64, thread: i64, all: bool) {
|
||||
self.0.lock().release(Some(thread), all, ticket);
|
||||
@@ -270,6 +279,8 @@ impl Session {
|
||||
jvm_located: watch::channel(false).0,
|
||||
kotlin_mirror: Mutex::new(None),
|
||||
jvm_memory: tokio::sync::Mutex::default(),
|
||||
stream_tracer: parking_lot::Mutex::new(None),
|
||||
stream_trace: parking_lot::Mutex::new(None),
|
||||
quirks: kotlin_lsp::Quirks::default(),
|
||||
unity_startup_activity: Mutex::new(Instant::now()),
|
||||
}
|
||||
@@ -741,6 +752,9 @@ async fn on_event(mgr: &Arc<DebugManager>, s: &Arc<Session>, event: &str, mut bo
|
||||
}
|
||||
"stopped" => {
|
||||
let all = body.get("allThreadsStopped").and_then(Value::as_bool).unwrap_or(false);
|
||||
if crate::stream_trace::resume_traced_stop(s, int("threadId"), all) {
|
||||
return;
|
||||
}
|
||||
s.suspended.stopped(int("threadId"), all);
|
||||
let mut reason = str_("reason").unwrap_or_else(|| "pause".into());
|
||||
if let Some(quirks) = s.kotlin_lsp_quirks() {
|
||||
|
||||
@@ -0,0 +1,377 @@
|
||||
//! A stream chain traced while the program itself runs it. The JDT LS bundle arms the trace with
|
||||
//! the thread stopped where the chain starts; the program runs on `continue`, and the bundle holds
|
||||
//! the thread inside the terminal operation once it has run, until a `stepOut` brings java-debug
|
||||
//! to a stop of its own in which the records are read.
|
||||
|
||||
use crate::jvm_memory::vm_target;
|
||||
use crate::session::Session;
|
||||
use crate::{DebugManager, StepKind};
|
||||
use ide_core::event::DebugEvent;
|
||||
use ide_core::{CancellationToken, IdeError, IdeResult};
|
||||
use ide_jvm_inspect::{
|
||||
AbortState, InspectError, InspectFuture, StreamTracer, TraceCollected, TraceId, TraceState, VmTarget,
|
||||
};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::Value;
|
||||
use specta::Type;
|
||||
use std::future::Future;
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
/// Records the bundle keeps; later ones are only counted.
|
||||
const BUDGET: u32 = 50_000;
|
||||
const WAIT_MS: u32 = 500;
|
||||
const STOP_POLL: Duration = Duration::from_millis(20);
|
||||
const STOP_WAIT: Duration = Duration::from_secs(30);
|
||||
const RESUME_TIMEOUT: Duration = Duration::from_secs(30);
|
||||
/// The bundle reaches the JVM through java-debug's own session.
|
||||
const ADAPTER: &str = "java-debug";
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct TraceProgress {
|
||||
pub phase: TracePhase,
|
||||
pub records: u64,
|
||||
pub dropped: u64,
|
||||
/// Since the program started running the chain, as the bundle measures it.
|
||||
pub elapsed_ms: u64,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum TracePhase {
|
||||
Arming,
|
||||
Running,
|
||||
/// The terminal operation runs on, keeping no more records.
|
||||
RecordingStopped,
|
||||
Aborting,
|
||||
/// The terminal operation finished: stepping out of it and reading the records.
|
||||
Collecting,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub enum TraceRun {
|
||||
/// `generation`: the stop the records were read in, the only one their objects are valid in.
|
||||
Done {
|
||||
collected: TraceCollected,
|
||||
generation: u64,
|
||||
/// Stops of the traced thread while the program ran the chain, resumed unseen.
|
||||
resumed_stops: u32,
|
||||
},
|
||||
Unavailable {
|
||||
reason: TraceUnavailable,
|
||||
},
|
||||
Failed {
|
||||
detail: String,
|
||||
},
|
||||
/// Stop Recording or Abort Operation came before the terminal operation ran.
|
||||
Cancelled {
|
||||
detail: String,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "kind", rename_all = "camelCase", rename_all_fields = "camelCase")]
|
||||
pub enum TraceUnavailable {
|
||||
/// Not a java-debug session, or no JDT LS bundle behind it.
|
||||
NoBackend,
|
||||
NotSuspended,
|
||||
NotAtChainStart {
|
||||
detail: String,
|
||||
},
|
||||
/// A trace already runs in this session or its JVM.
|
||||
Busy,
|
||||
/// java-debug has no debug session for the JVM.
|
||||
NoSession,
|
||||
Unsupported {
|
||||
detail: String,
|
||||
},
|
||||
}
|
||||
|
||||
/// The session's running trace; `id` is `None` until `arm` answers.
|
||||
pub(crate) struct ActiveTrace {
|
||||
tracer: Arc<dyn StreamTracer>,
|
||||
target: VmTarget,
|
||||
id: Option<TraceId>,
|
||||
aborting: bool,
|
||||
thread_id: i64,
|
||||
/// From the `continue` that runs the chain until the bundle holds the thread after it.
|
||||
running: bool,
|
||||
resumed_stops: u32,
|
||||
}
|
||||
|
||||
/// A stop of the traced thread while the program runs the chain is resumed instead of shown, as
|
||||
/// IntelliJ does (spec G5): the UI keeps Resume locked meanwhile, and a breakpoint java-debug set
|
||||
/// since the bundle last switched them off, hit inside the terminal's invoke, would hold that
|
||||
/// invoke forever. java-debug stops a breakpoint's thread alone; a stop of every thread is shown.
|
||||
/// `true` when the stop was taken.
|
||||
pub(crate) fn resume_traced_stop(s: &Arc<Session>, thread_id: Option<i64>, all: bool) -> bool {
|
||||
let Some(thread_id) = thread_id.filter(|_| !all) else { return false };
|
||||
{
|
||||
let mut slot = s.stream_trace.lock();
|
||||
let Some(active) = slot.as_mut().filter(|a| a.running && a.thread_id == thread_id) else { return false };
|
||||
active.resumed_stops += 1;
|
||||
}
|
||||
let s = s.clone();
|
||||
tokio::spawn(async move {
|
||||
let sent =
|
||||
s.conn.request_timeout("continue", serde_json::json!({ "threadId": thread_id }), RESUME_TIMEOUT).await;
|
||||
if let Err(e) = sent {
|
||||
tracing::warn!(session = s.id.0, thread_id, "resuming a stop inside a stream trace: {e}");
|
||||
}
|
||||
});
|
||||
true
|
||||
}
|
||||
|
||||
fn set_running(s: &Session, running: bool) {
|
||||
if let Some(active) = s.stream_trace.lock().as_mut() {
|
||||
active.running = running;
|
||||
}
|
||||
}
|
||||
|
||||
/// Frees the session for the next trace however this one ends, a dropped future included.
|
||||
struct Claim<'s>(&'s Session);
|
||||
|
||||
impl Drop for Claim<'_> {
|
||||
fn drop(&mut self) {
|
||||
self.0.stream_trace.lock().take();
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn set_tracer(s: &Session, tracer: Arc<dyn StreamTracer>) {
|
||||
*s.stream_tracer.lock() = Some(tracer);
|
||||
s.emit(DebugEvent::Capabilities);
|
||||
}
|
||||
|
||||
fn tracer(s: &Session) -> Option<Arc<dyn StreamTracer>> {
|
||||
s.stream_tracer.lock().clone().filter(|_| s.adapter == ADAPTER)
|
||||
}
|
||||
|
||||
pub(crate) fn available(s: &Session) -> bool {
|
||||
tracer(s).is_some()
|
||||
}
|
||||
|
||||
pub(crate) async fn run(
|
||||
mgr: &DebugManager,
|
||||
s: &Session,
|
||||
thread_id: i64,
|
||||
plan: &Value,
|
||||
cancel: &CancellationToken,
|
||||
progress: &(impl Fn(TraceProgress) + Send + Sync),
|
||||
) -> TraceRun {
|
||||
let unavailable = |reason| TraceRun::Unavailable { reason };
|
||||
let Some(tracer) = tracer(s) else { return unavailable(TraceUnavailable::NoBackend) };
|
||||
let target = vm_target(s);
|
||||
let _claim = {
|
||||
let mut slot = s.stream_trace.lock();
|
||||
if slot.is_some() {
|
||||
return unavailable(TraceUnavailable::Busy);
|
||||
}
|
||||
*slot = Some(ActiveTrace {
|
||||
tracer: tracer.clone(),
|
||||
target: target.clone(),
|
||||
id: None,
|
||||
aborting: false,
|
||||
thread_id,
|
||||
running: false,
|
||||
resumed_stops: 0,
|
||||
});
|
||||
Claim(s)
|
||||
};
|
||||
if !s.suspended.get() {
|
||||
return unavailable(TraceUnavailable::NotSuspended);
|
||||
}
|
||||
let mut trace =
|
||||
Trace { mgr, s, tracer: &*tracer, target: &target, thread_id, progress, id: None, last: Counts::default() };
|
||||
match trace.drive(plan, cancel).await {
|
||||
Ok(run) => run,
|
||||
Err(run) => {
|
||||
// A stop from now on is the user's to see.
|
||||
set_running(s, false);
|
||||
trace.release().await;
|
||||
run
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `None` when no trace runs or it is still arming. The trace itself goes on to report how the
|
||||
/// abort ended it.
|
||||
pub(crate) async fn abort(s: &Session) -> IdeResult<Option<AbortState>> {
|
||||
let (tracer, target, id) = {
|
||||
let mut slot = s.stream_trace.lock();
|
||||
let Some(active) = slot.as_mut() else { return Ok(None) };
|
||||
let Some(id) = active.id else { return Ok(None) };
|
||||
active.aborting = true;
|
||||
(active.tracer.clone(), active.target.clone(), id)
|
||||
};
|
||||
let result = tokio::select! {
|
||||
biased;
|
||||
() = s.ended.cancelled() => return Ok(None),
|
||||
result = tracer.abort(&target, id) => result,
|
||||
};
|
||||
match result {
|
||||
Ok(state) => Ok(Some(state)),
|
||||
Err(InspectError::NoTrace) => Ok(None),
|
||||
Err(e) => Err(IdeError::internal(format!("cannot abort the stream trace: {e}"))),
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct Counts {
|
||||
records: u64,
|
||||
dropped: u64,
|
||||
elapsed_ms: u64,
|
||||
}
|
||||
|
||||
struct Trace<'a, P> {
|
||||
mgr: &'a DebugManager,
|
||||
s: &'a Session,
|
||||
tracer: &'a dyn StreamTracer,
|
||||
/// The stop the trace was armed in.
|
||||
target: &'a VmTarget,
|
||||
thread_id: i64,
|
||||
progress: &'a P,
|
||||
/// Set once `arm` answers.
|
||||
id: Option<TraceId>,
|
||||
last: Counts,
|
||||
}
|
||||
|
||||
impl<P: Fn(TraceProgress) + Send + Sync> Trace<'_, P> {
|
||||
/// `Err` ends the trace early.
|
||||
async fn drive(&mut self, plan: &Value, cancel: &CancellationToken) -> Result<TraceRun, TraceRun> {
|
||||
let (s, tracer, target) = (self.s, self.tracer, self.target);
|
||||
self.report(TracePhase::Arming);
|
||||
let id = self
|
||||
.until_ended(tracer.arm(target, self.thread_id, plan, BUDGET))
|
||||
.await?
|
||||
.map_err(|e| if s.ended.is_cancelled() { ended() } else { refused(e) })?;
|
||||
self.id = Some(id);
|
||||
if let Some(active) = s.stream_trace.lock().as_mut() {
|
||||
active.id = Some(id);
|
||||
}
|
||||
// Before the request: the thread can stop again before its reply arrives.
|
||||
set_running(s, true);
|
||||
self.dap(self.mgr.resume(s.id, self.thread_id)).await?;
|
||||
let mut stopped = false;
|
||||
loop {
|
||||
if cancel.is_cancelled() && !stopped {
|
||||
stopped = true;
|
||||
// Refused when the trace parked or failed just before: `wait` reports that.
|
||||
match self.until_ended(tracer.stop(target, id)).await? {
|
||||
Ok(records) => {
|
||||
self.last.records = records;
|
||||
self.report(TracePhase::RecordingStopped);
|
||||
}
|
||||
Err(e) => tracing::debug!(session = s.id.0, trace = id, "stream trace stop: {e}"),
|
||||
}
|
||||
}
|
||||
match self.inspect(tracer.wait(target, id, WAIT_MS)).await? {
|
||||
TraceState::Running { records, dropped, elapsed_ms } => {
|
||||
self.last = Counts { records, dropped, elapsed_ms };
|
||||
let aborting = s.stream_trace.lock().as_ref().is_some_and(|a| a.aborting);
|
||||
self.report(if aborting {
|
||||
TracePhase::Aborting
|
||||
} else if stopped {
|
||||
TracePhase::RecordingStopped
|
||||
} else {
|
||||
TracePhase::Running
|
||||
});
|
||||
}
|
||||
TraceState::Parked { records, dropped } => {
|
||||
set_running(s, false);
|
||||
self.last.records = records;
|
||||
self.last.dropped = dropped;
|
||||
break;
|
||||
}
|
||||
TraceState::Failed { detail } => return Err(TraceRun::Failed { detail }),
|
||||
TraceState::Cancelled { detail } => return Err(TraceRun::Cancelled { detail }),
|
||||
}
|
||||
}
|
||||
self.report(TracePhase::Collecting);
|
||||
let before = s.suspended.ticket();
|
||||
self.dap(self.mgr.step(s.id, self.thread_id, StepKind::Out)).await?;
|
||||
// Another thread's stop meanwhile is not this one: the traced thread would still be
|
||||
// inside the terminal operation.
|
||||
let stop = async {
|
||||
loop {
|
||||
if let Some(ticket) = s.suspended.stopped_since(self.thread_id, before) {
|
||||
return ticket;
|
||||
}
|
||||
tokio::time::sleep(STOP_POLL).await;
|
||||
}
|
||||
};
|
||||
let Ok(generation) = self.until_ended(tokio::time::timeout(STOP_WAIT, stop)).await? else {
|
||||
// Collecting in the old stop would only be refused as stale.
|
||||
return Err(TraceRun::Failed { detail: step_out_timeout() });
|
||||
};
|
||||
let stopped_in = VmTarget { generation, ..vm_target(s) };
|
||||
let collected = self.inspect(tracer.collect(&stopped_in, id, self.last.records)).await?;
|
||||
let resumed_stops = s.stream_trace.lock().as_ref().map_or(0, |a| a.resumed_stops);
|
||||
Ok(TraceRun::Done { collected, generation, resumed_stops })
|
||||
}
|
||||
|
||||
/// After a trace that ended early. Left to the bundle, an armed trace would keep every
|
||||
/// breakpoint off and a parked one its thread suspended behind java-debug's back; the bundle
|
||||
/// undoes either, or does so once a terminal still running returns. Not after a finished
|
||||
/// trace: the records it unpins are the values the result shows.
|
||||
async fn release(&self) {
|
||||
let Some(id) = self.id else { return };
|
||||
if self.s.ended.is_cancelled() {
|
||||
return;
|
||||
}
|
||||
if let Ok(Err(e)) = self.until_ended(self.tracer.release(self.target, id)).await {
|
||||
tracing::debug!(session = self.s.id.0, trace = id, "stream trace release: {e}");
|
||||
}
|
||||
}
|
||||
|
||||
fn report(&self, phase: TracePhase) {
|
||||
let Counts { records, dropped, elapsed_ms } = self.last;
|
||||
(self.progress)(TraceProgress { phase, records, dropped, elapsed_ms });
|
||||
}
|
||||
|
||||
/// A reply may never come once the session ends.
|
||||
async fn until_ended<T>(&self, work: impl Future<Output = T>) -> Result<T, TraceRun> {
|
||||
tokio::select! {
|
||||
biased;
|
||||
() = self.s.ended.cancelled() => Err(ended()),
|
||||
value = work => Ok(value),
|
||||
}
|
||||
}
|
||||
|
||||
async fn inspect<T>(&self, work: InspectFuture<'_, T>) -> Result<T, TraceRun> {
|
||||
self.until_ended(work).await?.map_err(|e| self.failed(e.to_string()))
|
||||
}
|
||||
|
||||
async fn dap(&self, work: impl Future<Output = IdeResult<()>>) -> Result<(), TraceRun> {
|
||||
self.until_ended(work).await?.map_err(|e| self.failed(e.message))
|
||||
}
|
||||
|
||||
/// A request that failed because the session was ending says so.
|
||||
fn failed(&self, detail: String) -> TraceRun {
|
||||
if self.s.ended.is_cancelled() { ended() } else { TraceRun::Failed { detail } }
|
||||
}
|
||||
}
|
||||
|
||||
fn step_out_timeout() -> String {
|
||||
format!(
|
||||
"java-debug reported no stop within {} s of stepping out of the stream's terminal operation",
|
||||
STOP_WAIT.as_secs()
|
||||
)
|
||||
}
|
||||
|
||||
fn ended() -> TraceRun {
|
||||
TraceRun::Failed { detail: "the debug session ended".into() }
|
||||
}
|
||||
|
||||
fn refused(e: InspectError) -> TraceRun {
|
||||
use TraceUnavailable as U;
|
||||
let reason = match e {
|
||||
InspectError::NotSuspended => U::NotSuspended,
|
||||
InspectError::Busy => U::Busy,
|
||||
InspectError::NoSession => U::NoSession,
|
||||
InspectError::Unsupported(detail) => U::Unsupported { detail },
|
||||
InspectError::NotAtChainStart(detail) => U::NotAtChainStart { detail },
|
||||
other => return TraceRun::Failed { detail: other.to_string() },
|
||||
};
|
||||
TraceRun::Unavailable { reason }
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
//! Protocol flow against an in-memory fake adapter.
|
||||
|
||||
mod jvm_inspect;
|
||||
mod stream_trace;
|
||||
|
||||
use super::*;
|
||||
use crate::adapter::{AdapterIo, LaunchFuture};
|
||||
@@ -132,6 +133,16 @@ struct Script {
|
||||
continue_reply: Option<Value>,
|
||||
/// Answer `continue` and stop at a breakpoint again, instead of letting the program exit.
|
||||
stop_after_continue: bool,
|
||||
/// Answer `stepOut` and stop these threads one after the other, 100 ms apart (java-debug
|
||||
/// stops the stepping thread right after the call returns).
|
||||
step_out_stops: &'static [i64],
|
||||
/// Refuse `stepOut`.
|
||||
refuse_step_out: bool,
|
||||
/// Refuse `continue`.
|
||||
refuse_continue: bool,
|
||||
/// Stop thread 1 alone at a breakpoint right after each of the first this many `continue`s
|
||||
/// that `continue_reply` answers.
|
||||
breakpoints_after_continue: usize,
|
||||
/// The `reason` of the stop a `next` ends with (`step` when unset; kotlin-lsp says `breakpoint`).
|
||||
step_reason: Option<&'static str>,
|
||||
/// Refuse `next`, then stop at a breakpoint (one the program hit meanwhile).
|
||||
@@ -185,6 +196,10 @@ impl Default for Script {
|
||||
hang_up_after_stop: false,
|
||||
continue_reply: None,
|
||||
stop_after_continue: false,
|
||||
step_out_stops: &[],
|
||||
refuse_step_out: false,
|
||||
refuse_continue: false,
|
||||
breakpoints_after_continue: 0,
|
||||
step_reason: None,
|
||||
refuse_next: false,
|
||||
invalidated_after_stop: false,
|
||||
@@ -248,6 +263,7 @@ async fn fake_adapter<S: AsyncRead + AsyncWrite + Unpin + Send + 'static>(stream
|
||||
let mut running = false;
|
||||
let mut thread_requests = 0;
|
||||
let mut unity = false;
|
||||
let mut breakpoints_left = script.breakpoints_after_continue;
|
||||
macro_rules! send {
|
||||
($v:expr) => {{
|
||||
let mut v: Value = $v;
|
||||
@@ -494,7 +510,21 @@ async fn fake_adapter<S: AsyncRead + AsyncWrite + Unpin + Send + 'static>(stream
|
||||
{"label": ""},
|
||||
]})
|
||||
),
|
||||
"continue" if script.continue_reply.is_some() => ok!(msg, script.continue_reply.clone().unwrap()),
|
||||
"continue" if script.refuse_continue => send!(
|
||||
json!({"type": "response", "request_seq": msg["seq"], "command": "continue", "success": false, "message": "Thread is not suspended"})
|
||||
),
|
||||
"continue" if script.continue_reply.is_some() => {
|
||||
ok!(msg, script.continue_reply.clone().unwrap());
|
||||
if breakpoints_left > 0 {
|
||||
breakpoints_left -= 1;
|
||||
send!(
|
||||
json!({"type": "event", "event": "stopped", "body": {"reason": "breakpoint", "threadId": 1}})
|
||||
);
|
||||
}
|
||||
}
|
||||
"stepOut" if script.refuse_step_out => send!(
|
||||
json!({"type": "response", "request_seq": msg["seq"], "command": "stepOut", "success": false, "message": "Thread is not suspended"})
|
||||
),
|
||||
"continue" if script.stop_after_continue => {
|
||||
ok!(msg, json!({"allThreadsContinued": true}));
|
||||
send!(
|
||||
@@ -507,6 +537,16 @@ async fn fake_adapter<S: AsyncRead + AsyncWrite + Unpin + Send + 'static>(stream
|
||||
send!(json!({"type": "event", "event": "terminated"}));
|
||||
}
|
||||
"pause" if script.hang_up_on_pause => break,
|
||||
"stepOut" if !script.step_out_stops.is_empty() => {
|
||||
ok!(msg, Value::Null);
|
||||
for (i, thread) in script.step_out_stops.iter().enumerate() {
|
||||
if i > 0 {
|
||||
tokio::time::sleep(Duration::from_millis(100)).await;
|
||||
}
|
||||
let reason = if i + 1 == script.step_out_stops.len() { "step" } else { "breakpoint" };
|
||||
send!(json!({"type": "event", "event": "stopped", "body": {"reason": reason, "threadId": thread}}));
|
||||
}
|
||||
}
|
||||
"stepIn" | "stepOut" | "pause" => ok!(msg, Value::Null),
|
||||
"redefineClasses" => {
|
||||
send!(
|
||||
@@ -1871,6 +1911,7 @@ fn godot_registry(port: u16, command: &str, args: &[&str]) -> Arc<LanguageRegist
|
||||
framework_files: Vec::new(),
|
||||
formatter: None,
|
||||
scratch_template: None,
|
||||
rainbow_brackets: Default::default(),
|
||||
tree_sitter: None,
|
||||
language_servers: vec![],
|
||||
debugger: Some(ide_language::DebuggerConfig {
|
||||
|
||||
@@ -0,0 +1,522 @@
|
||||
//! A stream chain traced while the program runs it, through a session's stream tracer.
|
||||
|
||||
use super::*;
|
||||
use ide_core::CancellationToken;
|
||||
use ide_jvm_inspect::{
|
||||
AbortState, CollectedTerminal, InspectError, InspectFuture, JvmValue, StreamTracer, TraceCollected, TraceId,
|
||||
TraceState, VmTarget,
|
||||
};
|
||||
use std::collections::VecDeque;
|
||||
use tokio::sync::Notify;
|
||||
|
||||
const TRACE: TraceId = 7;
|
||||
|
||||
#[derive(Default)]
|
||||
struct FakeTracer {
|
||||
/// Answers to `wait`, in order. Once they run out, `wait` signals `waiting` and answers only
|
||||
/// after more are pushed and `more` is notified.
|
||||
waits: Mutex<VecDeque<Result<TraceState, InspectError>>>,
|
||||
arm_error: Mutex<Option<InspectError>>,
|
||||
stop_error: Mutex<Option<InspectError>>,
|
||||
collect_error: Mutex<Option<InspectError>>,
|
||||
/// The record count each `collect` was given.
|
||||
collect_records: Mutex<Vec<u64>>,
|
||||
calls: Mutex<Vec<(&'static str, VmTarget)>>,
|
||||
waiting: Notify,
|
||||
more: Notify,
|
||||
}
|
||||
|
||||
impl FakeTracer {
|
||||
fn scripted(waits: impl IntoIterator<Item = TraceState>) -> Arc<Self> {
|
||||
Self::answering(waits.into_iter().map(Ok))
|
||||
}
|
||||
|
||||
fn answering(waits: impl IntoIterator<Item = Result<TraceState, InspectError>>) -> Arc<Self> {
|
||||
Arc::new(Self { waits: Mutex::new(waits.into_iter().collect()), ..Self::default() })
|
||||
}
|
||||
|
||||
fn record(&self, name: &'static str, target: &VmTarget) {
|
||||
self.calls.lock().push((name, target.clone()));
|
||||
}
|
||||
|
||||
fn names(&self) -> Vec<&'static str> {
|
||||
self.calls.lock().iter().map(|(name, _)| *name).collect()
|
||||
}
|
||||
|
||||
fn target_of(&self, name: &str) -> VmTarget {
|
||||
self.calls.lock().iter().find(|(n, _)| *n == name).map(|(_, t)| t.clone()).unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
impl StreamTracer for FakeTracer {
|
||||
fn arm<'a>(
|
||||
&'a self,
|
||||
target: &'a VmTarget,
|
||||
_thread_id: i64,
|
||||
_plan: &'a Value,
|
||||
_budget: u32,
|
||||
) -> InspectFuture<'a, TraceId> {
|
||||
self.record("arm", target);
|
||||
let error = self.arm_error.lock().clone();
|
||||
Box::pin(async move { error.map_or(Ok(TRACE), Err) })
|
||||
}
|
||||
|
||||
fn wait<'a>(&'a self, target: &'a VmTarget, _trace: TraceId, _ms: u32) -> InspectFuture<'a, TraceState> {
|
||||
self.record("wait", target);
|
||||
Box::pin(async move {
|
||||
loop {
|
||||
if let Some(state) = self.waits.lock().pop_front() {
|
||||
return state;
|
||||
}
|
||||
self.waiting.notify_one();
|
||||
self.more.notified().await;
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn stop<'a>(&'a self, target: &'a VmTarget, _trace: TraceId) -> InspectFuture<'a, u64> {
|
||||
self.record("stop", target);
|
||||
let error = self.stop_error.lock().clone();
|
||||
Box::pin(async move { error.map_or(Ok(3), Err) })
|
||||
}
|
||||
|
||||
fn abort<'a>(&'a self, target: &'a VmTarget, _trace: TraceId) -> InspectFuture<'a, AbortState> {
|
||||
self.record("abort", target);
|
||||
Box::pin(async { Ok(AbortState::Interrupted) })
|
||||
}
|
||||
|
||||
fn collect<'a>(&'a self, target: &'a VmTarget, _trace: TraceId, records: u64) -> InspectFuture<'a, TraceCollected> {
|
||||
self.record("collect", target);
|
||||
self.collect_records.lock().push(records);
|
||||
let error = self.collect_error.lock().clone();
|
||||
Box::pin(async move { error.map_or_else(|| Ok(collected()), Err) })
|
||||
}
|
||||
|
||||
fn release<'a>(&'a self, target: &'a VmTarget, _trace: TraceId) -> InspectFuture<'a, ()> {
|
||||
self.record("release", target);
|
||||
Box::pin(async { Ok(()) })
|
||||
}
|
||||
}
|
||||
|
||||
fn collected() -> TraceCollected {
|
||||
TraceCollected {
|
||||
records: vec![(0, JvmValue::Primitive { type_name: "int".into(), text: "1".into() })],
|
||||
dropped: 0,
|
||||
terminal: CollectedTerminal::Void,
|
||||
skipped_breakpoints: 0,
|
||||
sequentialized: false,
|
||||
}
|
||||
}
|
||||
|
||||
fn running(records: u64) -> TraceState {
|
||||
TraceState::Running { records, dropped: 0, elapsed_ms: 5 }
|
||||
}
|
||||
|
||||
fn parked() -> TraceState {
|
||||
TraceState::Parked { records: 10, dropped: 0 }
|
||||
}
|
||||
|
||||
/// java-debug keeps the program running after `continue` and stops right after a `stepOut`.
|
||||
fn java_debug() -> Script {
|
||||
Script { continue_reply: Some(json!({"allThreadsContinued": true})), step_out_stops: &[1], ..Script::default() }
|
||||
}
|
||||
|
||||
async fn stopped_java(h: &Harness, tracer: &Arc<FakeTracer>) -> DebugSessionId {
|
||||
let id = h.start(java_config("launch")).await.unwrap();
|
||||
h.wait_event(|e| matches!(e, DebugEvent::Stopped { .. })).await;
|
||||
h.manager.set_stream_tracer(id, tracer.clone()).unwrap();
|
||||
id
|
||||
}
|
||||
|
||||
async fn trace(h: &Harness, id: DebugSessionId) -> IdeResult<TraceRun> {
|
||||
let run = h.manager.stream_trace(id, 1, json!({"steps": []}), CancellationToken::new(), |_| {});
|
||||
tokio::time::timeout(Duration::from_secs(10), run).await.expect("the trace did not end")
|
||||
}
|
||||
|
||||
/// A trace in its own task, returned once it waits for the answers its tracer has not got.
|
||||
async fn hanging_trace(
|
||||
h: &Harness,
|
||||
id: DebugSessionId,
|
||||
tracer: &FakeTracer,
|
||||
) -> tokio::task::JoinHandle<IdeResult<TraceRun>> {
|
||||
hanging_trace_with(h, id, tracer, |_| {}).await
|
||||
}
|
||||
|
||||
async fn hanging_trace_with(
|
||||
h: &Harness,
|
||||
id: DebugSessionId,
|
||||
tracer: &FakeTracer,
|
||||
progress: impl Fn(TraceProgress) + Send + Sync + 'static,
|
||||
) -> tokio::task::JoinHandle<IdeResult<TraceRun>> {
|
||||
let manager = h.manager.clone();
|
||||
let task = tokio::spawn(async move {
|
||||
manager.stream_trace(id, 1, json!({"steps": []}), CancellationToken::new(), progress).await
|
||||
});
|
||||
tokio::time::timeout(Duration::from_secs(5), tracer.waiting.notified()).await.expect("the trace did not wait");
|
||||
task
|
||||
}
|
||||
|
||||
fn phases(seen: &Mutex<Vec<TraceProgress>>) -> Vec<TracePhase> {
|
||||
seen.lock().iter().map(|p| p.phase).collect()
|
||||
}
|
||||
|
||||
fn progress(phase: TracePhase, records: u64, elapsed_ms: u64) -> TraceProgress {
|
||||
TraceProgress { phase, records, dropped: 0, elapsed_ms }
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn trace_runs_continue_then_step_out() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([running(10), parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let start = h.manager.session(id).unwrap().suspended.ticket();
|
||||
|
||||
let run = trace(&h, id).await.unwrap();
|
||||
|
||||
let TraceRun::Done { collected: got, generation, resumed_stops } = run else { panic!("not done: {run:?}") };
|
||||
assert_eq!(got, collected());
|
||||
assert_eq!(resumed_stops, 0);
|
||||
assert!(generation > start, "collected in the stop of the trace ({start}), not after it ({generation})");
|
||||
let commands = h.commands();
|
||||
let resumed = commands.iter().position(|c| c == "continue").expect("no continue");
|
||||
let stepped = commands.iter().position(|c| c == "stepOut").expect("no stepOut");
|
||||
assert!(resumed < stepped, "{commands:?}");
|
||||
assert_eq!(h.request("continue")["arguments"]["threadId"], 1);
|
||||
assert_eq!(h.request("stepOut")["arguments"]["threadId"], 1);
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "wait", "collect"]);
|
||||
assert_eq!(*tracer.collect_records.lock(), [10], "collect is told how many records the trace parked with");
|
||||
assert_eq!(tracer.target_of("arm").generation, start);
|
||||
assert_eq!(tracer.target_of("collect").generation, generation);
|
||||
assert!(h.manager.session(id).unwrap().suspended.get());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn trace_reports_progress() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([running(10), parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let seen: Arc<Mutex<Vec<TraceProgress>>> = Arc::default();
|
||||
let sink = seen.clone();
|
||||
|
||||
let run = h.manager.stream_trace(id, 1, json!({}), CancellationToken::new(), move |p| sink.lock().push(p)).await;
|
||||
|
||||
assert!(matches!(run, Ok(TraceRun::Done { .. })), "{run:?}");
|
||||
assert_eq!(
|
||||
*seen.lock(),
|
||||
[
|
||||
progress(TracePhase::Arming, 0, 0),
|
||||
progress(TracePhase::Running, 10, 5),
|
||||
progress(TracePhase::Collecting, 10, 5),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn cancel_stops_recording_once() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([running(10), running(12), parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let cancel = CancellationToken::new();
|
||||
let on_running = cancel.clone();
|
||||
let seen: Arc<Mutex<Vec<TracePhase>>> = Arc::default();
|
||||
let sink = seen.clone();
|
||||
|
||||
let run = h
|
||||
.manager
|
||||
.stream_trace(id, 1, json!({}), cancel, move |p| {
|
||||
if p.phase == TracePhase::Running {
|
||||
on_running.cancel();
|
||||
}
|
||||
sink.lock().push(p.phase);
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(matches!(run, Ok(TraceRun::Done { .. })), "{run:?}");
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "stop", "wait", "wait", "collect"]);
|
||||
assert_eq!(
|
||||
*seen.lock(),
|
||||
[
|
||||
TracePhase::Arming,
|
||||
TracePhase::Running,
|
||||
TracePhase::RecordingStopped,
|
||||
TracePhase::RecordingStopped,
|
||||
TracePhase::Collecting
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn second_trace_is_busy() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let first = hanging_trace(&h, id, &tracer).await;
|
||||
|
||||
let second = trace(&h, id).await.unwrap();
|
||||
|
||||
assert_eq!(second, TraceRun::Unavailable { reason: TraceUnavailable::Busy });
|
||||
assert_eq!(tracer.names().iter().filter(|n| **n == "arm").count(), 1);
|
||||
first.abort();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn trace_ends_when_session_ends() {
|
||||
// The fake adapter lets the program exit on `continue`.
|
||||
let h = harness(Script::default());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let session = h.manager.session(id).unwrap();
|
||||
|
||||
let run = trace(&h, id).await.unwrap();
|
||||
|
||||
assert_eq!(run, TraceRun::Failed { detail: "the debug session ended".into() });
|
||||
assert!(session.stream_trace.lock().is_none());
|
||||
let next = trace(&h, id).await;
|
||||
assert!(!matches!(next, Ok(TraceRun::Unavailable { reason: TraceUnavailable::Busy })), "{next:?}");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn dropping_the_trace_frees_the_session() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let first = hanging_trace(&h, id, &tracer).await;
|
||||
|
||||
first.abort();
|
||||
assert!(first.await.unwrap_err().is_cancelled());
|
||||
|
||||
let session = h.manager.session(id).unwrap();
|
||||
assert!(session.stream_trace.lock().is_none());
|
||||
// The first trace resumed the thread.
|
||||
session.suspended.stopped(Some(1), false);
|
||||
let again = hanging_trace(&h, id, &tracer).await;
|
||||
assert_eq!(tracer.names().iter().filter(|n| **n == "arm").count(), 2);
|
||||
again.abort();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn arm_errors_map_to_unavailable_or_failed() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
*tracer.arm_error.lock() = Some(InspectError::NotAtChainStart("the stop is on line 4".into()));
|
||||
assert_eq!(
|
||||
trace(&h, id).await.unwrap(),
|
||||
TraceRun::Unavailable { reason: TraceUnavailable::NotAtChainStart { detail: "the stop is on line 4".into() } }
|
||||
);
|
||||
*tracer.arm_error.lock() = Some(InspectError::TimedOut);
|
||||
assert_eq!(trace(&h, id).await.unwrap(), TraceRun::Failed { detail: InspectError::TimedOut.to_string() });
|
||||
assert!(!h.commands().iter().any(|c| c == "continue"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn abort_reaches_the_running_trace() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
assert_eq!(h.manager.stream_trace_abort(id).await.unwrap(), None);
|
||||
let seen: Arc<Mutex<Vec<TraceProgress>>> = Arc::default();
|
||||
let sink = seen.clone();
|
||||
let task = hanging_trace_with(&h, id, &tracer, move |p| sink.lock().push(p)).await;
|
||||
|
||||
assert_eq!(h.manager.stream_trace_abort(id).await.unwrap(), Some(AbortState::Interrupted));
|
||||
assert_eq!(tracer.target_of("abort"), tracer.target_of("arm"));
|
||||
|
||||
let thrown = "java.lang.RuntimeException: oi-cancel:1";
|
||||
tracer.waits.lock().extend([Ok(running(4)), Ok(TraceState::Failed { detail: thrown.into() })]);
|
||||
tracer.more.notify_one();
|
||||
let run = tokio::time::timeout(Duration::from_secs(5), task).await.unwrap().unwrap().unwrap();
|
||||
assert_eq!(run, TraceRun::Failed { detail: thrown.into() });
|
||||
assert_eq!(phases(&seen), [TracePhase::Arming, TracePhase::Aborting]);
|
||||
assert_eq!(tracer.names().last(), Some(&"release"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn failed_wait_passes_its_detail_through() {
|
||||
let h = harness(java_debug());
|
||||
let detail = "the program began to exit while the stream ran: stop the debug session";
|
||||
let tracer = FakeTracer::scripted([running(1), TraceState::Failed { detail: detail.into() }]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
assert_eq!(trace(&h, id).await.unwrap(), TraceRun::Failed { detail: detail.into() });
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "wait", "release"]);
|
||||
assert!(!h.commands().iter().any(|c| c == "stepOut"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_trace_cancelled_before_its_terminal_says_so() {
|
||||
let detail = "cancelled before the terminal ran";
|
||||
let tracer = FakeTracer::scripted([TraceState::Cancelled { detail: detail.into() }]);
|
||||
let h = harness(java_debug());
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
assert_eq!(trace(&h, id).await.unwrap(), TraceRun::Cancelled { detail: detail.into() });
|
||||
assert!(!h.commands().iter().any(|c| c == "stepOut"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_wait_that_errs_releases_the_trace() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::answering([Ok(running(1)), Err(InspectError::TimedOut)]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
assert_eq!(trace(&h, id).await.unwrap(), TraceRun::Failed { detail: InspectError::TimedOut.to_string() });
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "wait", "release"]);
|
||||
assert_eq!(tracer.target_of("release"), tracer.target_of("arm"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_refused_step_out_releases_the_trace() {
|
||||
let h = harness(Script { refuse_step_out: true, ..java_debug() });
|
||||
let tracer = FakeTracer::scripted([parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
let run = trace(&h, id).await.unwrap();
|
||||
|
||||
assert!(matches!(&run, TraceRun::Failed { detail } if detail.contains("not suspended")), "{run:?}");
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "release"]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_refused_continue_releases_the_trace() {
|
||||
let h = harness(Script { refuse_continue: true, ..java_debug() });
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
let run = trace(&h, id).await.unwrap();
|
||||
|
||||
assert!(matches!(&run, TraceRun::Failed { .. }), "{run:?}");
|
||||
assert_eq!(tracer.names(), ["arm", "release"]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_failed_collect_releases_the_trace() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([parked()]);
|
||||
*tracer.collect_error.lock() = Some(InspectError::Stale);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
assert!(matches!(trace(&h, id).await.unwrap(), TraceRun::Failed { .. }));
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "collect", "release"]);
|
||||
}
|
||||
|
||||
fn stops(h: &Harness) -> usize {
|
||||
h.events.lock().iter().filter(|e| matches!(e, IdeEvent::Debug { event: DebugEvent::Stopped { .. }, .. })).count()
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_stop_of_the_traced_thread_while_the_chain_runs_is_resumed_unseen() {
|
||||
// A breakpoint java-debug set meanwhile, hit inside the terminal's invoke before the bundle
|
||||
// switched it off: held there, the invoke would never return.
|
||||
let h = harness(Script { breakpoints_after_continue: 1, ..java_debug() });
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let shown = stops(&h);
|
||||
let task = hanging_trace(&h, id, &tracer).await;
|
||||
|
||||
for _ in 0..200 {
|
||||
if h.commands().iter().filter(|c| *c == "continue").count() == 2 {
|
||||
break;
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(10)).await;
|
||||
}
|
||||
assert_eq!(h.commands().iter().filter(|c| *c == "continue").count(), 2, "{:?}", h.commands());
|
||||
assert_eq!(h.log.lock().iter().rfind(|m| m["command"] == "continue").unwrap()["arguments"]["threadId"], 1);
|
||||
tracer.waits.lock().push_back(Ok(parked()));
|
||||
tracer.more.notify_one();
|
||||
let run = tokio::time::timeout(Duration::from_secs(5), task).await.unwrap().unwrap().unwrap();
|
||||
|
||||
let TraceRun::Done { resumed_stops, .. } = run else { panic!("not done: {run:?}") };
|
||||
assert_eq!(resumed_stops, 1);
|
||||
assert_eq!(stops(&h), shown + 1, "only the step-out stop is shown, after the trace parked");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_finished_trace_is_not_released() {
|
||||
// Releasing unpins the records, which the result's values still show until the program runs on.
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
|
||||
assert!(matches!(trace(&h, id).await.unwrap(), TraceRun::Done { .. }));
|
||||
assert!(!tracer.names().contains(&"release"), "{:?}", tracer.names());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn refused_stop_leaves_the_outcome_to_wait() {
|
||||
let h = harness(java_debug());
|
||||
let tracer = FakeTracer::scripted([running(10), parked()]);
|
||||
*tracer.stop_error.lock() = Some(InspectError::NoTrace);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let cancel = CancellationToken::new();
|
||||
let on_running = cancel.clone();
|
||||
let seen: Arc<Mutex<Vec<TraceProgress>>> = Arc::default();
|
||||
let sink = seen.clone();
|
||||
|
||||
let run = h
|
||||
.manager
|
||||
.stream_trace(id, 1, json!({}), cancel, move |p| {
|
||||
if p.phase == TracePhase::Running {
|
||||
on_running.cancel();
|
||||
}
|
||||
sink.lock().push(p);
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(matches!(run, Ok(TraceRun::Done { .. })), "{run:?}");
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "stop", "wait", "collect"]);
|
||||
assert_eq!(phases(&seen), [TracePhase::Arming, TracePhase::Running, TracePhase::Collecting]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn another_threads_stop_is_not_the_step_out() {
|
||||
// Thread 2 stops at a breakpoint 100 ms before the traced thread's step out ends.
|
||||
let h = harness(Script { step_out_stops: &[2, 1], ..java_debug() });
|
||||
let tracer = FakeTracer::scripted([parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
let start = h.manager.session(id).unwrap().suspended.ticket();
|
||||
|
||||
let run = trace(&h, id).await.unwrap();
|
||||
|
||||
let TraceRun::Done { generation, .. } = run else { panic!("not done: {run:?}") };
|
||||
assert_eq!(
|
||||
generation,
|
||||
start + 2,
|
||||
"collected in thread 2's stop, not in the traced thread's step-out stop after it"
|
||||
);
|
||||
assert_eq!(tracer.target_of("collect").generation, generation);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn step_out_without_a_stop_times_out() {
|
||||
let h = harness(Script { step_out_stops: &[], ..java_debug() });
|
||||
let tracer = FakeTracer::scripted([parked()]);
|
||||
let id = stopped_java(&h, &tracer).await;
|
||||
tokio::time::pause();
|
||||
|
||||
let run = h.manager.stream_trace(id, 1, json!({}), CancellationToken::new(), |_| {}).await.unwrap();
|
||||
|
||||
assert_eq!(
|
||||
run,
|
||||
TraceRun::Failed {
|
||||
detail: "java-debug reported no stop within 30 s of stepping out of the stream's terminal operation".into()
|
||||
}
|
||||
);
|
||||
assert!(h.commands().iter().any(|c| c == "stepOut"));
|
||||
assert_eq!(tracer.names(), ["arm", "wait", "release"]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn capability_only_for_java_debug() {
|
||||
let h = harness(Script::default());
|
||||
let tracer = FakeTracer::scripted([]);
|
||||
let java = h.start(java_config("launch")).await.unwrap();
|
||||
assert!(!h.manager.capabilities(java).unwrap().stream_trace);
|
||||
h.manager.set_stream_tracer(java, tracer.clone()).unwrap();
|
||||
assert!(h.manager.capabilities(java).unwrap().stream_trace);
|
||||
|
||||
let other = h.start(config()).await.unwrap();
|
||||
h.manager.set_stream_tracer(other, tracer.clone()).unwrap();
|
||||
assert!(!h.manager.capabilities(other).unwrap().stream_trace);
|
||||
}
|
||||
@@ -14,6 +14,7 @@ mod snowflake;
|
||||
pub mod source;
|
||||
pub mod split;
|
||||
pub mod sql;
|
||||
pub mod tools;
|
||||
mod watch;
|
||||
pub use watch::SourcesWatch;
|
||||
|
||||
@@ -787,6 +788,56 @@ impl DbManager {
|
||||
Ok(v.unwrap_or_else(|| "Connected".into()))
|
||||
}
|
||||
|
||||
/// Runs `job` with the client tool at `executable` against target `id`, connected like the
|
||||
/// data source (through its SSH tunnel, with its SSL settings and password), until it exits
|
||||
/// or `cancel` fires. Connects first, so a missing password fails the way it does for a
|
||||
/// console. Returns the exit code.
|
||||
pub async fn run_tool(
|
||||
&self,
|
||||
id: &str,
|
||||
executable: &std::path::Path,
|
||||
job: &tools::DbToolJob,
|
||||
cancel: &CancellationToken,
|
||||
on_output: impl FnMut(Vec<tools::ToolLine>),
|
||||
) -> IdeResult<Option<i32>> {
|
||||
let tool = job.tool();
|
||||
if !tool.is_program(executable) {
|
||||
return Err(IdeError::invalid(format!("{} is not {}", executable.display(), tool.program())));
|
||||
}
|
||||
let source = self.source(id)?;
|
||||
if source.driver != tool.driver() {
|
||||
return Err(IdeError::invalid(format!("{} cannot connect to {}", tool.program(), source.name)));
|
||||
}
|
||||
self.pool(id).await?;
|
||||
let password = self.password(&source).await;
|
||||
// Holding the tunnel keeps it open while the tool runs, even if the tree disconnects.
|
||||
let (target, _tunnel) = self.endpoint(&source, None, true).await?;
|
||||
let prepared = tools::prepare(job, &target, password.as_deref());
|
||||
tools::run(executable, &prepared.args, &prepared.env, cancel, on_output).await
|
||||
}
|
||||
|
||||
/// The command [`DbManager::run_tool`] would run, for the dialogs' preview: the data source's
|
||||
/// own host and port (not a tunnel's local end), and no password.
|
||||
pub fn tool_preview(&self, id: &str, executable: &std::path::Path, job: &tools::DbToolJob) -> IdeResult<String> {
|
||||
let source = self.source(id)?;
|
||||
let prepared = tools::prepare(job, &source, None);
|
||||
Ok(tools::command_line(executable, &prepared.args))
|
||||
}
|
||||
|
||||
/// The PostgreSQL server's `server_version_num` (`150013` for 15.13).
|
||||
pub async fn server_version(&self, id: &str) -> IdeResult<u32> {
|
||||
let pool = self.pool(id).await?;
|
||||
if pool.driver() != DbDriver::Postgres {
|
||||
return Err(IdeError::invalid("not a PostgreSQL data source"));
|
||||
}
|
||||
let rows = pool.rows("SHOW server_version_num", 1).await?;
|
||||
rows.into_iter()
|
||||
.next()
|
||||
.and_then(|r| r.into_iter().next().flatten())
|
||||
.and_then(|v| v.trim().parse().ok())
|
||||
.ok_or_else(|| IdeError::internal("no server version"))
|
||||
}
|
||||
|
||||
pub fn is_connected(&self, id: &str) -> bool {
|
||||
self.pools.lock().contains_key(id)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,339 @@
|
||||
//! What a dump or restore dialog asks for, as typed options, and the arguments that do it.
|
||||
//! The connection arguments come from [`super::connection`]; these are the rest.
|
||||
|
||||
use super::DbTool;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
use std::path::Path;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum DbDumpFormat {
|
||||
/// SQL text, restored with `psql`.
|
||||
Plain,
|
||||
Custom,
|
||||
/// A directory of files; the only format `pg_dump` writes in parallel.
|
||||
Directory,
|
||||
Tar,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum DbDumpStatements {
|
||||
Copy,
|
||||
Inserts,
|
||||
ColumnInserts,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum DbDumpContent {
|
||||
All,
|
||||
SchemaOnly,
|
||||
DataOnly,
|
||||
}
|
||||
|
||||
/// Name lists hold `pg_dump` patterns (`*`, `?`, quoted names).
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct DbPgDumpOptions {
|
||||
pub format: DbDumpFormat,
|
||||
pub statements: DbDumpStatements,
|
||||
pub content: DbDumpContent,
|
||||
pub schemas: Vec<String>,
|
||||
pub tables: Vec<String>,
|
||||
pub exclude_tables: Vec<String>,
|
||||
/// Plain format only: archives get DROP / CREATE at restore.
|
||||
pub clean: bool,
|
||||
pub if_exists: bool,
|
||||
pub create: bool,
|
||||
pub no_owner: bool,
|
||||
pub no_privileges: bool,
|
||||
/// Directory format only.
|
||||
pub jobs: u32,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct DbPgRestoreOptions {
|
||||
pub content: DbDumpContent,
|
||||
pub schemas: Vec<String>,
|
||||
pub clean: bool,
|
||||
pub if_exists: bool,
|
||||
pub no_owner: bool,
|
||||
pub no_privileges: bool,
|
||||
pub single_transaction: bool,
|
||||
pub exit_on_error: bool,
|
||||
/// Ignored with a single transaction, which `pg_restore` cannot split.
|
||||
pub jobs: u32,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct DbPsqlOptions {
|
||||
pub single_transaction: bool,
|
||||
pub stop_on_error: bool,
|
||||
}
|
||||
|
||||
/// A run of a client tool: which one, the file it writes or reads, and its options.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "tool", rename_all = "camelCase")]
|
||||
pub enum DbToolJob {
|
||||
PgDump {
|
||||
file: String,
|
||||
options: DbPgDumpOptions,
|
||||
},
|
||||
/// `file`: an archive, or a directory archive.
|
||||
PgRestore {
|
||||
file: String,
|
||||
options: DbPgRestoreOptions,
|
||||
},
|
||||
Psql {
|
||||
file: String,
|
||||
options: DbPsqlOptions,
|
||||
},
|
||||
}
|
||||
|
||||
impl DbToolJob {
|
||||
pub fn tool(&self) -> DbTool {
|
||||
match self {
|
||||
DbToolJob::PgDump { .. } => DbTool::PgDump,
|
||||
DbToolJob::PgRestore { .. } => DbTool::PgRestore,
|
||||
DbToolJob::Psql { .. } => DbTool::Psql,
|
||||
}
|
||||
}
|
||||
|
||||
/// The arguments after the connection ones.
|
||||
pub fn args(&self) -> Vec<String> {
|
||||
match self {
|
||||
DbToolJob::PgDump { file, options } => pg_dump(options, file),
|
||||
DbToolJob::PgRestore { file, options } => pg_restore(options, file),
|
||||
DbToolJob::Psql { file, options } => psql(options, file),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn flag(on: bool, flag: &str) -> Option<String> {
|
||||
on.then(|| flag.to_owned())
|
||||
}
|
||||
|
||||
fn content(c: DbDumpContent) -> Option<String> {
|
||||
match c {
|
||||
DbDumpContent::All => None,
|
||||
DbDumpContent::SchemaOnly => Some("--schema-only".into()),
|
||||
DbDumpContent::DataOnly => Some("--data-only".into()),
|
||||
}
|
||||
}
|
||||
|
||||
fn each(names: &[String], option: &str) -> impl Iterator<Item = String> {
|
||||
names.iter().map(|n| n.trim()).filter(|n| !n.is_empty()).map(move |n| format!("--{option}={n}"))
|
||||
}
|
||||
|
||||
fn pg_dump(o: &DbPgDumpOptions, file: &str) -> Vec<String> {
|
||||
let plain = o.format == DbDumpFormat::Plain;
|
||||
let format = match o.format {
|
||||
DbDumpFormat::Plain => "p",
|
||||
DbDumpFormat::Custom => "c",
|
||||
DbDumpFormat::Directory => "d",
|
||||
DbDumpFormat::Tar => "t",
|
||||
};
|
||||
let mut args = vec![format!("--format={format}"), format!("--file={file}")];
|
||||
args.extend(match o.statements {
|
||||
DbDumpStatements::Copy => None,
|
||||
DbDumpStatements::Inserts => Some("--inserts".to_owned()),
|
||||
DbDumpStatements::ColumnInserts => Some("--column-inserts".to_owned()),
|
||||
});
|
||||
args.extend(content(o.content));
|
||||
args.extend(each(&o.schemas, "schema"));
|
||||
args.extend(each(&o.tables, "table"));
|
||||
args.extend(each(&o.exclude_tables, "exclude-table"));
|
||||
args.extend(flag(plain && o.clean, "--clean"));
|
||||
args.extend(flag(plain && o.clean && o.if_exists, "--if-exists"));
|
||||
args.extend(flag(plain && o.create, "--create"));
|
||||
args.extend(flag(o.no_owner, "--no-owner"));
|
||||
args.extend(flag(o.no_privileges, "--no-privileges"));
|
||||
if o.format == DbDumpFormat::Directory && o.jobs > 1 {
|
||||
args.push(format!("--jobs={}", o.jobs));
|
||||
}
|
||||
args.push("--verbose".into());
|
||||
args
|
||||
}
|
||||
|
||||
fn pg_restore(o: &DbPgRestoreOptions, file: &str) -> Vec<String> {
|
||||
let mut args: Vec<String> = content(o.content).into_iter().collect();
|
||||
args.extend(each(&o.schemas, "schema"));
|
||||
args.extend(flag(o.clean, "--clean"));
|
||||
args.extend(flag(o.clean && o.if_exists, "--if-exists"));
|
||||
args.extend(flag(o.no_owner, "--no-owner"));
|
||||
args.extend(flag(o.no_privileges, "--no-privileges"));
|
||||
args.extend(flag(o.single_transaction, "--single-transaction"));
|
||||
args.extend(flag(o.exit_on_error, "--exit-on-error"));
|
||||
if o.jobs > 1 && !o.single_transaction {
|
||||
args.push(format!("--jobs={}", o.jobs));
|
||||
}
|
||||
args.push("--verbose".into());
|
||||
if !file.is_empty() {
|
||||
args.push(file.to_owned());
|
||||
}
|
||||
args
|
||||
}
|
||||
|
||||
fn psql(o: &DbPsqlOptions, file: &str) -> Vec<String> {
|
||||
let mut args: Vec<String> = (!file.is_empty()).then(|| format!("--file={file}")).into_iter().collect();
|
||||
args.extend(flag(o.single_transaction, "--single-transaction"));
|
||||
args.extend(flag(o.stop_on_error, "--set=ON_ERROR_STOP=1"));
|
||||
args
|
||||
}
|
||||
|
||||
/// The command as a shell would need it typed: the dialogs' preview.
|
||||
pub fn command_line(program: &Path, args: &[String]) -> String {
|
||||
let quote = |s: &str| {
|
||||
if !s.is_empty() && s.chars().all(|c| c.is_ascii_alphanumeric() || "@%+=:,./-_".contains(c)) {
|
||||
s.to_owned()
|
||||
} else {
|
||||
format!("'{}'", s.replace('\'', "'\\''"))
|
||||
}
|
||||
};
|
||||
std::iter::once(program.to_string_lossy().into_owned())
|
||||
.chain(args.iter().cloned())
|
||||
.map(|a| quote(&a))
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ")
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn dump() -> DbPgDumpOptions {
|
||||
DbPgDumpOptions {
|
||||
format: DbDumpFormat::Plain,
|
||||
statements: DbDumpStatements::Copy,
|
||||
content: DbDumpContent::All,
|
||||
schemas: vec![],
|
||||
tables: vec![],
|
||||
exclude_tables: vec![],
|
||||
clean: false,
|
||||
if_exists: false,
|
||||
create: false,
|
||||
no_owner: false,
|
||||
no_privileges: false,
|
||||
jobs: 1,
|
||||
}
|
||||
}
|
||||
|
||||
fn restore() -> DbPgRestoreOptions {
|
||||
DbPgRestoreOptions {
|
||||
content: DbDumpContent::All,
|
||||
schemas: vec![],
|
||||
clean: false,
|
||||
if_exists: false,
|
||||
no_owner: false,
|
||||
no_privileges: false,
|
||||
single_transaction: false,
|
||||
exit_on_error: true,
|
||||
jobs: 1,
|
||||
}
|
||||
}
|
||||
|
||||
fn args(job: DbToolJob) -> Vec<String> {
|
||||
job.args()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn dumps_plain_sql_with_copy_by_default() {
|
||||
let job = DbToolJob::PgDump { file: "/tmp/shop.sql".into(), options: dump() };
|
||||
assert_eq!(args(job), ["--format=p", "--file=/tmp/shop.sql", "--verbose"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn turns_lists_and_switches_into_flags() {
|
||||
let options = DbPgDumpOptions {
|
||||
statements: DbDumpStatements::ColumnInserts,
|
||||
content: DbDumpContent::DataOnly,
|
||||
schemas: vec!["public".into(), "audit".into()],
|
||||
tables: vec!["public.orders".into()],
|
||||
exclude_tables: vec!["public.log_*".into()],
|
||||
clean: true,
|
||||
if_exists: true,
|
||||
create: true,
|
||||
no_owner: true,
|
||||
..dump()
|
||||
};
|
||||
assert_eq!(
|
||||
args(DbToolJob::PgDump { file: "/tmp/x.sql".into(), options }),
|
||||
[
|
||||
"--format=p",
|
||||
"--file=/tmp/x.sql",
|
||||
"--column-inserts",
|
||||
"--data-only",
|
||||
"--schema=public",
|
||||
"--schema=audit",
|
||||
"--table=public.orders",
|
||||
"--exclude-table=public.log_*",
|
||||
"--clean",
|
||||
"--if-exists",
|
||||
"--create",
|
||||
"--no-owner",
|
||||
"--verbose",
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn leaves_drop_and_create_to_the_restore_of_an_archive() {
|
||||
let options = DbPgDumpOptions { format: DbDumpFormat::Custom, clean: true, create: true, ..dump() };
|
||||
let a = args(DbToolJob::PgDump { file: "/tmp/x.dump".into(), options });
|
||||
assert!(!a.iter().any(|a| a == "--clean" || a == "--create"), "{a:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn runs_parallel_jobs_only_where_the_tool_can() {
|
||||
let dir = DbPgDumpOptions { format: DbDumpFormat::Directory, jobs: 4, ..dump() };
|
||||
assert!(args(DbToolJob::PgDump { file: "/tmp/d".into(), options: dir.clone() }).contains(&"--jobs=4".into()));
|
||||
let custom = DbPgDumpOptions { format: DbDumpFormat::Custom, ..dir };
|
||||
assert!(!args(DbToolJob::PgDump { file: "/tmp/d".into(), options: custom }).contains(&"--jobs=4".into()));
|
||||
let single = DbPgRestoreOptions { jobs: 4, single_transaction: true, ..restore() };
|
||||
let a = args(DbToolJob::PgRestore { file: "/tmp/x".into(), options: single });
|
||||
assert!(a.contains(&"--single-transaction".into()) && !a.iter().any(|a| a.starts_with("--jobs")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn restores_the_archive_named_last_and_stops_on_the_first_error() {
|
||||
assert_eq!(
|
||||
args(DbToolJob::PgRestore { file: "/tmp/shop.dump".into(), options: restore() }),
|
||||
["--exit-on-error", "--verbose", "/tmp/shop.dump"]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn leaves_out_an_archive_not_chosen_yet() {
|
||||
let a = args(DbToolJob::PgRestore { file: String::new(), options: restore() });
|
||||
assert_eq!(a, ["--exit-on-error", "--verbose"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn runs_a_sql_file_in_one_transaction_that_stops_on_error() {
|
||||
let options = DbPsqlOptions { single_transaction: true, stop_on_error: true };
|
||||
assert_eq!(
|
||||
args(DbToolJob::Psql { file: "/tmp/shop.sql".into(), options }),
|
||||
["--file=/tmp/shop.sql", "--single-transaction", "--set=ON_ERROR_STOP=1"]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn quotes_what_a_shell_would_split() {
|
||||
let line = command_line(
|
||||
Path::new("/usr/bin/pg_dump"),
|
||||
&["--port=5432".into(), "--file=/tmp/my dump.sql".into(), "--table=it's".into()],
|
||||
);
|
||||
assert_eq!(line, r#"/usr/bin/pg_dump --port=5432 '--file=/tmp/my dump.sql' '--table=it'\''s'"#);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reads_the_job_the_dialog_sends() {
|
||||
let json = r#"{"tool":"psql","file":"/tmp/a.sql","options":{"singleTransaction":true,"stopOnError":false}}"#;
|
||||
let job: DbToolJob = serde_json::from_str(json).unwrap();
|
||||
assert_eq!(job.tool(), DbTool::Psql);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,536 @@
|
||||
//! Client tools of a database (`pg_dump`, `pg_restore`, `psql`): finding installed copies, the
|
||||
//! arguments and environment that connect them like the data source, and running them.
|
||||
|
||||
mod jobs;
|
||||
pub use jobs::*;
|
||||
|
||||
use crate::source::{DataSource, DbDriver, DbSslMode};
|
||||
use ide_core::{CancellationToken, IdeError, IdeResult};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
use std::ffi::OsStr;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::process::Stdio;
|
||||
use std::time::Duration;
|
||||
use tokio::io::{AsyncBufReadExt, AsyncRead, BufReader};
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum DbTool {
|
||||
PgDump,
|
||||
PgRestore,
|
||||
Psql,
|
||||
}
|
||||
|
||||
impl DbTool {
|
||||
pub fn program(self) -> &'static str {
|
||||
self.programs()[0]
|
||||
}
|
||||
|
||||
/// Executable names.
|
||||
pub fn programs(self) -> &'static [&'static str] {
|
||||
match self {
|
||||
DbTool::PgDump => &["pg_dump"],
|
||||
DbTool::PgRestore => &["pg_restore"],
|
||||
DbTool::Psql => &["psql"],
|
||||
}
|
||||
}
|
||||
|
||||
pub fn driver(self) -> DbDriver {
|
||||
DbDriver::Postgres
|
||||
}
|
||||
|
||||
/// Whether `path` names this tool (`pg_dump`, `pg_dump.exe`, `pg_dump-17`…).
|
||||
/// The data source's password is handed only to such a program.
|
||||
pub fn is_program(self, path: &Path) -> bool {
|
||||
let Some(stem) = path.file_stem().and_then(OsStr::to_str) else { return false };
|
||||
self.programs().iter().any(|p| {
|
||||
stem.strip_prefix(p).is_some_and(|rest| {
|
||||
let digits = rest.strip_prefix(['-', '.', '_']).unwrap_or(rest);
|
||||
digits.chars().all(|c| c.is_ascii_digit())
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// An installed copy of a tool.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase", rename = "DbToolInstall")]
|
||||
pub struct ToolInstall {
|
||||
pub path: String,
|
||||
/// First line of `--version`, e.g. `pg_dump (PostgreSQL) 17.2`.
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
/// A line the tool wrote.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase", rename = "DbToolLine")]
|
||||
pub struct ToolLine {
|
||||
pub stderr: bool,
|
||||
pub text: String,
|
||||
}
|
||||
|
||||
/// Directories holding the tools that are often missing from `PATH`, by platform.
|
||||
fn known_dirs() -> Vec<PathBuf> {
|
||||
let mut dirs = Vec::new();
|
||||
if cfg!(target_os = "macos") {
|
||||
for prefix in ["/opt/homebrew", "/usr/local"] {
|
||||
dirs.push(PathBuf::from(format!("{prefix}/bin")));
|
||||
let opt = PathBuf::from(format!("{prefix}/opt"));
|
||||
for keg in ["libpq", "postgresql"] {
|
||||
dirs.extend(children(&opt, keg).into_iter().map(|d| d.join("bin")));
|
||||
}
|
||||
}
|
||||
dirs.extend(
|
||||
children(Path::new("/Applications/Postgres.app/Contents/Versions"), "").into_iter().map(|d| d.join("bin")),
|
||||
);
|
||||
} else if cfg!(windows) {
|
||||
for var in ["ProgramFiles", "ProgramFiles(x86)"] {
|
||||
if let Some(base) = std::env::var_os(var) {
|
||||
let root = PathBuf::from(base).join("PostgreSQL");
|
||||
dirs.extend(children(&root, "").into_iter().map(|d| d.join("bin")));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
dirs.extend(children(Path::new("/usr/lib/postgresql"), "").into_iter().map(|d| d.join("bin")));
|
||||
dirs.extend(children(Path::new("/usr"), "pgsql-").into_iter().map(|d| d.join("bin")));
|
||||
}
|
||||
dirs
|
||||
}
|
||||
|
||||
/// Subdirectories of `parent` whose name starts with `prefix`, newest version first.
|
||||
fn children(parent: &Path, prefix: &str) -> Vec<PathBuf> {
|
||||
let Ok(entries) = std::fs::read_dir(parent) else { return Vec::new() };
|
||||
let mut dirs: Vec<PathBuf> = entries
|
||||
.flatten()
|
||||
.filter(|e| e.file_name().to_str().is_some_and(|n| n.starts_with(prefix)))
|
||||
.map(|e| e.path())
|
||||
.filter(|p| p.is_dir())
|
||||
.collect();
|
||||
dirs.sort_by_key(|p| std::cmp::Reverse(version_key(&p.to_string_lossy())));
|
||||
dirs
|
||||
}
|
||||
|
||||
/// The numbers in `text`, for comparing versions (`17.2` after `9.6`).
|
||||
fn version_key(text: &str) -> Vec<u32> {
|
||||
text.split(|c: char| !c.is_ascii_digit()).filter_map(|n| n.parse().ok()).collect()
|
||||
}
|
||||
|
||||
/// The installed copies of `tool` on `PATH` and in the usual install directories, newest first.
|
||||
/// Blocking: runs each one's `--version`.
|
||||
pub fn find_installs(tool: DbTool) -> Vec<ToolInstall> {
|
||||
let path = ide_core::process::host_var_os("PATH").unwrap_or_default();
|
||||
let mut dirs: Vec<PathBuf> = std::env::split_paths(&path).collect();
|
||||
dirs.extend(known_dirs());
|
||||
let mut seen = Vec::new();
|
||||
let mut out = Vec::new();
|
||||
for dir in dirs {
|
||||
for program in tool.programs() {
|
||||
let Some(found) = ide_core::process::find_executable(program, dir.as_os_str()) else { continue };
|
||||
let real = dunce::canonicalize(&found).unwrap_or_else(|_| found.clone());
|
||||
if seen.contains(&real) {
|
||||
continue;
|
||||
}
|
||||
seen.push(real);
|
||||
if let Ok(version) = version_of(&found) {
|
||||
out.push(ToolInstall { path: found.to_string_lossy().into_owned(), version });
|
||||
}
|
||||
}
|
||||
}
|
||||
out.sort_by_key(|i| std::cmp::Reverse(version_key(&i.version)));
|
||||
out
|
||||
}
|
||||
|
||||
/// The first line `path --version` prints. Blocking.
|
||||
pub fn version_of(path: &Path) -> IdeResult<String> {
|
||||
let (ok, text) = capture(path, "--version")?;
|
||||
match text.lines().next().map(str::trim).filter(|l| !l.is_empty()) {
|
||||
Some(line) if ok => Ok(line.to_owned()),
|
||||
_ => Err(IdeError::invalid(format!("{} is not a working executable", path.display()))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Runs `path arg` for at most five seconds; whether it succeeded, and its standard output.
|
||||
fn capture(path: &Path, arg: &str) -> IdeResult<(bool, String)> {
|
||||
if !path.is_file() {
|
||||
return Err(IdeError::not_found(format!("{} does not exist", path.display())));
|
||||
}
|
||||
let mut cmd = std::process::Command::new(path);
|
||||
cmd.arg(arg).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::null());
|
||||
ide_core::process::prepare(&mut cmd);
|
||||
let mut child = cmd.spawn().map_err(|e| IdeError::invalid(format!("cannot run {}: {e}", path.display())))?;
|
||||
let mut stdout = child.stdout.take().expect("piped");
|
||||
let reader = std::thread::spawn(move || {
|
||||
let mut buf = Vec::new();
|
||||
let _ = std::io::Read::read_to_end(&mut stdout, &mut buf);
|
||||
buf
|
||||
});
|
||||
let deadline = std::time::Instant::now() + Duration::from_secs(5);
|
||||
let status = loop {
|
||||
if let Some(status) = child.try_wait()? {
|
||||
break status;
|
||||
}
|
||||
if std::time::Instant::now() > deadline {
|
||||
let _ = child.kill();
|
||||
let _ = child.wait();
|
||||
return Err(IdeError::invalid(format!("{} {arg} did not finish", path.display())));
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(20));
|
||||
};
|
||||
let out = reader.join().unwrap_or_default();
|
||||
Ok((status.success(), String::from_utf8_lossy(&out).into_owned()))
|
||||
}
|
||||
|
||||
/// What made a dump, read from its first bytes (a directory: its `toc.dat`).
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum DbDumpKind {
|
||||
/// `pg_dump` custom or tar archive, or a directory archive: `pg_restore`.
|
||||
PostgresArchive,
|
||||
/// Plain SQL from `pg_dump`: `psql`.
|
||||
PostgresSql,
|
||||
/// `mysqldump` / `mariadb-dump`: not for the PostgreSQL tools.
|
||||
MysqlSql,
|
||||
Unknown,
|
||||
}
|
||||
|
||||
/// Blocking: reads at most the first 4 KiB.
|
||||
pub fn dump_kind(path: &Path) -> IdeResult<DbDumpKind> {
|
||||
use std::io::Read;
|
||||
if path.is_dir() {
|
||||
return Ok(if path.join("toc.dat").is_file() { DbDumpKind::PostgresArchive } else { DbDumpKind::Unknown });
|
||||
}
|
||||
let mut head = Vec::with_capacity(4096);
|
||||
std::fs::File::open(path)
|
||||
.map_err(|e| IdeError::not_found(format!("cannot read {}: {e}", path.display())))?
|
||||
.take(4096)
|
||||
.read_to_end(&mut head)?;
|
||||
Ok(kind_of(&head))
|
||||
}
|
||||
|
||||
fn kind_of(head: &[u8]) -> DbDumpKind {
|
||||
// A tar archive keeps `toc.dat` first; its name starts the 512-byte header.
|
||||
if head.starts_with(b"PGDMP") || head.starts_with(b"toc.dat\0") {
|
||||
return DbDumpKind::PostgresArchive;
|
||||
}
|
||||
let text = String::from_utf8_lossy(head);
|
||||
let comments: Vec<&str> = text.lines().take(20).filter(|l| l.starts_with("--")).collect();
|
||||
if comments.iter().any(|l| l.contains("PostgreSQL database dump")) {
|
||||
DbDumpKind::PostgresSql
|
||||
} else if comments.iter().any(|l| l.starts_with("-- MySQL dump") || l.starts_with("-- MariaDB dump")) {
|
||||
DbDumpKind::MysqlSql
|
||||
} else {
|
||||
DbDumpKind::Unknown
|
||||
}
|
||||
}
|
||||
|
||||
/// Arguments and environment that connect `tool` to `source` (already resolved, through its
|
||||
/// tunnel when it has one). The password is left to [`prepare`].
|
||||
pub fn connection(tool: DbTool, source: &DataSource) -> (Vec<String>, Vec<(String, String)>) {
|
||||
let mut args = Vec::new();
|
||||
let host = source.host.trim();
|
||||
if !host.is_empty() {
|
||||
args.push(format!("--host={host}"));
|
||||
}
|
||||
args.push(format!("--port={}", source.port.or(source.driver.default_port()).unwrap_or(5432)));
|
||||
if !source.user.trim().is_empty() {
|
||||
args.push(format!("--username={}", source.user.trim()));
|
||||
}
|
||||
if !source.database.is_empty() {
|
||||
args.push(format!("--dbname={}", source.database));
|
||||
}
|
||||
// Without a terminal a password prompt would wait forever: fail instead.
|
||||
args.push("--no-password".into());
|
||||
|
||||
let mut env = vec![
|
||||
("PGAPPNAME".to_owned(), format!("OpenIDEA {}", tool.program())),
|
||||
(
|
||||
"PGSSLMODE".to_owned(),
|
||||
match source.ssl {
|
||||
DbSslMode::Disable => "disable",
|
||||
DbSslMode::Prefer => "prefer",
|
||||
DbSslMode::Require => "require",
|
||||
DbSslMode::VerifyCa => "verify-ca",
|
||||
DbSslMode::VerifyFull => "verify-full",
|
||||
}
|
||||
.to_owned(),
|
||||
),
|
||||
];
|
||||
for (var, file) in [
|
||||
("PGSSLROOTCERT", &source.ssl_ca_file),
|
||||
("PGSSLCERT", &source.ssl_cert_file),
|
||||
("PGSSLKEY", &source.ssl_key_file),
|
||||
] {
|
||||
if !file.trim().is_empty() {
|
||||
env.push((var.to_owned(), ide_ssh::expand(file.trim()).to_string_lossy().into_owned()));
|
||||
}
|
||||
}
|
||||
if source.read_only {
|
||||
env.push(("PGOPTIONS".to_owned(), "-c default_transaction_read_only=on".to_owned()));
|
||||
}
|
||||
(args, env)
|
||||
}
|
||||
|
||||
/// How a tool is started: connection arguments, then the job's, and the environment.
|
||||
pub struct Prepared {
|
||||
pub args: Vec<String>,
|
||||
pub env: Vec<(String, String)>,
|
||||
}
|
||||
|
||||
/// The command for `job` against `source`. The password goes in `PGPASSWORD`, never in the
|
||||
/// arguments, which other users of the machine can read in the process list.
|
||||
pub fn prepare(job: &DbToolJob, source: &DataSource, password: Option<&str>) -> Prepared {
|
||||
let (mut args, mut env) = connection(job.tool(), source);
|
||||
args.extend(job.args());
|
||||
if let Some(p) = password.filter(|p| !p.is_empty()) {
|
||||
env.push(("PGPASSWORD".into(), p.to_owned()));
|
||||
}
|
||||
Prepared { args, env }
|
||||
}
|
||||
|
||||
/// Runs `program` until it exits, passing its output in batches. Returns the exit code
|
||||
/// (`None`: ended by a signal). Cancelling kills it and everything it started.
|
||||
pub async fn run(
|
||||
program: &Path,
|
||||
args: &[String],
|
||||
env: &[(String, String)],
|
||||
cancel: &CancellationToken,
|
||||
mut on_output: impl FnMut(Vec<ToolLine>),
|
||||
) -> IdeResult<Option<i32>> {
|
||||
let mut cmd = tokio::process::Command::new(program);
|
||||
cmd.args(args)
|
||||
.envs(env.iter().map(|(k, v)| (k, v)))
|
||||
.stdin(Stdio::null())
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::piped())
|
||||
.kill_on_drop(true);
|
||||
ide_core::process::prepare(cmd.as_std_mut());
|
||||
ide_core::process::own_group(cmd.as_std_mut());
|
||||
let mut child = cmd.spawn().map_err(|e| IdeError::invalid(format!("cannot start {}: {e}", program.display())))?;
|
||||
let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
|
||||
if let Some(out) = child.stdout.take() {
|
||||
forward(out, false, tx.clone());
|
||||
}
|
||||
if let Some(err) = child.stderr.take() {
|
||||
forward(err, true, tx);
|
||||
}
|
||||
|
||||
let mut batch = Vec::new();
|
||||
let mut tick = tokio::time::interval(Duration::from_millis(100));
|
||||
loop {
|
||||
tokio::select! {
|
||||
line = rx.recv() => match line {
|
||||
Some(line) => {
|
||||
batch.push(line);
|
||||
if batch.len() >= 500 {
|
||||
on_output(std::mem::take(&mut batch));
|
||||
}
|
||||
}
|
||||
None => break,
|
||||
},
|
||||
_ = tick.tick() => {
|
||||
if !batch.is_empty() {
|
||||
on_output(std::mem::take(&mut batch));
|
||||
}
|
||||
}
|
||||
_ = cancel.cancelled() => {
|
||||
if let Some(pid) = child.id() {
|
||||
ide_core::process::kill_tree_of(pid);
|
||||
}
|
||||
let _ = child.kill().await;
|
||||
return Err(IdeError::cancelled());
|
||||
}
|
||||
}
|
||||
}
|
||||
if !batch.is_empty() {
|
||||
on_output(batch);
|
||||
}
|
||||
let status = tokio::select! {
|
||||
status = child.wait() => status?,
|
||||
_ = cancel.cancelled() => {
|
||||
if let Some(pid) = child.id() {
|
||||
ide_core::process::kill_tree_of(pid);
|
||||
}
|
||||
let _ = child.kill().await;
|
||||
return Err(IdeError::cancelled());
|
||||
}
|
||||
};
|
||||
Ok(status.code())
|
||||
}
|
||||
|
||||
fn forward(
|
||||
pipe: impl AsyncRead + Unpin + Send + 'static,
|
||||
stderr: bool,
|
||||
tx: tokio::sync::mpsc::UnboundedSender<ToolLine>,
|
||||
) {
|
||||
tokio::spawn(async move {
|
||||
let mut reader = BufReader::new(pipe);
|
||||
let mut buf = Vec::new();
|
||||
loop {
|
||||
buf.clear();
|
||||
match reader.read_until(b'\n', &mut buf).await {
|
||||
Ok(0) | Err(_) => break,
|
||||
Ok(_) => {
|
||||
let text = String::from_utf8_lossy(&buf).trim_end_matches(['\r', '\n']).to_owned();
|
||||
if tx.send(ToolLine { stderr, text }).is_err() {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn pg() -> DataSource {
|
||||
DataSource {
|
||||
driver: DbDriver::Postgres,
|
||||
host: "db.example.test".into(),
|
||||
port: Some(6543),
|
||||
user: "app".into(),
|
||||
database: "shop".into(),
|
||||
..DataSource::default()
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn connects_like_the_data_source_without_prompting() {
|
||||
let (args, env) = connection(DbTool::PgDump, &pg());
|
||||
assert_eq!(args, ["--host=db.example.test", "--port=6543", "--username=app", "--dbname=shop", "--no-password"]);
|
||||
assert!(env.contains(&("PGSSLMODE".into(), "prefer".into())));
|
||||
assert!(!env.iter().any(|(k, _)| k == "PGPASSWORD" || k == "PGOPTIONS"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn default_port_and_optional_fields() {
|
||||
let source = DataSource { port: None, user: String::new(), database: String::new(), ..pg() };
|
||||
let (args, _) = connection(DbTool::Psql, &source);
|
||||
assert_eq!(args, ["--host=db.example.test", "--port=5432", "--no-password"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_only_sources_refuse_writes() {
|
||||
let source = DataSource { read_only: true, ssl: DbSslMode::VerifyFull, ..pg() };
|
||||
let (_, env) = connection(DbTool::PgRestore, &source);
|
||||
assert!(env.contains(&("PGOPTIONS".into(), "-c default_transaction_read_only=on".into())));
|
||||
assert!(env.contains(&("PGSSLMODE".into(), "verify-full".into())));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_the_tool_itself_is_accepted() {
|
||||
for ok in ["/usr/bin/pg_dump", "/pg/bin/pg_dump.exe", "/usr/bin/pg_dump-17", "/opt/pg_dump17"] {
|
||||
assert!(DbTool::PgDump.is_program(Path::new(ok)), "{ok}");
|
||||
}
|
||||
for bad in ["/usr/bin/pg_dumpall", "/bin/sh", "/usr/bin/pg_restore", "/tmp/evil"] {
|
||||
assert!(!DbTool::PgDump.is_program(Path::new(bad)), "{bad}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tells_dumps_apart_by_their_header() {
|
||||
assert_eq!(kind_of(b"PGDMP\x01\x0f"), DbDumpKind::PostgresArchive);
|
||||
assert_eq!(kind_of(b"toc.dat\0\0\0"), DbDumpKind::PostgresArchive);
|
||||
assert_eq!(kind_of(b"--\n-- PostgreSQL database dump\n--\n"), DbDumpKind::PostgresSql);
|
||||
assert_eq!(kind_of(b"-- MySQL dump 10.13 Distrib 8.4.6\n--\n"), DbDumpKind::MysqlSql);
|
||||
assert_eq!(kind_of(b"-- MariaDB dump 10.19 Distrib 11.4.2\n"), DbDumpKind::MysqlSql);
|
||||
assert_eq!(kind_of(b"CREATE TABLE t (id int);\n"), DbDumpKind::Unknown);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn newer_versions_sort_first() {
|
||||
assert!(version_key("pg_dump (PostgreSQL) 17.2") > version_key("pg_dump (PostgreSQL) 9.6.24"));
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[tokio::test]
|
||||
async fn streams_both_pipes_and_reports_the_exit_code() {
|
||||
let mut lines = Vec::new();
|
||||
let code = run(
|
||||
Path::new("/bin/sh"),
|
||||
&["-c".into(), "echo out; echo err >&2; exit 3".into()],
|
||||
&[],
|
||||
&CancellationToken::new(),
|
||||
|batch| lines.extend(batch),
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(code, Some(3));
|
||||
assert!(lines.contains(&ToolLine { stderr: false, text: "out".into() }));
|
||||
assert!(lines.contains(&ToolLine { stderr: true, text: "err".into() }));
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[tokio::test]
|
||||
async fn cancelling_stops_the_process() {
|
||||
let cancel = CancellationToken::new();
|
||||
let stop = cancel.clone();
|
||||
tokio::spawn(async move {
|
||||
tokio::time::sleep(Duration::from_millis(100)).await;
|
||||
stop.cancel();
|
||||
});
|
||||
let result = run(Path::new("/bin/sh"), &["-c".into(), "sleep 30".into()], &[], &cancel, |_| {}).await;
|
||||
assert!(result.is_err());
|
||||
}
|
||||
|
||||
/// A stand-in for `tool` that prints each argument on a line, then whether `PGPASSWORD`
|
||||
/// holds the expected password.
|
||||
#[cfg(unix)]
|
||||
fn echo_tool(dir: &Path, tool: DbTool) -> PathBuf {
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
let path = dir.join(tool.program());
|
||||
std::fs::write(
|
||||
&path,
|
||||
"#!/bin/sh\nfor a in \"$@\"; do echo \"arg:$a\"; done\necho \"env:${PGPASSWORD:+set}\"\n",
|
||||
)
|
||||
.unwrap();
|
||||
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o755)).unwrap();
|
||||
path
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[tokio::test]
|
||||
async fn the_password_never_reaches_the_arguments() {
|
||||
const SECRET: &str = "s3cret-pass-do-not-leak";
|
||||
let dir = std::env::temp_dir().join(format!("openidea-tools-{}", uuid::Uuid::new_v4()));
|
||||
std::fs::create_dir_all(&dir).unwrap();
|
||||
let file = dir.join("out.sql").to_string_lossy().into_owned();
|
||||
let jobs = [
|
||||
DbToolJob::PgDump {
|
||||
file: file.clone(),
|
||||
options: DbPgDumpOptions {
|
||||
format: DbDumpFormat::Plain,
|
||||
statements: DbDumpStatements::Copy,
|
||||
content: DbDumpContent::All,
|
||||
schemas: vec!["public".into()],
|
||||
tables: vec![],
|
||||
exclude_tables: vec![],
|
||||
clean: true,
|
||||
if_exists: true,
|
||||
create: false,
|
||||
no_owner: false,
|
||||
no_privileges: false,
|
||||
jobs: 1,
|
||||
},
|
||||
},
|
||||
DbToolJob::Psql {
|
||||
file: file.clone(),
|
||||
options: DbPsqlOptions { single_transaction: true, stop_on_error: true },
|
||||
},
|
||||
];
|
||||
for job in jobs {
|
||||
let program = echo_tool(&dir, job.tool());
|
||||
let prepared = prepare(&job, &pg(), Some(SECRET));
|
||||
assert!(!prepared.args.iter().any(|a| a.contains(SECRET)), "{:?}", prepared.args);
|
||||
let mut lines = Vec::new();
|
||||
run(&program, &prepared.args, &prepared.env, &CancellationToken::new(), |b| lines.extend(b)).await.unwrap();
|
||||
let text: Vec<&str> = lines.iter().map(|l| l.text.as_str()).collect();
|
||||
assert!(text.contains(&"arg:--dbname=shop"), "{text:?}");
|
||||
assert!(!text.iter().any(|l| l.contains(SECRET)), "{text:?}");
|
||||
assert!(text.contains(&"env:set"), "the tool gets the password from PGPASSWORD: {text:?}");
|
||||
}
|
||||
std::fs::remove_dir_all(&dir).unwrap();
|
||||
}
|
||||
}
|
||||
@@ -228,3 +228,78 @@ async fn opening_a_table_reads_multi_column_keys_in_order() -> IdeResult<()> {
|
||||
db.execute("p", "DROP SCHEMA oi_keys CASCADE", 10, &c).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Runs `job` with the newest installed copy of its tool, the way the dialogs do.
|
||||
async fn run_tool(db: &DbManager, target: &str, job: ide_db::tools::DbToolJob) -> IdeResult<()> {
|
||||
let install = ide_db::tools::find_installs(job.tool()).into_iter().next().expect("installed");
|
||||
let mut lines = Vec::new();
|
||||
let code = db.run_tool(target, install.path.as_ref(), &job, &CancellationToken::new(), |b| lines.extend(b)).await?;
|
||||
assert_eq!(code, Some(0), "{} failed: {lines:?}", job.tool().program());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn dumps_and_restores_with_the_client_tools() -> IdeResult<()> {
|
||||
use ide_db::tools::{
|
||||
DbDumpContent, DbDumpFormat, DbDumpStatements, DbPgDumpOptions, DbPgRestoreOptions, DbPsqlOptions, DbTool,
|
||||
DbToolJob, find_installs,
|
||||
};
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let Some(db) = manager(&tmp).await else { return Ok(()) };
|
||||
let server = db.server_version("p").await? / 10000;
|
||||
let major = |t: DbTool| {
|
||||
find_installs(t).first().and_then(|i| i.version.split(' ').nth(2)?.split('.').next()?.parse::<u32>().ok())
|
||||
};
|
||||
// Other major versions write or refuse what this server needs; the dialogs warn about that instead.
|
||||
if [DbTool::PgDump, DbTool::PgRestore, DbTool::Psql].into_iter().any(|t| major(t) != Some(server)) {
|
||||
return Ok(());
|
||||
}
|
||||
create_schemas(&db).await;
|
||||
let c = CancellationToken::new();
|
||||
db.execute("p", "DROP DATABASE IF EXISTS oi_restore", 1, &c).await?;
|
||||
db.execute("p", "CREATE DATABASE oi_restore", 1, &c).await?;
|
||||
let file = |name: &str| tmp.path().join(name).to_string_lossy().into_owned();
|
||||
|
||||
let dump = |format, file: String, schema: &str| DbToolJob::PgDump {
|
||||
file,
|
||||
options: DbPgDumpOptions {
|
||||
format,
|
||||
statements: DbDumpStatements::Copy,
|
||||
content: DbDumpContent::All,
|
||||
schemas: vec![schema.into()],
|
||||
tables: vec![],
|
||||
exclude_tables: vec![],
|
||||
clean: false,
|
||||
if_exists: false,
|
||||
create: false,
|
||||
no_owner: false,
|
||||
no_privileges: false,
|
||||
jobs: 1,
|
||||
},
|
||||
};
|
||||
let archive = file("a.dump");
|
||||
run_tool(&db, "p", dump(DbDumpFormat::Custom, archive.clone(), "oi_a")).await?;
|
||||
let restore = DbPgRestoreOptions {
|
||||
content: DbDumpContent::All,
|
||||
schemas: vec![],
|
||||
clean: false,
|
||||
if_exists: false,
|
||||
no_owner: false,
|
||||
no_privileges: false,
|
||||
single_transaction: false,
|
||||
exit_on_error: true,
|
||||
jobs: 1,
|
||||
};
|
||||
run_tool(&db, "p:oi_restore", DbToolJob::PgRestore { file: archive, options: restore }).await?;
|
||||
|
||||
let script = file("b.sql");
|
||||
run_tool(&db, "p", dump(DbDumpFormat::Plain, script.clone(), "oi_b")).await?;
|
||||
let psql = DbPsqlOptions { single_transaction: true, stop_on_error: true };
|
||||
run_tool(&db, "p:oi_restore", DbToolJob::Psql { file: script, options: psql }).await?;
|
||||
|
||||
let r = db.execute("p:oi_restore", "SELECT a.tag || ', ' || b.tag FROM oi_a.items a, oi_b.items b", 1, &c).await?;
|
||||
assert_eq!(r.rows[0][0].as_deref(), Some("from a, from b"));
|
||||
db.disconnect("p:oi_restore").await;
|
||||
db.execute("p", "DROP DATABASE oi_restore", 1, &c).await?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -26,6 +26,8 @@ pub enum Capability {
|
||||
DatabaseSources,
|
||||
VcsRead,
|
||||
VcsWrite,
|
||||
/// The Maven / Gradle dependency graph the IDE resolved.
|
||||
BuildRead,
|
||||
/// The plugin's own key-value store and data directory.
|
||||
Storage,
|
||||
/// The plugin's own secrets (kept in the client's OS keychain).
|
||||
@@ -55,6 +57,9 @@ pub enum Capability {
|
||||
FsRead(String),
|
||||
/// Write files outside the project under one path.
|
||||
FsWrite(String),
|
||||
/// Load the plugin's Java agent into the JVMs of Java run configurations. Never
|
||||
/// declared: it comes from `[[contributes.javaAgents]]`.
|
||||
JavaAgent,
|
||||
}
|
||||
|
||||
/// How a grant is presented (plan 4.2).
|
||||
@@ -72,7 +77,9 @@ pub enum Risk {
|
||||
impl Capability {
|
||||
pub fn risk(&self) -> Risk {
|
||||
match self {
|
||||
Self::ProjectRead | Self::EditorRead | Self::Storage | Self::Events | Self::VcsRead => Risk::Low,
|
||||
Self::ProjectRead | Self::EditorRead | Self::Storage | Self::Events | Self::VcsRead | Self::BuildRead => {
|
||||
Risk::Low
|
||||
}
|
||||
Self::EditorWrite
|
||||
| Self::DatabaseSources
|
||||
| Self::VcsWrite
|
||||
@@ -90,7 +97,8 @@ impl Capability {
|
||||
| Self::Process(_)
|
||||
| Self::Lsp(_)
|
||||
| Self::FsRead(_)
|
||||
| Self::FsWrite(_) => Risk::High,
|
||||
| Self::FsWrite(_)
|
||||
| Self::JavaAgent => Risk::High,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -111,6 +119,7 @@ impl Capability {
|
||||
Self::IdeCommands => "Run any IDE action or other plugins' commands as if you chose them, including running programs, committing and pushing".into(),
|
||||
Self::VcsRead => "Read version control state".into(),
|
||||
Self::VcsWrite => "Change version control state (commit, fetch, checkout)".into(),
|
||||
Self::BuildRead => "Read the project's resolved Maven and Gradle dependencies".into(),
|
||||
Self::Storage => "Store its own data".into(),
|
||||
Self::Secrets => "Store secrets in the system keychain".into(),
|
||||
Self::Events => "Observe editor, filesystem and version control events".into(),
|
||||
@@ -135,6 +144,7 @@ impl Capability {
|
||||
}
|
||||
Self::FsRead(path) => format!("Read files under {path}, outside the project"),
|
||||
Self::FsWrite(path) => format!("Change files under {path}, outside the project"),
|
||||
Self::JavaAgent => "Run code inside the Java applications you start".into(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -246,6 +256,7 @@ impl fmt::Display for Capability {
|
||||
Self::DatabaseSources => f.write_str("database.sources"),
|
||||
Self::VcsRead => f.write_str("vcs.read"),
|
||||
Self::VcsWrite => f.write_str("vcs.write"),
|
||||
Self::BuildRead => f.write_str("build.read"),
|
||||
Self::Storage => f.write_str("storage"),
|
||||
Self::Secrets => f.write_str("secrets"),
|
||||
Self::Events => f.write_str("events"),
|
||||
@@ -259,6 +270,7 @@ impl fmt::Display for Capability {
|
||||
Self::Lsp(s) => write!(f, "lsp:{s}"),
|
||||
Self::FsRead(p) => write!(f, "fs.read:{p}"),
|
||||
Self::FsWrite(p) => write!(f, "fs.write:{p}"),
|
||||
Self::JavaAgent => f.write_str("java.agent"),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -330,11 +342,13 @@ impl FromStr for Capability {
|
||||
"database.sources" => Self::DatabaseSources,
|
||||
"vcs.read" => Self::VcsRead,
|
||||
"vcs.write" => Self::VcsWrite,
|
||||
"build.read" => Self::BuildRead,
|
||||
"storage" => Self::Storage,
|
||||
"secrets" => Self::Secrets,
|
||||
"events" => Self::Events,
|
||||
"events.input" => Self::InputEvents,
|
||||
"clipboard" => Self::Clipboard,
|
||||
"java.agent" => Self::JavaAgent,
|
||||
_ => return Err(format!("unknown capability {s:?}")),
|
||||
})
|
||||
}
|
||||
@@ -383,6 +397,7 @@ mod tests {
|
||||
"editor.write",
|
||||
"project.write",
|
||||
"vcs.write",
|
||||
"build.read",
|
||||
"storage",
|
||||
"secrets",
|
||||
"events",
|
||||
@@ -392,6 +407,7 @@ mod tests {
|
||||
"process:cargo",
|
||||
"lsp:phoxite",
|
||||
"lsp:rust-analyzer",
|
||||
"java.agent",
|
||||
] {
|
||||
assert_eq!(s.parse::<Capability>().unwrap().to_string(), s);
|
||||
}
|
||||
@@ -425,8 +441,11 @@ mod tests {
|
||||
assert_eq!(Capability::Clipboard.risk(), Risk::Medium);
|
||||
assert_eq!(Capability::Process("cargo".into()).risk(), Risk::High);
|
||||
assert_eq!(Capability::Lsp("phoxite".into()).risk(), Risk::High);
|
||||
assert_eq!(Capability::BuildRead.risk(), Risk::Low);
|
||||
assert!(!Capability::Lsp("phoxite".into()).covers(&Capability::Lsp("intelephense".into())));
|
||||
assert!(Capability::Storage.auto_migrates() && !Capability::EditorWrite.auto_migrates());
|
||||
assert_eq!(Capability::JavaAgent.risk(), Risk::High);
|
||||
assert!(!Capability::JavaAgent.auto_migrates());
|
||||
}
|
||||
|
||||
/// A trusted project's files name programs the IDE starts by itself: the git and language
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
//! - `process:<program>` grants record the program's absolute path and file
|
||||
//! hash at grant time. Calls use that path, never a `PATH` lookup, and fail
|
||||
//! when the file changed (re-confirmation needed).
|
||||
//! - `java.agent` grants record the agent jar's path and hash the same way;
|
||||
//! a launch adds the agent only while the jar still has that hash.
|
||||
|
||||
use crate::capability::{Capability, Risk};
|
||||
use serde::{Deserialize, Serialize};
|
||||
@@ -267,7 +269,7 @@ impl Ledger {
|
||||
if cap == &Capability::NetAsk {
|
||||
grant.net_hosts.clear();
|
||||
}
|
||||
if let Capability::Process(_) = cap {
|
||||
if let Capability::Process(_) | Capability::JavaAgent = cap {
|
||||
grant.binaries.remove(&s);
|
||||
for binaries in grant.project_binaries.values_mut() {
|
||||
binaries.remove(&s);
|
||||
@@ -290,7 +292,7 @@ impl Ledger {
|
||||
self.grants.get_mut(subject).is_some_and(|g| g.net_hosts.remove(host))
|
||||
}
|
||||
|
||||
/// Records the program approved for a `process:` grant.
|
||||
/// Records the program approved for a `process:` grant (or the jar of a `java.agent` one).
|
||||
pub fn set_binary(&mut self, subject: &Subject, cap: &Capability, binary: BinaryGrant) {
|
||||
if let Some(grant) = self.grants.get_mut(subject) {
|
||||
grant.binaries.insert(cap.to_string(), binary);
|
||||
@@ -675,6 +677,21 @@ mod tests {
|
||||
assert!(l.check_binary(&r.subject, &cap).unwrap_err().contains("changed"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn revoking_java_agent_forgets_its_jar() {
|
||||
let mut l = Ledger::in_memory();
|
||||
let r = req("1.0.0", "h", &[], &["java.agent"]);
|
||||
let cap = Capability::JavaAgent;
|
||||
let jar = BinaryGrant { path: "/plugins/p/agent.jar".into(), hash: "abc".into() };
|
||||
l.confirm(&r, std::slice::from_ref(&cap), [(cap.to_string(), jar.clone())].into());
|
||||
assert_eq!(l.pinned_binary(&r.subject, &cap), Some(jar.clone()));
|
||||
l.set(&r.subject, &cap, false);
|
||||
assert_eq!(l.pinned_binary(&r.subject, &cap), None);
|
||||
// Granting again without a new hash does not bring the old one back.
|
||||
l.set(&r.subject, &cap, true);
|
||||
assert_eq!(l.pinned_binary(&r.subject, &cap), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hashes_and_grouping() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
|
||||
@@ -34,7 +34,7 @@ use std::path::{Component, Path, PathBuf};
|
||||
|
||||
pub const MANIFEST_FILE: &str = "plugin.toml";
|
||||
/// The plugin API (engine) version this host implements.
|
||||
pub const ENGINE_VERSION: &str = "1.9.0";
|
||||
pub const ENGINE_VERSION: &str = "1.10.0";
|
||||
/// The 0.1 API, still accepted for contribution-only packages and 0.1 components.
|
||||
pub const LEGACY_API: &str = "0.1";
|
||||
/// Marketplace categories, in the order they are shown.
|
||||
@@ -360,6 +360,14 @@ impl Manifest {
|
||||
if matches!(cap, Capability::Lsp(_)) {
|
||||
self.needs_api(&format!("capability `{cap}`"), 9)?;
|
||||
}
|
||||
if matches!(cap, Capability::BuildRead) {
|
||||
self.needs_api(&format!("capability `{cap}`"), 10)?;
|
||||
}
|
||||
if matches!(cap, Capability::JavaAgent) {
|
||||
return Err(
|
||||
"`java.agent` comes from `[[contributes.javaAgents]]`: remove it from [capabilities]".into()
|
||||
);
|
||||
}
|
||||
}
|
||||
if let Some(dark) = &self.icon_dark {
|
||||
if self.icon.is_none() {
|
||||
@@ -730,6 +738,22 @@ required = [\"lsp:phoxite\"]
|
||||
assert_eq!(m.capabilities.required, [Capability::Lsp("phoxite".into())]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_build_capability_needs_api_1_10() {
|
||||
let caps = "[capabilities]\noptional = [\"build.read\"]\n";
|
||||
assert!(err(&format!("{}{caps}", BASE.replace("^1.2", "^1.9"))).contains("new in plugin API 1.10"));
|
||||
let m = Manifest::parse(&format!("{}{caps}", BASE.replace("^1.2", "^1.10"))).unwrap();
|
||||
assert_eq!(m.capabilities.optional, [Capability::BuildRead]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn java_agent_capability_is_not_declared() {
|
||||
for list in ["required", "optional"] {
|
||||
let caps = format!("[capabilities]\n{list} = [\"java.agent\"]\n");
|
||||
assert!(err(&format!("{}{caps}", BASE.replace("^1.2", "^1.10"))).contains("contributes.javaAgents"));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_icons() {
|
||||
let m = Manifest::parse(&format!("{BASE}icon = \"icon.svg\"\nicon-dark = \"icon_dark.svg\"\n")).unwrap();
|
||||
|
||||
@@ -30,6 +30,8 @@ ide-vcs.workspace = true
|
||||
ide-dap.workspace = true
|
||||
ide-heap.workspace = true
|
||||
ide-jvm-attach.workspace = true
|
||||
ide-jvm-inspect.workspace = true
|
||||
ide-streams.workspace = true
|
||||
ide-build.workspace = true
|
||||
ide-analysis.workspace = true
|
||||
ide-coverage.workspace = true
|
||||
|
||||
@@ -331,7 +331,7 @@ targetIndex, or narrow the call with a contextSnippet that shows the one you mea
|
||||
FileEdit::Rename { from, to } => vec![from, to],
|
||||
};
|
||||
for p in paths {
|
||||
if let Err(e) = super::super::tool::ensure_inside(call.root(), p) {
|
||||
if let Err(e) = call.ensure_writable_place(p) {
|
||||
let hint = format!(
|
||||
"{}. Nothing was renamed. A rename that must change a file outside the project cannot run here.",
|
||||
e.message
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
use super::page::{OFFSET, Page};
|
||||
use super::scope::{self, Scope};
|
||||
use super::tool::{Call, Output, Param, ParamType, Tool};
|
||||
use ide_core::{Diagnostic, IdeResult, Severity};
|
||||
use serde_json::{Map, Value, json};
|
||||
@@ -14,7 +15,8 @@ pub fn tools() -> Vec<Tool> {
|
||||
|
||||
Use this tool to explore current open editors.",
|
||||
open_editors,
|
||||
),
|
||||
)
|
||||
.param(scope::param()),
|
||||
Tool::new(
|
||||
"get_current_file",
|
||||
"Returns the focused editor's file and selection reported by the IDE.
|
||||
@@ -43,18 +45,20 @@ Lines and UTF-16 columns are 1-based.",
|
||||
project_problems,
|
||||
)
|
||||
.param(Param::optional("errorsOnly", ParamType::Boolean, "Only errors (default) or warnings too"))
|
||||
.param(scope::param())
|
||||
.param(Param::optional("limit", ParamType::Integer, "Problems to return at most (default 100)"))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET)),
|
||||
]
|
||||
}
|
||||
|
||||
async fn open_editors(call: Call) -> IdeResult<Output> {
|
||||
let dir = Scope::of(&call)?;
|
||||
let windows = call.host.mcp_windows(call.root());
|
||||
let open = call.host.mcp_reports.editors(&windows);
|
||||
let active = call.host.mcp_reports.focused(call.window());
|
||||
let active = call.host.mcp_reports.focused(call.window()).filter(|e| dir.contains(&e.path.0));
|
||||
Output::json(json!({
|
||||
"activeFilePath": active.map(|e| call.display(&e.path.0)),
|
||||
"openFiles": open.iter().map(|p| call.display(p)).collect::<Vec<_>>(),
|
||||
"openFiles": open.iter().filter(|p| dir.contains(p)).map(|p| call.display(p)).collect::<Vec<_>>(),
|
||||
}))
|
||||
}
|
||||
|
||||
@@ -99,9 +103,11 @@ async fn file_problems(call: Call) -> IdeResult<Output> {
|
||||
async fn project_problems(call: Call) -> IdeResult<Output> {
|
||||
let page = Page::of(&call, PROBLEMS_LIMIT)?;
|
||||
let errors_only = call.flag("errorsOnly", true)?;
|
||||
let dir = Scope::of(&call)?;
|
||||
let files = call.host.mcp_reports.problems(&call.host.mcp_windows(call.root()));
|
||||
let problems: Vec<(String, Value)> = files
|
||||
.into_iter()
|
||||
.filter(|f| dir.contains(&f.path.0))
|
||||
.flat_map(|f| {
|
||||
let path = call.display(&f.path.0);
|
||||
let wanted = f.items.into_iter().filter(|d| !errors_only || d.severity == Severity::Error);
|
||||
|
||||
@@ -167,7 +167,10 @@ The `url` field in the result is as written in the file (unsubstituted); transpo
|
||||
}
|
||||
call.confirm(&subject, Some(detail)).await?;
|
||||
|
||||
let exchange = ide_http::run(input, &call.cancel).await?;
|
||||
// Exactly the request the user approved: preparing it again would read the
|
||||
// environment files again, which may name another destination by now.
|
||||
let redact_url = prepared.url.clone();
|
||||
let exchange = ide_http::send(prepared, Some(&path), &call.cancel).await?;
|
||||
let history = call.project().http_history.clone();
|
||||
let saved = exchange.clone();
|
||||
let _ = call.host().blocking(move || history.add(&saved)).await;
|
||||
@@ -188,7 +191,7 @@ The `url` field in the result is as written in the file (unsubstituted); transpo
|
||||
"status": response.map(|r| r.status),
|
||||
"statusText": response.map(|r| r.status_text.clone()),
|
||||
"totalMs": response.map(|r| r.total_ms).or(exchange.entry.total_ms),
|
||||
"error": redact_transport_error(exchange.entry.error.clone(), &prepared.url),
|
||||
"error": redact_transport_error(exchange.entry.error.clone(), &redact_url),
|
||||
"body": body,
|
||||
"bodyTruncated": body_truncated,
|
||||
}))
|
||||
|
||||
@@ -10,6 +10,7 @@ mod files;
|
||||
mod http;
|
||||
mod page;
|
||||
mod reports;
|
||||
mod scope;
|
||||
mod search;
|
||||
mod symbols;
|
||||
mod tool;
|
||||
@@ -54,14 +55,17 @@ impl Registry {
|
||||
if self.0.mcp_reports.remote_roots().iter().any(|p| p == root) {
|
||||
return Err("not supported for remote projects yet".into());
|
||||
}
|
||||
let mut windows: Vec<_> = self
|
||||
.0
|
||||
.projects
|
||||
.read()
|
||||
.iter()
|
||||
.filter(|(_, p)| p.root == root && !p.light)
|
||||
.map(|(w, p)| (w.clone(), p.clone()))
|
||||
.collect();
|
||||
let projects = self.0.projects.read();
|
||||
let open = || projects.iter().filter(|(_, p)| !p.light);
|
||||
let mut windows: Vec<_> = open().filter(|(_, p)| p.root == root).map(|(w, p)| (w.clone(), p.clone())).collect();
|
||||
if windows.is_empty() {
|
||||
// A project attached to an open one: the window it is attached in.
|
||||
windows = open()
|
||||
.filter(|(_, p)| tool::attached_projects(&p.root).iter().any(|a| a == root))
|
||||
.map(|(w, p)| (w.clone(), p.clone()))
|
||||
.collect();
|
||||
}
|
||||
drop(projects);
|
||||
let focused = self.0.mcp_reports.focused_window();
|
||||
windows.sort_by(|a, b| {
|
||||
(Some(&b.0) == focused.as_ref()).cmp(&(Some(&a.0) == focused.as_ref())).then(a.0.cmp(&b.0))
|
||||
@@ -71,13 +75,10 @@ impl Registry {
|
||||
}
|
||||
impl ToolRegistry for Registry {
|
||||
fn projects(&self) -> Vec<PathBuf> {
|
||||
self.0
|
||||
.projects()
|
||||
.into_iter()
|
||||
.filter(|p| !p.light)
|
||||
.map(|p| p.root.clone())
|
||||
.chain(self.0.mcp_reports.remote_roots())
|
||||
.collect()
|
||||
let open: Vec<_> = self.0.projects().into_iter().filter(|p| !p.light).collect();
|
||||
// Attached projects are listed too, so a `projectPath` inside one names it.
|
||||
let attached: Vec<_> = open.iter().flat_map(|p| tool::attached_projects(&p.root)).collect();
|
||||
open.into_iter().map(|p| p.root.clone()).chain(attached).chain(self.0.mcp_reports.remote_roots()).collect()
|
||||
}
|
||||
fn tools(&self, root: &Path) -> Result<Vec<ide_mcp::Tool>, String> {
|
||||
let (_, project) = self.target(root)?;
|
||||
|
||||
@@ -305,6 +305,7 @@ pub fn list_runs() -> Tool {
|
||||
start of the command, exit code and times. `get_run_status` gives a tab's whole status.",
|
||||
|call| async move {
|
||||
let page = Page::of(&call, LIST_LIMIT)?;
|
||||
let dir = crate::mcp::scope::Scope::of(&call)?;
|
||||
let wanted = call.opt_str("state")?.filter(|s| s != "all");
|
||||
let states = match wanted.as_deref() {
|
||||
None => None,
|
||||
@@ -325,6 +326,8 @@ start of the command, exit code and times. `get_run_status` gives a tab's whole
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|r| r.status())
|
||||
// A tab belongs where its command runs.
|
||||
.filter(|s| dir.contains_shown(call.root(), s["workingDirectory"].as_str().unwrap_or_default()))
|
||||
.filter(|s| {
|
||||
states.as_ref().is_none_or(|states| s["state"].as_str().is_some_and(|v| states.contains(&v)))
|
||||
})
|
||||
@@ -341,6 +344,7 @@ start of the command, exit code and times. `get_run_status` gives a tab's whole
|
||||
ParamType::String,
|
||||
"all (default), running, idle (not running), error (failed, crashed, startFailed), or one state",
|
||||
))
|
||||
.param(crate::mcp::scope::param())
|
||||
.param(Param::optional("limit", ParamType::Integer, "Tabs to return at most (default 10)"))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET))
|
||||
}
|
||||
|
||||
@@ -139,8 +139,13 @@ the whole command. Run points are found in Rust, JavaScript/TypeScript, Python a
|
||||
}
|
||||
let page = Page::of(&call, CONFIGURATIONS_LIMIT)?;
|
||||
let query = call.opt_str("query")?.map(|q| q.to_lowercase());
|
||||
let dir = crate::mcp::scope::Scope::of(&call)?;
|
||||
let list: Vec<Value> = configs
|
||||
.iter()
|
||||
// A configuration belongs where it runs.
|
||||
.filter(|c| {
|
||||
dir.contains(&c.cwd.as_deref().map_or_else(|| call.root().to_path_buf(), |d| call.root().join(d)))
|
||||
})
|
||||
.filter(|c| {
|
||||
query.as_ref().is_none_or(|q| {
|
||||
[c.name.as_str(), c.kind.as_str(), command_line(c).as_str()]
|
||||
@@ -164,6 +169,7 @@ the whole command. Run points are found in Rust, JavaScript/TypeScript, Python a
|
||||
in the file instead of project-wide run configurations.",
|
||||
))
|
||||
.param(Param::optional("query", ParamType::String, "Only configurations whose name, type or command contains it"))
|
||||
.param(crate::mcp::scope::param())
|
||||
.param(Param::optional("limit", ParamType::Integer, "Configurations to return at most (default 100)"))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET))
|
||||
}
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
//! The `scope` argument of the query tools: the directory their results are limited to, a
|
||||
//! folder of the project or a project attached to it.
|
||||
|
||||
use crate::mcp::tool::{Call, Param, ParamType};
|
||||
use ide_core::{IdeError, IdeResult};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
pub fn param() -> Param {
|
||||
Param::optional(
|
||||
"scope",
|
||||
ParamType::String,
|
||||
"Directory to limit results to: relative to the project root, or absolute",
|
||||
)
|
||||
}
|
||||
|
||||
/// No `scope`: everything.
|
||||
pub struct Scope(Option<PathBuf>);
|
||||
|
||||
impl Scope {
|
||||
pub fn of(call: &Call) -> IdeResult<Self> {
|
||||
let Some(raw) = call.opt_str("scope")?.filter(|s| !s.trim().is_empty()) else { return Ok(Self(None)) };
|
||||
let given = Path::new(raw.trim());
|
||||
let path = crate::mcp::tool::normalize(&if given.is_absolute() {
|
||||
given.to_path_buf()
|
||||
} else {
|
||||
call.root().join(given)
|
||||
});
|
||||
let path = dunce::canonicalize(&path).unwrap_or(path);
|
||||
if !path.is_dir() {
|
||||
return Err(IdeError::not_found(format!("scope {raw} is not a directory")));
|
||||
}
|
||||
let roots = std::iter::once(call.root().to_path_buf()).chain(call.project().content_roots());
|
||||
if !roots.into_iter().any(|root| path.starts_with(root)) {
|
||||
return Err(IdeError::invalid(format!("scope {raw} is outside the project")));
|
||||
}
|
||||
Ok(Self(Some(path)))
|
||||
}
|
||||
|
||||
pub fn dir(&self) -> Option<&Path> {
|
||||
self.0.as_deref()
|
||||
}
|
||||
|
||||
pub fn contains(&self, path: &Path) -> bool {
|
||||
self.0.as_ref().is_none_or(|dir| path.starts_with(dir))
|
||||
}
|
||||
|
||||
/// For a path the tools return: project-relative with `/`, or absolute.
|
||||
pub fn contains_shown(&self, root: &Path, path: &str) -> bool {
|
||||
self.0.is_none() || self.contains(&root.join(path))
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@
|
||||
//! the editor (one per character except emoji and other astral characters).
|
||||
|
||||
use crate::mcp::page::{OFFSET, Page};
|
||||
use crate::mcp::scope::{self, Scope};
|
||||
use crate::mcp::tool::{Call, Output, Param, ParamType, Tool};
|
||||
use crate::mcp::util::{INDEXING_PARTIAL_RESULT_REASON, MEDIUM_TIMEOUT};
|
||||
use crate::ops::search::SearchEvent;
|
||||
@@ -67,6 +68,7 @@ Examples: [\"src/**\", \"!**/test/**\"], [\"**/*.kt\"], [\"foo/\"].",
|
||||
|call| async move { text_search(call, false).await },
|
||||
)
|
||||
.param(Param::required("q", ParamType::String, "Text to search for"))
|
||||
.param(scope::param())
|
||||
.param(Param::optional("paths", ParamType::StringList, PATHS_DESCRIPTION))
|
||||
.param(Param::optional("limit", ParamType::Integer, LIMIT_DESCRIPTION))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET))
|
||||
@@ -89,6 +91,7 @@ Examples: [\"src/**\", \"!**/test/**\"], [\"**/*.kt\"], [\"foo/\"].",
|
||||
|call| async move { text_search(call, true).await },
|
||||
)
|
||||
.param(Param::required("q", ParamType::String, "Regex pattern to search for"))
|
||||
.param(scope::param())
|
||||
.param(Param::optional("paths", ParamType::StringList, PATHS_DESCRIPTION))
|
||||
.param(Param::optional("limit", ParamType::Integer, LIMIT_DESCRIPTION))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET))
|
||||
@@ -110,6 +113,7 @@ If you don't find a suitable result, try again with include_external=true to sea
|
||||
|call| async move { symbol_search(call).await },
|
||||
)
|
||||
.param(Param::required("q", ParamType::String, "Symbol query text"))
|
||||
.param(scope::param())
|
||||
.param(Param::optional("paths", ParamType::StringList, PATHS_DESCRIPTION))
|
||||
.param(Param::optional(
|
||||
"include_external",
|
||||
@@ -136,6 +140,7 @@ Paths are optional additional glob filters relative to the project root.",
|
||||
|call| async move { file_search(call).await },
|
||||
)
|
||||
.param(Param::required("q", ParamType::String, "Glob pattern to search for"))
|
||||
.param(scope::param())
|
||||
.param(Param::optional("paths", ParamType::StringList, PATHS_DESCRIPTION))
|
||||
.param(Param::optional(
|
||||
"includeExcluded",
|
||||
@@ -539,6 +544,7 @@ async fn text_search(call: Call, is_regex: bool) -> IdeResult<Output> {
|
||||
let pattern = query(&call, if is_regex { "Regex pattern is empty" } else { "Search text is empty" })?;
|
||||
let (page, limit) = page(&call, DEFAULT_LIMIT)?;
|
||||
let around = context(&call)?;
|
||||
let dir = Scope::of(&call)?;
|
||||
let scope = PathScope::new(call.root(), &call.str_list("paths")?)?;
|
||||
// Globs Find in Files cannot take are applied afterwards, so the engine must not
|
||||
// stop at `limit` matches the filter may drop.
|
||||
@@ -559,7 +565,8 @@ async fn text_search(call: Call, is_regex: bool) -> IdeResult<Output> {
|
||||
whole_word: false,
|
||||
include,
|
||||
exclude,
|
||||
scope: SearchScope::Project,
|
||||
// Only `scope` is walked.
|
||||
scope: dir.dir().map_or(SearchScope::Project, |d| SearchScope::Directory { path: d.to_path_buf().into() }),
|
||||
max_matches,
|
||||
context: Default::default(),
|
||||
};
|
||||
@@ -568,8 +575,12 @@ async fn text_search(call: Call, is_regex: bool) -> IdeResult<Output> {
|
||||
}
|
||||
let (files, summary, timed_out) = run_search(&call, query.clone()).await?;
|
||||
// Content roots outside the project are reported by absolute path.
|
||||
let mut files: Vec<(String, FileMatches)> =
|
||||
files.into_iter().map(|f| (call.display(&f.path.0), f)).filter(|(path, _)| scope.matches(path)).collect();
|
||||
let mut files: Vec<(String, FileMatches)> = files
|
||||
.into_iter()
|
||||
.filter(|f| dir.contains(&f.path.0))
|
||||
.map(|f| (call.display(&f.path.0), f))
|
||||
.filter(|(path, _)| scope.matches(path))
|
||||
.collect();
|
||||
files.sort_by(|a, b| a.0.cmp(&b.0));
|
||||
// Only these can match a line break.
|
||||
let may_span = is_regex || pattern.contains('\n');
|
||||
@@ -739,6 +750,7 @@ async fn run_search(call: &Call, query: SearchQuery) -> IdeResult<(Vec<FileMatch
|
||||
async fn file_search(call: Call) -> IdeResult<Output> {
|
||||
let q = query(&call, "Glob pattern is empty")?;
|
||||
let (page, limit) = page(&call, DEFAULT_LIMIT)?;
|
||||
let dir = Scope::of(&call)?;
|
||||
let scope = PathScope::new(call.root(), &call.str_list("paths")?)?;
|
||||
let include_excluded = call.flag("includeExcluded", false)?;
|
||||
let glob = GlobSetBuilder::new()
|
||||
@@ -748,16 +760,19 @@ async fn file_search(call: Call) -> IdeResult<Output> {
|
||||
// Ignored names and "Exclude files" patterns, which `read_dir` does not flag.
|
||||
let excludes = if include_excluded { None } else { Some(FileMask::new(&[], &call.project().search_excludes())?) };
|
||||
let root = call.root().to_path_buf();
|
||||
// The project folder and the content roots its walk does not cover: those outside it and
|
||||
// those inside it that it skips as ignored.
|
||||
let roots: Vec<PathBuf> = std::iter::once(root.clone())
|
||||
.chain(
|
||||
call.project()
|
||||
.content_roots()
|
||||
.into_iter()
|
||||
.filter(|r| relative_to_root(&root, r).is_none() || ide_index::walk_skips(&root, r)),
|
||||
)
|
||||
.collect();
|
||||
// `scope`, or the project folder and the content roots its walk does not cover: those
|
||||
// outside it and those inside it that it skips as ignored.
|
||||
let roots: Vec<PathBuf> = match dir.dir() {
|
||||
Some(dir) => vec![dir.to_path_buf()],
|
||||
None => std::iter::once(root.clone())
|
||||
.chain(
|
||||
call.project()
|
||||
.content_roots()
|
||||
.into_iter()
|
||||
.filter(|r| relative_to_root(&root, r).is_none() || ide_index::walk_skips(&root, r)),
|
||||
)
|
||||
.collect(),
|
||||
};
|
||||
let host = call.host();
|
||||
let walk = Walk {
|
||||
host: host.clone(),
|
||||
@@ -838,9 +853,9 @@ impl Walk {
|
||||
}
|
||||
}
|
||||
EntryKind::File => {
|
||||
// Files of content roots outside the project go by absolute path.
|
||||
// Files of content roots outside the project go by absolute path, with `/` as elsewhere.
|
||||
let path = relative_to_root(&self.root, &entry.path)
|
||||
.unwrap_or_else(|| entry.path.to_string_lossy().into_owned());
|
||||
.unwrap_or_else(|| entry.path.to_string_lossy().replace('\\', "/"));
|
||||
if self.glob.is_match(&path) && self.scope.matches(&path) {
|
||||
if found.len() == self.limit {
|
||||
return true;
|
||||
@@ -862,23 +877,32 @@ async fn symbol_search(call: Call) -> IdeResult<Output> {
|
||||
let q = query(&call, "Search query is empty")?;
|
||||
let (page, limit) = page(&call, SYMBOL_SEARCH_DEFAULT_LIMIT)?;
|
||||
let around = context(&call)?;
|
||||
let dir = Scope::of(&call)?;
|
||||
let scope = PathScope::new(call.root(), &call.str_list("paths")?)?;
|
||||
let external = call.flag("include_external", false)?;
|
||||
let host = call.host();
|
||||
let project = call.project().clone();
|
||||
let indexing_before = project.index.status().indexing;
|
||||
let pool = if scope.is_all() { limit + 1 } else { ((limit + 1) * SYMBOL_POOL_FACTOR).min(MAX_SYMBOL_POOL) };
|
||||
let pool = if scope.is_all() && dir.dir().is_none() {
|
||||
limit + 1
|
||||
} else {
|
||||
((limit + 1) * SYMBOL_POOL_FACTOR).min(MAX_SYMBOL_POOL)
|
||||
};
|
||||
let found = {
|
||||
let (project, q) = (project.clone(), q.clone());
|
||||
host.blocking(move || Ok(project.index.find_symbols(&q, ide_index::SymbolFilter::All, pool))).await?
|
||||
};
|
||||
let mut items: Vec<SearchItem> = found
|
||||
.into_iter()
|
||||
.filter(|s| scope.matches(&s.rel_path))
|
||||
.map(|s| SearchItem {
|
||||
// By the path the other tools give: the index shows a root outside the project by its
|
||||
// folder name, which is no path to read.
|
||||
.filter(|s| dir.contains(&s.path.0))
|
||||
.map(|s| (call.display(&s.path.0), s))
|
||||
.filter(|(path, _)| scope.matches(path))
|
||||
.map(|(path, s)| SearchItem {
|
||||
name: Some(s.name),
|
||||
container: s.container.filter(|c| !c.is_empty()),
|
||||
..SearchItem::at(s.rel_path, s.range)
|
||||
..SearchItem::at(path, s.range)
|
||||
})
|
||||
.collect();
|
||||
let mut timed_out = false;
|
||||
@@ -888,9 +912,9 @@ async fn symbol_search(call: Call) -> IdeResult<Output> {
|
||||
timed_out = out_of_time;
|
||||
for (name, container, location) in symbols {
|
||||
let path = location.uri.clone().unwrap_or_else(|| call.display(&location.path));
|
||||
// Project files obey `paths`; library symbols are what was asked for.
|
||||
// Project files obey `scope` and `paths`; library symbols are what was asked for.
|
||||
let inside = location.uri.is_none() && !Path::new(&path).is_absolute();
|
||||
if inside && !scope.matches(&path) {
|
||||
if inside && !(dir.contains_shown(call.root(), &path) && scope.matches(&path)) {
|
||||
continue;
|
||||
}
|
||||
let item = SearchItem {
|
||||
|
||||
@@ -211,6 +211,7 @@ pub fn find_references() -> Tool {
|
||||
Tool::new("find_references", "Find references using the language service and the IDE's project index. Positions are 1-based UTF-16. Reports incomplete results when analysis is still running.", |call| async move {
|
||||
let path = call.resolve_readable(&call.str("filePath")?).await?;
|
||||
let page = super::page::Page::of(&call, REFERENCES_LIMIT)?;
|
||||
let dir = super::scope::Scope::of(&call)?;
|
||||
let line = call.opt_i64("line")?.ok_or_else(|| IdeError::invalid("missing line"))?;
|
||||
let column = call.opt_i64("column")?.ok_or_else(|| IdeError::invalid("missing column"))?;
|
||||
let project = call.project.clone();
|
||||
@@ -248,7 +249,12 @@ pub fn find_references() -> Tool {
|
||||
// `classified`, when there, goes with `locations` one to one.
|
||||
if let serde_json::Value::Object(map) = &mut value {
|
||||
let mut list = |key: &str| match map.remove(key) { Some(serde_json::Value::Array(items)) => items, _ => Vec::new() };
|
||||
let (locations, classified) = (list("locations"), list("classified"));
|
||||
let (mut locations, mut classified) = (list("locations"), list("classified"));
|
||||
if dir.dir().is_some() {
|
||||
let inside = |l: &serde_json::Value| l["path"].as_str().is_some_and(|p| dir.contains(std::path::Path::new(p)));
|
||||
locations.retain(inside);
|
||||
classified.retain(|c| inside(&c["location"]));
|
||||
}
|
||||
let classified = page.take(classified, &mut serde_json::Map::new());
|
||||
let locations = page.take(locations, map);
|
||||
map.insert("locations".into(), locations.into());
|
||||
@@ -260,6 +266,7 @@ pub fn find_references() -> Tool {
|
||||
.param(Param::required("line", ParamType::Integer, "1-based line"))
|
||||
.param(Param::required("column", ParamType::Integer, "1-based UTF-16 column"))
|
||||
.param(Param::optional("includeDeclaration", ParamType::Boolean, "Include declarations (default true)"))
|
||||
.param(super::scope::param())
|
||||
.param(Param::optional("limit", ParamType::Integer, "References to return at most (default 100)"))
|
||||
.param(Param::optional("offset", ParamType::Integer, super::page::OFFSET))
|
||||
}
|
||||
|
||||
@@ -37,7 +37,12 @@ impl Call {
|
||||
.collect()
|
||||
}
|
||||
pub fn resolve_inside(&self, path: &str) -> IdeResult<PathBuf> {
|
||||
resolve_inside(self.root(), path)
|
||||
resolve_inside(self.root(), path).or_else(|e| {
|
||||
// An absolute path may name a trusted attached project, wherever it is.
|
||||
let absolute = path.starts_with("file://") || Path::new(path).is_absolute();
|
||||
let attached = if absolute { self.trusted_attachments() } else { Vec::new() };
|
||||
attached.iter().find_map(|root| resolve_inside(root, path).ok()).ok_or(e)
|
||||
})
|
||||
}
|
||||
pub async fn resolve_writable(&self, path: &str) -> IdeResult<PathBuf> {
|
||||
let path = self.resolve_inside(path)?;
|
||||
@@ -46,7 +51,24 @@ impl Call {
|
||||
}
|
||||
pub async fn check_writable(&self, path: &Path) -> IdeResult<()> {
|
||||
self.project.require_trust()?;
|
||||
ensure_inside(self.root(), path)
|
||||
self.ensure_writable_place(path)
|
||||
}
|
||||
/// `path` is inside the project or a trusted project attached to it.
|
||||
pub fn ensure_writable_place(&self, path: &Path) -> IdeResult<()> {
|
||||
ensure_inside(self.root(), path).or_else(|e| {
|
||||
if self.trusted_attachments().iter().any(|root| ensure_inside(root, path).is_ok()) {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(e)
|
||||
}
|
||||
})
|
||||
}
|
||||
/// The projects attached to this one that the user trusts (each is trusted on its own).
|
||||
fn trusted_attachments(&self) -> Vec<PathBuf> {
|
||||
attached_projects(self.root())
|
||||
.into_iter()
|
||||
.filter(|root| self.host.trust.trusted(root).unwrap_or(false))
|
||||
.collect()
|
||||
}
|
||||
pub async fn ask(&self, request: ide_core::event::McpUiRequest) -> IdeResult<()> {
|
||||
self.host.mcp_requests.ask(self, request).await
|
||||
@@ -300,3 +322,12 @@ pub fn resolve_inside(root: &Path, raw: &str) -> IdeResult<PathBuf> {
|
||||
pub fn ensure_inside(root: &Path, path: &Path) -> IdeResult<()> {
|
||||
resolve_inside(root, &path.to_string_lossy()).map(|_| ())
|
||||
}
|
||||
|
||||
/// The projects attached to the one at `root` (its workspace members), `root` itself left out.
|
||||
pub(crate) fn attached_projects(root: &Path) -> Vec<PathBuf> {
|
||||
ide_workspace::workspace::Workspace::load(root)
|
||||
.ok()
|
||||
.flatten()
|
||||
.map(|w| w.projects.into_iter().filter(|p| p != root).collect())
|
||||
.unwrap_or_default()
|
||||
}
|
||||
@@ -29,7 +29,7 @@ fn relative_to(root: &Path, path: &Path) -> String {
|
||||
};
|
||||
match rel {
|
||||
Some(rel) => rel.to_string_lossy().replace('\\', "/"),
|
||||
None => path.to_string_lossy().into_owned(),
|
||||
None => path.to_string_lossy().replace('\\', "/"),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -266,11 +266,16 @@ By default all Git repositories are returned.",
|
||||
.map(|r| (r.root.into_path_buf(), r.head))
|
||||
.collect();
|
||||
let wanted = call.opt_str("repositoryPathRelativeToProject")?;
|
||||
let scope = super::scope::Scope::of(&call)?;
|
||||
let git = git_executable(&call);
|
||||
let mut roots: Vec<(PathBuf, Option<String>)> = match &wanted {
|
||||
// A repository asked for, or the one holding `scope`.
|
||||
let target = match &wanted {
|
||||
Some(wanted) => Some(call.resolve_inside(wanted)?),
|
||||
None => scope.dir().map(Path::to_path_buf),
|
||||
};
|
||||
let mut roots: Vec<(PathBuf, Option<String>)> = match target {
|
||||
None => repos,
|
||||
Some(wanted) => {
|
||||
let path = call.resolve_inside(wanted)?;
|
||||
Some(path) => {
|
||||
// The innermost repository containing the path.
|
||||
match innermost_repo(repos, &path) {
|
||||
Some(repo) => vec![repo],
|
||||
@@ -282,7 +287,8 @@ By default all Git repositories are returned.",
|
||||
vec![(root, branch)]
|
||||
}
|
||||
None => {
|
||||
return Err(IdeError::not_found(format!("No git repository found for path: {wanted}")));
|
||||
let shown = wanted.unwrap_or_else(|| call.display(&path));
|
||||
return Err(IdeError::not_found(format!("No git repository found for path: {shown}")));
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -293,12 +299,13 @@ By default all Git repositories are returned.",
|
||||
for (root, branch) in roots {
|
||||
let rel = relative_to_project(&call, &root);
|
||||
let (git, dir) = (git.clone(), root.clone());
|
||||
let entries = host
|
||||
let mut entries = host
|
||||
.blocking(move || read_status(&git, &dir, include_untracked, include_ignored))
|
||||
.await
|
||||
.map_err(|e| {
|
||||
IdeError::internal(format!("Failed to get git status for repository '{rel}': {}", e.message))
|
||||
})?;
|
||||
entries.retain(|e| scope.contains(&root.join(e.path.trim_end_matches('/'))));
|
||||
let count = |f: fn(&StatusEntry) -> bool| entries.iter().filter(|e| f(e)).count();
|
||||
let listed: Vec<Value> = entries
|
||||
.iter()
|
||||
@@ -345,6 +352,7 @@ By default all Git repositories are returned.",
|
||||
))
|
||||
.param(Param::optional("includeUntracked", ParamType::Boolean, "Whether to include untracked files"))
|
||||
.param(Param::optional("includeIgnored", ParamType::Boolean, "Whether to include ignored files"))
|
||||
.param(super::scope::param())
|
||||
.param(Param::optional("limit", ParamType::Integer, "Entries to return per repository at most (default 100)"))
|
||||
.param(Param::optional("offset", ParamType::Integer, OFFSET))
|
||||
}
|
||||
|
||||
@@ -30,9 +30,15 @@ pub fn providers(host: &Host, window: &str) -> IdeResult<Vec<AgentProvider>> {
|
||||
}
|
||||
|
||||
/// Refreshes the selected agent's model catalog without sending a prompt.
|
||||
pub fn refresh_models(host: &Host, window: &str, provider: String, force: bool) -> IdeResult<AgentModelCatalog> {
|
||||
pub fn refresh_models(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
provider: String,
|
||||
force: bool,
|
||||
model: Option<String>,
|
||||
) -> IdeResult<AgentModelCatalog> {
|
||||
host.require_trust(window)?;
|
||||
host.project(window)?.agents.refresh_models(&provider, force)
|
||||
host.project(window)?.agents.refresh_models(&provider, force, model.as_deref())
|
||||
}
|
||||
|
||||
/// Overrides built-in agent `id`'s command with `command` (its agent file keeps the
|
||||
@@ -262,18 +268,6 @@ pub async fn fork(host: &Host, window: &str, task: String, turns: Option<u32>) -
|
||||
host.project(window)?.agents.fork(&task, turns).await
|
||||
}
|
||||
|
||||
/// Creates a temporary side conversation of `source`: lives in memory only, never
|
||||
/// persisted, not listed.
|
||||
pub async fn create_ephemeral(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
request: NewAgentTask,
|
||||
source: String,
|
||||
) -> IdeResult<AgentTask> {
|
||||
host.require_trust(window)?;
|
||||
host.project(window)?.agents.create_ephemeral(request, &source).await
|
||||
}
|
||||
|
||||
/// Drops the task's turns after its first `turns`; returns the message of the first dropped one.
|
||||
pub async fn rollback(host: &Host, window: &str, task: String, turns: u32) -> IdeResult<Option<AgentPrompt>> {
|
||||
host.require_trust(window)?;
|
||||
@@ -724,7 +718,10 @@ async fn probe_http_mcp_server(server: &ide_core::settings::AgentMcpServer) -> M
|
||||
if let Some(sid) = session_id.as_deref() {
|
||||
req = req.header("Mcp-Session-Id", sid);
|
||||
}
|
||||
let resp = req.send().await.map_err(|e| format!("Request to `{url}` failed: {e}"))?;
|
||||
let resp = req
|
||||
.send()
|
||||
.await
|
||||
.map_err(|e| format!("Request to `{url}` failed: {}", ide_http::client::describe(&e.without_url())))?;
|
||||
let status = resp.status();
|
||||
let next_session =
|
||||
resp.headers().get("mcp-session-id").and_then(|v| v.to_str().ok()).map(str::to_owned).or(session_id);
|
||||
@@ -841,7 +838,7 @@ pub(crate) fn register(d: &mut Dispatcher) {
|
||||
d.add("agent_subscribe", |c| async move { subscribe(&c.host, &c.window, c.channel("onEvent")?) });
|
||||
d.add("agent_providers", |c| async move { providers(&c.host, &c.window) });
|
||||
d.add("agent_refresh_models", |c| async move {
|
||||
refresh_models(&c.host, &c.window, c.arg("provider")?, c.arg("force")?)
|
||||
refresh_models(&c.host, &c.window, c.arg("provider")?, c.arg("force")?, c.arg("model")?)
|
||||
});
|
||||
d.add("agent_set_command", |c| async move { set_command(&c.host, &c.window, c.arg("id")?, c.arg("command")?) });
|
||||
d.add("agent_set_env", |c| async move { set_env(&c.host, &c.window, c.arg("id")?, c.arg("env")?) });
|
||||
|
||||
@@ -311,12 +311,11 @@ pub async fn build_sync(
|
||||
if completion_token.is_cancelled() {
|
||||
return Err(IdeError::cancelled());
|
||||
}
|
||||
if tool == BuildTool::Gradle {
|
||||
// The sync may report project folders outside the project (`includeFlat`): index and list them.
|
||||
project.refresh_index_scope();
|
||||
let p = project.clone();
|
||||
tokio::task::spawn_blocking(move || p.refresh_repositories());
|
||||
}
|
||||
// Gradle may report project folders outside the project (`includeFlat`), and a Maven
|
||||
// reactor may have gained or dropped modules beside it: index and list them.
|
||||
project.refresh_index_scope();
|
||||
let p = project.clone();
|
||||
tokio::task::spawn_blocking(move || p.refresh_repositories());
|
||||
// New source folders and dependency versions: the Project view and External Libraries reload.
|
||||
project.sink.emit(ide_core::IdeEvent::ProjectRootsChanged { root: project.root.clone().into() });
|
||||
if tool == BuildTool::Maven
|
||||
@@ -468,7 +467,15 @@ pub async fn gradle_dependencies(
|
||||
gradle_command: Some(gradle.command.clone()),
|
||||
..Default::default()
|
||||
};
|
||||
ide_build::gradle_dependencies(&scope.root, gradle, &options, &gradle_path, &configuration, &token)
|
||||
let dependencies =
|
||||
ide_build::gradle_dependencies(&scope.root, gradle, &options, &gradle_path, &configuration, &token)?;
|
||||
// What plugins read of the build (`build.dependencies`) instead of running Gradle.
|
||||
let report = ide_build::GradleReport { project: gradle_path, configuration, dependencies };
|
||||
let cache = ide_build::gradle::cache_dir(&scope.cache, &gradle.dir);
|
||||
if let Err(e) = ide_build::save_gradle_report(&scope.root, &cache, gradle, &report) {
|
||||
tracing::debug!("keeping the dependencies report of {}: {e}", report.project);
|
||||
}
|
||||
Ok(report.dependencies)
|
||||
})
|
||||
.await
|
||||
.map_err(join_err);
|
||||
@@ -476,6 +483,40 @@ pub async fn gradle_dependencies(
|
||||
result?
|
||||
}
|
||||
|
||||
/// What the Dependency Analyzer has of the builds of `project` at `root` (the project, or one
|
||||
/// of its workspace members), without running a build tool: the Maven modules as last synced
|
||||
/// and the Gradle reports read since the build files last changed.
|
||||
pub(crate) fn analyzed_dependencies(
|
||||
project: &Project,
|
||||
config: &Path,
|
||||
root: &Path,
|
||||
) -> IdeResult<crate::plugins::BuildGraph> {
|
||||
let mut graph = crate::plugins::BuildGraph::default();
|
||||
for scope in workspace::scopes(project, config)?.iter().filter(|s| root == project.root || s.root == root) {
|
||||
let settings = &scope.settings;
|
||||
let model = ide_build::load_linked(
|
||||
&scope.root,
|
||||
&scope.cache,
|
||||
ide_sdk::apply::maven_local_repository(&scope.root, settings),
|
||||
&settings.languages.java.maven,
|
||||
&settings.languages.java.gradle,
|
||||
);
|
||||
graph.maven.extend(model.maven.into_iter().flat_map(|m| m.projects));
|
||||
for build in &model.gradle {
|
||||
let reports =
|
||||
ide_build::gradle_reports(&scope.root, &ide_build::gradle::cache_dir(&scope.cache, &build.dir), build);
|
||||
// buildSrc can't be analyzed from the build, as in the Dependency Analyzer.
|
||||
for p in build.projects.iter().filter(|p| !p.build.as_deref().is_some_and(|b| b.ends_with(":buildSrc"))) {
|
||||
graph.gradle.push(crate::plugins::GradleModule {
|
||||
path: p.path.clone(),
|
||||
reports: reports.iter().filter(|r| r.project == p.path).cloned().collect(),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(graph)
|
||||
}
|
||||
|
||||
/// Where the direct dependency `dependency` of the Maven module `pom` is declared.
|
||||
pub async fn maven_dependency_declaration(
|
||||
host: &Host,
|
||||
|
||||
@@ -532,3 +532,35 @@ fn console_dir(host: &Host, id: &str) -> IdeResult<PathBuf> {
|
||||
std::fs::create_dir_all(&dir)?;
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
/// Runs a client tool against target `id` until it exits or the request is cancelled.
|
||||
/// Desktop only: the file paths come from local dialogs.
|
||||
pub async fn run_tool(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
request: RequestId,
|
||||
id: &str,
|
||||
executable: &std::path::Path,
|
||||
job: &ide_db::tools::DbToolJob,
|
||||
on_output: impl FnMut(Vec<ide_db::tools::ToolLine>),
|
||||
) -> IdeResult<Option<i32>> {
|
||||
let db = host.project(window)?.db.clone();
|
||||
let cancel = host.begin_request(request);
|
||||
let result = db.run_tool(id, executable, job, &cancel, on_output).await;
|
||||
host.end_request(request);
|
||||
result
|
||||
}
|
||||
|
||||
pub fn tool_preview(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
id: &str,
|
||||
executable: &std::path::Path,
|
||||
job: &ide_db::tools::DbToolJob,
|
||||
) -> IdeResult<String> {
|
||||
host.project(window)?.db.tool_preview(id, executable, job)
|
||||
}
|
||||
|
||||
pub async fn server_version(host: &Host, window: &str, id: &str) -> IdeResult<u32> {
|
||||
host.project(window)?.db.server_version(id).await
|
||||
}
|
||||
@@ -31,6 +31,8 @@ pub async fn debug_start(host: &Host, window: &str, config: LaunchConfig) -> Ide
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let agents = if is_jvm_launch(&config) { ide_run::java_agent::current() } else { Default::default() };
|
||||
let config = add_java_agents(config, &agents.options);
|
||||
let mut config = match_java_debug_encoding(start_java_attach_listener(config, cfg!(windows)), cfg!(windows));
|
||||
if config.adapter == "debugpy"
|
||||
&& config.request == "launch"
|
||||
@@ -119,6 +121,15 @@ pub async fn debug_start(host: &Host, window: &str, config: LaunchConfig) -> Ide
|
||||
let server_port = debug_server_port(&config);
|
||||
let result = host.debugger.start_with(config, owner, custom).await;
|
||||
flush_output();
|
||||
if let Ok(id) = &result {
|
||||
let sink = host.window_sink(label);
|
||||
for note in &agents.notes {
|
||||
sink.emit(ide_core::IdeEvent::Debug {
|
||||
session: *id,
|
||||
event: ide_core::event::DebugEvent::Output { category: "console".into(), output: format!("{note}\n") },
|
||||
});
|
||||
}
|
||||
}
|
||||
if result.is_err()
|
||||
&& let Some(pid) = unity_pid
|
||||
{
|
||||
@@ -154,10 +165,54 @@ fn debug_server_port(config: &LaunchConfig) -> Option<u16> {
|
||||
fn attach_jvm_inspector(host: &Host, window: &str, session: DebugSessionId, port: u16) {
|
||||
let Ok(project) = host.project(window) else { return };
|
||||
let Some(module) = project.lsp.java_debug_server_module(port) else { return };
|
||||
let inspector = std::sync::Arc::new(ide_lsp::JdtJvmInspector::new(project.lsp.clone(), module));
|
||||
let inspector = std::sync::Arc::new(ide_lsp::JdtJvmInspector::new(project.lsp.clone(), module.clone()));
|
||||
if let Err(e) = host.debugger.set_jvm_inspector(session, inspector) {
|
||||
tracing::debug!("jvm inspector for session {session:?}: {e}");
|
||||
return;
|
||||
}
|
||||
let tracer = std::sync::Arc::new(ide_lsp::JdtStreamTracer::new(project.lsp.clone(), module));
|
||||
if let Err(e) = host.debugger.set_stream_tracer(session, tracer) {
|
||||
tracing::debug!("stream tracer for session {session:?}: {e}");
|
||||
}
|
||||
}
|
||||
|
||||
/// A JVM the debugger starts itself: an Application or Spring Boot configuration, launched by
|
||||
/// java-debug or the Kotlin debugger (JAR Application debugs through a run with a JDWP agent).
|
||||
fn is_jvm_launch(config: &LaunchConfig) -> bool {
|
||||
config.request == "launch" && matches!(config.adapter.as_str(), "java-debug" | ide_dap::kotlin::ADAPTER)
|
||||
}
|
||||
|
||||
/// Plugins' Java agents ([`ide_run::java_agent`]) after the configuration's VM options:
|
||||
/// java-debug's `vmArgs` (one line, or a list) or the Kotlin debugger's `vmArguments` (a list).
|
||||
fn add_java_agents(mut config: LaunchConfig, options: &[String]) -> LaunchConfig {
|
||||
if options.is_empty() || !is_jvm_launch(&config) {
|
||||
return config;
|
||||
}
|
||||
let Some(serde_json::Value::Object(mut extra)) =
|
||||
config.extra_json.as_deref().and_then(|e| serde_json::from_str(e).ok())
|
||||
else {
|
||||
return config;
|
||||
};
|
||||
let key = if config.adapter == "java-debug" { "vmArgs" } else { "vmArguments" };
|
||||
let value = match extra.get(key) {
|
||||
None | Some(serde_json::Value::Null) if key == "vmArgs" => {
|
||||
ide_run::java_agent::add_to_vm_args_text("", options).into()
|
||||
}
|
||||
Some(serde_json::Value::String(text)) => ide_run::java_agent::add_to_vm_args_text(text, options).into(),
|
||||
None | Some(serde_json::Value::Null) | Some(serde_json::Value::Array(_)) => {
|
||||
let mut list: Vec<String> = extra
|
||||
.get(key)
|
||||
.and_then(serde_json::Value::as_array)
|
||||
.map(|a| a.iter().filter_map(|v| v.as_str().map(str::to_owned)).collect())
|
||||
.unwrap_or_default();
|
||||
ide_run::java_agent::add_to_vm_args(&mut list, options);
|
||||
list.into()
|
||||
}
|
||||
Some(_) => return config,
|
||||
};
|
||||
extra.insert(key.into(), value);
|
||||
config.extra_json = Some(serde_json::Value::Object(extra).to_string());
|
||||
config
|
||||
}
|
||||
|
||||
/// The JVM memory tab reads the class table over the attach socket, which only exists once the
|
||||
@@ -813,6 +868,36 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn plugin_java_agents_join_the_vm_options_of_jvm_launches() {
|
||||
let agent = "-javaagent:/my plugins/agent.jar=port=0".to_owned();
|
||||
let options = std::slice::from_ref(&agent);
|
||||
let field = |config: &LaunchConfig, key: &str| {
|
||||
serde_json::from_str::<serde_json::Value>(config.extra_json.as_deref().unwrap()).unwrap()[key].clone()
|
||||
};
|
||||
let debugged =
|
||||
add_java_agents(launch("java-debug", "launch", serde_json::json!({"vmArgs": "-Xmx1g"})), options);
|
||||
assert_eq!(vm_args(&debugged), "-Xmx1g \"-javaagent:/my plugins/agent.jar=port=0\"");
|
||||
assert_eq!(add_java_agents(debugged.clone(), options).extra_json, debugged.extra_json, "not added twice");
|
||||
let none = add_java_agents(launch("java-debug", "launch", serde_json::json!({"vmArgs": null})), options);
|
||||
assert_eq!(vm_args(&none), "\"-javaagent:/my plugins/agent.jar=port=0\"");
|
||||
let list = add_java_agents(launch("java-debug", "launch", serde_json::json!({"vmArgs": ["-Xmx1g"]})), options);
|
||||
assert_eq!(vm_args(&list), serde_json::json!(["-Xmx1g", agent]));
|
||||
let kotlin = launch(ide_dap::kotlin::ADAPTER, "launch", serde_json::json!({"vmArguments": ["-Xmx1g"]}));
|
||||
assert_eq!(field(&add_java_agents(kotlin, options), "vmArguments"), serde_json::json!(["-Xmx1g", agent]));
|
||||
let kotlin = launch(ide_dap::kotlin::ADAPTER, "launch", serde_json::json!({}));
|
||||
assert_eq!(field(&add_java_agents(kotlin, options), "vmArguments"), serde_json::json!([agent]));
|
||||
// Attaching (remote debug included), other adapters, and no granted agent: unchanged.
|
||||
for config in [
|
||||
launch("java-debug", "attach", serde_json::json!({"vmArgs": "-Xmx1g"})),
|
||||
launch("debugpy", "launch", serde_json::json!({"vmArgs": "-Xmx1g"})),
|
||||
] {
|
||||
assert_eq!(add_java_agents(config.clone(), options).extra_json, config.extra_json);
|
||||
}
|
||||
let config = launch("java-debug", "launch", serde_json::json!({"vmArgs": "-Xmx1g"}));
|
||||
assert_eq!(add_java_agents(config.clone(), &[]).extra_json, config.extra_json);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn debug_server_port_only_for_local_java_debug() {
|
||||
let port = |adapter: &str, request: &str, extra| debug_server_port(&launch(adapter, request, extra));
|
||||
|
||||
@@ -5,7 +5,7 @@ use crate::rpc::Dispatcher;
|
||||
use ide_core::{DocId, IdeError, IdeResult, OutlineItem, Range};
|
||||
use ide_language::{FoldRange, SyntaxHighlights};
|
||||
use ide_text::LineEnding;
|
||||
use ide_workspace::{DocumentEncoding, DocumentInfo, HistoryEntry};
|
||||
use ide_workspace::{DocumentEncoding, DocumentInfo, DocumentLanguage, HistoryEntry};
|
||||
use std::path::PathBuf;
|
||||
|
||||
/// Runs blocking work (disk I/O, parsing, large copies) on the blocking pool,
|
||||
@@ -32,11 +32,17 @@ pub async fn doc_open_virtual(host: &Host, window: &str, uri: String) -> IdeResu
|
||||
.await
|
||||
}
|
||||
|
||||
/// The CodeMirror mode `path` gets when opened (`DocumentInfo::ui_mode`),
|
||||
/// without opening it: previews of closed files.
|
||||
pub async fn doc_ui_mode(host: &Host, window: &str, path: PathBuf) -> IdeResult<Option<String>> {
|
||||
/// The language and CodeMirror mode `path` is shown with in an editor, without opening
|
||||
/// it: previews of closed files and diffs. `first_line` is the shown text's (a revision's)
|
||||
/// for hashbang detection; without it the file's on disk counts.
|
||||
pub async fn doc_language(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
path: PathBuf,
|
||||
first_line: Option<String>,
|
||||
) -> IdeResult<DocumentLanguage> {
|
||||
let project = host.project(window)?;
|
||||
blocking(move || Ok(project.documents.ui_mode_of(&path))).await
|
||||
blocking(move || Ok(project.documents.language_of(&path, first_line.as_deref()))).await
|
||||
}
|
||||
|
||||
/// "Reload with Encoding" (`reload`) or "Convert to Encoding"; returns the new encoding and BOM state.
|
||||
@@ -209,7 +215,10 @@ pub fn history_content(host: &Host, window: &str, id: String) -> IdeResult<Strin
|
||||
/// Commands of this module the remote server answers.
|
||||
pub(crate) fn register(d: &mut Dispatcher) {
|
||||
d.add("doc_open_virtual", |c| async move { doc_open_virtual(&c.host, &c.window, c.arg("uri")?).await });
|
||||
d.add("doc_ui_mode", |c| async move { doc_ui_mode(&c.host, &c.window, c.arg("path")?).await });
|
||||
d.add(
|
||||
"doc_language",
|
||||
|c| async move { doc_language(&c.host, &c.window, c.arg("path")?, c.arg("firstLine")?).await },
|
||||
);
|
||||
d.add("doc_set_encoding", |c| async move {
|
||||
doc_set_encoding(&c.host, &c.window, c.arg("doc")?, c.arg("encoding")?, c.arg("reload")?).await
|
||||
});
|
||||
|
||||
@@ -97,6 +97,8 @@ async fn resolve_launch(
|
||||
tokio::task::spawn_blocking(move || {
|
||||
let _external_build = external_build;
|
||||
let local_repo = ide_sdk::apply::maven_local_repository(&project.root, &settings);
|
||||
// Module outputs the launch runs from a snapshot of: the originals must not come back.
|
||||
let mut snapshotted = Vec::new();
|
||||
let built = if delegated {
|
||||
let rebuild_on_jdt_errors = rebuild_on_jdt_errors(policy, prefer_maven, info.error_count);
|
||||
let outputs = project.java_launch_snapshots.lock().build(
|
||||
@@ -109,6 +111,7 @@ async fn resolve_launch(
|
||||
)?;
|
||||
let copies = use_snapshot(&mut info, &outputs.originals, &outputs.snapshot);
|
||||
apply_external_build_result(&mut info, outputs.failure, outputs.authoritative);
|
||||
snapshotted = outputs.originals;
|
||||
copies
|
||||
} else if external {
|
||||
let built = compile::build_for_launch(&project.root, &model, &module, test, build_kind, &cancel)?;
|
||||
@@ -137,7 +140,7 @@ async fn resolve_launch(
|
||||
&project.build_cache_dir(),
|
||||
&cancel,
|
||||
);
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, maven_cp)?;
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, maven_cp, &snapshotted)?;
|
||||
} else {
|
||||
append_unique_class_paths(&mut class_paths, std::mem::take(&mut info.class_paths));
|
||||
}
|
||||
@@ -298,17 +301,23 @@ fn same_entry(a: &str, b: &str, windows: bool) -> bool {
|
||||
|
||||
/// Merge the Maven launch classpath without turning a recoverable probe failure into a
|
||||
/// failed launch. Cancellation still propagates; ordinary failures keep jdtls' classpath
|
||||
/// and leave the reason in the run console.
|
||||
/// and leave the reason in the run console. Maven lists the module's and its reactor
|
||||
/// siblings' `target/classes`; those in `snapshotted` already run from their snapshot,
|
||||
/// and listing both would make every resource (MyBatis mapper XML) load twice.
|
||||
fn merge_maven_launch_classpath(
|
||||
class_paths: &mut Vec<String>,
|
||||
info: &mut JavaLaunchInfo,
|
||||
classpath: IdeResult<String>,
|
||||
snapshotted: &[PathBuf],
|
||||
) -> IdeResult<()> {
|
||||
match classpath {
|
||||
Ok(classpath) => {
|
||||
let snapshotted: Vec<_> = snapshotted.iter().map(|p| p.to_string_lossy()).collect();
|
||||
append_unique_class_paths(
|
||||
class_paths,
|
||||
std::env::split_paths(&classpath).map(|path| path.to_string_lossy().into_owned()),
|
||||
std::env::split_paths(&classpath)
|
||||
.map(|path| path.to_string_lossy().into_owned())
|
||||
.filter(|path| !snapshotted.iter().any(|original| same_entry(path, original, cfg!(windows)))),
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
@@ -471,20 +480,46 @@ mod tests {
|
||||
let mut class_paths = vec!["snapshot.jar".to_owned()];
|
||||
let mut info =
|
||||
JavaLaunchInfo { class_paths: vec!["snapshot.jar".into(), "jdtls.jar".into()], ..Default::default() };
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Ok(maven)).unwrap();
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Ok(maven), &[]).unwrap();
|
||||
assert_eq!(class_paths, ["snapshot.jar", "maven.jar"]);
|
||||
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Err(IdeError::internal("offline dependency")))
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Err(IdeError::internal("offline dependency")), &[])
|
||||
.unwrap();
|
||||
assert_eq!(class_paths, ["snapshot.jar", "maven.jar", "jdtls.jar"]);
|
||||
assert!(info.hints[0].contains("offline dependency"), "{:?}", info.hints);
|
||||
}
|
||||
|
||||
/// Maven's launch classpath lists the module's and its reactor siblings' outputs, which
|
||||
/// the launch already runs from a snapshot: listed twice, MyBatis loads each mapper XML
|
||||
/// twice and fails with "XML fragments parsed from previous mappers already contains value".
|
||||
#[test]
|
||||
fn maven_classpath_leaves_out_outputs_the_launch_runs_from_a_snapshot() {
|
||||
let web = PathBuf::from("/work/haoke/haoke-web/target/classes");
|
||||
let service = PathBuf::from("/work/haoke/haoke-service/target/classes");
|
||||
let maven = std::env::join_paths([
|
||||
"/work/haoke/haoke-web/target/classes/",
|
||||
"/work/haoke/haoke-service/target/classes",
|
||||
"/work/haoke/haoke-api/target/classes",
|
||||
"/m2/mybatis.jar",
|
||||
])
|
||||
.unwrap()
|
||||
.to_string_lossy()
|
||||
.into_owned();
|
||||
let mut class_paths = vec!["/cache/launch-x/0".to_owned(), "/cache/launch-x/1".to_owned()];
|
||||
let mut info = JavaLaunchInfo::default();
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Ok(maven), &[web, service]).unwrap();
|
||||
assert_eq!(
|
||||
class_paths,
|
||||
["/cache/launch-x/0", "/cache/launch-x/1", "/work/haoke/haoke-api/target/classes", "/m2/mybatis.jar"]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cancelled_maven_classpath_probe_propagates_without_fallback() {
|
||||
let mut class_paths = vec!["snapshot.jar".to_owned()];
|
||||
let mut info = JavaLaunchInfo { class_paths: vec!["jdtls.jar".into()], ..Default::default() };
|
||||
let error = merge_maven_launch_classpath(&mut class_paths, &mut info, Err(IdeError::cancelled())).unwrap_err();
|
||||
let error =
|
||||
merge_maven_launch_classpath(&mut class_paths, &mut info, Err(IdeError::cancelled()), &[]).unwrap_err();
|
||||
assert_eq!(error.kind, ErrorKind::Cancelled);
|
||||
assert_eq!(class_paths, ["snapshot.jar"]);
|
||||
assert!(info.hints.is_empty());
|
||||
|
||||
@@ -550,6 +550,24 @@ pub async fn lsp_implementations(
|
||||
result
|
||||
}
|
||||
|
||||
/// Refines the implementations `targets` of the method at `pos` to their declarations (Java
|
||||
/// dependencies' class files point at the start of the class). Cancel with
|
||||
/// `cancel_request(request)`.
|
||||
pub async fn lsp_implementation_locations(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
request: RequestId,
|
||||
doc: DocId,
|
||||
pos: Pos,
|
||||
targets: Vec<Location>,
|
||||
) -> IdeResult<Vec<Location>> {
|
||||
let lsp = host.project(window)?.lsp.clone();
|
||||
let (_, cancel) = begin_position_request(host, window, request, doc, pos).await?;
|
||||
let result = lsp.implementation_locations(doc, pos, targets, cancel).await;
|
||||
host.end_request(request);
|
||||
result
|
||||
}
|
||||
|
||||
/// Go to Implementation of the symbol at `pos`. Implementations found before a slower
|
||||
/// search for the rest (Java: the project's, before the dependencies') arrive on
|
||||
/// `on_partial`; the result has them all. Cancel with `cancel_request(request)`.
|
||||
@@ -1223,7 +1241,7 @@ pub async fn lsp_change_signature(
|
||||
}
|
||||
|
||||
fn json_argument(args: &str) -> IdeResult<serde_json::Value> {
|
||||
serde_json::from_str(args).map_err(|e| IdeError::invalid(format!("invalid move arguments: {e}")))
|
||||
serde_json::from_str(args).map_err(|e| IdeError::invalid(format!("invalid refactoring arguments: {e}")))
|
||||
}
|
||||
|
||||
fn json_strings(values: Vec<serde_json::Value>) -> Vec<String> {
|
||||
@@ -1289,6 +1307,50 @@ pub async fn lsp_java_move(
|
||||
.await
|
||||
}
|
||||
|
||||
/// The Java class to extract an interface from: its members and the packages for the interface.
|
||||
pub async fn lsp_extract_interface_info(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
request: RequestId,
|
||||
doc: DocId,
|
||||
pos: Pos,
|
||||
) -> IdeResult<ExtractInterfaceInfo> {
|
||||
let project = host.project(window)?;
|
||||
let cancel = host.begin_request(request);
|
||||
let result = project.lsp.extract_interface_info(doc, pos, cancel).await;
|
||||
host.end_request(request);
|
||||
result
|
||||
}
|
||||
|
||||
/// Checks extracting a Java interface and computes its edit without applying it; `destination`
|
||||
/// is one of the info's packages.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub async fn lsp_extract_interface(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
request: RequestId,
|
||||
doc: DocId,
|
||||
pos: Pos,
|
||||
members: Vec<String>,
|
||||
name: String,
|
||||
destination: String,
|
||||
confirmation: Option<String>,
|
||||
) -> IdeResult<ServerRefactored> {
|
||||
let destination = json_argument(&destination)?;
|
||||
let project = host.project(window)?;
|
||||
let cancel = host.begin_request(request);
|
||||
let result = project.lsp.extract_interface(doc, pos, members, name, destination, confirmation, cancel).await;
|
||||
host.end_request(request);
|
||||
let mut extracted = result?;
|
||||
blocking(move || {
|
||||
if let Some(edit) = &mut extracted.edit {
|
||||
project.documents.prepare_workspace_edit(edit)?;
|
||||
}
|
||||
Ok(extracted)
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn lsp_rename(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
@@ -1943,6 +2005,17 @@ pub(crate) fn register(d: &mut Dispatcher) {
|
||||
let on_partial = c.sender("onPartial")?;
|
||||
lsp_goto_implementation(&c.host, &c.window, c.arg("request")?, c.arg("doc")?, c.arg("pos")?, on_partial).await
|
||||
});
|
||||
d.add("lsp_implementation_locations", |c| async move {
|
||||
lsp_implementation_locations(
|
||||
&c.host,
|
||||
&c.window,
|
||||
c.arg("request")?,
|
||||
c.arg("doc")?,
|
||||
c.arg("pos")?,
|
||||
c.arg("targets")?,
|
||||
)
|
||||
.await
|
||||
});
|
||||
d.add(
|
||||
"lsp_resolve_class_file",
|
||||
|c| async move { lsp_resolve_class_file(&c.host, &c.window, c.arg("path")?).await },
|
||||
@@ -2028,6 +2101,23 @@ pub(crate) fn register(d: &mut Dispatcher) {
|
||||
)
|
||||
.await
|
||||
});
|
||||
d.add("lsp_extract_interface_info", |c| async move {
|
||||
lsp_extract_interface_info(&c.host, &c.window, c.arg("request")?, c.arg("doc")?, c.arg("pos")?).await
|
||||
});
|
||||
d.add("lsp_extract_interface", |c| async move {
|
||||
lsp_extract_interface(
|
||||
&c.host,
|
||||
&c.window,
|
||||
c.arg("request")?,
|
||||
c.arg("doc")?,
|
||||
c.arg("pos")?,
|
||||
c.arg("members")?,
|
||||
c.arg("name")?,
|
||||
c.arg("destination")?,
|
||||
c.arg("confirmation")?,
|
||||
)
|
||||
.await
|
||||
});
|
||||
d.add("lsp_java_move_destinations", |c| async move {
|
||||
lsp_java_move_destinations(&c.host, &c.window, c.arg("request")?, c.arg("doc")?, c.arg("kind")?, c.arg("args")?)
|
||||
.await
|
||||
|
||||
@@ -33,6 +33,7 @@ pub mod sdk;
|
||||
pub mod search;
|
||||
pub mod spell;
|
||||
mod ssh;
|
||||
pub mod stream_trace;
|
||||
pub mod syntax;
|
||||
pub mod term;
|
||||
pub mod tools;
|
||||
@@ -88,6 +89,7 @@ pub fn register_all(d: &mut crate::rpc::Dispatcher) {
|
||||
java::register(d);
|
||||
debug::register(d);
|
||||
heap::register(d);
|
||||
stream_trace::register(d);
|
||||
bytes::register(d);
|
||||
vcs::register(d);
|
||||
doc::register(d);
|
||||
|
||||
@@ -208,41 +208,52 @@ pub async fn nav_index_definitions(
|
||||
}
|
||||
|
||||
/// Every Python class in the project (attached dependency roots included) and its base
|
||||
/// names. The index covers content roots, so this is the whole-project answer the UI uses
|
||||
/// for inheritance gutter markers when no type-hierarchy provider exists.
|
||||
/// names, answered from the project index: its symbols already carry the bases, and it
|
||||
/// covers content roots, so this is the whole-project answer the UI uses for inheritance
|
||||
/// gutter markers when no type-hierarchy provider exists. No file is parsed here.
|
||||
pub async fn nav_inheritance(host: &Host, window: &str) -> IdeResult<Vec<ClassInheritance>> {
|
||||
let project = host.project(window)?;
|
||||
let syntax = host.syntax();
|
||||
blocking(move || {
|
||||
let python = LanguageId::new("python");
|
||||
let files = project.index.files_with_extensions(&["py".into(), "pyi".into()], 20_000);
|
||||
let mut cache = CLASS_BASES.lock();
|
||||
let mut out = Vec::new();
|
||||
for path in files {
|
||||
// The open (possibly unsaved) buffer is keyed by its text, a file on disk by its
|
||||
// size and modification time, so only changed files are parsed again.
|
||||
// Disk-backed classes come from the index: it already parsed every file once for
|
||||
// symbols, so no second parse of the project is needed here.
|
||||
let mut out: Vec<ClassInheritance> = project
|
||||
.index
|
||||
.inheritance()
|
||||
.into_iter()
|
||||
// The index holds classes of every language; the graph is Python's.
|
||||
.filter(|c| matches!(c.path.extension().and_then(std::ffi::OsStr::to_str), Some("py" | "pyi")))
|
||||
.map(|c| ClassInheritance {
|
||||
path: IpcPath::from(c.path.clone()),
|
||||
line: c.range.start.line,
|
||||
col: c.range.start.col,
|
||||
name: c.name.clone(),
|
||||
bases: c.bases.clone(),
|
||||
})
|
||||
.collect();
|
||||
// Open buffers may be unsaved, so their classes are parsed live (and cached per
|
||||
// text/stamp) and replace the index's view of that file. This keeps #3359's
|
||||
// "open buffer by its text" behaviour while the disk path is index-backed.
|
||||
let open_files: Vec<PathBuf> = project
|
||||
.index
|
||||
.files_with_extensions(&["py".into(), "pyi".into()], 20_000)
|
||||
.into_iter()
|
||||
.filter(|path| project.documents.text_of(path).is_some())
|
||||
.collect();
|
||||
for path in open_files {
|
||||
let open = project.documents.text_of(&path);
|
||||
let stamp = match &open {
|
||||
Some(text) => Stamp::Text(text_hash(text)),
|
||||
None => match std::fs::metadata(&path) {
|
||||
Ok(m) => Stamp::Disk(m.len(), m.modified().ok()),
|
||||
Err(_) => continue,
|
||||
},
|
||||
Some(text) => Stamp(text_hash(text)),
|
||||
None => continue,
|
||||
};
|
||||
let text = open.unwrap();
|
||||
let classes = match cache.get(&path) {
|
||||
Some((cached, classes)) if *cached == stamp => classes,
|
||||
_ => {
|
||||
let text = match open {
|
||||
Some(text) => text,
|
||||
None => match project.text_of(&path) {
|
||||
Ok(text) => text,
|
||||
Err(_) => continue,
|
||||
},
|
||||
};
|
||||
let classes = syntax.class_bases(&python, &text);
|
||||
&cache.entry(path.clone()).insert_entry((stamp, classes)).into_mut().1
|
||||
}
|
||||
_ => &cache.entry(path.clone()).insert_entry((stamp, syntax.class_bases(&python, &text))).into_mut().1,
|
||||
};
|
||||
out.retain(|c| c.path.0 != *path);
|
||||
out.extend(classes.iter().map(|class| ClassInheritance {
|
||||
path: IpcPath::from(path.clone()),
|
||||
line: class.line,
|
||||
@@ -257,10 +268,7 @@ pub async fn nav_inheritance(host: &Host, window: &str) -> IdeResult<Vec<ClassIn
|
||||
}
|
||||
|
||||
#[derive(Clone, PartialEq, Eq)]
|
||||
enum Stamp {
|
||||
Text(u64),
|
||||
Disk(u64, Option<std::time::SystemTime>),
|
||||
}
|
||||
struct Stamp(u64);
|
||||
|
||||
fn text_hash(text: &str) -> u64 {
|
||||
use std::hash::{Hash, Hasher};
|
||||
|
||||
@@ -301,6 +301,8 @@ async fn start_inner(
|
||||
if config.command.is_empty() {
|
||||
return Err(IdeError::invalid("run configuration has no command"));
|
||||
}
|
||||
let on_target = config.extras.target.as_deref().is_some_and(|t| !t.is_empty());
|
||||
add_java_agents(&mut config, &on_output, !on_target);
|
||||
// Settings › Run Targets: over SSH, or in a container.
|
||||
if config.kind == "tomcat" && config.extras.target.as_deref().is_some_and(|t| !t.is_empty()) {
|
||||
return Err(IdeError::invalid("Tomcat Local requires the local machine"));
|
||||
@@ -446,6 +448,29 @@ async fn start_inner(
|
||||
host.processes.start(&project.root, &config, &options, sink, Box::new(move |c| on_output(c)))
|
||||
}
|
||||
|
||||
/// Plugins' Java agents (`[[contributes.javaAgents]]`, granted `java.agent`) for the JVM of an
|
||||
/// Application, Spring Boot or JAR Application configuration started on this machine. A JVM on a
|
||||
/// run target gets none; the console says so, and why an approved agent was left out.
|
||||
fn add_java_agents(config: &mut RunConfig, on_output: &Emit<OutputChunk>, local: bool) {
|
||||
if !ide_run::java_agent::applies(&config.kind) {
|
||||
return;
|
||||
}
|
||||
let agents = ide_run::java_agent::current();
|
||||
let say = |text: &str| on_output(OutputChunk::System { text: format!("{text}\n") });
|
||||
if !local {
|
||||
if !agents.options.is_empty() {
|
||||
say(
|
||||
"Plugin Java agents were not added: they load only into JVMs started on this machine, not on a run target.",
|
||||
);
|
||||
}
|
||||
return;
|
||||
}
|
||||
for note in &agents.notes {
|
||||
say(note);
|
||||
}
|
||||
ide_run::java_agent::add_to_args(&mut config.args, &agents.options);
|
||||
}
|
||||
|
||||
/// The Ruby test reporter's directory, installed on demand, for runs that take it.
|
||||
fn ruby_reporter_dir(host: &Host, config: &RunConfig) -> Option<std::path::PathBuf> {
|
||||
if !ide_run::ruby_reporter::applies(config) {
|
||||
|
||||
@@ -62,13 +62,25 @@ pub(crate) fn search_project(
|
||||
_ => None,
|
||||
};
|
||||
let workspace = ide_workspace::workspace::Workspace::load(root)?.is_some_and(|w| w.is_container(root));
|
||||
let include_root = !workspace
|
||||
|| matches!(query.scope, ide_search::SearchScope::Directory { .. } | ide_search::SearchScope::Files { .. });
|
||||
// A directory inside a content root is searched from that root, so that the project's
|
||||
// exclusions (a `.*` name) meet the paths there as in a whole-project search.
|
||||
let within = match &query.scope {
|
||||
ide_search::SearchScope::Directory { path } => {
|
||||
project.content_roots().into_iter().filter(|r| path.0.starts_with(r)).max_by_key(|r| r.components().count())
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
let include_root = within.is_none()
|
||||
&& (!workspace
|
||||
|| matches!(
|
||||
query.scope,
|
||||
ide_search::SearchScope::Directory { .. } | ide_search::SearchScope::Files { .. }
|
||||
));
|
||||
let content_roots = match query.scope {
|
||||
ide_search::SearchScope::Project
|
||||
| ide_search::SearchScope::FileSet { .. }
|
||||
| ide_search::SearchScope::Pattern { .. } => project.content_roots(),
|
||||
_ => Vec::new(),
|
||||
_ => within.into_iter().collect(),
|
||||
};
|
||||
let filter = |rel: &str| match set {
|
||||
Some(ProjectFileSet::Production) => !roots.is_test(rel),
|
||||
@@ -84,6 +96,19 @@ pub(crate) fn search_project(
|
||||
let mut total = SearchSummary::default();
|
||||
for dir in std::iter::once(root).filter(|_| include_root).chain(&content_roots) {
|
||||
let mut remaining = query.clone();
|
||||
// A root inside the project (one its walk skips) goes by its path there.
|
||||
let prefix = (dir != root).then(|| match dir.strip_prefix(root) {
|
||||
Ok(rel) if !workspace => rel.to_string_lossy().replace('\\', "/"),
|
||||
_ => dir.file_name().unwrap_or_default().to_string_lossy().into_owned(),
|
||||
});
|
||||
if let Some(prefix) = &prefix {
|
||||
remaining.include = rebase_masks(&query.include, prefix);
|
||||
remaining.exclude = rebase_masks(&query.exclude, prefix);
|
||||
// Only paths elsewhere were asked for.
|
||||
if remaining.include.is_empty() && !query.include.is_empty() {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
let max = if query.max_matches == 0 { 10_000 } else { query.max_matches };
|
||||
remaining.max_matches = max.saturating_sub(total.matches).max(1);
|
||||
let summary = ide_search::search_in_context(
|
||||
@@ -94,12 +119,7 @@ pub(crate) fn search_project(
|
||||
ide_search::TextSource { overlay: &|p| project.documents.search_text_of(p), decode: &decode },
|
||||
cancel,
|
||||
&|mut file| {
|
||||
if dir != root {
|
||||
// A root inside the project (one its walk skips) goes by its path there.
|
||||
let prefix = match dir.strip_prefix(root) {
|
||||
Ok(rel) if include_root => rel.to_string_lossy().replace('\\', "/"),
|
||||
_ => dir.file_name().unwrap_or_default().to_string_lossy().into_owned(),
|
||||
};
|
||||
if let Some(prefix) = &prefix {
|
||||
file.rel_path = format!("{prefix}/{}", file.rel_path);
|
||||
}
|
||||
emit(file);
|
||||
@@ -117,5 +137,41 @@ pub(crate) fn search_project(
|
||||
Ok(total)
|
||||
}
|
||||
|
||||
/// Project-relative `masks` (each a comma-separated list) for a search from the content root
|
||||
/// shown as `prefix`: paths below it lose the prefix, other paths can match nothing there and
|
||||
/// are dropped, names and `**/` patterns (`*.rs`, `**/build/**`) stay as they are.
|
||||
fn rebase_masks(masks: &[String], prefix: &str) -> Vec<String> {
|
||||
let prefix = format!("{}/", prefix.trim_end_matches('/'));
|
||||
masks
|
||||
.iter()
|
||||
.filter_map(|group| {
|
||||
let kept: Vec<String> = group
|
||||
.split(',')
|
||||
.map(str::trim)
|
||||
.filter(|m| !m.is_empty())
|
||||
.filter_map(|mask| {
|
||||
let (negated, body) = mask.strip_prefix('!').map_or(("", mask), |b| ("!", b.trim()));
|
||||
let body = body.trim_start_matches("./").trim_start_matches('/');
|
||||
if !body.contains('/') || body.starts_with("**/") {
|
||||
return Some(mask.to_owned());
|
||||
}
|
||||
body.strip_prefix(&prefix).map(|rest| format!("{negated}{rest}"))
|
||||
})
|
||||
.collect();
|
||||
(!kept.is_empty()).then(|| kept.join(","))
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn masks_follow_the_root_they_search() {
|
||||
let masks = vec![".wt/a/src/**, src/**".into(), "*.rs".into(), "!.wt/a/out/**".into(), "**/build/**".into()];
|
||||
assert_eq!(super::rebase_masks(&masks, ".wt/a"), ["src/**", "*.rs", "!out/**", "**/build/**"]);
|
||||
assert_eq!(super::rebase_masks(&["src/**".into()], ".wt/a"), Vec::<String>::new());
|
||||
}
|
||||
}
|
||||
|
||||
mod commands;
|
||||
pub use commands::*;
|
||||
@@ -0,0 +1,462 @@
|
||||
//! Java Stream Debugger: the stream chains around a debugger stop, and traces of a chain's real run.
|
||||
//! `ide_streams` finds the chains and links what the run recorded; `ide_dap` runs the trace.
|
||||
|
||||
use crate::Host;
|
||||
use crate::ops::Channel;
|
||||
use crate::rpc::Dispatcher;
|
||||
use ide_core::{CancellationToken, DebugSessionId, IdeError, IdeResult, LanguageId, Range, RequestId};
|
||||
use ide_dap::{StackFrame, TraceRun};
|
||||
pub use ide_dap::{TracePhase, TraceProgress, TraceUnavailable};
|
||||
pub use ide_jvm_inspect::{AbortState, JvmValue};
|
||||
use ide_jvm_inspect::{CollectedTerminal, TraceCollected};
|
||||
use ide_streams::{
|
||||
BoxKind, RealRunPlan, RealRunRefusal, Record, Rejection, StopContext, StreamChain, TerminalOutcome, TraceRecording,
|
||||
TraceValue, find_chains, link_trace, real_run_plan, recorded_steps,
|
||||
};
|
||||
pub use ide_streams::{Link, TraceBanner};
|
||||
use ide_syntax::{Snapshot, StructureService};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
use std::path::Path;
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct StreamChainInfo {
|
||||
/// The `chain_index` [`debug_stream_trace`] takes for the same frame.
|
||||
pub index: u32,
|
||||
pub range: Range,
|
||||
pub text: String,
|
||||
/// Intermediate operations in call order, modifiers included. Empty, like `terminal`, for a
|
||||
/// chain the search rejected.
|
||||
pub steps: Vec<String>,
|
||||
pub terminal: String,
|
||||
pub available: bool,
|
||||
/// Set exactly when `available` is false.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
#[specta(optional)]
|
||||
pub reason: Option<ChainUnavailable>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "kind", rename_all = "camelCase", rename_all_fields = "camelCase")]
|
||||
pub enum ChainUnavailable {
|
||||
NotTopFrame,
|
||||
NotAtChainStart,
|
||||
InsideChainLambda,
|
||||
NotJavaStreamRoot {
|
||||
root: String,
|
||||
},
|
||||
LazyTerminal {
|
||||
op: String,
|
||||
},
|
||||
NoTerminal,
|
||||
UnknownOperation {
|
||||
op: String,
|
||||
},
|
||||
SyntaxError,
|
||||
/// The session has no stream tracer: not java-debug, or its jdtls has no inspector bundle.
|
||||
NoBackend,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "status", rename_all = "camelCase", rename_all_fields = "camelCase")]
|
||||
pub enum StreamTraceResult {
|
||||
Ready {
|
||||
chain: Box<StreamChainInfo>,
|
||||
/// Column titles by recorded step: `steps[0]` is the root call's name (empty for a stream
|
||||
/// held in a local), then each operation that records, modifiers left out.
|
||||
steps: Vec<String>,
|
||||
/// In recording order.
|
||||
records: Vec<TraceRecordView>,
|
||||
/// Parallel to `records`.
|
||||
links: Vec<Link>,
|
||||
terminal: TerminalView,
|
||||
banners: Vec<TraceBanner>,
|
||||
/// The stop the values belong to, for `debug_jvm_memory_fields`.
|
||||
generation: u64,
|
||||
},
|
||||
Unavailable {
|
||||
reason: TraceUnavailable,
|
||||
},
|
||||
Failed {
|
||||
detail: String,
|
||||
},
|
||||
/// Recording was stopped, or the operation aborted, before the chain ran: nothing went wrong.
|
||||
Cancelled {
|
||||
detail: String,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct TraceRecordView {
|
||||
pub step: u16,
|
||||
pub value: JvmValue,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "kind", rename_all = "camelCase", rename_all_fields = "camelCase")]
|
||||
pub enum TerminalView {
|
||||
Value { value: JvmValue },
|
||||
Void,
|
||||
Threw { exception: JvmValue },
|
||||
}
|
||||
|
||||
/// The stream chains around `frame`'s line, in source order, with why each cannot be traced.
|
||||
/// `top`: `frame` is the thread's top frame, the only one a trace can run from.
|
||||
pub async fn debug_stream_chains(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
session: DebugSessionId,
|
||||
frame: StackFrame,
|
||||
top: bool,
|
||||
) -> IdeResult<Vec<StreamChainInfo>> {
|
||||
host.require_trust(window)?;
|
||||
let backend = host.debugger.capabilities(session)?.stream_trace;
|
||||
Ok(candidates(host, window, frame, top, backend).await?.into_iter().map(|c| c.info).collect())
|
||||
}
|
||||
|
||||
/// Runs the program from `thread_id`, stopped in `frame`, through the chain `chain_index` of
|
||||
/// [`debug_stream_chains`], recording each element, and leaves it stopped after the chain's
|
||||
/// terminal operation. `range` is that chain's [`StreamChainInfo::range`]: an edit in between
|
||||
/// can move another chain to the same index. Cancelling `request` stops recording while the
|
||||
/// program runs on.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub async fn debug_stream_trace(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
session: DebugSessionId,
|
||||
request: RequestId,
|
||||
thread_id: i64,
|
||||
frame: StackFrame,
|
||||
chain_index: u32,
|
||||
range: Range,
|
||||
on_progress: Channel<TraceProgress>,
|
||||
) -> IdeResult<StreamTraceResult> {
|
||||
host.require_trust(window)?;
|
||||
let cancel = host.begin_project_request(window, request);
|
||||
let chain = ChainRef { frame, index: chain_index, range };
|
||||
let result = trace(host, window, session, thread_id, chain, &cancel, &on_progress).await;
|
||||
host.end_request(request);
|
||||
result
|
||||
}
|
||||
|
||||
/// The chain the UI chose, as [`debug_stream_chains`] listed it.
|
||||
struct ChainRef {
|
||||
frame: StackFrame,
|
||||
index: u32,
|
||||
range: Range,
|
||||
}
|
||||
|
||||
async fn trace(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
session: DebugSessionId,
|
||||
thread_id: i64,
|
||||
chosen: ChainRef,
|
||||
cancel: &CancellationToken,
|
||||
on_progress: &Channel<TraceProgress>,
|
||||
) -> IdeResult<StreamTraceResult> {
|
||||
let line = chosen.frame.line;
|
||||
// `stream_trace` decides whether the session can trace, so the backend is assumed here.
|
||||
let candidate = candidates(host, window, chosen.frame, true, true)
|
||||
.await?
|
||||
.into_iter()
|
||||
.nth(chosen.index as usize)
|
||||
.filter(|c| c.info.range == chosen.range);
|
||||
let Some(candidate) = candidate else {
|
||||
return Ok(StreamTraceResult::Failed { detail: "the chain changed; trace it again".into() });
|
||||
};
|
||||
if let Some(reason) = candidate.info.reason.clone() {
|
||||
let reason = trace_unavailable(reason, line, candidate.chain.as_ref());
|
||||
return Ok(StreamTraceResult::Unavailable { reason });
|
||||
}
|
||||
let Some(chain) = candidate.chain else {
|
||||
return Err(IdeError::internal("an available stream chain has no parsed chain"));
|
||||
};
|
||||
let plan = real_run_plan(&chain).map_err(|e| IdeError::internal(format!("stream chain plan: {e:?}")))?;
|
||||
let plan_json = serde_json::to_value(&plan).map_err(|e| IdeError::internal(e.to_string()))?;
|
||||
// `stream_trace` resumes the program before it looks at `cancel`.
|
||||
if cancel.is_cancelled() {
|
||||
return Ok(StreamTraceResult::Cancelled { detail: "cancelled before the trace started".into() });
|
||||
}
|
||||
let progress = |p| {
|
||||
let _ = on_progress.send(p);
|
||||
};
|
||||
let run = host.debugger.stream_trace(session, thread_id, plan_json, cancel.clone(), progress).await?;
|
||||
Ok(match run {
|
||||
TraceRun::Done { collected, generation, resumed_stops } => {
|
||||
let info = candidate.info;
|
||||
host.blocking(move || Ok(ready(info, &chain, &plan, collected, generation, resumed_stops))).await?
|
||||
}
|
||||
TraceRun::Unavailable { reason } => StreamTraceResult::Unavailable { reason },
|
||||
TraceRun::Failed { detail } => StreamTraceResult::Failed { detail },
|
||||
TraceRun::Cancelled { detail } => StreamTraceResult::Cancelled { detail },
|
||||
})
|
||||
}
|
||||
|
||||
/// Ends the running trace's terminal operation (Abort Operation); `None` when no trace runs.
|
||||
pub async fn debug_stream_trace_abort(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
session: DebugSessionId,
|
||||
) -> IdeResult<Option<AbortState>> {
|
||||
host.require_trust(window)?;
|
||||
host.debugger.stream_trace_abort(session).await
|
||||
}
|
||||
|
||||
struct Candidate {
|
||||
info: StreamChainInfo,
|
||||
/// `None` for a chain the search rejected.
|
||||
chain: Option<StreamChain>,
|
||||
}
|
||||
|
||||
/// The file's current text (the open buffer, else the disk) searched off the command thread.
|
||||
/// Frames outside readable Java sources have no chains: java-debug gives library frames
|
||||
/// `jdt://contents/…` paths.
|
||||
async fn candidates(
|
||||
host: &Host,
|
||||
window: &str,
|
||||
frame: StackFrame,
|
||||
top: bool,
|
||||
backend: bool,
|
||||
) -> IdeResult<Vec<Candidate>> {
|
||||
let Some(path) = frame.path.clone() else { return Ok(Vec::new()) };
|
||||
let project = host.project(window)?;
|
||||
host.blocking(move || {
|
||||
let path = path.into_path_buf();
|
||||
let cancel = CancellationToken::new();
|
||||
let search = |snap: &Snapshot| {
|
||||
if snap.language.as_str() != "java" {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
chains_at(&project.structure, snap, &frame, top, backend, &cancel)
|
||||
};
|
||||
if let Some(doc) = project.documents.by_path(&path) {
|
||||
let snap = project.documents.text_snapshot(doc)?;
|
||||
if snap.large {
|
||||
return Err(IdeError::unavailable("file is too large for syntax analysis"));
|
||||
}
|
||||
return search(&Snapshot::doc(doc, snap.version, &snap.language, &snap.text));
|
||||
}
|
||||
let language: LanguageId = project.languages.detect(&path, None);
|
||||
if language.as_str() != "java" {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let Ok(text) = project.text_of(&path) else { return Ok(Vec::new()) };
|
||||
search(&Snapshot::text(&language, &text))
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
fn chains_at(
|
||||
service: &StructureService,
|
||||
snap: &Snapshot,
|
||||
frame: &StackFrame,
|
||||
top: bool,
|
||||
backend: bool,
|
||||
cancel: &CancellationToken,
|
||||
) -> IdeResult<Vec<Candidate>> {
|
||||
let path = frame.path.as_ref().map(|p| p.0.as_path());
|
||||
let file_stem = path.and_then(Path::file_stem).and_then(|s| s.to_str()).unwrap_or_default();
|
||||
let stop = StopContext { line: frame.line, in_lambda: frame.name.contains("lambda$"), file_stem };
|
||||
let found = find_chains(service, snap, &stop, cancel)?;
|
||||
let mut candidates: Vec<Candidate> = found
|
||||
.chains
|
||||
.into_iter()
|
||||
.map(|chain| {
|
||||
let reason = refusal(&chain, frame.line, top, backend);
|
||||
let info = StreamChainInfo {
|
||||
index: 0,
|
||||
range: chain.range,
|
||||
text: chain.text.clone(),
|
||||
steps: chain.ops.iter().map(|op| op.name.clone()).collect(),
|
||||
terminal: chain.terminal.name.clone(),
|
||||
available: reason.is_none(),
|
||||
reason,
|
||||
};
|
||||
Candidate { info, chain: Some(chain) }
|
||||
})
|
||||
.collect();
|
||||
candidates.extend(found.rejected.into_iter().map(|rejected| {
|
||||
let reason = if top { rejection(rejected.reason) } else { ChainUnavailable::NotTopFrame };
|
||||
let info = StreamChainInfo {
|
||||
index: 0,
|
||||
range: rejected.range,
|
||||
text: rejected.text,
|
||||
steps: Vec::new(),
|
||||
terminal: String::new(),
|
||||
available: false,
|
||||
reason: Some(reason),
|
||||
};
|
||||
Candidate { info, chain: None }
|
||||
}));
|
||||
candidates.sort_by_key(|c| c.info.range);
|
||||
for (i, c) in candidates.iter_mut().enumerate() {
|
||||
c.info.index = i as u32;
|
||||
}
|
||||
Ok(candidates)
|
||||
}
|
||||
|
||||
fn refusal(chain: &StreamChain, line: u32, top: bool, backend: bool) -> Option<ChainUnavailable> {
|
||||
if !top {
|
||||
return Some(ChainUnavailable::NotTopFrame);
|
||||
}
|
||||
// ECJ puts the first instruction of `T x =\n root…` on the root's line, not the
|
||||
// statement's; the bundle makes the final call from the line table.
|
||||
if line < chain.first_line || line > root_line(chain) {
|
||||
return Some(ChainUnavailable::NotAtChainStart);
|
||||
}
|
||||
if let Err(refused) = real_run_plan(chain) {
|
||||
return Some(refusal_reason(refused));
|
||||
}
|
||||
(!backend).then_some(ChainUnavailable::NoBackend)
|
||||
}
|
||||
|
||||
fn root_line(chain: &StreamChain) -> u32 {
|
||||
let before_root = chain.text.get(..chain.root.span.0).unwrap_or_default();
|
||||
chain.range.start.line + before_root.matches('\n').count() as u32
|
||||
}
|
||||
|
||||
fn refusal_reason(refused: RealRunRefusal) -> ChainUnavailable {
|
||||
match refused {
|
||||
RealRunRefusal::NotJavaStreamRoot { root } => ChainUnavailable::NotJavaStreamRoot { root },
|
||||
RealRunRefusal::LazyTerminal { op } => ChainUnavailable::LazyTerminal { op },
|
||||
RealRunRefusal::NoTerminal => ChainUnavailable::NoTerminal,
|
||||
RealRunRefusal::UnknownOperation { op } => ChainUnavailable::UnknownOperation { op },
|
||||
RealRunRefusal::InsideChainLambda => ChainUnavailable::InsideChainLambda,
|
||||
RealRunRefusal::SyntaxError => ChainUnavailable::SyntaxError,
|
||||
}
|
||||
}
|
||||
|
||||
fn rejection(rejected: Rejection) -> ChainUnavailable {
|
||||
match rejected {
|
||||
Rejection::LazyTerminal { op } => ChainUnavailable::LazyTerminal { op },
|
||||
Rejection::NoTerminal => ChainUnavailable::NoTerminal,
|
||||
Rejection::UnknownOperation { op } => ChainUnavailable::UnknownOperation { op },
|
||||
Rejection::InsideChainLambda => ChainUnavailable::InsideChainLambda,
|
||||
Rejection::SyntaxError => ChainUnavailable::SyntaxError,
|
||||
}
|
||||
}
|
||||
|
||||
/// The same reasons as the bundle's refusals, for a chain that stopped being traceable between
|
||||
/// [`debug_stream_chains`] and [`debug_stream_trace`].
|
||||
fn trace_unavailable(reason: ChainUnavailable, line: u32, chain: Option<&StreamChain>) -> TraceUnavailable {
|
||||
let unsupported = |detail: String| TraceUnavailable::Unsupported { detail };
|
||||
match reason {
|
||||
ChainUnavailable::NotAtChainStart => {
|
||||
let start = chain.map_or(String::new(), |c| format!(", the chain starts on line {}", c.first_line + 1));
|
||||
TraceUnavailable::NotAtChainStart { detail: format!("the stop is on line {}{start}", line + 1) }
|
||||
}
|
||||
ChainUnavailable::NoBackend => TraceUnavailable::NoBackend,
|
||||
ChainUnavailable::NotTopFrame => unsupported("only the top frame can be traced".into()),
|
||||
ChainUnavailable::InsideChainLambda => unsupported("the chain is already running".into()),
|
||||
ChainUnavailable::NotJavaStreamRoot { root } => {
|
||||
unsupported(format!("the stream {root} does not start in this statement"))
|
||||
}
|
||||
ChainUnavailable::LazyTerminal { op } => unsupported(format!("{op}() does not run the pipeline")),
|
||||
ChainUnavailable::NoTerminal => unsupported("the chain has no terminal operation".into()),
|
||||
ChainUnavailable::UnknownOperation { op } => unsupported(format!("unknown stream operation {op}()")),
|
||||
ChainUnavailable::SyntaxError => unsupported("the statement does not parse".into()),
|
||||
}
|
||||
}
|
||||
|
||||
fn ready(
|
||||
chain_info: StreamChainInfo,
|
||||
chain: &StreamChain,
|
||||
plan: &RealRunPlan,
|
||||
collected: TraceCollected,
|
||||
generation: u64,
|
||||
resumed_stops: u32,
|
||||
) -> StreamTraceResult {
|
||||
let recording = TraceRecording {
|
||||
records: collected.records.iter().map(|(step, v)| Record { step: *step, value: trace_value(v) }).collect(),
|
||||
dropped: collected.dropped,
|
||||
terminal: match &collected.terminal {
|
||||
CollectedTerminal::Value(v) => TerminalOutcome::Value { value: trace_value(v) },
|
||||
CollectedTerminal::Void => TerminalOutcome::Void,
|
||||
CollectedTerminal::Threw(e) => TerminalOutcome::Threw { exception: trace_value(e) },
|
||||
},
|
||||
};
|
||||
let mut linked = link_trace(plan, &recording, collected.skipped_breakpoints);
|
||||
if resumed_stops > 0 {
|
||||
linked.banners.push(TraceBanner::BreakpointsResumed { count: resumed_stops });
|
||||
}
|
||||
StreamTraceResult::Ready {
|
||||
chain: Box::new(chain_info),
|
||||
steps: recorded_steps(chain),
|
||||
records: collected.records.into_iter().map(|(step, value)| TraceRecordView { step, value }).collect(),
|
||||
links: linked.links,
|
||||
terminal: match collected.terminal {
|
||||
CollectedTerminal::Value(value) => TerminalView::Value { value },
|
||||
CollectedTerminal::Void => TerminalView::Void,
|
||||
CollectedTerminal::Threw(exception) => TerminalView::Threw { exception },
|
||||
},
|
||||
banners: linked.banners,
|
||||
generation,
|
||||
}
|
||||
}
|
||||
|
||||
fn trace_value(value: &JvmValue) -> TraceValue {
|
||||
match value {
|
||||
JvmValue::Null => TraceValue::Null,
|
||||
JvmValue::Boxed { id, type_name, text } => match box_kind(type_name) {
|
||||
Some(class) => TraceValue::Boxed { id: *id, class, value: text.clone() },
|
||||
None => TraceValue::Object { id: *id, class: type_name.clone() },
|
||||
},
|
||||
JvmValue::Str { id, text, .. } => {
|
||||
TraceValue::Str { id: *id, value: text.clone().unwrap_or_default(), truncated: text.is_none() }
|
||||
}
|
||||
JvmValue::Object { id, type_name } | JvmValue::Array { id, type_name, .. } => {
|
||||
TraceValue::Object { id: *id, class: type_name.clone() }
|
||||
}
|
||||
// The recorder boxes every element, so only a terminal's result is primitive, and linking
|
||||
// never reads that.
|
||||
JvmValue::Primitive { type_name, text } => match box_kind(type_name) {
|
||||
Some(class) => TraceValue::Boxed { id: 0, class, value: text.clone() },
|
||||
None => TraceValue::Null,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/// Wrapper class names (boxed values) and primitive type names (primitive values) alike.
|
||||
fn box_kind(type_name: &str) -> Option<BoxKind> {
|
||||
Some(match type_name {
|
||||
"java.lang.Boolean" | "boolean" => BoxKind::Boolean,
|
||||
"java.lang.Byte" | "byte" => BoxKind::Byte,
|
||||
"java.lang.Character" | "char" => BoxKind::Char,
|
||||
"java.lang.Short" | "short" => BoxKind::Short,
|
||||
"java.lang.Integer" | "int" => BoxKind::Int,
|
||||
"java.lang.Long" | "long" => BoxKind::Long,
|
||||
"java.lang.Float" | "float" => BoxKind::Float,
|
||||
"java.lang.Double" | "double" => BoxKind::Double,
|
||||
_ => return None,
|
||||
})
|
||||
}
|
||||
|
||||
/// Commands of this module the remote server answers.
|
||||
pub(crate) fn register(d: &mut Dispatcher) {
|
||||
d.add("debug_stream_chains", |c| async move {
|
||||
debug_stream_chains(&c.host, &c.window, c.arg("session")?, c.arg("frame")?, c.arg("top")?).await
|
||||
});
|
||||
d.add("debug_stream_trace", |c| async move {
|
||||
debug_stream_trace(
|
||||
&c.host,
|
||||
&c.window,
|
||||
c.arg("session")?,
|
||||
c.arg("request")?,
|
||||
c.arg("threadId")?,
|
||||
c.arg("frame")?,
|
||||
c.arg("chainIndex")?,
|
||||
c.arg("range")?,
|
||||
c.sender("onProgress")?,
|
||||
)
|
||||
.await
|
||||
});
|
||||
d.add("debug_stream_trace_abort", |c| async move {
|
||||
debug_stream_trace_abort(&c.host, &c.window, c.arg("session")?).await
|
||||
});
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
@@ -0,0 +1,444 @@
|
||||
use super::*;
|
||||
use ide_core::{CancellationToken, LanguageId};
|
||||
use ide_language::{Syntax, SyntaxCache};
|
||||
use ide_streams::BoxKind;
|
||||
use serde_json::json;
|
||||
use std::sync::{Arc, OnceLock};
|
||||
|
||||
const SOURCE: &str = r#"import java.util.*;
|
||||
import java.util.stream.*;
|
||||
|
||||
class Chains {
|
||||
Stream<Integer> items;
|
||||
|
||||
void run(List<Integer> nums) {
|
||||
List<Integer> evens = nums.stream() // C_EVENS
|
||||
.filter(x -> x % 2 == 0) // C_EVENS_FILTER
|
||||
.collect(Collectors.toList());
|
||||
List<Integer> out = // C_DECL
|
||||
nums.stream() // C_ROOT
|
||||
.map(x -> x + 1) // C_ROOT_MAP
|
||||
.collect(Collectors.toList());
|
||||
long n = this.items.filter(x -> x > 0).count(); // C_FIELD
|
||||
Iterator<Integer> it = nums.stream().map(x -> x).iterator(); // C_LAZY
|
||||
List<String> a = nums.stream().filter(x -> x % 2 == 0).map(x -> x * 10 + 1).sorted().map(String::valueOf).collect(Collectors.toList()); // C_SPIKE
|
||||
}
|
||||
}
|
||||
"#;
|
||||
|
||||
fn service() -> &'static StructureService {
|
||||
static S: OnceLock<StructureService> = OnceLock::new();
|
||||
S.get_or_init(|| StructureService::new(Arc::new(SyntaxCache::new(Arc::new(Syntax::new())))))
|
||||
}
|
||||
|
||||
fn line_of(marker: &str) -> u32 {
|
||||
let tag = format!("// {marker}");
|
||||
let found = SOURCE.lines().position(|l| l.trim_end().ends_with(&tag));
|
||||
found.unwrap_or_else(|| panic!("no line marked {marker}")) as u32
|
||||
}
|
||||
|
||||
fn frame(line: u32) -> StackFrame {
|
||||
StackFrame {
|
||||
id: 1,
|
||||
name: "Chains.run(List)".into(),
|
||||
path: Some("/project/src/Chains.java".into()),
|
||||
line,
|
||||
column: 8,
|
||||
presentation_hint: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn chains_on(line: u32, top: bool, backend: bool) -> Vec<StreamChainInfo> {
|
||||
let java = LanguageId::new("java");
|
||||
let snap = Snapshot::text(&java, SOURCE);
|
||||
let found = chains_at(service(), &snap, &frame(line), top, backend, &CancellationToken::new()).expect("search");
|
||||
found.into_iter().map(|c| c.info).collect()
|
||||
}
|
||||
|
||||
fn availability(info: &StreamChainInfo) -> serde_json::Value {
|
||||
let mut v = serde_json::to_value(info).unwrap();
|
||||
let map = v.as_object_mut().unwrap();
|
||||
json!({ "available": map.remove("available"), "reason": map.remove("reason") })
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chains_refuse_non_top_frame() {
|
||||
let infos = chains_on(line_of("C_EVENS"), false, true);
|
||||
assert!(!infos.is_empty());
|
||||
for info in &infos {
|
||||
assert_eq!(availability(info), json!({"available": false, "reason": {"kind": "notTopFrame"}}), "{info:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chains_need_first_line() {
|
||||
let infos = chains_on(line_of("C_EVENS_FILTER"), true, true);
|
||||
assert_eq!(infos.len(), 1, "{infos:?}");
|
||||
assert_eq!(availability(&infos[0]), json!({"available": false, "reason": {"kind": "notAtChainStart"}}));
|
||||
let mid = chains_on(line_of("C_ROOT_MAP"), true, true);
|
||||
assert_eq!(availability(&mid[0]), json!({"available": false, "reason": {"kind": "notAtChainStart"}}));
|
||||
}
|
||||
|
||||
/// ECJ puts a declaration's first instruction on the line of its initializer's root call.
|
||||
#[test]
|
||||
fn chains_accept_the_root_line_of_a_declaration() {
|
||||
let at_root = chains_on(line_of("C_ROOT"), true, true);
|
||||
assert_eq!(at_root.len(), 1, "{at_root:?}");
|
||||
assert_eq!(availability(&at_root[0]), json!({"available": true, "reason": null}));
|
||||
let at_head = chains_on(line_of("C_DECL"), true, true);
|
||||
assert_eq!(availability(&at_head[0]), json!({"available": true, "reason": null}));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chains_list_rejections() {
|
||||
let field = chains_on(line_of("C_FIELD"), true, true);
|
||||
assert_eq!(field.len(), 1, "{field:?}");
|
||||
assert_eq!(
|
||||
availability(&field[0]),
|
||||
json!({"available": false, "reason": {"kind": "notJavaStreamRoot", "root": "this.items"}})
|
||||
);
|
||||
let lazy = chains_on(line_of("C_LAZY"), true, true);
|
||||
assert_eq!(lazy.len(), 1, "{lazy:?}");
|
||||
assert_eq!(
|
||||
availability(&lazy[0]),
|
||||
json!({"available": false, "reason": {"kind": "lazyTerminal", "op": "iterator"}})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chains_without_a_tracer_have_no_backend() {
|
||||
let infos = chains_on(line_of("C_EVENS"), true, false);
|
||||
assert_eq!(availability(&infos[0]), json!({"available": false, "reason": {"kind": "noBackend"}}));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chain_info_json_shape() {
|
||||
let infos = chains_on(line_of("C_EVENS"), true, true);
|
||||
let v = serde_json::to_value(&infos[0]).unwrap();
|
||||
assert_eq!(v["index"], 0);
|
||||
assert_eq!(v["steps"], json!(["filter"]));
|
||||
assert_eq!(v["terminal"], "collect");
|
||||
assert_eq!(v["range"]["start"]["line"], line_of("C_EVENS"));
|
||||
assert_eq!(v["available"], true);
|
||||
assert!(v.get("reason").is_none(), "{v}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn jvm_value_to_trace_value() {
|
||||
let boxed = JvmValue::Boxed { id: 4, type_name: "java.lang.Integer".into(), text: "8".into() };
|
||||
assert_eq!(trace_value(&boxed), TraceValue::Boxed { id: 4, class: BoxKind::Int, value: "8".into() });
|
||||
let long_text = JvmValue::Str { id: 5, text: None, length: 50_000 };
|
||||
assert_eq!(trace_value(&long_text), TraceValue::Str { id: 5, value: String::new(), truncated: true });
|
||||
let short_text = JvmValue::Str { id: 6, text: Some("81".into()), length: 2 };
|
||||
assert_eq!(trace_value(&short_text), TraceValue::Str { id: 6, value: "81".into(), truncated: false });
|
||||
let object = JvmValue::Object { id: 7, type_name: "com.x.Order".into() };
|
||||
assert_eq!(trace_value(&object), TraceValue::Object { id: 7, class: "com.x.Order".into() });
|
||||
let array = JvmValue::Array { id: 8, type_name: "int[]".into(), length: 3 };
|
||||
assert_eq!(trace_value(&array), TraceValue::Object { id: 8, class: "int[]".into() });
|
||||
assert_eq!(trace_value(&JvmValue::Null), TraceValue::Null);
|
||||
let odd_box = JvmValue::Boxed { id: 9, type_name: "java.math.BigInteger".into(), text: "1".into() };
|
||||
assert_eq!(trace_value(&odd_box), TraceValue::Object { id: 9, class: "java.math.BigInteger".into() });
|
||||
let count = JvmValue::Primitive { type_name: "long".into(), text: "4".into() };
|
||||
assert_eq!(trace_value(&count), TraceValue::Boxed { id: 0, class: BoxKind::Long, value: "4".into() });
|
||||
let odd_primitive = JvmValue::Primitive { type_name: "void".into(), text: String::new() };
|
||||
assert_eq!(trace_value(&odd_primitive), TraceValue::Null);
|
||||
}
|
||||
|
||||
/// The log measured on `source -> filter -> map -> sorted -> map` (see ide-streams' spike test),
|
||||
/// as the bundle reports it: every `peek` re-boxes, so no two boxes share an id.
|
||||
fn spike_collected() -> TraceCollected {
|
||||
let steps_values: [(u16, &str); 24] = [
|
||||
(0, "5"),
|
||||
(0, "3"),
|
||||
(0, "8"),
|
||||
(1, "8"),
|
||||
(2, "81"),
|
||||
(0, "1"),
|
||||
(0, "4"),
|
||||
(1, "4"),
|
||||
(2, "41"),
|
||||
(0, "2"),
|
||||
(1, "2"),
|
||||
(2, "21"),
|
||||
(0, "9"),
|
||||
(0, "6"),
|
||||
(1, "6"),
|
||||
(2, "61"),
|
||||
(3, "21"),
|
||||
(4, "21"),
|
||||
(3, "41"),
|
||||
(4, "41"),
|
||||
(3, "61"),
|
||||
(4, "61"),
|
||||
(3, "81"),
|
||||
(4, "81"),
|
||||
];
|
||||
let records = steps_values
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, &(step, text))| {
|
||||
let id = 100 + i as u64;
|
||||
let value = if step == 4 {
|
||||
JvmValue::Str { id, text: Some(text.into()), length: text.len() as u32 }
|
||||
} else {
|
||||
JvmValue::Boxed { id, type_name: "java.lang.Integer".into(), text: text.into() }
|
||||
};
|
||||
(step, value)
|
||||
})
|
||||
.collect();
|
||||
TraceCollected {
|
||||
records,
|
||||
dropped: 3,
|
||||
terminal: CollectedTerminal::Value(JvmValue::Object { id: 7, type_name: "java.util.ArrayList".into() }),
|
||||
skipped_breakpoints: 2,
|
||||
sequentialized: false,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ready_links_the_collected_records() {
|
||||
let java = LanguageId::new("java");
|
||||
let snap = Snapshot::text(&java, SOURCE);
|
||||
let found = chains_at(service(), &snap, &frame(line_of("C_SPIKE")), true, true, &CancellationToken::new()).unwrap();
|
||||
let Candidate { info, chain } = found.into_iter().next().unwrap();
|
||||
let chain = chain.unwrap();
|
||||
let plan = real_run_plan(&chain).unwrap();
|
||||
let collected = spike_collected();
|
||||
let expected_records: Vec<TraceRecordView> =
|
||||
collected.records.iter().map(|(step, value)| TraceRecordView { step: *step, value: value.clone() }).collect();
|
||||
|
||||
let StreamTraceResult::Ready { chain: shown, steps, records, links, terminal, banners, generation } =
|
||||
ready(info.clone(), &chain, &plan, collected, 9, 0)
|
||||
else {
|
||||
panic!("not ready");
|
||||
};
|
||||
assert_eq!(*shown, info);
|
||||
assert_eq!(steps, ["stream", "filter", "map", "sorted", "map"]);
|
||||
assert_eq!(records, expected_records);
|
||||
assert_eq!(links.len(), records.len());
|
||||
assert_eq!(links[0], Link { parent: None, ambiguous: false });
|
||||
// `1=8` comes from the `0=8` just before it, and `2=81` from that.
|
||||
assert_eq!(links[3].parent, Some(2));
|
||||
assert_eq!(links[4].parent, Some(3));
|
||||
// `sorted` emits `3=21` after the whole upstream ran: it is the `2=21` of record 11, linked by
|
||||
// value although the box was re-made.
|
||||
assert_eq!(links[16], Link { parent: Some(11), ambiguous: false });
|
||||
assert_eq!(links[17].parent, Some(16));
|
||||
assert_eq!(links[22].parent, Some(4));
|
||||
assert_eq!(
|
||||
terminal,
|
||||
TerminalView::Value { value: JvmValue::Object { id: 7, type_name: "java.util.ArrayList".into() } }
|
||||
);
|
||||
assert_eq!(banners, [TraceBanner::Truncated { dropped: 3 }, TraceBanner::BreakpointsSkipped { count: 2 }]);
|
||||
assert_eq!(generation, 9);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ready_says_how_many_stops_were_resumed() {
|
||||
let java = LanguageId::new("java");
|
||||
let snap = Snapshot::text(&java, SOURCE);
|
||||
let found = chains_at(service(), &snap, &frame(line_of("C_SPIKE")), true, true, &CancellationToken::new()).unwrap();
|
||||
let Candidate { info, chain } = found.into_iter().next().unwrap();
|
||||
let chain = chain.unwrap();
|
||||
let plan = real_run_plan(&chain).unwrap();
|
||||
|
||||
let StreamTraceResult::Ready { banners, .. } = ready(info, &chain, &plan, spike_collected(), 9, 3) else {
|
||||
panic!("not ready");
|
||||
};
|
||||
assert_eq!(
|
||||
banners,
|
||||
[
|
||||
TraceBanner::Truncated { dropped: 3 },
|
||||
TraceBanner::BreakpointsSkipped { count: 2 },
|
||||
TraceBanner::BreakpointsResumed { count: 3 }
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
const WINDOW: &str = "main";
|
||||
|
||||
/// A real `Host` with a trusted project holding `src/Chains.java` (= [`SOURCE`]).
|
||||
struct Fixture {
|
||||
host: Host,
|
||||
source: std::path::PathBuf,
|
||||
_temp: tempfile::TempDir,
|
||||
}
|
||||
|
||||
impl Fixture {
|
||||
async fn new() -> Self {
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
let base = dunce::canonicalize(temp.path()).unwrap();
|
||||
let root = base.join("project");
|
||||
std::fs::create_dir_all(root.join("src")).unwrap();
|
||||
let source = root.join("src/Chains.java");
|
||||
std::fs::write(&source, SOURCE).unwrap();
|
||||
let host = Host::new(crate::HostConfig {
|
||||
config_dir: base.join("config"),
|
||||
data_dir: base.join("data"),
|
||||
local_data_dir: base.join("local"),
|
||||
languages: Arc::new(ide_language::LanguageRegistry::load(None).unwrap()),
|
||||
syntax: Arc::default(),
|
||||
sink_for: Box::new(|_| Arc::new(|_| {})),
|
||||
owner: |w| w,
|
||||
runtime: tokio::runtime::Handle::current(),
|
||||
project_environment: false,
|
||||
});
|
||||
host.open_project(WINDOW, &root).unwrap();
|
||||
host.set_project_trust(&root, true, false).await.unwrap();
|
||||
Self { host, source, _temp: temp }
|
||||
}
|
||||
|
||||
fn frame(&self, line: u32) -> StackFrame {
|
||||
StackFrame { path: Some(self.source.as_path().into()), ..frame(line) }
|
||||
}
|
||||
|
||||
async fn chains(&self, frame: StackFrame) -> Vec<StreamChainInfo> {
|
||||
candidates(&self.host, WINDOW, frame, true, true).await.unwrap().into_iter().map(|c| c.info).collect()
|
||||
}
|
||||
|
||||
async fn trace(&self, request: u32, frame: StackFrame, index: u32, range: Range) -> StreamTraceResult {
|
||||
let request = RequestId(request);
|
||||
debug_stream_trace(
|
||||
&self.host,
|
||||
WINDOW,
|
||||
DebugSessionId(404),
|
||||
request,
|
||||
1,
|
||||
frame,
|
||||
index,
|
||||
range,
|
||||
Channel::new(|_| {}),
|
||||
)
|
||||
.await
|
||||
.unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn chains_skip_frames_without_a_readable_java_source() {
|
||||
let f = Fixture::new().await;
|
||||
assert_eq!(f.chains(f.frame(line_of("C_EVENS"))).await.len(), 1, "the file on disk is read");
|
||||
let library = StackFrame {
|
||||
path: Some("jdt://contents/rt.jar/java.util.stream/ReferencePipeline.class?=java/rt.jar".into()),
|
||||
..frame(120)
|
||||
};
|
||||
assert_eq!(f.chains(library).await, []);
|
||||
let missing = StackFrame { path: Some(f.source.with_file_name("Missing.java").as_path().into()), ..frame(3) };
|
||||
assert_eq!(f.chains(missing).await, []);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn trace_refuses_a_chain_that_changed() {
|
||||
let f = Fixture::new().await;
|
||||
let at = f.frame(line_of("C_EVENS"));
|
||||
let listed = f.chains(at.clone()).await.remove(0);
|
||||
let changed = StreamTraceResult::Failed { detail: "the chain changed; trace it again".into() };
|
||||
let mut moved = listed.range;
|
||||
moved.end.col += 1;
|
||||
assert_eq!(f.trace(1, at.clone(), listed.index, moved).await, changed);
|
||||
assert_eq!(f.trace(2, at, listed.index + 1, listed.range).await, changed);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn trace_reports_an_unavailable_chain_like_the_bundle() {
|
||||
let f = Fixture::new().await;
|
||||
let mid = f.frame(line_of("C_EVENS_FILTER"));
|
||||
let listed = f.chains(mid.clone()).await.remove(0);
|
||||
let detail = format!(
|
||||
"the stop is on line {}, the chain starts on line {}",
|
||||
line_of("C_EVENS_FILTER") + 1,
|
||||
line_of("C_EVENS") + 1
|
||||
);
|
||||
assert_eq!(
|
||||
f.trace(1, mid, listed.index, listed.range).await,
|
||||
StreamTraceResult::Unavailable { reason: TraceUnavailable::NotAtChainStart { detail } }
|
||||
);
|
||||
let field = f.frame(line_of("C_FIELD"));
|
||||
let listed = f.chains(field.clone()).await.remove(0);
|
||||
let detail = "the stream this.items does not start in this statement".to_string();
|
||||
assert_eq!(
|
||||
f.trace(2, field, listed.index, listed.range).await,
|
||||
StreamTraceResult::Unavailable { reason: TraceUnavailable::Unsupported { detail } }
|
||||
);
|
||||
}
|
||||
|
||||
/// The session id names no session: reaching `stream_trace` would fail the call.
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn trace_cancelled_before_it_starts_does_not_run() {
|
||||
let f = Fixture::new().await;
|
||||
let at = f.frame(line_of("C_EVENS"));
|
||||
let listed = f.chains(at.clone()).await.remove(0);
|
||||
f.host.cancel_request(RequestId(7));
|
||||
assert_eq!(
|
||||
f.trace(7, at, listed.index, listed.range).await,
|
||||
StreamTraceResult::Cancelled { detail: "cancelled before the trace started".into() }
|
||||
);
|
||||
assert_eq!(
|
||||
serde_json::to_value(StreamTraceResult::Cancelled { detail: "x".into() }).unwrap(),
|
||||
json!({"status": "cancelled", "detail": "x"})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ready_result_json_shape() {
|
||||
let info = chains_on(line_of("C_EVENS"), true, true).remove(0);
|
||||
let value = JvmValue::Boxed { id: 4, type_name: "java.lang.Integer".into(), text: "8".into() };
|
||||
let ready = StreamTraceResult::Ready {
|
||||
chain: Box::new(info),
|
||||
steps: vec!["stream".into(), "filter".into()],
|
||||
records: vec![TraceRecordView { step: 0, value: value.clone() }],
|
||||
links: vec![Link { parent: None, ambiguous: false }],
|
||||
terminal: TerminalView::Threw { exception: JvmValue::Object { id: 9, type_name: "java.lang.X".into() } },
|
||||
banners: vec![TraceBanner::Truncated { dropped: 2 }, TraceBanner::BreakpointsSkipped { count: 1 }],
|
||||
generation: 3,
|
||||
};
|
||||
let v = serde_json::to_value(&ready).unwrap();
|
||||
assert_eq!(v["status"], "ready");
|
||||
assert_eq!(v["chain"]["available"], true);
|
||||
assert_eq!(v["steps"], json!(["stream", "filter"]));
|
||||
assert_eq!(
|
||||
v["records"],
|
||||
json!([{"step": 0, "value": {"kind": "boxed", "id": 4, "typeName": "java.lang.Integer", "text": "8"}}])
|
||||
);
|
||||
assert_eq!(v["links"], json!([{"parent": null, "ambiguous": false}]));
|
||||
assert_eq!(
|
||||
v["terminal"],
|
||||
json!({"kind": "threw", "exception": {"kind": "object", "id": 9, "typeName": "java.lang.X"}})
|
||||
);
|
||||
assert_eq!(v["banners"], json!([{"kind": "truncated", "dropped": 2}, {"kind": "breakpointsSkipped", "count": 1}]));
|
||||
assert_eq!(v["generation"], 3);
|
||||
assert_eq!(serde_json::to_value(TerminalView::Value { value }).unwrap()["kind"], "value");
|
||||
assert_eq!(serde_json::to_value(TerminalView::Void).unwrap(), json!({"kind": "void"}));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn other_results_json_shape() {
|
||||
let unavailable =
|
||||
StreamTraceResult::Unavailable { reason: TraceUnavailable::NotAtChainStart { detail: "line 4".into() } };
|
||||
assert_eq!(
|
||||
serde_json::to_value(&unavailable).unwrap(),
|
||||
json!({"status": "unavailable", "reason": {"kind": "notAtChainStart", "detail": "line 4"}})
|
||||
);
|
||||
assert_eq!(
|
||||
serde_json::to_value(StreamTraceResult::Failed { detail: "boom".into() }).unwrap(),
|
||||
json!({"status": "failed", "detail": "boom"})
|
||||
);
|
||||
let progress = TraceProgress { phase: TracePhase::RecordingStopped, records: 5, dropped: 0, elapsed_ms: 40 };
|
||||
assert_eq!(
|
||||
serde_json::to_value(&progress).unwrap(),
|
||||
json!({"phase": "recordingStopped", "records": 5, "dropped": 0, "elapsedMs": 40})
|
||||
);
|
||||
let stuck = AbortState::Stuck { holders: vec![(3, "main".into())] };
|
||||
assert_eq!(serde_json::to_value(&stuck).unwrap(), json!({"kind": "stuck", "holders": [[3, "main"]]}));
|
||||
assert_eq!(serde_json::to_value(AbortState::Interrupted).unwrap(), json!({"kind": "interrupted"}));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chain_info_steps_keep_modifiers() {
|
||||
let java = LanguageId::new("java");
|
||||
let source = "class Chains { void run(java.util.List<Integer> nums) {\n\
|
||||
long n = nums.parallelStream().filter(x -> x > 0).unordered().map(x -> x).count();\n} }";
|
||||
let snap = Snapshot::text(&java, source);
|
||||
let found = chains_at(service(), &snap, &frame(1), true, true, &CancellationToken::new()).unwrap();
|
||||
assert_eq!(found[0].info.steps, ["filter", "unordered", "map"]);
|
||||
}
|
||||
@@ -112,6 +112,11 @@ pub trait PluginWorkspace: Send + Sync {
|
||||
) -> Result<serde_json::Value, HostError> {
|
||||
Err(HostError::NotFound(format!("no language server `{server}` is running for this project")))
|
||||
}
|
||||
/// What the IDE has resolved of the Maven / Gradle builds of the project at `root`;
|
||||
/// never runs a build tool.
|
||||
fn build_graph(&self, _root: &Path) -> Result<super::BuildGraph, HostError> {
|
||||
Ok(super::BuildGraph::default())
|
||||
}
|
||||
/// Current index of the project rooted at `root`; never reads disk or calls LSP.
|
||||
fn symbols(
|
||||
&self,
|
||||
@@ -234,7 +239,7 @@ fn network_error(error: reqwest::Error) -> HostError {
|
||||
}
|
||||
source = e.source();
|
||||
}
|
||||
HostError::Failed(error.to_string())
|
||||
HostError::Failed(ide_http::client::describe(&error))
|
||||
}
|
||||
|
||||
fn redirect_capability(from: &reqwest::Url, to: &reqwest::Url) -> Result<Capability, String> {
|
||||
@@ -1551,13 +1556,8 @@ impl HostApi for PluginApi {
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
fn open_diff(
|
||||
&self,
|
||||
client: &str,
|
||||
diff: ide_plugin::ContentDiff,
|
||||
file_name: Option<String>,
|
||||
) -> Result<(), HostError> {
|
||||
super::execution::validate_diff(&diff)?;
|
||||
fn open_diff(&self, client: &str, diff: ide_plugin::FileDiff, file_name: Option<String>) -> Result<(), HostError> {
|
||||
super::execution::validate_file_diff(&diff)?;
|
||||
if let Some(name) = &file_name {
|
||||
super::execution::label(name, 256)?;
|
||||
}
|
||||
@@ -2229,6 +2229,20 @@ impl HostApi for PluginApi {
|
||||
Ok(result.to_string())
|
||||
}
|
||||
|
||||
fn build_dependencies(
|
||||
&self,
|
||||
root: &Path,
|
||||
module: Option<&str>,
|
||||
) -> Result<Vec<ide_plugin::DependencyNode>, HostError> {
|
||||
self.require_api("`build`", 10)?;
|
||||
let workspace = self.shared.workspace().ok_or_else(|| HostError::NotFound("no project is open".into()))?;
|
||||
// The graph comes from running the project's build, as `vcs.read` does git.
|
||||
if !workspace.trusted(root) {
|
||||
return Err(HostError::Denied("project is not trusted".into()));
|
||||
}
|
||||
super::build_graph::dependency_nodes(&workspace.build_graph(root)?, module)
|
||||
}
|
||||
|
||||
fn find_files(&self, root: &Path, glob: &str, limit: usize) -> Result<Vec<String>, HostError> {
|
||||
let matcher = globset::GlobBuilder::new(glob)
|
||||
.literal_separator(true)
|
||||
@@ -3379,6 +3393,13 @@ impl PluginWorkspace for HostWorkspace {
|
||||
})
|
||||
}
|
||||
|
||||
fn build_graph(&self, root: &Path) -> Result<super::BuildGraph, HostError> {
|
||||
let host = self.0.upgrade().ok_or(HostError::Cancelled)?;
|
||||
let project = HostWorkspace::project_covering(self, root)
|
||||
.ok_or_else(|| HostError::NotFound("the project is no longer open".into()))?;
|
||||
crate::ops::build::analyzed_dependencies(&project, &host.config_dir, root).map_err(failed)
|
||||
}
|
||||
|
||||
fn trusted(&self, root: &Path) -> bool {
|
||||
// A workspace member is as trusted as the group's project it was opened with.
|
||||
HostWorkspace::project_covering(self, root).is_some_and(|p| p.is_trusted())
|
||||
|
||||
@@ -0,0 +1,337 @@
|
||||
//! `build.dependencies`: the Dependency Analyzer's Maven / Gradle trees as the flat
|
||||
//! list the plugin API passes (records can't nest), each module a root.
|
||||
|
||||
use ide_build::{GradleDependency, GradleReport, MavenDependency, MavenProject, Omission};
|
||||
use ide_plugin::{DependencyNode, DependencyStatus, HostError};
|
||||
|
||||
/// Most nodes one call returns.
|
||||
const MAX_NODES: usize = 100_000;
|
||||
|
||||
/// What the IDE has resolved of a project's builds, without running a build tool.
|
||||
#[derive(Clone, Debug, Default)]
|
||||
pub struct BuildGraph {
|
||||
/// Maven modules with their dependencies (with the transitive ones after a sync).
|
||||
pub maven: Vec<MavenProject>,
|
||||
pub gradle: Vec<GradleModule>,
|
||||
}
|
||||
|
||||
/// A Gradle project and the reports the Dependency Analyzer read for it.
|
||||
#[derive(Clone, Debug, Default)]
|
||||
pub struct GradleModule {
|
||||
/// Gradle path (`:`, `:app`).
|
||||
pub path: String,
|
||||
/// One per configuration read.
|
||||
pub reports: Vec<GradleReport>,
|
||||
}
|
||||
|
||||
/// The graph of `module` (a Maven `groupId:artifactId` or a Gradle path), or of every module.
|
||||
pub fn dependency_nodes(graph: &BuildGraph, module: Option<&str>) -> Result<Vec<DependencyNode>, HostError> {
|
||||
let mut out = Nodes(Vec::new());
|
||||
let mut found = false;
|
||||
for p in graph.maven.iter().filter(|p| module.is_none_or(|m| m == p.key())) {
|
||||
found = true;
|
||||
let root = out.push(DependencyNode {
|
||||
group: p.group_id.clone(),
|
||||
artifact: p.artifact_id.clone(),
|
||||
version: p.version.clone(),
|
||||
scope: String::new(),
|
||||
status: DependencyStatus::Resolved,
|
||||
requested_version: None,
|
||||
parent: None,
|
||||
})?;
|
||||
out.maven(&p.dependencies, root)?;
|
||||
}
|
||||
for g in graph.gradle.iter().filter(|g| module.is_none_or(|m| m == g.path)) {
|
||||
found = true;
|
||||
let root = out.push(DependencyNode {
|
||||
group: String::new(),
|
||||
artifact: g.path.clone(),
|
||||
version: String::new(),
|
||||
scope: String::new(),
|
||||
status: DependencyStatus::Resolved,
|
||||
requested_version: None,
|
||||
parent: None,
|
||||
})?;
|
||||
for report in &g.reports {
|
||||
out.gradle(&report.dependencies, &report.configuration, root)?;
|
||||
}
|
||||
}
|
||||
match module {
|
||||
Some(m) if !found => Err(HostError::NotFound(format!("no Maven or Gradle module `{m}` in this project"))),
|
||||
_ => Ok(out.0),
|
||||
}
|
||||
}
|
||||
|
||||
struct Nodes(Vec<DependencyNode>);
|
||||
|
||||
impl Nodes {
|
||||
fn push(&mut self, node: DependencyNode) -> Result<u32, HostError> {
|
||||
if self.0.len() >= MAX_NODES {
|
||||
return Err(HostError::Failed(format!(
|
||||
"the dependency graph has more than {MAX_NODES} nodes; ask for one module"
|
||||
)));
|
||||
}
|
||||
self.0.push(node);
|
||||
Ok((self.0.len() - 1) as u32)
|
||||
}
|
||||
|
||||
fn maven(&mut self, deps: &[MavenDependency], parent: u32) -> Result<(), HostError> {
|
||||
for d in deps {
|
||||
let version = d.version.clone().unwrap_or_default();
|
||||
let (status, version, requested) = match d.omitted {
|
||||
// `version` lost to `conflict_with`.
|
||||
Some(Omission::Conflict) => (
|
||||
DependencyStatus::OmittedForConflict,
|
||||
d.conflict_with.clone().unwrap_or_else(|| version.clone()),
|
||||
Some(version),
|
||||
),
|
||||
Some(Omission::Duplicate | Omission::Cycle) => {
|
||||
(DependencyStatus::OmittedForDuplicate, version, d.managed_from.clone())
|
||||
}
|
||||
None if d.managed_from.is_some() => (DependencyStatus::VersionManaged, version, d.managed_from.clone()),
|
||||
None => (DependencyStatus::Resolved, version, None),
|
||||
};
|
||||
let index = self.push(DependencyNode {
|
||||
group: d.group_id.clone(),
|
||||
artifact: d.artifact_id.clone(),
|
||||
requested_version: requested.filter(|r| *r != version),
|
||||
version,
|
||||
scope: d.scope.clone(),
|
||||
status,
|
||||
parent: Some(parent),
|
||||
})?;
|
||||
self.maven(&d.children, index)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn gradle(&mut self, deps: &[GradleDependency], configuration: &str, parent: u32) -> Result<(), HostError> {
|
||||
// A constraint is not a dependency: it occurs as one elsewhere in the tree.
|
||||
for d in deps.iter().filter(|d| !d.constraint) {
|
||||
let (status, version, requested) = if d.project || d.unresolved {
|
||||
(DependencyStatus::Resolved, String::new(), None)
|
||||
} else {
|
||||
match (&d.requested, &d.selected) {
|
||||
(_, None) => (DependencyStatus::Resolved, d.requested.clone().unwrap_or_default(), None),
|
||||
// A platform or a constraint supplies the version.
|
||||
(None, Some(selected)) => (DependencyStatus::VersionManaged, selected.clone(), None),
|
||||
// Conflict resolution picked another version than this exact request.
|
||||
(Some(requested), Some(selected)) if exact_version(requested) => {
|
||||
(DependencyStatus::OmittedForConflict, selected.clone(), Some(requested.clone()))
|
||||
}
|
||||
// A range or a rich version (`1.+`, `{strictly 2.0}`) resolved as asked.
|
||||
(Some(requested), Some(selected)) => {
|
||||
(DependencyStatus::Resolved, selected.clone(), Some(requested.clone()))
|
||||
}
|
||||
}
|
||||
};
|
||||
let status = if d.repeated && status == DependencyStatus::Resolved {
|
||||
DependencyStatus::OmittedForDuplicate
|
||||
} else {
|
||||
status
|
||||
};
|
||||
let index = self.push(DependencyNode {
|
||||
group: d.group.clone(),
|
||||
artifact: d.name.clone(),
|
||||
requested_version: requested.filter(|r| *r != version),
|
||||
version,
|
||||
scope: configuration.to_owned(),
|
||||
status,
|
||||
parent: Some(parent),
|
||||
})?;
|
||||
self.gradle(&d.children, configuration, index)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// `1.2.3`, not a range, dynamic or rich version (`[1,2)`, `1.+`, `latest.release`, `{strictly 1}`).
|
||||
fn exact_version(v: &str) -> bool {
|
||||
!v.is_empty() && !v.starts_with("latest.") && !v.contains(['[', ']', '(', ')', ',', '+', '{', '}', ' '])
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn maven(group: &str, artifact: &str, version: &str, scope: &str) -> MavenDependency {
|
||||
MavenDependency {
|
||||
group_id: group.into(),
|
||||
artifact_id: artifact.into(),
|
||||
version: Some(version.into()),
|
||||
kind: "jar".into(),
|
||||
scope: scope.into(),
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
fn gradle(group: &str, name: &str, requested: Option<&str>, selected: Option<&str>) -> GradleDependency {
|
||||
GradleDependency {
|
||||
group: group.into(),
|
||||
name: name.into(),
|
||||
requested: requested.map(Into::into),
|
||||
selected: selected.map(Into::into),
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// (group, artifact, version, scope, status, requested, parent) of every node.
|
||||
type Row<'a> = (&'a str, &'a str, &'a str, &'a str, DependencyStatus, Option<&'a str>, Option<u32>);
|
||||
|
||||
fn rows(nodes: &[DependencyNode]) -> Vec<Row<'_>> {
|
||||
nodes
|
||||
.iter()
|
||||
.map(|n| {
|
||||
(
|
||||
n.group.as_str(),
|
||||
n.artifact.as_str(),
|
||||
n.version.as_str(),
|
||||
n.scope.as_str(),
|
||||
n.status,
|
||||
n.requested_version.as_deref(),
|
||||
n.parent,
|
||||
)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn graph() -> BuildGraph {
|
||||
let mut lang3_lost = maven("org.apache.commons", "commons-lang3", "3.12.0", "compile");
|
||||
lang3_lost.omitted = Some(Omission::Conflict);
|
||||
lang3_lost.conflict_with = Some("3.14.0".into());
|
||||
let mut text = maven("org.apache.commons", "commons-text", "1.11.0", "compile");
|
||||
text.children = vec![lang3_lost];
|
||||
let mut logging = maven("commons-logging", "commons-logging", "1.3.0", "compile");
|
||||
logging.managed_from = Some("1.2".into());
|
||||
let mut junit_again = maven("junit", "junit", "4.13.2", "test");
|
||||
junit_again.omitted = Some(Omission::Duplicate);
|
||||
let mut hamcrest = maven("org.hamcrest", "hamcrest", "2.2", "test");
|
||||
hamcrest.children = vec![junit_again];
|
||||
let app = MavenProject {
|
||||
group_id: "com.example".into(),
|
||||
artifact_id: "app".into(),
|
||||
version: "1.0".into(),
|
||||
dependencies: vec![
|
||||
maven("org.apache.commons", "commons-lang3", "3.14.0", "compile"),
|
||||
text,
|
||||
logging,
|
||||
hamcrest,
|
||||
],
|
||||
..Default::default()
|
||||
};
|
||||
let mut databind = gradle("com.fasterxml.jackson.core", "jackson-databind", Some("2.15.0"), Some("2.15.3"));
|
||||
databind.repeated = true;
|
||||
let mut web = gradle("org.springframework.boot", "spring-boot-starter-web", None, Some("3.2.0"));
|
||||
web.children = vec![databind];
|
||||
let mut constraint = gradle("com.google.guava", "guava", Some("32.1.3-jre"), None);
|
||||
constraint.constraint = true;
|
||||
let mut core = gradle("", ":core", None, None);
|
||||
core.project = true;
|
||||
core.children = vec![constraint];
|
||||
let mut failed = gradle("org.missing", "gone", Some("9"), None);
|
||||
failed.unresolved = true;
|
||||
let report = GradleReport {
|
||||
project: ":web".into(),
|
||||
configuration: "runtimeClasspath".into(),
|
||||
dependencies: vec![
|
||||
web,
|
||||
core,
|
||||
gradle("org.slf4j", "slf4j-api", Some("2.+"), Some("2.0.13")),
|
||||
gradle("org.yaml", "snakeyaml", Some("2.2"), None),
|
||||
failed,
|
||||
],
|
||||
};
|
||||
BuildGraph {
|
||||
maven: vec![app],
|
||||
gradle: vec![
|
||||
GradleModule { path: ":web".into(), reports: vec![report] },
|
||||
GradleModule { path: ":".into(), reports: Vec::new() },
|
||||
],
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn modules_are_roots_with_their_trees_flattened_under_them() {
|
||||
use DependencyStatus::*;
|
||||
let nodes = dependency_nodes(&graph(), None).unwrap();
|
||||
assert_eq!(
|
||||
rows(&nodes),
|
||||
[
|
||||
("com.example", "app", "1.0", "", Resolved, None, None),
|
||||
("org.apache.commons", "commons-lang3", "3.14.0", "compile", Resolved, None, Some(0)),
|
||||
("org.apache.commons", "commons-text", "1.11.0", "compile", Resolved, None, Some(0)),
|
||||
(
|
||||
"org.apache.commons",
|
||||
"commons-lang3",
|
||||
"3.14.0",
|
||||
"compile",
|
||||
OmittedForConflict,
|
||||
Some("3.12.0"),
|
||||
Some(2)
|
||||
),
|
||||
("commons-logging", "commons-logging", "1.3.0", "compile", VersionManaged, Some("1.2"), Some(0)),
|
||||
("org.hamcrest", "hamcrest", "2.2", "test", Resolved, None, Some(0)),
|
||||
("junit", "junit", "4.13.2", "test", OmittedForDuplicate, None, Some(5)),
|
||||
("", ":web", "", "", Resolved, None, None),
|
||||
(
|
||||
"org.springframework.boot",
|
||||
"spring-boot-starter-web",
|
||||
"3.2.0",
|
||||
"runtimeClasspath",
|
||||
VersionManaged,
|
||||
None,
|
||||
Some(7)
|
||||
),
|
||||
(
|
||||
"com.fasterxml.jackson.core",
|
||||
"jackson-databind",
|
||||
"2.15.3",
|
||||
"runtimeClasspath",
|
||||
OmittedForConflict,
|
||||
Some("2.15.0"),
|
||||
Some(8)
|
||||
),
|
||||
("", ":core", "", "runtimeClasspath", Resolved, None, Some(7)),
|
||||
("org.slf4j", "slf4j-api", "2.0.13", "runtimeClasspath", Resolved, Some("2.+"), Some(7)),
|
||||
("org.yaml", "snakeyaml", "2.2", "runtimeClasspath", Resolved, None, Some(7)),
|
||||
("org.missing", "gone", "", "runtimeClasspath", Resolved, None, Some(7)),
|
||||
("", ":", "", "", Resolved, None, None),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn one_module_by_its_maven_key_or_gradle_path() {
|
||||
let maven = dependency_nodes(&graph(), Some("com.example:app")).unwrap();
|
||||
assert_eq!((maven.len(), maven[0].artifact.as_str()), (7, "app"));
|
||||
let gradle = dependency_nodes(&graph(), Some(":web")).unwrap();
|
||||
assert_eq!((gradle.len(), gradle[0].artifact.as_str(), gradle[1].parent), (7, ":web", Some(0)));
|
||||
// A Gradle project with no report read yet is known, with nothing under it.
|
||||
assert_eq!(dependency_nodes(&graph(), Some(":")).unwrap().len(), 1);
|
||||
let err = dependency_nodes(&graph(), Some("app")).unwrap_err();
|
||||
assert!(matches!(err, HostError::NotFound(_)), "{err:?}");
|
||||
assert!(dependency_nodes(&BuildGraph::default(), None).unwrap().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_graph_too_large_for_one_call_fails() {
|
||||
let app = MavenProject {
|
||||
group_id: "g".into(),
|
||||
artifact_id: "a".into(),
|
||||
dependencies: vec![maven("g", "d", "1", "compile"); MAX_NODES],
|
||||
..Default::default()
|
||||
};
|
||||
let graph = BuildGraph { maven: vec![app], gradle: Vec::new() };
|
||||
assert!(matches!(dependency_nodes(&graph, None), Err(HostError::Failed(_))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn exact_versions() {
|
||||
for v in ["1.0", "32.1.3-jre", "2.15.0"] {
|
||||
assert!(exact_version(v), "{v}");
|
||||
}
|
||||
for v in ["", "1.+", "[1.0,2.0)", "latest.release", "{strictly 1.0}"] {
|
||||
assert!(!exact_version(v), "{v}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -91,12 +91,31 @@ fn diff_side(value: &str, side: &str) -> Result<(), HostError> {
|
||||
}
|
||||
|
||||
pub(super) fn validate_diff(diff: &ide_plugin::ContentDiff) -> Result<(), HostError> {
|
||||
diff_side(&diff.left, "left")?;
|
||||
diff_side(&diff.right, "right")?;
|
||||
for value in [&diff.left_label, &diff.right_label].into_iter().flatten() {
|
||||
validate_diff_parts([Some(&diff.left), Some(&diff.right)], [&diff.left_label, &diff.right_label], &diff.title)
|
||||
}
|
||||
|
||||
/// A `None` side doesn't exist (an added or deleted file); at least one side does.
|
||||
pub(super) fn validate_file_diff(diff: &ide_plugin::FileDiff) -> Result<(), HostError> {
|
||||
validate_diff_parts([diff.left.as_ref(), diff.right.as_ref()], [&diff.left_label, &diff.right_label], &diff.title)
|
||||
}
|
||||
|
||||
fn validate_diff_parts(
|
||||
sides: [Option<&String>; 2],
|
||||
labels: [&Option<String>; 2],
|
||||
title: &Option<String>,
|
||||
) -> Result<(), HostError> {
|
||||
if sides.iter().all(Option::is_none) {
|
||||
return Err(HostError::Invalid("a diff needs at least one side".into()));
|
||||
}
|
||||
for (value, side) in sides.into_iter().zip(["left", "right"]) {
|
||||
if let Some(value) = value {
|
||||
diff_side(value, side)?;
|
||||
}
|
||||
}
|
||||
for value in labels.into_iter().flatten() {
|
||||
label(value, 128)?;
|
||||
}
|
||||
if let Some(title) = &diff.title {
|
||||
if let Some(title) = title {
|
||||
label(title, 256)?;
|
||||
}
|
||||
Ok(())
|
||||
@@ -713,6 +732,28 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_file_diff_may_miss_one_side_but_not_both() {
|
||||
let side = |left: Option<&str>, right: Option<&str>| ide_plugin::FileDiff {
|
||||
left: left.map(Into::into),
|
||||
right: right.map(Into::into),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(validate_file_diff(&side(None, Some("added\n"))).is_ok());
|
||||
assert!(validate_file_diff(&side(Some("deleted\n"), None)).is_ok());
|
||||
assert!(validate_file_diff(&side(Some(""), Some(""))).is_ok());
|
||||
assert!(
|
||||
matches!(validate_file_diff(&side(None, None)), Err(HostError::Invalid(m)) if m == "a diff needs at least one side")
|
||||
);
|
||||
let huge = "y".repeat(MAX_DIFF_SIDE + 1);
|
||||
assert!(
|
||||
matches!(validate_file_diff(&side(None, Some(&huge))), Err(HostError::Invalid(m)) if m == "diff too large: the right side is over 8 MiB")
|
||||
);
|
||||
assert!(
|
||||
matches!(validate_file_diff(&side(Some("a\0"), None)), Err(HostError::Invalid(m)) if m.contains("NUL"))
|
||||
);
|
||||
}
|
||||
|
||||
fn launch(
|
||||
env: Vec<(&str, &str)>,
|
||||
debugger: Option<ide_plugin::PluginDebugger>,
|
||||
|
||||
@@ -0,0 +1,250 @@
|
||||
//! The `javaAgents` extension point (API 1.10): a Java agent the host loads into the
|
||||
//! JVM of Application, Spring Boot and JAR Application configurations.
|
||||
//!
|
||||
//! ```toml
|
||||
//! [[contributes.javaAgents]]
|
||||
//! path = "agent/openidea-spring-agent.jar" # inside the package
|
||||
//! args = "optional-arguments" # optional
|
||||
//! ```
|
||||
//!
|
||||
//! One agent per plugin. The declaration derives the optional high-risk `java.agent`
|
||||
//! capability; granting it records the jar's hash, and a launch adds the agent only
|
||||
//! while the jar still has it ([`ide_run::java_agent`]).
|
||||
|
||||
use ide_extension::{Capability, Disposable, ExtensionPoint, Manifest, Package, Placement, Prepared, decode};
|
||||
use ide_language::ProgramPin;
|
||||
use ide_run::java_agent::{ContributedAgent, JavaAgentSource};
|
||||
use parking_lot::RwLock;
|
||||
use serde::Deserialize;
|
||||
use std::collections::HashMap;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::{AtomicU64, Ordering};
|
||||
|
||||
pub const POINT_ID: &str = "javaAgents";
|
||||
const MAX_ARGS: usize = 4096;
|
||||
|
||||
#[derive(Clone, Debug, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct Decl {
|
||||
path: PathBuf,
|
||||
#[serde(default)]
|
||||
args: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
struct Agent {
|
||||
/// The jar, resolved inside the package.
|
||||
jar: PathBuf,
|
||||
args: Option<String>,
|
||||
}
|
||||
|
||||
/// Agents of enabled plugins.
|
||||
#[derive(Default)]
|
||||
pub struct JavaAgents {
|
||||
items: RwLock<Vec<(u64, String, Agent)>>,
|
||||
seq: AtomicU64,
|
||||
}
|
||||
|
||||
impl JavaAgents {
|
||||
fn add(self: &Arc<Self>, plugin: String, agent: Agent) -> Disposable {
|
||||
let seq = self.seq.fetch_add(1, Ordering::Relaxed);
|
||||
self.items.write().push((seq, plugin, agent));
|
||||
let weak = Arc::downgrade(self);
|
||||
Disposable::new(move || {
|
||||
if let Some(this) = weak.upgrade() {
|
||||
this.items.write().retain(|(s, _, _)| *s != seq);
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
pub struct JavaAgentsPoint {
|
||||
store: Arc<JavaAgents>,
|
||||
}
|
||||
|
||||
impl JavaAgentsPoint {
|
||||
pub fn new(store: Arc<JavaAgents>) -> Self {
|
||||
Self { store }
|
||||
}
|
||||
}
|
||||
|
||||
impl ExtensionPoint for JavaAgentsPoint {
|
||||
fn id(&self) -> &'static str {
|
||||
POINT_ID
|
||||
}
|
||||
|
||||
fn placement(&self) -> Placement {
|
||||
Placement::Workspace
|
||||
}
|
||||
|
||||
fn prepare(&self, pkg: &Package, decl: toml::Value) -> Result<Prepared, String> {
|
||||
pkg.manifest.needs_api("contributes.javaAgents", 10)?;
|
||||
if pkg.manifest.declarations(POINT_ID).len() > 1 {
|
||||
return Err("contributes.javaAgents: a plugin contributes at most one Java agent".into());
|
||||
}
|
||||
let d: Decl = decode(POINT_ID, decl)?;
|
||||
let jar = resolve(&pkg.dir, &d.path)?;
|
||||
let args = d.args.filter(|a| !a.is_empty());
|
||||
if let Some(args) = &args
|
||||
&& (args.len() > MAX_ARGS || args.contains(|c: char| c.is_control()))
|
||||
{
|
||||
return Err(format!("contributes.javaAgents: `args` must be one line of at most {MAX_ARGS} bytes"));
|
||||
}
|
||||
let label = label(&d.path, args.as_deref());
|
||||
let (store, plugin) = (self.store.clone(), pkg.id().to_owned());
|
||||
let agent = Agent { jar, args };
|
||||
Ok(Prepared::new(label, move || Ok(store.add(plugin, agent))).file(d.path).capability(Capability::JavaAgent))
|
||||
}
|
||||
}
|
||||
|
||||
/// What Settings › Plugins shows: the jar's file name and its arguments, as `-javaagent:` takes them.
|
||||
fn label(path: &Path, args: Option<&str>) -> String {
|
||||
let name = path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default();
|
||||
match args {
|
||||
Some(args) => format!("{name}={args}"),
|
||||
None => name,
|
||||
}
|
||||
}
|
||||
|
||||
/// The jar a package's declaration names, as an absolute path inside the package:
|
||||
/// `..`, absolute paths and symlinks that lead out of it are refused.
|
||||
fn resolve(dir: &Path, rel: &Path) -> Result<PathBuf, String> {
|
||||
ide_extension::check_relative(rel, "contributes.javaAgents: `path`")?;
|
||||
let root = dunce::canonicalize(dir).map_err(|e| format!("plugin directory: {e}"))?;
|
||||
let jar = dunce::canonicalize(dir.join(rel))
|
||||
.map_err(|_| format!("contributes.javaAgents: {}: no such file in the plugin", rel.display()))?;
|
||||
if !jar.starts_with(&root) {
|
||||
return Err(format!("contributes.javaAgents: {}: points outside the plugin", rel.display()));
|
||||
}
|
||||
if !jar.is_file() {
|
||||
return Err(format!("contributes.javaAgents: {}: not a file", rel.display()));
|
||||
}
|
||||
Ok(jar)
|
||||
}
|
||||
|
||||
/// The jar the package at `dir` declares, for recording its hash when `java.agent`
|
||||
/// is granted (before the declaration has taken effect, as on install).
|
||||
pub(super) fn declared_jar(manifest: &Manifest, dir: &Path) -> Option<PathBuf> {
|
||||
let decl = manifest.declarations(POINT_ID).into_iter().next()?;
|
||||
let d: Decl = decode(POINT_ID, decl).ok()?;
|
||||
resolve(dir, &d.path).ok()
|
||||
}
|
||||
|
||||
type Pins = Arc<RwLock<HashMap<(String, String), ProgramPin>>>;
|
||||
|
||||
/// [`JavaAgentSource`] over the agents and the hashes granted for them.
|
||||
pub struct PluginJavaAgents {
|
||||
pub(super) store: Arc<JavaAgents>,
|
||||
pub(super) pins: Pins,
|
||||
}
|
||||
|
||||
impl JavaAgentSource for PluginJavaAgents {
|
||||
fn agents(&self) -> Vec<ContributedAgent> {
|
||||
let cap = Capability::JavaAgent.to_string();
|
||||
let pins = self.pins.read();
|
||||
self.store
|
||||
.items
|
||||
.read()
|
||||
.iter()
|
||||
.map(|(_, plugin, agent)| ContributedAgent {
|
||||
plugin: plugin.clone(),
|
||||
jar: agent.jar.clone(),
|
||||
args: agent.args.clone(),
|
||||
approved_hash: pins.get(&(plugin.clone(), cap.clone())).map(|pin| pin.hash.clone()),
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
const MANIFEST: &str =
|
||||
"id = \"acme.spring\"\nname = \"Spring\"\nversion = \"1.0.0\"\nengines.openidea = \"^1.10\"\n";
|
||||
|
||||
fn package(dir: &Path, manifest: &str) -> Package {
|
||||
std::fs::create_dir_all(dir.join("agent")).unwrap();
|
||||
std::fs::write(dir.join("agent/spring agent.jar"), b"PK").unwrap();
|
||||
Package::new(Manifest::parse(manifest).unwrap(), dir.to_path_buf())
|
||||
}
|
||||
|
||||
fn prepare(pkg: &Package) -> Result<Prepared, String> {
|
||||
let point = JavaAgentsPoint::new(Arc::default());
|
||||
let decls = pkg.manifest.declarations(POINT_ID);
|
||||
let mut last = Err("no declaration".into());
|
||||
for decl in decls {
|
||||
last = Ok(point.prepare(pkg, decl)?);
|
||||
}
|
||||
last
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_the_declaration_and_derives_the_capability() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let toml = format!(
|
||||
"{MANIFEST}[[contributes.javaAgents]]\npath = \"agent/spring agent.jar\"\nargs = \"port=0,trace\"\n"
|
||||
);
|
||||
let pkg = package(tmp.path(), &toml);
|
||||
let prepared = prepare(&pkg).unwrap();
|
||||
assert_eq!(prepared.capabilities, [Capability::JavaAgent]);
|
||||
assert_eq!(prepared.files, [PathBuf::from("agent/spring agent.jar")]);
|
||||
assert_eq!(prepared.label, "spring agent.jar=port=0,trace");
|
||||
let jar = declared_jar(&pkg.manifest, &pkg.dir).unwrap();
|
||||
assert_eq!(jar, dunce::canonicalize(tmp.path().join("agent/spring agent.jar")).unwrap());
|
||||
|
||||
let store: Arc<JavaAgents> = Arc::default();
|
||||
let point = JavaAgentsPoint::new(store.clone());
|
||||
let decl = pkg.manifest.declarations(POINT_ID).remove(0);
|
||||
let disposable = (point.prepare(&pkg, decl).unwrap().commit)().unwrap();
|
||||
let source = PluginJavaAgents { store: store.clone(), pins: Arc::default() };
|
||||
let agents = source.agents();
|
||||
assert_eq!(agents.len(), 1);
|
||||
assert_eq!(
|
||||
(agents[0].plugin.as_str(), agents[0].args.as_deref(), agents[0].approved_hash.as_ref()),
|
||||
("acme.spring", Some("port=0,trace"), None)
|
||||
);
|
||||
source.pins.write().insert(("acme.spring".into(), "java.agent".into()), ProgramPin::approve(&jar).unwrap());
|
||||
assert!(source.agents()[0].approved_hash.is_some());
|
||||
disposable.dispose();
|
||||
assert!(source.agents().is_empty(), "disabling the plugin drops its agent");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn refuses_what_would_fail_at_launch() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let outside = tempfile::tempdir().unwrap();
|
||||
std::fs::write(outside.path().join("evil.jar"), b"PK").unwrap();
|
||||
let refused = |n: usize, manifest: &str| {
|
||||
let dir = tmp.path().join(n.to_string());
|
||||
prepare(&package(&dir, manifest)).map(|_| ()).unwrap_err()
|
||||
};
|
||||
let case = |n: usize, body: &str| refused(n, &format!("{MANIFEST}{body}"));
|
||||
let agent = |path: &str| format!("[[contributes.javaAgents]]\npath = \"{path}\"\n");
|
||||
assert!(case(0, &agent("../evil.jar")).contains("relative path inside the plugin"));
|
||||
assert!(case(1, &agent("/etc/passwd")).contains("relative path inside the plugin"));
|
||||
assert!(case(2, &agent("agent/missing.jar")).contains("no such file"));
|
||||
assert!(case(3, &agent("agent")).contains("not a file"));
|
||||
let two = format!("{}{}", agent("agent/spring agent.jar"), agent("agent/spring agent.jar"));
|
||||
assert!(case(4, &two).contains("at most one Java agent"));
|
||||
assert!(
|
||||
case(5, "[[contributes.javaAgents]]\npath = \"agent/spring agent.jar\"\nargs = \"a\\nb\"\n")
|
||||
.contains("one line")
|
||||
);
|
||||
assert!(
|
||||
case(6, "[[contributes.javaAgents]]\npath = \"agent/spring agent.jar\"\nmain = \"x\"\n")
|
||||
.contains("unknown field")
|
||||
);
|
||||
let old = format!("{}{}", MANIFEST.replace("^1.10", "^1.9"), agent("agent/spring agent.jar"));
|
||||
assert!(refused(7, &old).contains("new in plugin API 1.10"));
|
||||
#[cfg(unix)]
|
||||
{
|
||||
let dir = tmp.path().join("8");
|
||||
let pkg = package(&dir, &format!("{MANIFEST}{}", agent("agent/link.jar")));
|
||||
std::os::unix::fs::symlink(outside.path().join("evil.jar"), dir.join("agent/link.jar")).unwrap();
|
||||
assert!(prepare(&pkg).map(|_| ()).unwrap_err().contains("points outside the plugin"));
|
||||
assert_eq!(declared_jar(&pkg.manifest, &pkg.dir), None);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -134,7 +134,8 @@ fn read_remote(url: &str, max: usize, deadline: Duration) -> Result<Vec<u8>, Str
|
||||
super::api::net_runtime().block_on(async move {
|
||||
let failed = |e: reqwest::Error| match e.is_timeout() {
|
||||
true => format!("{url}: no answer in time"),
|
||||
false => format!("{url}: {e}"),
|
||||
// With its cause: "error sending request" alone does not say what failed.
|
||||
false => format!("{url}: {}", ide_http::client::describe(&e.without_url())),
|
||||
};
|
||||
let too_large = || format!("{url}: larger than {} MiB", max >> 20);
|
||||
let mut response = client.get(url).timeout(deadline).send().await.map_err(failed)?;
|
||||
@@ -587,6 +588,16 @@ mod tests {
|
||||
assert!(reachable_from("/srv/market/index.json", "/srv/market/a.oiplugin"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_failed_read_says_why() {
|
||||
// A port nothing listens on: refused.
|
||||
let port = std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port();
|
||||
let url = format!("http://127.0.0.1:{port}/a.oiplugin");
|
||||
let err = read_url(&url, 1 << 20).unwrap_err();
|
||||
assert_eq!(err.matches(&url).count(), 1, "{err}");
|
||||
assert!(err.to_lowercase().contains("refused"), "{err}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_server_that_stops_answering_does_not_hold_the_read() {
|
||||
use std::io::{BufRead, BufReader, Write};
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
|
||||
mod api;
|
||||
mod auth;
|
||||
mod build_graph;
|
||||
pub mod commands;
|
||||
pub mod commit;
|
||||
mod database;
|
||||
@@ -37,6 +38,7 @@ mod inlay_hints;
|
||||
mod install;
|
||||
pub mod intellij;
|
||||
mod ipc;
|
||||
mod java_agents;
|
||||
pub mod language_features;
|
||||
mod market;
|
||||
mod mcp;
|
||||
@@ -58,6 +60,7 @@ pub mod web;
|
||||
mod websocket;
|
||||
|
||||
pub use api::{FileSecretStore, HostWorkspace, PluginWorkspace, SecretStore};
|
||||
pub use build_graph::{BuildGraph, GradleModule};
|
||||
pub(crate) use hover::merge as merge_hover;
|
||||
pub use icons::{
|
||||
MAX_PLUGIN_ICON, map_asset as icon_theme_map_asset, plugin_icon, sanitize_svg, svg_prefix as icon_theme_svg_prefix,
|
||||
@@ -378,6 +381,8 @@ pub struct PluginHost {
|
||||
ui: Arc<UiStore>,
|
||||
languages: Arc<PluginLanguages>,
|
||||
run_detectors: Arc<run_detectors::RunDetectors>,
|
||||
/// `[[contributes.javaAgents]]` of enabled plugins.
|
||||
java_agents: Arc<java_agents::JavaAgents>,
|
||||
/// `[[contributes.providers]]` of enabled plugins.
|
||||
providers: Arc<providers::Providers>,
|
||||
navigation: Mutex<navigation::NavigationIndex>,
|
||||
@@ -457,7 +462,9 @@ impl PluginHost {
|
||||
let languages = PluginLanguages::new();
|
||||
let run_detectors: Arc<run_detectors::RunDetectors> = Arc::default();
|
||||
let providers: Arc<providers::Providers> = Arc::default();
|
||||
register_builtin_points(®istry, &ui, &languages, &run_detectors, &providers).map_err(IdeError::internal)?;
|
||||
let java_agents: Arc<java_agents::JavaAgents> = Arc::default();
|
||||
register_builtin_points(®istry, &ui, &languages, &run_detectors, &java_agents, &providers)
|
||||
.map_err(IdeError::internal)?;
|
||||
let pins: Arc<RwLock<HashMap<(String, String), ProgramPin>>> = Arc::default();
|
||||
let policy_pins = pins.clone();
|
||||
languages.set_process_policy(Arc::new(move |plugin, cap| {
|
||||
@@ -491,6 +498,7 @@ impl PluginHost {
|
||||
ui,
|
||||
languages,
|
||||
run_detectors,
|
||||
java_agents,
|
||||
providers,
|
||||
navigation: Mutex::default(),
|
||||
endpoints: Mutex::default(),
|
||||
@@ -991,8 +999,8 @@ impl PluginHost {
|
||||
};
|
||||
// Consent covers what the install page showed.
|
||||
let request = request_for(&subject, &pkg.manifest, &hash, &set.capabilities);
|
||||
self.record_consent(&request, consent);
|
||||
let dir = install::active_dir(&root).ok_or_else(|| IdeError::internal("the installed version is missing"))?;
|
||||
self.record_consent(&request, consent, agent_jar_grant(&pkg.manifest, &dir));
|
||||
self.load_dir(&dir, PluginSource::Installed, None);
|
||||
if let Some(previous) = previous {
|
||||
let failed = self
|
||||
@@ -1110,7 +1118,7 @@ impl PluginHost {
|
||||
let hash = self.package_hash_of(&plugin);
|
||||
let extra = plugin.meta.lock().declared_extra.clone();
|
||||
let request = request_for(&plugin.subject(), plugin.manifest(), &hash, &extra);
|
||||
self.record_consent(&request, consent);
|
||||
self.record_consent(&request, consent, agent_jar_grant(plugin.manifest(), plugin.dir()));
|
||||
self.stop(&plugin);
|
||||
if !self.state.lock().disabled.contains(id) {
|
||||
self.start(&plugin);
|
||||
@@ -1160,6 +1168,12 @@ impl PluginHost {
|
||||
return Err(IdeError::invalid(format!("plugin {id:?} has not been confirmed yet")));
|
||||
}
|
||||
ledger.set(&subject, &cap, granted);
|
||||
if granted
|
||||
&& cap == Capability::JavaAgent
|
||||
&& let Some(jar) = agent_jar_grant(plugin.manifest(), plugin.dir())
|
||||
{
|
||||
ledger.set_binary(&subject, &cap, jar);
|
||||
}
|
||||
if granted
|
||||
&& let Capability::Process(program) = &cap
|
||||
&& let Some(bin) = ledger
|
||||
@@ -1696,6 +1710,11 @@ impl PluginHost {
|
||||
})
|
||||
}
|
||||
|
||||
/// Plugins' `javaAgents`, for [`ide_run::java_agent::set_java_agent_source`].
|
||||
pub fn java_agents(&self) -> Arc<dyn ide_run::java_agent::JavaAgentSource> {
|
||||
Arc::new(java_agents::PluginJavaAgents { store: self.java_agents.clone(), pins: self.pins.clone() })
|
||||
}
|
||||
|
||||
/// The syntax of plugin languages, for [`ide_language::set_external_syntax`].
|
||||
pub fn syntax_provider(self: &Arc<Self>) -> Arc<dyn ide_language::ExternalSyntax> {
|
||||
Arc::new(PluginSyntax(Arc::downgrade(self)))
|
||||
@@ -2933,7 +2952,7 @@ impl PluginHost {
|
||||
}
|
||||
let declared =
|
||||
plugin.manifest().capabilities.all().cloned().chain(plugin.meta.lock().declared_extra.clone());
|
||||
for cap in declared.filter(|c| matches!(c, Capability::Process(_))) {
|
||||
for cap in declared.filter(|c| matches!(c, Capability::Process(_) | Capability::JavaAgent)) {
|
||||
if let Some(bin) = ledger.pinned_binary(&subject, &cap) {
|
||||
pins.insert(
|
||||
(plugin.id().to_owned(), cap.to_string()),
|
||||
@@ -2994,7 +3013,9 @@ impl PluginHost {
|
||||
self.save_ledger(&ledger);
|
||||
}
|
||||
|
||||
fn record_consent(&self, request: &Request<'_>, consent: &Consent) {
|
||||
/// `agent_jar`: the jar of the plugin's `javaAgents` declaration, recorded when
|
||||
/// `java.agent` is accepted.
|
||||
fn record_consent(&self, request: &Request<'_>, consent: &Consent, agent_jar: Option<BinaryGrant>) {
|
||||
let accepted: Vec<Capability> = request.optional.iter().filter(|c| consent.accepts(c)).cloned().collect();
|
||||
let choices: BTreeMap<_, _> = {
|
||||
let ledger = self.ledger.lock();
|
||||
@@ -3016,6 +3037,7 @@ impl PluginHost {
|
||||
.get(&c.to_string())
|
||||
.map_or_else(|| self.resolve_binary(program), |path| ledger::approve_program(path).ok())
|
||||
.map(|b| (c.to_string(), b)),
|
||||
Capability::JavaAgent => agent_jar.clone().map(|jar| (c.to_string(), jar)),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
@@ -3094,6 +3116,13 @@ impl Drop for PluginHost {
|
||||
}
|
||||
}
|
||||
|
||||
/// The jar of a package's `javaAgents` declaration with its hash now, for a `java.agent` grant.
|
||||
fn agent_jar_grant(manifest: &Manifest, dir: &Path) -> Option<BinaryGrant> {
|
||||
let path = java_agents::declared_jar(manifest, dir)?;
|
||||
let hash = ledger::file_hash(&path).map_err(|e| tracing::info!("java.agent: {}: {e}", path.display())).ok()?;
|
||||
Some(BinaryGrant { path, hash })
|
||||
}
|
||||
|
||||
fn request_for<'a>(subject: &Subject, m: &'a Manifest, hash: &'a str, declared: &[Capability]) -> Request<'a> {
|
||||
let mut optional = m.capabilities.optional.clone();
|
||||
// What declarations need (a language server's `process:`) is optional:
|
||||
|
||||
@@ -64,6 +64,7 @@ pub fn register_builtin_points(
|
||||
ui: &Arc<UiStore>,
|
||||
languages: &Arc<PluginLanguages>,
|
||||
run_detectors: &Arc<super::run_detectors::RunDetectors>,
|
||||
java_agents: &Arc<super::java_agents::JavaAgents>,
|
||||
providers: &Arc<super::providers::Providers>,
|
||||
) -> Result<(), String> {
|
||||
registry.register(Arc::new(UiPoint::new(COMMANDS, ui.clone(), command)))?;
|
||||
@@ -71,6 +72,7 @@ pub fn register_builtin_points(
|
||||
registry.register(Arc::new(LanguagesPoint::new(languages.clone())))?;
|
||||
registry.register(Arc::new(UiPoint::new(super::icons::POINT_ID, ui.clone(), super::icons::icon_theme)))?;
|
||||
registry.register(Arc::new(super::run_detectors::RunDetectorsPoint::new(run_detectors.clone())))?;
|
||||
registry.register(Arc::new(super::java_agents::JavaAgentsPoint::new(java_agents.clone())))?;
|
||||
registry.register(Arc::new(super::navigation::IndexersPoint))?;
|
||||
registry.register(Arc::new(super::providers::ProvidersPoint::new(providers.clone())))?;
|
||||
registry.register(Arc::new(UiPoint::new(super::providers::SECRETS_POINT, ui.clone(), super::providers::secret)))?;
|
||||
|
||||
@@ -220,7 +220,7 @@ pub enum PluginEvent {
|
||||
ContentTabReply { plugin_id: String, request_id: String, reply: ide_plugin::ContentTabReply },
|
||||
/// Open two texts in this window's diff viewer.
|
||||
#[serde(rename_all = "camelCase")]
|
||||
OpenDiff { plugin_id: String, diff: ide_plugin::ContentDiff, file_name: Option<String> },
|
||||
OpenDiff { plugin_id: String, diff: ide_plugin::FileDiff, file_name: Option<String> },
|
||||
|
||||
/// Plugins, their status or their contributions changed: re-fetch `plugin_list`.
|
||||
CommandsChanged,
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
//! [[contributes.keymaps]]
|
||||
//! command = "check"
|
||||
//! key = "Ctrl+Alt+C" # `mac` for a different binding on macOS (`Meta+Alt+C`)
|
||||
//! # key = "Escape" + when = "…" # API 1.10: Escape in an editor that the IDE had no use for
|
||||
//!
|
||||
//! [[contributes.statusBar]]
|
||||
//! id = "branch"
|
||||
@@ -203,8 +204,16 @@ struct KeymapDecl {
|
||||
key: String,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
mac: Option<String>,
|
||||
/// Only with an `Escape` binding (API 1.10): when the command clears something.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
when: Option<String>,
|
||||
}
|
||||
|
||||
/// The one plain key a plugin may bind (API 1.10): in a focused editor, after the IDE's own uses of
|
||||
/// Escape (popups, completion, rename, selection, extra carets, Vim) found nothing to do, like a
|
||||
/// handler at the end of IDEA's EditorEscape chain.
|
||||
const ESCAPE: &str = "Escape";
|
||||
|
||||
const MODIFIERS: [&str; 4] = ["Meta", "Ctrl", "Alt", "Shift"];
|
||||
const NAMED_KEYS: [&str; 22] = [
|
||||
"Enter",
|
||||
@@ -262,9 +271,21 @@ pub fn validate_binding(binding: &str) -> Result<(), String> {
|
||||
pub(super) fn keymap(pkg: &Package, decl: toml::Value) -> Result<UiDecl, String> {
|
||||
let d: KeymapDecl = decode(KEYMAPS, decl)?;
|
||||
declared_command(pkg, KEYMAPS, &d.command)?;
|
||||
validate_binding(&d.key).map_err(|e| format!("contributes.keymaps: {e}"))?;
|
||||
if let Some(m) = &d.mac {
|
||||
validate_binding(m).map_err(|e| format!("contributes.keymaps: {e}"))?;
|
||||
let escape = d.key == ESCAPE || d.mac.as_deref() == Some(ESCAPE);
|
||||
if escape {
|
||||
if d.key != ESCAPE || d.mac.as_deref().is_some_and(|m| m != ESCAPE) {
|
||||
return Err("contributes.keymaps: an Escape binding is Escape on every platform".into());
|
||||
}
|
||||
pkg.manifest.needs_api("contributes.keymaps key = \"Escape\"", 10)?;
|
||||
let when = d.when.as_deref().ok_or("contributes.keymaps: an Escape binding needs a `when` clause")?;
|
||||
validate_when(when).map_err(|e| format!("contributes.keymaps: {e}"))?;
|
||||
} else if d.when.is_some() {
|
||||
return Err("contributes.keymaps: `when` is only for an Escape binding".into());
|
||||
}
|
||||
for binding in std::iter::once(&d.key).chain(&d.mac) {
|
||||
if binding != ESCAPE {
|
||||
validate_binding(binding).map_err(|e| format!("contributes.keymaps: {e}"))?;
|
||||
}
|
||||
}
|
||||
Ok(UiDecl::new(d.command.clone(), d.key.clone(), json(&d)?))
|
||||
}
|
||||
@@ -1114,6 +1135,37 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn escape_bindings_need_api_1_10_and_a_when_clause() {
|
||||
let pkg = |api: &str| {
|
||||
let manifest = ide_extension::Manifest::parse(&format!(
|
||||
"id='test'\nname='Test'\nversion='1.0.0'\nengines.openidea='{api}'\n[[contributes.commands]]\nid='clear'\ntitle='Clear'"
|
||||
))
|
||||
.unwrap();
|
||||
Package::new(manifest, std::path::PathBuf::from("/unused"))
|
||||
};
|
||||
let check = |api: &str, decl: &str| keymap(&pkg(api), toml::from_str(decl).unwrap());
|
||||
let escape = "command='clear'\nkey='Escape'\nwhen='plugin.test.active'";
|
||||
let ok = check("^1.10", escape).unwrap();
|
||||
assert_eq!(ok.json["when"], "plugin.test.active");
|
||||
assert!(check("^1.10", &format!("{escape}\nmac='Escape'")).is_ok());
|
||||
for (api, decl, error) in [
|
||||
("^1.9", escape, "1.10"),
|
||||
("^1.10", "command='clear'\nkey='Escape'", "when"),
|
||||
("^1.10", "command='clear'\nkey='Escape'\nwhen='a &&'", "when"),
|
||||
("^1.10", &format!("{escape}\nmac='Meta+K'") as &str, "every platform"),
|
||||
("^1.10", "command='clear'\nkey='Ctrl+K'\nmac='Escape'\nwhen='x'", "every platform"),
|
||||
("^1.10", "command='clear'\nkey='Ctrl+K'\nwhen='x'", "only for an Escape"),
|
||||
("^1.10", "command='clear'\nkey='Enter'", "needs Ctrl"),
|
||||
("^1.10", "command='clear'\nkey='Shift+Escape'", "needs Ctrl"),
|
||||
] {
|
||||
let err = check(api, decl).unwrap_err();
|
||||
assert!(err.contains(error), "{api} {decl}\n→ {err}");
|
||||
}
|
||||
// Other bindings are unchanged.
|
||||
assert!(check("^1.9", "command='clear'\nkey='Ctrl+Alt+C'").is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bindings_need_a_modifier() {
|
||||
for ok in ["Ctrl+Alt+C", "Meta+Shift+K", "F5", "Shift+F6", "Meta+K Meta+C", "Alt+Enter"] {
|
||||
|
||||
@@ -112,7 +112,7 @@ impl Host {
|
||||
let detected_roots = Arc::new(RwLock::new(ide_workspace::roots::detect(&root)));
|
||||
let excludes = exclude_globs(&root, &settings.effective(), &detected_roots.read());
|
||||
let build_cache = self.local_data_dir.join("cache").join(project_key(&root)).join("build");
|
||||
let extra_roots = content_roots(&settings.effective(), &root, &build_cache);
|
||||
let extra_roots = content_roots(&settings.effective(), &root, &build_cache, trusted.load(Ordering::Acquire));
|
||||
mark("roots");
|
||||
|
||||
// The project's own registry: File Types associations may be project-scoped.
|
||||
@@ -147,7 +147,9 @@ impl Host {
|
||||
lsp.set_content_roots(language_server_roots(&root, extra_roots.clone()));
|
||||
lsp.set_jdtls_import_roots(ide_build::maven_external_roots(
|
||||
&root,
|
||||
&settings.effective().languages.java.maven.linked_projects,
|
||||
&build_cache,
|
||||
&settings.effective().languages.java.maven,
|
||||
trusted.load(Ordering::Acquire),
|
||||
));
|
||||
let settings = Arc::new(settings);
|
||||
{
|
||||
@@ -177,6 +179,7 @@ impl Host {
|
||||
let root = member.as_ref().unwrap_or(window_root);
|
||||
ide_sdk::apply::server_launch_overrides(cfg, &effective);
|
||||
ide_sdk::apply::configure_server(cfg, root, server_root, &effective);
|
||||
ide_sdk::apply::configure_vue_module_resolution(cfg, &data_dir);
|
||||
crate::ops::sdk::container_python::configure_server(cfg, &data_dir, root, &effective);
|
||||
if cfg.name == "jdtls" {
|
||||
// A workspace member keeps its build model under its own key (Build Project).
|
||||
@@ -414,7 +417,10 @@ impl Host {
|
||||
// Detected excluded folders (`target`, `build`) leave the index too.
|
||||
let effective = settings.effective();
|
||||
index.set_scope(
|
||||
index_roots(&root, content_roots(&effective, &root, &build_cache)),
|
||||
index_roots(
|
||||
&root,
|
||||
content_roots(&effective, &root, &build_cache, trusted.load(Ordering::Acquire)),
|
||||
),
|
||||
exclude_globs(&root, &effective, &fresh),
|
||||
);
|
||||
*detected_roots.write() = fresh;
|
||||
@@ -457,7 +463,14 @@ impl Host {
|
||||
// through the `.git` paths above; this covers the whole tree being brought in.
|
||||
git_dirs |= batch.created.iter().any(|p| p.join(".git").exists());
|
||||
if git_dirs {
|
||||
scan_repositories(&root, &repos, &settings, &sink, &build_cache);
|
||||
scan_repositories(
|
||||
&root,
|
||||
&repos,
|
||||
&settings,
|
||||
&sink,
|
||||
&build_cache,
|
||||
trusted.load(Ordering::Acquire),
|
||||
);
|
||||
}
|
||||
let vcs_moved = batch.vcs.iter().any(|p| vcs_path_changed(p));
|
||||
if git_dirs || vcs_moved {
|
||||
@@ -543,9 +556,10 @@ impl Host {
|
||||
{
|
||||
let (root, repos, settings, sink) = (root.clone(), repos.clone(), settings.clone(), sink.clone());
|
||||
let build_cache = build_cache.clone();
|
||||
let trusted = trusted.load(Ordering::Acquire);
|
||||
std::thread::Builder::new()
|
||||
.name("openidea-vcs-roots".into())
|
||||
.spawn(move || scan_repositories(&root, &repos, &settings, &sink, &build_cache))?;
|
||||
.spawn(move || scan_repositories(&root, &repos, &settings, &sink, &build_cache, trusted))?;
|
||||
}
|
||||
mark("git");
|
||||
tracing::info!("opened {} in window {window} in {} ms {laps:?}", root.display(), started.elapsed().as_millis());
|
||||
@@ -906,8 +920,9 @@ fn scan_repositories(
|
||||
settings: &SettingsStore,
|
||||
sink: &SharedSink,
|
||||
build_cache: &Path,
|
||||
trusted: bool,
|
||||
) {
|
||||
match discover_repositories(root, settings, build_cache) {
|
||||
match discover_repositories(root, settings, build_cache, trusted) {
|
||||
Ok(found) => {
|
||||
if found.roots() != repos.read().roots() {
|
||||
*repos.write() = found;
|
||||
@@ -920,7 +935,7 @@ fn scan_repositories(
|
||||
|
||||
/// The repository containing `root` and those nested below it or below a content root.
|
||||
/// The project-open scan and the watcher's rescan share these skip rules.
|
||||
fn discover_repositories(root: &Path, settings: &SettingsStore, build_cache: &Path) -> IdeResult<Repos> {
|
||||
fn discover_repositories(root: &Path, settings: &SettingsStore, build_cache: &Path, trusted: bool) -> IdeResult<Repos> {
|
||||
let ignored = settings.effective().ignored_names();
|
||||
let skip = |p: &Path| {
|
||||
p.file_name().is_some_and(|n| {
|
||||
@@ -931,13 +946,20 @@ fn discover_repositories(root: &Path, settings: &SettingsStore, build_cache: &Pa
|
||||
})
|
||||
};
|
||||
let mut roots = vec![root.to_path_buf()];
|
||||
roots.extend(content_roots(&settings.effective(), root, build_cache));
|
||||
roots.extend(content_roots(&settings.effective(), root, build_cache, trusted));
|
||||
Repos::discover_roots(&roots, &skip)
|
||||
}
|
||||
|
||||
impl Project {
|
||||
pub fn refresh_repositories(&self) {
|
||||
scan_repositories(&self.root, &self.repos, &self.settings, &self.sink, &self.build_cache_dir());
|
||||
scan_repositories(
|
||||
&self.root,
|
||||
&self.repos,
|
||||
&self.settings,
|
||||
&self.sink,
|
||||
&self.build_cache_dir(),
|
||||
self.is_trusted(),
|
||||
);
|
||||
}
|
||||
|
||||
/// The project's git repositories.
|
||||
@@ -1203,7 +1225,7 @@ impl Project {
|
||||
|
||||
/// Project Structure content roots besides the project folder (existing directories).
|
||||
pub fn content_roots(&self) -> Vec<PathBuf> {
|
||||
content_roots(&self.settings.effective(), &self.root, &self.build_cache_dir())
|
||||
content_roots(&self.settings.effective(), &self.root, &self.build_cache_dir(), self.is_trusted())
|
||||
}
|
||||
|
||||
/// Applies Settings › File Types; open documents whose language changed are
|
||||
@@ -1227,7 +1249,9 @@ impl Project {
|
||||
self.lsp.set_content_roots(language_server_roots(&self.root, roots.clone()));
|
||||
self.lsp.set_jdtls_import_roots(ide_build::maven_external_roots(
|
||||
&self.root,
|
||||
&self.settings.effective().languages.java.maven.linked_projects,
|
||||
&self.build_cache_dir(),
|
||||
&self.settings.effective().languages.java.maven,
|
||||
self.is_trusted(),
|
||||
));
|
||||
self.index.set_scope(index_roots(&self.root, roots.clone()), excludes.clone());
|
||||
self.watcher.set_excludes(&excludes);
|
||||
@@ -1353,8 +1377,14 @@ pub(crate) fn workspace_member_roots(root: &Path) -> Vec<PathBuf> {
|
||||
/// Workspace members in manifest order, or the attached projects outside the project and
|
||||
/// those inside it that its walk skips as ignored (a git worktree under an ignored folder),
|
||||
/// extra Project Structure directories, Gradle project folders outside the project, and
|
||||
/// directories of Maven POMs linked from outside it (`build_cache` is the Gradle sync cache).
|
||||
fn content_roots(settings: &ide_core::settings::Settings, root: &Path, build_cache: &Path) -> Vec<PathBuf> {
|
||||
/// directories of Maven POMs linked from outside it and, when `trusted`, of the Maven reactor's
|
||||
/// modules there (`build_cache` holds the Gradle and Maven sync results).
|
||||
fn content_roots(
|
||||
settings: &ide_core::settings::Settings,
|
||||
root: &Path,
|
||||
build_cache: &Path,
|
||||
trusted: bool,
|
||||
) -> Vec<PathBuf> {
|
||||
if let Ok(Some(workspace)) = ide_workspace::workspace::Workspace::load(root) {
|
||||
if workspace.is_container(root) {
|
||||
return workspace.projects;
|
||||
@@ -1364,14 +1394,14 @@ fn content_roots(settings: &ide_core::settings::Settings, root: &Path, build_cac
|
||||
.into_iter()
|
||||
.filter(|p| !p.starts_with(root) || ide_index::walk_skips(root, p))
|
||||
.collect::<Vec<_>>();
|
||||
for path in extra_content_roots(settings, root, build_cache) {
|
||||
for path in extra_content_roots(settings, root, build_cache, trusted) {
|
||||
if !roots.contains(&path) {
|
||||
roots.push(path);
|
||||
}
|
||||
}
|
||||
return roots;
|
||||
}
|
||||
extra_content_roots(settings, root, build_cache)
|
||||
extra_content_roots(settings, root, build_cache, trusted)
|
||||
}
|
||||
|
||||
/// The content roots plus the projects attached inside this one. The index covers those
|
||||
@@ -1438,7 +1468,7 @@ fn navigation_roots_uncached(project: &Project, from: &Path) -> Vec<PathBuf> {
|
||||
}
|
||||
}
|
||||
if workspace.is_none() {
|
||||
for root in content_roots(&settings, &project.root, &project.build_cache_dir()) {
|
||||
for root in content_roots(&settings, &project.root, &project.build_cache_dir(), project.is_trusted()) {
|
||||
if !roots.contains(&root) {
|
||||
roots.push(root);
|
||||
}
|
||||
@@ -1457,7 +1487,12 @@ fn member_dependencies_for<'a>(map: &'a BTreeMap<String, Vec<String>>, own_key:
|
||||
map.iter().find(|(key, _)| ide_core::ipc_path::to_ipc(&PathBuf::from(key)) == own_key).map(|(_, deps)| deps)
|
||||
}
|
||||
|
||||
fn extra_content_roots(settings: &ide_core::settings::Settings, root: &Path, build_cache: &Path) -> Vec<PathBuf> {
|
||||
fn extra_content_roots(
|
||||
settings: &ide_core::settings::Settings,
|
||||
root: &Path,
|
||||
build_cache: &Path,
|
||||
trusted: bool,
|
||||
) -> Vec<PathBuf> {
|
||||
let mut out: Vec<PathBuf> = Vec::new();
|
||||
let user = settings
|
||||
.project_structure
|
||||
@@ -1467,7 +1502,7 @@ fn extra_content_roots(settings: &ide_core::settings::Settings, root: &Path, bui
|
||||
.map(|r| PathBuf::from(r.trim()));
|
||||
for p in user
|
||||
.chain(ide_build::gradle_external_roots(root, build_cache, &settings.languages.java.gradle))
|
||||
.chain(ide_build::maven_external_roots(root, &settings.languages.java.maven.linked_projects))
|
||||
.chain(ide_build::maven_external_roots(root, build_cache, &settings.languages.java.maven, trusted))
|
||||
{
|
||||
if p.is_absolute() && p.is_dir() && !p.starts_with(root) && !out.contains(&p) {
|
||||
out.push(p);
|
||||
@@ -1953,11 +1988,11 @@ mod maven_linkage_tests {
|
||||
}
|
||||
let mut settings = ide_core::settings::Settings::default();
|
||||
settings.languages.java.maven.linked_projects = vec!["../B/pom.xml".into()];
|
||||
assert_eq!(super::content_roots(&settings, &a, &base.join("cache")), vec![b]);
|
||||
assert_eq!(super::content_roots(&settings, &a, &base.join("cache"), false), vec![b]);
|
||||
// External links must not replace jdtls's scan of the opened root with a build-file list.
|
||||
assert_eq!(super::jdtls_maven_import(&a, &settings), (Vec::new(), None));
|
||||
settings.languages.java.maven.linked_projects.clear();
|
||||
assert!(super::content_roots(&settings, &a, &base.join("cache")).is_empty());
|
||||
assert!(super::content_roots(&settings, &a, &base.join("cache"), false).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -2181,7 +2216,7 @@ mod content_roots_tests {
|
||||
settings.project_structure.content_roots = vec![shared.to_string_lossy().into_owned()];
|
||||
settings.project_structure.dependencies =
|
||||
vec![dep.to_string_lossy().into_owned(), root.to_string_lossy().into_owned()];
|
||||
let roots = content_roots(&settings, &root, &tmp.path().join("build"));
|
||||
let roots = content_roots(&settings, &root, &tmp.path().join("build"), false);
|
||||
assert_eq!(roots, vec![shared, dep]);
|
||||
}
|
||||
|
||||
@@ -2195,12 +2230,12 @@ mod content_roots_tests {
|
||||
}
|
||||
let settings = ide_core::settings::Settings::default();
|
||||
let build = ws.join("build");
|
||||
assert!(super::language_server_roots(&root, content_roots(&settings, &root, &build)).is_empty());
|
||||
assert!(super::language_server_roots(&root, content_roots(&settings, &root, &build, false)).is_empty());
|
||||
|
||||
ide_workspace::workspace::Workspace::attach(&root, "app", vec![root.clone(), nested.clone(), other.clone()])
|
||||
.unwrap();
|
||||
// The index walks the nested project as part of the root ...
|
||||
let roots = content_roots(&settings, &root, &build);
|
||||
let roots = content_roots(&settings, &root, &build, false);
|
||||
assert_eq!(roots, vec![other.clone()]);
|
||||
// ... while its files go to a language server of its own.
|
||||
assert_eq!(super::language_server_roots(&root, roots), vec![other, nested]);
|
||||
|
||||
@@ -309,13 +309,14 @@ pub fn event_sink(peer: Arc<OnceLock<Peer>>, window: Option<String>) -> ide_core
|
||||
|
||||
/// Whether a desktop shows an `event` notification of its server in the window. A server reports
|
||||
/// on its project; what this machine answers or owns itself (MCP approvals, app updates, window
|
||||
/// groups) never comes from it.
|
||||
/// groups, its own connection to the server) never comes from it.
|
||||
pub fn client_accepts(event: &IdeEvent) -> bool {
|
||||
match event {
|
||||
IdeEvent::McpRequest { .. }
|
||||
| IdeEvent::McpRequestClosed { .. }
|
||||
| IdeEvent::WindowGroupsChanged
|
||||
| IdeEvent::WindowFullscreenChanged
|
||||
| IdeEvent::RemoteConnectionLost { .. }
|
||||
| IdeEvent::UpdateStatusChanged { .. }
|
||||
| IdeEvent::UpdateAvailable { .. } => false,
|
||||
IdeEvent::DbSourcesChanged
|
||||
|
||||
@@ -245,10 +245,18 @@ impl crate::Host {
|
||||
pub async fn refresh_project_trust(&self) -> IdeResult<()> {
|
||||
for project in self.projects().into_iter().filter(|p| !p.light) {
|
||||
let trusted = self.trust.window_trusted(&project.root).unwrap_or(false);
|
||||
let roots = project.content_roots();
|
||||
let previous = project.trusted.swap(trusted, std::sync::atomic::Ordering::AcqRel);
|
||||
if previous == trusted {
|
||||
continue;
|
||||
}
|
||||
// Maven reactor modules outside the project are content roots of a trusted project only.
|
||||
if project.content_roots() != roots {
|
||||
project.refresh_index_scope();
|
||||
let p = project.clone();
|
||||
tokio::task::spawn_blocking(move || p.refresh_repositories());
|
||||
project.sink.emit(ide_core::IdeEvent::ProjectRootsChanged { root: project.root.clone().into() });
|
||||
}
|
||||
if let Some(bridge) = &project.kotlin_bridge {
|
||||
bridge.schedule();
|
||||
}
|
||||
@@ -324,6 +332,7 @@ pub fn restricted_command_allowed(cmd: &str) -> bool {
|
||||
| "doc_edit"
|
||||
| "doc_folding"
|
||||
| "doc_highlights"
|
||||
| "doc_language"
|
||||
| "doc_open"
|
||||
| "doc_open_untitled"
|
||||
| "doc_open_virtual"
|
||||
@@ -338,7 +347,6 @@ pub fn restricted_command_allowed(cmd: &str) -> bool {
|
||||
| "doc_set_line_ending"
|
||||
| "doc_snapshot"
|
||||
| "doc_sync_from_disk"
|
||||
| "doc_ui_mode"
|
||||
| "syntax_errors"
|
||||
| "syntax_expression_at"
|
||||
| "syntax_identifiers"
|
||||
|
||||
@@ -68,7 +68,7 @@ done
|
||||
}
|
||||
for _ in 0..20 {
|
||||
for window in ["first", "second"] {
|
||||
let state = ops::agent::refresh_models(&host, window, "catalog-test".into(), true).unwrap();
|
||||
let state = ops::agent::refresh_models(&host, window, "catalog-test".into(), true, None).unwrap();
|
||||
assert!(state.refreshing);
|
||||
}
|
||||
}
|
||||
@@ -87,7 +87,7 @@ done
|
||||
assert!(completed.is_ok(), "both windows must receive the completed catalog");
|
||||
for _ in 0..20 {
|
||||
for window in ["first", "second"] {
|
||||
let catalog = ops::agent::refresh_models(&host, window, "catalog-test".into(), true).unwrap();
|
||||
let catalog = ops::agent::refresh_models(&host, window, "catalog-test".into(), true, None).unwrap();
|
||||
assert!(!catalog.refreshing);
|
||||
assert!(catalog.retry_at_ms.is_some());
|
||||
let models = catalog.config.iter().find(|o| o.category.as_deref() == Some("model")).unwrap();
|
||||
|
||||
@@ -69,3 +69,47 @@ async fn external_maven_link_persists_reloads_and_unlink_keeps_files() {
|
||||
assert_eq!(std::fs::read_to_string(sibling.join("pom.xml")).unwrap(), b_pom);
|
||||
host.shutdown().await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn reactor_module_beside_a_trusted_project_is_a_content_root_until_removed() {
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
let base = dunce::canonicalize(temp.path()).unwrap();
|
||||
let root = base.join("aggregator");
|
||||
let service = base.join("service-a");
|
||||
std::fs::create_dir_all(root.join("core")).unwrap();
|
||||
std::fs::create_dir_all(&service).unwrap();
|
||||
let reactor = |modules: &str| {
|
||||
format!(
|
||||
"<project><artifactId>aggregator</artifactId><packaging>pom</packaging><modules>{modules}</modules></project>"
|
||||
)
|
||||
};
|
||||
std::fs::write(root.join("pom.xml"), reactor("<module>core</module><module>../service-a</module>")).unwrap();
|
||||
std::fs::write(root.join("core/pom.xml"), "<project><artifactId>core</artifactId></project>").unwrap();
|
||||
std::fs::write(service.join("pom.xml"), "<project><artifactId>service-a</artifactId></project>").unwrap();
|
||||
let host = Host::new(HostConfig {
|
||||
config_dir: base.join("config"),
|
||||
data_dir: base.join("data"),
|
||||
local_data_dir: base.join("local"),
|
||||
languages: Arc::new(ide_language::LanguageRegistry::load(None).unwrap()),
|
||||
syntax: Arc::default(),
|
||||
sink_for: Box::new(|_| Arc::new(NullSink)),
|
||||
owner: |window| window,
|
||||
runtime: tokio::runtime::Handle::current(),
|
||||
project_environment: false,
|
||||
});
|
||||
host.open_project("main", &root).unwrap();
|
||||
let project = || host.project("main").unwrap();
|
||||
assert!(project().content_roots().is_empty(), "Restricted Mode does not widen the index");
|
||||
assert!(project().lsp.jdtls_import_roots().is_empty());
|
||||
|
||||
host.set_project_trust(&root, true, false).await.unwrap();
|
||||
assert_eq!(project().content_roots(), vec![service.clone()]);
|
||||
assert_eq!(project().lsp.jdtls_import_roots(), vec![service.clone()]);
|
||||
|
||||
std::fs::write(root.join("pom.xml"), reactor("<module>core</module>")).unwrap();
|
||||
project().refresh_index_scope();
|
||||
assert!(project().content_roots().is_empty());
|
||||
assert!(project().lsp.jdtls_import_roots().is_empty());
|
||||
assert!(service.join("pom.xml").is_file());
|
||||
host.shutdown().await;
|
||||
}
|
||||
@@ -213,6 +213,79 @@ async fn project_path_argument_routes_to_another_open_project() {
|
||||
assert_eq!(reply["result"]["content"][0]["text"], "L1: second project");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn trusted_attached_projects_are_writable_and_reach_the_window_they_are_attached_in() {
|
||||
let h = Harness::new();
|
||||
h.trust().await;
|
||||
let base = dunce::canonicalize(h.tmp.path()).unwrap();
|
||||
let (attached, untrusted, other) = (base.join("attached"), base.join("untrusted"), base.join("other"));
|
||||
for dir in [&attached, &untrusted, &other] {
|
||||
std::fs::create_dir_all(dir).unwrap();
|
||||
}
|
||||
ide_workspace::workspace::Workspace::attach(
|
||||
&h.root,
|
||||
"project",
|
||||
vec![h.root.clone(), attached.clone(), untrusted.clone()],
|
||||
)
|
||||
.unwrap();
|
||||
h.host.trust.decide(&attached, true, false).unwrap();
|
||||
|
||||
// Outside the project folder, by absolute path.
|
||||
let file = attached.join("new.txt");
|
||||
h.call("create_new_file", json!({"pathInProject": file, "text": "hello"})).await;
|
||||
assert_eq!(std::fs::read_to_string(&file).unwrap(), "hello");
|
||||
let shown = file.to_string_lossy().replace('\\', "/");
|
||||
let patch = format!("*** Begin Patch\n*** Update File: {shown}\n@@\n-hello\n+patched\n*** End Patch");
|
||||
let output = h.call("apply_patch", json!({ "input": patch })).await;
|
||||
assert!(output.starts_with("1 out of 1"), "{output}");
|
||||
assert!(std::fs::read_to_string(&file).unwrap().starts_with("patched"));
|
||||
for dir in [&untrusted, &other] {
|
||||
let e = h.error("create_new_file", json!({"pathInProject": dir.join("x.txt"), "text": "no"})).await;
|
||||
assert!(e.contains("outside"), "{}: {e}", dir.display());
|
||||
assert!(!dir.join("x.txt").exists());
|
||||
}
|
||||
|
||||
// A `projectPath` naming the attached project reaches the window it is attached in.
|
||||
let registry = Registry::new(h.host.clone());
|
||||
assert!(registry.projects().contains(&attached));
|
||||
let read = tokio::task::spawn_blocking(move || {
|
||||
registry.call(&attached, "read_file", &json!({"file_path": "src/b.txt"}).to_string(), CancellationToken::new())
|
||||
})
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
assert!(read.starts_with("L1: needle"), "{read}");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn files_of_a_project_attached_outside_go_by_their_absolute_path_everywhere() {
|
||||
let h = Harness::new();
|
||||
h.trust().await;
|
||||
let attached = dunce::canonicalize(h.tmp.path()).unwrap().join("attached");
|
||||
std::fs::create_dir_all(attached.join("src")).unwrap();
|
||||
std::fs::write(attached.join("src/lib.rs"), "pub fn attached_marker() {}\n").unwrap();
|
||||
let git = std::process::Command::new("git").current_dir(&attached).args(["init", "-q"]).status().unwrap();
|
||||
assert!(git.success());
|
||||
h.host.trust.decide(&attached, true, false).unwrap();
|
||||
ide_host::ops::project::attach_workspace(&h.host, "main", &attached).unwrap();
|
||||
assert!(h.host.project("main").unwrap().index.wait_idle(std::time::Duration::from_secs(10)));
|
||||
let shown = |rel: &str| attached.join(rel).to_string_lossy().replace('\\', "/");
|
||||
|
||||
let files = h.json("search_file", json!({"q":"**/lib.rs"})).await;
|
||||
assert_eq!(files["items"], json!([{ "filePath": shown("src/lib.rs") }]));
|
||||
let symbols = h.json("search_symbol", json!({"q":"attached_marker"})).await;
|
||||
assert_eq!(symbols["items"][0]["filePath"], shown("src/lib.rs"), "{symbols}");
|
||||
assert_eq!(symbols["items"][0]["lineText"], "pub fn attached_marker() {}");
|
||||
let status = h.json("git_status", json!({})).await;
|
||||
let repos: Vec<&str> = status["repositories"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.map(|r| r["repositoryPathRelativeToProject"].as_str().unwrap())
|
||||
.collect();
|
||||
assert!(repos.contains(&shown("").trim_end_matches('/')), "{repos:?}");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn mutations_preserve_unsaved_text_and_reject_metadata_and_escapes() {
|
||||
let h = Harness::new();
|
||||
@@ -368,6 +441,95 @@ async fn git_status_and_diff_on_a_temporary_repository() {
|
||||
assert!(!h.tmp.path().join("executed").exists());
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn scope_limits_the_query_tools_to_a_directory() {
|
||||
let h = Harness::new();
|
||||
std::fs::create_dir_all(h.root.join("lib")).unwrap();
|
||||
std::fs::write(h.root.join("lib/c.txt"), "needle\n").unwrap();
|
||||
let paths = |v: &Value| -> Vec<String> {
|
||||
let mut out: Vec<String> =
|
||||
v["items"].as_array().unwrap().iter().map(|i| i["filePath"].as_str().unwrap().to_owned()).collect();
|
||||
out.dedup();
|
||||
out
|
||||
};
|
||||
assert_eq!(paths(&h.json("search_text", json!({"q":"needle","scope":"lib"})).await), ["lib/c.txt"]);
|
||||
assert_eq!(paths(&h.json("search_regex", json!({"q":"need.e","scope":"lib/"})).await), ["lib/c.txt"]);
|
||||
let absolute = h.root.join("src").to_string_lossy().into_owned();
|
||||
assert_eq!(paths(&h.json("search_file", json!({"q":"*.txt","scope":absolute})).await), ["src/a.txt", "src/b.txt"]);
|
||||
// Within the scope, `paths` narrows further.
|
||||
assert_eq!(
|
||||
paths(&h.json("search_text", json!({"q":"needle","scope":"src","paths":["**/b.txt"]})).await),
|
||||
["src/b.txt"]
|
||||
);
|
||||
assert!(h.error("search_text", json!({"q":"needle","scope":"missing"})).await.contains("is not a directory"));
|
||||
assert!(h.error("search_text", json!({"q":"needle","scope":".."})).await.contains("outside the project"));
|
||||
|
||||
let git = |args: &[&str]| {
|
||||
let output = std::process::Command::new("git").current_dir(&h.root).args(args).output().unwrap();
|
||||
assert!(output.status.success(), "{}", String::from_utf8_lossy(&output.stderr));
|
||||
};
|
||||
git(&["init"]);
|
||||
git(&["add", "."]);
|
||||
git(&["-c", "user.name=Test", "-c", "[email protected]", "commit", "-m", "Initial"]);
|
||||
std::fs::write(h.root.join("src/a.txt"), "changed\n").unwrap();
|
||||
std::fs::write(h.root.join("lib/c.txt"), "changed\n").unwrap();
|
||||
let status = h.json("git_status", json!({"scope":"lib"})).await;
|
||||
assert_eq!(status["repositories"].as_array().unwrap().len(), 1);
|
||||
assert_eq!(
|
||||
status["repositories"][0]["entries"],
|
||||
json!([{"pathRelativeToRepository":"lib/c.txt","indexStatus":" ","workTreeStatus":"M"}])
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn scope_reaches_an_attached_worktree_the_repository_ignores() {
|
||||
let h = Harness::new();
|
||||
h.trust().await;
|
||||
let git = |dir: &Path, args: &[&str]| {
|
||||
let output = std::process::Command::new("git").current_dir(dir).args(args).output().unwrap();
|
||||
assert!(output.status.success(), "{}", String::from_utf8_lossy(&output.stderr));
|
||||
};
|
||||
git(&h.root, &["init"]);
|
||||
git(&h.root, &["add", "."]);
|
||||
git(&h.root, &["-c", "user.name=Test", "-c", "[email protected]", "commit", "-m", "Initial"]);
|
||||
std::fs::write(h.root.join(".git/info/exclude"), "/.wt/\n").unwrap();
|
||||
git(&h.root, &["worktree", "add", "-q", ".wt/feature"]);
|
||||
let worktree = h.root.join(".wt/feature");
|
||||
h.host.trust.decide(&worktree, true, false).unwrap();
|
||||
ide_host::ops::project::attach_workspace(&h.host, "main", &worktree).unwrap();
|
||||
// Hidden folders excluded by name: `.wt` is one, the worktree's own files are not.
|
||||
ide_host::ops::project::set_settings(
|
||||
&h.host,
|
||||
"main",
|
||||
ide_workspace::settings::SettingsScope::Project,
|
||||
"projectStructure.excludeFiles",
|
||||
"\".*\"",
|
||||
)
|
||||
.unwrap();
|
||||
let found = |args: Value| {
|
||||
let h = &h;
|
||||
async move {
|
||||
let v = h.json("search_text", args).await;
|
||||
let mut out: Vec<String> = v["items"]
|
||||
.as_array()
|
||||
.cloned()
|
||||
.unwrap_or_default()
|
||||
.iter()
|
||||
.map(|i| i["filePath"].as_str().unwrap().to_owned())
|
||||
.collect();
|
||||
out.dedup();
|
||||
out
|
||||
}
|
||||
};
|
||||
let everywhere = found(json!({"q":"needle"})).await;
|
||||
assert!(everywhere.contains(&".wt/feature/src/b.txt".to_owned()), "{everywhere:?}");
|
||||
assert_eq!(
|
||||
found(json!({"q":"needle","scope":".wt/feature/src"})).await,
|
||||
[".wt/feature/src/a.txt", ".wt/feature/src/b.txt"]
|
||||
);
|
||||
assert_eq!(found(json!({"q":"needle","paths":[".wt/feature/src/b.txt"]})).await, [".wt/feature/src/b.txt"]);
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[tokio::test(flavor = "multi_thread")]
|
||||
async fn reformat_uses_the_formatter_chain_and_preserves_a_dirty_buffer() {
|
||||
|
||||
@@ -131,9 +131,13 @@ async fn returns_all_python_classes_and_bases() {
|
||||
// Every returned entry is a Python file.
|
||||
assert!(all.iter().all(|c| { matches!(c.path.0.extension().and_then(|e| e.to_str()), Some("py" | "pyi")) }));
|
||||
|
||||
// A file changed on disk is parsed again; the others come from the cache.
|
||||
// A file changed on disk is picked up once the index re-reads it. The index is the
|
||||
// single source of truth for on-disk classes now; edits go through its update path
|
||||
// (the IDE's file watcher calls this in production).
|
||||
let extra = p.root.join("src/extra.pyi");
|
||||
std::fs::write(&extra, "class Stub(Child): ...\nclass Added(Base): ...\n").unwrap();
|
||||
p.host.project(WINDOW).unwrap().index.update(std::slice::from_ref(&extra), &[]);
|
||||
assert!(p.host.project(WINDOW).unwrap().index.wait_idle(Duration::from_secs(5)));
|
||||
let again = ops::nav::nav_inheritance(&p.host, WINDOW).await.unwrap();
|
||||
assert_eq!(find(&again, "Stub").bases, vec!["Child".to_string()]);
|
||||
assert_eq!(find(&again, "Added").bases, vec!["Base".to_string()]);
|
||||
|
||||
@@ -54,6 +54,7 @@ fn method() -> SymbolTag {
|
||||
kind: SymbolKind::Method,
|
||||
container: None,
|
||||
range: Range::new(Pos::new(0, 4), Pos::new(0, 8)),
|
||||
bases: Vec::new(),
|
||||
}
|
||||
}
|
||||
const SOURCE: &str = "def source:item\nref mapping:item\n";
|
||||
|
||||
@@ -225,6 +225,7 @@ async fn indexed_usages_rename_preview_staleness_and_grouped_undo() {
|
||||
kind: ide_core::SymbolKind::Method,
|
||||
container: None,
|
||||
range: ide_core::Range::new(Pos::new(0, 4), Pos::new(0, 5)),
|
||||
bases: Vec::new(),
|
||||
};
|
||||
plugins
|
||||
.index_navigation(
|
||||
|
||||
@@ -196,6 +196,41 @@ impl PluginWorkspace for TestWorkspace {
|
||||
self.server_messages.lock().push((method.into(), params.clone(), notify));
|
||||
Ok(if notify { serde_json::Value::Null } else { serde_json::json!({ "method": method, "params": params }) })
|
||||
}
|
||||
/// A Maven module with a lost version conflict, and a Gradle project with one report.
|
||||
fn build_graph(&self, _root: &Path) -> Result<BuildGraph, HostError> {
|
||||
let dep = |artifact: &str, version: &str| ide_build::MavenDependency {
|
||||
group_id: "org.apache.commons".into(),
|
||||
artifact_id: artifact.into(),
|
||||
version: Some(version.into()),
|
||||
scope: "compile".into(),
|
||||
..Default::default()
|
||||
};
|
||||
let mut text = dep("commons-text", "1.11.0");
|
||||
text.children = vec![ide_build::MavenDependency {
|
||||
omitted: Some(ide_build::Omission::Conflict),
|
||||
conflict_with: Some("3.14.0".into()),
|
||||
..dep("commons-lang3", "3.12.0")
|
||||
}];
|
||||
let app = ide_build::MavenProject {
|
||||
group_id: "com.example".into(),
|
||||
artifact_id: "app".into(),
|
||||
version: "1.0".into(),
|
||||
dependencies: vec![text],
|
||||
..Default::default()
|
||||
};
|
||||
let snakeyaml = ide_build::GradleDependency {
|
||||
group: "org.yaml".into(),
|
||||
name: "snakeyaml".into(),
|
||||
requested: Some("2.2".into()),
|
||||
..Default::default()
|
||||
};
|
||||
let report = ide_build::GradleReport {
|
||||
project: ":web".into(),
|
||||
configuration: "runtimeClasspath".into(),
|
||||
dependencies: vec![snakeyaml],
|
||||
};
|
||||
Ok(BuildGraph { maven: vec![app], gradle: vec![GradleModule { path: ":web".into(), reports: vec![report] }] })
|
||||
}
|
||||
fn project_windows(&self, root: &Path) -> Vec<String> {
|
||||
// `main` shows the fixture project; other open roots have no window left.
|
||||
if root == self.root { vec!["closing".into(), "main".into()] } else { Vec::new() }
|
||||
@@ -2151,6 +2186,60 @@ fn run_detectors_offer_granted_commands_in_marked_projects() {
|
||||
assert!(detection.launch(config).unwrap_err().contains("no longer enabled"));
|
||||
}
|
||||
|
||||
/// A plugin's Java agent (`[[contributes.javaAgents]]`, the `java-agent` fixture): an optional
|
||||
/// high-risk `java.agent` capability; refusing or revoking it keeps the plugin working and the
|
||||
/// launch gets no agent; granting it pins the jar, which may not change afterwards.
|
||||
#[test]
|
||||
fn java_agent_loads_only_while_granted_and_unchanged() {
|
||||
let f = fixture(Limits::default());
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let pkg = tmp.path().join("java-agent");
|
||||
copy_dir(&sample("java-agent"), &pkg);
|
||||
let preview = f.host.preview_install(&pkg).unwrap();
|
||||
let cap = preview.capabilities.iter().find(|c| c.id == "java.agent").expect("derived from the declaration");
|
||||
assert!(cap.optional && cap.risk == ide_extension::Risk::High && !cap.granted);
|
||||
assert_eq!(cap.description, "Run code inside the Java applications you start");
|
||||
|
||||
// Refused on install: the plugin is on, Java launches get no agent.
|
||||
let info = f.host.install_from_dir(&pkg, &Consent::default()).unwrap();
|
||||
assert_eq!(info.status, PluginStatus::Static, "{:?}", info.error);
|
||||
assert!(info.contributions.iter().any(|c| c.point == "javaAgents" && c.label == "fixture agent.jar=mode=test"));
|
||||
let source = f.host.java_agents();
|
||||
let launch = || {
|
||||
let agents = ide_run::java_agent::approved(&source.agents());
|
||||
let mut args: Vec<String> = ["-Xmx1g", "-cp", "/p/classes", "app.Main"].map(String::from).into();
|
||||
ide_run::java_agent::add_to_args(&mut args, &agents.options);
|
||||
(args, agents.notes)
|
||||
};
|
||||
let plain: Vec<String> = ["-Xmx1g", "-cp", "/p/classes", "app.Main"].map(String::from).into();
|
||||
assert_eq!(launch(), (plain.clone(), vec![]));
|
||||
|
||||
// Granted: the installed jar with its arguments, one argument after the VM options.
|
||||
let info = f.host.set_capability("java-agent", "java.agent", true).unwrap();
|
||||
assert!(info.capabilities.iter().any(|c| c.id == "java.agent" && c.granted));
|
||||
let jar = dunce::canonicalize(f.installed("java-agent").join("agent/fixture agent.jar")).unwrap();
|
||||
let option = format!("-javaagent:{}=mode=test", jar.display());
|
||||
let mut with_agent = plain.clone();
|
||||
with_agent.insert(3, option.clone());
|
||||
assert_eq!(launch(), (with_agent.clone(), vec![]));
|
||||
|
||||
// The jar changed since it was granted: left out, with a reason, until approved again.
|
||||
std::fs::write(&jar, "swapped").unwrap();
|
||||
let (args, notes) = launch();
|
||||
assert_eq!(args, plain);
|
||||
assert!(notes.len() == 1 && notes[0].contains("changed since it was approved"), "{notes:?}");
|
||||
f.host.set_capability("java-agent", "java.agent", true).unwrap();
|
||||
assert_eq!(launch(), (with_agent.clone(), vec![]));
|
||||
|
||||
// Revoked, then the plugin disabled: no agent either way.
|
||||
f.host.set_capability("java-agent", "java.agent", false).unwrap();
|
||||
assert_eq!(f.status("java-agent"), PluginStatus::Static);
|
||||
assert_eq!(launch(), (plain.clone(), vec![]));
|
||||
f.host.set_capability("java-agent", "java.agent", true).unwrap();
|
||||
f.host.set_enabled("java-agent", false).unwrap();
|
||||
assert_eq!(launch(), (plain, vec![]));
|
||||
}
|
||||
|
||||
/// Compiled components are cached across runs (keyed by module and
|
||||
/// engine), so a cold activation only deserializes.
|
||||
#[test]
|
||||
@@ -6518,8 +6607,8 @@ fn a_plugin_command_opens_a_diff_in_its_window() {
|
||||
client.as_deref() == Some("main")
|
||||
&& matches!(event, PluginEvent::OpenDiff { plugin_id, diff, file_name }
|
||||
if plugin_id == "execution"
|
||||
&& diff.left == "before\n"
|
||||
&& diff.right == "after\n"
|
||||
&& diff.left.as_deref() == Some("before\n")
|
||||
&& diff.right.as_deref() == Some("after\n")
|
||||
&& diff.title.as_deref() == Some("Review")
|
||||
&& file_name.as_deref() == Some("src/review.rs"))
|
||||
})
|
||||
@@ -7022,6 +7111,59 @@ fn the_language_server_grant_needs_api_1_9() {
|
||||
assert!(err.message.contains("new in plugin API 1.9"), "{err:?}");
|
||||
}
|
||||
|
||||
/// `build.dependencies` hands a plugin the resolved Maven / Gradle graph as a flat list, each
|
||||
/// module a root, with `build.read` in a trusted project (API 1.10).
|
||||
#[test]
|
||||
fn build_dependencies_need_the_grant_and_a_trusted_project() {
|
||||
let f = fixture(Limits::default());
|
||||
let id = "test.build-graph";
|
||||
let info = f.install(&sample("build-graph"));
|
||||
assert!(info.capabilities.iter().any(|c| c.id == "build.read" && c.granted && c.risk == ide_extension::Risk::Low));
|
||||
|
||||
// `parent group:artifact:version scope status requested`, as the fixture prints them.
|
||||
assert_eq!(
|
||||
f.run(id, "dependencies", None).unwrap().unwrap(),
|
||||
"- com.example:app:1.0 resolved -\n\
|
||||
0 org.apache.commons:commons-text:1.11.0 compile resolved -\n\
|
||||
1 org.apache.commons:commons-lang3:3.14.0 compile conflict 3.12.0\n\
|
||||
- ::web: resolved -\n\
|
||||
3 org.yaml:snakeyaml:2.2 runtimeClasspath resolved -"
|
||||
);
|
||||
assert_eq!(
|
||||
f.run(id, "dependencies", Some(":web")).unwrap().unwrap(),
|
||||
"- ::web: resolved -\n0 org.yaml:snakeyaml:2.2 runtimeClasspath resolved -"
|
||||
);
|
||||
let err = f.host.run_command(id, "dependencies", Some("app"), f.inv()).unwrap_err();
|
||||
assert_eq!(err.kind, ErrorKind::NotFound, "{err:?}");
|
||||
|
||||
f.host.set_capability(id, "build.read", false).unwrap();
|
||||
let err = f.host.run_command(id, "dependencies", None, f.inv()).unwrap_err();
|
||||
assert_eq!(err.kind, ErrorKind::PermissionDenied, "{err:?}");
|
||||
assert!(err.message.contains("build.read"), "{err:?}");
|
||||
f.host.set_capability(id, "build.read", true).unwrap();
|
||||
|
||||
// The graph comes from running the project's build: not in an untrusted project.
|
||||
let mut untrusted = TestWorkspace::new(&f.project);
|
||||
Arc::get_mut(&mut untrusted).unwrap().trusted = false;
|
||||
f.host.set_workspace(Some(untrusted));
|
||||
let err = f.host.run_command(id, "dependencies", None, f.inv()).unwrap_err();
|
||||
assert_eq!(err.kind, ErrorKind::PermissionDenied, "{err:?}");
|
||||
assert_eq!(f.host.info_of(id).unwrap().stats.crashes, 0);
|
||||
}
|
||||
|
||||
/// The grant is new in API 1.10: an older `engines.openidea` can't ask for it.
|
||||
#[test]
|
||||
fn the_build_grant_needs_api_1_10() {
|
||||
let f = fixture(Limits::default());
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let pkg = tmp.path().join("build-graph");
|
||||
copy_dir(&sample("build-graph"), &pkg);
|
||||
let manifest = std::fs::read_to_string(pkg.join("plugin.toml")).unwrap();
|
||||
std::fs::write(pkg.join("plugin.toml"), manifest.replace("\"^1.10\"", "\"^1.9\"")).unwrap();
|
||||
let err = f.host.install_from_dir(&pkg, &Consent::all()).unwrap_err();
|
||||
assert!(err.message.contains("new in plugin API 1.10"), "{err:?}");
|
||||
}
|
||||
|
||||
/// The UI's synthetic post-install `SettingsChanged([])` reaches a plugin that
|
||||
/// subscribes to `on-event:settings-changed`, though it carries no keys.
|
||||
#[test]
|
||||
|
||||
@@ -109,7 +109,7 @@ pub async fn check_connection(proxy: &ProxySettings, url: &str, cancel: &Cancell
|
||||
}
|
||||
|
||||
/// reqwest errors with their causes ("error sending request: … connection refused").
|
||||
pub(crate) fn describe(e: &reqwest::Error) -> String {
|
||||
pub fn describe(e: &reqwest::Error) -> String {
|
||||
use std::error::Error;
|
||||
let mut msg = e.to_string();
|
||||
let mut source = e.source();
|
||||
|
||||
@@ -34,6 +34,16 @@ pub struct RunInput<'a> {
|
||||
/// variables, missing includes) fail; transport errors are part of the exchange.
|
||||
pub async fn run(input: RunInput<'_>, cancel: &CancellationToken) -> IdeResult<HttpExchange> {
|
||||
let request = prepare(&input)?;
|
||||
send(request, input.file, cancel).await
|
||||
}
|
||||
|
||||
/// Sends an already prepared request (one the user approved as shown); `file` is the
|
||||
/// request file it came from, for the history.
|
||||
pub async fn send(
|
||||
request: PreparedRequest,
|
||||
file: Option<&Path>,
|
||||
cancel: &CancellationToken,
|
||||
) -> IdeResult<HttpExchange> {
|
||||
let time_ms = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.map(|d| d.as_secs_f64() * 1000.0)
|
||||
@@ -57,7 +67,7 @@ pub async fn run(input: RunInput<'_>, cancel: &CancellationToken) -> IdeResult<H
|
||||
url: request.url.clone(),
|
||||
status: response.as_ref().map(|r| r.status),
|
||||
total_ms: response.as_ref().map(|r| r.total_ms),
|
||||
file: input.file.map(IpcPath::from),
|
||||
file: file.map(IpcPath::from),
|
||||
error,
|
||||
},
|
||||
request,
|
||||
|
||||
@@ -106,6 +106,9 @@ pub(crate) struct StoredSymbol {
|
||||
pub kind: SymbolKind,
|
||||
pub container: Option<String>,
|
||||
pub range: Range,
|
||||
/// Base names of a class definition; empty for every other symbol.
|
||||
#[serde(default)]
|
||||
pub bases: Vec<String>,
|
||||
}
|
||||
|
||||
/// A symbol resolved out of [`SymTable`].
|
||||
@@ -114,6 +117,8 @@ pub(crate) struct SymRef<'a> {
|
||||
pub kind: SymbolKind,
|
||||
pub container: Option<&'a str>,
|
||||
pub range: Range,
|
||||
/// Base names joined with `'\0'`; empty when the symbol has none.
|
||||
pub bases: &'a str,
|
||||
}
|
||||
|
||||
pub(crate) struct FileEntry {
|
||||
@@ -402,6 +407,8 @@ pub(crate) struct SymTable {
|
||||
container: Vec<Span>,
|
||||
kind: Vec<SymbolKind>,
|
||||
range: Vec<Range>,
|
||||
/// Base names joined with `'\0'`, one interned span per symbol (`NONE` for none).
|
||||
bases: Vec<Span>,
|
||||
text: String,
|
||||
dead_rows: usize,
|
||||
}
|
||||
@@ -423,6 +430,18 @@ impl SymTable {
|
||||
(span.start != u32::MAX).then(|| span.get(&self.text))
|
||||
}
|
||||
|
||||
/// The symbol's base names joined with `'\0'`; empty when it has none.
|
||||
#[inline]
|
||||
pub(crate) fn bases(&self, i: u32) -> &str {
|
||||
let span = self.bases[i as usize];
|
||||
if span.start == u32::MAX { "" } else { span.get(&self.text) }
|
||||
}
|
||||
|
||||
/// The base names of row `i`, split out of the interned string.
|
||||
pub(crate) fn base_list(&self, i: u32) -> Vec<&str> {
|
||||
self.bases(i).split('\0').filter(|b| !b.is_empty()).collect()
|
||||
}
|
||||
|
||||
/// The mask + name rows of a file's contiguous symbol range.
|
||||
#[inline]
|
||||
pub(crate) fn heads(&self, start: u32, len: u32) -> &[SymHead] {
|
||||
@@ -459,10 +478,12 @@ impl SymTable {
|
||||
Some(c) => self.intern(c),
|
||||
None => Span::NONE,
|
||||
};
|
||||
let bases = if s.bases.is_empty() { Span::NONE } else { self.intern(&s.bases.join("\0")) };
|
||||
self.head.push(SymHead { mask, name });
|
||||
self.container.push(container);
|
||||
self.kind.push(s.kind);
|
||||
self.range.push(s.range);
|
||||
self.bases.push(bases);
|
||||
}
|
||||
(start, agg_mask)
|
||||
}
|
||||
@@ -476,6 +497,7 @@ impl SymTable {
|
||||
&& self.container(i) == s.container.as_deref()
|
||||
&& self.kind(i) == s.kind
|
||||
&& self.range(i) == s.range
|
||||
&& self.base_list(i) == s.bases.iter().map(String::as_str).collect::<Vec<_>>()
|
||||
})
|
||||
}
|
||||
|
||||
@@ -492,6 +514,7 @@ impl SymTable {
|
||||
let mut container = Vec::with_capacity(head.capacity());
|
||||
let mut kind = Vec::with_capacity(head.capacity());
|
||||
let mut range = Vec::with_capacity(head.capacity());
|
||||
let mut bases = Vec::with_capacity(head.capacity());
|
||||
let mut live = 0u32;
|
||||
for (slot, row) in rows.iter_mut().enumerate() {
|
||||
if !row.live {
|
||||
@@ -518,6 +541,14 @@ impl SymTable {
|
||||
}
|
||||
kind.push(self.kind[i as usize]);
|
||||
range.push(self.range[i as usize]);
|
||||
let bases_span = self.bases[i as usize];
|
||||
if bases_span.start == u32::MAX {
|
||||
bases.push(Span::NONE);
|
||||
} else {
|
||||
let b = bases_span.get(&self.text);
|
||||
bases.push(Span::of(&text, b));
|
||||
text.push_str(b);
|
||||
}
|
||||
live += 1;
|
||||
}
|
||||
}
|
||||
@@ -525,6 +556,7 @@ impl SymTable {
|
||||
self.container = container;
|
||||
self.kind = kind;
|
||||
self.range = range;
|
||||
self.bases = bases;
|
||||
self.text = text;
|
||||
self.dead_rows = 0;
|
||||
}
|
||||
@@ -534,6 +566,7 @@ impl SymTable {
|
||||
self.container.shrink_to_fit();
|
||||
self.kind.shrink_to_fit();
|
||||
self.range.shrink_to_fit();
|
||||
self.bases.shrink_to_fit();
|
||||
self.text.shrink_to_fit();
|
||||
}
|
||||
}
|
||||
@@ -577,6 +610,7 @@ impl IndexData {
|
||||
self.syms.container.reserve(symbols);
|
||||
self.syms.kind.reserve(symbols);
|
||||
self.syms.range.reserve(symbols);
|
||||
self.syms.bases.reserve(symbols);
|
||||
}
|
||||
|
||||
/// Hydrates a validated warm-start snapshot in one pass, without per-file
|
||||
@@ -640,6 +674,7 @@ impl IndexData {
|
||||
kind: s.kind,
|
||||
container: s.container.map(str::to_owned),
|
||||
range: s.range,
|
||||
bases: s.bases.split('\0').filter(|b| !b.is_empty()).map(str::to_owned).collect(),
|
||||
})
|
||||
.collect(),
|
||||
ignored: e.ignored,
|
||||
@@ -666,6 +701,7 @@ impl IndexData {
|
||||
kind: syms.kind(i),
|
||||
container: syms.container(i),
|
||||
range: syms.range(i),
|
||||
bases: syms.bases(i),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -823,6 +859,7 @@ mod tests {
|
||||
kind: SymbolKind::Function,
|
||||
container: None,
|
||||
range: Range::default(),
|
||||
bases: Vec::new(),
|
||||
})
|
||||
.collect(),
|
||||
..Default::default()
|
||||
@@ -957,7 +994,13 @@ mod tests {
|
||||
}
|
||||
|
||||
fn symbol(n: &str) -> StoredSymbol {
|
||||
StoredSymbol { name: n.to_owned(), kind: SymbolKind::Function, container: None, range: Range::default() }
|
||||
StoredSymbol {
|
||||
name: n.to_owned(),
|
||||
kind: SymbolKind::Function,
|
||||
container: None,
|
||||
range: Range::default(),
|
||||
bases: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -50,6 +50,17 @@ pub struct SymbolMatch {
|
||||
pub indices: MatchIndices,
|
||||
}
|
||||
|
||||
/// A class declaration of the index and the base names written in its source.
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct ClassDecl {
|
||||
pub path: PathBuf,
|
||||
pub name: String,
|
||||
/// Selection range: the class name's identifier.
|
||||
pub range: Range,
|
||||
/// Bare base names, as written (`class X(pkg.mod.Base)` keeps `Base`).
|
||||
pub bases: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum SymbolFilter {
|
||||
@@ -206,11 +217,34 @@ impl ProjectIndex {
|
||||
kind: s.kind,
|
||||
container: s.container.map(ToString::to_string),
|
||||
range: s.range,
|
||||
bases: s.bases.split('\0').filter(|b| !b.is_empty()).map(str::to_owned).collect(),
|
||||
})
|
||||
.collect(),
|
||||
)
|
||||
}
|
||||
|
||||
/// Every class declaration of the indexed project (content roots included) with the
|
||||
/// base names written in its source, in path order. The UI builds an inheritance
|
||||
/// graph from it, so it needs no language server's type hierarchy.
|
||||
pub fn inheritance(&self) -> Vec<ClassDecl> {
|
||||
let data = self.shared.data.read();
|
||||
let mut out = Vec::new();
|
||||
for entry in data.files.iter().flatten() {
|
||||
for s in data.symbols_of(entry) {
|
||||
if s.kind != SymbolKind::Class {
|
||||
continue;
|
||||
}
|
||||
out.push(ClassDecl {
|
||||
path: entry.path.clone(),
|
||||
name: s.name.to_owned(),
|
||||
range: s.range,
|
||||
bases: s.bases.split('\0').filter(|b| !b.is_empty()).map(str::to_owned).collect(),
|
||||
});
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Bounded file inventory for background plugin indexers; honors the same
|
||||
/// project/exclude scope as search and never walks the filesystem.
|
||||
pub fn files_with_extensions(&self, extensions: &[String], limit: usize) -> Vec<PathBuf> {
|
||||
@@ -517,6 +551,7 @@ pub mod bench_support {
|
||||
kind: if k % 3 == 0 { SymbolKind::Class } else { SymbolKind::Method },
|
||||
container: (k % 3 != 0).then(|| format!("{w}{s}")),
|
||||
range: Range::default(),
|
||||
bases: Vec::new(),
|
||||
})
|
||||
.collect();
|
||||
let record = FileRecord { symbols, ..Default::default() };
|
||||
|
||||
@@ -11,8 +11,8 @@ use std::time::{SystemTime, UNIX_EPOCH};
|
||||
|
||||
const FILES: TableDefinition<&str, &[u8]> = TableDefinition::new("files");
|
||||
const META: TableDefinition<&str, &[u8]> = TableDefinition::new("meta");
|
||||
/// Bump when [`FileRecord`] or its encoding changes.
|
||||
const SCHEMA: &str = "openidea-index-3";
|
||||
/// Bump when [`FileRecord`] or its encoding changes. 4: a symbol's base names.
|
||||
const SCHEMA: &str = "openidea-index-4";
|
||||
|
||||
/// The real Git directory for a checkout/worktree (`root/.git` may be a file
|
||||
/// containing `gitdir: ...`).
|
||||
@@ -113,6 +113,9 @@ struct FlatSymbol {
|
||||
name_len: u32,
|
||||
container_start: u32,
|
||||
container_len: u32,
|
||||
/// Base names joined with `'\0'` (`bases_len` 0 when the symbol has none).
|
||||
bases_start: u32,
|
||||
bases_len: u32,
|
||||
kind: SymbolKind,
|
||||
range: Range,
|
||||
}
|
||||
@@ -324,11 +327,14 @@ impl Snapshot {
|
||||
let start = s.container_start as usize;
|
||||
&self.text[start..start + s.container_len as usize]
|
||||
});
|
||||
let bases_start = s.bases_start as usize;
|
||||
let bases = &self.text[bases_start..bases_start + s.bases_len as usize];
|
||||
StoredSymbol {
|
||||
name: name.to_owned(),
|
||||
kind: s.kind,
|
||||
container: container.map(str::to_owned),
|
||||
range: s.range,
|
||||
bases: bases.split('\0').filter(|b| !b.is_empty()).map(str::to_owned).collect(),
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
@@ -498,11 +504,15 @@ impl Store {
|
||||
}
|
||||
None => (u32::MAX, 0),
|
||||
};
|
||||
let bases_start = fit(snap.text.len())?;
|
||||
snap.text.push_str(s.bases);
|
||||
snap.symbols.push(FlatSymbol {
|
||||
name_start,
|
||||
name_len: fit(s.name.len())?,
|
||||
container_start,
|
||||
container_len,
|
||||
bases_start,
|
||||
bases_len: fit(s.bases.len())?,
|
||||
kind: s.kind,
|
||||
range: s.range,
|
||||
});
|
||||
@@ -717,6 +727,7 @@ mod tests {
|
||||
kind: SymbolKind::Class,
|
||||
container: Some("Order".into()),
|
||||
range: Range::default(),
|
||||
bases: vec!["Base".into()],
|
||||
}],
|
||||
..Default::default()
|
||||
};
|
||||
@@ -740,6 +751,7 @@ mod tests {
|
||||
assert_eq!(symbols.len(), 1);
|
||||
assert_eq!(symbols[0].name, "OrderController");
|
||||
assert_eq!(symbols[0].container.as_deref(), Some("Order"));
|
||||
assert_eq!(symbols[0].bases, vec!["Base".to_string()], "bases survive the snapshot");
|
||||
|
||||
store.apply(&[], &[], false).unwrap();
|
||||
assert!(store.load_snapshot().is_none(), "a file change invalidates the snapshot");
|
||||
|
||||
@@ -567,6 +567,29 @@ fn symbols_named_any_answers_every_name_inside_the_root_in_one_walk() {
|
||||
assert_eq!(found, expected.map(|(name, path)| (name.to_string(), path.to_string())));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inheritance_reports_python_classes_and_their_bases() {
|
||||
let f = Fixture::new(&[(
|
||||
"app.py",
|
||||
"class Base:\n pass\n\nclass Child(Base, other.Mixin):\n pass\n\nclass Plain:\n pass\n",
|
||||
)]);
|
||||
let idx = f.open();
|
||||
let mut found: Vec<(String, u32, Vec<String>)> =
|
||||
idx.inheritance().into_iter().map(|c| (c.name, c.range.start.line, c.bases)).collect();
|
||||
found.sort();
|
||||
assert_eq!(
|
||||
found,
|
||||
vec![
|
||||
("Base".to_string(), 0, Vec::new()),
|
||||
("Child".to_string(), 3, vec!["Base".to_string(), "Mixin".to_string()]),
|
||||
("Plain".to_string(), 6, Vec::new()),
|
||||
]
|
||||
);
|
||||
// Every class of the project is reported, even without a superclass: the UI needs
|
||||
// them to resolve the base names of other files.
|
||||
assert_eq!(idx.inheritance().len(), 3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn content_roots_and_excludes_change_without_reopening() {
|
||||
let fx = Fixture::new(&[("src/main.rs", "fn alpha() {}\n"), ("src/gen/out.rs", "fn generated() {}\n")]);
|
||||
|
||||
@@ -752,7 +752,13 @@ impl Shared {
|
||||
.syntax
|
||||
.tags(&lang, &text)
|
||||
.into_iter()
|
||||
.map(|t| StoredSymbol { name: t.name, kind: t.kind, container: t.container, range: t.range })
|
||||
.map(|t| StoredSymbol {
|
||||
name: t.name,
|
||||
kind: t.kind,
|
||||
container: t.container,
|
||||
range: t.range,
|
||||
bases: t.bases,
|
||||
})
|
||||
.collect();
|
||||
}
|
||||
Extracted::New(rec)
|
||||
|
||||
@@ -8,8 +8,6 @@ license.workspace = true
|
||||
[dependencies]
|
||||
futures.workspace = true
|
||||
serde.workspace = true
|
||||
serde_json.workspace = true
|
||||
specta.workspace = true
|
||||
thiserror.workspace = true
|
||||
|
||||
[dev-dependencies]
|
||||
serde_json.workspace = true
|
||||
@@ -2,8 +2,10 @@
|
||||
//! suspended. Implementations live elsewhere (jdtls bundle for Java, JDWP link for Kotlin).
|
||||
|
||||
mod names;
|
||||
mod stream;
|
||||
|
||||
pub use names::{is_boxed, name_to_signature, signature_to_name, string_length};
|
||||
pub use stream::{AbortState, CollectedTerminal, StreamTracer, TraceCollected, TraceId, TraceState};
|
||||
|
||||
use futures::future::BoxFuture;
|
||||
use serde::{Deserialize, Serialize};
|
||||
@@ -112,6 +114,15 @@ pub enum InspectError {
|
||||
VmNotFound,
|
||||
#[error("not supported by this debug adapter: {0}")]
|
||||
Unsupported(String),
|
||||
#[error("java-debug has no debug session for this JVM")]
|
||||
NoSession,
|
||||
/// The bundle's reason, e.g. which line the chain starts on.
|
||||
#[error("the debuggee is not stopped where the stream chain starts: {0}")]
|
||||
NotAtChainStart(String),
|
||||
#[error("a stream trace is already running in this JVM")]
|
||||
Busy,
|
||||
#[error("there is no such stream trace in this JVM")]
|
||||
NoTrace,
|
||||
#[error("the request timed out")]
|
||||
TimedOut,
|
||||
#[error("the connection was closed")]
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
//! Tracing a stream chain while the program itself runs it. One trace per VM; the trace's records
|
||||
//! are read back once the debuggee is suspended again.
|
||||
|
||||
use crate::{InspectFuture, JvmValue, VmTarget};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use specta::Type;
|
||||
|
||||
/// Assigned by the debuggee-side bundle; valid for one VM.
|
||||
pub type TraceId = u64;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum TraceState {
|
||||
Running {
|
||||
records: u64,
|
||||
dropped: u64,
|
||||
elapsed_ms: u64,
|
||||
},
|
||||
/// The terminal operation finished and the thread is suspended again, ready to `collect`.
|
||||
Parked {
|
||||
records: u64,
|
||||
dropped: u64,
|
||||
},
|
||||
Failed {
|
||||
detail: String,
|
||||
},
|
||||
/// Stopped or aborted before the terminal operation ran: taken down, the program untouched.
|
||||
Cancelled {
|
||||
detail: String,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
|
||||
#[serde(tag = "kind", rename_all = "camelCase", rename_all_fields = "camelCase")]
|
||||
pub enum AbortState {
|
||||
Interrupted,
|
||||
Stopped,
|
||||
/// Suspended threads that own a monitor the terminal may be waiting for: `(thread id, name)`.
|
||||
Stuck {
|
||||
holders: Vec<(i64, String)>,
|
||||
},
|
||||
/// The terminal had not started.
|
||||
Cancelled,
|
||||
/// The trace had already parked or failed.
|
||||
Finished,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum CollectedTerminal {
|
||||
Value(JvmValue),
|
||||
Void,
|
||||
Threw(JvmValue),
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct TraceCollected {
|
||||
/// `(step, value)`: step counts the wrapped ops from 0 (the source).
|
||||
pub records: Vec<(u16, JvmValue)>,
|
||||
/// Records past the arm-time budget; counted, not kept.
|
||||
pub dropped: u64,
|
||||
pub terminal: CollectedTerminal,
|
||||
pub skipped_breakpoints: u32,
|
||||
/// A parallel chain was forced to run sequentially so that records keep their order.
|
||||
pub sequentialized: bool,
|
||||
}
|
||||
|
||||
pub trait StreamTracer: Send + Sync {
|
||||
/// `plan` is the JSON of `ide_streams::RealRunPlan`; `budget` caps the records kept.
|
||||
fn arm<'a>(
|
||||
&'a self,
|
||||
target: &'a VmTarget,
|
||||
thread_id: i64,
|
||||
plan: &'a serde_json::Value,
|
||||
budget: u32,
|
||||
) -> InspectFuture<'a, TraceId>;
|
||||
/// Blocks up to `ms` milliseconds for the trace to leave `Running`.
|
||||
fn wait<'a>(&'a self, target: &'a VmTarget, trace: TraceId, ms: u32) -> InspectFuture<'a, TraceState>;
|
||||
/// Stops keeping records while the terminal keeps running; returns the records kept so far.
|
||||
fn stop<'a>(&'a self, target: &'a VmTarget, trace: TraceId) -> InspectFuture<'a, u64>;
|
||||
fn abort<'a>(&'a self, target: &'a VmTarget, trace: TraceId) -> InspectFuture<'a, AbortState>;
|
||||
/// `target.generation` must be a stop after the trace parked. `records`: how many it parked
|
||||
/// with; reading each takes a round trip to the JVM, so the time allowed grows with them.
|
||||
fn collect<'a>(&'a self, target: &'a VmTarget, trace: TraceId, records: u64) -> InspectFuture<'a, TraceCollected>;
|
||||
fn release<'a>(&'a self, target: &'a VmTarget, trace: TraceId) -> InspectFuture<'a, ()>;
|
||||
}
|
||||
Loaded 100 of 805 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Заблокувати користувача