The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.
TypeScript code-editorcross-platformdapdatabase-clientdebuggerdesktop-appdeveloper-toolsgithttp-clientideintellijlsprusttauriterminal
test(plugins): keep one snapshot of the released plugin API and require it at release (#1512)
l0ng-ai91d6c7de579b
diff --git a/.github/workflows/release.yml b/.github/workflows/release.ymlindex 1758e67a4..ed6644138 100644--- a/.github/workflows/release.yml+++ b/.github/workflows/release.yml@@ -37,6 +37,16 @@ jobs:echo "::error::tag $TAG does not match tauri.conf.json version $app"exit 1fi+ # A shipped plugin API is frozen: its WIT must be the snapshot api_frozen.rs checks later+ # versions against (plugins/README.md, "Evolving the plugin API").+ - name: Plugin API snapshot matches wit/+ run: |+ api() { sed -n 's/^package openidea:plugin@\(.*\);$/\1/p' "$1/plugin.wit"; }+ snapshot=sdk/rust/openidea-plugin/tests/api/released+ if [ "$(api wit)" != "$(api "$snapshot")" ]; then+ echo "::error::plugin API $(api wit) ships without a snapshot ($snapshot is $(api "$snapshot")): copy wit/*.wit to $snapshot/"+ exit 1+ fi# The official plugins' public key (from PLUGIN_SIGNING_KEY, the seed# `openidea-plugin keygen` writes), built into the app: their packages# must carry its signature whatever the marketplace index lists. Withoutdiff --git a/plugins/README.md b/plugins/README.mdindex 6fe018090..d2f1ab09d 100644--- a/plugins/README.md+++ b/plugins/README.md@@ -958,10 +958,15 @@ only grows:Checked automatically:-- SDK `tests/api_frozen.rs`: `tests/api/<version>/` holds the WIT of each+- SDK `tests/api_frozen.rs`: `tests/api/released/` holds the WIT of the latestreleased version; every interface, type, function and world import or- export in it must still exist unchanged in `wit/` (rules 1–3). Copy `wit/`- there when a version ships.+ export in it must still exist unchanged in `wit/` (rules 1–3). Under the+ released version `wit/` must match it exactly, so additions start with a+ version bump. Each snapshot passed this check against the one before, so+ one snapshot covers every release.+- Releasing: when the `wit/` version changes, copy `wit/*.wit` over+ `tests/api/released/` in the release commit. The release workflow refuses a+ tag whose `wit/` version differs from the snapshot's.- `crates/ide-plugin/tests/api_compat.rs`: the versions agree, the SDK's copymatches, the version check (rules 4, 5); a simulated next-minor host (everyimport stubbed at the newer version, plus extra functions and an extradiff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/events.wit b/sdk/rust/openidea-plugin/tests/api/released/events.witsimilarity index 98%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/events.witrename to sdk/rust/openidea-plugin/tests/api/released/events.witindex 2d118d812..7da95eac5 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/events.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/events.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Workbench events, delivered in batches to `event-handler.handle`.interface events {diff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/exports.wit b/sdk/rust/openidea-plugin/tests/api/released/exports.witsimilarity index 98%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/exports.witrename to sdk/rust/openidea-plugin/tests/api/released/exports.witindex 065ef9a5f..808377432 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/exports.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/exports.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];interface lifecycle {use types.{context, error};diff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/host.wit b/sdk/rust/openidea-plugin/tests/api/released/host.witsimilarity index 78%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/host.witrename to sdk/rust/openidea-plugin/tests/api/released/host.witindex b6325cb71..c7ac7f916 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/host.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/host.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Writes to the IDE log, tagged with the plugin id.interface log {@@ -8,7 +8,7 @@ interface log {}interface ui {- use types.{notification-level};+ use types.{error, notification-level};record status-item {text: string,@@ -23,6 +23,10 @@ interface ui {/// Shows or updates the plugin's status bar item `id` in every window.set-status-item: func(id: string, item: status-item);remove-status-item: func(id: string);+ /// Copies `text` to the system clipboard. Requires `clipboard`.+ copy-to-clipboard: func(text: string) -> result<_, error>;+ /// Opens an `http://` or `https://` URL in the user's default browser.+ open-url: func(url: string) -> result<_, error>;}/// Persistent key-value storage of the plugin (survives restarts and idlediff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/io.wit b/sdk/rust/openidea-plugin/tests/api/released/io.witsimilarity index 98%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/io.witrename to sdk/rust/openidea-plugin/tests/api/released/io.witindex f1fe634a3..b93ea079e 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/io.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/io.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Problems in files, shown in the editor and the Problems view.interface diagnostics {diff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/plugin.wit b/sdk/rust/openidea-plugin/tests/api/released/plugin.witsimilarity index 98%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/plugin.witrename to sdk/rust/openidea-plugin/tests/api/released/plugin.witindex 938ee0842..e9fc0ac85 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/plugin.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/plugin.wit@@ -7,7 +7,7 @@/// or processes beyond WASI's clocks and randomness; everything else goes/// through the imports below, gated by the capabilities granted in/// `plugin.toml` (a missing one returns `error::denied`).-package openidea:[email protected];+package openidea:[email protected];world plugin {import log;diff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/providers.wit b/sdk/rust/openidea-plugin/tests/api/released/providers.witsimilarity index 99%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/providers.witrename to sdk/rust/openidea-plugin/tests/api/released/providers.witindex 97dd4c7a6..17c1123a8 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/providers.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/providers.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Editor features a plugin provides for the languages it declares under/// `[[contributes.providers]]` (the host calls only declared kinds). They rundiff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/types.wit b/sdk/rust/openidea-plugin/tests/api/released/types.witsimilarity index 98%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/types.witrename to sdk/rust/openidea-plugin/tests/api/released/types.witindex 2e2b48f74..de35cadf6 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/types.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/types.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Shared types. Positions are 0-based lines and UTF-16 code unit columns,/// as in the editor and LSP.diff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/views.wit b/sdk/rust/openidea-plugin/tests/api/released/views.witsimilarity index 93%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/views.witrename to sdk/rust/openidea-plugin/tests/api/released/views.witindex dcc806dcb..8a67e222e 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/views.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/views.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];/// Declarative views: tool windows declared/// under `[[contributes.views]]` and custom editors under@@ -133,6 +133,10 @@ interface views {/// `program` (pinned by a `process:<program>` grant) with `args` in the/// project root: long-running output (logs) and interactive sessions.open-terminal: func(title: string, program: string, args: list<string>) -> result<_, error>;+ /// Opens `path` (project-relative or absolute, inside the project) in an+ /// editor of the window the call came from, the caret at `line` and+ /// `column` (0-based; UTF-16 column): a view's links to code.+ open-location: func(path: string, line: u32, column: u32) -> result<_, error>;}/// The plugin's own settings (`[contributes.settings]`), as the user set themdiff --git a/sdk/rust/openidea-plugin/tests/api/1.0.0/workspace.wit b/sdk/rust/openidea-plugin/tests/api/released/workspace.witsimilarity index 94%rename from sdk/rust/openidea-plugin/tests/api/1.0.0/workspace.witrename to sdk/rust/openidea-plugin/tests/api/released/workspace.witindex febca7c6f..180040471 100644--- a/sdk/rust/openidea-plugin/tests/api/1.0.0/workspace.wit+++ b/sdk/rust/openidea-plugin/tests/api/released/workspace.wit@@ -1,4 +1,4 @@-package openidea:[email protected];+package openidea:[email protected];interface workspace {use types.{error};@@ -84,6 +84,8 @@ interface vcs {/// `none` when the project is not in a repository. Requires `vcs.read`.status: func(project: borrow<project>) -> result<option<repository-status>, error>;+ /// Configured remotes (`name`, fetch `url`), in order. Requires `vcs.read`.+ remotes: func(project: borrow<project>) -> result<list<tuple<string, string>>, error>;/// Fetches all remotes (pruning deleted branches). Requires `vcs.write`./// Long-running: call it inside a task.fetch: func(project: borrow<project>) -> result<_, error>;diff --git a/sdk/rust/openidea-plugin/tests/api_frozen.rs b/sdk/rust/openidea-plugin/tests/api_frozen.rsindex b5a0e08ca..79ca3e07f 100644--- a/sdk/rust/openidea-plugin/tests/api_frozen.rs+++ b/sdk/rust/openidea-plugin/tests/api_frozen.rs@@ -3,11 +3,13 @@//! a field added to a record or a case added to a variant breaks every//! component built for the release.//!-//! `tests/api/<version>/` is the WIT of each release, copied when it was-//! frozen. Every interface, type and function in it must still exist in-//! `wit/` with the same definition; additions are fine. When a version is-//! released, copy `wit/` to `tests/api/<that version>/`. Until the first-//! release there is no snapshot and the API may still change freely.+//! `tests/api/released/` is the WIT of the latest released version. Every+//! interface, type and function in it must still exist in `wit/` with the same+//! definition. Additions need a newer version than the snapshot's: under the+//! released version `wit/` must match it exactly. When a version ships, copy+//! `wit/` over the snapshot (the release workflow refuses a tag whose `wit/`+//! version differs from it). Each snapshot passed this check against the one+//! before, so the latest one covers every earlier release.use std::collections::BTreeMap;use std::path::Path;@@ -110,77 +112,83 @@ fn anonymous(r: &Resolve, id: TypeId) -> String {}}-/// The frozen releases (`tests/api/<version>/`), none before the first release.-fn releases(root: &Path) -> Vec<std::path::PathBuf> {- match std::fs::read_dir(root.join("tests/api")) {- Ok(dir) => dir.map(|e| e.unwrap().path()).filter(|p| p.is_dir()).collect(),- Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),- Err(e) => panic!("tests/api: {e}"),- }+fn root() -> &'static Path {+ Path::new(env!("CARGO_MANIFEST_DIR"))+}++/// The latest released version's WIT.+fn released() -> std::path::PathBuf {+ root().join("tests/api/released")+}++/// The `package openidea:[email protected]` version of a WIT directory.+fn version(dir: &Path) -> Vec<u64> {+ let src = std::fs::read_to_string(dir.join("plugin.wit")).unwrap_or_else(|e| panic!("{}: {e}", dir.display()));+ let v = src.lines().find_map(|l| l.trim().strip_prefix("package openidea:plugin@")).unwrap();+ v.trim_end_matches(';').split('.').map(|p| p.parse().unwrap()).collect()}#[test]fn the_surface_covers_the_whole_api() {- // Keeps the check below meaningful while there is no release to compare.- let current = surface(&Path::new(env!("CARGO_MANIFEST_DIR")).join("wit"));- assert!(current.len() > 50, "only {} items: did wit/ load?", current.len());- assert!(current.keys().any(|k| k.starts_with("world ")));- assert!(current.keys().any(|k| k.contains("/func ")));- assert!(current.keys().any(|k| k.contains("/type ")));+ for dir in [root().join("wit"), released()] {+ let items = surface(&dir);+ assert!(items.len() > 50, "{}: only {} items: did it load?", dir.display(), items.len());+ assert!(items.keys().any(|k| k.starts_with("world ")));+ assert!(items.keys().any(|k| k.contains("/func ")));+ assert!(items.keys().any(|k| k.contains("/type ")));+ }}#[test]-fn released_apis_are_unchanged() {- let root = Path::new(env!("CARGO_MANIFEST_DIR"));- let current = surface(&root.join("wit"));- for dir in releases(root) {- let release = surface(&dir);- let version = dir.file_name().unwrap().to_string_lossy().into_owned();- let mut broken = Vec::new();- for (key, was) in &release {- match current.get(key) {- None => broken.push(format!("{key}: removed (was {was})")),- // A world may gain imports and exports; everything else stays as it was. Items are- // compared without their `@version`: a later minor names them `@1.1.0`, and wasmtime- // resolves the release's `@1.0.0` to it.- Some(now) if key.starts_with("world ") => {- let had = |s: &str, part: &str| -> Vec<String> {- let start = s.find(part).unwrap() + part.len();- let end = s[start..].find(']').unwrap() + start;- s[start..end]- .split(", ")- .filter(|x| !x.is_empty())- .map(|x| x.split('@').next().unwrap_or(x).to_owned())- .collect()- };- for part in ["imports [", "exports ["] {- let now = had(now, part);- for item in had(was, part) {- if !now.contains(&item) {- broken.push(format!("{key}: no longer has {item}"));- }+fn the_released_api_is_unchanged() {+ let current = surface(&root().join("wit"));+ let release = surface(&released());+ let mut broken = Vec::new();+ for (key, was) in &release {+ match current.get(key) {+ None => broken.push(format!("{key}: removed (was {was})")),+ // A world may gain imports and exports; everything else stays as it was. Items are+ // compared without their `@version`: a later minor names them `@1.2.0`, and wasmtime+ // resolves the release's `@1.1.0` to it.+ Some(now) if key.starts_with("world ") => {+ let had = |s: &str, part: &str| -> Vec<String> {+ let start = s.find(part).unwrap() + part.len();+ let end = s[start..].find(']').unwrap() + start;+ s[start..end]+ .split(", ")+ .filter(|x| !x.is_empty())+ .map(|x| x.split('@').next().unwrap_or(x).to_owned())+ .collect()+ };+ for part in ["imports [", "exports ["] {+ let now = had(now, part);+ for item in had(was, part) {+ if !now.contains(&item) {+ broken.push(format!("{key}: no longer has {item}"));}}}- Some(now) if now != was => broken.push(format!("{key}:\n was {was}\n now {now}")),- Some(_) => {}}+ Some(now) if now != was => broken.push(format!("{key}:\n was {was}\n now {now}")),+ Some(_) => {}}- assert!(broken.is_empty(), "plugin API {version} changed incompatibly:\n {}", broken.join("\n "));- assert!(release.len() > 50, "{version}: only {} items: did the snapshot load?", release.len());}+ assert!(broken.is_empty(), "the released plugin API changed incompatibly:\n {}", broken.join("\n "));}#[test]-fn the_current_api_is_a_release_or_newer_than_all() {- // `wit/` is either a frozen release or the next one; never older.- let root = Path::new(env!("CARGO_MANIFEST_DIR"));- let src = std::fs::read_to_string(root.join("wit/plugin.wit")).unwrap();- let current = src.lines().find_map(|l| l.trim().strip_prefix("package openidea:plugin@")).unwrap();- let current: Vec<u64> = current.trim_end_matches(';').split('.').map(|p| p.parse().unwrap()).collect();- for dir in releases(root) {- let name = dir.file_name().unwrap().to_string_lossy().into_owned();- let release: Vec<u64> = name.split('.').map(|p| p.parse().unwrap()).collect();- assert!(release <= current, "tests/api/{name} is newer than wit/ ({current:?})");+fn additions_need_a_newer_version() {+ // A component built from `wit/` imports what `wit/` declares; under a released version an+ // IDE of that release would lack the additions and refuse it.+ let (current, release) = (version(&root().join("wit")), version(&released()));+ assert!(current >= release, "wit/ ({current:?}) is older than the released API ({release:?})");+ if current == release {+ let (now, was) = (surface(&root().join("wit")), surface(&released()));+ let added: Vec<_> = now.keys().filter(|k| now.get(*k) != was.get(*k)).collect();+ assert!(+ added.is_empty(),+ "wit/ adds to the released version {release:?}; bump the package version in wit/ \+ (and the SDK's copy, ENGINE_VERSION, API_VERSION) first:\n {added:?}"+ );}}