From c7cd72b09e5f5c4bdbd65d208832dc51532fc4cf Mon Sep 17 00:00:00 2001 From: dotCooCoo Date: Sat, 31 Oct 2026 04:28:23 -0700 Subject: [PATCH 01/68] M3: Selection colors rows apply library color styles and create a style A row's Styles menu lists this file's color styles (library copies are no longer listed as local), then each enabled library's published color styles under the library's name. Choosing a library style copies it in, linked and read-only, and applies it to every fill and stroke the row stands for in one undo step (selection.applyColorStyle with `library`). A row linked to a style or variable now has the Styles button too, so it can switch to another style. Create style on an ordinary row opens a window with the next free "Color n" name. Create makes a style of the row's whole paint (gradient stops, opacity and blend mode included) and links it to every target in one undo step (selection.createColorStyle {targets, name, description?}). A name another style has, an empty name, or a row whose slots no longer share one paint is refused, and the window stays open. Text ranges with fills of their own take the style's value without a link. --- crates/engine/src/cmd/library.rs | 2 +- .../engine/src/selection/selection_colors.rs | 78 +++++- crates/engine/tests/it/selection_colors.rs | 180 ++++++++++++- crates/ui-egui/src/panels/selection_colors.rs | 240 +++++++++++++++--- docs/ui-parity.md | 2 +- 5 files changed, 461 insertions(+), 41 deletions(-) diff --git a/crates/engine/src/cmd/library.rs b/crates/engine/src/cmd/library.rs index 5f3263765..8aeb12d49 100644 --- a/crates/engine/src/cmd/library.rs +++ b/crates/engine/src/cmd/library.rs @@ -194,7 +194,7 @@ fn with(p: &Value, keys: &[&str], mut base: Value) -> Value { } /// An enabled library of the active document (`library` param), read from its file. -fn library(s: &mut Session, cmd: &str, p: &Value) -> Result<(LibraryLink, Arc)> { +pub(crate) fn library(s: &mut Session, cmd: &str, p: &Value) -> Result<(LibraryLink, Arc)> { let key = req_string(cmd, p, "library")?; let link = find_link(s.doc()?, &key) .cloned() diff --git a/crates/engine/src/selection/selection_colors.rs b/crates/engine/src/selection/selection_colors.rs index 6ab99e819..b653f333b 100644 --- a/crates/engine/src/selection/selection_colors.rs +++ b/crates/engine/src/selection/selection_colors.rs @@ -5,14 +5,14 @@ use std::collections::{BTreeMap, BTreeSet}; use figcraft_color::{Paint, PaintKind}; -use figcraft_doc::{Document, NodeId, NodeKind, StyleKind, VariableType, VariableValue}; +use figcraft_doc::{Document, NodeId, NodeKind, Style, StyleKind, VariableType, VariableValue}; use serde::{Deserialize, Serialize}; use serde_json::{Value, json}; use crate::cmd::lists::{BoundList, list_binding, rebind_edited_paint}; use crate::cmd::styles::{rebind_paint_alpha, unbind_slot}; -use crate::params::{get, paint_of, parse, req_string, targets}; -use crate::{CommandSpec, Result, Session, bad, spec}; +use crate::params::{get, paint_of, parse, req_string, string, targets}; +use crate::{CommandSpec, EngineError, Result, Session, bad, spec}; #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] #[serde(rename_all = "camelCase", deny_unknown_fields)] @@ -127,10 +127,17 @@ pub fn specs() -> Vec { spec!( "selection.applyColorStyle", "Apply selection color style", - "{targets, style}; applies the color style to matching fill/stroke lists (text ranges keep typography)", + "{targets, style (id or name), library? (an enabled library: id, name or path; the style is then one it publishes, copied in linked and read-only)}; applies the color style to matching fill/stroke lists (text ranges keep typography)", true, apply_style ), + spec!( + "selection.createColorStyle", + "Create selection color style", + "{targets, name, description?} → {id}; makes a color style of the paint the targets share and applies it to them as selection.applyColorStyle does; a name another style has is refused", + true, + create_style + ), spec!( "selection.bindColorVariable", "Apply selection color variable", @@ -205,15 +212,72 @@ fn apply_style(s: &mut Session, p: &Value) -> Result { const CMD: &str = "selection.applyColorStyle"; let targets = checked_targets(s, p, CMD)?; let name = req_string(CMD, p, "style")?; + let name = if string(p, "library").is_some() { import_library_style(s, CMD, p, &name)? } else { name }; let style = s.doc()?.style(&name).cloned().ok_or_else(|| bad(CMD, "no such color style"))?; if !matches!(style.kind, StyleKind::Paint { .. }) { return Err(bad(CMD, "a color style is required")); } - for target in &targets { + link_style(s, &targets, &style)?; + Ok(json!({"ok": true})) +} + +/// Copy the color style `key` (id, else name) that the enabled library `library` publishes into the +/// document, linked and read-only, and return the copy's id. +fn import_library_style(s: &mut Session, cmd: &str, p: &Value, key: &str) -> Result { + let (link, lib) = crate::cmd::library::library(s, cmd, p)?; + let published = |st: &&Style| lib.manifest.style(&st.id).is_some_and(|x| x.published); + let styles = || lib.doc.styles.iter().filter(published); + let style = styles() + .find(|st| st.id == key) + .or_else(|| styles().find(|st| st.name == key)) + .ok_or_else(|| bad(cmd, format!("\"{}\" publishes no style `{key}`", link.name)))?; + if !matches!(style.kind, StyleKind::Paint { .. }) { + return Err(bad(cmd, "a color style is required")); + } + let keys = BTreeSet::from([style.id.clone()]); + crate::library::import_styles(s.doc_mut()?, &lib, &keys, false) + .into_values() + .next() + .ok_or_else(|| EngineError::Other("the style didn't import".into())) +} + +fn create_style(s: &mut Session, p: &Value) -> Result { + const CMD: &str = "selection.createColorStyle"; + let targets = checked_targets(s, p, CMD)?; + let doc = s.doc()?; + let paint = targets.first().and_then(|t| t.paint(doc)).ok_or_else(|| bad(CMD, "a selection color target no longer exists"))?; + if !matches!(paint.kind, PaintKind::Solid { .. } | PaintKind::Gradient(_)) { + return Err(bad(CMD, "a solid or gradient paint is required")); + } + if targets.iter().any(|t| t.paint(doc).as_ref() != Some(&paint)) { + return Err(bad(CMD, "the targets no longer share one paint")); + } + let name = crate::cmd::variables::clean_name(&req_string(CMD, p, "name")?).ok_or_else(|| bad(CMD, "name can't be empty"))?; + if doc.styles.iter().any(|st| st.name == name) { + return Err(bad(CMD, format!("a style named `{name}` already exists"))); + } + let doc = s.doc_mut()?; + let id = doc.new_style_id(); + let style = Style { + id: id.clone(), + name, + description: string(p, "description").unwrap_or_default(), + kind: StyleKind::Paint { paints: vec![paint] }, + bound: BTreeMap::new(), + }; + doc.styles.push(style.clone()); + link_style(s, &targets, &style)?; + Ok(json!({"id": id})) +} + +/// Apply paint style `style` to every target: a fill or stroke list is linked to it; a text range +/// takes its resolved paints and keeps its typography. +fn link_style(s: &mut Session, targets: &[PaintTarget], style: &Style) -> Result<()> { + for target in targets { if let Some((start, end)) = target.range { // Text ranges have typography-style links, not paint-style links. Copy resolved paint // values just as an explicit range fill does; never replace its font or size. - let StyleKind::Paint { paints } = crate::style_vars::kind_for(s.doc()?, &style, target.id).into_owned() else { continue }; + let StyleKind::Paint { paints } = crate::style_vars::kind_for(s.doc()?, style, target.id).into_owned() else { continue }; let n = s.doc_mut()?.get_mut(target.id)?; if let NodeKind::Text(t) = &mut n.kind { t.restyle(start, end, |st| st.fills = Some(paints.clone())); @@ -222,7 +286,7 @@ fn apply_style(s: &mut Session, p: &Value) -> Result { crate::cmd::styles::apply_style_ref(s.doc_mut()?, target.id, if target.fills { "fillStyle" } else { "strokeStyle" }, Some(&style.id))?; } } - Ok(json!({"ok": true})) + Ok(()) } /// The binding key (`fills//color` or `strokes//color`) of the slot a target stands for, when the diff --git a/crates/engine/tests/it/selection_colors.rs b/crates/engine/tests/it/selection_colors.rs index c3fc4f97c..41204e5db 100644 --- a/crates/engine/tests/it/selection_colors.rs +++ b/crates/engine/tests/it/selection_colors.rs @@ -156,9 +156,14 @@ fn invalid_or_stale_targets_roll_back_atomically() { assert!(s.execute("selection.setPaint", &json!({"targets":red.targets,"paint":"#0000ff"})).is_err()); assert_eq!(fill(&s, a), "FF0000"); assert_eq!(s.undo_depth(), before); - for command in - ["selection.setPaint", "selection.selectColor", "selection.applyColorStyle", "selection.bindColorVariable", "selection.detachColor"] - { + for command in [ + "selection.setPaint", + "selection.selectColor", + "selection.applyColorStyle", + "selection.bindColorVariable", + "selection.detachColor", + "selection.createColorStyle", + ] { for params in [json!({}), json!({"targets":[]}), json!({"targets":[{"id":a,"fills":true,"index":0,"range":[0,1]}]})] { assert!(s.execute(command, ¶ms).is_err()); } @@ -421,3 +426,172 @@ fn scopes_filter_the_menu_but_the_command_binds_anyway() { run(&mut s, "selection.bindColorVariable", json!({"targets":fill_slot,"variable":"Line"})); assert_eq!(fill(&s, a), "00FF00"); } + +#[test] +fn a_style_created_from_a_row_links_its_fills_and_strokes_in_one_undo_step() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#0000ff"); + run(&mut s, "stroke.add", json!({"id":b,"color":"#ff0000"})); + let red = group(&s, &[a, b], "FF0000"); + let before = s.undo_depth(); + let id = run(&mut s, "selection.createColorStyle", json!({"targets":red.targets,"name":"Brand/Red"}))["id"].clone(); + let doc = s.doc().unwrap(); + let style = doc.style(id.as_str().unwrap()).unwrap(); + assert_eq!(style.name, "Brand/Red"); + assert!(matches!(&style.kind, figcraft_doc::StyleKind::Paint { paints } if paints.len() == 1 && paints[0] == red.paint)); + assert_eq!(doc.node(a).unwrap().styles.fill.as_deref(), id.as_str()); + assert_eq!(doc.node(b).unwrap().styles.stroke.as_deref(), id.as_str()); + assert_eq!(doc.node(b).unwrap().styles.fill, None); + assert_eq!(fill(&s, b), "0000FF"); + assert_eq!(s.undo_depth().0, before.0 + 1); + run(&mut s, "style.update", json!({"style":id,"value":"#00ff00"})); + assert_eq!(fill(&s, a), "00FF00"); + assert_eq!(s.doc().unwrap().node(b).unwrap().strokes[0].solid_color().unwrap().to_hex(), "00FF00"); + s.undo().unwrap(); + s.undo().unwrap(); + assert!(s.doc().unwrap().style("Brand/Red").is_none()); + assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill, None); + assert_eq!(fill(&s, a), "FF0000"); + s.redo().unwrap(); + assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill.as_deref(), id.as_str()); +} + +#[test] +fn a_created_style_keeps_the_rows_gradient_opacity_and_blend_mode() { + use figcraft_color::{BlendMode, Color, Gradient, GradientKind}; + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#0000ff"); + let mut paint = Paint::gradient(Gradient::default_for(GradientKind::Radial, Color::BLACK)); + paint.opacity = 0.5; + paint.blend = BlendMode::Multiply; + for id in [a, b] { + run(&mut s, "fill.set", json!({"id":id,"paint":paint})); + } + let row = collect(s.doc().unwrap(), &[a, b]).into_iter().find(|g| g.paint == paint).unwrap(); + assert_eq!(row.targets.len(), 2); + let id = run(&mut s, "selection.createColorStyle", json!({"targets":row.targets,"name":"Shade"}))["id"].clone(); + let doc = s.doc().unwrap(); + assert!(matches!(&doc.style("Shade").unwrap().kind, figcraft_doc::StyleKind::Paint { paints } if paints == &vec![paint.clone()])); + for n in [a, b] { + assert_eq!(doc.node(n).unwrap().fills, vec![paint.clone()]); + assert_eq!(doc.node(n).unwrap().styles.fill.as_deref(), id.as_str()); + } +} + +#[test] +fn creating_a_style_refuses_taken_or_empty_names_and_stale_rows_and_changes_nothing() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#ff0000"); + run(&mut s, "style.create", json!({"type":"paint","name":"Brand","value":"#00ff00"})); + let red = group(&s, &[a, b], "FF0000"); + let before = s.undo_depth(); + let styles = s.doc().unwrap().styles.len(); + for name in ["Brand", " Brand ", "", " "] { + assert!(s.execute("selection.createColorStyle", &json!({"targets":red.targets,"name":name})).is_err(), "{name:?}"); + } + assert!(s.execute("selection.createColorStyle", &json!({"targets":red.targets})).is_err()); + // One slot of the row changed since it was listed: the row no longer stands for one paint. + run(&mut s, "fill.set", json!({"id":b,"color":"#0000ff"})); + let before_stale = s.undo_depth(); + assert!(s.execute("selection.createColorStyle", &json!({"targets":red.targets,"name":"Red"})).is_err()); + assert_eq!(s.undo_depth(), before_stale); + assert_eq!(s.undo_depth().0, before.0 + 1); + let doc = s.doc().unwrap(); + assert_eq!(doc.styles.len(), styles); + assert_eq!(doc.node(a).unwrap().styles.fill, None); + assert_eq!(fill(&s, a), "FF0000"); +} + +#[test] +fn a_linked_row_switches_to_another_style() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#0000ff"); + run(&mut s, "style.create", json!({"type":"paint","name":"Brand","value":"#ff0000"})); + let accent = run(&mut s, "style.create", json!({"type":"paint","name":"Accent","value":"#00ff00"}))["id"].clone(); + run(&mut s, "style.apply", json!({"id":a,"style":"Brand","target":"fill"})); + let linked = collect(s.doc().unwrap(), &[a, b]).into_iter().find(|g| g.style.is_some()).unwrap(); + run(&mut s, "selection.applyColorStyle", json!({"targets":linked.targets,"style":"Accent"})); + assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill.as_deref(), accent.as_str()); + assert_eq!(fill(&s, a), "00FF00"); + assert_eq!(fill(&s, b), "0000FF"); +} + +struct Fixture(std::path::PathBuf); + +impl Drop for Fixture { + #[allow(clippy::disallowed_methods)] + fn drop(&mut self) { + let _ = std::fs::remove_dir_all(&self.0); + } +} + +/// A saved library file publishing the color style "Brand" (#0000ff) and the text style "Heading", +/// with the color style "_Draft" left unpublished; the fixture, the file and the library's id. +#[allow(clippy::disallowed_methods)] +fn color_library(tag: &str) -> (Fixture, std::path::PathBuf, Value) { + let fixture = Fixture(std::env::temp_dir().join(format!("figcraft-selection-colors-{tag}-{}", std::process::id()))); + let _ = std::fs::remove_dir_all(&fixture.0); + std::fs::create_dir(&fixture.0).unwrap(); + let path = fixture.0.join("library.figcraft"); + let mut publisher = Session::new(); + run(&mut publisher, "style.create", json!({"type":"paint","name":"Brand","value":"#0000ff"})); + run(&mut publisher, "style.create", json!({"type":"paint","name":"_Draft","value":"#00ff00"})); + let text = run(&mut publisher, "text.create", json!({"text":"Title"}))["id"].clone(); + run(&mut publisher, "style.create", json!({"type":"text","name":"Heading","from":text})); + let published = run(&mut publisher, "library.publish", json!({})); + assert_eq!(published["styles"], 2); + run(&mut publisher, "file.saveAs", json!({"path":path})); + (fixture, path, published["id"].clone()) +} + +#[test] +fn a_row_applies_a_published_library_style_as_a_linked_copy_in_one_undo_step() { + let (_fixture, path, library) = color_library("apply"); + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#00ff00"); + run(&mut s, "stroke.add", json!({"id":b,"color":"#ff0000"})); + run(&mut s, "library.add", json!({"path":path})); + let red = group(&s, &[a, b], "FF0000"); + let before = s.undo_depth(); + run(&mut s, "selection.applyColorStyle", json!({"targets":red.targets,"style":"Brand","library":library})); + let doc = s.doc().unwrap(); + let copy = doc.node(a).unwrap().styles.fill.clone().unwrap(); + assert!(figcraft_engine::library::is_remote_style(doc, ©)); + assert_eq!(doc.node(b).unwrap().styles.stroke.as_deref(), Some(copy.as_str())); + assert_eq!(fill(&s, a), "0000FF"); + assert_eq!(fill(&s, b), "00FF00"); + assert_eq!(s.undo_depth().0, before.0 + 1); + s.undo().unwrap(); + let doc = s.doc().unwrap(); + assert!(doc.style(©).is_none()); + assert_eq!(doc.node(a).unwrap().styles.fill, None); + assert_eq!(fill(&s, a), "FF0000"); + // Choosing it again reuses the one copy. + s.redo().unwrap(); + let blue = group(&s, &[a, b], "0000FF"); + run(&mut s, "selection.applyColorStyle", json!({"targets":blue.targets,"style":"Brand","library":library})); + assert_eq!(s.doc().unwrap().styles.len(), 1); +} + +#[test] +fn library_styles_that_are_unpublished_not_colors_or_not_enabled_are_refused() { + let (_fixture, path, library) = color_library("refuse"); + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + rectangle(&mut s, "#00ff00"); + let red = group(&s, &[a], "FF0000"); + assert!(s.execute("selection.applyColorStyle", &json!({"targets":red.targets,"style":"Brand","library":library})).is_err()); + run(&mut s, "library.add", json!({"path":path})); + let before = s.undo_depth(); + for (style, lib) in [("_Draft", library.clone()), ("Heading", library.clone()), ("Missing", library.clone()), ("Brand", json!("Elsewhere"))] { + assert!(s.execute("selection.applyColorStyle", &json!({"targets":red.targets,"style":style,"library":lib})).is_err(), "{style}"); + } + assert_eq!(s.undo_depth(), before); + assert!(s.doc().unwrap().styles.is_empty()); + assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill, None); +} diff --git a/crates/ui-egui/src/panels/selection_colors.rs b/crates/ui-egui/src/panels/selection_colors.rs index 97333367f..7a8189ddb 100644 --- a/crates/ui-egui/src/panels/selection_colors.rs +++ b/crates/ui-egui/src/panels/selection_colors.rs @@ -4,8 +4,9 @@ use std::sync::Arc; use egui::{Id, Ui}; -use figcraft_color::Color; -use figcraft_doc::{Document, NodeId, StyleKind, VariableType}; +use figcraft_color::{Color, Paint}; +use figcraft_doc::{Document, NodeId, PublishedLibrary, Style, StyleKind, VariableType}; +use figcraft_engine::library; use figcraft_engine::selection_colors::{PaintTarget, SelectionColor, bind_refusal, collect, in_scope}; use serde_json::json; @@ -58,13 +59,15 @@ pub(crate) fn toggle(app: &mut FigApp, targets: Vec, response: Opti } /// Draw the selection-colour groups (at least two): swatch opens the picker, hex and opacity -/// edits, style/variable detach/apply/bind, and “select layers with this color”; disabled -/// during an interaction. +/// edits, style/variable detach/apply/bind, a style from this file or an enabled library, Create +/// style, and “select layers with this color”; disabled during an interaction. pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId]) { let Ok(ds) = app.session.ds() else { return }; let interacting = ds.interaction.is_some(); - let colors = colors(ui, ds.uid, doc, ids, interacting); + let uid = ds.uid; + let colors = colors(ui, uid, doc, ids, interacting); if colors.len() < 2 { + ui.data_mut(|d| d.remove::(create_form_id())); return; } let t = Tokens::get(ui.ctx()); @@ -77,12 +80,14 @@ pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId crate::right::row(ui, 32.0, |ui| { let swatch = widgets::swatch(ui, &group.paint, 24.0).tip(tr("Edit colour")); toggle(app, group.targets.clone(), Some(&swatch)); - let width = (ui.available_width() - 116.0).max(40.0); let linked_name = group .style .as_ref() .and_then(|id| doc.style(id).map(|s| s.name.as_str())) .or_else(|| group.variable.as_ref().and_then(|id| doc.variables.get_by_id(id).map(|v| v.name.as_str()))); + // A linked row has a Detach button beside its Styles button. + let buttons = if linked_name.is_some() { 148.0 } else { 116.0 }; + let width = (ui.available_width() - buttons).max(40.0); if let Some(name) = linked_name { let response = widgets::dropdown(ui, name, width, None); toggle(app, group.targets.clone(), Some(&response)); @@ -112,28 +117,14 @@ pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId paint.opacity = (value / 100.0).clamp(0.0, 1.0); app.run("selection.setPaint", json!({"targets": group.targets, "paint": paint})); } - if linked_name.is_some() { - let detach = if group.style.is_some() { tr("Detach style") } else { tr("Detach variable") }; - if icons::button(ui, Icon::Detach, 24.0, false, detach).clicked() { - app.run("selection.detachColor", json!({"targets": group.targets})); - } - } else { - let styles = icons::button(ui, Icon::Styles, 24.0, false, tr("Color styles")); - crate::right::menu_popup(&styles).show(|ui| { - let mut any = false; - for style in &doc.styles { - if !matches!(style.kind, StyleKind::Paint { .. }) { - continue; - } - any = true; - if crate::right::menu_item(ui, &style.name, "") { - app.run("selection.applyColorStyle", json!({"targets": group.targets, "style": style.id})); - app.ui.picker = None; - ui.close(); - } - } - if !any { - widgets::label(ui, tr("No color styles"), t.text_secondary); + let styles = icons::button(ui, Icon::Styles, 24.0, false, tr("Color styles")); + crate::right::menu_popup(&styles).show(|ui| { + style_items(app, ui, doc, group, &t); + if linked_name.is_none() { + ui.separator(); + if crate::right::menu_item(ui, tr("Create style"), "") { + open_create_form(app, ui, doc, group); + ui.close(); } let variables: Vec<_> = doc .variables @@ -156,7 +147,13 @@ pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId ui.close(); } } - }); + } + }); + if linked_name.is_some() { + let detach = if group.style.is_some() { tr("Detach style") } else { tr("Detach variable") }; + if icons::button(ui, Icon::Detach, 24.0, false, detach).clicked() { + app.run("selection.detachColor", json!({"targets": group.targets})); + } } if icons::button(ui, Icon::Move, 24.0, false, tr("Select layers with this color")).clicked() { app.run("selection.selectColor", json!({"targets": group.targets})); @@ -168,6 +165,106 @@ pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId }); ui.add_space(8.0); widgets::separator(ui); + create_form(app, ui.ctx(), uid); +} + +/// The paint styles a row's Styles menu offers: this file's (not library copies), then each enabled +/// library's published ones under its name (a library this session hasn't read offers none). A choice +/// applies the style to the row's targets. +fn style_items(app: &mut FigApp, ui: &mut Ui, doc: &Document, group: &SelectionColor, t: &Tokens) { + let paint = |s: &&Style| matches!(s.kind, StyleKind::Paint { .. }); + let local: Vec<&Style> = library::local_styles(doc).filter(paint).collect(); + let libs = crate::variable_ui::libraries(app, doc); + let offered: Vec<(&PublishedLibrary, Vec<&Style>)> = libs + .iter() + .map(|l| (l.as_ref(), l.doc.styles.iter().filter(|s| l.manifest.style(&s.id).is_some_and(|x| x.published)).filter(paint).collect::>())) + .filter(|(_, list)| !list.is_empty()) + .collect(); + if local.is_empty() && offered.is_empty() { + widgets::label(ui, tr("No color styles"), t.text_secondary); + } + for style in local { + if crate::right::menu_item(ui, &style.name, "") { + app.run("selection.applyColorStyle", json!({"targets": group.targets, "style": style.id})); + app.ui.picker = None; + ui.close(); + } + } + for (lib, list) in offered { + ui.separator(); + widgets::label(ui, &lib.manifest.name, t.text_secondary); + for style in list { + if crate::right::menu_item(ui, &style.name, "") { + app.run("selection.applyColorStyle", json!({"targets": group.targets, "style": style.id, "library": lib.manifest.id})); + app.ui.picker = None; + ui.close(); + } + } + } +} + +/// The Create style window's state: the document and row it was opened for, and the name typed. +#[derive(Clone)] +struct CreateForm { + document: u64, + targets: Vec, + paint: Paint, + name: String, +} + +fn create_form_id() -> Id { + Id::unique("selection_color_create_style") +} + +/// Open the Create style window for `group`, with the next free "Color n" name. +fn open_create_form(app: &mut FigApp, ui: &Ui, doc: &Document, group: &SelectionColor) { + let Ok(ds) = app.session.ds() else { return }; + let form = CreateForm { + document: ds.uid, + targets: group.targets.clone(), + paint: group.paint.clone(), + name: crate::style_picker::next_name(doc, "Color"), + }; + app.ui.picker = None; + ui.data_mut(|d| d.insert_temp(create_form_id(), form)); +} + +/// The Create style window: the row's paint, a name, Cancel and Create (Enter creates). Create runs +/// `selection.createColorStyle`; when it fails (a name in use, a row that changed) the window stays +/// open with the name for correction. +fn create_form(app: &mut FigApp, ctx: &egui::Context, document: u64) { + let Some(mut form) = ctx.data(|d| d.get_temp::(create_form_id())) else { return }; + if form.document != document { + ctx.data_mut(|d| d.remove::(create_form_id())); + return; + } + let (mut open, mut cancel, mut create) = (true, false, false); + crate::dialogs::window(tr("Create style"), ctx).id(create_form_id().with("window")).open(&mut open).show(ctx, |ui| { + ui.set_width(240.0); + ui.horizontal(|ui| { + widgets::swatch(ui, &form.paint, 24.0); + ui.label(widgets::paint_name(&form.paint)); + }); + ui.add_space(6.0); + let name = ui.add(egui::TextEdit::singleline(&mut form.name).hint_text(tr("Name")).desired_width(220.0)); + widgets::select_all_on_focus(ui, &name, &form.name); + if ui.memory(|m| m.focused().is_none()) { + name.request_focus(); + } + ui.add_space(10.0); + let ready = !form.name.trim().is_empty(); + ui.horizontal(|ui| { + cancel = widgets::button(ui, tr("Cancel"), false, true).clicked() || ui.input(|i| i.key_pressed(egui::Key::Escape)); + let enter = name.lost_focus() && ui.input(|i| i.key_pressed(egui::Key::Enter)); + create = (widgets::button(ui, tr("Create"), true, ready).clicked() || enter) && ready; + }); + }); + let made = create && app.run("selection.createColorStyle", json!({"targets": form.targets, "name": form.name.trim()})).is_some(); + if open && !cancel && !made { + ctx.data_mut(|d| d.insert_temp(create_form_id(), form)); + } else { + ctx.data_mut(|d| d.remove::(create_form_id())); + } } #[cfg(test)] @@ -369,4 +466,89 @@ mod tests { assert!(texts.iter().any(|(s, _)| s == "FF0000") && texts.iter().any(|(s, _)| s == "0000FF")); assert!(p.app.ui.last_error.is_none()); } + + fn text_at(texts: &[(String, Pos2)], s: &str) -> Pos2 { + texts.iter().rev().find(|(t, _)| t == s).unwrap_or_else(|| panic!("{s:?} isn't drawn")).1 + } + + #[test] + fn styles_menu_offers_an_enabled_librarys_published_color_styles() { + let dir = std::env::temp_dir().join(format!("figcraft-selection-colors-panel-{}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir(&dir).unwrap(); + let path = dir.join("library.figcraft"); + let mut publisher = Session::new(); + publisher.execute("style.create", &json!({"type":"paint","name":"Ocean","value":"#00ffff"})).unwrap(); + publisher.execute("style.create", &json!({"type":"paint","name":"_Draft","value":"#ffff00"})).unwrap(); + publisher.execute("library.publish", &json!({})).unwrap(); + publisher.execute("file.saveAs", &json!({"path":path})).unwrap(); + let (mut p, a, b) = Panel::new(); + p.app.run("library.add", json!({"path":path})); + let red = text_at(&p.frame(vec![]), "FF0000"); + p.click(Pos2::new(228.0, red.y)); + let texts = p.frame(vec![]); + let library_name = p.app.session.doc().unwrap().libraries.enabled[0].name.clone(); + assert!(texts.iter().any(|(s, _)| *s == library_name), "library styles are listed under the library's name"); + assert!(!texts.iter().any(|(s, _)| s == "_Draft"), "unpublished styles aren't offered"); + p.click(text_at(&texts, "Ocean")); + let _ = std::fs::remove_dir_all(&dir); + let doc = p.app.session.doc().unwrap(); + let copy = doc.node(a).unwrap().styles.fill.clone().unwrap(); + assert!(library::is_remote_style(doc, ©)); + assert_eq!(doc.node(a).unwrap().fills[0].solid_color().unwrap().to_hex(), "00FFFF"); + assert!(doc.node(b).unwrap().styles.fill.is_none()); + assert!(p.app.ui.last_error.is_none()); + // The copy is listed under its library, not as one of this file's styles. + let blue = text_at(&p.frame(vec![]), "0000FF"); + p.click(Pos2::new(228.0, blue.y)); + let texts = p.frame(vec![]); + assert_eq!(texts.iter().filter(|(s, _)| s == "Ocean").count(), 2, "the linked row's name and the library's entry"); + } + + #[test] + fn create_style_names_the_row_links_it_and_stays_open_on_a_taken_name() { + let (mut p, a, b) = Panel::new(); + let red = text_at(&p.frame(vec![]), "FF0000"); + p.click(Pos2::new(228.0, red.y)); + let create = text_at(&p.frame(vec![]), "Create style"); + p.click(create); + for _ in 0..2 { + p.frame(vec![]); + } + let form = p.ctx.data(|d| d.get_temp::(create_form_id())).expect("Create style opens its window"); + assert_eq!(form.name, "Color 1"); + // Another style takes the name first: Create fails and the window stays for a new name. + p.app.run("style.create", json!({"type":"paint","name":"Color 1","value":"#00ff00"})); + let button = text_at(&p.frame(vec![]), "Create"); + p.click(button); + assert!(p.ctx.data(|d| d.get_temp::(create_form_id())).is_some()); + assert!(p.app.session.doc().unwrap().node(a).unwrap().styles.fill.is_none()); + p.ctx.data_mut(|d| d.get_temp_mut_or_insert_with(create_form_id(), || form.clone()).name = "Brand".into()); + let before = p.app.session.undo_depth(); + let button = text_at(&p.frame(vec![]), "Create"); + p.click(button); + assert!(p.ctx.data(|d| d.get_temp::(create_form_id())).is_none()); + let doc = p.app.session.doc().unwrap(); + let brand = doc.style("Brand").unwrap().id.clone(); + assert_eq!(doc.node(a).unwrap().styles.fill.as_deref(), Some(brand.as_str())); + assert!(doc.node(b).unwrap().styles.fill.is_none()); + assert_eq!(p.app.session.undo_depth().0, before.0 + 1); + assert!(p.frame(vec![]).iter().any(|(s, _)| s == "Brand")); + } + + #[test] + fn a_linked_rows_styles_menu_switches_its_style() { + let (mut p, a, _) = Panel::new(); + p.app.run("style.create", json!({"type":"paint","name":"Brand","value":"#ff0000"})); + p.app.run("style.create", json!({"type":"paint","name":"Accent","value":"#00ff00"})); + p.app.run("style.apply", json!({"id":a,"style":"Brand","target":"fill"})); + let row = text_at(&p.frame(vec![]), "Brand"); + p.click(Pos2::new(196.0, row.y)); + let texts = p.frame(vec![]); + assert!(!texts.iter().any(|(s, _)| s == "Create style"), "a linked row has a style already"); + p.click(text_at(&texts, "Accent")); + let doc = p.app.session.doc().unwrap(); + assert_eq!(doc.node(a).unwrap().styles.fill.as_deref(), doc.style("Accent").map(|s| s.id.as_str())); + assert!(p.app.ui.last_error.is_none()); + } } diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 0286fd37d..5e634bc2b 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -74,7 +74,7 @@ interaction feel not yet compared. | Transform box at small sizes | done | a press inside a layer smaller than its handles moves it, the nearest handle wins, handles answer just outside and are hidden under 16 px on screen; cursors follow each handle and the box's rotation | | Locked layers | done | selectable from the layers panel; no handles, not dragged with the rest of a selection | | Smart selection spacing | partial | with layers in a row, a column or an aligned grid selected, the Layout section shows horizontal and vertical spacing ("Mixed" until set; typed, scrubbed, fractional and negative) and pink handles in the gaps on the canvas drag them, one undo step, Escape cancels (`arrange.spacing`; sizes, parents and offsets within each track kept; at most 2,000 layers; flow children, locked layers and layers inside instances left out). A ring at each layer's centre drags it to another place in a regular row, column or complete top-left-aligned grid: the others close up and make room around it with the gaps kept, and with Cmd/Ctrl held the two layers swap places instead, previewed live while dragging (`selection_reorder_tests`; no ring on a layer under 16 px on screen). Not covered: reordering irregular grids, and several marked layers moved together. Checked by its author on macOS and in the app on Windows (#402) | -| Selection colors | partial | for a mixed selection the Design panel lists their solid and gradient paints (children and text ranges included; hidden paints, masks, images, patterns and boolean operands left out; styles and variables listed apart): editing a colour changes every matching fill and stroke in one undo step, a row selects the layers that use it or applies a color style or color variable of the document, and a row linked to a style or variable detaches it, keeping the color (`selection.colors`, `selection.setPaint`, `selection.applyColorStyle`, `selection.bindColorVariable`, `selection.detachColor`, `selection.selectColor`). No library styles or variables from there, and no new style or variable from a row (#403) | +| Selection colors | partial | for a mixed selection the Design panel lists their solid and gradient paints (children and text ranges included; hidden paints, masks, images, patterns and boolean operands left out; styles and variables listed apart): editing a colour changes every matching fill and stroke in one undo step, a row selects the layers that use it or applies a color style or color variable of the document, and a row linked to a style or variable detaches it, keeping the color (`selection.colors`, `selection.setPaint`, `selection.applyColorStyle`, `selection.bindColorVariable`, `selection.detachColor`, `selection.selectColor`). A row's Styles menu also lists each enabled library's published color styles under the library's name (a library that can't be read offers none), and a linked row's menu switches it to another style; a library style is copied in, linked and read-only, in the same undo step (`selection.applyColorStyle` with `library`). Create style on an ordinary row asks for a name (the next free "Color n" first) and makes a style of the row's whole paint, gradients, opacity and blend mode included, linked to every fill and stroke the row stands for in one undo step; a name in use keeps the window open (`selection.createColorStyle`). Text ranges with fills of their own take the style's value, without a link. No library variables from there, and no new variable from a row (#403) | | Keyboard box selection | done | Alt+Space on macOS, Ctrl+Space on Windows and Linux, or F8 (`select.area`): a box around the selection or in the middle of the view; arrows move it, Cmd/Ctrl+arrows or Shift+arrows size it (Shift with Cmd/Ctrl: farther), Enter selects like a marquee (Shift+Enter toggles, Cmd/Ctrl+Enter nested), Escape closes | ## Tools From 889983ffe23c709fb8d669d944f97acaeb343f37 Mon Sep 17 00:00:00 2001 From: dotCooCoo Date: Sat, 31 Oct 2026 04:41:03 -0700 Subject: [PATCH 02/68] Selection colors: Create style refuses a row whose fill or stroke list holds other paints A created style holds the row's one paint, and linking it replaces the target's whole fill or stroke list, so a layer with other fills or strokes lost them. selection.createColorStyle now refuses such targets before any change, and the Styles menu leaves Create style out for those rows. --- .../engine/src/selection/selection_colors.rs | 15 ++++++++++- crates/engine/tests/it/selection_colors.rs | 26 ++++++++++++++++++- crates/ui-egui/src/panels/selection_colors.rs | 15 +++++++++-- 3 files changed, 52 insertions(+), 4 deletions(-) diff --git a/crates/engine/src/selection/selection_colors.rs b/crates/engine/src/selection/selection_colors.rs index b653f333b..54b9703b8 100644 --- a/crates/engine/src/selection/selection_colors.rs +++ b/crates/engine/src/selection/selection_colors.rs @@ -134,7 +134,7 @@ pub fn specs() -> Vec { spec!( "selection.createColorStyle", "Create selection color style", - "{targets, name, description?} → {id}; makes a color style of the paint the targets share and applies it to them as selection.applyColorStyle does; a name another style has is refused", + "{targets, name, description?} → {id}; makes a color style of the paint the targets share and applies it to them as selection.applyColorStyle does; a name another style has, or a target whose list holds other paints, is refused", true, create_style ), @@ -252,6 +252,9 @@ fn create_style(s: &mut Session, p: &Value) -> Result { if targets.iter().any(|t| t.paint(doc).as_ref() != Some(&paint)) { return Err(bad(CMD, "the targets no longer share one paint")); } + if let Some(why) = create_refusal(doc, &targets) { + return Err(bad(CMD, why)); + } let name = crate::cmd::variables::clean_name(&req_string(CMD, p, "name")?).ok_or_else(|| bad(CMD, "name can't be empty"))?; if doc.styles.iter().any(|st| st.name == name) { return Err(bad(CMD, format!("a style named `{name}` already exists"))); @@ -270,6 +273,16 @@ fn create_style(s: &mut Session, p: &Value) -> Result { Ok(json!({"id": id})) } +/// Why a color style can't be made from `targets` (`selection.createColorStyle`), if it can't: a +/// linked style replaces the whole fill or stroke list, so a target whose list holds other paints +/// would lose them. The Selection colors menu leaves Create style out for such rows. +pub fn create_refusal(doc: &Document, targets: &[PaintTarget]) -> Option<&'static str> { + targets + .iter() + .any(|t| t.paints(doc).is_none_or(|paints| paints.len() != 1)) + .then_some("a style can only be made from a fill or stroke list that holds this one paint") +} + /// Apply paint style `style` to every target: a fill or stroke list is linked to it; a text range /// takes its resolved paints and keeps its typography. fn link_style(s: &mut Session, targets: &[PaintTarget], style: &Style) -> Result<()> { diff --git a/crates/engine/tests/it/selection_colors.rs b/crates/engine/tests/it/selection_colors.rs index 41204e5db..7fdbfb635 100644 --- a/crates/engine/tests/it/selection_colors.rs +++ b/crates/engine/tests/it/selection_colors.rs @@ -2,7 +2,7 @@ use figcraft_color::Paint; use figcraft_doc::NodeId; use figcraft_engine::{ Session, - selection_colors::{SelectionColor, collect}, + selection_colors::{self, SelectionColor, collect}, }; use serde_json::{Value, json}; @@ -505,6 +505,30 @@ fn creating_a_style_refuses_taken_or_empty_names_and_stale_rows_and_changes_noth assert_eq!(fill(&s, a), "FF0000"); } +#[test] +fn creating_a_style_refuses_a_row_whose_list_holds_other_paints() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#ff0000"); + run(&mut s, "fill.add", json!({"id":a,"paint":"#0000ff"})); + let red = group(&s, &[a, b], "FF0000"); + let before = s.undo_depth(); + let styles = s.doc().unwrap().styles.len(); + let err = s.execute("selection.createColorStyle", &json!({"targets":red.targets,"name":"Red"})).unwrap_err(); + assert!(err.to_string().contains("holds this one paint"), "{err}"); + assert!(selection_colors::create_refusal(s.doc().unwrap(), &red.targets).is_some()); + assert_eq!(s.undo_depth(), before); + let doc = s.doc().unwrap(); + assert_eq!(doc.styles.len(), styles); + assert_eq!(doc.node(a).unwrap().fills.len(), 2, "the layer keeps its other fill"); + assert!(doc.node(b).unwrap().styles.fill.is_none()); + // The single-paint layer alone still makes a style. + let b_only: Vec<_> = red.targets.iter().filter(|t| t.id == b).cloned().collect(); + assert!(selection_colors::create_refusal(s.doc().unwrap(), &b_only).is_none()); + run(&mut s, "selection.createColorStyle", json!({"targets":b_only,"name":"Red"})); + assert!(s.doc().unwrap().node(b).unwrap().styles.fill.is_some()); +} + #[test] fn a_linked_row_switches_to_another_style() { let mut s = Session::new(); diff --git a/crates/ui-egui/src/panels/selection_colors.rs b/crates/ui-egui/src/panels/selection_colors.rs index 7a8189ddb..4d5682e35 100644 --- a/crates/ui-egui/src/panels/selection_colors.rs +++ b/crates/ui-egui/src/panels/selection_colors.rs @@ -7,7 +7,7 @@ use egui::{Id, Ui}; use figcraft_color::{Color, Paint}; use figcraft_doc::{Document, NodeId, PublishedLibrary, Style, StyleKind, VariableType}; use figcraft_engine::library; -use figcraft_engine::selection_colors::{PaintTarget, SelectionColor, bind_refusal, collect, in_scope}; +use figcraft_engine::selection_colors::{PaintTarget, SelectionColor, bind_refusal, collect, create_refusal, in_scope}; use serde_json::json; use crate::a11y::Tip; @@ -122,7 +122,7 @@ pub fn section(app: &mut FigApp, ui: &mut Ui, doc: &Arc, ids: &[NodeId style_items(app, ui, doc, group, &t); if linked_name.is_none() { ui.separator(); - if crate::right::menu_item(ui, tr("Create style"), "") { + if create_refusal(doc, &group.targets).is_none() && crate::right::menu_item(ui, tr("Create style"), "") { open_create_form(app, ui, doc, group); ui.close(); } @@ -536,6 +536,17 @@ mod tests { assert!(p.frame(vec![]).iter().any(|(s, _)| s == "Brand")); } + #[test] + fn create_style_is_left_out_for_a_row_whose_list_holds_other_paints() { + let (mut p, a, _) = Panel::new(); + p.app.run("fill.add", json!({"id":a,"paint":"#00ff00"})); + let red = text_at(&p.frame(vec![]), "FF0000"); + p.click(Pos2::new(228.0, red.y)); + let texts = p.frame(vec![]); + assert!(texts.iter().any(|(s, _)| s == "No color styles"), "the Styles menu opens"); + assert!(!texts.iter().any(|(s, _)| s == "Create style")); + } + #[test] fn a_linked_rows_styles_menu_switches_its_style() { let (mut p, a, _) = Panel::new(); From 1b7d9221e20c36b177d97c74aa89298d929abfc1 Mon Sep 17 00:00:00 2001 From: dotCooCoo Date: Sat, 31 Oct 2026 04:47:01 -0700 Subject: [PATCH 03/68] Selection colors: a library that is not a string is refused instead of linking a local style selection.applyColorStyle chose the library path only when `library` read as a string, so an object or array fell through and linked a local style of the same name. Any non-null `library` now goes to the library lookup, which refuses a non-string before any change. --- crates/engine/src/selection/selection_colors.rs | 2 +- crates/engine/tests/it/selection_colors.rs | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/crates/engine/src/selection/selection_colors.rs b/crates/engine/src/selection/selection_colors.rs index 54b9703b8..52e39483b 100644 --- a/crates/engine/src/selection/selection_colors.rs +++ b/crates/engine/src/selection/selection_colors.rs @@ -212,7 +212,7 @@ fn apply_style(s: &mut Session, p: &Value) -> Result { const CMD: &str = "selection.applyColorStyle"; let targets = checked_targets(s, p, CMD)?; let name = req_string(CMD, p, "style")?; - let name = if string(p, "library").is_some() { import_library_style(s, CMD, p, &name)? } else { name }; + let name = if get(p, "library").is_some() { import_library_style(s, CMD, p, &name)? } else { name }; let style = s.doc()?.style(&name).cloned().ok_or_else(|| bad(CMD, "no such color style"))?; if !matches!(style.kind, StyleKind::Paint { .. }) { return Err(bad(CMD, "a color style is required")); diff --git a/crates/engine/tests/it/selection_colors.rs b/crates/engine/tests/it/selection_colors.rs index 7fdbfb635..7778fedc3 100644 --- a/crates/engine/tests/it/selection_colors.rs +++ b/crates/engine/tests/it/selection_colors.rs @@ -619,3 +619,19 @@ fn library_styles_that_are_unpublished_not_colors_or_not_enabled_are_refused() { assert!(s.doc().unwrap().styles.is_empty()); assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill, None); } + +#[test] +fn a_library_that_is_not_a_string_is_refused_rather_than_linking_a_local_style() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + run(&mut s, "style.create", json!({"type":"paint","name":"Brand","value":"#0000ff"})); + let red = group(&s, &[a], "FF0000"); + let before = s.undo_depth(); + for lib in [json!({}), json!([]), json!({"id":"Brand"})] { + let err = s.execute("selection.applyColorStyle", &json!({"targets":red.targets,"style":"Brand","library":lib})).unwrap_err(); + assert!(err.to_string().contains("`library` must be a string"), "{lib}: {err}"); + } + assert_eq!(s.undo_depth(), before); + assert_eq!(s.doc().unwrap().node(a).unwrap().styles.fill, None); + assert_eq!(fill(&s, a), "FF0000"); +} From cb429813f3bd9399054508082f2f64a910f7bba2 Mon Sep 17 00:00:00 2001 From: dotCooCoo Date: Sat, 31 Oct 2026 04:58:28 -0700 Subject: [PATCH 04/68] Selection colors: Create style keeps the variables bound to the row's paint selection.createColorStyle gives the new style the variable bindings of the fill or stroke it is made from, the color and the gradient stops, so linked layers keep following the variables. Targets bound to different variables are refused, and the Styles menu leaves Create style out for them. --- .../engine/src/selection/selection_colors.rs | 39 ++++++++----- crates/engine/tests/it/selection_colors.rs | 57 +++++++++++++++++++ docs/ui-parity.md | 2 +- 3 files changed, 83 insertions(+), 15 deletions(-) diff --git a/crates/engine/src/selection/selection_colors.rs b/crates/engine/src/selection/selection_colors.rs index 52e39483b..53ef11fae 100644 --- a/crates/engine/src/selection/selection_colors.rs +++ b/crates/engine/src/selection/selection_colors.rs @@ -5,7 +5,7 @@ use std::collections::{BTreeMap, BTreeSet}; use figcraft_color::{Paint, PaintKind}; -use figcraft_doc::{Document, NodeId, NodeKind, Style, StyleKind, VariableType, VariableValue}; +use figcraft_doc::{Document, NodeId, NodeKind, Style, StyleKind, VariableId, VariableType, VariableValue}; use serde::{Deserialize, Serialize}; use serde_json::{Value, json}; @@ -134,7 +134,7 @@ pub fn specs() -> Vec { spec!( "selection.createColorStyle", "Create selection color style", - "{targets, name, description?} → {id}; makes a color style of the paint the targets share and applies it to them as selection.applyColorStyle does; a name another style has, or a target whose list holds other paints, is refused", + "{targets, name, description?} → {id}; makes a color style of the paint the targets share and applies it to them as selection.applyColorStyle does, keeping the variables bound to the paint; a name another style has, a target whose list holds other paints, or targets bound to different variables are refused", true, create_style ), @@ -259,15 +259,11 @@ fn create_style(s: &mut Session, p: &Value) -> Result { if doc.styles.iter().any(|st| st.name == name) { return Err(bad(CMD, format!("a style named `{name}` already exists"))); } + let kind = StyleKind::Paint { paints: vec![paint] }; + let bound = targets.first().map(|t| target_bindings(doc, t, &kind)).unwrap_or_default(); let doc = s.doc_mut()?; let id = doc.new_style_id(); - let style = Style { - id: id.clone(), - name, - description: string(p, "description").unwrap_or_default(), - kind: StyleKind::Paint { paints: vec![paint] }, - bound: BTreeMap::new(), - }; + let style = Style { id: id.clone(), name, description: string(p, "description").unwrap_or_default(), kind, bound }; doc.styles.push(style.clone()); link_style(s, &targets, &style)?; Ok(json!({"id": id})) @@ -275,12 +271,27 @@ fn create_style(s: &mut Session, p: &Value) -> Result { /// Why a color style can't be made from `targets` (`selection.createColorStyle`), if it can't: a /// linked style replaces the whole fill or stroke list, so a target whose list holds other paints -/// would lose them. The Selection colors menu leaves Create style out for such rows. +/// would lose them. The new style takes over the variables bound to the paint, so targets bound to +/// different variables are refused too. The Selection colors menu leaves Create style out for such rows. pub fn create_refusal(doc: &Document, targets: &[PaintTarget]) -> Option<&'static str> { - targets - .iter() - .any(|t| t.paints(doc).is_none_or(|paints| paints.len() != 1)) - .then_some("a style can only be made from a fill or stroke list that holds this one paint") + if targets.iter().any(|t| t.paints(doc).is_none_or(|paints| paints.len() != 1)) { + return Some("a style can only be made from a fill or stroke list that holds this one paint"); + } + let paint = targets.first().and_then(|t| t.paint(doc))?; + let kind = StyleKind::Paint { paints: vec![paint] }; + let mut bindings = targets.iter().map(|t| target_bindings(doc, t, &kind)); + let first = bindings.next()?; + bindings.any(|b| b != first).then_some("the targets are bound to different variables") +} + +/// The variable bindings a paint style of `kind` made from `target` takes over: those on the fill or +/// stroke list the target stands for. A text range with fills of its own holds none. +fn target_bindings(doc: &Document, target: &PaintTarget, kind: &StyleKind) -> BTreeMap { + if list_field(doc, target).is_none() { + return BTreeMap::new(); + } + let field = if target.fills { "fillStyle" } else { "strokeStyle" }; + doc.node(target.id).map(|n| crate::style_vars::from_layer(n, field, kind)).unwrap_or_default() } /// Apply paint style `style` to every target: a fill or stroke list is linked to it; a text range diff --git a/crates/engine/tests/it/selection_colors.rs b/crates/engine/tests/it/selection_colors.rs index 7778fedc3..be661e21a 100644 --- a/crates/engine/tests/it/selection_colors.rs +++ b/crates/engine/tests/it/selection_colors.rs @@ -529,6 +529,63 @@ fn creating_a_style_refuses_a_row_whose_list_holds_other_paints() { assert!(s.doc().unwrap().node(b).unwrap().styles.fill.is_some()); } +#[test] +fn a_style_created_from_a_variable_bound_row_keeps_following_the_variable() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#ff0000"); + let v = theme_variable(&mut s, "Brand", "#ff0000"); + for id in [a, b] { + run(&mut s, "variable.bind", json!({"id":id,"field":"fill","variable":v})); + } + let red = group(&s, &[a, b], "FF0000"); + assert_eq!(red.targets.len(), 2); + run(&mut s, "selection.createColorStyle", json!({"targets":red.targets,"name":"Brand"})); + let style = s.doc().unwrap().style("Brand").unwrap(); + assert_eq!(style.bound.get("fills/0/color").map(String::as_str), v.as_str()); + run(&mut s, "variable.set", json!({"variable":v,"value":"#00ff00"})); + assert_eq!(fill(&s, a), "00FF00"); + assert_eq!(fill(&s, b), "00FF00"); +} + +#[test] +fn a_style_created_from_a_gradient_keeps_its_stop_variables() { + use figcraft_color::{Color, Gradient, GradientKind, PaintKind}; + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let paint = Paint::gradient(Gradient::default_for(GradientKind::Linear, Color::BLACK)); + run(&mut s, "fill.set", json!({"id":a,"paint":paint})); + let v = theme_variable(&mut s, "Brand", "#ff0000"); + run(&mut s, "variable.bind", json!({"id":a,"field":"fills/0/stops/0/color","variable":v})); + let row = collect(s.doc().unwrap(), &[a]).into_iter().next().unwrap(); + run(&mut s, "selection.createColorStyle", json!({"targets":row.targets,"name":"Shade"})); + assert!(s.doc().unwrap().style("Shade").unwrap().bound.contains_key("fills/0/stops/0/color")); + run(&mut s, "variable.set", json!({"variable":v,"value":"#00ff00"})); + let PaintKind::Gradient(g) = &s.doc().unwrap().node(a).unwrap().fills[0].kind else { panic!("not a gradient") }; + assert_eq!(g.stops[0].color.to_hex(), "00FF00"); +} + +#[test] +fn creating_a_style_refuses_targets_bound_to_different_variables() { + let mut s = Session::new(); + let a = rectangle(&mut s, "#ff0000"); + let b = rectangle(&mut s, "#ff0000"); + let v = theme_variable(&mut s, "Brand", "#ff0000"); + run(&mut s, "variable.bind", json!({"id":a,"field":"fill","variable":v})); + let targets: Vec<_> = collect(s.doc().unwrap(), &[a, b]).into_iter().flat_map(|g| g.targets).collect(); + assert_eq!(targets.len(), 2); + assert!(selection_colors::create_refusal(s.doc().unwrap(), &targets).is_some()); + let before = s.undo_depth(); + let styles = s.doc().unwrap().styles.len(); + let err = s.execute("selection.createColorStyle", &json!({"targets":targets,"name":"Red"})).unwrap_err(); + assert!(err.to_string().contains("different variables"), "{err}"); + assert_eq!(s.undo_depth(), before); + let doc = s.doc().unwrap(); + assert_eq!(doc.styles.len(), styles); + assert!(!doc.node(a).unwrap().bound.is_empty()); + assert!(doc.node(b).unwrap().styles.fill.is_none()); +} + #[test] fn a_linked_row_switches_to_another_style() { let mut s = Session::new(); diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 5e634bc2b..5d0ba4b96 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -74,7 +74,7 @@ interaction feel not yet compared. | Transform box at small sizes | done | a press inside a layer smaller than its handles moves it, the nearest handle wins, handles answer just outside and are hidden under 16 px on screen; cursors follow each handle and the box's rotation | | Locked layers | done | selectable from the layers panel; no handles, not dragged with the rest of a selection | | Smart selection spacing | partial | with layers in a row, a column or an aligned grid selected, the Layout section shows horizontal and vertical spacing ("Mixed" until set; typed, scrubbed, fractional and negative) and pink handles in the gaps on the canvas drag them, one undo step, Escape cancels (`arrange.spacing`; sizes, parents and offsets within each track kept; at most 2,000 layers; flow children, locked layers and layers inside instances left out). A ring at each layer's centre drags it to another place in a regular row, column or complete top-left-aligned grid: the others close up and make room around it with the gaps kept, and with Cmd/Ctrl held the two layers swap places instead, previewed live while dragging (`selection_reorder_tests`; no ring on a layer under 16 px on screen). Not covered: reordering irregular grids, and several marked layers moved together. Checked by its author on macOS and in the app on Windows (#402) | -| Selection colors | partial | for a mixed selection the Design panel lists their solid and gradient paints (children and text ranges included; hidden paints, masks, images, patterns and boolean operands left out; styles and variables listed apart): editing a colour changes every matching fill and stroke in one undo step, a row selects the layers that use it or applies a color style or color variable of the document, and a row linked to a style or variable detaches it, keeping the color (`selection.colors`, `selection.setPaint`, `selection.applyColorStyle`, `selection.bindColorVariable`, `selection.detachColor`, `selection.selectColor`). A row's Styles menu also lists each enabled library's published color styles under the library's name (a library that can't be read offers none), and a linked row's menu switches it to another style; a library style is copied in, linked and read-only, in the same undo step (`selection.applyColorStyle` with `library`). Create style on an ordinary row asks for a name (the next free "Color n" first) and makes a style of the row's whole paint, gradients, opacity and blend mode included, linked to every fill and stroke the row stands for in one undo step; a name in use keeps the window open (`selection.createColorStyle`). Text ranges with fills of their own take the style's value, without a link. No library variables from there, and no new variable from a row (#403) | +| Selection colors | partial | for a mixed selection the Design panel lists their solid and gradient paints (children and text ranges included; hidden paints, masks, images, patterns and boolean operands left out; styles and variables listed apart): editing a colour changes every matching fill and stroke in one undo step, a row selects the layers that use it or applies a color style or color variable of the document, and a row linked to a style or variable detaches it, keeping the color (`selection.colors`, `selection.setPaint`, `selection.applyColorStyle`, `selection.bindColorVariable`, `selection.detachColor`, `selection.selectColor`). A row's Styles menu also lists each enabled library's published color styles under the library's name (a library that can't be read offers none), and a linked row's menu switches it to another style; a library style is copied in, linked and read-only, in the same undo step (`selection.applyColorStyle` with `library`). Create style on an ordinary row asks for a name (the next free "Color n" first) and makes a style of the row's whole paint, gradients, opacity, blend mode and variables bound to gradient stops included, linked to every fill and stroke the row stands for in one undo step; a name in use keeps the window open (`selection.createColorStyle`). Text ranges with fills of their own take the style's value, without a link. No library variables from there, and no new variable from a row (#403) | | Keyboard box selection | done | Alt+Space on macOS, Ctrl+Space on Windows and Linux, or F8 (`select.area`): a box around the selection or in the middle of the view; arrows move it, Cmd/Ctrl+arrows or Shift+arrows size it (Shift with Cmd/Ctrl: farther), Enter selects like a marquee (Shift+Enter toggles, Cmd/Ctrl+Enter nested), Escape closes | ## Tools From 03151d86849a3bf6f02eb8304eb09f832d5190ef Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sat, 31 Oct 2026 11:10:18 -0400 Subject: [PATCH 05/68] M7: a gap between Import and Export in the Local variables window (#1754) The window lays itself out with zero item spacing, and the header button bar is a child Ui that inherited it, so Import and Export touched. The bar now spaces its buttons 16 px apart, the gap Export has to the Close button glyph. Co-Authored-By: Claude Fable 5.1 --- crates/ui-egui/src/dialogs/variables_panel.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/crates/ui-egui/src/dialogs/variables_panel.rs b/crates/ui-egui/src/dialogs/variables_panel.rs index 9a1011a42..28d9a21e5 100644 --- a/crates/ui-egui/src/dialogs/variables_panel.rs +++ b/crates/ui-egui/src/dialogs/variables_panel.rs @@ -181,6 +181,9 @@ fn header(app: &mut FigApp, ui: &mut Ui, open: &mut bool) { // Import and export, left of Close. let bar = Rect::from_min_max(pos2(r.max.x - 280.0, r.min.y + 10.0), pos2(r.max.x - 40.0, r.max.y - 10.0)); let mut bar = ui.new_child(UiBuilder::new().max_rect(bar).layout(egui::Layout::right_to_left(egui::Align::Center))); + // The window lays itself out without item spacing (set by the caller); the buttons in this bar + // keep the same gap between them as the one between Export and the Close button (#1754). + bar.spacing_mut().item_spacing.x = 16.0; let export = widgets::button(&mut bar, tr("Export…"), false, true); crate::right::menu_popup(&export).show(|ui| { for (label, format) in [(tr("Variables JSON…"), "json"), (tr("CSS custom properties…"), "css"), (tr("Dart constants for Flutter…"), "dart")] From 40534ddf14f204743e7e6558bb0a9f8a8d71d144 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sat, 31 Oct 2026 11:20:21 -0400 Subject: [PATCH 06/68] M1: the page background opacity can be edited in the Page section (#1748) The Design panel drew the page opacity as a "100 %" label, so it could not be changed from the panel although the model, page.setBackground and the colour picker already handled a translucent page. The label is now a percent number field like the other opacity fields (named Opacity for screen readers), committing page.setBackground; a scrub stays one undo step. The hex field keeps the current opacity unless the typed colour carries one, as the colour picker does. Regression test in field_tests. Co-Authored-By: Claude Fable 5.1 --- crates/ui-egui/src/field_tests.rs | 41 ++++++++++++++++++++++++++++++ crates/ui-egui/src/panels/right.rs | 39 +++++++++++++++++++++------- 2 files changed, 71 insertions(+), 9 deletions(-) diff --git a/crates/ui-egui/src/field_tests.rs b/crates/ui-egui/src/field_tests.rs index 566f0828b..63995fc80 100644 --- a/crates/ui-egui/src/field_tests.rs +++ b/crates/ui-egui/src/field_tests.rs @@ -1194,3 +1194,44 @@ fn sidebar_field_text_stays_in_place_on_focus() { assert!((before.center().y - after.center().y).abs() <= 0.5, "numeric={numeric}: before={before:?}, after={after:?}"); } } + +/// The Page section's opacity field edits the page background's alpha (#1748; it was a label), +/// one undo step per commit, and the hex field keeps that opacity unless the typed colour +/// carries its own. +#[test] +fn the_page_background_opacity_field_sets_the_page_colour_alpha() { + let mut u = Ui::new(Session::new()); + u.ctx.enable_accesskit(); + u.frame(vec![]); + let page_bg = |u: &Ui| { + let page = u.app.session.page().unwrap(); + match &u.app.session.doc().unwrap().node(page).unwrap().kind { + figcraft_doc::NodeKind::Page { background, .. } => *background, + _ => panic!("the page"), + } + }; + // Within an 8-bit step: the colour travels as RRGGBBAA. + let near = |a: f32, b: f32| (a - b).abs() < 1.0 / 255.0; + assert!(near(page_bg(&u).a, 1.0)); + let steps = undo_steps(&u); + type_into(&mut u, "Opacity", "50", Key::Enter); + assert!(near(page_bg(&u).a, 0.5), "{:?}", page_bg(&u)); + assert_eq!(undo_steps(&u), steps + 1, "one undo step for the commit"); + // The hex field keeps the opacity when the typed colour has none, and takes one it carries. + let hex = |u: &mut Ui| u.ctx.read_response(Id::unique("pagebg").with("click")).expect("the hex field").rect.center(); + let at = hex(&mut u); + click(&mut u, at); + u.frame(vec![Event::Text("FF0000".into())]); + key(&mut u, Key::Enter, Modifiers::NONE); + let c = page_bg(&u); + assert!(near(c.r, 1.0) && near(c.g, 0.0) && near(c.a, 0.5), "{c:?}"); + let at = hex(&mut u); + click(&mut u, at); + u.frame(vec![Event::Text("00FF0080".into())]); + key(&mut u, Key::Enter, Modifiers::NONE); + let c = page_bg(&u); + assert!(near(c.g, 1.0) && near(c.a, 128.0 / 255.0), "{c:?}"); + assert_eq!(undo_steps(&u), steps + 3); + u.app.run("edit.undo", json!({})); + assert!(near(page_bg(&u).r, 1.0) && near(page_bg(&u).a, 0.5), "undo takes back the last colour alone"); +} diff --git a/crates/ui-egui/src/panels/right.rs b/crates/ui-egui/src/panels/right.rs index 6dde13136..4f31f4089 100644 --- a/crates/ui-egui/src/panels/right.rs +++ b/crates/ui-egui/src/panels/right.rs @@ -311,27 +311,48 @@ fn design(app: &mut FigApp, ui: &mut Ui) { /// Draw the page section: background and colour profile, local variables/styles, and the /// page export section. fn page_section(app: &mut FigApp, ui: &mut Ui, doc: &Document) { - let t = Tokens::get(ui.ctx()); let Ok(page) = app.session.page() else { return }; let bg = match doc.node(page).map(|n| &n.kind) { Some(NodeKind::Page { background, .. }) => *background, _ => figcraft_color::Color::DEFAULT_PAGE, }; widgets::section_header(ui, tr("Page"), &[], false); - let mut new_hex = None; + // The new colour and, from a scrub, whether the scrub is over (live edits stay one undo step). + let mut new_color: Option<(figcraft_color::Color, Option)> = None; row(ui, 32.0, |ui| { let p = Paint::solid(bg); let sw = widgets::swatch(ui, &p, 16.0); app.picker_control(crate::colorpicker::PickerTarget::PageBackground, &sw); - if let Some(h) = widgets::text_field(ui, Id::unique("pagebg"), &bg.to_hex(), 96.0, "") { - new_hex = Some(h); + // A typed colour keeps the page's opacity unless it carries one (`FF000080`), as the + // colour picker's hex field does. + if let Some(h) = widgets::text_field(ui, Id::unique("pagebg"), &bg.to_hex(), 96.0, "") + && let Some(c) = figcraft_color::Color::from_hex_or_name(&h) + { + new_color = Some((c.with_alpha(if c.a < 1.0 { c.a } else { bg.a }), None)); + } + // The opacity: a field like every other opacity field, not a label (#1748). + let alpha = |v: f64| bg.with_alpha((v / 100.0).clamp(0.0, 1.0) as f32); + let shown = Some(f64::from((bg.a * 100.0).round())); + match widgets::number_field(ui, Id::unique("pagebg_a"), Lead::Named(tr("Opacity")), shown, "%", 56.0, 1.0) { + Some(FieldEdit::Set(v)) => new_color = Some((alpha(v), None)), + Some(FieldEdit::Scrub(v, done)) => new_color = Some((alpha(v), Some(done))), + None => {} } - widgets::label(ui, "100 %", t.text); }); - if let Some(h) = new_hex - && let Some(c) = figcraft_color::Color::from_hex_or_name(&h) - { - app.run("page.setBackground", json!({"color": c.to_css_hex()})); + if let Some((c, scrub)) = new_color { + let p = json!({"color": c.to_css_hex()}); + match scrub { + None => { + app.run("page.setBackground", p); + } + Some(done) => { + let _ = app.session.begin_interaction("Page background"); + let _ = app.session.execute("page.setBackground", &p); + if done { + let _ = app.session.commit_interaction(); + } + } + } } widgets::separator(ui); widgets::section_header(ui, tr("Color profile"), &[], false); From fcab85ddd017e929fe5a38d8c67d3c8e36f31760 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sat, 31 Oct 2026 11:34:55 -0400 Subject: [PATCH 07/68] M4: the Pencil draws white on a dark page or frame, and previews in that colour (#1741) Figma: "a round 3px stroke weight in black, unless you are sketching on a dark canvas or frame". The Pencil always drew black. It now takes the colour from the same dark-background rule new text uses (the nearest ancestor with a mostly opaque solid fill, else the page), and the overlay carries that colour for the stroke in progress so the preview matches. Engine and UI regression tests. Co-Authored-By: Claude Fable 5.1 --- crates/engine/src/brush_tests.rs | 32 +++++++++++++++++++++++ crates/engine/src/canvas/tools.rs | 3 +++ crates/engine/src/canvas/tools/draw.rs | 1 + crates/engine/src/canvas/tools/handles.rs | 31 ++++++++++++++++------ crates/engine/src/canvas/tools/pen.rs | 13 ++++++++- crates/engine/src/canvas/tools/pointer.rs | 2 ++ crates/ui-egui/src/canvas/overlays.rs | 6 +++-- crates/ui-egui/src/canvas_fixes_tests.rs | 17 ++++++++++++ 8 files changed, 94 insertions(+), 11 deletions(-) diff --git a/crates/engine/src/brush_tests.rs b/crates/engine/src/brush_tests.rs index e4e8b428b..984eaaad5 100644 --- a/crates/engine/src/brush_tests.rs +++ b/crates/engine/src/brush_tests.rs @@ -107,3 +107,35 @@ fn the_pencil_records_pressure_and_its_brush() { let last = doc.nodes().filter(|n| matches!(n.kind, NodeKind::Vector { .. })).max_by_key(|n| n.id).unwrap(); assert!(last.stroke.profile().is_none() && last.stroke.brush.is_none()); } + +/// The Pencil draws black on a light page and white on a dark page or inside a dark frame, the +/// rule new text follows (#1741; Figma: "in black, unless you're sketching on a dark canvas or +/// frame"), and the stroke in progress previews in that colour. +#[test] +fn the_pencil_draws_white_on_a_dark_background() { + use figcraft_color::Color; + let mut s = Session::new(); + s.execute("tool.set", &json!({"tool": "pencil"})).unwrap(); + // A stroke from (x, y); its colour, and the preview colour the overlay carried while drawing. + let stroke = |s: &mut Session, x: f64, y: f64| { + s.pointer(&PointerEvent::at(PointerKind::Down, x, y, 1.0)).unwrap(); + s.pointer(&PointerEvent::at(PointerKind::Move, x + 40.0, y + 10.0, 1.0)).unwrap(); + let preview = s.tool.overlay.pen_color; + s.pointer(&PointerEvent::at(PointerKind::Move, x + 80.0, y, 1.0)).unwrap(); + s.pointer(&PointerEvent::at(PointerKind::Up, x + 80.0, y, 1.0)).unwrap(); + assert!(s.tool.overlay.pen_color.is_none(), "no preview colour after the stroke"); + let doc = s.doc().unwrap(); + let last = doc.nodes().filter(|n| matches!(n.kind, NodeKind::Vector { .. })).max_by_key(|n| n.id).unwrap(); + (last.strokes.first().and_then(|p| p.solid_color()).unwrap(), preview) + }; + assert_eq!(stroke(&mut s, 0.0, 0.0), (Color::BLACK, Some(Color::BLACK)), "a light page"); + s.execute("page.setBackground", &json!({"color": "#1E1E1E"})).unwrap(); + assert_eq!(stroke(&mut s, 0.0, 100.0), (Color::WHITE, Some(Color::WHITE)), "a dark page"); + // A dark frame on a light page, and a light frame on a dark page. + s.execute("page.setBackground", &json!({"color": "#F5F5F5"})).unwrap(); + s.execute("node.create", &json!({"type": "frame", "x": 300, "y": 300, "width": 200, "height": 200, "props": {"fills": ["#202020"]}})).unwrap(); + assert_eq!(stroke(&mut s, 320.0, 320.0), (Color::WHITE, Some(Color::WHITE)), "inside a dark frame"); + s.execute("page.setBackground", &json!({"color": "#1E1E1E"})).unwrap(); + s.execute("node.create", &json!({"type": "frame", "x": 600, "y": 300, "width": 200, "height": 200, "props": {"fills": ["#FFFFFF"]}})).unwrap(); + assert_eq!(stroke(&mut s, 620.0, 320.0), (Color::BLACK, Some(Color::BLACK)), "inside a light frame on a dark page"); +} diff --git a/crates/engine/src/canvas/tools.rs b/crates/engine/src/canvas/tools.rs index c68276fd3..9b8271695 100644 --- a/crates/engine/src/canvas/tools.rs +++ b/crates/engine/src/canvas/tools.rs @@ -327,6 +327,9 @@ pub struct Overlay { pub cursor: Cursor, /// Pen tool: the in-progress path's anchor points and the rubber band to the pointer. pub pen: Vec<[f64; 2]>, + /// Pencil: the colour of the stroke in progress, for its preview (white over a dark page or + /// frame); None outside a Pencil stroke. + pub pen_color: Option, pub rubber: Option<[f64; 4]>, /// Pen tool: the handles shaping the segments at the pen (anchor x, y, handle x, y): the last /// anchor's in and out handles and the one before's out handle. diff --git a/crates/engine/src/canvas/tools/draw.rs b/crates/engine/src/canvas/tools/draw.rs index d59a2b904..7df150e43 100644 --- a/crates/engine/src/canvas/tools/draw.rs +++ b/crates/engine/src/canvas/tools/draw.rs @@ -221,6 +221,7 @@ impl Session { } Gesture::Pencil { mut points, mut pressure } => { self.tool.overlay.pen.clear(); + self.tool.overlay.pen_color = None; // The stroke ends where the button came up, even without a move to get there. if points.last().is_none_or(|l| (*l - ev.p()).hypot() > 0.5 / ev.zoom.max(1e-6)) { points.push(ev.p()); diff --git a/crates/engine/src/canvas/tools/handles.rs b/crates/engine/src/canvas/tools/handles.rs index 7ccaca403..9bd1c5973 100644 --- a/crates/engine/src/canvas/tools/handles.rs +++ b/crates/engine/src/canvas/tools/handles.rs @@ -36,16 +36,31 @@ pub fn anchor_name(a: (u8, u8)) -> &'static str { ANCHORS.get(usize::from(a.1.min(2)) * 3 + usize::from(a.0.min(2))).copied().unwrap_or("tl") } +/// Whether what is drawn in `parent` sits on a dark background: the nearest layer from `parent` +/// out whose top visible fill is a mostly opaque solid colour, else the page (#362). +pub(crate) fn on_dark_background(doc: &Document, parent: NodeId) -> bool { + std::iter::once(parent) + .chain(doc.ancestors(parent)) + .filter_map(|id| doc.node(id)) + .find_map(|n| match &n.kind { + NodeKind::Page { background, .. } => Some(background.is_dark()), + _ => n.fills.iter().rev().find(|p| p.visible).and_then(|p| p.solid_color()).filter(|c| c.a >= 0.5).map(|c| c.is_dark()), + }) + .unwrap_or(false) +} + /// The fill new text takes to be readable where it is drawn, in `parent`: white on a dark -/// background (None: the model's default, black). The background is the nearest layer from `parent` -/// out whose top visible fill is a mostly opaque solid colour, else the page (#362). For text made -/// in the app: by the Text tool, or by a command that names no fill while the interface is up. +/// background (None: the model's default, black). For text made in the app: by the Text tool, or +/// by a command that names no fill while the interface is up. pub(crate) fn readable_text_fills(doc: &Document, parent: NodeId) -> Option> { - let dark = std::iter::once(parent).chain(doc.ancestors(parent)).filter_map(|id| doc.node(id)).find_map(|n| match &n.kind { - NodeKind::Page { background, .. } => Some(background.is_dark()), - _ => n.fills.iter().rev().find(|p| p.visible).and_then(|p| p.solid_color()).filter(|c| c.a >= 0.5).map(|c| c.is_dark()), - }); - dark.unwrap_or(false).then(|| vec![figcraft_color::Paint::solid(figcraft_color::Color::WHITE)]) + on_dark_background(doc, parent).then(|| vec![figcraft_color::Paint::solid(figcraft_color::Color::WHITE)]) +} + +/// The colour the Pencil draws with in `parent`: [`PENCIL_STROKE`]'s black, or white on a dark +/// background by the rule text follows (#1741; "in black, unless you're sketching on a dark canvas +/// or frame"). +pub(crate) fn pencil_color(doc: &Document, parent: NodeId) -> figcraft_color::Color { + if on_dark_background(doc, parent) { figcraft_color::Color::WHITE } else { PENCIL_STROKE.0 } } const ANCHORS: [&str; 9] = ["tl", "t", "tr", "l", "c", "r", "bl", "b", "br"]; diff --git a/crates/engine/src/canvas/tools/pen.rs b/crates/engine/src/canvas/tools/pen.rs index d519bc580..8de56bec7 100644 --- a/crates/engine/src/canvas/tools/pen.rs +++ b/crates/engine/src/canvas/tools/pen.rs @@ -296,7 +296,9 @@ impl Session { let mut local = fitted.clone(); local.apply_affine(pw.inverse()); let _ = d; - let (color, weight) = PENCIL_STROKE; + // Black, or white on a dark page or frame (#1741). + let (_, weight) = PENCIL_STROKE; + let color = super::handles::pencil_color(self.doc()?, parent); let mut props = json!({"fills": [], "strokes": [color.to_css_hex()], "strokeWeight": weight, "strokeCap": "round", "strokeJoin": "round", "strokeAlign": "center"}); // Pen pressure becomes the stroke's width profile (brushes follow it too). if let Some(points) = pressure_profile(points, pressure) { @@ -311,4 +313,13 @@ impl Session { )?; Ok(()) } + + /// The colour a Pencil stroke starting at `p` will have: it goes into the frame under `p` + /// (else the page), and is white when that is dark (`pencil_color`). + pub(super) fn pencil_color_at(&self, p: figcraft_geom::Point) -> Result { + let page = self.page()?; + let doc = self.doc()?; + let parent = frame_at(doc, page, p, &[]).unwrap_or(page); + Ok(super::handles::pencil_color(doc, parent)) + } } diff --git a/crates/engine/src/canvas/tools/pointer.rs b/crates/engine/src/canvas/tools/pointer.rs index 1493604dc..bd4fa94e7 100644 --- a/crates/engine/src/canvas/tools/pointer.rs +++ b/crates/engine/src/canvas/tools/pointer.rs @@ -156,6 +156,8 @@ impl Session { ToolId::TextOnPath => self.text_on_path_down(ev), ToolId::Pen => self.pen_down(ev), ToolId::Pencil => { + // The preview draws in the colour the stroke will have (#1741). + self.tool.overlay.pen_color = self.pencil_color_at(ev.p()).ok(); self.tool.gesture = Gesture::Pencil { points: vec![ev.p()], pressure: vec![ev.pressure] }; Ok(()) } diff --git a/crates/ui-egui/src/canvas/overlays.rs b/crates/ui-egui/src/canvas/overlays.rs index 483a180b9..2434bbf7f 100644 --- a/crates/ui-egui/src/canvas/overlays.rs +++ b/crates/ui-egui/src/canvas/overlays.rs @@ -421,8 +421,10 @@ fn pen_overlay(app: &FigApp, painter: &egui::Painter, zoom: f64) { if !ov.pen.is_empty() { let pts: Vec = ov.pen.iter().map(|[x, y]| app.to_screen(*x, *y)).collect(); if app.session.tool.tool == ToolId::Pencil { - // The stroke it will make, in its colour and weight (at least a point when zoomed out). - let (color, weight) = figcraft_engine::tools::PENCIL_STROKE; + // The stroke it will make, in its colour and weight (at least a point when zoomed out): + // white over a dark page or frame, as the stroke will be (#1741). + let (default, weight) = figcraft_engine::tools::PENCIL_STROKE; + let color = ov.pen_color.unwrap_or(default); painter.add(Shape::line(pts, stroke(doc_c32(painter.ctx(), color), ((weight * zoom) as f32).max(1.0)))); } else { for [x0, y0, x1, y1] in &ov.pen_handles { diff --git a/crates/ui-egui/src/canvas_fixes_tests.rs b/crates/ui-egui/src/canvas_fixes_tests.rs index d8112a3aa..cdb19492a 100644 --- a/crates/ui-egui/src/canvas_fixes_tests.rs +++ b/crates/ui-egui/src/canvas_fixes_tests.rs @@ -186,6 +186,23 @@ fn the_pencil_previews_its_stroke_in_its_colour_and_weight() { assert!((w - 1.0).abs() < 0.01, "at least a point: {w}"); } +/// Over a dark page the Pencil's preview is white, as the stroke it makes will be (#1741). +#[test] +fn the_pencil_previews_white_over_a_dark_page() { + let mut u = Ui::new(Session::new()); + u.app.run("page.setBackground", json!({"color": "#1E1E1E"})); + u.app.run("tool.set", json!({"tool": "pencil"})); + let white = egui::epaint::ColorMode::Solid(crate::theme::c32(figcraft_color::Color::WHITE)); + let at = |u: &Ui, x: f64, y: f64| u.app.to_screen(x, y); + u.button(at(&u, 10.0, 10.0), true); + for i in 1..=6 { + let p = at(&u, 10.0 + 12.0 * f64::from(i), 10.0 + 6.0 * f64::from(i % 2)); + u.frame(vec![egui::Event::PointerMoved(p)]); + } + let shapes = flat(&u.frame_output(vec![]).shapes); + assert!(shapes.iter().any(|s| matches!(s, Shape::Path(p) if !p.closed && p.points.len() >= 3 && p.stroke.color == white)), "a white preview"); +} + #[test] fn a_selected_layer_shows_its_constraint_guides_in_its_frame() { // A child pinned left (the default) in a frame without auto layout: a dashed guide runs from its From f137e9df9a8bf9ced198f8faa7177bd1ca242798 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Legrand?= Date: Sat, 31 Oct 2026 20:29:10 +0100 Subject: [PATCH 08/68] fix(pathops): M2.1: keep Fenwick indices Rust 1.95 compatible --- crates/pathops/src/budget.rs | 4 ++-- crates/pathops/src/budget_tests.rs | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/crates/pathops/src/budget.rs b/crates/pathops/src/budget.rs index ff6f9cab4..714611ceb 100644 --- a/crates/pathops/src/budget.rs +++ b/crates/pathops/src/budget.rs @@ -112,7 +112,7 @@ impl Fenwick { let mut i = rank + 1; while let Some(c) = self.0.get_mut(i) { *c += by; - i += i.isolate_lowest_one(); + i += i & i.wrapping_neg(); } } @@ -123,7 +123,7 @@ impl Fenwick { && let Some(c) = self.0.get(i) { n += c; - i -= i.isolate_lowest_one(); + i -= i & i.wrapping_neg(); } u64::try_from(n).unwrap_or(0) } diff --git a/crates/pathops/src/budget_tests.rs b/crates/pathops/src/budget_tests.rs index b53b5545d..a55e58e85 100644 --- a/crates/pathops/src/budget_tests.rs +++ b/crates/pathops/src/budget_tests.rs @@ -93,3 +93,9 @@ fn a_fold_stops_once_it_has_swept_its_budget() { assert_eq!(steps, MAX_FOLD_SEGMENTS / 100_004); assert_eq!(budget.spend(&BezPath::new(), &BezPath::new()), Err(PathOpsError::TooComplex), "spent stays spent"); } + +#[test] +fn overlapping_rectangle_bounds_count_self_and_cross_pairs() { + let shapes = rects([Rect::new(0.0, 0.0, 2.0, 2.0), Rect::new(1.0, 1.0, 3.0, 3.0), Rect::new(4.0, 4.0, 5.0, 5.0)]); + assert_eq!(complexity([&shapes]), Some(Complexity { segments: 12, crossings: 14 })); +} From e3df030be97c427b070cfee648cc2daf07ae35f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Legrand?= Date: Sat, 31 Oct 2026 20:45:51 +0100 Subject: [PATCH 09/68] fix(text): M2.1: simplify font file filter --- crates/text/src/fontdb.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/text/src/fontdb.rs b/crates/text/src/fontdb.rs index 2c6aac948..6ebd7ec45 100644 --- a/crates/text/src/fontdb.rs +++ b/crates/text/src/fontdb.rs @@ -1304,7 +1304,7 @@ fn index_font_file(path: &std::path::Path, meta: &std::fs::Metadata, out: &mut B return; } let ext = path.extension().and_then(std::ffi::OsStr::to_str).map(str::to_ascii_lowercase).unwrap_or_default(); - if !matches!(ext.as_str(), "ttf" | "otf" | "ttc" | "otc") && !(path.extension().is_none() && starts_like_a_font(path)) { + if !(matches!(ext.as_str(), "ttf" | "otf" | "ttc" | "otc") || path.extension().is_none() && starts_like_a_font(path)) { return; } // Very large files are indexed all the same (Apple Color Emoji is ~180 MB and is where the From 25b128e5385af20f1b7f34ab6f68cf4eebf40d54 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sun, 1 Nov 2026 00:14:22 -0400 Subject: [PATCH 10/68] Pencil colour: document the dark threshold; tests for a frame without a fill, a see-through fill and the threshold Review follow-up on #1775: the dark rule is the one text uses (on_dark_background); a frame with no fill, or a fill under 50% alpha, is looked through to what is behind it, and the threshold is Color::is_dark (#757575 is dark, #767676 is light). Co-Authored-By: Claude Fable 5.1 --- crates/engine/src/brush_tests.rs | 10 ++++++++++ crates/engine/src/canvas/tools/handles.rs | 4 +++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/crates/engine/src/brush_tests.rs b/crates/engine/src/brush_tests.rs index 984eaaad5..35dba6a7f 100644 --- a/crates/engine/src/brush_tests.rs +++ b/crates/engine/src/brush_tests.rs @@ -138,4 +138,14 @@ fn the_pencil_draws_white_on_a_dark_background() { s.execute("page.setBackground", &json!({"color": "#1E1E1E"})).unwrap(); s.execute("node.create", &json!({"type": "frame", "x": 600, "y": 300, "width": 200, "height": 200, "props": {"fills": ["#FFFFFF"]}})).unwrap(); assert_eq!(stroke(&mut s, 620.0, 320.0), (Color::BLACK, Some(Color::BLACK)), "inside a light frame on a dark page"); + // A frame without a fill, or with a see-through one, is looked through to what is behind it. + s.execute("node.create", &json!({"type": "frame", "x": 900, "y": 300, "width": 200, "height": 200, "props": {"fills": []}})).unwrap(); + assert_eq!(stroke(&mut s, 920.0, 320.0), (Color::WHITE, Some(Color::WHITE)), "a frame without a fill on a dark page"); + s.execute("node.create", &json!({"type": "frame", "x": 1200, "y": 300, "width": 200, "height": 200, "props": {"fills": ["#FFFFFF40"]}})).unwrap(); + assert_eq!(stroke(&mut s, 1220.0, 320.0), (Color::WHITE, Some(Color::WHITE)), "a mostly transparent light frame on a dark page"); + // The threshold is Color::is_dark: white reads better than black from #757575 down. + for (bg, want) in [("#767676", Color::BLACK), ("#757575", Color::WHITE)] { + s.execute("page.setBackground", &json!({"color": bg})).unwrap(); + assert_eq!(stroke(&mut s, 0.0, 600.0).0, want, "on {bg}"); + } } diff --git a/crates/engine/src/canvas/tools/handles.rs b/crates/engine/src/canvas/tools/handles.rs index 9bd1c5973..9fa04d9bb 100644 --- a/crates/engine/src/canvas/tools/handles.rs +++ b/crates/engine/src/canvas/tools/handles.rs @@ -37,7 +37,9 @@ pub fn anchor_name(a: (u8, u8)) -> &'static str { } /// Whether what is drawn in `parent` sits on a dark background: the nearest layer from `parent` -/// out whose top visible fill is a mostly opaque solid colour, else the page (#362). +/// out whose top visible fill is a mostly opaque (alpha 0.5 or more) solid colour, else the page +/// (#362); a frame without such a fill is looked through to what is behind it. Dark means white +/// reads better on it than black (`Color::is_dark`: `#757575` is dark, `#767676` is light). pub(crate) fn on_dark_background(doc: &Document, parent: NodeId) -> bool { std::iter::once(parent) .chain(doc.ancestors(parent)) From 16b13919aa72c3eff4c8f3a52140bf8771492ce9 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sun, 1 Nov 2026 00:20:29 -0400 Subject: [PATCH 11/68] Page hex field: an 8-digit hex asking for opaque sets 100% Review follow-up on #1770: the typed colour keeps the page opacity only when the text carries no alpha (not 4 or 8 hex digits); FF0000FF on a translucent page now sets 100%. Test extended. Co-Authored-By: Claude Fable 5.1 --- crates/ui-egui/src/field_tests.rs | 11 +++++++++-- crates/ui-egui/src/panels/right.rs | 8 +++++--- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/crates/ui-egui/src/field_tests.rs b/crates/ui-egui/src/field_tests.rs index 63995fc80..8802bb7e9 100644 --- a/crates/ui-egui/src/field_tests.rs +++ b/crates/ui-egui/src/field_tests.rs @@ -1231,7 +1231,14 @@ fn the_page_background_opacity_field_sets_the_page_colour_alpha() { key(&mut u, Key::Enter, Modifiers::NONE); let c = page_bg(&u); assert!(near(c.g, 1.0) && near(c.a, 128.0 / 255.0), "{c:?}"); - assert_eq!(undo_steps(&u), steps + 3); + // Eight digits asking for opaque set 100 %: an alpha of 1 in the text is not "no alpha". + let at = hex(&mut u); + click(&mut u, at); + u.frame(vec![Event::Text("0000FFFF".into())]); + key(&mut u, Key::Enter, Modifiers::NONE); + let c = page_bg(&u); + assert!(near(c.b, 1.0) && near(c.a, 1.0), "{c:?}"); + assert_eq!(undo_steps(&u), steps + 4); u.app.run("edit.undo", json!({})); - assert!(near(page_bg(&u).r, 1.0) && near(page_bg(&u).a, 0.5), "undo takes back the last colour alone"); + assert!(near(page_bg(&u).g, 1.0) && near(page_bg(&u).a, 128.0 / 255.0), "undo takes back the last colour alone"); } diff --git a/crates/ui-egui/src/panels/right.rs b/crates/ui-egui/src/panels/right.rs index 4f31f4089..e9987ec49 100644 --- a/crates/ui-egui/src/panels/right.rs +++ b/crates/ui-egui/src/panels/right.rs @@ -323,12 +323,14 @@ fn page_section(app: &mut FigApp, ui: &mut Ui, doc: &Document) { let p = Paint::solid(bg); let sw = widgets::swatch(ui, &p, 16.0); app.picker_control(crate::colorpicker::PickerTarget::PageBackground, &sw); - // A typed colour keeps the page's opacity unless it carries one (`FF000080`), as the - // colour picker's hex field does. + // A typed colour keeps the page's opacity unless it carries one: 4 or 8 hex digits + // (`FF000080`; `FF0000FF` asks for opaque). if let Some(h) = widgets::text_field(ui, Id::unique("pagebg"), &bg.to_hex(), 96.0, "") && let Some(c) = figcraft_color::Color::from_hex_or_name(&h) { - new_color = Some((c.with_alpha(if c.a < 1.0 { c.a } else { bg.a }), None)); + let digits = h.trim().trim_start_matches('#'); + let carries_alpha = matches!(digits.len(), 4 | 8) && digits.chars().all(|ch| ch.is_ascii_hexdigit()); + new_color = Some((if carries_alpha { c } else { c.with_alpha(bg.a) }, None)); } // The opacity: a field like every other opacity field, not a label (#1748). let alpha = |v: f64| bg.with_alpha((v / 100.0).clamp(0.0, 1.0) as f32); From 058cc24befd3602da169a2565328ccba741f9e4e Mon Sep 17 00:00:00 2001 From: samhyun Date: Sun, 1 Nov 2026 18:06:56 +0900 Subject: [PATCH 12/68] M8: grains stay in their cells whatever origin a render starts from Noise and texture lay their grain cells out in the layer's own coordinates, so a patch, a band or a pan should draw the grains a full render draws. At a zoom of 1.7, a 1-unit cell is 1.7 pixels across and every tenth edge falls on a row of pixel centres; a render whose origin is a whole number of pixels off reached that edge with another rounding error and moved the row into the next cell. An edit over a textured layer patched up to 197 levels off a full render, and a noisy one 224. Cell positions are now rounded to 1/2^20 of a cell before they're cut into cells, and texture adds its scatter to the pixel index in whole pixels instead of flooring it in f32 together with the index. Co-Authored-By: Claude Opus 5.5 --- crates/render/src/grain.rs | 20 +++++++++++++++---- crates/render/src/grain_tests.rs | 20 +++++++++++++++++++ crates/render/src/retained_tests.rs | 30 +++++++++++++++++++++++++++++ 3 files changed, 66 insertions(+), 4 deletions(-) diff --git a/crates/render/src/grain.rs b/crates/render/src/grain.rs index d339a29fd..0ee827765 100644 --- a/crates/render/src/grain.rs +++ b/crates/render/src/grain.rs @@ -26,6 +26,14 @@ fn unit(h: u64, at: u32) -> f32 { f32::from(((h >> at) & 0xFFFF) as u16) / 65536.0 } +/// Cell positions are rounded to 1 / `STEPS_PER_CELL` of a cell before they're cut into cells. A +/// pixel centre can fall exactly on a cell edge (at a zoom of 1.7, a 1-unit cell is 1.7 pixels +/// across: every tenth edge does), and a view whose origin is a whole number of pixels off (a +/// patch, a band, a pan) reaches it with another rounding error. Unrounded, a row of grains lands +/// in the next cell; rounded, the edge moves 1 / 2²¹ of a cell aside, off the centres layers at +/// round positions and zooms put it on. +const STEPS_PER_CELL: f64 = 1_048_576.0; + /// Maps layer pixels to the grain cells under their centres. struct Cells { /// Layer pixels → local units, divided by the grain size: `[a, b, c, d, e, f]`. @@ -44,7 +52,8 @@ impl Cells { fn at(&self, x: u32, y: u32) -> (i64, i64) { let (px, py) = (f64::from(x) + 0.5, f64::from(y) + 0.5); let [a, b, c, d, e, f] = self.m; - ((a * px + c * py + e).floor() as i64, (b * px + d * py + f).floor() as i64) + let cell = |v: f64| ((v * STEPS_PER_CELL).round() / STEPS_PER_CELL).floor() as i64; + (cell(a * px + c * py + e), cell(b * px + d * py + f)) } } @@ -120,11 +129,14 @@ pub fn texture(layer: &mut Pixmap, t: &Texture, xf: Affine, scale: f64, seed: u3 let hv = hash(ix, iy, seed ^ 0x7E57_u32); // A uniform point in the disc of radius r. let (ang, dist) = (unit(hv, 0) * std::f32::consts::TAU, unit(hv, 16).sqrt() * r); - let (fx, fy) = (x as f32 + 0.5 + ang.cos() * dist, y as f32 + 0.5 + ang.sin() * dist); + // The move in whole pixels, apart from `x` and `y`: the same pixel of the page moves + // the same way wherever the layer's pixels start. + let (mx, my) = ((0.5 + ang.cos() * dist).floor() as i64, (0.5 + ang.sin() * dist).floor() as i64); + let (fx, fy) = (i64::from(x) + mx, i64::from(y) + my); let i = ((y * w + x) * 4) as usize; let mut px = [0u8; 4]; - if fx >= 0.0 && fy >= 0.0 && (fx as u32) < w && (fy as u32) < h { - let j = (((fy as u32) * w + fx as u32) * 4) as usize; + if fx >= 0 && fy >= 0 && fx < i64::from(w) && fy < i64::from(h) { + let j = ((fy * i64::from(w) + fx) * 4) as usize; if let Some(s) = src.get(j..j + 4) { px.copy_from_slice(s); } diff --git a/crates/render/src/grain_tests.rs b/crates/render/src/grain_tests.rs index bde0129a4..a06a445df 100644 --- a/crates/render/src/grain_tests.rs +++ b/crates/render/src/grain_tests.rs @@ -96,6 +96,26 @@ fn noise_grains_have_their_size_and_stay_put() { assert_eq!(px(&z, 23, 23), c); } +/// Panning by whole pixels at a zoom where grain edges fall on pixel centres (1.7: a 1-unit grain +/// is 1.7 pixels, every tenth edge on a centre) reaches those edges from another origin, with +/// another rounding error: the grains still stay put. +#[test] +fn grains_stay_put_where_their_edges_fall_on_pixel_centres() { + let s = 1.7; + for (why, kind) in [ + ("noise", noise(Noise { density: 0.5, size: 0.5, color: Color::BLACK, ..Noise::default() })), + ("texture", EffectKind::Texture(Texture { size: 0.5, radius: 12.0, clip_to_shape: false, ..Texture::default() })), + ] { + let (d, r) = square(kind); + let a = render_at(&d, r, (0.0, 0.0), s); + for (dx, dy) in [(79u32, 62u32), (13, 7), (31, 47), (5, 99)] { + let b = render_at(&d, r, (f64::from(dx) / s, f64::from(dy) / s), s); + let off = (0..200 - dy).flat_map(|y| (0..200 - dx).map(move |x| (x, y))).filter(|&(x, y)| px(&a, x + dx, y + dy) != px(&b, x, y)).count(); + assert_eq!(off, 0, "{why}, a pan by ({dx}, {dy}) pixels"); + } + } +} + #[test] fn noise_blend_mode_applies() { let (d, r) = square(noise(Noise { density: 1.0, color: Color::WHITE, blend: figcraft_color::BlendMode::Multiply, ..Noise::default() })); diff --git a/crates/render/src/retained_tests.rs b/crates/render/src/retained_tests.rs index dd93abc72..103178542 100644 --- a/crates/render/src/retained_tests.rs +++ b/crates/render/src/retained_tests.rs @@ -569,3 +569,33 @@ fn pans_patch_backdrops_at_the_edges_that_moved_in() { } } } + +#[test] +fn grainy_layers_patch_as_they_render() { + fonts(); + let texture = |clip_to_shape| EffectKind::Texture(figcraft_doc::Texture { size: 0.5, radius: 12.0, clip_to_shape, ..Default::default() }); + let noise = EffectKind::Noise(figcraft_doc::Noise { size: 0.5, density: 0.4, color: Color::BLACK, ..Default::default() }); + // At a zoom of 1.7, a grain of 0.5 is 1.7 pixels across: every tenth grain edge falls on a row + // of pixel centres, and a patch renders those rows from another origin than a full render. + for (why, kind) in [("texture", texture(false)), ("texture clipped to its shape", texture(true)), ("noise", noise)] { + let mut d = Document::new("grain"); + let p = d.first_page().unwrap(); + let e = d.create(p, NodeKind::Rectangle, "E", 60.0, 50.0, 120.0, 90.0).unwrap(); + solid(d.get_mut(e).unwrap(), "E03030"); + d.get_mut(e).unwrap().effects = vec![Effect { kind, visible: true }]; + let m = d.create(p, NodeKind::Rectangle, "M", 220.0, 60.0, 30.0, 30.0).unwrap(); + solid(d.get_mut(m).unwrap(), "20A060"); + let doc = Arc::new(d); + let v = View { origin: (0.0, 0.0), scale: 1.7, width: 400, height: 300 }; + let mut r = Retained::default(); + check(&mut r, &doc, p, &v); + // Over the grainy layer, which is redrawn whole. + let over = edit(&doc, |d| d.get_mut(m).unwrap().transform = Affine::translate((100.0, 80.0))); + let (shown, pix, work) = r.render(&over, p, &v, &Options::default()).unwrap(); + let pix = pix.clone(); + let full = render_view(&over, p, &shown, &Options::default()).unwrap(); + let worst = pix.data().iter().zip(full.data()).map(|(a, b)| a.abs_diff(*b)).max().unwrap_or(0); + assert!(partial(work), "{why}: {work:?}"); + assert!(worst <= 2, "{why}: {work:?} is {worst} levels off a full render"); + } +} From e39e563408aa64b89be507326dd68aabdb25cb68 Mon Sep 17 00:00:00 2001 From: samhyun Date: Sun, 1 Nov 2026 18:21:00 +0900 Subject: [PATCH 13/68] M8: dots halfway between pixels stay put across pans, bands and patches The board's dot grid puts each mark on the device pixel nearest its page position, measured from the view's top-left. At a zoom of 1.0625 a step of 24 is 25.5 pixels, so every second mark falls halfway between two pixels, and a view a whole number of pixels on could put it on the other one: `round` sends halves away from zero, so a mark left of the view's origin went left and one right of it went right, and the origin `(px + offset) / scale` reached the half with another rounding error. A pan moved those marks by a pixel (up to 123 levels off). Positions are now rounded to 1/65536 px and then half up. Co-Authored-By: Claude Opus 5.5 --- crates/render/src/dots.rs | 11 ++++++++++- crates/render/src/dots_tests.rs | 24 ++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/crates/render/src/dots.rs b/crates/render/src/dots.rs index b13cbdd57..f3effd1f1 100644 --- a/crates/render/src/dots.rs +++ b/crates/render/src/dots.rs @@ -57,7 +57,7 @@ pub(crate) fn draw(pix: &mut Pixmap, view: &View, d: &Dots) { let strong = |k: i64| k.rem_euclid(major) == 0; // The device-pixel span of the mark on line `k` along an axis `len` pixels long from `o`. let span = |k: i64, o: f64, len: i64| { - let a = ((k as f64 * d.step * s - o).round() as i64).saturating_sub(lead); + let a = (nearest_px(k as f64 * d.step * s - o) as i64).saturating_sub(lead); (a.max(0), a.saturating_add(side).min(len)) }; let row = w as usize * 4; @@ -92,6 +92,15 @@ pub(crate) fn draw(pix: &mut Pixmap, view: &View, d: &Dots) { } } +/// The device pixel nearest `p` pixels from the view's top-left. A mark halfway between two pixels +/// goes to the right (or lower) one on either side of the origin, and `p` is first rounded to +/// 1/65536 px: a view a whole number of pixels off (a pan, a band, a patch) reaches it with another +/// rounding error, and would otherwise put the marks that fall halfway on the other pixel. +fn nearest_px(p: f64) -> f64 { + const STEPS: f64 = 65_536.0; + ((p * STEPS).round() / STEPS + 0.5).floor() +} + /// Which line covers each device pixel along an axis: 0 none, 1 a faded one, 2 a strong one. type Cover = Vec; diff --git a/crates/render/src/dots_tests.rs b/crates/render/src/dots_tests.rs index 53d052062..a5ff2edc9 100644 --- a/crates/render/src/dots_tests.rs +++ b/crates/render/src/dots_tests.rs @@ -134,3 +134,27 @@ fn graph_paper_is_strong_every_major_line() { assert_eq!(at(x, -195), strong, "a strong line at {x}"); } } + +/// At a zoom of 1.0625, a step of 24 is 25.5 pixels: every second dot falls halfway between two +/// pixels. A view a whole number of pixels on (a pan, a band, a patch) has to put it on the same +/// one, on whichever side of that view's origin it is. +#[test] +fn dots_halfway_between_pixels_stay_put() { + let (d, page) = page_with_square(); + for lines in [false, true] { + let opts = Options { dots: Some(Dots { lines, ..dots() }), ..Default::default() }; + let s = 1.0625; + let full = View { origin: (0.0, 0.0), scale: s, width: 400, height: 300 }; + let a = render_view_single(&d, page, &full, &opts).unwrap(); + for dx in 1..100u32 { + let dy = (dx * 37) % 100; + let v = View { origin: (f64::from(dx) / s, f64::from(dy) / s), scale: s, width: 250, height: 180 }; + let b = render_view_single(&d, page, &v, &opts).unwrap(); + for y in 0..180 { + for x in 0..250 { + assert_eq!(rgba(&b, x, y), rgba(&a, x + dx, y + dy), "lines {lines}, a pan by ({dx}, {dy}), at {x}, {y}"); + } + } + } + } +} From a46e2369bcd86afa8f8c859f6e914250606d4a40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20Mittelst=C3=A4dt?= <62167861+TheGalitube@users.noreply.github.com> Date: Sun, 1 Nov 2026 09:31:20 +0000 Subject: [PATCH 14/68] Preserve finite values at large rounding precision Found while testing crates/geom/src/transform.rs:59 Co-Authored-By: GPT-5.6-Luna Co-Authored-By: GPT-6-Luna --- crates/geom/src/tests.rs | 7 +++++++ crates/geom/src/transform.rs | 3 +++ 2 files changed, 10 insertions(+) diff --git a/crates/geom/src/tests.rs b/crates/geom/src/tests.rs index 37e6ccab7..509db9779 100644 --- a/crates/geom/src/tests.rs +++ b/crates/geom/src/tests.rs @@ -163,6 +163,13 @@ fn set_rotation_keeps_center() { } } +#[test] +fn round_to_handles_large_precision_without_changing_finite_values() { + assert_eq!(round_to(1.25, 400), 1.25); + assert_eq!(round_to(-1.25, 400), -1.25); + assert_eq!(round_to(1.23456, 2), 1.23); +} + #[test] fn reverse_subpaths_preserves_open_and_closed() { let mut open = BezPath::new(); diff --git a/crates/geom/src/transform.rs b/crates/geom/src/transform.rs index f992060fd..69c6c788d 100644 --- a/crates/geom/src/transform.rs +++ b/crates/geom/src/transform.rs @@ -57,6 +57,9 @@ pub fn rotate_about(xf: Affine, pivot: Point, degrees: f64) -> Affine { /// Round a value to `digits` decimals for display (avoids `-0` and float noise). pub fn round_to(v: f64, digits: i32) -> f64 { let f = 10f64.powi(digits); + if v.is_finite() && !f.is_finite() { + return v; + } let r = (v * f).round() / f; if r == 0.0 { 0.0 } else { r } } From c8f34acc59052e6d3482396866bae670a5a93e05 Mon Sep 17 00:00:00 2001 From: samhyun Date: Sun, 1 Nov 2026 18:40:05 +0900 Subject: [PATCH 15/68] M8: dots on the 1/65536 px rounding step stay put too Review of #1796: rounding a mark's position to 1/65536 px with `round` sent the halves of that step away from zero, the asymmetry the PR set out to remove, one step further down. At a step of 25.5 - 2^-17 px, a pan by 26 pixels put the first mark a pixel off a full render. Both roundings now go half up. Co-Authored-By: Claude Opus 5.5 --- crates/render/src/dots.rs | 11 ++++++----- crates/render/src/dots_tests.rs | 22 ++++++++++++++++++++++ 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/crates/render/src/dots.rs b/crates/render/src/dots.rs index f3effd1f1..5d4ae1fc1 100644 --- a/crates/render/src/dots.rs +++ b/crates/render/src/dots.rs @@ -92,13 +92,14 @@ pub(crate) fn draw(pix: &mut Pixmap, view: &View, d: &Dots) { } } -/// The device pixel nearest `p` pixels from the view's top-left. A mark halfway between two pixels -/// goes to the right (or lower) one on either side of the origin, and `p` is first rounded to -/// 1/65536 px: a view a whole number of pixels off (a pan, a band, a patch) reaches it with another -/// rounding error, and would otherwise put the marks that fall halfway on the other pixel. +/// The first device pixel of a mark whose edge is `p` pixels from the view's top-left: the one +/// whose left (or top) edge is nearest, and the right (or lower) one when two are as near. `p` is +/// first rounded to 1/65536 px, halves up as well: a view a whole number of pixels off (a pan, a +/// band, a patch) reaches it with another rounding error, and, rounded either way, would put the +/// marks that fall halfway on the other pixel. fn nearest_px(p: f64) -> f64 { const STEPS: f64 = 65_536.0; - ((p * STEPS).round() / STEPS + 0.5).floor() + ((p * STEPS + 0.5).floor() / STEPS + 0.5).floor() } /// Which line covers each device pixel along an axis: 0 none, 1 a faded one, 2 a strong one. diff --git a/crates/render/src/dots_tests.rs b/crates/render/src/dots_tests.rs index a5ff2edc9..18d96345f 100644 --- a/crates/render/src/dots_tests.rs +++ b/crates/render/src/dots_tests.rs @@ -158,3 +158,25 @@ fn dots_halfway_between_pixels_stay_put() { } } } + +/// A mark that rounds to a half step of 1/65536 px goes the same way on both sides of a view's +/// origin too: at a step of 25.5 − 2⁻¹⁷ px, the first mark is where 1/65536 px rounds up. +#[test] +fn dots_on_the_rounding_step_stay_put() { + let (d, page) = page_with_square(); + let step = 25.5 - 2f64.powi(-17); + for lines in [false, true] { + let opts = Options { dots: Some(Dots { step, lines, ..dots() }), ..Default::default() }; + let full = View { origin: (0.0, 0.0), scale: 1.0, width: 300, height: 200 }; + let a = render_view_single(&d, page, &full, &opts).unwrap(); + for pan in 1..60u32 { + let v = View { origin: (f64::from(pan), f64::from(pan)), scale: 1.0, width: 200, height: 120 }; + let b = render_view_single(&d, page, &v, &opts).unwrap(); + for y in 0..120 { + for x in 0..200 { + assert_eq!(rgba(&b, x, y), rgba(&a, x + pan, y + pan), "lines {lines}, a pan by {pan}, at {x}, {y}"); + } + } + } + } +} From 12b0bcddcba1b0098e09250e0f9075c0a0826197 Mon Sep 17 00:00:00 2001 From: samhyun Date: Sun, 1 Nov 2026 18:47:09 +0900 Subject: [PATCH 16/68] M8: a test for texture's whole-pixel moves in wide layers Review of #1795: the tests checked the rounding of grain cells but not the move texture now adds in whole pixels. Rounded cells with the old `f32` move still passed them. A pan across a 2,400-pixel-wide striped layer catches it: past 1,024 pixels, the old move came out a pixel off for some pixels. Co-Authored-By: Claude Opus 5.5 --- crates/render/src/grain_tests.rs | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/crates/render/src/grain_tests.rs b/crates/render/src/grain_tests.rs index a06a445df..743530944 100644 --- a/crates/render/src/grain_tests.rs +++ b/crates/render/src/grain_tests.rs @@ -158,3 +158,32 @@ fn hostile_grain_values_do_not_crash() { let _ = render_at(&d, r, (0.0, 0.0), 1.0); } } + +/// Texture moves each pixel by whole pixels, the same in any layer: far from the layer's left edge +/// (past 1024 pixels), a move worked out in `f32` together with the pixel's index came out a +/// pixel off for some indices, so a pan changed which pixel a grain took. (The stripes' gradient +/// itself can differ by a level between the two renders; a grain taking the wrong pixel differs by +/// far more.) +#[test] +fn texture_moves_far_into_a_wide_layer_stay_put() { + use figcraft_color::{ColorStop, Gradient, GradientKind}; + let mut d = Document::new("wide"); + let p = d.first_page().unwrap(); + let r = d.create(p, NodeKind::Rectangle, "Stripes", 0.0, 0.0, 2400.0, 60.0).unwrap(); + let n = d.get_mut(r).unwrap(); + // Black and white stripes, 3 units each: a pixel's neighbours differ. + let stops = (0..=800).map(|i| ColorStop { position: i as f32 / 800.0, color: if i % 2 == 0 { Color::BLACK } else { Color::WHITE } }).collect(); + n.fills = vec![Paint::gradient(Gradient { kind: GradientKind::Linear, stops, from: (0.0, 0.5), to: (1.0, 0.5), width: (0.0, 1.0) })]; + n.effects = + vec![Effect { kind: EffectKind::Texture(Texture { size: 1.0, radius: 12.0, clip_to_shape: false, ..Texture::default() }), visible: true }]; + let view = |x: f64, w: u32| View { origin: (x, -20.0), scale: 1.0, width: w, height: 100 }; + let mut a = Pixmap::new(2440, 100).unwrap(); + render_nodes_into(&d, &[r], &view(-20.0, 2440), &mut a); + for dx in [300u32, 1021, 1500] { + let mut b = Pixmap::new(900, 100).unwrap(); + render_nodes_into(&d, &[r], &view(f64::from(dx) - 20.0, 900), &mut b); + let far = |p: [u8; 4], q: [u8; 4]| p.iter().zip(q).any(|(u, v)| u.abs_diff(v) > 8); + let off = (0..100).flat_map(|y| (0..900).map(move |x| (x, y))).filter(|&(x, y)| far(px(&a, x + dx, y), px(&b, x, y))).count(); + assert_eq!(off, 0, "a pan by {dx} pixels"); + } +} From 3f7f5f38ce985132d64b0b803fb96b83654fb86c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20Mittelst=C3=A4dt?= <62167861+TheGalitube@users.noreply.github.com> Date: Sun, 1 Nov 2026 10:09:26 +0000 Subject: [PATCH 17/68] Reject overflowing u32 varints Found while testing crates/format/src/fig/kiwi.rs:190 Co-Authored-By: GPT-5.6-Luna Co-Authored-By: GPT-6-Luna --- crates/format/src/fig/kiwi.rs | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/crates/format/src/fig/kiwi.rs b/crates/format/src/fig/kiwi.rs index d34b3774d..c564e445d 100644 --- a/crates/format/src/fig/kiwi.rs +++ b/crates/format/src/fig/kiwi.rs @@ -187,9 +187,13 @@ impl<'b> Reader<'b> { let mut shift = 0; loop { let b = self.byte()?; - value |= u32::from(b & 127).checked_shl(shift).unwrap_or(0); + let part = b & 127; + if shift == 28 && (part > 0x0f || b & 128 != 0) { + return err("u32 varint overflow"); + } + value |= u32::from(part) << shift; shift += 7; - if b & 128 == 0 || shift >= 35 { + if b & 128 == 0 { return Ok(value); } } @@ -640,3 +644,17 @@ fn numbered(token: &str, default: u32) -> Result<(String, u32), KiwiError> { Some((name, n)) => Ok((name.to_string(), n.parse().map_err(|_| KiwiError(format!("schema text: bad number in `{token}`")))?)), } } + +#[cfg(test)] +mod tests { + use super::Reader; + + #[test] + fn overflowing_u32_varint_is_rejected() { + let mut boundary = Reader { data: &[0xff, 0xff, 0xff, 0xff, 0x0f], pos: 0 }; + assert_eq!(boundary.var_uint(), Ok(u32::MAX)); + + let mut overflowing = Reader { data: &[0xff, 0xff, 0xff, 0xff, 0x7f], pos: 0 }; + assert!(overflowing.var_uint().is_err(), "overflowing u32 varint was accepted"); + } +} From 8c93d0559fbb70d4b9478e286a506cf9abe6447d Mon Sep 17 00:00:00 2001 From: samhyun Date: Sun, 1 Nov 2026 19:03:53 +0900 Subject: [PATCH 18/68] M8: dots quantize their position apart from the view's origin Review of #1796: quantizing the mark's distance from the view's corner took in the error of the view's origin converted to pixels, so a mark one 1/65536 px step short of a half could still cross it. At a step of 24 and a zoom of (75.5 - 2^-17) / 24, a pan by 51 pixels moved the first mark. The mark's position and the origin are now each quantized before the one is taken from the other. The origin rounds its halves down: some 4 x 10^10 pixels out, its error is exactly half a step, and rounded up it moved the marks again. Past 2^37 pixels the step is finer than f64 and values are used as they are, so huge ones no longer overflow to infinity and come out as a mark at the view's corner. Co-Authored-By: Claude Opus 5.5 --- crates/render/src/dots.rs | 22 +++++++++----- crates/render/src/dots_tests.rs | 54 +++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 8 deletions(-) diff --git a/crates/render/src/dots.rs b/crates/render/src/dots.rs index 5d4ae1fc1..c33e89a22 100644 --- a/crates/render/src/dots.rs +++ b/crates/render/src/dots.rs @@ -57,7 +57,7 @@ pub(crate) fn draw(pix: &mut Pixmap, view: &View, d: &Dots) { let strong = |k: i64| k.rem_euclid(major) == 0; // The device-pixel span of the mark on line `k` along an axis `len` pixels long from `o`. let span = |k: i64, o: f64, len: i64| { - let a = (nearest_px(k as f64 * d.step * s - o) as i64).saturating_sub(lead); + let a = (nearest_px(k as f64 * d.step * s, o) as i64).saturating_sub(lead); (a.max(0), a.saturating_add(side).min(len)) }; let row = w as usize * 4; @@ -92,14 +92,20 @@ pub(crate) fn draw(pix: &mut Pixmap, view: &View, d: &Dots) { } } -/// The first device pixel of a mark whose edge is `p` pixels from the view's top-left: the one -/// whose left (or top) edge is nearest, and the right (or lower) one when two are as near. `p` is -/// first rounded to 1/65536 px, halves up as well: a view a whole number of pixels off (a pan, a -/// band, a patch) reaches it with another rounding error, and, rounded either way, would put the -/// marks that fall halfway on the other pixel. -fn nearest_px(p: f64) -> f64 { +/// The first device pixel of a mark whose edge is `at` pixels from the page origin, in a view whose +/// top-left is `o` pixels from it: the pixel whose left (or top) edge is nearest, and the right (or +/// lower) one when two are as near. A view a whole number of pixels off (a pan, a band, a patch) +/// gets `o` back from its origin with a rounding error, so `at` and `o` are each rounded to +/// 1/65536 px first: the mark's own position decides the pixel, and the view only counts it out +/// from its corner. The mark's halves go up and the origin's down: far out, where the origin's +/// error is half a step, it still comes back to the whole pixel. Past 2³⁷ px the step is finer +/// than `f64` and values are used as they are. +fn nearest_px(at: f64, o: f64) -> f64 { const STEPS: f64 = 65_536.0; - ((p * STEPS + 0.5).floor() / STEPS + 0.5).floor() + const EXACT: f64 = 137_438_953_472.0; // 2³⁷ + let up = |v: f64| if v.abs() < EXACT { (v * STEPS + 0.5).floor() / STEPS } else { v }; + let down = |v: f64| if v.abs() < EXACT { (v * STEPS - 0.5).ceil() / STEPS } else { v }; + (up(at) - down(o) + 0.5).floor() } /// Which line covers each device pixel along an axis: 0 none, 1 a faded one, 2 a strong one. diff --git a/crates/render/src/dots_tests.rs b/crates/render/src/dots_tests.rs index 18d96345f..75932a2bf 100644 --- a/crates/render/src/dots_tests.rs +++ b/crates/render/src/dots_tests.rs @@ -180,3 +180,57 @@ fn dots_on_the_rounding_step_stay_put() { } } } + +/// The view's origin is quantized apart from the marks: converted to pixels, a whole-pixel origin +/// comes back a hair off, and taken together with a mark one step short of a half it would push the +/// mark across. +#[test] +fn dots_one_rounding_step_short_of_a_half_stay_put() { + let (d, page) = page_with_square(); + let s = (75.5 - 2f64.powi(-17)) / 24.0; + for lines in [false, true] { + let opts = Options { dots: Some(Dots { lines, ..dots() }), ..Default::default() }; + let a = render_view_single(&d, page, &View { origin: (0.0, 0.0), scale: s, width: 300, height: 200 }, &opts).unwrap(); + for pan in 1..100u32 { + let v = View { origin: (f64::from(pan) / s, f64::from(pan) / s), scale: s, width: 200, height: 100 }; + let b = render_view_single(&d, page, &v, &opts).unwrap(); + for y in 0..100 { + for x in 0..200 { + assert_eq!(rgba(&b, x, y), rgba(&a, x + pan, y + pan), "lines {lines}, a pan by {pan}, at {x}, {y}"); + } + } + } + } +} + +/// Far out (some 4 × 10¹⁰ pixels), a whole-pixel origin comes back from page units exactly half a +/// rounding step off: rounded up, it would move the marks that fall halfway between pixels. +#[test] +fn far_out_dots_stay_put() { + let (d, page) = page_with_square(); + let s = 0.3; + let at = 42_536_140_695.0; + let opts = Options { dots: Some(Dots { step: 5.0, ..dots() }), ..Default::default() }; + let a = render_view_single(&d, page, &View { origin: (at / s, 0.0), scale: s, width: 420, height: 40 }, &opts).unwrap(); + for dx in 1..200u32 { + let v = View { origin: ((at + f64::from(dx)) / s, 0.0), scale: s, width: 200, height: 40 }; + let b = render_view_single(&d, page, &v, &opts).unwrap(); + for y in 0..40 { + for x in 0..200 { + assert_eq!(rgba(&b, x, y), rgba(&a, x + dx, y), "a pan by {dx}, at {x}, {y}"); + } + } + } +} + +/// Positions too far out to quantize draw nothing rather than a mark at the corner. +#[test] +fn dots_out_past_any_page_draw_nothing() { + let (d, page) = page_with_square(); + let plain = render_view_single(&d, page, &View { origin: (1e304, 0.0), scale: 1.0, width: 40, height: 40 }, &Options::default()).unwrap(); + for (step, x) in [(1e290, 1e304), (1e299, 1e305), (3e303, 1.5e308)] { + let opts = Options { dots: Some(Dots { step, ..dots() }), ..Default::default() }; + let p = render_view_single(&d, page, &View { origin: (x, 0.0), scale: 1.0, width: 40, height: 40 }, &opts).unwrap(); + assert_eq!(p.data(), plain.data(), "a step of {step} at {x}"); + } +} From 4e22873b44dfcf5ec6d5a8e7fd8b077501b07662 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sun, 1 Nov 2026 12:01:33 -0500 Subject: [PATCH 19/68] Page opacity test: a scrub on the field is live and one undo step Co-Authored-By: Claude Fable 5.1 --- crates/ui-egui/src/field_tests.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/crates/ui-egui/src/field_tests.rs b/crates/ui-egui/src/field_tests.rs index 8802bb7e9..a6fd9830f 100644 --- a/crates/ui-egui/src/field_tests.rs +++ b/crates/ui-egui/src/field_tests.rs @@ -1217,6 +1217,14 @@ fn the_page_background_opacity_field_sets_the_page_colour_alpha() { type_into(&mut u, "Opacity", "50", Key::Enter); assert!(near(page_bg(&u).a, 0.5), "{:?}", page_bg(&u)); assert_eq!(undo_steps(&u), steps + 1, "one undo step for the commit"); + // No label is drawn, so the field's leading strip scrubs it: a percent a point, live, and one + // undo step for the whole drag. + let edge = lead(&u, Id::unique("pagebg_a")); + drag(&mut u, edge, -25.0, Modifiers::NONE); + assert!(near(page_bg(&u).a, 0.25), "{:?}", page_bg(&u)); + assert_eq!(undo_steps(&u), steps + 2, "one undo step for the whole scrub"); + u.app.run("edit.undo", json!({})); + assert!(near(page_bg(&u).a, 0.5), "undo takes back the scrub alone"); // The hex field keeps the opacity when the typed colour has none, and takes one it carries. let hex = |u: &mut Ui| u.ctx.read_response(Id::unique("pagebg").with("click")).expect("the hex field").rect.center(); let at = hex(&mut u); From e7a599baea9f3accbb9dd1ef561fc03566d1875a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Legrand?= Date: Sun, 1 Nov 2026 19:42:52 +0100 Subject: [PATCH 20/68] style(text): M2.1: clarify font filter precedence --- crates/text/src/fontdb.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/text/src/fontdb.rs b/crates/text/src/fontdb.rs index 6ebd7ec45..ac851647b 100644 --- a/crates/text/src/fontdb.rs +++ b/crates/text/src/fontdb.rs @@ -1304,7 +1304,7 @@ fn index_font_file(path: &std::path::Path, meta: &std::fs::Metadata, out: &mut B return; } let ext = path.extension().and_then(std::ffi::OsStr::to_str).map(str::to_ascii_lowercase).unwrap_or_default(); - if !(matches!(ext.as_str(), "ttf" | "otf" | "ttc" | "otc") || path.extension().is_none() && starts_like_a_font(path)) { + if !(matches!(ext.as_str(), "ttf" | "otf" | "ttc" | "otc") || (path.extension().is_none() && starts_like_a_font(path))) { return; } // Very large files are indexed all the same (Apple Color Emoji is ~180 MB and is where the From c41471d20bdde3e7308afce5fe92a884f1873a60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Legrand?= Date: Sun, 1 Nov 2026 19:54:54 +0100 Subject: [PATCH 21/68] build(pathops): M2.1: inherit workspace Rust version --- crates/pathops/Cargo.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/crates/pathops/Cargo.toml b/crates/pathops/Cargo.toml index 27e2b7200..207a79cdf 100644 --- a/crates/pathops/Cargo.toml +++ b/crates/pathops/Cargo.toml @@ -3,6 +3,7 @@ name = "figcraft-pathops" version.workspace = true edition.workspace = true license.workspace = true +rust-version.workspace = true description = "FigCraft path operations: booleans (union, subtract, intersect, exclude), outline stroke with inside/center/outside alignment, arrowheads" [lints] From cda326e24e8972eb2724f2456707562dd50cbcfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Legrand?= Date: Sat, 31 Oct 2026 20:54:42 +0100 Subject: [PATCH 22/68] fix(vectordrawable): M2.1: use inclusive range checks --- crates/vectordrawable/src/paint.rs | 2 +- crates/vectordrawable/src/tests/gradients.rs | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/vectordrawable/src/paint.rs b/crates/vectordrawable/src/paint.rs index f66d0554a..0e8d01407 100644 --- a/crates/vectordrawable/src/paint.rs +++ b/crates/vectordrawable/src/paint.rs @@ -68,7 +68,7 @@ pub(crate) fn color_at(stops: &[(f64, Color)], t: f64) -> Color { /// the seam where the gradient starts over kept as a hard step. pub(crate) fn turn_stops(stops: &[(f64, Color)], shift: f64) -> Vec<(f64, Color)> { let d = shift.rem_euclid(1.0); - if !d.is_finite() || d < 1e-9 || d > 1.0 - 1e-9 || stops.is_empty() { + if !d.is_finite() || !(1e-9..=1.0 - 1e-9).contains(&d) || stops.is_empty() { return stops.to_vec(); } let seam = 1.0 - d; diff --git a/crates/vectordrawable/src/tests/gradients.rs b/crates/vectordrawable/src/tests/gradients.rs index ae58126e1..8f2a69edc 100644 --- a/crates/vectordrawable/src/tests/gradients.rs +++ b/crates/vectordrawable/src/tests/gradients.rs @@ -77,7 +77,7 @@ fn every_gradient_samples_where_figcraft_samples_it() { let stops: Vec<_> = g.sorted_stops().iter().map(|s| (f64::from(s.position), s.color)).collect(); let (a, b) = (color_at(&stops, want), color_at(&grad.stops, got)); // Away from the sweep's seam a turn's worth either side is the same colour. - let near_seam = kind == GradientKind::Angular && (want < 1e-3 || want > 1.0 - 1e-3); + let near_seam = kind == GradientKind::Angular && !want.is_nan() && !(1e-3..=1.0 - 1e-3).contains(&want); if !near_seam { assert!( (a.r - b.r).abs() < 1e-3 && (a.g - b.g).abs() < 1e-3 && (a.b - b.b).abs() < 1e-3, @@ -107,7 +107,7 @@ fn the_written_gradient_matches_the_rendered_pixels() { for x in (2..98).step_by(3) { let pt = Point::new(x as f64 + 0.5, y as f64 + 0.5); let ft = figcraft_t(kind, f, pt); - if kind == GradientKind::Angular && (ft < 0.03 || ft > 0.97 || (ft - 0.6).abs() < 0.01) { + if kind == GradientKind::Angular && !ft.is_nan() && (!(0.03..=0.97).contains(&ft) || (ft - 0.6).abs() < 0.01) { continue; } let (t, grad) = vd_t(&out, pt).unwrap(); @@ -149,7 +149,7 @@ fn turned_stops_keep_every_colour_where_it_was() { for i in 1..200 { let t = i as f64 / 200.0; let moved = (t + shift).rem_euclid(1.0); - if moved < 1e-6 || moved > 1.0 - 1e-6 { + if !moved.is_nan() && !(1e-6..=1.0 - 1e-6).contains(&moved) { continue; } let (a, b) = (color_at(&stops, t), color_at(&turned, moved)); From 6f7814c9d3c4c8d25d1750962e6e9603725d9d2b Mon Sep 17 00:00:00 2001 From: michaelgiraldo <1228401+michaelgiraldo@users.noreply.github.com> Date: Sun, 1 Nov 2026 11:23:39 -0800 Subject: [PATCH 23/68] M9: document combined browser and collaboration hosting --- docs/server.md | 12 ++++++++++++ packaging/server/Caddyfile | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/docs/server.md b/docs/server.md index 9d42cb0fc..fddd5852e 100644 --- a/docs/server.md +++ b/docs/server.md @@ -753,6 +753,18 @@ sudo -u figcraft figcraft-server --config /etc/figcraft-server/server.toml key The other commands ([Managing files and links](#managing-files-and-links)) run the same way, as the `figcraft` user with `--config /etc/figcraft-server/server.toml`. +**Browser editor on the same hostname (optional).** The steps above install the collaboration +server. To also serve the editor, copy the complete contents of the matching +`figcraft-web-/` release directory into `/srv/figcraft-web`, with `index.html` directly +inside it; keep subdirectories such as `snippets/`. Use the commented browser-and-server block +in [`packaging/server/Caddyfile`](../packaging/server/Caddyfile) in place of its active server-only +block. Keep the loopback `listen`, `public_url` and `trusted_proxy` settings from steps 2 and 4. +The editor opens at `https://figcraft.example.com/app/`; the hostname root remains the +`wss://figcraft.example.com/` collaboration endpoint, not an editor homepage. Configure the +browser's `figcraft-server` meta tag as described in the +[web-hosting guide](../packaging/web/README.md#live-sessions), using the server address without a +publishing key. That guide also covers browser requirements, fonts and static-file delivery. + **In Docker instead of systemd.** [`packaging/server/Dockerfile`](../packaging/server/Dockerfile) builds a small image (the binary on a distroless base, no shell) that runs as an unprivileged user, keeps its files in the `/data` volume and stops gracefully on `docker stop`. Build it from diff --git a/packaging/server/Caddyfile b/packaging/server/Caddyfile index cd34394d0..e8ba7be8f 100644 --- a/packaging/server/Caddyfile +++ b/packaging/server/Caddyfile @@ -16,3 +16,35 @@ figcraft.example.com { # reverse_proxy 127.0.0.1:47900 # } # } + +# Browser editor and server on the same hostname instead. Use this block IN PLACE OF the +# active block above. Copy the complete browser release into /srv/figcraft-web, with index.html +# directly inside it and subdirectories such as snippets/ kept. See packaging/web/README.md for +# the browser's figcraft-server meta tag; never put a publishing key in public HTML. +# Open the editor at /app/. The hostname root remains the WSS endpoint, not an editor homepage. +# +# figcraft.example.com { +# encode gzip +# +# redir /app /app/?{query} 308 +# +# @entry path /app/ /app/index.html +# header @entry Cache-Control "no-cache" +# +# @release_assets path /app/figcraft-web-*.js /app/figcraft-web-*_bg.wasm +# header @release_assets Cache-Control "public, max-age=31536000, immutable" +# +# # No root favicon is configured: do not forward its implicit request to the WS server. +# handle /favicon.ico { +# respond 204 +# } +# +# handle_path /app/* { +# root * /srv/figcraft-web +# file_server +# } +# +# handle { +# reverse_proxy 127.0.0.1:47900 +# } +# } From 86e74a93f592050b72583ed928bd14eb6c381a0c Mon Sep 17 00:00:00 2001 From: michaelgiraldo <1228401+michaelgiraldo@users.noreply.github.com> Date: Sun, 1 Nov 2026 11:54:10 -0800 Subject: [PATCH 24/68] M9: avoid immutable caching of missing browser assets --- packaging/server/Caddyfile | 5 +- packaging/server/caddy-test.sh | 119 +++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+), 1 deletion(-) create mode 100755 packaging/server/caddy-test.sh diff --git a/packaging/server/Caddyfile b/packaging/server/Caddyfile index e8ba7be8f..b36700b7e 100644 --- a/packaging/server/Caddyfile +++ b/packaging/server/Caddyfile @@ -32,7 +32,10 @@ figcraft.example.com { # header @entry Cache-Control "no-cache" # # @release_assets path /app/figcraft-web-*.js /app/figcraft-web-*_bg.wasm -# header @release_assets Cache-Control "public, max-age=31536000, immutable" +# # Defer so a missing asset does not receive the one-year cache header. +# header @release_assets Cache-Control "public, max-age=31536000, immutable" { +# defer +# } # # # No root favicon is configured: do not forward its implicit request to the WS server. # handle /favicon.ico { diff --git a/packaging/server/caddy-test.sh b/packaging/server/caddy-test.sh new file mode 100755 index 000000000..f2dd6b563 --- /dev/null +++ b/packaging/server/caddy-test.sh @@ -0,0 +1,119 @@ +#!/bin/sh +# Exercise the optional browser/server example with synthetic files over loopback HTTP. +# Requires caddy and nc; no backend, root access, public DNS or certificate is needed. +# Usage: packaging/server/caddy-test.sh +# Overrides: CADDY=/path/to/caddy CADDYFILE=/path/to/Caddyfile CADDY_TEST_PORT=18080 +set -eu + +HERE="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd)" +CADDY="${CADDY:-caddy}" +CADDYFILE="${CADDYFILE:-$HERE/Caddyfile}" +PORT="${CADDY_TEST_PORT:-18080}" +case "$PORT" in ''|*[!0-9]*) echo 'CADDY_TEST_PORT must be a port number' >&2; exit 1 ;; esac +[ "$PORT" -gt 1023 ] && [ "$PORT" -lt 65536 ] || exit 1 +command -v "$CADDY" >/dev/null +command -v nc >/dev/null + +WORK="$(mktemp -d)" +PID='' +cleanup() { + status=$? + trap - 0 + if [ -n "$PID" ]; then + kill "$PID" 2>/dev/null || true + wait "$PID" 2>/dev/null || true + fi + rm -rf "$WORK" + exit "$status" +} +trap cleanup 0 +trap 'exit 1' HUP INT TERM +fail() { printf 'FAIL: %s\n' "$*" >&2; cat "$WORK/caddy.log" >&2; exit 1; } + +mkdir "$WORK/web" +printf 'synthetic editor\n' >"$WORK/web/index.html" +printf 'synthetic JavaScript asset\n' >"$WORK/web/figcraft-web-present.js" +printf 'synthetic WebAssembly asset\n' >"$WORK/web/figcraft-web-present_bg.wasm" + +# Extract the real commented block, changing only the hostname and filesystem root. +# The admin endpoint is disabled; state directories stay inside the temporary fixture. +printf '{\n\tadmin off\n}\n' >"$WORK/Caddyfile" +awk -v port="$PORT" -v root="$WORK/web" ' + $0 == "# figcraft.example.com {" { active = 1; found++; print "http://127.0.0.1:" port " {"; next } + active { + if ($0 !~ /^#/) exit 1 + if ($0 == "# }") { print "}"; active = 0; next } + sub(/^# ?/, "") + if ($1 == "root" && $2 == "*" && $3 == "/srv/figcraft-web") $0 = "\t\troot * \"" root "\"" + print + } + END { if (found != 1 || active) exit 1 } +' "$CADDYFILE" >>"$WORK/Caddyfile" + +XDG_CONFIG_HOME="$WORK/config" XDG_DATA_HOME="$WORK/data" \ + "$CADDY" validate --config "$WORK/Caddyfile" --adapter caddyfile >"$WORK/caddy.log" 2>&1 || + fail 'extracted example did not validate' +XDG_CONFIG_HOME="$WORK/config" XDG_DATA_HOME="$WORK/data" \ + "$CADDY" run --config "$WORK/Caddyfile" --adapter caddyfile >>"$WORK/caddy.log" 2>&1 & +PID=$! + +request() { + printf '%s %s HTTP/1.1\r\nHost: 127.0.0.1\r\nConnection: close\r\n\r\n' "$1" "$2" | + nc -w 2 127.0.0.1 "$PORT" >"$WORK/response" || return 1 + tr -d '\r' <"$WORK/response" >"$WORK/clean" + awk 'BEGIN { headers = 1 } headers && /^$/ { headers = 0; next } !headers { print }' \ + "$WORK/clean" >"$WORK/body" +} +status() { awk 'NR == 1 { print $2 }' "$WORK/clean"; } +cache() { + awk '/^$/ { exit } tolower($0) ~ /^cache-control:/ { sub(/^[^:]*:[ \t]*/, ""); print }' "$WORK/clean" +} + +attempt=0 +until request GET /app/ 2>/dev/null && [ "$(status)" = 200 ]; do + kill -0 "$PID" 2>/dev/null || fail 'Caddy did not start (port may be in use)' + attempt=$((attempt + 1)) + [ "$attempt" -lt 30 ] || fail 'Caddy did not become ready' + sleep 0.1 +done +kill -0 "$PID" 2>/dev/null || fail 'Caddy exited during startup' + +IMMUTABLE='public, max-age=31536000, immutable' +checks=0 +check() { + method=$1 + name=$2 + expected=$3 + request "$method" "/app/$name" || fail "$method $name request failed" + [ "$(status)" = "$expected" ] || fail "$method $name: expected HTTP $expected, got $(status)" + if [ "$expected" = 200 ]; then + [ "$(cache)" = "$IMMUTABLE" ] || fail "$method $name: successful asset lost its cache policy" + if [ "$method" = GET ]; then + cmp -s "$WORK/body" "$WORK/web/$name" || fail "$method $name: wrong file contents" + fi + else + [ -z "$(cache)" ] || fail "$method $name: a missing asset received Cache-Control: $(cache)" + fi + if [ "$method" = HEAD ]; then + [ ! -s "$WORK/body" ] || fail "$method $name: HEAD returned a body" + fi + checks=$((checks + 1)) + printf 'PASS: %s %s -> %s\n' "$method" "$name" "$expected" +} + +for method in GET HEAD; do + check "$method" figcraft-web-present.js 200 + check "$method" figcraft-web-present_bg.wasm 200 + check "$method" figcraft-web-later.js 404 + check "$method" figcraft-web-later_bg.wasm 404 +done + +# The same URLs must work immediately when deployment supplies the previously missing files. +printf 'new JavaScript asset\n' >"$WORK/web/figcraft-web-later.js" +printf 'new WebAssembly asset\n' >"$WORK/web/figcraft-web-later_bg.wasm" +for method in GET HEAD; do + check "$method" figcraft-web-later.js 200 + check "$method" figcraft-web-later_bg.wasm 200 +done + +printf 'Caddy browser asset caching: %s checks passed (%s)\n' "$checks" "$("$CADDY" version)" From ecd900ab375cc75b533f29021a6e60c2181c8385 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Sun, 1 Nov 2026 23:47:48 -0500 Subject: [PATCH 25/68] Control channel: ui.key arrows pan the view when nothing is selected, as the window does Co-Authored-By: Claude Fable 5.1 --- crates/ui-egui/src/control.rs | 5 ++++- crates/ui-egui/src/inspect_fields_tests.rs | 25 ++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/crates/ui-egui/src/control.rs b/crates/ui-egui/src/control.rs index fd5a2a4e9..aa79bec78 100644 --- a/crates/ui-egui/src/control.rs +++ b/crates/ui-egui/src/control.rs @@ -996,7 +996,10 @@ fn ui_key(app: &mut FigApp, ctx: &Context, p: &Value) -> Result { "ArrowUp" => (0, -1), _ => (0, 1), }; - let (cmd, params) = if m.cmd || m.ctrl { + // With nothing selected the arrows pan the view, as the window's own key path does. + let (cmd, params) = if app.session.selection().is_empty() { + ("view.pan", json!({"dx": dx, "dy": dy, "big": m.shift})) + } else if m.cmd || m.ctrl { ("transform.nudgeSize", json!({"dw": dx, "dh": dy, "big": m.shift})) } else { ("transform.nudge", json!({"dx": dx, "dy": dy, "big": m.shift})) diff --git a/crates/ui-egui/src/inspect_fields_tests.rs b/crates/ui-egui/src/inspect_fields_tests.rs index 102e232b3..9ea3223fd 100644 --- a/crates/ui-egui/src/inspect_fields_tests.rs +++ b/crates/ui-egui/src/inspect_fields_tests.rs @@ -46,3 +46,28 @@ fn control_inspection_rejects_invalid_options_consistently() { } } } + +/// `ui.key` with an arrow and nothing selected pans the view, as the window's own key path does +/// (before, it answered that nothing was selected); with a selection it nudges (Shift: farther). +#[test] +fn control_key_arrows_pan_with_nothing_selected() { + let mut u = Ui::new(Session::new()); + let r = + call(&mut u, "engine.execute", json!({"command": "shape.rectangle", "params": {"x": 0, "y": 0, "width": 40, "height": 40}})).unwrap()["id"] + .clone(); + u.app.run("select.set", json!({"ids": []})); + u.app.run("view.set", json!({"zoom": 2.0, "cx": 0, "cy": 0})); + let view = |u: &Ui| { + let v = &u.app.session.ds().unwrap().view; + (v.cx, v.cy) + }; + call(&mut u, "ui.key", json!({"key": "ArrowRight"})).unwrap(); + assert_eq!(view(&u), (10.0, 0.0), "20 screen pixels at 200%"); + call(&mut u, "ui.key", json!({"key": "ArrowUp", "shift": true})).unwrap(); + assert_eq!(view(&u), (10.0, -100.0), "Shift: ten times as far"); + u.app.run("select.set", json!({"ids": [r]})); + call(&mut u, "ui.key", json!({"key": "ArrowRight"})).unwrap(); + assert_eq!(view(&u), (10.0, -100.0), "with a selection the view stays"); + let id = figcraft_engine::params::id_of(&r).unwrap(); + assert_eq!(u.app.session.doc().unwrap().world_bounds(id).unwrap().x0, 1.0, "the selection moved instead"); +} From 55821565ac0a3ecc36268a72fa5a2aec9430bb53 Mon Sep 17 00:00:00 2001 From: samhyun Date: Mon, 2 Nov 2026 09:58:03 +0900 Subject: [PATCH 26/68] M8: a spread round a stroke with corners keeps its whole shadow A dashed stroke is cut into dashes with corners wherever they fall round the outline, and a width profile or a brush can give the stroke corners of its own. A drop shadow's spread mitres those corners out, but a whole ellipse or a box still counted as growing by exactly its spread, so the shadow was cut off at the layer's edge (up to 255 levels). Such a node now gets the room a star does. Whether the outline's own mitres end on its box is a check of its own, which the stroke's reach keeps using, so a node with no spread keeps its bounds. Co-Authored-By: Claude Opus 5.5 --- crates/doc/src/node.rs | 22 ++++++++++--- crates/render/src/spread_tests.rs | 55 +++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 5 deletions(-) diff --git a/crates/doc/src/node.rs b/crates/doc/src/node.rs index 3ac81afdb..e24057f7b 100644 --- a/crates/doc/src/node.rs +++ b/crates/doc/src/node.rs @@ -944,7 +944,7 @@ impl Node { if self.stroke.cap_start.is_arrow() || self.stroke.cap_end.is_arrow() || point_arrows { w.max(self.stroke.weight) * 3.0 } else { w }; // Right-angled or smooth outlines (boxes, whole ellipses) end their mitres on the grown // box; an arc's corners don't. - let miter = if self.grows_by_exactly_its_spread() { 1.0 } else { self.stroke.miter_limit.clamp(1.0, 4.0) }; + let miter = if self.outline_mitres_end_on_its_box() { 1.0 } else { self.stroke.miter_limit.clamp(1.0, 4.0) }; base.max(if matches!(self.kind, NodeKind::Line | NodeKind::Vector { .. }) { caps } else { 0.0 }) * miter } else { 0.0 @@ -960,9 +960,10 @@ impl Node { !(matches!(self.kind, NodeKind::Group) || (matches!(self.kind, NodeKind::Text(_)) && self.has_visible_stroke())) } - /// Whether a spread grows this node's outline by exactly the spread (no sharp corners). An arc - /// (an ellipse that doesn't go all the way round) has corners where its ends meet its sides. - fn grows_by_exactly_its_spread(&self) -> bool { + /// Whether this node's outline has no sharp corners (right-angled ones aside), so mitres along + /// it end on its box grown by as much: a box or a whole ellipse. An arc (an ellipse that doesn't + /// go all the way round) has corners where its ends meet its sides. + fn outline_mitres_end_on_its_box(&self) -> bool { match self.kind { NodeKind::Rectangle | NodeKind::Section { .. } => true, NodeKind::Ellipse { sweep, .. } => figcraft_geom::full_sweep(sweep), @@ -970,9 +971,20 @@ impl Node { } } + /// Whether a spread grows this node by exactly the spread: its outline mitres end on its box + /// (see [`Node::outline_mitres_end_on_its_box`]), and so does its stroke. A dashed stroke is + /// cut into dashes with corners wherever they fall round the outline, and a width profile or a + /// brush can give the stroke corners of its own, which the spread mitres out. + fn grows_by_exactly_its_spread(&self) -> bool { + let s = &self.stroke; + let cornered = self.has_visible_stroke() && (!s.dashes.is_empty() || s.profile().is_some() || s.brush.is_some()); + !cornered && self.outline_mitres_end_on_its_box() + } + /// How much further than its spread a drop shadow can reach at the outline's sharp corners: /// spread moves the edges out in parallel and they meet in a mitre (see - /// [`SPREAD_MITER_LIMIT`]). Rectangles, frames and whole ellipses grow by exactly the spread. + /// [`SPREAD_MITER_LIMIT`]). Rectangles, frames and whole ellipses grow by exactly the spread, + /// unless their stroke has corners (see [`Node::grows_by_exactly_its_spread`]). fn spread_miter_reach(&self) -> f64 { if self.grows_by_exactly_its_spread() { return 0.0; diff --git a/crates/render/src/spread_tests.rs b/crates/render/src/spread_tests.rs index 6b30766fc..ec41dd8dd 100644 --- a/crates/render/src/spread_tests.rs +++ b/crates/render/src/spread_tests.rs @@ -192,3 +192,58 @@ fn arc_stroke_mitres_are_not_cut_off() { assert!(worst <= 2, "{align:?}: {worst} levels cut off"); } } + +/// A dashed stroke is cut into separate dashes with square ends, a width profile can step its +/// width and a brush lays down shapes of its own: round a whole ellipse or a rounded box, a spread +/// mitres out at their corners, past the box grown by the spread, and keeps its whole shadow. +#[test] +fn stroke_corners_spread_mitres_are_not_cut_off() { + use figcraft_doc::{Brush, Node, StrokeAlign, StrokeCap, WidthProfile}; + type Style = fn(&mut Node); + let strokes: [(&str, Style); 4] = [ + ("dashed", |n| n.stroke.dashes = vec![30.0, 30.0]), + ("dashed with square caps", |n| (n.stroke.dashes, n.stroke.dash_cap) = (vec![30.0, 30.0], Some(StrokeCap::Square))), + ("stepped", |n| n.stroke.width_profile = Some(WidthProfile::new([(0.0, 1.0), (0.25, 4.0), (0.26, 0.2), (0.75, 4.0)]))), + ("starry", |n| n.stroke.brush = Some(Brush::new("stars"))), + ]; + let shapes = [(NodeKind::Ellipse { start: 0.0, sweep: std::f64::consts::TAU, inner: 0.0 }, 0.0), (NodeKind::Rectangle, 100.0)]; + for (kind, radius) in shapes { + for (name, style) in strokes { + for align in [StrokeAlign::Outside, StrokeAlign::Center] { + let make = |effects: Vec| { + let (mut d, n) = shape(kind.clone(), effects); + let node = d.get_mut(n).unwrap(); + node.corners.radii = [radius; 4]; + node.strokes = vec![Paint::solid(Color::WHITE)]; + (node.stroke.weight, node.stroke.align) = (20.0, align); + style(node); + (d, n) + }; + let (d, n) = make(vec![EffectKind::DropShadow(shadow(30.0))]); + let clear = Shadow { color: Color::new(0.0, 0.0, 0.0, 0.0), ..shadow(120.0) }; + let (roomy, m) = make(vec![EffectKind::DropShadow(shadow(30.0)), EffectKind::DropShadow(clear)]); + let (a, b) = (render(&d, n), render(&roomy, m)); + let worst = a.data().chunks(4).zip(b.data().chunks(4)).map(|(p, q)| p[3].abs_diff(q[3])).max().unwrap_or(0); + // The stroke lands a little differently on a layer of another size, even when + // both have room to spare: up to 16 levels at a pixel or two. Cut off is 255. + assert!(worst <= 16, "{kind:?} radius {radius}, {name} {align:?}: {worst} levels cut off"); + } + } + } +} + +/// Without a spread, a dashed stroke reaches no further than a solid one: the bounds an export +/// goes by stay the box grown by the stroke. +#[test] +fn a_dashed_stroke_without_a_spread_keeps_its_bounds() { + use figcraft_doc::StrokeAlign; + for kind in [NodeKind::Rectangle, NodeKind::Ellipse { start: 0.0, sweep: std::f64::consts::TAU, inner: 0.0 }] { + let (mut d, n) = shape(kind.clone(), vec![]); + let node = d.get_mut(n).unwrap(); + node.strokes = vec![Paint::solid(Color::WHITE)]; + (node.stroke.weight, node.stroke.align) = (20.0, StrokeAlign::Outside); + node.stroke.dashes = vec![30.0, 30.0]; + let b = crate::export_bounds(&d, n).unwrap(); + assert_eq!((b.x0, b.y0, b.x1, b.y1), (80.0, 80.0, 320.0, 320.0), "{kind:?}"); + } +} From ed2747e9a4a4487c2e0202386b0e3c51c030ea31 Mon Sep 17 00:00:00 2001 From: samhyun Date: Mon, 2 Nov 2026 10:36:05 +0900 Subject: [PATCH 27/68] M8: a stroke's square dash ends and brush shapes paint within its bounds MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three ways a stroke painted past the bounds an export and a redraw go by, with no effects at all: - A dash's square end stands out along the path as far as the band does across it, so its corners reach √2 times as far from the path. Round a curve that is past the box grown by the stroke. - The ink brush's ragged edges reach 0.54 of the weight from the path, not 0.5. - A scatter brush's copies stray by the weight whatever a width profile does, but the profile's scale was applied to the stray as well, so a thinning profile left them out. `outline_reach` now counts square dash ends as √2 at least, and `Brush::reach_factor` takes the profile's scale for the shapes only and counts the shapes' reach (`Brush::SHAPE_REACH`), which a test checks every preset against. Co-Authored-By: Claude Opus 5.5 --- crates/doc/src/node.rs | 6 ++- crates/doc/src/props.rs | 15 +++++-- crates/pathops/src/brush_tests.rs | 21 +++++++--- crates/render/src/lib.rs | 2 + crates/render/src/stroke_reach_tests.rs | 54 +++++++++++++++++++++++++ 5 files changed, 88 insertions(+), 10 deletions(-) create mode 100644 crates/render/src/stroke_reach_tests.rs diff --git a/crates/doc/src/node.rs b/crates/doc/src/node.rs index e24057f7b..ce7d75ec3 100644 --- a/crates/doc/src/node.rs +++ b/crates/doc/src/node.rs @@ -945,7 +945,11 @@ impl Node { // Right-angled or smooth outlines (boxes, whole ellipses) end their mitres on the grown // box; an arc's corners don't. let miter = if self.outline_mitres_end_on_its_box() { 1.0 } else { self.stroke.miter_limit.clamp(1.0, 4.0) }; - base.max(if matches!(self.kind, NodeKind::Line | NodeKind::Vector { .. }) { caps } else { 0.0 }) * miter + // A dash's square end stands out along the path as far as the band does across it: + // its corners reach √2 times as far from the path, past the box round a curve. + let square_dashes = !self.stroke.dashes.is_empty() && self.stroke.band_caps().contains(&StrokeCap::Square); + let corners = if square_dashes { miter.max(std::f64::consts::SQRT_2) } else { miter }; + base.max(if matches!(self.kind, NodeKind::Line | NodeKind::Vector { .. }) { caps } else { 0.0 }) * corners } else { 0.0 }; diff --git a/crates/doc/src/props.rs b/crates/doc/src/props.rs index 0c78681f2..1c6cd6e3e 100644 --- a/crates/doc/src/props.rs +++ b/crates/doc/src/props.rs @@ -146,10 +146,16 @@ impl Brush { } } - /// How much wider than the stroke weight the brush can paint (larger copies, strays). - pub fn reach_factor(&self) -> f64 { + /// The farthest a built-in brush shape reaches from the path, in stroke weights: the ink + /// brush's ragged edges stand a little past half the weight. + pub const SHAPE_REACH: f64 = 0.54; + + /// How much wider than the stroke weight the brush can paint where a width profile scales it + /// at most `scale`: its shapes' edges and larger copies, which the profile scales, and strays, + /// which it doesn't. + pub fn reach_factor(&self, scale: f64) -> f64 { let b = self.sanitized(); - 1.0 + b.size_jitter + 2.0 * b.scatter + 2.0 * Self::SHAPE_REACH * (1.0 + b.size_jitter) * scale + 2.0 * b.scatter } } @@ -188,7 +194,8 @@ impl StrokeProps { /// The widest the stroke gets anywhere along the path (the weight, scaled by a width profile /// and widened by a brush's reach). pub fn max_weight(&self) -> f64 { - self.profile().map_or(self.weight, |p| self.weight * p.max_scale()) * self.brush.as_ref().map_or(1.0, Brush::reach_factor) + let scale = self.profile().map_or(1.0, WidthProfile::max_scale); + self.weight * self.brush.as_ref().map_or(scale, |b| b.reach_factor(scale)) } /// The miter limit as the angle (degrees) below which joins bevel: limit = 1 / sin(angle / 2), diff --git a/crates/pathops/src/brush_tests.rs b/crates/pathops/src/brush_tests.rs index 403935ddd..b97356362 100644 --- a/crates/pathops/src/brush_tests.rs +++ b/crates/pathops/src/brush_tests.rs @@ -21,14 +21,25 @@ fn props(weight: f64, b: &Brush) -> StrokeProps { StrokeProps { weight, align: StrokeAlign::Center, brush: Some(b.clone()), ..Default::default() } } +/// What a brush paints stays within half [`StrokeProps::max_weight`] of the path, which the +/// stroke's bounds go by: plain, with copies grown, turned and strayed all they can, and with a +/// width profile thinning or widening it (strays keep their distance, whatever the profile). #[test] fn every_preset_draws_inside_its_reach() { for p in PRESETS { - let b = brush(p.id); - let out = outline(&line(200.0), 10.0, &props(10.0, &b), &b).unwrap(); - let bb = out.bounding_box(); - assert!(!out.elements().is_empty(), "{}", p.id); - assert!(bb.y0 >= -5.5 && bb.y1 <= 5.5 && bb.x0 >= -5.5 && bb.x1 <= 205.5, "{}: {bb:?}", p.id); + let wild = Brush { size_jitter: 1.0, rotation_jitter: 1.0, scatter: 4.0, ..brush(p.id) }; + for (b, profile) in [(brush(p.id), None), (wild.clone(), None), (wild.clone(), Some(0.2)), (wild, Some(2.0))] { + let k = StrokeProps { width_profile: profile.map(|s| WidthProfile::new([(0.0, s), (1.0, s)])), ..props(10.0, &b) }; + let out = outline(&line(200.0), 10.0, &k, &b).unwrap(); + let bb = out.bounding_box(); + let reach = k.max_weight() / 2.0; + assert!(!out.elements().is_empty(), "{}", p.id); + assert!( + bb.y0 >= -reach && bb.y1 <= reach && bb.x0 >= -reach && bb.x1 <= 200.0 + reach, + "{} {b:?} {profile:?}: {bb:?}, reach {reach}", + p.id + ); + } } assert!(outline(&line(10.0), 1.0, &props(1.0, &brush("nope")), &brush("nope")).is_none()); } diff --git a/crates/render/src/lib.rs b/crates/render/src/lib.rs index f1ab0ea5f..5276d2e64 100644 --- a/crates/render/src/lib.rs +++ b/crates/render/src/lib.rs @@ -564,6 +564,8 @@ mod solo_tests; #[cfg(test)] mod spread_tests; #[cfg(test)] +mod stroke_reach_tests; +#[cfg(test)] mod tests; #[cfg(test)] mod width_tests; diff --git a/crates/render/src/stroke_reach_tests.rs b/crates/render/src/stroke_reach_tests.rs new file mode 100644 index 000000000..f447e93bd --- /dev/null +++ b/crates/render/src/stroke_reach_tests.rs @@ -0,0 +1,54 @@ +//! What a stroke paints stays within the bounds an export and a redraw go by: square dash ends +//! that stand out round a curve, brush shapes past half the weight and brush copies that stray +//! further than a width profile thins them included. + +use figcraft_color::{Color, Paint}; +use figcraft_doc::{Brush, Document, Node, NodeKind, StrokeAlign, StrokeCap, StrokeJoin, WidthProfile}; + +use super::*; + +/// How many pixels `kind` (at (200, 200), `size` square) with a 40-unit stroke styled by `style` +/// paints more than a pixel outside its export bounds, on a 600 × 600 view. +fn painted_outside(kind: &NodeKind, size: f64, align: StrokeAlign, miter_limit: f64, style: fn(&mut Node)) -> usize { + let mut d = Document::new("reach"); + let p = d.first_page().unwrap(); + let n = d.create(p, kind.clone(), "S", 200.0, 200.0, size, size).unwrap(); + let node = d.get_mut(n).unwrap(); + node.fills.clear(); + node.corners.radii = [30.0; 4]; + node.strokes = vec![Paint::solid(Color::WHITE)]; + (node.stroke.weight, node.stroke.align, node.stroke.join, node.stroke.miter_limit) = (40.0, align, StrokeJoin::Miter, miter_limit); + style(node); + let b = crate::export_bounds(&d, n).unwrap(); + let mut pix = Pixmap::new(600, 600).unwrap(); + render_nodes_into(&d, &[n], &View { origin: (0.0, 0.0), scale: 1.0, width: 600, height: 600 }, &mut pix); + let (xs, ys) = (b.x0 - 1.0..=b.x1 + 1.0, b.y0 - 1.0..=b.y1 + 1.0); + let inside = |i: usize| xs.contains(&((i % 600) as f64 + 0.5)) && ys.contains(&((i / 600) as f64 + 0.5)); + pix.data().chunks(4).enumerate().filter(|(i, p)| p[3] > 0 && !inside(*i)).count() +} + +#[test] +fn a_stroke_with_corners_paints_within_its_bounds() { + type Style = fn(&mut Node); + let strokes: [(&str, Style); 4] = [ + ("square dash ends", |n| (n.stroke.dashes, n.stroke.dash_cap) = (vec![30.0, 30.0], Some(StrokeCap::Square))), + ("short square dashes", |n| (n.stroke.dashes, n.stroke.dash_cap) = (vec![1.0, 7.0], Some(StrokeCap::Square))), + ("the ink brush", |n| n.stroke.brush = Some(Brush::new("ink"))), + ("a thinned scatter brush", |n| { + n.stroke.brush = Some(Brush { scatter: 1.0, ..Brush::new("dots") }); + n.stroke.width_profile = Some(WidthProfile::new([(0.0, 0.5), (1.0, 0.5)])); + }), + ]; + let circle = NodeKind::Ellipse { start: 0.0, sweep: std::f64::consts::TAU, inner: 0.0 }; + let shapes = [(&circle, 200.0), (&circle, 30.0), (&NodeKind::Rectangle, 200.0), (&NodeKind::Star { count: 5, inner_ratio: 0.4 }, 200.0)]; + for (kind, size) in shapes { + for (name, style) in strokes { + for align in [StrokeAlign::Center, StrokeAlign::Outside] { + for miter_limit in [4.0, 1.0] { + let outside = painted_outside(kind, size, align, miter_limit, style); + assert_eq!(outside, 0, "{kind:?} {size}, {name}, {align:?}, mitre limit {miter_limit}"); + } + } + } + } +} From 2e392e99b1d2310cb9f48a7e5a47fab098e07ffa Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Mon, 2 Nov 2026 07:55:27 -0500 Subject: [PATCH 28/68] M8: a fill per region: the Fill section and the fill commands edit the regions selected in vector edit mode (#1875) fill.set/add/remove/move/paste on the edited layer go to the selected regions' own fill stacks (or those named by regions), the layer's fills untouched; the Fill section and the colour picker list them. Test regions_tests::the_fill_commands_edit_the_selected_regions; docs. Co-Authored-By: Claude Fable 5.1 --- crates/engine/src/canvas/vectoredit.rs | 15 +++ .../src/canvas/vectoredit/regions_tests.rs | 47 ++++++++ crates/engine/src/cmd/edit.rs | 23 +++- crates/engine/src/cmd/edit/props.rs | 112 ++++++++++++++++-- crates/engine/src/cmd/lists.rs | 17 ++- crates/ui-egui/src/panels/right/paints.rs | 8 +- crates/ui-egui/src/widgets/colorpicker.rs | 7 ++ docs/mcp.md | 5 +- docs/ui-parity.md | 5 +- 9 files changed, 219 insertions(+), 20 deletions(-) diff --git a/crates/engine/src/canvas/vectoredit.rs b/crates/engine/src/canvas/vectoredit.rs index 078f0804e..5d5408d02 100644 --- a/crates/engine/src/canvas/vectoredit.rs +++ b/crates/engine/src/canvas/vectoredit.rs @@ -1245,6 +1245,21 @@ pub fn paint_all(doc: &mut Document, id: NodeId, pts: &[Point]) -> Result Ok(filled) } +/// The fills the Fill section shows for layer `id` while regions of it are selected in edit +/// mode: the stack those regions share (their own, else the layer's), `Some(None)` when they +/// differ (mixed), `None` when no region of that layer is selected (the layer's fills show). The +/// fill commands edit the same regions then ("you can adjust the fill for each region +/// individually", Edit vector layers, #1875). +pub fn selected_region_fills(s: &Session, id: NodeId) -> Option>> { + let ve = s.ds().ok()?.vector_edit.as_ref().filter(|ve| ve.id == id && !ve.regions.is_empty())?; + let doc = s.doc().ok()?; + let node = doc.node(id)?; + let net = network(doc, id)?; + let mut stacks = ve.regions.iter().filter_map(|r| net.regions.get(*r)).map(|r| r.fills.clone().unwrap_or_else(|| node.fills.clone())); + let first = stacks.next()?; + Some(stacks.all(|st| st == first).then_some(first)) +} + /// Add points `vs` of edited layer `id` to its selection. pub(crate) fn add_points(ve: &mut VectorEdit, id: NodeId, vs: &[usize]) { let list = if id == ve.id { Some(&mut ve.vertices) } else { ve.others.iter_mut().find(|o| o.id == id).map(|o| &mut o.vertices) }; diff --git a/crates/engine/src/canvas/vectoredit/regions_tests.rs b/crates/engine/src/canvas/vectoredit/regions_tests.rs index 6787a59f9..c0b762aff 100644 --- a/crates/engine/src/canvas/vectoredit/regions_tests.rs +++ b/crates/engine/src/canvas/vectoredit/regions_tests.rs @@ -6,6 +6,7 @@ use figcraft_geom::{Affine, Point, Rect, Vec2}; use serde_json::json; use super::regions::*; +use super::selected_region_fills; use super::tests::{ex, net, ve}; use crate::Session; use crate::tools::{PointerEvent, PointerKind}; @@ -540,3 +541,49 @@ fn hovered_and_selected_is_hatched_once_and_regions_share_one_pattern() { assert!(!part.is_empty() && part.len() < all.len()); assert!(part.iter().all(|x| all.iter().any(|y| (x - y).abs() < 1e-6))); } + +/// "If there are multiple closed regions within a vector network, you can adjust the fill for each +/// region individually" (Edit vector layers, #1875): with regions selected in edit mode, the fill +/// commands edit those regions' own fills and leave the layer's; `regions` names them outright. +#[test] +fn the_fill_commands_edit_the_selected_regions() { + let mut s = Session::new(); + let id = editing_vector(&mut s, overlapping()); + let fills_of = |s: &Session, r: usize| net(s, id).regions[r].fills.clone(); + let layer = |s: &Session| s.doc().unwrap().node(id).unwrap().fills.clone(); + let colour = |s: &Session, r: usize, i: usize| fills_of(s, r).unwrap()[i].solid_color().unwrap().to_css_hex().to_ascii_uppercase(); + let before = layer(&s); + ex(&mut s, "vector.edit.select", json!({"regions": [1]})); + ex(&mut s, "fill.set", json!({"ids": [id], "color": "#FF0000"})); + assert_eq!(fills_of(&s, 1).map(|f| f.len()), Some(1)); + assert_eq!(colour(&s, 1, 0), "#FF0000"); + assert_eq!(fills_of(&s, 0), None, "the other region still inherits"); + assert_eq!(layer(&s), before, "the layer's fills are untouched"); + // The section's list for the layer is the region's own stack. + assert_eq!(selected_region_fills(&s, id).and_then(|l| l).map(|l| l.len()), Some(1)); + ex(&mut s, "fill.add", json!({"ids": [id], "color": "#00FF00"})); + assert_eq!(fills_of(&s, 1).unwrap().len(), 2); + ex(&mut s, "fill.move", json!({"ids": [id], "from": 0, "to": 1})); + assert_eq!((colour(&s, 1, 0), colour(&s, 1, 1)), ("#00FF00".to_string(), "#FF0000".to_string())); + ex(&mut s, "fill.remove", json!({"ids": [id], "index": 0})); + assert_eq!(fills_of(&s, 1).unwrap().len(), 1); + assert_eq!(colour(&s, 1, 0), "#FF0000"); + assert_eq!(layer(&s), before); + // Both regions selected with different fills: the section shows mixed content. + ex(&mut s, "vector.edit.select", json!({"regions": [0, 1]})); + assert_eq!(selected_region_fills(&s, id), Some(None)); + // Named outright, with no selection; junk is refused. + ex(&mut s, "vector.edit.select", json!({})); + ex(&mut s, "fill.set", json!({"ids": [id], "regions": [0], "color": "#0000FF"})); + assert_eq!(colour(&s, 0, 0), "#0000FF"); + assert!(s.execute("fill.set", &json!({"ids": [id], "regions": [9], "color": "#0000FF"})).is_err()); + assert!(s.execute("fill.set", &json!({"ids": [id], "regions": "all", "color": "#0000FF"})).is_err()); + assert!(s.execute("fill.set", &json!({"ids": [id], "regions": [], "color": "#0000FF"})).is_err()); + // Nothing selected: the layer's fills, as before; the regions keep their own. + ex(&mut s, "fill.set", json!({"ids": [id], "color": "#123456"})); + assert_ne!(layer(&s), before); + assert_eq!(colour(&s, 1, 0), "#FF0000"); + assert_eq!(selected_region_fills(&s, id), None); + s.undo().unwrap(); + assert_eq!(layer(&s), before, "one undo step per command"); +} diff --git a/crates/engine/src/cmd/edit.rs b/crates/engine/src/cmd/edit.rs index 700fa7414..1bd9bf45e 100644 --- a/crates/engine/src/cmd/edit.rs +++ b/crates/engine/src/cmd/edit.rs @@ -15,6 +15,7 @@ use crate::{BatchStep, EngineError, Result, Session, bad, spec}; mod clipboard; mod props; +pub(crate) use props::{edit_region_fills, fill_regions}; mod select; pub use clipboard::{CLIP_CLOSE, CLIP_OPEN, copy_to_clipboard, design_clipboard_buffer, paste_into}; @@ -330,14 +331,28 @@ pub fn specs() -> Vec { s.doc_mut()?.reorder(i, idx)?; ok() }), - spec!("fill.add", "Add fill", "{ids?, paint? | color? (default #D9D9D9 or white for frames)}", true, |s, p| paint_list(s, p, true, true)), + spec!( + "fill.add", + "Add fill", + "{ids?, paint? | color? (default #D9D9D9 or white for frames), regions? (a vector's regions by index: their own fills, as the regions selected in edit mode)}", + true, + |s, p| paint_list(s, p, true, true) + ), spec!("stroke.add", "Add stroke", "{ids?, paint? | color? (default black)}", true, |s, p| paint_list(s, p, false, true)), - spec!("fill.remove", "Remove fill", "{ids?, index}", true, |s, p| paint_list(s, p, true, false)), + spec!("fill.remove", "Remove fill", "{ids?, index, regions?}", true, |s, p| paint_list(s, p, true, false)), spec!("stroke.remove", "Remove stroke", "{ids?, index}", true, |s, p| paint_list(s, p, false, false)), - spec!("fill.set", "Set fill", "{ids?, index?, paint | color, opacity?, visible?, blend?}", true, |s, p| paint_set(s, p, true)), + spec!( + "fill.set", + "Set fill", + "{ids?, index?, paint | color, opacity?, visible?, blend?, regions? (a vector's regions by index: their own fills, as the regions selected in edit mode)}", + true, + |s, p| paint_set(s, p, true) + ), spec!("stroke.set", "Set stroke", "{ids?, index?, paint | color, opacity?, visible?, blend?}", true, |s, p| paint_set(s, p, false)), spec!("fill.copy", "Copy fill", "{id?, index? (default the top fill)}", false, |s, p| paint_copy(s, p, true)), - spec!("fill.paste", "Paste fill", "{ids?, index? (replace the fill there; without: add one)}", true, |s, p| paint_paste(s, p, true)), + spec!("fill.paste", "Paste fill", "{ids?, index? (replace the fill there; without: add one), regions?}", true, |s, p| paint_paste( + s, p, true + )), spec!( "stroke.copy", "Copy stroke", diff --git a/crates/engine/src/cmd/edit/props.rs b/crates/engine/src/cmd/edit/props.rs index da19b1eec..f11c228cb 100644 --- a/crates/engine/src/cmd/edit/props.rs +++ b/crates/engine/src/cmd/edit/props.rs @@ -260,10 +260,83 @@ pub(super) fn reparent(s: &mut Session, p: &Value) -> Result { ok() } +/// The regions of a vector whose own fill stacks a fill command edits instead of the layer's: the +/// `regions` named (with one target, a vector; indices into its network's regions), else the +/// regions selected in vector edit mode when the one target is the layer being edited ("you can +/// adjust the fill for each region individually", Edit vector layers, #1875). None: the layer's. +pub(crate) fn fill_regions(s: &Session, cmd: &str, p: &Value, ids: &[NodeId]) -> Result)>> { + let doc = s.doc()?; + let region_count = |id: NodeId| match doc.node(id).map(|n| &n.kind) { + Some(NodeKind::Vector { network }) => Some(network.regions.len()), + _ => None, + }; + if let Some(list) = get(p, "regions") { + let [id] = ids else { return Err(bad(cmd, "`regions` goes with one vector layer")) }; + let Some(count) = region_count(*id) else { return Err(bad(cmd, "`regions` goes with a vector layer")) }; + let regions = list + .as_array() + .ok_or_else(|| bad(cmd, "regions: [index, ...]"))? + .iter() + .map(|v| { + v.as_u64() + .and_then(|i| usize::try_from(i).ok()) + .filter(|i| *i < count) + .ok_or_else(|| bad(cmd, format!("regions: indices below {count}"))) + }) + .collect::>>()?; + if regions.is_empty() { + return Err(bad(cmd, "regions: at least one")); + } + return Ok(Some((*id, regions))); + } + let [id] = ids else { return Ok(None) }; + let Some(ve) = s.ds()?.vector_edit.as_ref().filter(|ve| ve.id == *id && !ve.regions.is_empty()) else { return Ok(None) }; + let count = region_count(*id).unwrap_or(0); + let regions: Vec = ve.regions.iter().copied().filter(|r| *r < count).collect(); + Ok((!regions.is_empty()).then_some((*id, regions))) +} + +/// Runs `f` on the own fill stack of each of `regions` of vector `id` (a region without one +/// starts from the layer's fills, which stay as they are). +pub(crate) fn edit_region_fills( + doc: &mut figcraft_doc::Document, + id: NodeId, + regions: &[usize], + mut f: impl FnMut(&mut Vec) -> Result<()>, +) -> Result<()> { + let inherited = doc.get(id)?.fills.clone(); + let NodeKind::Vector { network } = &mut doc.get_mut(id)?.kind else { return Err(bad("fill", "not a vector layer")) }; + for &r in regions { + let Some(region) = network.regions.get_mut(r) else { continue }; + let mut list = region.fills.take().unwrap_or_else(|| inherited.clone()); + f(&mut list)?; + region.fills = Some(list); + } + Ok(()) +} + pub(super) fn paint_list(s: &mut Session, p: &Value, fills: bool, add: bool) -> Result { let cmd = if fills { "fill" } else { "stroke" }; let ids = req_targets(cmd, s, p)?; let index = if add || get(p, "index").is_none() { None } else { Some(req_index(cmd, p, "index")?) }; + if let Some((id, regions)) = fill_regions(s, cmd, p, &ids)?.filter(|_| fills) { + let paint = match get(p, "paint").or_else(|| get(p, "color")) { + Some(v) => Some(paint_of(v).ok_or_else(|| bad(cmd, "invalid paint"))?), + None => None, + }; + edit_region_fills(s.doc_mut()?, id, ®ions, |list| { + if add { + list.push(paint.clone().unwrap_or_else(|| figcraft_color::Paint::solid(figcraft_color::Color::DEFAULT_SHAPE))); + } else { + let idx = index.unwrap_or(list.len().saturating_sub(1)); + if idx < list.len() { + let _ = list.remove(idx); + } + } + Ok(()) + })?; + return ok(); + } let doc = s.doc_mut()?; for i in ids { let n = doc.get_mut(i)?; @@ -295,16 +368,8 @@ pub(super) fn paint_set(s: &mut Session, p: &Value, fills: bool) -> Result None, }; let col = color(p, "color"); - let doc = s.doc_mut()?; - for i in ids { - let n = doc.get_mut(i)?; - let list = if fills { &mut n.fills } else { &mut n.strokes }; - let at = idx.unwrap_or(list.len().saturating_sub(1)); - if list.is_empty() { - list.push(figcraft_color::Paint::solid(if fills { figcraft_color::Color::DEFAULT_SHAPE } else { figcraft_color::Color::BLACK })); - } - let Some(slot) = list.get_mut(at) else { return Err(bad(cmd, format!("no paint at index {at}"))) }; - let old = slot.clone(); + // The edit of one paint slot, the same for a layer's list and a region's. + let edit_slot = |slot: &mut figcraft_color::Paint| { if let Some(np) = &new_paint { *slot = np.clone(); } @@ -325,6 +390,30 @@ pub(super) fn paint_set(s: &mut Session, p: &Value, fills: bool) -> Result Result { q["index"] = json!(at); diff --git a/crates/engine/src/cmd/lists.rs b/crates/engine/src/cmd/lists.rs index e53291b6d..19be64606 100644 --- a/crates/engine/src/cmd/lists.rs +++ b/crates/engine/src/cmd/lists.rs @@ -15,7 +15,7 @@ use crate::{Result, Session, spec}; pub fn specs() -> Vec { vec![ - spec!("fill.move", "Move fill", "{ids?, from, to} (indices in the fill list, bottom first)", true, |s, p| { + spec!("fill.move", "Move fill", "{ids?, from, to, regions?} (indices in the fill list, bottom first)", true, |s, p| { move_item(s, p, "fill.move", BoundList::Fills) }), spec!("stroke.move", "Move stroke", "{ids?, from, to} (indices in the stroke list, bottom first)", true, |s, p| { @@ -249,7 +249,20 @@ fn reorder(v: &mut Vec, from: usize, to: usize) -> bool { fn move_item(s: &mut Session, p: &Value, cmd: &str, list: BoundList) -> Result { let from = req_index(cmd, p, "from")?; let to = req_index(cmd, p, "to")?; - for id in req_targets(cmd, s, p)? { + let ids = req_targets(cmd, s, p)?; + // Fills of the regions selected (or named) in a vector: their own stacks move (#1875). + if matches!(list, BoundList::Fills) + && let Some((id, regions)) = crate::cmd::edit::fill_regions(s, cmd, p, &ids)? + { + crate::cmd::edit::edit_region_fills(s.doc_mut()?, id, ®ions, |fills| { + if from < fills.len() && to < fills.len() { + reorder(fills, from, to); + } + Ok(()) + })?; + return ok(); + } + for id in ids { let len = s.doc()?.node(id).map(|n| list.len(n)).unwrap_or(0); if from >= len || to >= len || from == to { continue; diff --git a/crates/ui-egui/src/panels/right/paints.rs b/crates/ui-egui/src/panels/right/paints.rs index 58423d252..377597841 100644 --- a/crates/ui-egui/src/panels/right/paints.rs +++ b/crates/ui-egui/src/panels/right/paints.rs @@ -293,7 +293,13 @@ pub(super) fn paints(app: &mut FigApp, ui: &mut Ui, doc: &Document, sel: &[NodeI } let t = Tokens::get(ui.ctx()); let ids = sel.to_vec(); - let list = common(doc, sel, |n| if fills { n.fills.clone() } else { n.strokes.clone() }); + // Regions selected in vector edit mode: their own fills ("you can adjust the fill for each + // region individually", Edit vector layers, #1875); the fill commands edit those too. + let region_list = match sel { + [id] if fills => figcraft_engine::vectoredit::selected_region_fills(&app.session, *id), + _ => None, + }; + let list = region_list.unwrap_or_else(|| common(doc, sel, |n| if fills { n.fills.clone() } else { n.strokes.clone() })); let title = if fills { tr("Fill") } else { tr("Stroke") }; let empty = list.as_ref().is_none_or(|l| l.is_empty()); let slot = if fills { StyleSlot::Fill } else { StyleSlot::Stroke }; diff --git a/crates/ui-egui/src/widgets/colorpicker.rs b/crates/ui-egui/src/widgets/colorpicker.rs index 5fbcc7b40..d8a5357f6 100644 --- a/crates/ui-egui/src/widgets/colorpicker.rs +++ b/crates/ui-egui/src/widgets/colorpicker.rs @@ -92,6 +92,13 @@ fn current_paint(app: &FigApp, target: &PickerTarget) -> Option { }, PickerTarget::Paint { fills, index, ids } => { let n = doc.node(*ids.first()?)?; + // Regions selected in vector edit mode: the picker edits their own fills (#1875). + if *fills + && ids.len() == 1 + && let Some(Some(list)) = figcraft_engine::vectoredit::selected_region_fills(&app.session, n.id) + { + return list.get(*index).cloned(); + } let list = if *fills { &n.fills } else { &n.strokes }; list.get(*index).cloned() } diff --git a/docs/mcp.md b/docs/mcp.md index b5e49e749..72815b351 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -723,7 +723,10 @@ made active), add?}`, `vector.edit.selectAll` (every edited layer's points), `ve `vector.edit.addVertex`, `vector.edit.connect {a, b}`, `vector.edit.pen {x, y, dx?, dy?}` (continues from the pen's open end; clicking a point connects or branches), `vector.edit.penEnd`, `vector.edit.paint {x, y} | {points}` (paint bucket: fills or unfills the closed area under a page -point; with `points`, the areas under the rest go the way the first went, like a drag), +point; with `points`, the areas under the rest go the way the first went, like a drag), `fill.set`, +`fill.add`, `fill.remove`, `fill.move` and `fill.paste` on the edited layer while regions are +selected (`vector.edit.select {regions}`), which edit those regions' own fills and leave the +layer's (`regions: [index, ...]` names them on any vector layer), `vector.edit.cut {segment, t} | {vertex} | {from: [x, y], to: [x, y]}` (the last cuts every path the page line crosses; parts that come apart move to layers of their own above, listed in `layers`), `vector.edit.erase {points, radius?}` (the eraser), diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 1d3c01373..fa242b184 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -1,6 +1,6 @@ # UI and interaction parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-02 · **Change:** patch (Backspace or Delete at the start of a list item keeps the item's indentation level, as the lists article says; max lines on auto-width text keep it auto width, hugging that many lines, as the text properties article says; superscript and subscript are synthesised where the font has no glyphs for them, from the standard glyphs shrunk and shifted by the font's OS/2 metrics, and a run mixing available and unavailable glyphs is synthesised whole, as Explore text properties says (#1828); Alt+Enter while editing text opens the link at the caret, as the accessibility page documents; Minimize, by its shortcut or the button by the file name, collapses the navigation bar and both sidebars as the help center says, with the right sidebar back while something is selected (#1835); the interface size keys of the help center's accessibility page: Cmd/Ctrl+Shift+Alt with =, - and 0 step the interface through the Preferences sizes and back to the system's size; Cmd/Ctrl+Alt+arrows rotate the selection a degree at a time, 15 with Shift, as the help center's accessibility page says; they resized before; the Layers panel answers Ctrl+1 as well as Alt+1 on Windows and Linux, the two keys the help center gives it; the colour picker's Image tab shows a placeholder and Upload from computer, an asset preview, and a file dropped on it replaces the image, keeping the fill mode, crop and position (#1682); the keyboard's Menu key opens the context menu, as Shift+F10 does; the eyedropper with Cmd/Ctrl+Shift makes a colour style or variable of what it picks; sidebar number and text fields keep their text vertically centered when focused, including typography spacing; with the pen out, Enter or a double-click ends the path and edits the vector with the Move tool instead of drawing on (#1430); the Actions palette offers only commands that run from it, and no second row reading like a menu item: Place image opens the file dialog (#1574); Preferences ▸ Scroll wheel zoom: a mouse wheel zooms the canvas about the pointer and Cmd/Ctrl+wheel scrolls (#1390); boolean operations refuse input past their caps, and a boolean group past them draws without its result (#1104); the selection and hover outlines of rounded rectangles and frames follow their corners (#1506); colour picker review fixes for text undo, fitted sidebars, moving controls and gradient variables; Corner smoothing: an original icon and the shared number-field drag gesture, preserving fractional baselines; guides snap to layers when dragged; Crop image: Object ▸ Crop image, the right-click menu and the image fill row enter crop mode (`image.crop`, #1464); the Design panel's sections on one grid — 16 / 8 margins, 88 + 8 + 88 + 8 + 24 columns, 24 pt rows, 4 pt between a row's buttons (#858); the toolbar on one 32 pt grid, without its Resources button (#1210); colour picker LCH and OKLCH models; an XML (Android Vector Drawable) export format; Context menus: the Menu key reaches egui 0.37 but is unbound (row done → partial); the Text on a path tool; board tool keys pinned; community fixes: the text box by dragging, the font picker keys, the pen path on leaving Design, a still canvas in vector edit mode, a scrolling pages list, colour emoji, readable new text in frames, system theme on first run; the Small caps sample in Type settings drawn from capitals; recent files as cards; vector edit mode: hovering, hatching, selecting and dragging filled regions; home screen: Templates tab, first-run templates and Getting started tips; number fields: scrub rates, arrow steps, arithmetic with brackets, relative edits of mixed values; outline mode's hidden layers and object bounds; Hide when publishing; cursors per tool and modifier; panel widths; dark pages for files made in the dark theme; drag threshold and double-clicks into text in groups; rotation origin on Alt+R and placing with Enter: no documented shortcut missing; keyboard shortcut parity suite and bindings; cursor chat and spotlight in live sessions; layers and assets panels behaviour suite and fixes; vector multi-edit and the vector edit tail; canvas navigation, guides and grids behaviour suite and fixes; shapes and vector behaviour suite and fixes; paint and effects behaviour suite and fixes; frames, groups, sections and masks behaviour suite and fixes; layers panel keyboard: F2 rename, Shift+F10 context menu, F8 box selection; selection and transform behaviour suite and fixes; Display P3: gamut warning and soft-proof (true P3 blocked upstream); several windows; boolean hit testing on the result, group drags, frame outlines and slices; outlines for the selection, mask outlines; arc fields, live boolean editing, shape builder on strokes, one-sided widths; fields select their text on focus; Typography spacing icons support scrubbing (#373); CSS colour names in hex fields; a rename selects the whole name, so typing replaces it; Escape or Enter after a pen path stays on the same vector (#760); IME composition kept on through idle frames of a text edit, candidates at the caret (#747); Selection colors for mixed selections and smart-selection spacing (#753); submenus with a hover delay and a safe triangle; the Actions palette's tabs, ranked search, highlight and recents; menu items that ask for a value; editor fixes from the community batches) · **Target:** Figma Design UI3 (desktop app 126.10.7) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-02 · **Change:** minor (a fill per region of a vector: with regions selected in edit mode, the Fill section and the fill commands edit those regions' own fills, as Edit vector layers says (#1875); Backspace or Delete at the start of a list item keeps the item's indentation level, as the lists article says; max lines on auto-width text keep it auto width, hugging that many lines, as the text properties article says; superscript and subscript are synthesised where the font has no glyphs for them, from the standard glyphs shrunk and shifted by the font's OS/2 metrics, and a run mixing available and unavailable glyphs is synthesised whole, as Explore text properties says (#1828); Alt+Enter while editing text opens the link at the caret, as the accessibility page documents; Minimize, by its shortcut or the button by the file name, collapses the navigation bar and both sidebars as the help center says, with the right sidebar back while something is selected (#1835); the interface size keys of the help center's accessibility page: Cmd/Ctrl+Shift+Alt with =, - and 0 step the interface through the Preferences sizes and back to the system's size; Cmd/Ctrl+Alt+arrows rotate the selection a degree at a time, 15 with Shift, as the help center's accessibility page says; they resized before; the Layers panel answers Ctrl+1 as well as Alt+1 on Windows and Linux, the two keys the help center gives it; the colour picker's Image tab shows a placeholder and Upload from computer, an asset preview, and a file dropped on it replaces the image, keeping the fill mode, crop and position (#1682); the keyboard's Menu key opens the context menu, as Shift+F10 does; the eyedropper with Cmd/Ctrl+Shift makes a colour style or variable of what it picks; sidebar number and text fields keep their text vertically centered when focused, including typography spacing; with the pen out, Enter or a double-click ends the path and edits the vector with the Move tool instead of drawing on (#1430); the Actions palette offers only commands that run from it, and no second row reading like a menu item: Place image opens the file dialog (#1574); Preferences ▸ Scroll wheel zoom: a mouse wheel zooms the canvas about the pointer and Cmd/Ctrl+wheel scrolls (#1390); boolean operations refuse input past their caps, and a boolean group past them draws without its result (#1104); the selection and hover outlines of rounded rectangles and frames follow their corners (#1506); colour picker review fixes for text undo, fitted sidebars, moving controls and gradient variables; Corner smoothing: an original icon and the shared number-field drag gesture, preserving fractional baselines; guides snap to layers when dragged; Crop image: Object ▸ Crop image, the right-click menu and the image fill row enter crop mode (`image.crop`, #1464); the Design panel's sections on one grid — 16 / 8 margins, 88 + 8 + 88 + 8 + 24 columns, 24 pt rows, 4 pt between a row's buttons (#858); the toolbar on one 32 pt grid, without its Resources button (#1210); colour picker LCH and OKLCH models; an XML (Android Vector Drawable) export format; Context menus: the Menu key reaches egui 0.37 but is unbound (row done → partial); the Text on a path tool; board tool keys pinned; community fixes: the text box by dragging, the font picker keys, the pen path on leaving Design, a still canvas in vector edit mode, a scrolling pages list, colour emoji, readable new text in frames, system theme on first run; the Small caps sample in Type settings drawn from capitals; recent files as cards; vector edit mode: hovering, hatching, selecting and dragging filled regions; home screen: Templates tab, first-run templates and Getting started tips; number fields: scrub rates, arrow steps, arithmetic with brackets, relative edits of mixed values; outline mode's hidden layers and object bounds; Hide when publishing; cursors per tool and modifier; panel widths; dark pages for files made in the dark theme; drag threshold and double-clicks into text in groups; rotation origin on Alt+R and placing with Enter: no documented shortcut missing; keyboard shortcut parity suite and bindings; cursor chat and spotlight in live sessions; layers and assets panels behaviour suite and fixes; vector multi-edit and the vector edit tail; canvas navigation, guides and grids behaviour suite and fixes; shapes and vector behaviour suite and fixes; paint and effects behaviour suite and fixes; frames, groups, sections and masks behaviour suite and fixes; layers panel keyboard: F2 rename, Shift+F10 context menu, F8 box selection; selection and transform behaviour suite and fixes; Display P3: gamut warning and soft-proof (true P3 blocked upstream); several windows; boolean hit testing on the result, group drags, frame outlines and slices; outlines for the selection, mask outlines; arc fields, live boolean editing, shape builder on strokes, one-sided widths; fields select their text on focus; Typography spacing icons support scrubbing (#373); CSS colour names in hex fields; a rename selects the whole name, so typing replaces it; Escape or Enter after a pen path stays on the same vector (#760); IME composition kept on through idle frames of a text edit, candidates at the caret (#747); Selection colors for mixed selections and smart-selection spacing (#753); submenus with a hover delay and a safe triangle; the Actions palette's tabs, ranked search, highlight and recents; menu items that ask for a value; editor fixes from the community batches) · **Target:** Figma Design UI3 (desktop app 126.10.7) Fine canvas control is what Figma users feel first: handles, snapping, nudging, modifier keys, drag behaviour, numeric precision. This checklist covers the tools, gestures and panels. Status: @@ -86,7 +86,7 @@ interaction feel not yet compared. | Rectangle, ellipse (arc handles and Design panel arc fields), polygon, star, line, arrow; Shift/Alt | done | Alt draws lines from the centre too (`shapes_behaviour_tests`) | | Corner radius handles (inside each corner of a rectangle or frame, a polygon's or star's top point; Alt: one corner), star ratio handle; Count and Ratio fields | done | handles hide under 48 px on screen; no count handle on the canvas (the Count field instead); corner smoothing rounds rectangles and frames only | | Pen: vector networks, branch, close, bend; pencil | done | pen pressure on Windows and from browser styluses only; outside edit mode the Pen closes on its first point, connects to its other points and continues a selected open path from an end point (`vector_multi_behaviour_tests`); Escape ends the path and keeps its layer in edit mode with the pen, so the next path joins the same vector and another Escape leaves edit mode (#760, `pen_end_tests`); Enter or a double-click ends the path (at the double-click's point, added once) and edits the vector with the Move tool, a double-click with the idle pen edits the layer under it, and in edit mode the pen's Enter or double-click takes the Move tool (#1430, `pen_vector_edit_tests`); switching from Design to Prototype or Inspect ends the path and returns to Move (#308) | -| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`). Not yet: areas of other layers edited at once | +| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]` (#1875). Not yet: areas of other layers edited at once | | Shape builder (Shift+M) on fills, strokes and open paths; variable width (Shift+W), one side with Alt | done | | | Boolean groups: clicked where the result is, double-click or Cmd/Ctrl-click into operands, live results while dragging or editing points, per-operand operations | done | a group past the path operations' caps (250 000 segments, 2 million possible crossings, 4 million segments swept over a fold) draws without its result, with a warning, and Flatten refuses it (#1104) | | Text: point, auto height, fixed; caret, words, lines, IME | done | Backspace or Delete at the start of a list item takes its marker and keeps its level, the paragraph starting where the item's text did ("delete the counter, but keep the same level of indentation", Create bulleted and numbered lists; `text_tail_tests::list_keys_at_list_items`, text crate `behaviour_tests`); max lines on auto-width text keep it auto width, hugging up to that many lines and growing with its longest line ("Text resizing is set to auto height or auto width", Explore text properties; `text_behaviour_tests::max_lines_on_auto_width_text_keeps_auto_width_and_hugs_that_many_lines`); Alt+Enter while editing opens the link at the caret, web and mail links only (`text.openLink`; "press ⌥Option Return/Alt Enter to activate a focused link", Accessibility at Figma; `text_link_tests`); the font picker previews a family on the canvas while hovered (no undo step; Escape restores, #653) and Up/Down step through it (#352); a selection highlight after a line break starts at that line's start and an empty last line shows its mark (#665); carets step over whole emoji and accented letters; colour emoji draw from their colour tables (#300); IME composition replayed in tests as macOS sends it, not yet checked on a Mac (#747); CJK words by script run (no dictionary); vertical trim in Type settings; no spell check | @@ -177,6 +177,7 @@ in the table. `crates/ui-egui/src/shortcut_keys_tests.rs` drives the keys a look | Date | Change | Summary | |---|---|---| +| 2026-11-02 | minor | M8, #1875: a fill per region. With regions of a vector selected in edit mode (a press inside one with the Move tool, `vector.edit.select {regions}`), the Fill section lists the regions' own fills (the layer's for a region that has none; mixed content when they differ) and its rows and the colour picker edit them: `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` on the edited layer go to the selected regions' stacks (`Region.fills`, what the renderer already draws), the layer's fills and fill style untouched; `regions: [index, ...]` names them on any vector layer ("If there are multiple closed regions within a vector network, you can adjust the fill for each region individually", Edit vector layers). Tests: `regions_tests::the_fill_commands_edit_the_selected_regions`. Numbers unchanged. | | 2026-11-02 | patch | M4: Backspace or Delete at the start of a list item takes its marker and keeps its level ("Use Backspace or Delete at the beginning of a list item to delete the counter, but keep the same level of indentation", Create bulleted and numbered lists): a plain paragraph may now carry a list level, and the text layout starts it where that level's item text starts (the gutters stay even when no list is left). Backspace used to drop the level too, and Delete at an item's start deleted the next character. Tab on such a paragraph types a tab, as outside a list. Tests: `text_tail_tests::list_keys_at_list_items`, text crate `behaviour_tests::a_plain_paragraph_at_a_list_level_starts_where_the_items_text_does` | | 2026-11-02 | patch | M4: max lines on an auto-width text keep it auto width: the box hugs up to that many lines and still grows with its longest line ("Max lines is available only if truncate text is enabled, and: Text resizing is set to auto height or auto width", Explore text properties). `text.maxLines` turned such a text into a fixed truncating box with a stale height, so later typing no longer widened it; fixed-size text still becomes a truncating box, auto-height text hugs as before. Test: `text_behaviour_tests::max_lines_on_auto_width_text_keeps_auto_width_and_hugs_that_many_lines` | | 2026-11-02 | patch | M4, #1828: superscript and subscript synthesised where the font has no `sups` / `subs` glyphs (the standard glyph shrunk and shifted by the OS/2 metrics, the usual 0.65 em and 0.35 / 0.14 em offsets without them), and a run mixing available and unavailable glyphs synthesised whole, as Explore text properties says. Tests: `text::tests::superscript_native_or_synthesised_and_never_mixed`, `text_behaviour_tests::superscript_and_subscript_are_synthesised_without_glyphs_for_them`. | From d2e7c49e57271daab2d8e7b002ce45ad352531cf Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Mon, 2 Nov 2026 09:14:55 -0500 Subject: [PATCH 29/68] Region fills: each region once, no override for a no-op, Copy fill reads the region, layer-only controls off region rows Named regions are deduplicated; an inheriting region stays inheriting when an edit leaves its stack as it was, and its own stack is only replaced once the edit succeeds; fill.copy reads the selected regions' paint; the Fill section leaves the fill style, a variable bound to the layer's fill and the image crop off region rows. Tests in regions_tests and region_fill_rows_tests. Co-Authored-By: Claude Opus 5.5 --- .../src/canvas/vectoredit/regions_tests.rs | 24 +++++ crates/engine/src/cmd/edit/props.rs | 29 ++++-- crates/ui-egui/src/lib.rs | 2 + crates/ui-egui/src/panels/right/paints.rs | 28 +++--- crates/ui-egui/src/region_fill_rows_tests.rs | 99 +++++++++++++++++++ docs/mcp.md | 3 +- docs/ui-parity.md | 2 +- 7 files changed, 167 insertions(+), 20 deletions(-) create mode 100644 crates/ui-egui/src/region_fill_rows_tests.rs diff --git a/crates/engine/src/canvas/vectoredit/regions_tests.rs b/crates/engine/src/canvas/vectoredit/regions_tests.rs index c0b762aff..cc40ef6f0 100644 --- a/crates/engine/src/canvas/vectoredit/regions_tests.rs +++ b/crates/engine/src/canvas/vectoredit/regions_tests.rs @@ -587,3 +587,27 @@ fn the_fill_commands_edit_the_selected_regions() { s.undo().unwrap(); assert_eq!(layer(&s), before, "one undo step per command"); } + +/// Region fill edits from review: a region named twice is edited once; an edit that changes +/// nothing leaves an inheriting region inheriting; Copy fill reads the selected region's fill. +#[test] +fn region_fill_edits_apply_once_skip_no_ops_and_copy_the_region() { + let mut s = Session::new(); + let id = editing_vector(&mut s, overlapping()); + let fills_of = |s: &Session, r: usize| net(s, id).regions[r].fills.clone(); + ex(&mut s, "vector.edit.select", json!({"regions": [1]})); + ex(&mut s, "fill.move", json!({"ids": [id], "from": 0, "to": 0})); + assert_eq!(fills_of(&s, 1), None, "moving a paint onto itself leaves the region inheriting"); + ex(&mut s, "fill.remove", json!({"ids": [id], "index": 5})); + assert_eq!(fills_of(&s, 1), None, "removing a paint that isn't there leaves it inheriting"); + ex(&mut s, "fill.add", json!({"ids": [id], "regions": [0, 0], "color": "#00FF00"})); + assert_eq!(fills_of(&s, 0).map(|f| f.len()), Some(2), "the layer's fill and one added, once"); + // Copy fill takes the selected region's own paint, not the layer's. + ex(&mut s, "fill.set", json!({"ids": [id], "color": "#FF0000"})); + ex(&mut s, "fill.copy", json!({"ids": [id], "index": 0})); + let copied = s.clipboard.paint.clone().map(|(_, p)| p.solid_color().unwrap().to_css_hex().to_ascii_uppercase()); + assert_eq!(copied.as_deref(), Some("#FF0000")); + // Regions whose fills differ have no one paint to copy. + ex(&mut s, "vector.edit.select", json!({"regions": [0, 1]})); + assert!(s.execute("fill.copy", &json!({"ids": [id], "index": 0})).is_err()); +} diff --git a/crates/engine/src/cmd/edit/props.rs b/crates/engine/src/cmd/edit/props.rs index f11c228cb..04315bbed 100644 --- a/crates/engine/src/cmd/edit/props.rs +++ b/crates/engine/src/cmd/edit/props.rs @@ -273,7 +273,7 @@ pub(crate) fn fill_regions(s: &Session, cmd: &str, p: &Value, ids: &[NodeId]) -> if let Some(list) = get(p, "regions") { let [id] = ids else { return Err(bad(cmd, "`regions` goes with one vector layer")) }; let Some(count) = region_count(*id) else { return Err(bad(cmd, "`regions` goes with a vector layer")) }; - let regions = list + let mut regions = list .as_array() .ok_or_else(|| bad(cmd, "regions: [index, ...]"))? .iter() @@ -284,6 +284,9 @@ pub(crate) fn fill_regions(s: &Session, cmd: &str, p: &Value, ids: &[NodeId]) -> .ok_or_else(|| bad(cmd, format!("regions: indices below {count}"))) }) .collect::>>()?; + // A region named twice is edited once. + regions.sort_unstable(); + regions.dedup(); if regions.is_empty() { return Err(bad(cmd, "regions: at least one")); } @@ -292,12 +295,16 @@ pub(crate) fn fill_regions(s: &Session, cmd: &str, p: &Value, ids: &[NodeId]) -> let [id] = ids else { return Ok(None) }; let Some(ve) = s.ds()?.vector_edit.as_ref().filter(|ve| ve.id == *id && !ve.regions.is_empty()) else { return Ok(None) }; let count = region_count(*id).unwrap_or(0); - let regions: Vec = ve.regions.iter().copied().filter(|r| *r < count).collect(); + let mut regions: Vec = ve.regions.iter().copied().filter(|r| *r < count).collect(); + regions.sort_unstable(); + regions.dedup(); Ok((!regions.is_empty()).then_some((*id, regions))) } /// Runs `f` on the own fill stack of each of `regions` of vector `id` (a region without one -/// starts from the layer's fills, which stay as they are). +/// starts from the layer's fills, which stay as they are). A region that inherits the layer's +/// fills keeps inheriting when `f` leaves the stack as it was, so later edits of the layer's +/// fills still reach it; a region's own stack is only replaced once `f` succeeds. pub(crate) fn edit_region_fills( doc: &mut figcraft_doc::Document, id: NodeId, @@ -308,9 +315,11 @@ pub(crate) fn edit_region_fills( let NodeKind::Vector { network } = &mut doc.get_mut(id)?.kind else { return Err(bad("fill", "not a vector layer")) }; for &r in regions { let Some(region) = network.regions.get_mut(r) else { continue }; - let mut list = region.fills.take().unwrap_or_else(|| inherited.clone()); + let mut list = region.fills.clone().unwrap_or_else(|| inherited.clone()); f(&mut list)?; - region.fills = Some(list); + if region.fills.is_some() || list != inherited { + region.fills = Some(list); + } } Ok(()) } @@ -433,7 +442,15 @@ pub(super) fn paint_copy(s: &mut Session, p: &Value, fills: bool) -> Result list, + Some(None) => return Err(bad(cmd, "the selected regions' fills differ")), + None if fills => &n.fills, + None => &n.strokes, + }; let at = at.unwrap_or(list.len().saturating_sub(1)); let paint = list.get(at).cloned().ok_or_else(|| bad(cmd, format!("no {} at index {at}", if fills { "fill" } else { "stroke" })))?; (paint, (!fills).then(|| n.stroke.clone())) diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index e9969c106..d787fb1ca 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -221,6 +221,8 @@ mod proto_reorder_tests; #[cfg(test)] mod proto_responsive_tests; #[cfg(test)] +mod region_fill_rows_tests; +#[cfg(test)] mod resources_tests; #[cfg(test)] mod sampled_color_tests; diff --git a/crates/ui-egui/src/panels/right/paints.rs b/crates/ui-egui/src/panels/right/paints.rs index 377597841..675becc6d 100644 --- a/crates/ui-egui/src/panels/right/paints.rs +++ b/crates/ui-egui/src/panels/right/paints.rs @@ -299,20 +299,20 @@ pub(super) fn paints(app: &mut FigApp, ui: &mut Ui, doc: &Document, sel: &[NodeI [id] if fills => figcraft_engine::vectoredit::selected_region_fills(&app.session, *id), _ => None, }; + // The fill style, a variable bound to the layer's fill and the image crop are the layer's: + // they stay off a region's rows. + let region = region_list.is_some(); let list = region_list.unwrap_or_else(|| common(doc, sel, |n| if fills { n.fills.clone() } else { n.strokes.clone() })); let title = if fills { tr("Fill") } else { tr("Stroke") }; let empty = list.as_ref().is_none_or(|l| l.is_empty()); let slot = if fills { StyleSlot::Fill } else { StyleSlot::Stroke }; // The section's right-click menu adds the copied paint (`fill.paste` / `stroke.paste`). let paste = if fills { tr("Paste fill") } else { tr("Paste stroke") }; - let (clicked, header) = widgets::section_header_resp( - ui, - title, - &[(Icon::Styles, tr("Styles")), (Icon::Plus, if fills { tr("Add fill") } else { tr("Add stroke") })], - empty, - ); + let add = (Icon::Plus, if fills { tr("Add fill") } else { tr("Add stroke") }); + let buttons = if region { vec![add] } else { vec![(Icon::Styles, tr("Styles")), add] }; + let (clicked, header) = widgets::section_header_resp(ui, title, &buttons, empty); if let Some(i) = clicked { - if i == 1 { + if buttons.get(i).is_some_and(|(icon, _)| *icon == Icon::Plus) { // The new paint goes on top; open its picker. A mixed selection has no one index to edit. if app.run(if fills { "fill.add" } else { "stroke.add" }, json!({"ids": ids})).is_some() && let Some(l) = &list @@ -329,14 +329,16 @@ pub(super) fn paints(app: &mut FigApp, ui: &mut Ui, doc: &Document, sel: &[NodeI ui.close(); } }); - style_picker::chip(app, ui, doc, &ids, slot); + if !region { + style_picker::chip(app, ui, doc, &ids, slot); + } match &list { None => widgets::note(ui, tr("Click + to replace mixed content"), t.text_secondary), Some(l) => { // The last paint is on top: shown first. Rows drag to reorder. let mut drag = ListDrag::new(ui, if fills { "fills" } else { "strokes" }); for (i, p) in l.iter().enumerate().rev() { - let r = paint_row(app, ui, &ids, i, p, fills); + let r = paint_row(app, ui, &ids, i, p, fills, region); drag.row(ui, i, r, r, || paint_label(p)); } if let Some((from, to)) = drag.finish(ui) { @@ -446,7 +448,9 @@ pub(super) fn paints(app: &mut FigApp, ui: &mut Ui, doc: &Document, sel: &[NodeI } /// Paint `i`'s row (swatch, colour or kind, opacity, visibility, remove); returns its area. -fn paint_row(app: &mut FigApp, ui: &mut Ui, ids: &[NodeId], i: usize, p: &Paint, fills: bool) -> Rect { +/// One paint's row; `region`: a row of the regions selected in vector edit mode (#1875), which +/// leaves out what belongs to the layer (its variable binding, the image crop). +fn paint_row(app: &mut FigApp, ui: &mut Ui, ids: &[NodeId], i: usize, p: &Paint, fills: bool, region: bool) -> Rect { let t = Tokens::get(ui.ctx()); let ids = ids.to_vec(); let cmd = if fills { "fill.set" } else { "stroke.set" }; @@ -461,7 +465,7 @@ fn paint_row(app: &mut FigApp, ui: &mut Ui, ids: &[NodeId], i: usize, p: &Paint, let text_r = Rect::from_min_max(pos2(sw.max.x + 8.0, r.min.y), pos2(r.max.x - 52.0, r.max.y)); let mut child = ui.new_child(egui::UiBuilder::new().max_rect(text_r)); // The variable bound to this paint's colour (its key on the layers: `fill` or `fills//color`). - let bound = app.session.doc().ok().and_then(|d| { + let bound = app.session.doc().ok().filter(|_| !region).and_then(|d| { let key = ids.first().and_then(|id| d.node(*id)).and_then(|n| figcraft_engine::cmd::lists::paint_binding_key(n, fills, i))?; Some((key.to_string(), crate::variable_ui::bound_name(d, &ids, key)?)) }); @@ -502,7 +506,7 @@ fn paint_row(app: &mut FigApp, ui: &mut Ui, ids: &[NodeId], i: usize, p: &Paint, _ => { child.painter().text(pos2(text_r.min.x, r.center().y), Align2::LEFT_CENTER, paint_label(p), regular(11.0), t.text); // One layer's image fill: crop it on the canvas. - if fills && ids.len() == 1 && matches!(p.kind, PaintKind::Image(_)) { + if fills && ids.len() == 1 && !region && matches!(p.kind, PaintKind::Image(_)) { let cr = Rect::from_center_size(pos2(text_r.max.x - 9.0, r.center().y), vec2(18.0, 18.0)); let cresp = ui.interact(cr, Id::unique(("crop_image", i)), Sense::click()).tip(tr("Crop image")); icons::paint(ui.painter(), cr.shrink(3.0), Icon::Crop, if cresp.hovered() { t.icon } else { t.icon_secondary }); diff --git a/crates/ui-egui/src/region_fill_rows_tests.rs b/crates/ui-egui/src/region_fill_rows_tests.rs new file mode 100644 index 000000000..7dc1c9a5b --- /dev/null +++ b/crates/ui-egui/src/region_fill_rows_tests.rs @@ -0,0 +1,99 @@ +//! The Fill section with a region of a vector selected in edit mode (#1875), driven through egui +//! headless: the region's own fill shows, and what belongs to the layer (its fill style, a +//! variable bound to its fill) stays off the region's rows. + +use egui::accesskit::Role; +use egui::{Pos2, pos2}; +use figcraft_doc::{NodeId, NodeKind, Region, Segment, VectorNetwork, Vertex}; +use figcraft_engine::Session; +use serde_json::json; + +use crate::layers_drag_tests::Ui; + +/// Four points and four straight segments of a square, appended to `n`. +fn square(n: &mut VectorNetwork, x0: f64, y0: f64, size: f64) { + let v0 = n.vertices.len(); + for (x, y) in [(x0, y0), (x0 + size, y0), (x0 + size, y0 + size), (x0, y0 + size)] { + n.vertices.push(Vertex::new(x, y)); + } + for k in 0..4 { + n.segments.push(Segment::line(v0 + k, v0 + (k + 1) % 4)); + } +} + +/// A vector of two squares, the outer one's region then the inner one's, its fill bound to a +/// blue colour variable; in edit mode with the inner region selected and given a red fill of its +/// own. +fn ui() -> Ui { + let mut s = Session::new(); + let r = s.execute("vector.create", &json!({"points": [[0, 0], [10, 0], [10, 10]], "closed": true})).unwrap(); + let id = NodeId(r["id"].as_u64().unwrap()); + { + let doc = s.doc_mut().unwrap(); + let node = doc.get_mut(id).unwrap(); + let mut n = VectorNetwork::default(); + square(&mut n, 0.0, 0.0, 200.0); + square(&mut n, 60.0, 60.0, 80.0); + n.regions = + vec![Region { loops: vec![vec![0, 1, 2, 3]], ..Default::default() }, Region { loops: vec![vec![4, 5, 6, 7]], ..Default::default() }]; + node.kind = NodeKind::Vector { network: n }; + node.transform = figcraft_geom::Affine::IDENTITY; + node.fills = vec![figcraft_color::Paint::solid(figcraft_color::Color::DEFAULT_SHAPE)]; + figcraft_engine::vectoredit::refit(doc, id).unwrap(); + } + s.execute("variable.createCollection", &json!({"name": "Theme"})).unwrap(); + s.execute("variable.create", &json!({"collection": "Theme", "name": "brand", "type": "color", "value": "#0000FF"})).unwrap(); + s.execute("variable.bind", &json!({"ids": [id.0], "field": "fill", "variable": "brand"})).unwrap(); + s.execute("select.set", &json!({"ids": [id.0]})).unwrap(); + s.execute("vector.edit.begin", &json!({"id": id.0})).unwrap(); + s.execute("vector.edit.select", &json!({"regions": [1]})).unwrap(); + s.execute("fill.set", &json!({"ids": [id.0], "color": "#FF0000"})).unwrap(); + let mut u = Ui::new(s); + u.ctx.enable_accesskit(); + u.frame(vec![]); + u +} + +/// The accessible controls after a frame: role, label, value and centre. +fn controls(u: &mut Ui) -> Vec<(Role, String, String, Pos2)> { + u.frame(vec![]); + let out = u.frame_output(vec![]); + let nodes = out.platform_output.accesskit_update.expect("an AccessKit update").nodes; + nodes + .iter() + .map(|(_, n)| { + let at = n.bounds().map_or(pos2(0.0, 0.0), |b| pos2(((b.x0 + b.x1) / 2.0) as f32, ((b.y0 + b.y1) / 2.0) as f32)); + (n.role(), n.label().unwrap_or_default().to_string(), n.value().unwrap_or_default().to_string(), at) + }) + .collect() +} + +fn button(c: &[(Role, String, String, Pos2)], name: &str) -> Pos2 { + c.iter().find(|(r, l, _, _)| *r == Role::Button && l == name).map(|(_, _, _, p)| *p).unwrap_or_else(|| panic!("no {name} button: {c:?}")) +} + +/// What the Fill section shows, between its + and the Stroke section's: its hex rows, whether a +/// Detach variable button is there, and whether its header has a Styles button. +fn fill_section(c: &[(Role, String, String, Pos2)]) -> (Vec, bool, bool) { + let (top, bottom) = (button(c, "Add fill"), button(c, "Add stroke")); + let inside = |p: &Pos2| p.y > top.y + 2.0 && p.y < bottom.y - 2.0; + let rows = c.iter().filter(|(r, _, _, p)| *r == Role::TextInput && inside(p)).map(|(_, _, v, _)| v.clone()).collect(); + let detach = c.iter().any(|(_, l, _, p)| l == "Detach variable" && inside(p)); + let styles = c.iter().any(|(r, l, _, p)| *r == Role::Button && l == "Styles" && (p.y - top.y).abs() < 2.0); + (rows, detach, styles) +} + +#[test] +fn a_selected_regions_rows_leave_out_the_layers_style_and_variable() { + let mut u = ui(); + let red = figcraft_color::Color::from_hex("#FF0000").unwrap().to_hex(); + let (rows, detach, styles) = fill_section(&controls(&mut u)); + assert_eq!(rows, [red], "the region's own red, as a hex field"); + assert!(!detach, "the layer's variable binding is not the region's"); + assert!(!styles, "no fill style for a region's fills"); + // No region selected: the layer's row again, with its bound variable and the Styles button. + u.app.run("vector.edit.select", json!({})); + let (rows, detach, styles) = fill_section(&controls(&mut u)); + assert!(rows.is_empty(), "the layer's paint shows as its variable, not a hex field: {rows:?}"); + assert!(detach && styles); +} diff --git a/docs/mcp.md b/docs/mcp.md index 72815b351..c014dc877 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -726,7 +726,8 @@ from the pen's open end; clicking a point connects or branches), `vector.edit.pe point; with `points`, the areas under the rest go the way the first went, like a drag), `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` on the edited layer while regions are selected (`vector.edit.select {regions}`), which edit those regions' own fills and leave the -layer's (`regions: [index, ...]` names them on any vector layer), +layer's (`regions: [index, ...]` names them on any vector layer; `fill.copy` copies the selected +regions' paint), `vector.edit.cut {segment, t} | {vertex} | {from: [x, y], to: [x, y]}` (the last cuts every path the page line crosses; parts that come apart move to layers of their own above, listed in `layers`), `vector.edit.erase {points, radius?}` (the eraser), diff --git a/docs/ui-parity.md b/docs/ui-parity.md index fa242b184..4a9168cb8 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -86,7 +86,7 @@ interaction feel not yet compared. | Rectangle, ellipse (arc handles and Design panel arc fields), polygon, star, line, arrow; Shift/Alt | done | Alt draws lines from the centre too (`shapes_behaviour_tests`) | | Corner radius handles (inside each corner of a rectangle or frame, a polygon's or star's top point; Alt: one corner), star ratio handle; Count and Ratio fields | done | handles hide under 48 px on screen; no count handle on the canvas (the Count field instead); corner smoothing rounds rectangles and frames only | | Pen: vector networks, branch, close, bend; pencil | done | pen pressure on Windows and from browser styluses only; outside edit mode the Pen closes on its first point, connects to its other points and continues a selected open path from an end point (`vector_multi_behaviour_tests`); Escape ends the path and keeps its layer in edit mode with the pen, so the next path joins the same vector and another Escape leaves edit mode (#760, `pen_end_tests`); Enter or a double-click ends the path (at the double-click's point, added once) and edits the vector with the Move tool, a double-click with the idle pen edits the layer under it, and in edit mode the pen's Enter or double-click takes the Move tool (#1430, `pen_vector_edit_tests`); switching from Design to Prototype or Inspect ends the path and returns to Move (#308) | -| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]` (#1875). Not yet: areas of other layers edited at once | +| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]`; Copy fill takes the region's paint, and what belongs to the layer (its fill style, a variable bound to its fill, the image crop) stays off a region's rows (#1875). Not yet: areas of other layers edited at once | | Shape builder (Shift+M) on fills, strokes and open paths; variable width (Shift+W), one side with Alt | done | | | Boolean groups: clicked where the result is, double-click or Cmd/Ctrl-click into operands, live results while dragging or editing points, per-operand operations | done | a group past the path operations' caps (250 000 segments, 2 million possible crossings, 4 million segments swept over a fold) draws without its result, with a warning, and Flatten refuses it (#1104) | | Text: point, auto height, fixed; caret, words, lines, IME | done | Backspace or Delete at the start of a list item takes its marker and keeps its level, the paragraph starting where the item's text did ("delete the counter, but keep the same level of indentation", Create bulleted and numbered lists; `text_tail_tests::list_keys_at_list_items`, text crate `behaviour_tests`); max lines on auto-width text keep it auto width, hugging up to that many lines and growing with its longest line ("Text resizing is set to auto height or auto width", Explore text properties; `text_behaviour_tests::max_lines_on_auto_width_text_keeps_auto_width_and_hugs_that_many_lines`); Alt+Enter while editing opens the link at the caret, web and mail links only (`text.openLink`; "press ⌥Option Return/Alt Enter to activate a focused link", Accessibility at Figma; `text_link_tests`); the font picker previews a family on the canvas while hovered (no undo step; Escape restores, #653) and Up/Down step through it (#352); a selection highlight after a line break starts at that line's start and an empty last line shows its mark (#665); carets step over whole emoji and accented letters; colour emoji draw from their colour tables (#300); IME composition replayed in tests as macOS sends it, not yet checked on a Mac (#747); CJK words by script run (no dictionary); vertical trim in Type settings; no spell check | From aa2fed07e270cb02153f052b240f06b6a46fdd74 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Mon, 2 Nov 2026 09:49:10 -0500 Subject: [PATCH 30/68] Region fills: fill.pattern stays on the layer; the canvas handles and the picker's image paths edit the region's paint fill.pattern sets the layer's fill as its spec says. The gradient and crop handles read the paint from the stack fill.set writes (the selected regions' while there are any); for a region's paint, Upload from computer and image presets write the paint like any edit, and a drop on the picker goes to the canvas (image.replace and image.adjust edit layer paints). Tests in regions_tests, canvas/handles/region_tests and colorpicker image tests. Co-Authored-By: Claude Opus 5.5 --- .../src/canvas/vectoredit/regions_tests.rs | 13 +++++++ crates/engine/src/cmd/edit/props.rs | 10 ++++-- crates/ui-egui/src/canvas/handles.rs | 24 ++++++++++--- .../src/canvas/handles/region_tests.rs | 35 +++++++++++++++++++ crates/ui-egui/src/region_fill_rows_tests.rs | 16 ++++++--- crates/ui-egui/src/widgets/colorpicker.rs | 27 +++++++++++--- .../src/widgets/colorpicker_image_tests.rs | 28 +++++++++++++++ docs/ui-parity.md | 2 +- 8 files changed, 138 insertions(+), 17 deletions(-) create mode 100644 crates/ui-egui/src/canvas/handles/region_tests.rs diff --git a/crates/engine/src/canvas/vectoredit/regions_tests.rs b/crates/engine/src/canvas/vectoredit/regions_tests.rs index cc40ef6f0..272c556fd 100644 --- a/crates/engine/src/canvas/vectoredit/regions_tests.rs +++ b/crates/engine/src/canvas/vectoredit/regions_tests.rs @@ -611,3 +611,16 @@ fn region_fill_edits_apply_once_skip_no_ops_and_copy_the_region() { ex(&mut s, "vector.edit.select", json!({"regions": [0, 1]})); assert!(s.execute("fill.copy", &json!({"ids": [id], "index": 0})).is_err()); } + +/// `fill.pattern` sets the layer's fill, as its spec says, also while regions are selected. +#[test] +fn fill_pattern_sets_the_layers_fill_with_regions_selected() { + let mut s = Session::new(); + let src = crate::params::id_of(&ex(&mut s, "shape.rectangle", json!({"x": 400, "y": 0, "width": 20, "height": 20}))["id"]).unwrap(); + let id = editing_vector(&mut s, overlapping()); + ex(&mut s, "vector.edit.select", json!({"regions": [1]})); + ex(&mut s, "fill.pattern", json!({"ids": [id], "source": src})); + assert_eq!(net(&s, id).regions[1].fills, None, "the region still inherits"); + let top = s.doc().unwrap().node(id).unwrap().fills.last().cloned().unwrap(); + assert!(matches!(top.kind, figcraft_color::PaintKind::Pattern(_)), "{top:?}"); +} diff --git a/crates/engine/src/cmd/edit/props.rs b/crates/engine/src/cmd/edit/props.rs index 04315bbed..2a719af0d 100644 --- a/crates/engine/src/cmd/edit/props.rs +++ b/crates/engine/src/cmd/edit/props.rs @@ -369,6 +369,12 @@ pub(super) fn paint_list(s: &mut Session, p: &Value, fills: bool, add: bool) -> } pub(super) fn paint_set(s: &mut Session, p: &Value, fills: bool) -> Result { + paint_set_in(s, p, fills, true) +} + +/// [`paint_set`]; `to_regions`: whether the regions selected (or named) on a vector take the +/// edit in their own fills (#1875), as for `fill.set`; `fill.pattern` always sets the layer's. +fn paint_set_in(s: &mut Session, p: &Value, fills: bool, to_regions: bool) -> Result { let cmd = if fills { "fill.set" } else { "stroke.set" }; let ids = req_targets(cmd, s, p)?; let idx = opt_index(cmd, p, "index")?; @@ -400,7 +406,7 @@ pub(super) fn paint_set(s: &mut Session, p: &Value, fills: bool) -> Result Result { q["paint"] = serde_json::to_value(figcraft_color::Paint { kind: figcraft_color::PaintKind::Pattern(pt), ..figcraft_color::Paint::pattern(src.0) }) .map_err(|e| bad(CMD, e.to_string()))?; - paint_set(s, &q, true) + paint_set_in(s, &q, true, false) } pub(super) fn effect_add(s: &mut Session, p: &Value) -> Result { diff --git a/crates/ui-egui/src/canvas/handles.rs b/crates/ui-egui/src/canvas/handles.rs index 137e2c92b..aa3033b0d 100644 --- a/crates/ui-egui/src/canvas/handles.rs +++ b/crates/ui-egui/src/canvas/handles.rs @@ -40,6 +40,17 @@ enum Drag { /// The Crop-mode image being edited: (node, fills, index, paint, image rect in the unit box). type UnitRect = (f64, f64, f64, f64); +/// The paint list a picker paint at an index belongs to on layer `n`: the selected regions' own +/// fills while regions of it are selected in vector edit mode, as the Fill section lists them and +/// `fill.set` edits them (#1875), else the layer's fills or strokes. None when those regions' +/// fills differ. +fn edited_list(app: &FigApp, n: &figcraft_doc::Node, fills: bool) -> Option> { + if fills && let Some(regions) = figcraft_engine::vectoredit::selected_region_fills(&app.session, n.id) { + return regions; + } + Some(if fills { n.fills.clone() } else { n.strokes.clone() }) +} + /// The paint open in the colour picker, else the image fill in crop mode (while its layer is the /// selection). fn crop_target(app: &FigApp) -> Option<(NodeId, bool, usize, ImagePaint, UnitRect)> { @@ -53,7 +64,7 @@ fn crop_target(app: &FigApp) -> Option<(NodeId, bool, usize, ImagePaint, UnitRec }; let doc = app.session.doc().ok()?; let n = doc.node(id)?; - let list = if fills { &n.fills } else { &n.strokes }; + let list = edited_list(app, n, fills)?; let PaintKind::Image(img) = &list.get(index)?.kind else { return None }; if img.scale_mode != ImageScaleMode::Crop { return None; @@ -193,7 +204,7 @@ fn gradient_target(app: &FigApp) -> Option<(NodeId, bool, usize, figcraft_color: return None; } let n = app.session.doc().ok()?.node(id)?; - let list = if *fills { &n.fills } else { &n.strokes }; + let list = edited_list(app, n, *fills)?; match &list.get(*index)?.kind { PaintKind::Gradient(g) => Some((id, *fills, *index, g.clone())), _ => None, @@ -233,7 +244,7 @@ fn line_param(a: Pos2, b: Pos2, p: Pos2) -> Option<(f64, f32)> { fn set_gradient(app: &mut FigApp, id: NodeId, fills: bool, index: usize, g: figcraft_color::Gradient) { let Some(n) = app.session.doc().ok().and_then(|d| d.node(id)).cloned() else { return }; - let list = if fills { &n.fills } else { &n.strokes }; + let Some(list) = edited_list(app, &n, fills) else { return }; let Some(mut paint) = list.get(index).cloned() else { return }; paint.kind = PaintKind::Gradient(g); let cmd = if fills { "fill.set" } else { "stroke.set" }; @@ -652,7 +663,7 @@ fn apply(app: &mut FigApp, drag: &Drag, pos: Pos2, shift: bool) { Drag::Gradient { id, fills, index, which } => { let Some(u) = screen_to_unit(app, *id, pos) else { return }; let Some(n) = app.session.doc().ok().and_then(|d| d.node(*id)).cloned() else { return }; - let list = if *fills { &n.fills } else { &n.strokes }; + let Some(list) = edited_list(app, &n, *fills) else { return }; let Some(mut paint) = list.get(*index).cloned() else { return }; if let PaintKind::Gradient(g) = &mut paint.kind { match which { @@ -727,7 +738,7 @@ fn apply(app: &mut FigApp, drag: &Drag, pos: Pos2, shift: bool) { (ax.min(ax + nw), ay.min(ay + nh), ax.max(ax + nw), ay.max(ay + nh)) }; let Some(n) = app.session.doc().ok().and_then(|d| d.node(*id)).cloned() else { return }; - let list = if *fills { &n.fills } else { &n.strokes }; + let Some(list) = edited_list(app, &n, *fills) else { return }; let Some(mut paint) = list.get(*index).cloned() else { return }; if let PaintKind::Image(img) = &mut paint.kind { img.crop = Some(ImagePaint::crop_from_rect(r.0, r.1, r.2, r.3)); @@ -749,3 +760,6 @@ fn apply(app: &mut FigApp, drag: &Drag, pos: Pos2, shift: bool) { } } } + +#[cfg(test)] +mod region_tests; diff --git a/crates/ui-egui/src/canvas/handles/region_tests.rs b/crates/ui-egui/src/canvas/handles/region_tests.rs new file mode 100644 index 000000000..d5033d7f7 --- /dev/null +++ b/crates/ui-egui/src/canvas/handles/region_tests.rs @@ -0,0 +1,35 @@ +//! The canvas paint handles with a region of a vector selected in edit mode (#1875): they read +//! and write the paint the colour picker shows, the region's own, not the layer's. + +use figcraft_color::{Color, Gradient, GradientKind, Paint, PaintKind}; +use serde_json::json; + +use super::{gradient_target, set_gradient}; +use crate::colorpicker::PickerTarget; +use crate::layers_drag_tests::Ui; + +#[test] +fn the_gradient_handles_edit_a_selected_regions_own_paint() { + let mut s = figcraft_engine::Session::new(); + let id = crate::region_fill_rows_tests::two_region_vector(&mut s); + s.execute("vector.edit.begin", &json!({"id": id.0})).unwrap(); + s.execute("vector.edit.select", &json!({"regions": [1]})).unwrap(); + // The region's own paint: a gradient at half opacity; the layer keeps its solid grey. + let mut paint = Paint::gradient(Gradient::default_for(GradientKind::Linear, Color::BLACK)); + paint.opacity = 0.5; + s.execute("fill.set", &json!({"ids": [id.0], "paint": paint})).unwrap(); + let mut u = Ui::new(s); + u.app.ui.picker = Some(PickerTarget::Paint { fills: true, index: 0, ids: vec![id] }); + let (at, fills, index, g) = gradient_target(&u.app).expect("the handles show the region's gradient"); + assert_eq!((at, fills, index), (id, true, 0)); + let mut moved = g.clone(); + moved.from = (0.1, 0.2); + set_gradient(&mut u.app, id, true, 0, moved); + let doc = u.app.session.doc().unwrap(); + let n = doc.node(id).unwrap(); + let figcraft_doc::NodeKind::Vector { network } = &n.kind else { panic!("not a vector") }; + let region = network.regions[1].fills.clone().unwrap(); + assert!(matches!(®ion[0].kind, PaintKind::Gradient(x) if x.from == (0.1, 0.2)), "{region:?}"); + assert_eq!(region[0].opacity, 0.5, "the region's paint keeps its own opacity"); + assert!(matches!(n.fills[0].kind, PaintKind::Solid { .. }), "the layer's fill is untouched: {:?}", n.fills); +} diff --git a/crates/ui-egui/src/region_fill_rows_tests.rs b/crates/ui-egui/src/region_fill_rows_tests.rs index 7dc1c9a5b..5d071bca3 100644 --- a/crates/ui-egui/src/region_fill_rows_tests.rs +++ b/crates/ui-egui/src/region_fill_rows_tests.rs @@ -21,11 +21,9 @@ fn square(n: &mut VectorNetwork, x0: f64, y0: f64, size: f64) { } } -/// A vector of two squares, the outer one's region then the inner one's, its fill bound to a -/// blue colour variable; in edit mode with the inner region selected and given a red fill of its -/// own. -fn ui() -> Ui { - let mut s = Session::new(); +/// A vector of two squares on the page, the outer one's region then the inner one's, both +/// inheriting the layer's default grey fill (also used by the canvas handle and picker tests). +pub(crate) fn two_region_vector(s: &mut Session) -> NodeId { let r = s.execute("vector.create", &json!({"points": [[0, 0], [10, 0], [10, 10]], "closed": true})).unwrap(); let id = NodeId(r["id"].as_u64().unwrap()); { @@ -41,6 +39,14 @@ fn ui() -> Ui { node.fills = vec![figcraft_color::Paint::solid(figcraft_color::Color::DEFAULT_SHAPE)]; figcraft_engine::vectoredit::refit(doc, id).unwrap(); } + id +} + +/// [`two_region_vector`] with its fill bound to a blue colour variable; in edit mode with the +/// inner region selected and given a red fill of its own. +fn ui() -> Ui { + let mut s = Session::new(); + let id = two_region_vector(&mut s); s.execute("variable.createCollection", &json!({"name": "Theme"})).unwrap(); s.execute("variable.create", &json!({"collection": "Theme", "name": "brand", "type": "color", "value": "#0000FF"})).unwrap(); s.execute("variable.bind", &json!({"ids": [id.0], "field": "fill", "variable": "brand"})).unwrap(); diff --git a/crates/ui-egui/src/widgets/colorpicker.rs b/crates/ui-egui/src/widgets/colorpicker.rs index d8a5357f6..60c1e0b32 100644 --- a/crates/ui-egui/src/widgets/colorpicker.rs +++ b/crates/ui-egui/src/widgets/colorpicker.rs @@ -581,6 +581,18 @@ fn set_image_pending(ctx: &egui::Context, target: Option<&PickerTarget>) { } /// `image.replace`'s parameters for layers' paint `index`. +/// Whether `target` is a paint of the regions selected in vector edit mode (#1875): the picker +/// shows the regions' own fills, which the image commands (layer paints only) don't reach, so +/// their image edits are written as paints like any other. +fn region_backed(app: &FigApp, target: &PickerTarget) -> bool { + match target { + PickerTarget::Paint { fills: true, ids, .. } => { + matches!(ids.as_slice(), [id] if figcraft_engine::vectoredit::selected_region_fills(&app.session, *id).is_some()) + } + _ => false, + } +} + fn image_params(fills: bool, index: usize, ids: &[NodeId]) -> serde_json::Value { json!({"ids": ids, "target": if fills { "fill" } else { "stroke" }, "index": index}) } @@ -591,6 +603,11 @@ fn image_params(fills: bool, index: usize, ids: &[NodeId]) -> serde_json::Value pub(crate) fn image_drop_target(app: &FigApp, ctx: &egui::Context) -> Option<(Rect, serde_json::Value)> { let target = app.ui.picker.as_ref()?; let PickerTarget::Paint { fills, index, ids } = target else { return None }; + // A region's own paint takes no drop (`image.replace` edits layer paints); the file goes to + // the canvas as it would without the picker. + if region_backed(app, target) { + return None; + } if !image_pending(ctx, target) && !matches!(current_paint(app, target)?.kind, PaintKind::Image(_)) { return None; } @@ -611,7 +628,9 @@ fn picked_bytes(file: &serde_json::Value) -> Option> { fn upload_image(app: &mut FigApp, target: &PickerTarget) { let target = target.clone(); app.pick_file(tr("Choose image"), &IMAGE_FILES, true, move |app, file| { - if let PickerTarget::Paint { fills, index, ids } = &target { + if let PickerTarget::Paint { fills, index, ids } = &target + && !region_backed(app, &target) + { let mut params = image_params(*fills, *index, ids); for key in ["path", "data"] { if let Some(v) = file.get(key) { @@ -1404,9 +1423,9 @@ fn image_presets(app: &mut FigApp, ui: &mut Ui, target: &PickerTarget, paint: &m app.run("image.deletePreset", json!({"name": name})); } Some(PresetAction::Apply(name)) => match target { - // Layer paints go through the command; other targets (a text range, a style) get the - // preset's values written like any edit. - PickerTarget::Paint { fills, index, ids } => { + // Layer paints go through the command; other targets (a text range, a style, a + // region's own paint) get the preset's values written like any edit. + PickerTarget::Paint { fills, index, ids } if !region_backed(app, target) => { app.run("image.adjust", json!({"ids": ids, "target": if *fills { "fill" } else { "stroke" }, "index": index, "preset": name})); } _ => { diff --git a/crates/ui-egui/src/widgets/colorpicker_image_tests.rs b/crates/ui-egui/src/widgets/colorpicker_image_tests.rs index 539a69fc9..5d4b229a5 100644 --- a/crates/ui-egui/src/widgets/colorpicker_image_tests.rs +++ b/crates/ui-egui/src/widgets/colorpicker_image_tests.rs @@ -284,3 +284,31 @@ fn cancelling_the_upload_changes_nothing() { } let _ = std::fs::remove_dir_all(&dir); } + +/// A region of a vector selected in edit mode (#1875): Upload from computer puts the image in the +/// region's own fill the picker shows, the layer's fills untouched; a file dropped on the picker +/// isn't taken for a region's paint (it goes to the canvas, as without the picker). +#[test] +fn upload_from_computer_on_a_regions_fill_puts_the_image_in_the_region() { + let dir = temp_dir("region"); + let mut s = Session::new(); + let id = crate::region_fill_rows_tests::two_region_vector(&mut s); + s.execute("vector.edit.begin", &json!({"id": id.0})).unwrap(); + s.execute("vector.edit.select", &json!({"regions": [1]})).unwrap(); + s.execute("fill.set", &json!({"ids": [id.0], "color": "#FF0000"})).unwrap(); + let layer_fills = s.doc().unwrap().node(id).unwrap().fills.clone(); + let mut u = Ui::new(s); + open_picker(&mut u, id, 0); + let asked = fake_picker(&mut u, Some(png(5)), false, &dir); + click_image_tab(&mut u); + assert!(super::image_drop_target(&u.app, &u.ctx).is_none(), "a drop isn't taken for a region's paint"); + click_upload(&mut u); + assert_eq!(asked.load(Ordering::SeqCst), 1); + let doc = u.app.session.doc().unwrap(); + let n = doc.node(id).unwrap(); + assert_eq!(n.fills, layer_fills, "the layer's fills are untouched"); + let figcraft_doc::NodeKind::Vector { network } = &n.kind else { panic!("not a vector") }; + let region = network.regions[1].fills.clone().unwrap(); + assert!(matches!(region.last().map(|p| &p.kind), Some(PaintKind::Image(_))), "{region:?}"); + let _ = std::fs::remove_dir_all(&dir); +} diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 4a9168cb8..b9972b7aa 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -86,7 +86,7 @@ interaction feel not yet compared. | Rectangle, ellipse (arc handles and Design panel arc fields), polygon, star, line, arrow; Shift/Alt | done | Alt draws lines from the centre too (`shapes_behaviour_tests`) | | Corner radius handles (inside each corner of a rectangle or frame, a polygon's or star's top point; Alt: one corner), star ratio handle; Count and Ratio fields | done | handles hide under 48 px on screen; no count handle on the canvas (the Count field instead); corner smoothing rounds rectangles and frames only | | Pen: vector networks, branch, close, bend; pencil | done | pen pressure on Windows and from browser styluses only; outside edit mode the Pen closes on its first point, connects to its other points and continues a selected open path from an end point (`vector_multi_behaviour_tests`); Escape ends the path and keeps its layer in edit mode with the pen, so the next path joins the same vector and another Escape leaves edit mode (#760, `pen_end_tests`); Enter or a double-click ends the path (at the double-click's point, added once) and edits the vector with the Move tool, a double-click with the idle pen edits the layer under it, and in edit mode the pen's Enter or double-click takes the Move tool (#1430, `pen_vector_edit_tests`); switching from Design to Prototype or Inspect ends the path and returns to Move (#308) | -| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]`; Copy fill takes the region's paint, and what belongs to the layer (its fill style, a variable bound to its fill, the image crop) stays off a region's rows (#1875). Not yet: areas of other layers edited at once | +| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]`; Copy fill takes the region's paint, the colour picker and its canvas gradient and crop handles edit it (an image from Upload from computer included; a file dropped on the picker goes to the canvas instead), what belongs to the layer (its fill style, a variable bound to its fill, the image crop button) stays off a region's rows, and `fill.pattern` sets the layer's fill (#1875). Not yet: areas of other layers edited at once | | Shape builder (Shift+M) on fills, strokes and open paths; variable width (Shift+W), one side with Alt | done | | | Boolean groups: clicked where the result is, double-click or Cmd/Ctrl-click into operands, live results while dragging or editing points, per-operand operations | done | a group past the path operations' caps (250 000 segments, 2 million possible crossings, 4 million segments swept over a fold) draws without its result, with a warning, and Flatten refuses it (#1104) | | Text: point, auto height, fixed; caret, words, lines, IME | done | Backspace or Delete at the start of a list item takes its marker and keeps its level, the paragraph starting where the item's text did ("delete the counter, but keep the same level of indentation", Create bulleted and numbered lists; `text_tail_tests::list_keys_at_list_items`, text crate `behaviour_tests`); max lines on auto-width text keep it auto width, hugging up to that many lines and growing with its longest line ("Text resizing is set to auto height or auto width", Explore text properties; `text_behaviour_tests::max_lines_on_auto_width_text_keeps_auto_width_and_hugs_that_many_lines`); Alt+Enter while editing opens the link at the caret, web and mail links only (`text.openLink`; "press ⌥Option Return/Alt Enter to activate a focused link", Accessibility at Figma; `text_link_tests`); the font picker previews a family on the canvas while hovered (no undo step; Escape restores, #653) and Up/Down step through it (#352); a selection highlight after a line break starts at that line's start and an empty last line shows its mark (#665); carets step over whole emoji and accented letters; colour emoji draw from their colour tables (#300); IME composition replayed in tests as macOS sends it, not yet checked on a Mac (#747); CJK words by script run (no dictionary); vertical trim in Type settings; no spell check | From 6365e4339b4d4cf5754111715e2ea4e4eee74b9d Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Mon, 2 Nov 2026 20:32:37 +0100 Subject: [PATCH 31/68] M4: Increase and decrease font weight step through the styles the family has (#1831) text.weightUp/weightDown stepped the CSS weight by 100 and stored a canonical name ("Medium", "Semi Bold", ...) whether the family had that face or not, so the first press on Arial Regular changed nothing visible and the stored style named a face no font provides. They now move to the nearest heavier or lighter style of the family with the same slant and width (Narrow stays Narrow), and stay put at either end. A family that isn't installed keeps the old 100 steps. --- crates/engine/src/cmd/text.rs | 65 ++++++++++++++++- crates/engine/src/lib.rs | 2 + crates/engine/src/text_weight_step_tests.rs | 81 +++++++++++++++++++++ 3 files changed, 145 insertions(+), 3 deletions(-) create mode 100644 crates/engine/src/text_weight_step_tests.rs diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index f72f215ee..c2b9043c3 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -122,11 +122,70 @@ fn toggle_italic(s: &mut Session, p: &Value) -> Result { }) } +/// What a style name says besides its weight and slant ("Narrow Bold Italic" → "narrow"). +fn style_rest(style: &str) -> String { + const WORDS: [&str; 25] = [ + "thin", + "hairline", + "extralight", + "ultralight", + "light", + "regular", + "normal", + "roman", + "book", + "medium", + "semibold", + "demibold", + "bold", + "extrabold", + "ultrabold", + "black", + "heavy", + "semi", + "demi", + "extra", + "ultra", + "italic", + "oblique", + "plain", + "standard", + ]; + let s = style.to_ascii_lowercase().replace('-', " "); + let words = s.split_whitespace().filter(|w| !WORDS.contains(w) && !w.chars().all(|c| c.is_ascii_digit())); + words.collect::>().join(" ") +} + +fn slanted(style: &str) -> bool { + let s = style.to_ascii_lowercase(); + s.contains("italic") || s.contains("oblique") +} + +/// The next heavier (`up`) or lighter style of `styles` (a family's) after the chars' style: the +/// nearest weight with the same slant and width, as the style menu lists them. None when the family +/// has nothing further that way. +pub(crate) fn next_style(styles: &[String], st: &TextStyle, up: bool) -> Option { + let (w, italic, rest) = (i32::from(st.weight()), st.italic(), style_rest(&st.font_style)); + styles + .iter() + .filter(|x| slanted(x) == italic && style_rest(x) == rest) + .map(|x| (i32::from(figcraft_doc::style_weight(x)) - w, x)) + .filter(|(d, _)| if up { *d > 0 } else { *d < 0 }) + .min_by_key(|(d, _)| d.abs()) + .map(|(_, x)| x.clone()) +} + fn step_weight(s: &mut Session, p: &Value, up: bool) -> Result { style(s, p, |st| { - let w = (i32::from(st.weight()) + if up { 100 } else { -100 }).clamp(100, 900) as u16; - let italic = st.italic(); - st.set_font_style(styled_name(weight_name(w), italic)); + let styles = figcraft_text::family_styles(&st.font_family); + if styles.is_empty() { + // A family that isn't installed: step the weight by 100 under its canonical name. + let w = (i32::from(st.weight()) + if up { 100 } else { -100 }).clamp(100, 900) as u16; + let italic = st.italic(); + st.set_font_style(styled_name(weight_name(w), italic)); + } else if let Some(next) = next_style(&styles, st, up) { + st.set_font_style(next); + } }) } diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index e919444e2..621fdd8cb 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -575,6 +575,8 @@ mod text_style_picker_tests; #[cfg(test)] mod text_tail_tests; #[cfg(test)] +mod text_weight_step_tests; +#[cfg(test)] mod textfit_tests; #[cfg(test)] mod theme_pages_tests; diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs new file mode 100644 index 000000000..f3f7fa587 --- /dev/null +++ b/crates/engine/src/text_weight_step_tests.rs @@ -0,0 +1,81 @@ +//! Increase and decrease font weight step through the styles the family has, by weight with the +//! same slant and width (#1831), not by 100 to a canonical name no face provides. + +use figcraft_doc::{NodeId, TextStyle}; +use serde_json::json; + +use crate::Session; +use crate::cmd::text::next_style; + +fn styles(names: &[&str]) -> Vec { + names.iter().map(|s| (*s).to_string()).collect() +} + +fn at(style: &str) -> TextStyle { + let mut st = TextStyle::default(); + st.set_font_style(style); + st +} + +/// Walk `from` heavier (`up`) or lighter until the family has nothing further. +fn walk(family: &[String], from: &str, up: bool) -> Vec { + let mut st = at(from); + let mut out = Vec::new(); + while let Some(next) = next_style(family, &st, up) { + st.set_font_style(next.clone()); + out.push(next); + } + out +} + +#[test] +fn the_steps_follow_the_family_with_the_same_slant_and_width() { + let arial = styles(&["Narrow", "Regular", "Italic", "Narrow Italic", "Bold", "Narrow Bold", "Bold Italic", "Narrow Bold Italic", "Black"]); + assert_eq!(walk(&arial, "Regular", true), ["Bold", "Black"]); + assert_eq!(walk(&arial, "Black", false), ["Bold", "Regular"]); + assert_eq!(walk(&arial, "Italic", true), ["Bold Italic"]); + assert_eq!(walk(&arial, "Narrow", true), ["Narrow Bold"]); + assert_eq!(walk(&arial, "Narrow Bold Italic", false), ["Narrow Italic"]); + let segoe = styles(&["Light", "Semilight", "Regular", "Italic", "Semibold", "Bold", "Black", "Bold Italic"]); + assert_eq!(walk(&segoe, "Regular", true), ["Semibold", "Bold", "Black"]); + assert_eq!(walk(&segoe, "Regular", false), ["Light"]); + // A style the family doesn't have (as the old steps stored) moves to the next real one. + assert_eq!(next_style(&segoe, &at("Medium"), true).as_deref(), Some("Semibold")); +} + +#[test] +fn a_custom_weight_axis_value_steps_from_where_it_is() { + let family = styles(&["Light", "Regular", "Medium", "Bold"]); + let mut st = at("Regular"); + st.variations.insert("wght".into(), 550.0); + assert_eq!(next_style(&family, &st, true).as_deref(), Some("Bold")); + assert_eq!(next_style(&family, &st, false).as_deref(), Some("Medium")); +} + +fn font_style(s: &Session, t: NodeId) -> String { + s.doc().unwrap().node(t).unwrap().kind.text().unwrap().spans()[0].2.font_style.clone() +} + +#[test] +fn the_commands_land_on_styles_the_family_has() { + figcraft_text::scan_system_fonts(); + // Any installed family with a regular face and a heavier upright one (CI machines differ). + let upright = |x: &String| !x.to_lowercase().contains("italic") && !x.to_lowercase().contains("oblique"); + let pick = figcraft_text::family_names().into_iter().find_map(|f| { + let st = figcraft_text::family_styles(&f); + (st.iter().any(|x| x == "Regular") && st.iter().any(|x| upright(x) && figcraft_doc::style_weight(x) > 400)).then_some((f, st)) + }); + let Some((family, styles)) = pick else { return }; + let mut s = Session::new(); + let r = s.execute("node.create", &json!({"type": "text", "text": "Hi", "props": {"fontFamily": family, "fontStyle": "Regular"}})).unwrap(); + let t = crate::params::id_of(&r["id"]).unwrap(); + s.execute("text.weightUp", &json!({"ids": [t]})).unwrap(); + let up = font_style(&s, t); + assert!(styles.contains(&up) && figcraft_doc::style_weight(&up) > 400, "{family}: {up} of {styles:?}"); + s.execute("text.weightDown", &json!({"ids": [t]})).unwrap(); + assert_eq!(font_style(&s, t), "Regular", "{family}: {styles:?}"); + // A family that isn't installed still steps by 100 under the canonical names. + s.execute("node.set", &json!({"ids": [t], "props": {"fontFamily": "No Such Family 7f3a", "fontStyle": "Regular"}})).unwrap(); + s.execute("text.weightUp", &json!({"ids": [t]})).unwrap(); + assert_eq!(font_style(&s, t), "Medium"); +} From dc82e6cac9b3ab2055dd294fa015fb9072d8f26e Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Tue, 3 Nov 2026 00:49:00 +0100 Subject: [PATCH 32/68] M4: weight steps follow the family's order and keep widths and oblique slants (#1831) Review follow-up. The step now finds the chars' style in the family's list (the style menu's order, lightest first) and takes its neighbour, so a style whose name gives no distinct weight (Semilight) is reachable; a style the family lacks or a custom wght value still goes by weight, ties going to the nearer one in that order. "Extra", "Ultra", "Semi" and "Demi" are weight words only before a weight ("Extra Bold"), so "Extra Condensed" keeps its width; Oblique names count as slanted for the current style too; W3-style names are weights; and style_weight reads Hairline as 100, not 400. The installed-font test picks a family the step actually moves. --- crates/doc/src/tests.rs | 1 + crates/doc/src/text.rs | 3 +- crates/engine/src/cmd/text.rs | 65 ++++++++++++++++----- crates/engine/src/text_weight_step_tests.rs | 40 +++++++++++-- 4 files changed, 86 insertions(+), 23 deletions(-) diff --git a/crates/doc/src/tests.rs b/crates/doc/src/tests.rs index a0e3e17b0..0964f2e46 100644 --- a/crates/doc/src/tests.rs +++ b/crates/doc/src/tests.rs @@ -223,6 +223,7 @@ fn text_case() { assert_eq!(style_weight("Semi Bold Italic"), 600); assert_eq!(style_weight("Black"), 900); assert_eq!(style_weight("Regular"), 400); + assert_eq!(style_weight("Hairline"), 100); } #[test] diff --git a/crates/doc/src/text.rs b/crates/doc/src/text.rs index 0c41d3c9a..a0850ec83 100644 --- a/crates/doc/src/text.rs +++ b/crates/doc/src/text.rs @@ -389,8 +389,9 @@ pub fn style_weight(style: &str) -> u16 { { return n; } - let table: [(&str, u16); 10] = [ + let table: [(&str, u16); 11] = [ ("thin", 100), + ("hairline", 100), ("extralight", 200), ("ultralight", 200), ("light", 300), diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index c2b9043c3..31008533a 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -122,14 +122,23 @@ fn toggle_italic(s: &mut Session, p: &Value) -> Result { }) } -/// What a style name says besides its weight and slant ("Narrow Bold Italic" → "narrow"). +/// Hiragino's weight names: "W3" is 300. +fn w_number(word: &str) -> Option { + let n = word.strip_prefix('w')?.parse::().ok()?; + (1..=9).contains(&n).then_some(n * 100) +} + +/// What a style name says besides its weight and slant ("Narrow Bold Italic" → "narrow", +/// "Extra Condensed Bold" → "extra condensed"). fn style_rest(style: &str) -> String { - const WORDS: [&str; 25] = [ + const WEIGHTS: [&str; 25] = [ "thin", "hairline", "extralight", "ultralight", "light", + "semilight", + "demilight", "regular", "normal", "roman", @@ -141,40 +150,64 @@ fn style_rest(style: &str) -> String { "extrabold", "ultrabold", "black", + "extrablack", + "ultrablack", "heavy", - "semi", - "demi", - "extra", - "ultra", "italic", "oblique", "plain", "standard", ]; + // Words that grade the weight word after them ("Extra Bold") but a width otherwise ("Extra Condensed"). + const GRADES: [&str; 4] = ["extra", "ultra", "semi", "demi"]; let s = style.to_ascii_lowercase().replace('-', " "); - let words = s.split_whitespace().filter(|w| !WORDS.contains(w) && !w.chars().all(|c| c.is_ascii_digit())); - words.collect::>().join(" ") + let words: Vec<&str> = s.split_whitespace().collect(); + let weight = |w: &str| WEIGHTS.contains(&w) || w_number(w).is_some() || w.chars().all(|c| c.is_ascii_digit()); + let rest = words.iter().enumerate().filter(|(i, w)| { + let graded = GRADES.contains(w) && words.get(i + 1).is_some_and(|next| weight(next) && !matches!(*next, "italic" | "oblique")); + !weight(w) && !graded + }); + rest.map(|(_, w)| *w).collect::>().join(" ") } +/// A style name that slants: italic, or oblique as some families name it. fn slanted(style: &str) -> bool { let s = style.to_ascii_lowercase(); s.contains("italic") || s.contains("oblique") } -/// The next heavier (`up`) or lighter style of `styles` (a family's) after the chars' style: the -/// nearest weight with the same slant and width, as the style menu lists them. None when the family -/// has nothing further that way. +/// The weight a style name says ("W3" too). +fn name_weight(style: &str) -> u16 { + w_number(&style.to_ascii_lowercase()).unwrap_or_else(|| figcraft_doc::style_weight(style)) +} + +/// The next heavier (`up`) or lighter style of `styles` (a family's, lightest first, as the style +/// menu lists them) after the chars' style, with the same slant and width. The chars' style is +/// found in the list by name and its neighbour taken; a style the family doesn't have, or a custom +/// weight axis value, goes to the nearest weight that way. None when the family has nothing further. pub(crate) fn next_style(styles: &[String], st: &TextStyle, up: bool) -> Option { - let (w, italic, rest) = (i32::from(st.weight()), st.italic(), style_rest(&st.font_style)); - styles - .iter() - .filter(|x| slanted(x) == italic && style_rest(x) == rest) - .map(|x| (i32::from(figcraft_doc::style_weight(x)) - w, x)) + let italic = st.italic() || slanted(&st.font_style); + let rest = style_rest(&st.font_style); + let mut same: Vec<&String> = styles.iter().filter(|x| slanted(x) == italic && style_rest(x) == rest).collect(); + let norm = |s: &str| s.to_lowercase().replace([' ', '-', '_'], ""); + let here = same.iter().position(|x| norm(x) == norm(&st.font_style)); + if let Some(i) = here.filter(|_| !st.variations.contains_key("wght")) { + let next = if up { i.checked_add(1) } else { i.checked_sub(1) }; + return next.and_then(|n| same.get(n)).map(|x| (*x).clone()); + } + let w = i32::from(st.weight()); + // Of equal weights, the one nearest in the family's order: the first going up, the last going down. + if !up { + same.reverse(); + } + same.into_iter() + .map(|x| (i32::from(name_weight(x)) - w, x)) .filter(|(d, _)| if up { *d > 0 } else { *d < 0 }) .min_by_key(|(d, _)| d.abs()) .map(|(_, x)| x.clone()) } +/// `text.weightUp` / `text.weightDown`: each targeted run moves to the next style of its family. fn step_weight(s: &mut Session, p: &Value, up: bool) -> Result { style(s, p, |st| { let styles = figcraft_text::family_styles(&st.font_family); diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs index f3f7fa587..f3647d77d 100644 --- a/crates/engine/src/text_weight_step_tests.rs +++ b/crates/engine/src/text_weight_step_tests.rs @@ -38,11 +38,39 @@ fn the_steps_follow_the_family_with_the_same_slant_and_width() { assert_eq!(walk(&arial, "Narrow Bold Italic", false), ["Narrow Italic"]); let segoe = styles(&["Light", "Semilight", "Regular", "Italic", "Semibold", "Bold", "Black", "Bold Italic"]); assert_eq!(walk(&segoe, "Regular", true), ["Semibold", "Bold", "Black"]); - assert_eq!(walk(&segoe, "Regular", false), ["Light"]); + assert_eq!(walk(&segoe, "Regular", false), ["Semilight", "Light"]); // A style the family doesn't have (as the old steps stored) moves to the next real one. assert_eq!(next_style(&segoe, &at("Medium"), true).as_deref(), Some("Semibold")); } +#[test] +fn extra_and_semi_before_a_width_keep_the_width() { + let family = styles(&["Extra Condensed Regular", "Condensed Regular", "Condensed Bold", "Extra Condensed Bold", "Semi Condensed Extra Bold"]); + assert_eq!(walk(&family, "Extra Condensed Regular", true), ["Extra Condensed Bold"]); + assert_eq!(walk(&family, "Condensed Bold", false), ["Condensed Regular"]); + assert_eq!(walk(&family, "Semi Condensed Extra Bold", false), Vec::::new()); +} + +#[test] +fn oblique_names_step_to_oblique_faces() { + let dejavu = styles(&["Book", "Oblique", "Bold", "Bold Oblique"]); + assert_eq!(walk(&dejavu, "Oblique", true), ["Bold Oblique"]); + assert_eq!(walk(&dejavu, "Bold Oblique", false), ["Oblique"]); + assert_eq!(walk(&dejavu, "Book", true), ["Bold"]); +} + +#[test] +fn hairline_and_w_numbers_are_weights() { + let family = styles(&["Hairline", "Thin", "Regular", "Bold"]); + assert_eq!(walk(&family, "Regular", false), ["Thin", "Hairline"]); + // Off the list (a stored style the family lacks): by weight, the nearer of two equal ones. + assert_eq!(next_style(&family, &at("Extra Light"), false).as_deref(), Some("Thin")); + assert_eq!(next_style(&family, &at("Extra Light"), true).as_deref(), Some("Regular")); + let hiragino = styles(&["W3", "W6"]); + assert_eq!(walk(&hiragino, "W3", true), ["W6"]); + assert_eq!(next_style(&hiragino, &at("Bold"), false).as_deref(), Some("W6")); +} + #[test] fn a_custom_weight_axis_value_steps_from_where_it_is() { let family = styles(&["Light", "Regular", "Medium", "Bold"]); @@ -59,19 +87,19 @@ fn font_style(s: &Session, t: NodeId) -> String { #[test] fn the_commands_land_on_styles_the_family_has() { figcraft_text::scan_system_fonts(); - // Any installed family with a regular face and a heavier upright one (CI machines differ). - let upright = |x: &String| !x.to_lowercase().contains("italic") && !x.to_lowercase().contains("oblique"); + // Any installed family with a Regular face and a style the step takes it to (CI machines differ). let pick = figcraft_text::family_names().into_iter().find_map(|f| { let st = figcraft_text::family_styles(&f); - (st.iter().any(|x| x == "Regular") && st.iter().any(|x| upright(x) && figcraft_doc::style_weight(x) > 400)).then_some((f, st)) + let up = next_style(&st, &at("Regular"), true).filter(|_| st.iter().any(|x| x == "Regular"))?; + Some((f, st, up)) }); - let Some((family, styles)) = pick else { return }; + let Some((family, styles, heavier)) = pick else { return }; let mut s = Session::new(); let r = s.execute("node.create", &json!({"type": "text", "text": "Hi", "props": {"fontFamily": family, "fontStyle": "Regular"}})).unwrap(); let t = crate::params::id_of(&r["id"]).unwrap(); s.execute("text.weightUp", &json!({"ids": [t]})).unwrap(); let up = font_style(&s, t); - assert!(styles.contains(&up) && figcraft_doc::style_weight(&up) > 400, "{family}: {up} of {styles:?}"); + assert_eq!(up, heavier, "{family}: {styles:?}"); s.execute("text.weightDown", &json!({"ids": [t]})).unwrap(); assert_eq!(font_style(&s, t), "Regular", "{family}: {styles:?}"); // A family that isn't installed still steps by 100 under the canonical names. From 2c9226c0215acf23772cd6c062790019fe9629d7 Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Tue, 3 Nov 2026 03:44:58 +0100 Subject: [PATCH 33/68] M4: weight steps from an off-list weight compare the faces' own weights (#1831) next_style compared a custom wght value or a style the family lacks with the weights the style names say, so Segoe UI Variable's Semilight (350) counted as 300 and a wght of 325 stepped up to Regular. The family's styles now come with the weights the style menu sorts them by (figcraft_text::family_style_weights), and "W7 Italic" reads as 700. --- crates/engine/src/cmd/text.rs | 33 +++++++++------- crates/engine/src/text_weight_step_tests.rs | 43 ++++++++++++++++++--- crates/text/src/fontdb.rs | 13 ++++++- crates/text/src/lib.rs | 4 +- 4 files changed, 69 insertions(+), 24 deletions(-) diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index 31008533a..a25d19733 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -176,32 +176,35 @@ fn slanted(style: &str) -> bool { s.contains("italic") || s.contains("oblique") } -/// The weight a style name says ("W3" too). -fn name_weight(style: &str) -> u16 { - w_number(&style.to_ascii_lowercase()).unwrap_or_else(|| figcraft_doc::style_weight(style)) +/// The weight a style name says ("W3" and "W6 Italic" too). +pub(crate) fn name_weight(style: &str) -> u16 { + let first = style.to_ascii_lowercase().replace('-', " "); + first.split_whitespace().next().and_then(w_number).unwrap_or_else(|| figcraft_doc::style_weight(style)) } -/// The next heavier (`up`) or lighter style of `styles` (a family's, lightest first, as the style -/// menu lists them) after the chars' style, with the same slant and width. The chars' style is -/// found in the list by name and its neighbour taken; a style the family doesn't have, or a custom -/// weight axis value, goes to the nearest weight that way. None when the family has nothing further. -pub(crate) fn next_style(styles: &[String], st: &TextStyle, up: bool) -> Option { +/// The next heavier (`up`) or lighter style of `styles` (a family's with the weight each is listed +/// by, lightest first, as the style menu lists them) after the chars' style, with the same slant +/// and width. The chars' style is found in the list by name and its neighbour taken; a style the +/// family doesn't have, or a custom weight axis value, goes to the listed style of nearest weight +/// that way. None when the family has nothing further. +pub(crate) fn next_style(styles: &[(String, u16)], st: &TextStyle, up: bool) -> Option { let italic = st.italic() || slanted(&st.font_style); let rest = style_rest(&st.font_style); - let mut same: Vec<&String> = styles.iter().filter(|x| slanted(x) == italic && style_rest(x) == rest).collect(); + let mut same: Vec<&(String, u16)> = styles.iter().filter(|(x, _)| slanted(x) == italic && style_rest(x) == rest).collect(); let norm = |s: &str| s.to_lowercase().replace([' ', '-', '_'], ""); - let here = same.iter().position(|x| norm(x) == norm(&st.font_style)); - if let Some(i) = here.filter(|_| !st.variations.contains_key("wght")) { + let here = same.iter().position(|(x, _)| norm(x) == norm(&st.font_style)); + let axis = st.variations.contains_key("wght"); + if let Some(i) = here.filter(|_| !axis) { let next = if up { i.checked_add(1) } else { i.checked_sub(1) }; - return next.and_then(|n| same.get(n)).map(|x| (*x).clone()); + return next.and_then(|n| same.get(n)).map(|(x, _)| x.clone()); } - let w = i32::from(st.weight()); + let w = i32::from(if axis { st.weight() } else { name_weight(&st.font_style) }); // Of equal weights, the one nearest in the family's order: the first going up, the last going down. if !up { same.reverse(); } same.into_iter() - .map(|x| (i32::from(name_weight(x)) - w, x)) + .map(|(x, xw)| (i32::from(*xw) - w, x)) .filter(|(d, _)| if up { *d > 0 } else { *d < 0 }) .min_by_key(|(d, _)| d.abs()) .map(|(_, x)| x.clone()) @@ -210,7 +213,7 @@ pub(crate) fn next_style(styles: &[String], st: &TextStyle, up: bool) -> Option< /// `text.weightUp` / `text.weightDown`: each targeted run moves to the next style of its family. fn step_weight(s: &mut Session, p: &Value, up: bool) -> Result { style(s, p, |st| { - let styles = figcraft_text::family_styles(&st.font_family); + let styles = figcraft_text::family_style_weights(&st.font_family); if styles.is_empty() { // A family that isn't installed: step the weight by 100 under its canonical name. let w = (i32::from(st.weight()) + if up { 100 } else { -100 }).clamp(100, 900) as u16; diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs index f3647d77d..96562bf7e 100644 --- a/crates/engine/src/text_weight_step_tests.rs +++ b/crates/engine/src/text_weight_step_tests.rs @@ -5,10 +5,16 @@ use figcraft_doc::{NodeId, TextStyle}; use serde_json::json; use crate::Session; -use crate::cmd::text::next_style; +use crate::cmd::text::{name_weight, next_style}; -fn styles(names: &[&str]) -> Vec { - names.iter().map(|s| (*s).to_string()).collect() +/// A family's styles listed by the weights their names say, as for faces not read yet. +fn styles(names: &[&str]) -> Vec<(String, u16)> { + names.iter().map(|s| ((*s).to_string(), name_weight(s))).collect() +} + +/// A family's styles with the faces' own weights. +fn weighed(faces: &[(&str, u16)]) -> Vec<(String, u16)> { + faces.iter().map(|(s, w)| ((*s).to_string(), *w)).collect() } fn at(style: &str) -> TextStyle { @@ -18,7 +24,7 @@ fn at(style: &str) -> TextStyle { } /// Walk `from` heavier (`up`) or lighter until the family has nothing further. -fn walk(family: &[String], from: &str, up: bool) -> Vec { +fn walk(family: &[(String, u16)], from: &str, up: bool) -> Vec { let mut st = at(from); let mut out = Vec::new(); while let Some(next) = next_style(family, &st, up) { @@ -80,6 +86,31 @@ fn a_custom_weight_axis_value_steps_from_where_it_is() { assert_eq!(next_style(&family, &st, false).as_deref(), Some("Medium")); } +#[test] +fn off_the_list_the_faces_own_weights_decide() { + // From 500 between 400 and 700 faces: the neighbours, under their own names (the axis value goes). + let family = weighed(&[("Light", 300), ("Regular", 400), ("Bold", 700)]); + let mut st = at("Regular"); + st.variations.insert("wght".into(), 500.0); + assert_eq!(next_style(&family, &st, true).as_deref(), Some("Bold")); + assert_eq!(next_style(&family, &st, false).as_deref(), Some("Regular")); + st.set_font_style("Bold"); + assert_eq!((st.weight(), st.variations.get("wght")), (700, None)); + // Segoe UI Variable's Semilight is 350, not the 300 its name says: from a `wght` of 325 it is + // the next heavier style, and from 375 the next lighter. + let segoe = weighed(&[("Light", 300), ("Semilight", 350), ("Regular", 400), ("Semibold", 600), ("Bold", 700)]); + st.variations.insert("wght".into(), 325.0); + assert_eq!(next_style(&segoe, &st, true).as_deref(), Some("Semilight")); + assert_eq!(next_style(&segoe, &st, false).as_deref(), Some("Light")); + st.variations.insert("wght".into(), 375.0); + assert_eq!(next_style(&segoe, &st, false).as_deref(), Some("Semilight")); + assert_eq!(next_style(&segoe, &st, true).as_deref(), Some("Regular")); + // A W-numbered name with a slant after it is still that weight ("W7 Italic" is 700). + let hiragino = weighed(&[("W3 Italic", 300), ("W6 Italic", 600), ("W8 Italic", 800)]); + assert_eq!(next_style(&hiragino, &at("W7 Italic"), false).as_deref(), Some("W6 Italic")); + assert_eq!(next_style(&hiragino, &at("W7 Italic"), true).as_deref(), Some("W8 Italic")); +} + fn font_style(s: &Session, t: NodeId) -> String { s.doc().unwrap().node(t).unwrap().kind.text().unwrap().spans()[0].2.font_style.clone() } @@ -89,8 +120,8 @@ fn the_commands_land_on_styles_the_family_has() { figcraft_text::scan_system_fonts(); // Any installed family with a Regular face and a style the step takes it to (CI machines differ). let pick = figcraft_text::family_names().into_iter().find_map(|f| { - let st = figcraft_text::family_styles(&f); - let up = next_style(&st, &at("Regular"), true).filter(|_| st.iter().any(|x| x == "Regular"))?; + let st = figcraft_text::family_style_weights(&f); + let up = next_style(&st, &at("Regular"), true).filter(|_| st.iter().any(|(x, _)| x == "Regular"))?; Some((f, st, up)) }); let Some((family, styles, heavier)) = pick else { return }; diff --git a/crates/text/src/fontdb.rs b/crates/text/src/fontdb.rs index d0004fcd9..c3c2f43a6 100644 --- a/crates/text/src/fontdb.rs +++ b/crates/text/src/fontdb.rs @@ -743,6 +743,12 @@ impl FontDb { /// Style names of a family, by weight then italic. pub fn styles(&mut self, family: &str) -> Vec { + self.style_weights(family).into_iter().map(|(name, _)| name).collect() + } + + /// [`styles`](Self::styles) with the weight each is listed by: the face's own (Segoe UI + /// Semilight is 350), a named instance's `wght`, or for a face not read yet its name's. + pub fn style_weights(&mut self, family: &str) -> Vec<(String, u16)> { self.load_family(family, None); let key = self.key(family); // (weight, italic, order in the font, name): named instances keep the font's order. @@ -768,7 +774,7 @@ impl FontDb { v.sort(); let mut seen = std::collections::HashSet::new(); v.retain(|x| seen.insert(norm_style(&x.3))); - v.into_iter().map(|x| x.3).collect() + v.into_iter().map(|x| (x.3, x.0)).collect() } /// The key `family` is known under: itself in any case; for a name designs use for Apple's @@ -1502,6 +1508,11 @@ pub fn family_styles(family: &str) -> Vec { db().write().unwrap_or_else(std::sync::PoisonError::into_inner).styles(family) } +/// [`family_styles`] with the weight each is listed by (see [`FontDb::style_weights`]). +pub fn family_style_weights(family: &str) -> Vec<(String, u16)> { + db().write().unwrap_or_else(std::sync::PoisonError::into_inner).style_weights(family) +} + /// Scan system fonts into the global db (desktop; a no-op on the web, or with /// `FIGCRAFT_NO_SYSTEM_FONTS` set). Runs once per process: a concurrent caller waits for that scan. /// The directory walk runs without holding the database lock; results are merged in one short write. diff --git a/crates/text/src/lib.rs b/crates/text/src/lib.rs index cad3e1326..b6d87d669 100644 --- a/crates/text/src/lib.rs +++ b/crates/text/src/lib.rs @@ -17,8 +17,8 @@ pub use breaks::{backspace_step, grapheme_step}; pub use color::{ColorBitmap, ColorInk, ColorLayer}; pub use fontdb::{ Axis, CRAFT_FONTS, Coords, Face, FontDb, LocalFont, NamedInstance, Rescan, add_local_fonts, axis_label, db, face_with_char, family_names, - family_styles, find_face, has_family, installed_fonts_known, load_font_bytes, load_local_font, local_only, no_coords, opt_out_of_system_fonts, - rescan_system_fonts, scan_system_fonts, scan_system_fonts_on_demand, system_fonts_scanned, take_wanted_local_fonts, + family_style_weights, family_styles, find_face, has_family, installed_fonts_known, load_font_bytes, load_local_font, local_only, no_coords, + opt_out_of_system_fonts, rescan_system_fonts, scan_system_fonts, scan_system_fonts_on_demand, system_fonts_scanned, take_wanted_local_fonts, }; pub use layout::{Decoration, Glyph, Line, TextLayout, layout}; pub use onpath::OnPath; From 45c89c5a737e493c9e2e3de12d0e40d02ee2edbc Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Tue, 3 Nov 2026 04:38:16 +0100 Subject: [PATCH 34/68] M4: weight steps reach a weight family's italics and read W weights after a width (#1831) A family installed as one family per weight ("Foo Bold" with Regular and Italic faces) now lists Bold and Bold Italic, the names resolve draws them by, with the faces' own weights when they are read. A W-numbered weight counts after other words too ("Condensed W7 Italic" is 700). --- crates/engine/src/cmd/text.rs | 6 +-- crates/engine/src/text_weight_step_tests.rs | 4 ++ crates/text/src/fontdb.rs | 21 ++++++++-- crates/text/src/fontdb_names_tests.rs | 43 ++++++++++++++++++++- 4 files changed, 67 insertions(+), 7 deletions(-) diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index a25d19733..9024e1229 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -176,10 +176,10 @@ fn slanted(style: &str) -> bool { s.contains("italic") || s.contains("oblique") } -/// The weight a style name says ("W3" and "W6 Italic" too). +/// The weight a style name says ("W3", "W6 Italic" and "Condensed W7" too). pub(crate) fn name_weight(style: &str) -> u16 { - let first = style.to_ascii_lowercase().replace('-', " "); - first.split_whitespace().next().and_then(w_number).unwrap_or_else(|| figcraft_doc::style_weight(style)) + let words = style.to_ascii_lowercase().replace('-', " "); + words.split_whitespace().find_map(w_number).unwrap_or_else(|| figcraft_doc::style_weight(style)) } /// The next heavier (`up`) or lighter style of `styles` (a family's with the weight each is listed diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs index 96562bf7e..e8bf65a7b 100644 --- a/crates/engine/src/text_weight_step_tests.rs +++ b/crates/engine/src/text_weight_step_tests.rs @@ -109,6 +109,10 @@ fn off_the_list_the_faces_own_weights_decide() { let hiragino = weighed(&[("W3 Italic", 300), ("W6 Italic", 600), ("W8 Italic", 800)]); assert_eq!(next_style(&hiragino, &at("W7 Italic"), false).as_deref(), Some("W6 Italic")); assert_eq!(next_style(&hiragino, &at("W7 Italic"), true).as_deref(), Some("W8 Italic")); + // And after a width ("Condensed W7 Italic" is 700 too). + let condensed = weighed(&[("Condensed W3 Italic", 300), ("Condensed W6 Italic", 600), ("Condensed W8 Italic", 800)]); + assert_eq!(next_style(&condensed, &at("Condensed W7 Italic"), true).as_deref(), Some("Condensed W8 Italic")); + assert_eq!(next_style(&condensed, &at("Condensed W7 Italic"), false).as_deref(), Some("Condensed W6 Italic")); } fn font_style(s: &Session, t: NodeId) -> String { diff --git a/crates/text/src/fontdb.rs b/crates/text/src/fontdb.rs index c3c2f43a6..a856aa1fe 100644 --- a/crates/text/src/fontdb.rs +++ b/crates/text/src/fontdb.rs @@ -767,9 +767,24 @@ impl FontDb { v.push((w, f.italic || italic_name(&inst.name), k, inst.name.clone())); } } - // A family installed as one family per weight offers those weights too. - for (_, style) in self.split_families(&key) { - v.push((pending_weight(&style).clamp(1, 1000) as u16, italic_name(&style), 0, style)); + // A family installed as one family per weight offers those weights too, upright and italic + // as that family's faces are ("Foo Bold" with Regular and Italic faces: Bold and Bold + // Italic, the names `resolve` finds them by). A face read gives its own weight, one not + // read the name's; the families aren't read for this. + for (k, style) in self.split_families(&key) { + let named = pending_weight(&style).clamp(1, 1000) as u16; + let italic = italic_name(&style); + let read = self.families.get(&k).map(|(_, idx)| idx.as_slice()).unwrap_or_default().iter().filter_map(|i| self.faces.get(*i)); + let unread = self.pending.get(&k).into_iter().flat_map(|(_, entries)| entries).map(|e| (named, italic_name(&e.style))); + let faces: Vec<(u16, bool)> = read.map(|f| (f.weight, f.italic)).chain(unread).collect(); + if faces.is_empty() { + v.push((named, italic, 0, style)); + continue; + } + for (w, slanted) in faces { + let name = if slanted && !italic { format!("{style} Italic") } else { style.clone() }; + v.push((w, slanted || italic, 0, name)); + } } v.sort(); let mut seen = std::collections::HashSet::new(); diff --git a/crates/text/src/fontdb_names_tests.rs b/crates/text/src/fontdb_names_tests.rs index 0d31b7c56..62bd27be3 100644 --- a/crates/text/src/fontdb_names_tests.rs +++ b/crates/text/src/fontdb_names_tests.rs @@ -5,9 +5,10 @@ //! case; the picker lists what is installed. Synthetic family names only, over pending entries //! (no files) and the embedded faces when the build has them. +use std::collections::BTreeMap; use std::sync::Arc; -use super::{CRAFT_FONTS, Face, FontBytes, FontDb, Pending, style_words}; +use super::{CRAFT_FONTS, Face, FontBytes, FontDb, LocalFont, Pending, scan_dir, style_words, system_font_dirs}; fn entry(style: &str) -> Pending { Pending { path: format!("no-such-dir/{style}.ttf").into(), index: 0, style: style.into(), postscript: None, local: None } @@ -104,3 +105,43 @@ fn faces_are_found_and_listed_under_either_name() { assert!(Arc::ptr_eq(&db.find("Synthetic Text SemiBold", "Regular").unwrap(), &semibold)); assert!(Arc::ptr_eq(&db.find("synthetictext", "Semibold").unwrap(), &semibold)); } + +#[test] +fn a_family_per_weight_offers_its_italics_too() { + // Listed by name before anything is read: Synthetic Slab Bold's Italic face is Bold Italic. + let local = |id: usize, family: &str, style: &str| LocalFont { id, family: family.into(), style: style.into(), postscript: String::new() }; + let mut db = FontDb::default(); + db.add_local(vec![ + local(0, "Synthetic Slab", "Regular"), + local(1, "Synthetic Slab", "Italic"), + local(2, "Synthetic Slab Bold", "Regular"), + local(3, "Synthetic Slab Bold", "Italic"), + ]); + let listed = |db: &mut FontDb| db.style_weights("Synthetic Slab"); + let want = |v: &[(&str, u16)]| v.iter().map(|(s, w)| ((*s).to_string(), *w)).collect::>(); + assert_eq!(listed(&mut db), want(&[("Regular", 400), ("Italic", 400), ("Bold", 700), ("Bold Italic", 700)])); + assert_eq!(resolved(&db, "Synthetic Slab", "Bold Italic"), pair("synthetic slab bold", "Italic"), "the style drawn by that face"); + // Faces read give their own weights: Synthetic Slab Semi Light's are 350, not the name's 300. + let stand_in = CRAFT_FONTS.first().map(|f| f.bytes.to_vec()).or_else(|| { + let mut installed = BTreeMap::new(); + for dir in system_font_dirs() { + scan_dir(&dir, 0, &mut installed); + } + installed.values().flat_map(|(_, v)| v).find_map(|p| std::fs::read(&p.path).ok()) + }); + let Some(bytes) = stand_in.map(Arc::new) else { + eprintln!("skipping the read faces: no font to stand in"); + return; + }; + let face = |family: &str, style: &str, weight: u16, italic: bool| { + let mut f = Face::from_bytes(FontBytes::Shared(bytes.clone()), 0, Some(family), Some(style)).unwrap(); + f.instances.clear(); + (f.weight, f.italic) = (weight, italic); + f + }; + let mut db = FontDb::default(); + db.add(face("Synthetic Slab", "Regular", 400, false)); + db.add(face("Synthetic Slab Semi Light", "Regular", 350, false)); + db.add(face("Synthetic Slab Semi Light", "Italic", 350, true)); + assert_eq!(listed(&mut db), want(&[("Semi Light", 350), ("Semi Light Italic", 350), ("Regular", 400)])); +} From 8864068cd592f517d4dd4b0ce6c4270957d9d0c6 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:21:45 +0000 Subject: [PATCH 35/68] fix(engine): compare online servers' paths with their case same_server lowercased the whole address, so files on /Team/ and /team/ (which a proxy can route to different servers) counted as one server and the online refresh sent both files' owner tokens to whichever answered. The scheme and host still compare without case; the path keeps its. --- crates/engine/src/online_tests.rs | 3 +++ crates/engine/src/sharing/online.rs | 13 ++++++++----- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/crates/engine/src/online_tests.rs b/crates/engine/src/online_tests.rs index af13db8e7..c6feca29c 100644 --- a/crates/engine/src/online_tests.rs +++ b/crates/engine/src/online_tests.rs @@ -590,4 +590,7 @@ fn same_server_ignores_the_default_port_before_a_path() { assert!(same_server("wss://share.example:443/figcraft/", "wss://share.example/figcraft/")); assert!(same_server("ws://host:80/x", "ws://host/x")); assert!(!same_server("wss://share.example:8443/figcraft/", "wss://share.example/figcraft/")); + // The path is a route: owner tokens for /Team/ must never be sent to /team/. + assert!(same_server("WSS://Share.Example/team/", "wss://share.example/team")); + assert!(!same_server("wss://share.example/Team/", "wss://share.example/team/")); } diff --git a/crates/engine/src/sharing/online.rs b/crates/engine/src/sharing/online.rs index d68b20f82..89eb8a266 100644 --- a/crates/engine/src/sharing/online.rs +++ b/crates/engine/src/sharing/online.rs @@ -117,14 +117,17 @@ pub(crate) fn plain_server(server: &str) -> String { /// Two addresses name the same server (case, a closing slash and the scheme's own port aside). pub fn same_server(a: &str, b: &str) -> bool { let norm = |s: &str| { - let s = plain_server(s).to_ascii_lowercase(); + let s = plain_server(s); let s = s.trim_end_matches('/'); - let port = if s.starts_with("wss://") { ":443" } else { ":80" }; let start = s.find("://").map_or(0, |i| i + 3); let end = s[start..].find('/').map_or(s.len(), |i| start + i); - match s[start..end].strip_suffix(port) { - Some(host) => format!("{}{}{}", &s[..start], host, &s[end..]), - None => s.to_string(), + // The scheme and host compare without case; the path routes (a proxy may send + // `/Team/` and `/team/` to different servers), so it keeps its case. + let head = s[..end].to_ascii_lowercase(); + let port = if head.starts_with("wss://") { ":443" } else { ":80" }; + match head[start..].strip_suffix(port) { + Some(host) => format!("{}{}{}", &head[..start], host, &s[end..]), + None => format!("{head}{}", &s[end..]), } }; norm(a) == norm(b) From 4e7d8319f1c04428672e7c84e80d63b9eb11f966 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:22:15 +0000 Subject: [PATCH 36/68] fix(collab-net): hold a health check's header read to the handshake deadline The request line was read within the hello timeout, but the header loop after it only timed out per read, so a peer dripping header bytes kept the worker thread and its connection slot for as long as it liked. Each header read now gets what is left of the one deadline. --- crates/collab-net/src/hub/conn.rs | 34 +++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/crates/collab-net/src/hub/conn.rs b/crates/collab-net/src/hub/conn.rs index 1f365cbab..345f94117 100644 --- a/crates/collab-net/src/hub/conn.rs +++ b/crates/collab-net/src/hub/conn.rs @@ -51,6 +51,12 @@ fn health_check(stream: &mut TcpStream, until: Instant) -> bool { let mut req = Vec::new(); let mut chunk = [0u8; 1024]; while !req.windows(4).any(|w| w == b"\r\n\r\n") && req.len() < 16 << 10 { + // The same deadline as the request line: a peer dripping header bytes would otherwise + // hold this thread and its connection slot for as long as it liked. + let left = until.saturating_duration_since(Instant::now()); + if left.is_zero() || stream.set_read_timeout(Some(left)).is_err() { + break; + } match stream.read(&mut chunk) { Ok(0) | Err(_) => break, Ok(n) => req.extend_from_slice(chunk.get(..n).unwrap_or_default()), @@ -407,3 +413,31 @@ fn linger(ws: &mut WebSocket) { } } } + +#[cfg(test)] +mod health_check_tests { + use super::*; + + #[test] + fn a_health_check_dripping_headers_ends_at_the_deadline() { + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let addr = listener.local_addr().unwrap(); + let client = std::thread::spawn(move || { + let mut c = TcpStream::connect(addr).unwrap(); + c.write_all(b"GET /healthz HTTP/1.1\r\n").unwrap(); + // One header byte every 20 ms, far past the deadline, until the server hangs up. + for _ in 0..200 { + if c.write_all(b"X").is_err() { + break; + } + std::thread::sleep(Duration::from_millis(20)); + } + }); + let (mut stream, _) = listener.accept().unwrap(); + let start = Instant::now(); + assert!(health_check(&mut stream, start + Duration::from_millis(300))); + assert!(start.elapsed() < Duration::from_secs(2), "{:?}", start.elapsed()); + drop(stream); + client.join().unwrap(); + } +} From a9e66d2de9cc628a09f98898b69ec8a5bb2404fc Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:24:32 +0000 Subject: [PATCH 37/68] perf(vectordrawable): keep warning names in a set Each affected layer name was checked against every name already kept for the warning, quadratic in the number of distinct names although only three are ever shown. A set holds the distinct names; the first three stay in order. --- crates/vectordrawable/src/warnings.rs | 38 ++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/crates/vectordrawable/src/warnings.rs b/crates/vectordrawable/src/warnings.rs index 445198d5b..6f7f152ef 100644 --- a/crates/vectordrawable/src/warnings.rs +++ b/crates/vectordrawable/src/warnings.rs @@ -63,27 +63,53 @@ const NAMED: usize = 3; #[derive(Default)] pub(crate) struct Warnings { - seen: std::collections::BTreeMap>, + /// Per warning: the distinct names so far (a set, so a document with many distinct names + /// doesn't make each check a scan of all before it), and the first few in order. + seen: std::collections::BTreeMap, Vec)>, } impl Warnings { pub fn add(&mut self, w: Warn, layer: &str) { - let names = self.seen.entry(w).or_default(); - if !names.iter().any(|n| n == layer) { - names.push(layer.to_string()); + let (distinct, first) = self.seen.entry(w).or_default(); + if distinct.insert(layer.to_string()) && first.len() < NAMED { + first.push(layer.to_string()); } } pub fn finish(self) -> Vec { self.seen .into_iter() - .map(|(w, names)| { + .map(|(w, (distinct, names))| { let shown: Vec = names.iter().take(NAMED).map(|n| if n.is_empty() { "unnamed layer".to_string() } else { n.clone() }).collect(); - let more = names.len().saturating_sub(NAMED); + let more = distinct.len().saturating_sub(NAMED); let more = if more > 0 { format!(", {more} more") } else { String::new() }; format!("{} ({}{more})", w.message(), shown.join(", ")) }) .collect() } } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn names_are_counted_once_each_and_the_first_three_shown() { + let mut w = Warnings::default(); + for name in ["a", "b", "a", "c", "d", "b", "e"] { + w.add(Warn::NothingDrawn, name); + } + let lines = w.finish(); + assert_eq!(lines.len(), 1); + assert!(lines[0].ends_with("(a, b, c, 2 more)"), "{}", lines[0]); + // Many distinct names: each is one set insertion, not a scan of all before it. + let mut w = Warnings::default(); + let start = std::time::Instant::now(); + for i in 0..200_000 { + w.add(Warn::TooLarge, &format!("layer {i}")); + } + assert!(w.finish()[0].ends_with("199997 more)")); + assert!(start.elapsed() < std::time::Duration::from_secs(5), "{:?}", start.elapsed()); + } +} From dd03165d79362b2d25b3c21de7128a0c24d31544 Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:27:23 +0100 Subject: [PATCH 38/68] M4: weight steps read number weights after a width too (#1831) An off-list "Condensed 600" read as 400, since a number word counted as a weight only at the start of the name: weightUp took Condensed 500 and weightDown found nothing. A number from 100 to 1000 now counts in any position, as W numbers do. Smaller numbers (a width grade, an optical size: "Condensed 2", "Caption 12") are part of the width rather than a weight, so optical sizes no longer step into each other. --- crates/engine/src/cmd/text.rs | 13 ++++++++++--- crates/engine/src/text_weight_step_tests.rs | 14 ++++++++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index 9024e1229..392fd4636 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -128,6 +128,13 @@ fn w_number(word: &str) -> Option { (1..=9).contains(&n).then_some(n * 100) } +/// A weight number as some families name styles ("Condensed 600"). Below 100 it is something else +/// (a width grade, an optical size: "Condensed 2", "Caption 12"). +fn number_weight(word: &str) -> Option { + let n = word.parse::().ok().filter(|_| word.bytes().all(|b| b.is_ascii_digit()))?; + (100..=1000).contains(&n).then_some(n) +} + /// What a style name says besides its weight and slant ("Narrow Bold Italic" → "narrow", /// "Extra Condensed Bold" → "extra condensed"). fn style_rest(style: &str) -> String { @@ -162,7 +169,7 @@ fn style_rest(style: &str) -> String { const GRADES: [&str; 4] = ["extra", "ultra", "semi", "demi"]; let s = style.to_ascii_lowercase().replace('-', " "); let words: Vec<&str> = s.split_whitespace().collect(); - let weight = |w: &str| WEIGHTS.contains(&w) || w_number(w).is_some() || w.chars().all(|c| c.is_ascii_digit()); + let weight = |w: &str| WEIGHTS.contains(&w) || w_number(w).or_else(|| number_weight(w)).is_some(); let rest = words.iter().enumerate().filter(|(i, w)| { let graded = GRADES.contains(w) && words.get(i + 1).is_some_and(|next| weight(next) && !matches!(*next, "italic" | "oblique")); !weight(w) && !graded @@ -176,10 +183,10 @@ fn slanted(style: &str) -> bool { s.contains("italic") || s.contains("oblique") } -/// The weight a style name says ("W3", "W6 Italic" and "Condensed W7" too). +/// The weight a style name says ("W3", "W6 Italic", "Condensed W7" and "Condensed 600" too). pub(crate) fn name_weight(style: &str) -> u16 { let words = style.to_ascii_lowercase().replace('-', " "); - words.split_whitespace().find_map(w_number).unwrap_or_else(|| figcraft_doc::style_weight(style)) + words.split_whitespace().find_map(|w| w_number(w).or_else(|| number_weight(w))).unwrap_or_else(|| figcraft_doc::style_weight(style)) } /// The next heavier (`up`) or lighter style of `styles` (a family's with the weight each is listed diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs index e8bf65a7b..057a0a4e5 100644 --- a/crates/engine/src/text_weight_step_tests.rs +++ b/crates/engine/src/text_weight_step_tests.rs @@ -77,6 +77,20 @@ fn hairline_and_w_numbers_are_weights() { assert_eq!(next_style(&hiragino, &at("Bold"), false).as_deref(), Some("W6")); } +#[test] +fn number_weights_count_after_a_width_but_other_numbers_dont() { + // An off-list "Condensed 600" is 600, as "600" alone is: between Condensed 500 and 700. + let condensed = weighed(&[("Condensed 300", 300), ("Condensed 500", 500), ("Condensed 700", 700)]); + assert_eq!(next_style(&condensed, &at("Condensed 600"), true).as_deref(), Some("Condensed 700")); + assert_eq!(next_style(&condensed, &at("Condensed 600"), false).as_deref(), Some("Condensed 500")); + assert_eq!((name_weight("Condensed 600"), name_weight("600 Italic"), name_weight("Condensed 1000")), (600, 600, 1000)); + // A number that isn't a weight (a width grade, an optical size) is part of the width. + assert_eq!((name_weight("Condensed 2"), name_weight("Caption 12 Bold"), name_weight("Condensed +600")), (400, 700, 400)); + let optical = styles(&["Caption 12 Regular", "Caption 24 Regular", "Caption 12 Bold", "Caption 24 Bold"]); + assert_eq!(walk(&optical, "Caption 12 Regular", true), ["Caption 12 Bold"]); + assert_eq!(walk(&optical, "Caption 24 Bold", false), ["Caption 24 Regular"]); +} + #[test] fn a_custom_weight_axis_value_steps_from_where_it_is() { let family = styles(&["Light", "Regular", "Medium", "Bold"]); From 5851d9b9780887a544a3bc448c8c3530740086d9 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Tue, 3 Nov 2026 00:54:34 -0500 Subject: [PATCH 39/68] Control channel arrows: test the crosshair before the pan With a shape tool and nothing selected, ui.key ArrowRight moves the placement crosshair and leaves the view. Co-Authored-By: Claude Opus 5.5 --- crates/ui-egui/src/inspect_fields_tests.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/crates/ui-egui/src/inspect_fields_tests.rs b/crates/ui-egui/src/inspect_fields_tests.rs index 9ea3223fd..bdd0abcd8 100644 --- a/crates/ui-egui/src/inspect_fields_tests.rs +++ b/crates/ui-egui/src/inspect_fields_tests.rs @@ -70,4 +70,12 @@ fn control_key_arrows_pan_with_nothing_selected() { assert_eq!(view(&u), (10.0, -100.0), "with a selection the view stays"); let id = figcraft_engine::params::id_of(&r).unwrap(); assert_eq!(u.app.session.doc().unwrap().world_bounds(id).unwrap().x0, 1.0, "the selection moved instead"); + // With a shape tool chosen and nothing selected the arrows move the placement crosshair + // first (#1869), and the view stays. + u.app.run("select.set", json!({"ids": []})); + u.app.run("tool.rectangle", json!({})); + let before = view(&u); + call(&mut u, "ui.key", json!({"key": "ArrowRight"})).unwrap(); + assert_eq!(view(&u), before, "the crosshair, not a pan"); + assert!(u.app.session.crosshair().is_some()); } From a3cadb66cf08fa17309ad8e46dc74dd4c7c59a65 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Tue, 3 Nov 2026 01:12:47 -0500 Subject: [PATCH 40/68] Docs: one vector edit row after the merge The merge with main kept both versions of the row; they are combined, the Bend click sentence and the region fill sentences together. Co-Authored-By: Claude Opus 5.5 --- docs/ui-parity.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 0f7119979..69599e0bc 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -87,8 +87,7 @@ interaction feel not yet compared. | Rectangle, ellipse (arc handles and Design panel arc fields), polygon, star, line, arrow; Shift/Alt | done | Alt draws lines from the centre too (`shapes_behaviour_tests`) | | Corner radius handles (inside each corner of a rectangle or frame, a polygon's or star's top point; Alt: one corner), star ratio handle; Count and Ratio fields | done | handles hide under 48 px on screen; no count handle on the canvas (the Count field instead); corner smoothing rounds rectangles and frames only | | Pen: vector networks, branch, close, bend; pencil | done | pen pressure on Windows and from browser styluses only; outside edit mode the Pen closes on its first point, connects to its other points and continues a selected open path from an end point (`vector_multi_behaviour_tests`); Escape ends the path and keeps its layer in edit mode with the pen, so the next path joins the same vector and another Escape leaves edit mode (#760, `pen_end_tests`); Enter or a double-click ends the path (at the double-click's point, added once) and edits the vector with the Move tool, a double-click with the idle pen edits the layer under it, and in edit mode the pen's Enter or double-click takes the Move tool (#1430, `pen_vector_edit_tests`); switching from Design to Prototype or Inspect ends the path and returns to Move (#308) | -| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]`; Copy fill takes the region's paint, the colour picker and its canvas gradient and crop handles edit it (an image from Upload from computer included; a file dropped on the picker goes to the canvas instead), what belongs to the layer (its fill style, a variable bound to its fill, the image crop button) stays off a region's rows, and `fill.pattern` sets the layer's fill (#1875). Not yet: areas of other layers edited at once | -| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); a Bend click on a sharp point between two segments curves it (handles along the line between its neighbours, a third of the way to each, `ops::auto_smooth`), on a curved one sharpens it, a drag sets the handles by hand (#1875). Not yet: areas of other layers edited at once | +| Vector edit mode: bend, paint bucket, lasso, cut, eraser, transform box, point snapping, mirroring | done | a double-click a few pixels off a thin stroke enters edit mode (#646); entering edit mode and picking a region keep the canvas still (#322); a point dropped on another point merges with it, and dropping one end of an open path on the other closes it (a 2-point line's end just moves, #401); Flatten keeps open paths open (#377); paint bucket drags across areas; cut drags divide a shape into layers; delete and heal follows the curve; rounded points are drawn; Shift-click deselects a point at a corner of the box (`vector_behaviour_tests`); several vectors edited at once, Shift-click handles to drag them together, a cap and join per point, rounded points beside curves (`vector_multi_behaviour_tests`); filled regions with the Move tool: the area under the pointer is hatched ("/" lines in the selection colour, clipped by the area's own fill rule, holes left out, gone 3.5 px from a point or 2 px from a segment at any zoom), the line spacing follows octave folding (fitted to measurements at several zoom levels: 8 px at every power-of-two zoom, growing with the zoom and stepping back at √2 · 2ⁿ) and stays fixed to the shape when panning; a click selects the area and its points (moved with it but drawn unselected), Shift adds or removes an area, a press on a selected area drags the whole selection, no hover hatch during drags, a click on an empty spot (a hole) clears it and stays in edit mode; `vector.edit.select {regions}` (`regions_tests`, `vector_regions_tests`); a Bend click on a sharp point between two segments curves it (handles along the line between its neighbours, a third of the way to each, `ops::auto_smooth`), on a curved one sharpens it, a drag sets the handles by hand (#1875); with regions selected, the Fill section (its rows and the colour picker) and `fill.set`, `fill.add`, `fill.remove`, `fill.move` and `fill.paste` edit those regions' own fills, the layer's untouched, or the regions named by `regions: [index, ...]`; Copy fill takes the region's paint, the colour picker and its canvas gradient and crop handles edit it (an image from Upload from computer included; a file dropped on the picker goes to the canvas instead), what belongs to the layer (its fill style, a variable bound to its fill, the image crop button) stays off a region's rows, and `fill.pattern` sets the layer's fill (#1875). Not yet: areas of other layers edited at once | | Shape builder (Shift+M) on fills, strokes and open paths; variable width (Shift+W), one side with Alt | done | | | Boolean groups: clicked where the result is, double-click or Cmd/Ctrl-click into operands, live results while dragging or editing points, per-operand operations | done | a group past the path operations' caps (250 000 segments, 2 million possible crossings, 4 million segments swept over a fold) draws without its result, with a warning, and Flatten refuses it (#1104) | | Text: point, auto height, fixed; caret, words, lines, IME | done | Backspace or Delete at the start of a list item takes its marker and keeps its level, the paragraph starting where the item's text did ("delete the counter, but keep the same level of indentation", Create bulleted and numbered lists; `text_tail_tests::list_keys_at_list_items`, text crate `behaviour_tests`); max lines on auto-width text keep it auto width, hugging up to that many lines and growing with its longest line ("Text resizing is set to auto height or auto width", Explore text properties; `text_behaviour_tests::max_lines_on_auto_width_text_keeps_auto_width_and_hugs_that_many_lines`); Alt+Enter while editing opens the link at the caret, web and mail links only (`text.openLink`; "press ⌥Option Return/Alt Enter to activate a focused link", Accessibility at Figma; `text_link_tests`); the font picker previews a family on the canvas while hovered (no undo step; Escape restores, #653) and Up/Down step through it (#352); a selection highlight after a line break starts at that line's start and an empty last line shows its mark (#665); carets step over whole emoji and accented letters; colour emoji draw from their colour tables (#300); IME composition replayed in tests as macOS sends it, not yet checked on a Mac (#747); CJK words by script run (no dictionary); vertical trim in Type settings; no spell check | From 692c4545ba2dcf31a405fd7c28cdaac9d13e813d Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Tue, 3 Nov 2026 11:41:15 +0100 Subject: [PATCH 41/68] M4: weight steps read Univers numbers (45 Light, 57 Condensed) by weight within their width (#1831) --- crates/engine/src/cmd/text.rs | 95 +++++++++++++-------- crates/engine/src/text_weight_step_tests.rs | 32 +++++++ 2 files changed, 92 insertions(+), 35 deletions(-) diff --git a/crates/engine/src/cmd/text.rs b/crates/engine/src/cmd/text.rs index 392fd4636..2ef66c519 100644 --- a/crates/engine/src/cmd/text.rs +++ b/crates/engine/src/cmd/text.rs @@ -135,46 +135,65 @@ fn number_weight(word: &str) -> Option { (100..=1000).contains(&n).then_some(n) } +/// Style-name words that give a weight or a slant. +const WEIGHT_WORDS: [&str; 25] = [ + "thin", + "hairline", + "extralight", + "ultralight", + "light", + "semilight", + "demilight", + "regular", + "normal", + "roman", + "book", + "medium", + "semibold", + "demibold", + "bold", + "extrabold", + "ultrabold", + "black", + "extrablack", + "ultrablack", + "heavy", + "italic", + "oblique", + "plain", + "standard", +]; + +/// Words that grade the weight word after them ("Extra Bold") but a width otherwise ("Extra Condensed"). +const GRADES: [&str; 4] = ["extra", "ultra", "semi", "demi"]; + +/// The width a Univers number leading a style name gives, as Univers, Frutiger and Helvetica Neue +/// LT name styles ("45 Light", "55 Roman", "57 Condensed", "67 Bold Condensed"): the first digit +/// grades the weight, the second the width (3 or 4 extended, 5 or 6 normal, 7 or 8 condensed, 9 +/// ultra condensed; even is italic, which the name says too). Only before weight, slant and width +/// words, so another leading number ("12 Regular", "55 Rounded") stays part of the width. +fn univers_width(words: &[&str]) -> Option { + const WIDTHS: [&str; 6] = ["condensed", "compressed", "narrow", "extended", "expanded", "wide"]; + let (code, rest) = words.split_first()?; + let &[b'1'..=b'9', d @ b'3'..=b'9'] = code.as_bytes() else { return None }; + let known = |w: &&str| WEIGHT_WORDS.contains(w) || GRADES.contains(w) || WIDTHS.contains(w); + (!rest.is_empty() && rest.iter().all(known)).then_some((d - b'1') / 2) +} + /// What a style name says besides its weight and slant ("Narrow Bold Italic" → "narrow", -/// "Extra Condensed Bold" → "extra condensed"). +/// "Extra Condensed Bold" → "extra condensed", "67 Bold Condensed" → its Univers width and "condensed"). fn style_rest(style: &str) -> String { - const WEIGHTS: [&str; 25] = [ - "thin", - "hairline", - "extralight", - "ultralight", - "light", - "semilight", - "demilight", - "regular", - "normal", - "roman", - "book", - "medium", - "semibold", - "demibold", - "bold", - "extrabold", - "ultrabold", - "black", - "extrablack", - "ultrablack", - "heavy", - "italic", - "oblique", - "plain", - "standard", - ]; - // Words that grade the weight word after them ("Extra Bold") but a width otherwise ("Extra Condensed"). - const GRADES: [&str; 4] = ["extra", "ultra", "semi", "demi"]; let s = style.to_ascii_lowercase().replace('-', " "); let words: Vec<&str> = s.split_whitespace().collect(); - let weight = |w: &str| WEIGHTS.contains(&w) || w_number(w).or_else(|| number_weight(w)).is_some(); + let weight = |w: &str| WEIGHT_WORDS.contains(&w) || w_number(w).or_else(|| number_weight(w)).is_some(); let rest = words.iter().enumerate().filter(|(i, w)| { let graded = GRADES.contains(w) && words.get(i + 1).is_some_and(|next| weight(next) && !matches!(*next, "italic" | "oblique")); !weight(w) && !graded }); - rest.map(|(_, w)| *w).collect::>().join(" ") + let univers = univers_width(&words).map(|d| format!("univers width {d}")); + // The Univers number (the first word kept) gives way to its width. + let rest = rest.map(|(_, w)| *w).skip(usize::from(univers.is_some())); + univers.as_deref().into_iter().chain(rest).collect::>().join(" ") } /// A style name that slants: italic, or oblique as some families name it. @@ -183,10 +202,16 @@ fn slanted(style: &str) -> bool { s.contains("italic") || s.contains("oblique") } -/// The weight a style name says ("W3", "W6 Italic", "Condensed W7" and "Condensed 600" too). +/// The weight a style name says ("W3", "W6 Italic", "Condensed W7", "Condensed 600" and "45 Light" too). pub(crate) fn name_weight(style: &str) -> u16 { - let words = style.to_ascii_lowercase().replace('-', " "); - words.split_whitespace().find_map(|w| w_number(w).or_else(|| number_weight(w))).unwrap_or_else(|| figcraft_doc::style_weight(style)) + let s = style.to_ascii_lowercase().replace('-', " "); + let words: Vec<&str> = s.split_whitespace().collect(); + // A Univers number's weight digit has no fixed CSS weight ("65" is Medium in Helvetica Neue, + // Bold in Univers): the words after it say it. + if let Some((_, rest)) = words.split_first().filter(|_| univers_width(&words).is_some()) { + return figcraft_doc::style_weight(&rest.join(" ")); + } + words.iter().find_map(|w| w_number(w).or_else(|| number_weight(w))).unwrap_or_else(|| figcraft_doc::style_weight(style)) } /// The next heavier (`up`) or lighter style of `styles` (a family's with the weight each is listed diff --git a/crates/engine/src/text_weight_step_tests.rs b/crates/engine/src/text_weight_step_tests.rs index 057a0a4e5..a6c465789 100644 --- a/crates/engine/src/text_weight_step_tests.rs +++ b/crates/engine/src/text_weight_step_tests.rs @@ -91,6 +91,38 @@ fn number_weights_count_after_a_width_but_other_numbers_dont() { assert_eq!(walk(&optical, "Caption 24 Bold", false), ["Caption 24 Regular"]); } +#[test] +fn univers_numbers_step_by_weight_within_their_width() { + // Helvetica Neue LT, Univers, Frutiger: the first digit grades the weight, the second the width. + let hn = weighed(&[ + ("45 Light", 300), + ("46 Light Italic", 300), + ("55 Roman", 400), + ("56 Italic", 400), + ("57 Condensed", 400), + ("65 Medium", 500), + ("67 Medium Condensed", 500), + ("75 Bold", 700), + ("76 Bold Italic", 700), + ("77 Bold Condensed", 700), + ]); + assert_eq!(walk(&hn, "55 Roman", true), ["65 Medium", "75 Bold"]); + assert_eq!(walk(&hn, "65 Medium", false), ["55 Roman", "45 Light"]); + assert_eq!(walk(&hn, "57 Condensed", true), ["67 Medium Condensed", "77 Bold Condensed"]); + assert_eq!(walk(&hn, "67 Medium Condensed", false), ["57 Condensed"]); + assert_eq!(walk(&hn, "46 Light Italic", true), ["56 Italic", "76 Bold Italic"]); + // Faces not read yet: the words after the number give the weight. + let univers = styles(&["45 Light", "55 Roman", "65 Bold", "75 Black", "57 Condensed", "67 Bold Condensed"]); + assert_eq!(walk(&univers, "45 Light", true), ["55 Roman", "65 Bold", "75 Black"]); + assert_eq!(walk(&univers, "67 Bold Condensed", false), ["57 Condensed"]); + assert_eq!((name_weight("45 Light"), name_weight("75 Black"), name_weight("57 Condensed")), (300, 900, 400)); + // Other leading numbers stay part of the width: before another word, or not a width digit. + let other = styles(&["12 Regular", "12 Bold", "55 Rounded", "55 Rounded Bold", "Regular", "Bold"]); + assert_eq!(walk(&other, "12 Regular", true), ["12 Bold"]); + assert_eq!(walk(&other, "55 Rounded", true), ["55 Rounded Bold"]); + assert_eq!(walk(&other, "Regular", true), ["Bold"]); +} + #[test] fn a_custom_weight_axis_value_steps_from_where_it_is() { let family = styles(&["Light", "Regular", "Medium", "Bold"]); From fe18f6d96d48db1d7962636e14e3a7f6ba7f5092 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Tue, 3 Nov 2026 09:48:51 -0500 Subject: [PATCH 42/68] M6: .jam import: a connector end with an AUTO or CENTER magnet faces the other end (#1909) An end whose magnet is AUTO has no fixed point: FigJam picks the side when it draws, and the file keeps whatever relativePosition the end last had, so the importer sent every automatic end out of the stale side (the left one in the reporter's file). AUTO and CENTER ends now attach to the side facing the other end, as a board connector drawn here does, for straight, elbowed and curved connectors alike; named magnets and ends without one are unchanged. Test: connectors_with_an_automatic_side_leave_the_side_facing_the_target (the fixture schema gains the ConnectorMagnet enum). Docs: file-format-parity .jam row, status line and revision history. Co-Authored-By: Claude Fable 5.1 --- crates/format/src/fig/map/connector.rs | 11 ++++-- crates/format/src/fig/tail_tests.rs | 47 ++++++++++++++++++++++++++ crates/format/src/fig/tests.rs | 3 +- docs/file-format-parity.md | 5 +-- 4 files changed, 61 insertions(+), 5 deletions(-) diff --git a/crates/format/src/fig/map/connector.rs b/crates/format/src/fig/map/connector.rs index de2ff501c..3db1597b1 100644 --- a/crates/format/src/fig/map/connector.rs +++ b/crates/format/src/fig/map/connector.rs @@ -77,8 +77,13 @@ impl<'a> Mapper<'a> { let (w, h) = n.get("size").map_or((0.0, 0.0), |s| (num(s, "x").unwrap_or(0.0), num(s, "y").unwrap_or(0.0))); let at = e.get("relativePosition").and_then(|r| Some((num(r, "x")?, num(r, "y")?))); let t = n.get("transform").and_then(matrix).unwrap_or_default(); + // An automatic magnet (`AUTO`: the side is picked when the connector is drawn; + // `CENTER`: the end aims at the layer's middle) attaches to the side facing the + // other end, as a board connector drawn here does; the file's `relativePosition` + // is not where such an end sits (#1909). + let automatic = matches!(e.get("magnet").and_then(Kv::str), Some("AUTO" | "CENTER")); match routing { - Routing::Straight => { + Routing::Straight if !automatic => { let (rx, ry) = at.unwrap_or((0.5, 0.5)); RouteEnd::Point(t * Point::new(w * rx, h * ry)) } @@ -407,7 +412,8 @@ pub(super) fn connector_has_saved_label(v: &View<'_>) -> bool { .is_some_and(|s| !s.trim().is_empty()) } -/// The side of its layer a connector end leaves from: the `magnet` the file names, else the edge +/// The side of its layer a connector end leaves from: the `magnet` the file names (`AUTO` and +/// `CENTER`: the side facing the other end, whatever `relativePosition` says; #1909), else the edge /// its point on the layer (`relativePosition`, 0–1) lies on, else the side facing the other end. fn side(e: &Kv<'_>, at: Option<(f64, f64)>) -> Side { match e.get("magnet").and_then(Kv::str) { @@ -415,6 +421,7 @@ fn side(e: &Kv<'_>, at: Option<(f64, f64)>) -> Side { Some("RIGHT") => Side::Right, Some("BOTTOM") => Side::Bottom, Some("LEFT") => Side::Left, + Some("AUTO" | "CENTER") => Side::Auto, _ => match at { Some((x, _)) if x <= 0.0 => Side::Left, Some((x, _)) if x >= 1.0 => Side::Right, diff --git a/crates/format/src/fig/tail_tests.rs b/crates/format/src/fig/tail_tests.rs index 2c8cce032..e89154b7a 100644 --- a/crates/format/src/fig/tail_tests.rs +++ b/crates/format/src/fig/tail_tests.rs @@ -666,6 +666,53 @@ fn connectors_without_a_saved_path_follow_their_line_style() { assert!(warnings.iter().any(|w| w.contains("FigCraft's own routing")), "{warnings:?}"); } +/// #1909: a connector end whose magnet is `AUTO` (FigJam picks the side when it draws) or `CENTER` +/// (the end aims at the layer's middle) leaves the side facing the other end, as a board connector +/// drawn here does, whatever `relativePosition` the file kept for it; a named magnet still wins. +#[test] +fn connectors_with_an_automatic_side_leave_the_side_facing_the_target() { + let mut message = tail_message(); + let Kv::Array(nodes) = field_mut(&mut message, "nodeChanges").unwrap() else { panic!() }; + let box_at = |id, name: &str, x| node(id, Some((1, "*")), "RECTANGLE", name, vec![("size", xy(100.0, 100.0)), ("transform", at(x, 600.0))]); + // The ends keep a stale point on the left of A and the right of B, as the reporter's file did. + let end = |node, magnet: &'static str, x| o(vec![("endpointNodeID", g(node)), ("magnet", e(magnet)), ("relativePosition", xy(x, 0.5))]); + let joined = |id, name: &str, style: &'static str, start: &'static str, finish: &'static str| { + node( + id, + Some((1, "+")), + "CONNECTOR", + name, + vec![ + ("strokePaints", arr(vec![solid(0.0, 0.0, 0.0)])), + ("connectorStart", end(60, start, 0.0)), + ("connectorEnd", end(61, finish, 1.0)), + ("connectorLineStyle", e(style)), + ], + ) + }; + nodes.extend([ + box_at(60, "A", 0.0), + box_at(61, "B", 300.0), + joined(62, "Elbow", "ELBOWED", "AUTO", "AUTO"), + joined(63, "Line", "STRAIGHT", "CENTER", "CENTER"), + joined(64, "Curve", "CURVED", "AUTO", "AUTO"), + joined(65, "Named", "ELBOWED", "BOTTOM", "AUTO"), + ]); + let (doc, _) = import(&canvas(&schema(), &message), "Sides").unwrap(); + let ends = |name: &str| -> ((f64, f64), (f64, f64)) { + let world = doc.world_transform(named(&doc, name).id); + let pts: Vec<(f64, f64)> = + network_of(&doc, name).vertices.iter().map(|v| world * figcraft_doc::geom::Point::new(v.x, v.y)).map(|p| (p.x, p.y)).collect(); + (pts[0], pts[pts.len() - 1]) + }; + // From A's right side (facing B) to B's left side (facing A), not from the stale left point. + for name in ["Elbow", "Line", "Curve"] { + assert_eq!(ends(name), ((100.0, 650.0), (300.0, 650.0)), "{name}"); + } + // A named magnet keeps its side: the bottom of A; the automatic end still faces A. + assert_eq!(ends("Named"), ((50.0, 700.0), (300.0, 650.0))); +} + /// A connector with a label but no saved snapshot: a frame holding its line and its label, /// centred on the line's middle, in black when the connector gives no paint. #[test] diff --git a/crates/format/src/fig/tests.rs b/crates/format/src/fig/tests.rs index 2d4a1f7d6..b5c0b5af4 100644 --- a/crates/format/src/fig/tests.rs +++ b/crates/format/src/fig/tests.rs @@ -29,6 +29,7 @@ enum StrokeJoin MITER BEVEL ROUND enum VectorMirror NONE ANGLE ANGLE_AND_LENGTH enum ShapeWithTextType SQUARE ELLIPSE enum ConnectorLineStyle ELBOWED STRAIGHT CURVED +enum ConnectorMagnet NONE AUTO TOP LEFT BOTTOM RIGHT CENTER enum ExpressionFunction ADDITION SUBTRACTION RESOLVE_VARIANT MULTIPLY DIVIDE EQUALS enum NavigationType NAVIGATE OVERLAY enum TransitionType INSTANT_TRANSITION DISSOLVE SMART_ANIMATE @@ -50,7 +51,7 @@ message VariableTarget VariableID id message VariableSetID GUID guid, AssetRef assetRef message ConditionalActions Action[] actions, VariableData condition message VectorData uint vectorNetworkBlob, Vector normalizedSize, NodeChange[] styleOverrideTable -message ConnectorEndpoint GUID endpointNodeID, Vector position, Vector relativePosition +message ConnectorEndpoint GUID endpointNodeID, Vector position, Vector relativePosition, ConnectorMagnet magnet message VariableData AnyValue value, DataType dataType message Paint PaintType type, Color color, float opacity, bool visible, Image image, Matrix transform, ColorStop[] stops, VariableData colorVar, ImageScaleMode imageScaleMode message ParentIndex GUID guid, string position diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 56cc701a2..230942290 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -1,6 +1,6 @@ # File format parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-01 · **Change:** minor (a FigJam connector without a saved snapshot took no stroke and was invisible; its line's paint, weight, cap and dashes now come from the file's generated line record (#1807); a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); imported and pasted text finds an installed family under the other names its fonts give it, and with other case and spacing (#1292); `.fig` export writes colour calculations as the colour they show in each mode and leaves out, with a warning, one that resolves to nothing (#1280); `.fig` import budgets four decoded values per compressed byte instead of one, still within 20M–128M, so dense files within that budget open instead of being refused as having too many values (#574); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; folders, devices and pipes are refused before anything is read (#1114); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); a FigJam `.jam` file opens as a board (#1342); FigJam `.jam` files open like `.fig` files: File ▸ Open, drag and drop, `file.import` and the command line (#1342); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); SVG import draws each pattern tile once per scale, within the layer budget (#1080); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); offline Penpot 2.x import/export (#1143); `.sketch` import checked against Sketch's renders: master backgrounds, symbol clipping, tints before Sketch 64, mask opacity, bitmap fills, image overrides on shapes, stretching stacks, blur radii, colour adjustments, OKLab gradients, text growth, shape group borders (#1389); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); image member names are checked on read, and REST image placeholders get archive-safe keys (#1086); Android Vector Drawable (XML) export; `.fig` export: files the incumbent imports, with component set properties, and grid track sizes at its field ids; Save and auto-save don't replace changes another app made to the open file (#1330); `.sketch` import, best effort, Sketch 48 and newer; the PNG row names ignore overlapping layers and where include bounding box is offered; the Fonts table's missing-font row describes the Missing fonts window; `.figcraft` carries the file kind (boards); `.fig` import: resized instances and variable modes by asset key; atomic saves; auto-save; SVG export clip of nested frames; SVG/PDF export depth refusal (#208); `.fig` export: instance sizes, variables with modes, shared styles, variable-width strokes; `.fig` export: written files checked by opening them in other software; experimental `.fig` export; export and inspect behaviour suite and fixes; .fig import: editable vector networks and more layer kinds; embedded image colour profiles; `.fig` import, best effort; animated GIF fills and TIFF images; last major: created, formats from the installed Figma's Info.plist and help center, ours from source; REST import keeps slot layers and instances' slot content (#792); REST import reads grid track sizes (#465); `.fig` import fidelity from the community batches, budgets for large files, the import report, a `.fig` copy from Save as, paste from another design app; instance layers' size and resizing and Hug on import (#731, #732)) · **Target:** Figma Design (desktop app 126.10.7) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-03 · **Change:** minor (a `.jam` connector end with an `AUTO` or `CENTER` magnet leaves the side facing the other end, not the side its stale saved point named (#1909); a FigJam connector without a saved snapshot took no stroke and was invisible; its line's paint, weight, cap and dashes now come from the file's generated line record (#1807); a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); imported and pasted text finds an installed family under the other names its fonts give it, and with other case and spacing (#1292); `.fig` export writes colour calculations as the colour they show in each mode and leaves out, with a warning, one that resolves to nothing (#1280); `.fig` import budgets four decoded values per compressed byte instead of one, still within 20M–128M, so dense files within that budget open instead of being refused as having too many values (#574); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; folders, devices and pipes are refused before anything is read (#1114); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); a FigJam `.jam` file opens as a board (#1342); FigJam `.jam` files open like `.fig` files: File ▸ Open, drag and drop, `file.import` and the command line (#1342); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); SVG import draws each pattern tile once per scale, within the layer budget (#1080); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); offline Penpot 2.x import/export (#1143); `.sketch` import checked against Sketch's renders: master backgrounds, symbol clipping, tints before Sketch 64, mask opacity, bitmap fills, image overrides on shapes, stretching stacks, blur radii, colour adjustments, OKLab gradients, text growth, shape group borders (#1389); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); image member names are checked on read, and REST image placeholders get archive-safe keys (#1086); Android Vector Drawable (XML) export; `.fig` export: files the incumbent imports, with component set properties, and grid track sizes at its field ids; Save and auto-save don't replace changes another app made to the open file (#1330); `.sketch` import, best effort, Sketch 48 and newer; the PNG row names ignore overlapping layers and where include bounding box is offered; the Fonts table's missing-font row describes the Missing fonts window; `.figcraft` carries the file kind (boards); `.fig` import: resized instances and variable modes by asset key; atomic saves; auto-save; SVG export clip of nested frames; SVG/PDF export depth refusal (#208); `.fig` export: instance sizes, variables with modes, shared styles, variable-width strokes; `.fig` export: written files checked by opening them in other software; experimental `.fig` export; export and inspect behaviour suite and fixes; .fig import: editable vector networks and more layer kinds; embedded image colour profiles; `.fig` import, best effort; animated GIF fills and TIFF images; last major: created, formats from the installed Figma's Info.plist and help center, ours from source; REST import keeps slot layers and instances' slot content (#792); REST import reads grid track sizes (#465); `.fig` import fidelity from the community batches, budgets for large files, the import report, a `.fig` copy from Save as, paste from another design app; instance layers' size and resizing and Hug on import (#731, #732)) · **Target:** Figma Design (desktop app 126.10.7) Every format Figma reads or writes, with FigCraft's support. Sources: `Info.plist` of `/Applications/Figma.app` (document types only; nothing inside the bundle's code was read), Figma's @@ -20,7 +20,7 @@ and prototype interactions are still unchecked there. | `.fig` (Figma Design, `com.figma.document`, `application/x-figma`) | native (cloud; "Save local copy") | **yes, best effort** (`file.open`, `file.import`, drop, CLI, MCP) | **experimental** ([below](#export-to-fig-experimental)) | `.fig` files open (best effort): the zip, its deflate/zstd chunks and the kiwi schema are decoded generically and mapped by field name onto the REST importer, so pages, the layer tree, geometry, paints (styles resolved), strokes, effects, text with styled runs, vectors as editable vector networks with region-specific fill paints (points, curved segments, filled areas with their winding, per-point corner radius and handle mirroring, end caps; outlines when the network is missing or damaged), auto layout (grid included; a flow that records no primary-axis sizing hugs on that axis, an instance that records no auto layout has its main's), constraints, ellipse arcs, boolean operations, components, sets (with their descriptions), instances (expanded from their main with overrides, derived layout and property values; the size and resizing their layers override stay overrides), styles, variables with modes and bindings, prototyping (set-variable, set-variable-mode and conditional actions included) and image fills from the archive come across; sticky notes and shapes with text keep their generated backgrounds, styled text, text paints, saved child bounds and sticky author lines as editable frame children, including saved vector networks without geometry paths, outer fill/stroke outlines when generated geometry is damaged, and outer body text when its generated child is unusable even if an author survives (#1341, #1397); connectors, tables, code blocks, slides and similar layers come in as the closest frames, text layers and vectors, with a warning; anything else is a warning. Since 2026-10-17 (community batches #727, #728): an instance's own identity and the cached library components a file carries, overrides applied by key and order, local text values and instance overrides over a shared text style, grid track sizes (fixed, content-sized, fill), slot content, labels of connectors saved with their drawn path (a static snapshot; the ends aren't live), skip ink, paragraph options and hanging lists, list start numbers, vertical trim, per-point stroke joins, editable text on a path, image adjustments and images carried in the message; since 2026-10-29, style links that name a library style by asset key and version (the file's own copy of it), with override rows above the linking one still winning, and override rows restating a nested level's overrides applied at that level, below the instance's own (#1234), and the line breaks the file saved with a text, followed until an edit or a resize could move one, or where a line would come out more than 3% wider than its box in the fonts at hand (#1236). Budgets come from the file's own size (four decoded values per compressed byte, 20M–128M, lower ceilings on 32-bit targets; the layer cap follows the file's size too), so a 15.4 MB synthetic file with 300,000 layers opens whole; ZIP image reads have a separate total budget of 4 GiB (1 GiB on 32-bit targets) of decompressed ZIP-member bytes containing encoded images, with the 256 MiB per-image cap kept: a member that cannot fit is skipped before its output buffer is allocated, and the import report names the budget and counts skipped images (#1076). Failed reads and invalid image contents still consume the bytes read; a reference used by several layers is read once. This is not a limit on decoded pixels or total import memory; images carried inside the message are unchanged. The file's bytes stay out of the command journal; an import report lists what was left out or changed once the file opens. Elbowed and curved connectors without a saved path are routed as FigCraft's board connectors are (right angles, or one curve, from the sides of the layers they join), and a connector routed here takes its line's paint, weight, cap and dashes from the file's generated line record, as one with a saved snapshot does (#1807). A connector's label without a saved snapshot is kept as text centred on its line, without its background. Not read: table cells beyond their own layers, live style and variable links for vector region fills, variables bound to fields the editor can't bind, video fills. Tested on fixtures generated in code (`crates/format/src/fig/tests.rs`, `tail_tests.rs` and the per-feature `*_tests.rs` beside them, fuzzed), `crates/engine/src/shapebuilder_region_paints_tests.rs`, and by reading back what the export writes; the FigJam report sample from #1341 checked locally only; no representative real-world corpus yet | read tail 5–10, write: checks against real files 5–15 | | `.penpot` (Penpot 2.x ZIP export) | — | **yes, offline** (open, import, drop, CLI, MCP) | **yes, offline** (export, CLI convert) | Editable layers, supported flex/grid layout, components, tokens and prototypes using the existing model. Unsupported layouts retain saved positions and bounded metadata; toggle-overlay and embedded font binaries are reported. Font references remain editable; no downloads. Synthetic regression coverage; live Penpot and cross-platform QA remain open. See [Penpot reference](penpot.md). | further live Penpot and cross-platform QA | | `.sketch` (Sketch 48 and newer) | import (file browser ▸ Import or drop, desktop app too; converted to a Figma file, symbols as components; per the help center) | **yes, best effort** (`file.open`, `file.import`, drop, CLI, MCP; Open With from Finder, Explorer and Linux file managers once installed; recent files show its `previews/preview.png`) | no (out of scope) | zip + JSON read from the public format description; Sketch 43–47 (text as binary property lists) and older (SQLite) files are refused with a message to resave them in a newer Sketch. Pages, artboards as frames with their background, groups; Sketch 2025 and newer: frames (clipping or not) with their style, graphics, stacks as auto layout (direction, gap, alignment, padding, wrap, hug/fill sizing, stretching filling every item across, items ignoring the stack), corners in the style (rounded, smooth with its smoothing; angled, inside square and inside arc as paths), pins and sizing, per-side borders, lists of blurs (progressive background blurs, glass), inner shadows in the shadow list, tints (a graphic's, group's or instance's fill colouring its layers, and colour overrides; from Sketch 64, before which a group's fill draws nothing), text colour and visibility overrides, text sized by its sizing; rectangles with corner radii, ovals, stars and polygons while their points are the generated ones, paths as editable vector networks, shape groups as their shape, as one compound path (children without an operation, by the group's winding rule) or as boolean operations (mixed operations nested from the left); operands' own borders ignored as Sketch does; open paths filled as if closed, edited ovals and rectangles as paths, bitmaps (their image under their style's fills; colour adjustments as image filters with Sketch's tone curve, contrast and then brightness added), slices, hotspots; transforms (rotation, flips after it), resizing constraints; fills (solid, gradients with Sketch's geometry, gradients mixed in OKLab or OKLCH as sRGB stops along the same colours, image patterns), borders (the first enabled border's width and position), shadows, inner shadows, layer, motion and background blurs (Sketch's radius is the standard deviation), opacity and blend modes; clipping masks (an outline mask that shows its own style draws a copy under itself, as Sketch does, and its opacity fades it and what it clips together; alpha masks only mask; broken mask chains wrapped), progressive opacity (Fade) as an alpha mask of its gradient; text with styled runs (UTF-16 ranges), paragraph and vertical alignment, lines placed by Sketch's line spacing behaviour, box sizing, fonts found by their PostScript names among the installed ones (else the family read from the name), variable font axes, Sketch's natural line (ascent and descent rounded, no line gap, a fifth more for classic Mac fonts) for text without a fixed line height; symbols as components (library copies on a page of their own) and instances carrying their masters' layers with overrides (text, nested swaps and hiding, images, also on shapes' image fills, layer and text styles, nested paths), clipping only where the master clips (`clippingBehavior` 1), laid out for their size the way Sketch does it (proportional sharing per pins from format 110, scaling before) and still live; master backgrounds in instances only when the master includes them in both instances and exports, as on Sketch's canvas and renders; Apple's system fonts found under the names designs use, with the platform's tracking kept as letter spacing; shared layer styles as paint (fills, border colours) and effect styles, shared text styles as text styles; Color Variables (also library ones) as colour variables with bindings; prototype links, flow starts, export options, layout and square grids (hidden, as Sketch shows them only in its layout view). Instances of a stack laid out at their size and texts an override changed measured again on open, an auto-width one growing from its aligned edge. Warnings: noise fills, OKLab and OKLCH gradients, motion and zoom blurs (drawn as plain blurs), fonts embedded with their data (not used), Smart Layout (kept as laid out), locked overrides, scaled instances. Tested on fixtures built in code (`crates/format/src/sketch/*_tests.rs`, fuzzed) and locally (`FIGCRAFT_SKETCH_SAMPLES`) on one real Sketch 50 file and the public Apache-2.0 IBM Carbon Design Kit saved by Sketch 68 and 83 (70,000 layers open in ~3 s, debug build; its edition saved by Sketch 47 is refused, as it should be); compared artboard by artboard with Sketch 2026's own renders (`FIGCRAFT_SKETCHTOOL`, black-box): the Sketch 50 file's 73 artboards differ in at most 2.3% of their pixels (0.8% on average) (text metrics, fonts FigCraft doesn't find, antialiasing), Carbon 11's 69 1.1% on average and at most 4.4% (text in IBM Plex, which the file embeds and FigCraft doesn't use yet), a Sketch 64 file's 65 artboards 2.1% on average, a Sketch 2026 showcase file's 16 frames 0.9% on average (at most 1.9%); the rules for master backgrounds, symbol clipping, mask opacity, bitmap fills, image overrides, stretching stacks, blur radii, colour adjustments, gradient interpolation and text growth checked against Sketch's renders of files built for each case (black-box, synthetic) | 5–10 (Smart Layout as auto layout, motion and zoom blurs, several borders of different widths; fonts embedded in the file once `.figcraft` documents can carry fonts: until then they would only last the session). Known limitations: a plain group (not a frame) that fills a stack keeps its layers' size where Sketch stretches them; a font Sketch can't find draws in the installed family's own weight (Sketch falls back to a regular face); text in the system SF Pro comes out a few percent narrower than Sketch's; macOS's reserved system fonts (PingFang) aren't found; brightness past about +0.4 is approximated (image filters can't add); OKLab gradients become sRGB stops (FigCraft gradients mix in sRGB) | -| `.jam` (whiteboards) | native to FigJam | **yes, best effort** (`file.open`, `file.import`, File ▸ Open, drop, CLI, MCP) | no | the same archive as a `.fig` (its canvas header reads `fig-jam.`) through the same reader (#1342): it opens as a board (the file kind; a `.fig` stays a design file), with generated sticky and shape backgrounds and text kept (#1341) as ordinary layers rather than native board objects (see [boards-parity](boards-parity.md)); tables, stamps, code blocks and the like come in as frames with their text and connectors as vectors, with an import note; a layer type the reader doesn't know is left out with a note naming it; writing `.jam` is not supported | — | +| `.jam` (whiteboards) | native to FigJam | **yes, best effort** (`file.open`, `file.import`, File ▸ Open, drop, CLI, MCP) | no | the same archive as a `.fig` (its canvas header reads `fig-jam.`) through the same reader (#1342): it opens as a board (the file kind; a `.fig` stays a design file), with generated sticky and shape backgrounds and text kept (#1341) as ordinary layers rather than native board objects (see [boards-parity](boards-parity.md)); tables, stamps, code blocks and the like come in as frames with their text and connectors as vectors (an end with an `AUTO` or `CENTER` magnet leaves the side facing the other end, #1909), with an import note; a layer type the reader doesn't know is left out with a note naming it; writing `.jam` is not supported | — | | `.deck` (Slides) | native to other Figma products | no | no | out of scope | — | | REST API file JSON (`GET /v1/files/:key`) + local variables JSON + `images/` folder | the API's output | **yes** (`file.open`, `file.import`, CLI) | no | pages, layer tree, geometry, paints, strokes, effects, text runs, vectors, auto layout (sizing modes left out read as hug, as documented; grid track sizes from `gridColumnsSizing` / `gridRowsSizing`: px, fr, auto, `minmax(0, 1fr)`, `repeat()`), constraints, grids, components, sets, instances with overrides (sizes and resizing included), component properties, slots (`SLOT` layers bound to their slot property; an instance's slot keeps its content as the instance's own unless its property value is the main's default content; slot limits and preferred components are warnings), styles, prototyping (incl. conditionals and variable modes), variables with modes, aliases, scopes and bindings, image adjustments (the same tint sign as `.fig`); the import report after opening; warnings for what's skipped (video triggers and actions, modifier keys). Unit tests in `crates/format/src/rest/*_tests.rs` | — | | `.figcraft` (ours: zip of `document.json` + images, versions inside) | — | yes | yes | streamed JSON, 50k layers save ~0.09 s / load ~0.16 s (`cargo xtask bench`); old files keep opening (`large_tests.rs`); image members are `images/`, and a key that can't be one — path text, a space, over 128 chars — is left out with a complaint instead of loaded (`image_tests`); saves write a unique staging file and rename it into place (#284); optional auto-save of files with a path (`pref.autoSave`, #305); Save and auto-save refuse to write over a file another app (figcraft-cli, say) changed since it was opened or saved here, judged by its size and modification time: Revert to saved loads those changes, Save as keeps both, `file.save {overwrite: true}` replaces them (#1330); `kind: "board"` marks a board (left out for design files, so files from before boards are design files; the home screen reads it for the file's mark); board objects keep their `board` metadata on the layer; Dev Mode measurements are kept on the layer they start from (`measurements: [{to} | {side}]`, left out when there are none, so older files open with none) | — | @@ -187,6 +187,7 @@ source paint coordinates. | Date | Change | Summary | |---|---|---| +| 2026-11-03 | patch | M6, #1909: `.jam` import: a connector end whose magnet is `AUTO` (FigJam picks the side when it draws) or `CENTER` (the end aims at the layer's middle) left the side its stale `relativePosition` named, the left one in the reporter's file, so the connectors looped behind their shape or crossed it. It now leaves the side facing the other end, as a board connector drawn here does (`Side::Auto`), for straight, elbowed and curved connectors alike; a named magnet (`TOP`, `RIGHT`, `BOTTOM`, `LEFT`) is unchanged, and an end without a magnet still takes the edge its point lies on. The Plugin API lists the magnets (`ConnectorEndpoint.magnet`: "Which side of the node it attaches to"; NONE, AUTO, TOP, LEFT, BOTTOM, RIGHT, CENTER; "Straight connectors may use only CENTER or NONE magnets"). Test: `connectors_with_an_automatic_side_leave_the_side_facing_the_target`. Numbers unchanged. | | 2026-11-01 | patch | `.fig` and `.jam` import: a connector without a saved snapshot (elbowed and curved ones are routed here) took no stroke, so it was invisible (#1807); its line's paint, weight, cap and dashes now come from the file's generated line record, as a saved snapshot's do, and the connector's own values, when it has any, win. Test: `fig::connector_label_tests::a_routed_connector_takes_its_line_style_from_the_generated_record`. Numbers unchanged | | 2026-10-31 | patch | M4: Dash and Custom strokes have a Dash cap (None, Round, Square) in the advanced stroke settings and `node.set {dashCap}`, on both ends of every dash on the canvas and in PNG, PDF and SVG. Unset, dashes keep taking the end point caps, so older files look the same; the saved file writes it only when set. Numbers unchanged | | 2026-10-30 | minor | `.fig` import: a connector's label without a saved snapshot was skipped; now the connector imports as a frame holding its line and the label, as a connector with a saved snapshot does, the label centred on the line's middle by length (in a 200-wide box, laid out again with the fonts at hand), in the connector's fill paints or black. Its background isn't known without the snapshot and is left out. Not checked on real files. Test: `fig::tests::tail::a_labelled_connector_without_a_snapshot_keeps_its_label` | From ac184c1ca8af9fde615a11f239ac25b376768e72 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:29:20 +0000 Subject: [PATCH 43/68] fix(engine): refuse linked files when publishing a plugin folder The assets of a plugin folder were read through whatever links they pointed at, so a folder handed to the publisher could put any file the publisher can read into the bundle the directory then serves to everyone. A linked asset, or a linked assets folder, is refused by name before anything is sent. --- crates/engine/src/automation/file_access.rs | 6 +++++ .../engine/src/extensions/plugin_directory.rs | 21 ++++++++++++---- crates/engine/src/plugin_directory_tests.rs | 25 +++++++++++++++++++ 3 files changed, 47 insertions(+), 5 deletions(-) diff --git a/crates/engine/src/automation/file_access.rs b/crates/engine/src/automation/file_access.rs index b40a92f79..901966166 100644 --- a/crates/engine/src/automation/file_access.rs +++ b/crates/engine/src/automation/file_access.rs @@ -292,6 +292,12 @@ pub fn open(path: impl AsRef) -> Result { std::fs::File::open(allow(path, Access::Read)?).map_err(io(path)) } +/// What the file system says about `path` itself (a link is not followed). +pub fn link_metadata(path: impl AsRef) -> Result { + let path = path.as_ref(); + std::fs::symlink_metadata(allow(path, Access::Read)?).map_err(io(path)) +} + /// What the file system says about `path` (links followed). pub fn metadata(path: impl AsRef) -> Result { let path = path.as_ref(); diff --git a/crates/engine/src/extensions/plugin_directory.rs b/crates/engine/src/extensions/plugin_directory.rs index 2f721feae..5fafb7ee4 100644 --- a/crates/engine/src/extensions/plugin_directory.rs +++ b/crates/engine/src/extensions/plugin_directory.rs @@ -221,12 +221,23 @@ fn bundle_from_disk(cmd: &str, path: &str) -> Result { let wasm = module_file(&file, &m)?; let mut assets = Vec::new(); let dir = file.parent().map(|d| d.join(ASSETS)); + // Links are not followed: a folder handed to the publisher could otherwise put any file the + // publisher can read (a key, a token) in the bundle the directory then serves to everyone. + let linked = |p: &std::path::Path| crate::file_access::link_metadata(p).is_ok_and(|m| m.is_symlink()); + if dir.as_ref().is_some_and(|d| linked(d)) { + return Err(bad(cmd, format!("the {ASSETS} folder is a link: only files inside the plugin's folder are published"))); + } if let Some(entries) = dir.as_ref().and_then(|d| crate::file_access::read_dir(d).ok()) { - let mut names: Vec<(String, std::path::PathBuf)> = entries - .into_iter() - .filter(|p| crate::file_access::metadata(p).is_ok_and(|m| m.is_file())) - .map(|p| (p.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default(), p)) - .collect(); + let mut names: Vec<(String, std::path::PathBuf)> = Vec::new(); + for p in entries { + let name = p.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default(); + if linked(&p) { + return Err(bad(cmd, format!("{ASSETS}/{name} is a link: only files inside the plugin's folder are published"))); + } + if crate::file_access::link_metadata(&p).is_ok_and(|m| m.is_file()) { + names.push((name, p)); + } + } names.sort(); if names.len() > MAX_ASSETS { return Err(bad(cmd, format!("a plugin's assets folder holds at most {MAX_ASSETS} files"))); diff --git a/crates/engine/src/plugin_directory_tests.rs b/crates/engine/src/plugin_directory_tests.rs index fa4d3d4cc..255232a7a 100644 --- a/crates/engine/src/plugin_directory_tests.rs +++ b/crates/engine/src/plugin_directory_tests.rs @@ -252,3 +252,28 @@ fn publishing_sends_a_checked_folder() { assert_eq!(r["id"], ID); let _ = std::fs::remove_dir_all(&dir); } + +#[cfg(unix)] +#[test] +fn publishing_refuses_a_linked_asset_instead_of_bundling_what_it_points_at() { + let (mut s, d) = session(); + let dir = temp("publish-link"); + std::fs::create_dir_all(dir.join("build")).unwrap(); + std::fs::create_dir_all(dir.join("assets")).unwrap(); + std::fs::write(dir.join("build").join("tiny.wasm"), wasm()).unwrap(); + std::fs::write(dir.join("figcraft-plugin.json"), json!({"id": ID, "name": "Tiny", "version": "1.0.0", "main": "build/tiny.wasm"}).to_string()) + .unwrap(); + // A private file outside the plugin folder, reached through a link in its assets. + let secret = temp("publish-link-secret").join("token.txt"); + std::fs::write(&secret, b"per-user-secret").unwrap(); + std::os::unix::fs::symlink(&secret, dir.join("assets").join("notes.txt")).unwrap(); + let e = s.execute("plugin.directory.publish", &json!({"path": dir.to_string_lossy(), "server": "ws://h:1/"})).unwrap_err().to_string(); + assert!(e.contains("link"), "{e}"); + assert!(d.lock().unwrap().plugins.is_empty(), "nothing was sent"); + // The whole assets folder as a link is refused the same way. + std::fs::remove_file(dir.join("assets").join("notes.txt")).unwrap(); + std::fs::remove_dir(dir.join("assets")).unwrap(); + std::os::unix::fs::symlink(secret.parent().unwrap(), dir.join("assets")).unwrap(); + let e = s.execute("plugin.directory.publish", &json!({"path": dir.to_string_lossy(), "server": "ws://h:1/"})).unwrap_err().to_string(); + assert!(e.contains("link"), "{e}"); +} From 411b16931b1c67902ad1e363644e9f38366ffaa8 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:33:49 +0000 Subject: [PATCH 44/68] fix(geom): keep arc subdivision bounded whatever the radius kurbo turns an arc into cubics by radius divided by tolerance, so the fixed 0.01 let an ellipse, polygon corner, rounded rectangle, per-side stroke corner or SVG arc with a radius like 1e300 ask for more cubics than memory holds before any size check saw the geometry. Arcs now use a tolerance that scales with the radius, and SVG path data from documents, commands and imports is refused before parsing when a number passes 1e9. --- crates/doc/src/text.rs | 2 +- crates/engine/src/cmd/create.rs | 6 ++- crates/format/src/penpot.rs | 2 +- crates/format/src/rest.rs | 2 +- crates/geom/src/lib.rs | 74 +++++++++++++++++++++++++++++---- crates/geom/src/tests.rs | 46 ++++++++++++++++++++ crates/pathops/src/lib.rs | 3 +- 7 files changed, 122 insertions(+), 13 deletions(-) diff --git a/crates/doc/src/text.rs b/crates/doc/src/text.rs index 0c41d3c9a..1eb19d714 100644 --- a/crates/doc/src/text.rs +++ b/crates/doc/src/text.rs @@ -513,7 +513,7 @@ impl TextPath { /// The path (empty when `d` doesn't parse). pub fn path(&self) -> figcraft_geom::BezPath { - figcraft_geom::BezPath::from_svg(&self.d).unwrap_or_default() + figcraft_geom::svg_path(&self.d).unwrap_or_default() } /// The start offset clamped into 0..1 (NaN: 0). diff --git a/crates/engine/src/cmd/create.rs b/crates/engine/src/cmd/create.rs index 9caf4551a..21f758c75 100644 --- a/crates/engine/src/cmd/create.rs +++ b/crates/engine/src/cmd/create.rs @@ -194,7 +194,7 @@ fn create_kind(s: &mut Session, p: &Value, t: &str) -> Result { /// Parse SVG path data (`M L H V C S Q T A Z`, absolute and relative) into a bezier path. pub fn parse_path_data(d: &str) -> Option { - figcraft_geom::BezPath::from_svg(d).ok() + figcraft_geom::svg_path(d).ok() } /// A vector's geometry made from SVG path data (see [`path_network`]). @@ -213,7 +213,9 @@ pub(crate) struct PathShape { pub(crate) fn path_network(cmd: &str, d: &str, width: Option, height: Option) -> Result { use figcraft_geom::Shape; let empty = || bad(cmd, "`path` draws nothing: a vector needs a visible line or area"); - let mut path = parse_path_data(d).ok_or_else(|| bad(cmd, "`path` is not valid SVG path data"))?; + let mut path = figcraft_geom::svg_path(d).map_err(|e| { + if e.contains("too large") { bad(cmd, "`path` has coordinates too large to draw") } else { bad(cmd, "`path` is not valid SVG path data") } + })?; let bb = path.bounding_box(); if !(bb.x0.is_finite() && bb.y0.is_finite() && bb.width().is_finite() && bb.height().is_finite()) { return Err(bad(cmd, "`path` has coordinates too large to draw")); diff --git a/crates/format/src/penpot.rs b/crates/format/src/penpot.rs index 6cd8fe53c..2ad259394 100644 --- a/crates/format/src/penpot.rs +++ b/crates/format/src/penpot.rs @@ -3951,7 +3951,7 @@ fn vector_path(v: &Value, warnings: &mut Vec) -> Option { /// Parse supported vector commands and report unrepresentable geometry. fn vector_bezpath(v: &Value, warnings: &mut Vec) -> Option { if let Some(d) = v.get("content").and_then(Value::as_str) { - let path = BezPath::from_svg(d).ok().filter(|p| !p.elements().is_empty())?; + let path = figcraft_doc::geom::svg_path(d).ok().filter(|p| !p.elements().is_empty())?; let origin = Affine::translate((-geometry(v, "x", 0.0), -geometry(v, "y", 0.0))); return Some(origin * path); } diff --git a/crates/format/src/rest.rs b/crates/format/src/rest.rs index 4604b73a6..818b06714 100644 --- a/crates/format/src/rest.rs +++ b/crates/format/src/rest.rs @@ -843,7 +843,7 @@ impl<'a> Ctx<'a> { self.warn("very long vector paths were skipped"); continue; } - match BezPath::from_svg(d) { + match figcraft_doc::geom::svg_path(d) { Ok(bp) if sane(&bp) && out.elements().len() + bp.elements().len() <= MAX_PATH_ELEMENTS => { winding.get_or_insert(if text(p, "windingRule") == Some("EVENODD") { WindingRule::EvenOdd } else { WindingRule::NonZero }); out.extend(bp); diff --git a/crates/geom/src/lib.rs b/crates/geom/src/lib.rs index 696a02e92..9b04c29ce 100644 --- a/crates/geom/src/lib.rs +++ b/crates/geom/src/lib.rs @@ -18,6 +18,62 @@ pub use transform::*; /// Corner radii in clockwise order from the top-left: `[tl, tr, br, bl]`. pub type Radii = [f64; 4]; +/// The tolerance an arc of radius `r` is turned into cubics with: a hundredth of a unit, or a +/// millionth of the radius once that is more. kurbo's cubic count grows with radius ÷ tolerance, +/// so a fixed tolerance let a radius of 1e300 ask for more cubics than memory holds. +pub fn arc_tolerance(r: f64) -> f64 { + // An infinite radius (finite inputs can overflow on the way, 1e300 squared) gets an infinite + // tolerance: kurbo's count is then NaN, which it floors to its minimum of a few cubics. + if r.is_finite() { (r.abs() * 1e-6).max(0.01) } else { f64::INFINITY } +} + +/// Largest coordinate, radius or other number SVG path data may carry ([`svg_path`]). +pub const MAX_SVG_COORD: f64 = 1e9; + +/// `d` (SVG path data) as a path. A number past [`MAX_SVG_COORD`] is refused before parsing: the +/// parser turns an arc into cubics by its radius at a fixed tolerance, so a radius of 1e300 would +/// be unbounded work and memory on the way to geometry that is refused anyway. +pub fn svg_path(d: &str) -> Result { + if number_past(d, MAX_SVG_COORD) { + return Err(format!("path data holds a number too large (past {MAX_SVG_COORD:e})")); + } + BezPath::from_svg(d).map_err(|e| e.to_string()) +} + +/// Whether a number in SVG path data `d` lies past ±`max` (or isn't finite). Numbers are split as +/// the SVG grammar does (`1-2` and `.5.5` are two each; `1e-3` is one). +fn number_past(d: &str, max: f64) -> bool { + fn big(cur: &mut String, max: f64) -> bool { + let big = cur.parse::().is_ok_and(|v| v.is_nan() || v.abs() > max); + cur.clear(); + big + } + let (mut cur, mut dot, mut exp) = (String::new(), false, false); + for c in d.chars() { + let continues = match c { + '0'..='9' => true, + '.' => !dot && !exp, + 'e' | 'E' => !exp && cur.chars().any(|c| c.is_ascii_digit()), + '+' | '-' => cur.ends_with(['e', 'E']), + _ => false, + }; + if continues { + dot |= c == '.'; + exp |= matches!(c, 'e' | 'E'); + cur.push(c); + continue; + } + if big(&mut cur, max) { + return true; + } + (dot, exp) = (c == '.', false); + if matches!(c, '+' | '-' | '.') { + cur.push(c); + } + } + big(&mut cur, max) +} + fn finite(v: f64) -> f64 { if v.is_finite() { v } else { 0.0 } } @@ -126,7 +182,7 @@ fn append_corner(path: &mut BezPath, corner: Point, din: Vec2, dout: Vec2, prof: } if sweep.abs() > 1e-9 { let arc = kurbo::Arc::new(center, (r, r), a0, sweep, 0.0); - arc.to_cubic_beziers(0.01, |p1, p2, p| path.curve_to(p1, p2, p)); + arc.to_cubic_beziers(arc_tolerance(r), |p1, p2, p| path.curve_to(p1, p2, p)); } let end = at(0.0, p); if a + b + c > 1e-9 { @@ -297,7 +353,7 @@ pub fn smoothed_polygon(points: &[Point], radius: f64, smoothing: f64) -> BezPat sweep -= TAU; } if sweep.abs() > 1e-9 { - kurbo::Arc::new(center, (r, r), a0, sweep, 0.0).to_cubic_beziers(0.01, |p1, p2, q| path.curve_to(p1, p2, q)); + kurbo::Arc::new(center, (r, r), a0, sweep, 0.0).to_cubic_beziers(arc_tolerance(r), |p1, p2, q| path.curve_to(p1, p2, q)); } let end = at(u2, p, 0.0); if a + b + c > 1e-9 { @@ -334,25 +390,29 @@ pub fn ellipse(width: f64, height: f64, start: f64, sweep: f64, inner: f64) -> B let start = finite(start); let inner = finite(inner).clamp(0.0, 1.0); let full = full_sweep(sweep); + let tol = arc_tolerance(rx.max(ry)); let mut path = BezPath::new(); + // A whole turn as an arc with these radii: kurbo's `Ellipse` recovers its radii from an + // affine map, which overflows to infinity for radii near f64's limit (and infinite cubics). + let whole = |rx: f64, ry: f64| kurbo::Arc::new(c, (rx, ry), 0.0, TAU, 0.0); if full && inner <= 0.0 { - return kurbo::Ellipse::new(c, (rx, ry), 0.0).to_path(0.01); + return whole(rx, ry).to_path(tol); } if full { // A ring: outer clockwise, inner counter-clockwise. - path.extend(kurbo::Ellipse::new(c, (rx, ry), 0.0).path_elements(0.01)); - let inner_path = kurbo::Ellipse::new(c, (rx * inner, ry * inner), 0.0).to_path(0.01); + path.extend(whole(rx, ry).path_elements(tol)); + let inner_path = whole(rx * inner, ry * inner).to_path(tol); path.extend(inner_path.reverse_subpaths()); return path; } let outer = kurbo::Arc::new(c, (rx, ry), start, sweep, 0.0); path.move_to(c + Vec2::new(rx * start.cos(), ry * start.sin())); - outer.to_cubic_beziers(0.01, |p1, p2, p| path.curve_to(p1, p2, p)); + outer.to_cubic_beziers(tol, |p1, p2, p| path.curve_to(p1, p2, p)); if inner > 0.0 { let end = start + sweep; path.line_to(c + Vec2::new(rx * inner * end.cos(), ry * inner * end.sin())); let back = kurbo::Arc::new(c, (rx * inner, ry * inner), end, -sweep, 0.0); - back.to_cubic_beziers(0.01, |p1, p2, p| path.curve_to(p1, p2, p)); + back.to_cubic_beziers(tol, |p1, p2, p| path.curve_to(p1, p2, p)); } else { path.line_to(c); } diff --git a/crates/geom/src/tests.rs b/crates/geom/src/tests.rs index 37e6ccab7..410e24bb9 100644 --- a/crates/geom/src/tests.rs +++ b/crates/geom/src/tests.rs @@ -177,3 +177,49 @@ fn reverse_subpaths_preserves_open_and_closed() { let r = ::reverse_subpaths(&closed); assert!(matches!(r.elements().last(), Some(kurbo::PathEl::ClosePath)), "{:?}", r.elements()); } + +#[test] +fn a_huge_ellipse_arc_is_a_few_cubics() { + let big = ellipse(1e300, 1e300, 0.3, 2.0, 0.5); + assert!(big.elements().len() < 200, "{}", big.elements().len()); +} + +#[test] +fn a_huge_ring_is_a_few_cubics() { + let ring = ellipse(1e300, 1e300, 0.0, TAU, 0.5); + assert!(ring.elements().len() < 200, "{}", ring.elements().len()); +} + +#[test] +fn a_huge_smoothed_star_is_a_few_cubics() { + let star = smoothed_polygon(&star_points(1e300, 1e300, 5, 0.5), 1e299, 0.5); + assert!(star.elements().len() < 400, "{}", star.elements().len()); +} + +#[test] +fn a_huge_rounded_rect_is_a_few_cubics() { + let rect = rounded_rect(1e300, 1e300, [1e299; 4], 0.0); + assert!(rect.elements().len() < 100, "{}", rect.elements().len()); +} + +#[test] +fn an_infinite_radius_is_a_few_cubics() { + let mut n = 0; + kurbo::Arc::new((0.0, 0.0), (f64::INFINITY, 1.0), 0.0, 1.0, 0.0).to_cubic_beziers(arc_tolerance(f64::INFINITY), |_, _, _| n += 1); + assert!(n < 16, "{n}"); +} + +#[test] +fn svg_path_refuses_numbers_past_the_limit_before_parsing() { + let start = std::time::Instant::now(); + for d in ["M0 0 A1e300 1e300 0 0 1 1 1", "M0 0A1e300-1e300 0 0 1 1 1", "M 0 0 L 1e10 5", "M0 0L-2e9.5 0", "M0 0 L 1e999 0"] { + assert!(svg_path(d).is_err(), "{d}"); + } + assert!(start.elapsed() < std::time::Duration::from_secs(2), "{:?}", start.elapsed()); + for d in ["M0 0 L 1e9 5 A 5 5 0 0 1 10 10 Z", "M0 0 L-2.5 0.5 L1e-3 -4e2 Z", "M10,20 l1,-2.5e+1"] { + assert!(svg_path(d).is_ok(), "{d}"); + } + assert!(!number_past("M0 0L-2.5.5 1e-3-4e2z", 1e3)); + assert!(number_past("M0 0L-2.5.5 1e-3-4e3z", 1e3)); + assert!(number_past("M.5.5e10", 1e3)); +} diff --git a/crates/pathops/src/lib.rs b/crates/pathops/src/lib.rs index e69cb9bb1..a939d2522 100644 --- a/crates/pathops/src/lib.rs +++ b/crates/pathops/src/lib.rs @@ -617,7 +617,8 @@ fn elliptical_rect(r: figcraft_geom::Rect, [tl, tr, br, bl]: [(f64, f64); 4]) -> if rx > 0.0 && ry > 0.0 { let c = Point::new(corner.x + sx * rx, corner.y + sy * ry); p.line_to((c.x + rx * start.cos(), c.y + ry * start.sin())); - kurbo::Arc::new(c, (rx, ry), start, FRAC_PI_2, 0.0).to_cubic_beziers(0.01, |a, b, e| p.curve_to(a, b, e)); + kurbo::Arc::new(c, (rx, ry), start, FRAC_PI_2, 0.0) + .to_cubic_beziers(figcraft_geom::arc_tolerance(rx.max(ry)), |a, b, e| p.curve_to(a, b, e)); } else { p.line_to(corner); } From 02db900cc81e0b57c6861beded522c33a156f2a6 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Tue, 3 Nov 2026 04:02:53 +0000 Subject: [PATCH 45/68] fix(engine): keep plugins out of branches, saved versions and library links A read-only plugin could archive, merge, create or update a branch: branch state lives beside the document, so neither the command's history flag nor the document Arc check saw the write. Any plugin could read a saved version through dev.compare's version parameter although version.* is denied, and library.list handed plugins each library's path, which for a server library is the share link with its token. --- crates/engine/src/doc_list_paths_tests.rs | 17 +++++++++ crates/engine/src/extensions/plugins.rs | 43 ++++++++++++++++++++--- 2 files changed, 56 insertions(+), 4 deletions(-) diff --git a/crates/engine/src/doc_list_paths_tests.rs b/crates/engine/src/doc_list_paths_tests.rs index 0c62a18dd..f69941919 100644 --- a/crates/engine/src/doc_list_paths_tests.rs +++ b/crates/engine/src/doc_list_paths_tests.rs @@ -46,3 +46,20 @@ fn a_plugin_gets_names_but_no_paths() { assert!(out.contains("Front"), "{out}"); assert!(!out.contains(SECRET) && !out.contains("path"), "{out}"); } + +#[test] +fn a_plugin_gets_library_names_but_not_their_links() { + const LINK: &str = "ws://tracker.example:9/?file=f&token=per-file-secret"; + let mut s = Session::new(); + s.doc_mut().unwrap().libraries_mut().enabled.push(figcraft_doc::LibraryLink { + id: "lib".into(), + name: "Kit".into(), + path: LINK.into(), + version: 3, + }); + let tail = "(call $set_output (i32.const 40000) (call $reply_read (i32.const 40000) (i32.const 20000))) (return (i32.const 0))"; + install(&mut s, manifest("org.test.libs", "read", &[]), &script(&[("library.list", json!({}))], OnRefusal::Fail, tail)); + let out = ex(&mut s, "plugin.run", json!({"id": "org.test.libs"}))["output"].to_string(); + assert!(out.contains("Kit"), "{out}"); + assert!(!out.contains("per-file-secret") && !out.contains("\\\"path\\\""), "{out}"); +} diff --git a/crates/engine/src/extensions/plugins.rs b/crates/engine/src/extensions/plugins.rs index 2b1094306..78044ee71 100644 --- a/crates/engine/src/extensions/plugins.rs +++ b/crates/engine/src/extensions/plugins.rs @@ -170,12 +170,21 @@ fn refusal(m: &Manifest, command: &str, params: &Value) -> Option { if command == "variable.import" && get(params, "variables").and_then(Value::as_str).is_some_and(|t| !t.trim_start().starts_with('{')) { return Some("plugins can't read files: pass the variables JSON itself".into()); } + // A saved version is the file's history, which plugins can't read (`version.` is denied). + if command == "dev.compare" && get(params, "version").is_some_and(|v| !v.is_null()) { + return Some("plugins can't read saved versions: leave out `version`".into()); + } if !m.permissions.allows(command) { return Some(format!("`{command}` isn't in the commands {} asked permission for", m.name)); } if m.permissions.access == Access::Read && find_command(command).is_some_and(|c| c.history) { return Some(format!("`{command}` edits the document, and {} may only read it", m.name)); } + // Branches live beside the document (not in its undo history or its `Arc`), so the write + // checks below don't see them change. + if m.permissions.access == Access::Read && matches!(command, "branch.create" | "branch.updateFromMain" | "branch.merge" | "branch.archive") { + return Some(format!("`{command}` changes the file's branches, and {} may only read it", m.name)); + } None } @@ -253,10 +262,19 @@ impl figcraft_plugin::Host for EngineHost<'_> { Ok(v) }); r.map(|mut v| { - // A plugin gets the open files' names, not where they are on disk (#1117). - if command == "doc.list" { - for e in v.as_array_mut().into_iter().flatten().filter_map(Value::as_object_mut) { - e.remove("path"); + // A plugin gets the open files' and libraries' names, not where they are on disk or + // the share links (with their tokens) that reach them (#1117). + if matches!(command, "doc.list" | "library.list") { + // `doc.list` is a list; `library.list` keeps its list under `libraries`. + let list = if command == "library.list" { v.get_mut("libraries") } else { Some(&mut v) }; + for e in list.and_then(Value::as_array_mut).into_iter().flatten().filter_map(Value::as_object_mut) { + // An error may quote the path too. + if let Some(Value::String(path)) = e.remove("path") + && !path.is_empty() + && let Some(Value::String(err)) = e.get_mut("error") + { + *err = err.replace(&path, "the library"); + } } } v.to_string() @@ -698,6 +716,23 @@ mod refusal_tests { let r = refusal(&m, "library.publishToServer", &json!({})); assert!(r.is_some(), "library.publishToServer uploads the document and must be refused"); } + + #[test] + fn read_only_plugin_cannot_change_branches() { + let m = Manifest::parse(r#"{"id":"x.y","name":"X","main":"plugin.wasm"}"#).unwrap(); + for cmd in ["branch.archive", "branch.updateFromMain", "branch.merge", "branch.create"] { + assert!(refusal(&m, cmd, &json!({})).is_some(), "{cmd} changes persisted branch state"); + } + assert!(refusal(&m, "branch.list", &json!({})).is_none()); + } + + #[test] + fn plugins_cannot_compare_against_a_saved_version() { + let m = Manifest::parse(r#"{"id":"x.y","name":"X","main":"plugin.wasm","permissions":{"access":"write"}}"#).unwrap(); + assert!(refusal(&m, "dev.compare", &json!({"version": "v1"})).is_some()); + assert!(refusal(&m, "dev.compare", &json!({"version": null})).is_none()); + assert!(refusal(&m, "dev.compare", &json!({})).is_none()); + } } #[cfg(test)] From 4cd7313ca2ccfaa6a71308b03c8f5ad472d7bf6a Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Wed, 4 Nov 2026 00:20:16 +0000 Subject: [PATCH 46/68] address review: give plugins a fixed message for library failures --- crates/engine/src/doc_list_paths_tests.rs | 17 +++++++++++++++++ crates/engine/src/extensions/plugins.rs | 22 +++++++++++++--------- 2 files changed, 30 insertions(+), 9 deletions(-) diff --git a/crates/engine/src/doc_list_paths_tests.rs b/crates/engine/src/doc_list_paths_tests.rs index f69941919..0d73d0736 100644 --- a/crates/engine/src/doc_list_paths_tests.rs +++ b/crates/engine/src/doc_list_paths_tests.rs @@ -63,3 +63,20 @@ fn a_plugin_gets_library_names_but_not_their_links() { assert!(out.contains("Kit"), "{out}"); assert!(!out.contains("per-file-secret") && !out.contains("\\\"path\\\""), "{out}"); } + +#[test] +fn a_plugin_gets_a_fixed_message_for_library_update_failures() { + const LINK: &str = "/home/someone/private/kits/kit.figcraft"; + let mut s = Session::new(); + s.doc_mut().unwrap().libraries_mut().enabled.push(figcraft_doc::LibraryLink { + id: "lib".into(), + name: "Kit".into(), + path: LINK.into(), + version: 3, + }); + let tail = "(call $set_output (i32.const 40000) (call $reply_read (i32.const 40000) (i32.const 20000))) (return (i32.const 0))"; + install(&mut s, manifest("org.test.upd", "read", &[]), &script(&[("library.updates", json!({}))], OnRefusal::Fail, tail)); + let out = ex(&mut s, "plugin.run", json!({"id": "org.test.upd"}))["output"].to_string(); + assert!(out.contains("could not be read"), "{out}"); + assert!(!out.contains("someone") && !out.contains("private"), "{out}"); +} diff --git a/crates/engine/src/extensions/plugins.rs b/crates/engine/src/extensions/plugins.rs index 78044ee71..7677a9b7d 100644 --- a/crates/engine/src/extensions/plugins.rs +++ b/crates/engine/src/extensions/plugins.rs @@ -264,16 +264,20 @@ impl figcraft_plugin::Host for EngineHost<'_> { r.map(|mut v| { // A plugin gets the open files' and libraries' names, not where they are on disk or // the share links (with their tokens) that reach them (#1117). - if matches!(command, "doc.list" | "library.list") { - // `doc.list` is a list; `library.list` keeps its list under `libraries`. - let list = if command == "library.list" { v.get_mut("libraries") } else { Some(&mut v) }; + if matches!(command, "doc.list" | "library.list" | "library.updates") { + // `doc.list` is a list; `library.list` keeps its list under `libraries`, and + // `library.updates` its failures under `errors`. + let list = match command { + "library.list" => v.get_mut("libraries"), + "library.updates" => v.get_mut("errors"), + _ => Some(&mut v), + }; for e in list.and_then(Value::as_array_mut).into_iter().flatten().filter_map(Value::as_object_mut) { - // An error may quote the path too. - if let Some(Value::String(path)) = e.remove("path") - && !path.is_empty() - && let Some(Value::String(err)) = e.get_mut("error") - { - *err = err.replace(&path, "the library"); + e.remove("path"); + // A failure's text may quote the path, a token or another form of it: the + // plugin gets a fixed message. + if let Some(err) = e.get_mut("error").filter(|v| v.is_string()) { + *err = json!("the library could not be read"); } } } From bda7ca910d287663322f7bf932094636ae4f7712 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Wed, 4 Nov 2026 01:52:02 -0500 Subject: [PATCH 47/68] M6: a FigJam elbow connector saved with its path keeps it on import (#1910) The `.jam` importer routed every elbowed connector itself, so one drawn around a layer by hand in FigJam came in routed through it. FigJam saves the path as `connectorControlPoints`: one per run between the first and the last, each a point on its run (in the connector's parent's coordinates) with the run's axis; the first run leaves the start's side and the last arrives at the end's. They become the `ConnectorPath::Runs` a board connector reshaped by hand has, walked by `figcraft_doc::route_along`, so the path is kept exactly. Points that don't make such a path (off both axes, two runs the same way in a row, a first or last run sideways to its side, more runs than a hand could make) leave the connector to the router as before, and only connectors routed here count in the "own routing" note. `figcraft_doc::attach_points` and `MAX_RUNS` are exported for it. Docs: file-format-parity.md, boards-parity.md. Co-Authored-By: Claude Fable 5.1 --- crates/doc/src/board_route.rs | 11 +++- crates/doc/src/lib.rs | 2 +- crates/format/src/fig/map/connector.rs | 50 +++++++++++++++-- crates/format/src/fig/tail_tests.rs | 77 ++++++++++++++++++++++++++ crates/format/src/fig/tests.rs | 3 +- docs/boards-parity.md | 2 +- docs/file-format-parity.md | 7 ++- 7 files changed, 140 insertions(+), 12 deletions(-) diff --git a/crates/doc/src/board_route.rs b/crates/doc/src/board_route.rs index 1aa45c810..38efbef9b 100644 --- a/crates/doc/src/board_route.rs +++ b/crates/doc/src/board_route.rs @@ -66,6 +66,12 @@ pub fn attached_sides(from: RouteEnd, to: RouteEnd) -> (Option, Option (Point, Point) { + (attach(from, to.centre()).0, attach(to, from.centre()).0) +} + /// The route's path handles: one for each run of an elbow and one for a curve, with the portion /// of the path each moves and where it sits. pub fn path_handles(pts: &[Point], routing: Routing) -> Vec<(usize, Point)> { @@ -90,8 +96,9 @@ pub fn reshaped(from: RouteEnd, to: RouteEnd, routing: Routing, path: Option<&Co } } -/// A path of more runs than this can't be made by hand: [`reshaped`] refuses another. -const MAX_RUNS: usize = 64; +/// A path of more runs than this can't be made by hand: [`reshaped`] refuses another, and an +/// importer leaves a saved one to the router. +pub const MAX_RUNS: usize = 64; /// The runs of the right-angled route `pts` with run `portion` moved to `p`. fn reshaped_runs(pts: &[Point], portion: usize, p: Point) -> Option { diff --git a/crates/doc/src/lib.rs b/crates/doc/src/lib.rs index 1349aac1d..b60a65ada 100644 --- a/crates/doc/src/lib.rs +++ b/crates/doc/src/lib.rs @@ -27,7 +27,7 @@ pub mod vector_faces; pub mod vector_regions; pub use board::*; -pub use board_route::{RouteEnd, attached_sides, path_handles, reshaped, route_along, route_points}; +pub use board_route::{MAX_RUNS, RouteEnd, attach_points, attached_sides, path_handles, reshaped, route_along, route_points}; pub use colors::*; pub use comments::*; pub use facilitation::*; diff --git a/crates/format/src/fig/map/connector.rs b/crates/format/src/fig/map/connector.rs index de2ff501c..01c07c00e 100644 --- a/crates/format/src/fig/map/connector.rs +++ b/crates/format/src/fig/map/connector.rs @@ -2,7 +2,7 @@ use super::layer::{cap_name, own_text, svg_path, valid_size}; use super::paint::{paint, stroke}; use super::{Affine, Kv, Mapper, NO_STYLE, Obj, Point, Value, View, generated_record, guid, json, matrix, network, num, rows}; use figcraft_doc::geom::kurbo::{BezPath, PathEl, Rect, Shape}; -use figcraft_doc::{RouteEnd, Routing, Side, route_points}; +use figcraft_doc::{ConnectorPath, MAX_RUNS, RouteEnd, Routing, Side, attach_points, attached_sides, route_along}; /// How a connector imports: from its saved snapshot (`terminal`: as one vector, no room for its /// label), or drawn from its ends, as a frame with its line and `label` when it has one. @@ -48,7 +48,8 @@ impl<'a> Mapper<'a> { /// A connector's end caps, and when it has no saved outline or network its line between its /// ends (free points, or a sibling layer): straight to the point given on the layer (its - /// centre unless given), or elbowed or curved from a side of it, as a board connector runs. + /// centre unless given), or elbowed or curved from a side of it, as a board connector runs; + /// an elbow saved with its path (FigJam's control points) runs along it (#1910). /// Returns the middle of that line by length, in the connector's own coordinates. pub(super) fn connector(&mut self, o: &mut Obj, v: &View<'a>, space: Affine) -> Option { for (from, to) in [("connectorStartCap", "strokeCapStart"), ("connectorEndCap", "strokeCapEnd")] { @@ -94,11 +95,13 @@ impl<'a> Mapper<'a> { }; ok.then_some(end) }; - let Some(pts) = end("connectorStart").zip(end("connectorEnd")).and_then(|(a, b)| route_points(a, b, routing)) else { + let ends = end("connectorStart").zip(end("connectorEnd")); + let path = ends.filter(|_| routing == Routing::Elbow).and_then(|(a, b)| saved_runs(v, a, b)); + let Some(pts) = ends.and_then(|(a, b)| route_along(a, b, routing, path.as_ref())) else { self.warn("connectors whose ends can't be placed are empty"); return None; }; - if routing != Routing::Straight { + if routing != Routing::Straight && path.is_none() { self.warn("elbowed and curved connectors without a saved path follow FigCraft's own routing"); } // A curved route is one curve: its ends and the two control points between them. @@ -407,6 +410,45 @@ pub(super) fn connector_has_saved_label(v: &View<'_>) -> bool { .is_some_and(|s| !s.trim().is_empty()) } +/// The path a FigJam elbow connector was saved with: its `connectorControlPoints`, one per run +/// between the first and the last, each a point on its run (in the connector's parent's +/// coordinates, like its ends) with the run's axis; the first run leaves the start's side and the +/// last arrives at the end's, so neither is saved. `None` without any, or when they don't make +/// such a path: a point off both axes, two runs in a row the same way, a first or last run that +/// would leave or arrive sideways to its side, or more runs than a hand could make here. +fn saved_runs(v: &View<'_>, from: RouteEnd, to: RouteEnd) -> Option { + let saved = v.list("connectorControlPoints"); + if saved.is_empty() || saved.len() + 2 > MAX_RUNS { + return None; + } + let (p0, p1) = attach_points(from, to); + let mid = p0.midpoint(p1); + let mut at = Vec::with_capacity(saved.len()); + let (mut first, mut last) = (None, None); + for p in saved { + let pos = p.get("position").and_then(|q| Some(Point::new(num(q, "x")?, num(q, "y")?)))?; + let (ax, ay) = p.get("axis").and_then(|q| Some((num(q, "x")?, num(q, "y")?)))?; + let sideways = match (ax != 0.0, ay != 0.0) { + (true, false) => true, + (false, true) => false, + _ => return None, + }; + if last == Some(sideways) { + return None; + } + first.get_or_insert(!sideways); + last = Some(sideways); + at.push(if sideways { pos.y - mid.y } else { pos.x - mid.x }); + } + // The run through each end goes the way its side faces: the first at right angles to the first + // saved run, the last to the last. + let (across, last) = (first?, last?); + let faces_across = |s: Side| matches!(s, Side::Left | Side::Right); + let (s0, s1) = attached_sides(from, to); + let fits = s0.is_none_or(|s| faces_across(s) == across) && s1.is_none_or(|s| faces_across(s) != last); + fits.then_some(ConnectorPath::Runs { across, at }) +} + /// The side of its layer a connector end leaves from: the `magnet` the file names, else the edge /// its point on the layer (`relativePosition`, 0–1) lies on, else the side facing the other end. fn side(e: &Kv<'_>, at: Option<(f64, f64)>) -> Side { diff --git a/crates/format/src/fig/tail_tests.rs b/crates/format/src/fig/tail_tests.rs index 2c8cce032..09e6ed85a 100644 --- a/crates/format/src/fig/tail_tests.rs +++ b/crates/format/src/fig/tail_tests.rs @@ -863,3 +863,80 @@ fn write_fixture() { std::fs::write(out, zip_file(&tail_canvas())).unwrap(); } } + +/// An elbow connector saved with its path (#1910): FigJam's control points, one per run between +/// the first and the last, each on its run with the run's axis, give the path the connector keeps; +/// the first run leaves the start's side and the last arrives at the end's. +#[test] +fn an_elbow_connector_saved_with_its_path_keeps_it() { + let mut message = tail_message(); + let Kv::Array(nodes) = field_mut(&mut message, "nodeChanges").unwrap() else { panic!() }; + let box_at = |id, name: &str, x, y| node(id, Some((1, "*")), "RECTANGLE", name, vec![("size", xy(100.0, 100.0)), ("transform", at(x, y))]); + let point = |x, y, ax, ay| o(vec![("position", xy(x, y)), ("axis", xy(ax, ay))]); + // From A's bottom, across at y 740, down at x 200, into B's left: four runs. + let saved = node( + 66, + Some((1, "+")), + "CONNECTOR", + "Saved", + vec![ + ("strokePaints", arr(vec![solid(0.0, 0.0, 0.0)])), + ("connectorStart", o(vec![("endpointNodeID", g(64)), ("relativePosition", xy(0.5, 1.0))])), + ("connectorEnd", o(vec![("endpointNodeID", g(65)), ("relativePosition", xy(0.0, 0.5))])), + ("connectorLineStyle", e("ELBOWED")), + ("connectorControlPoints", arr(vec![point(150.0, 740.0, 1.0, 0.0), point(200.0, 800.0, 0.0, 1.0)])), + ], + ); + nodes.extend([box_at(64, "A", 0.0, 600.0), box_at(65, "B", 300.0, 800.0), saved]); + let (doc, warnings) = import(&canvas(&schema(), &message), "Saved path").unwrap(); + let world = doc.world_transform(named(&doc, "Saved").id); + let line: Vec<_> = + network_of(&doc, "Saved").vertices.iter().map(|v| world * figcraft_doc::geom::Point::new(v.x, v.y)).map(|p| (p.x, p.y)).collect(); + assert_eq!(line, [(50.0, 700.0), (50.0, 740.0), (200.0, 740.0), (200.0, 850.0), (300.0, 850.0)]); + // The fixture's own Link, saved without a path, is routed here: the note counts it alone. + let routed: Vec<_> = warnings.iter().filter(|w| w.contains("FigCraft's own routing")).collect(); + assert_eq!(routed.len(), 1, "{warnings:?}"); + assert!(!routed[0].contains('×'), "a connector with its path isn't counted among those routed here: {routed:?}"); +} + +/// Saved control points that don't make a path from the connector's sides (#1910): a first run +/// that would leave the bottom sideways, a point off both axes, or two runs in a row the same way +/// leave the connector to FigCraft's routing, as one saved without a path is. +#[test] +fn an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here() { + let mut message = tail_message(); + let Kv::Array(nodes) = field_mut(&mut message, "nodeChanges").unwrap() else { panic!() }; + let box_at = |id, name: &str, x, y| node(id, Some((1, "*")), "RECTANGLE", name, vec![("size", xy(100.0, 100.0)), ("transform", at(x, y))]); + let point = |x, y, ax, ay| o(vec![("position", xy(x, y)), ("axis", xy(ax, ay))]); + let elbow = |id, name: &str, points: Vec>| { + let mut fields = vec![ + ("strokePaints", arr(vec![solid(0.0, 0.0, 0.0)])), + ("connectorStart", o(vec![("endpointNodeID", g(64)), ("relativePosition", xy(0.5, 1.0))])), + ("connectorEnd", o(vec![("endpointNodeID", g(65)), ("relativePosition", xy(0.0, 0.5))])), + ("connectorLineStyle", e("ELBOWED")), + ]; + if !points.is_empty() { + fields.push(("connectorControlPoints", arr(points))); + } + node(id, Some((1, "+")), "CONNECTOR", name, fields) + }; + nodes.extend([ + box_at(64, "A", 0.0, 600.0), + box_at(65, "B", 300.0, 800.0), + elbow(66, "Plain", vec![]), + elbow(67, "Sideways", vec![point(100.0, 650.0, 0.0, 1.0)]), + elbow(68, "Askew", vec![point(150.0, 740.0, 1.0, 1.0)]), + elbow(69, "Repeated", vec![point(150.0, 740.0, 1.0, 0.0), point(150.0, 760.0, 1.0, 0.0)]), + ]); + let (doc, warnings) = import(&canvas(&schema(), &message), "Unfit paths").unwrap(); + let line = |name: &str| -> Vec<(f64, f64)> { + let world = doc.world_transform(named(&doc, name).id); + network_of(&doc, name).vertices.iter().map(|v| world * figcraft_doc::geom::Point::new(v.x, v.y)).map(|p| (p.x, p.y)).collect() + }; + let plain = line("Plain"); + assert!(plain.len() >= 3, "routed in right angles: {plain:?}"); + for name in ["Sideways", "Askew", "Repeated"] { + assert_eq!(line(name), plain, "{name} is routed as one without a path"); + } + assert!(warnings.iter().any(|w| w.contains("FigCraft's own routing")), "{warnings:?}"); +} diff --git a/crates/format/src/fig/tests.rs b/crates/format/src/fig/tests.rs index 2d4a1f7d6..317d0c6f5 100644 --- a/crates/format/src/fig/tests.rs +++ b/crates/format/src/fig/tests.rs @@ -51,6 +51,7 @@ message VariableSetID GUID guid, AssetRef assetRef message ConditionalActions Action[] actions, VariableData condition message VectorData uint vectorNetworkBlob, Vector normalizedSize, NodeChange[] styleOverrideTable message ConnectorEndpoint GUID endpointNodeID, Vector position, Vector relativePosition +message ConnectorControlPoint Vector position, Vector axis message VariableData AnyValue value, DataType dataType message Paint PaintType type, Color color, float opacity, bool visible, Image image, Matrix transform, ColorStop[] stops, VariableData colorVar, ImageScaleMode imageScaleMode message ParentIndex GUID guid, string position @@ -74,7 +75,7 @@ message Event InteractionType interactionType message Action GUID transitionNodeID, TransitionType transitionType, float transitionDuration, EasingType easingType, ConnectionType connectionType, NavigationType navigationType, VariableTarget targetVariable, VariableData targetVariableData, VariableSetID targetVariableSetID, GUID targetVariableModeID, ConditionalActions[] conditionalActions message Interaction Event event, Action[] actions message StartingPoint string name, string position -message NodeChange GUID guid, ParentIndex parentIndex, NodeType type, string name, bool visible, float opacity, Vector size, Matrix transform, Paint[] fillPaints, Paint[] strokePaints, float strokeWeight, float cornerRadius, bool resizeToFit, bool internalOnly, float fontSize, FontName fontName, TextData textData, uint styleID, Path[] fillGeometry, Path[] strokeGeometry, StyleType styleType, StyleId styleIdForFill, SymbolData symbolData, PropDef[] componentPropDefs, PropAssignment[] componentPropAssignments, VariableDataMap parameterConsumptionMap, SetMode[] variableSetModes, VariableID variableSetID, ResolvedType variableResolvedType, Values variableDataValues, ModeMap variableModeBySetMap, Interaction[] prototypeInteractions, StartingPoint prototypeStartingPoint, GUIDPath guidPath, StackMode stackMode, float stackSpacing, float stackHorizontalPadding, float stackVerticalPadding, uint count, float starInnerScale, VectorData vectorData, StrokeCap strokeCap, StrokeJoin strokeJoin, VectorMirror handleMirroring, ShapeWithTextType shapeWithTextType, ConnectorEndpoint connectorStart, ConnectorEndpoint connectorEnd, StrokeCap connectorStartCap, StrokeCap connectorEndCap, ConnectorLineStyle connectorLineStyle, ConstraintType horizontalConstraint, ConstraintType verticalConstraint, NodeChange[] derivedSymbolData, string key, string version, LeadingTrim leadingTrim, float[] dashPattern +message NodeChange GUID guid, ParentIndex parentIndex, NodeType type, string name, bool visible, float opacity, Vector size, Matrix transform, Paint[] fillPaints, Paint[] strokePaints, float strokeWeight, float cornerRadius, bool resizeToFit, bool internalOnly, float fontSize, FontName fontName, TextData textData, uint styleID, Path[] fillGeometry, Path[] strokeGeometry, StyleType styleType, StyleId styleIdForFill, SymbolData symbolData, PropDef[] componentPropDefs, PropAssignment[] componentPropAssignments, VariableDataMap parameterConsumptionMap, SetMode[] variableSetModes, VariableID variableSetID, ResolvedType variableResolvedType, Values variableDataValues, ModeMap variableModeBySetMap, Interaction[] prototypeInteractions, StartingPoint prototypeStartingPoint, GUIDPath guidPath, StackMode stackMode, float stackSpacing, float stackHorizontalPadding, float stackVerticalPadding, uint count, float starInnerScale, VectorData vectorData, StrokeCap strokeCap, StrokeJoin strokeJoin, VectorMirror handleMirroring, ShapeWithTextType shapeWithTextType, ConnectorEndpoint connectorStart, ConnectorEndpoint connectorEnd, StrokeCap connectorStartCap, StrokeCap connectorEndCap, ConnectorLineStyle connectorLineStyle, ConstraintType horizontalConstraint, ConstraintType verticalConstraint, NodeChange[] derivedSymbolData, string key, string version, LeadingTrim leadingTrim, float[] dashPattern, ConnectorControlPoint[] connectorControlPoints message Blob byte[] bytes message Message NodeChange[] nodeChanges, Blob[] blobs "; diff --git a/docs/boards-parity.md b/docs/boards-parity.md index 7526d39aa..ef7c4a8b3 100644 --- a/docs/boards-parity.md +++ b/docs/boards-parity.md @@ -64,7 +64,7 @@ all end with the same geometry. | Audio and huddles | missing | | | AI features (summaries, sorting stickies, generating boards) | missing | | | Grid on the page | done | the canvas render draws it after the page colour and before the layers (`figcraft_render::Dots`), so objects cover it. Dots by default, or lines, graph paper (a strong line every 2–12 cells over fainter ones, like Japanese section paper) or none; spacing (4–512), mark size and contrast are settings kept with the preferences (`board.grid`; Preferences ▸ Board grid). Zoomed out it thins out (dots and lines by halves, graph paper down to its strong lines) until the marks are at least 14 points apart (10 for lines), the marks the next step drops fading out first; dots stay about a point and a half across on screen (1 to 3 points), scaled by the size setting. Dark marks on a light page, light ones on a dark page, from the theme's ink; written straight into the image, no allocation per mark, a crossing of two lines blended once; never in exports. FigCraft's own settings: the incumbent's board grid has none | -| `.jam` import and export | **partial**: a `.jam` opens as a board, best effort (#1342): its stickies and shapes with text come in as frames with their generated layers and its connectors as vectors, not as native board objects; no export | see [`file-format-parity.md`](file-format-parity.md) | +| `.jam` import and export | **partial**: a `.jam` opens as a board, best effort (#1342): its stickies and shapes with text come in as frames with their generated layers and its connectors as vectors, not as native board objects (an elbowed connector keeps the path it was saved with, #1910); no export | see [`file-format-parity.md`](file-format-parity.md) | ## Revision history diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 56cc701a2..835e3ac00 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -1,6 +1,6 @@ # File format parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-01 · **Change:** minor (a FigJam connector without a saved snapshot took no stroke and was invisible; its line's paint, weight, cap and dashes now come from the file's generated line record (#1807); a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); imported and pasted text finds an installed family under the other names its fonts give it, and with other case and spacing (#1292); `.fig` export writes colour calculations as the colour they show in each mode and leaves out, with a warning, one that resolves to nothing (#1280); `.fig` import budgets four decoded values per compressed byte instead of one, still within 20M–128M, so dense files within that budget open instead of being refused as having too many values (#574); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; folders, devices and pipes are refused before anything is read (#1114); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); a FigJam `.jam` file opens as a board (#1342); FigJam `.jam` files open like `.fig` files: File ▸ Open, drag and drop, `file.import` and the command line (#1342); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); SVG import draws each pattern tile once per scale, within the layer budget (#1080); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); offline Penpot 2.x import/export (#1143); `.sketch` import checked against Sketch's renders: master backgrounds, symbol clipping, tints before Sketch 64, mask opacity, bitmap fills, image overrides on shapes, stretching stacks, blur radii, colour adjustments, OKLab gradients, text growth, shape group borders (#1389); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); image member names are checked on read, and REST image placeholders get archive-safe keys (#1086); Android Vector Drawable (XML) export; `.fig` export: files the incumbent imports, with component set properties, and grid track sizes at its field ids; Save and auto-save don't replace changes another app made to the open file (#1330); `.sketch` import, best effort, Sketch 48 and newer; the PNG row names ignore overlapping layers and where include bounding box is offered; the Fonts table's missing-font row describes the Missing fonts window; `.figcraft` carries the file kind (boards); `.fig` import: resized instances and variable modes by asset key; atomic saves; auto-save; SVG export clip of nested frames; SVG/PDF export depth refusal (#208); `.fig` export: instance sizes, variables with modes, shared styles, variable-width strokes; `.fig` export: written files checked by opening them in other software; experimental `.fig` export; export and inspect behaviour suite and fixes; .fig import: editable vector networks and more layer kinds; embedded image colour profiles; `.fig` import, best effort; animated GIF fills and TIFF images; last major: created, formats from the installed Figma's Info.plist and help center, ours from source; REST import keeps slot layers and instances' slot content (#792); REST import reads grid track sizes (#465); `.fig` import fidelity from the community batches, budgets for large files, the import report, a `.fig` copy from Save as, paste from another design app; instance layers' size and resizing and Hug on import (#731, #732)) · **Target:** Figma Design (desktop app 126.10.7) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** minor (a FigJam elbow connector saved with its path (`connectorControlPoints`) keeps it on import, as a board connector reshaped by hand does, instead of being routed again (#1910); a FigJam connector without a saved snapshot took no stroke and was invisible; its line's paint, weight, cap and dashes now come from the file's generated line record (#1807); a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); imported and pasted text finds an installed family under the other names its fonts give it, and with other case and spacing (#1292); `.fig` export writes colour calculations as the colour they show in each mode and leaves out, with a warning, one that resolves to nothing (#1280); `.fig` import budgets four decoded values per compressed byte instead of one, still within 20M–128M, so dense files within that budget open instead of being refused as having too many values (#574); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; folders, devices and pipes are refused before anything is read (#1114); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); a FigJam `.jam` file opens as a board (#1342); FigJam `.jam` files open like `.fig` files: File ▸ Open, drag and drop, `file.import` and the command line (#1342); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); SVG import draws each pattern tile once per scale, within the layer budget (#1080); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); offline Penpot 2.x import/export (#1143); `.sketch` import checked against Sketch's renders: master backgrounds, symbol clipping, tints before Sketch 64, mask opacity, bitmap fills, image overrides on shapes, stretching stacks, blur radii, colour adjustments, OKLab gradients, text growth, shape group borders (#1389); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); image member names are checked on read, and REST image placeholders get archive-safe keys (#1086); Android Vector Drawable (XML) export; `.fig` export: files the incumbent imports, with component set properties, and grid track sizes at its field ids; Save and auto-save don't replace changes another app made to the open file (#1330); `.sketch` import, best effort, Sketch 48 and newer; the PNG row names ignore overlapping layers and where include bounding box is offered; the Fonts table's missing-font row describes the Missing fonts window; `.figcraft` carries the file kind (boards); `.fig` import: resized instances and variable modes by asset key; atomic saves; auto-save; SVG export clip of nested frames; SVG/PDF export depth refusal (#208); `.fig` export: instance sizes, variables with modes, shared styles, variable-width strokes; `.fig` export: written files checked by opening them in other software; experimental `.fig` export; export and inspect behaviour suite and fixes; .fig import: editable vector networks and more layer kinds; embedded image colour profiles; `.fig` import, best effort; animated GIF fills and TIFF images; last major: created, formats from the installed Figma's Info.plist and help center, ours from source; REST import keeps slot layers and instances' slot content (#792); REST import reads grid track sizes (#465); `.fig` import fidelity from the community batches, budgets for large files, the import report, a `.fig` copy from Save as, paste from another design app; instance layers' size and resizing and Hug on import (#731, #732)) · **Target:** Figma Design (desktop app 126.10.7) Every format Figma reads or writes, with FigCraft's support. Sources: `Info.plist` of `/Applications/Figma.app` (document types only; nothing inside the bundle's code was read), Figma's @@ -17,10 +17,10 @@ and prototype interactions are still unchecked there. | Format | Figma | FigCraft read | FigCraft write | Fidelity / testing | Hours | |---|---|---|---|---|---| -| `.fig` (Figma Design, `com.figma.document`, `application/x-figma`) | native (cloud; "Save local copy") | **yes, best effort** (`file.open`, `file.import`, drop, CLI, MCP) | **experimental** ([below](#export-to-fig-experimental)) | `.fig` files open (best effort): the zip, its deflate/zstd chunks and the kiwi schema are decoded generically and mapped by field name onto the REST importer, so pages, the layer tree, geometry, paints (styles resolved), strokes, effects, text with styled runs, vectors as editable vector networks with region-specific fill paints (points, curved segments, filled areas with their winding, per-point corner radius and handle mirroring, end caps; outlines when the network is missing or damaged), auto layout (grid included; a flow that records no primary-axis sizing hugs on that axis, an instance that records no auto layout has its main's), constraints, ellipse arcs, boolean operations, components, sets (with their descriptions), instances (expanded from their main with overrides, derived layout and property values; the size and resizing their layers override stay overrides), styles, variables with modes and bindings, prototyping (set-variable, set-variable-mode and conditional actions included) and image fills from the archive come across; sticky notes and shapes with text keep their generated backgrounds, styled text, text paints, saved child bounds and sticky author lines as editable frame children, including saved vector networks without geometry paths, outer fill/stroke outlines when generated geometry is damaged, and outer body text when its generated child is unusable even if an author survives (#1341, #1397); connectors, tables, code blocks, slides and similar layers come in as the closest frames, text layers and vectors, with a warning; anything else is a warning. Since 2026-10-17 (community batches #727, #728): an instance's own identity and the cached library components a file carries, overrides applied by key and order, local text values and instance overrides over a shared text style, grid track sizes (fixed, content-sized, fill), slot content, labels of connectors saved with their drawn path (a static snapshot; the ends aren't live), skip ink, paragraph options and hanging lists, list start numbers, vertical trim, per-point stroke joins, editable text on a path, image adjustments and images carried in the message; since 2026-10-29, style links that name a library style by asset key and version (the file's own copy of it), with override rows above the linking one still winning, and override rows restating a nested level's overrides applied at that level, below the instance's own (#1234), and the line breaks the file saved with a text, followed until an edit or a resize could move one, or where a line would come out more than 3% wider than its box in the fonts at hand (#1236). Budgets come from the file's own size (four decoded values per compressed byte, 20M–128M, lower ceilings on 32-bit targets; the layer cap follows the file's size too), so a 15.4 MB synthetic file with 300,000 layers opens whole; ZIP image reads have a separate total budget of 4 GiB (1 GiB on 32-bit targets) of decompressed ZIP-member bytes containing encoded images, with the 256 MiB per-image cap kept: a member that cannot fit is skipped before its output buffer is allocated, and the import report names the budget and counts skipped images (#1076). Failed reads and invalid image contents still consume the bytes read; a reference used by several layers is read once. This is not a limit on decoded pixels or total import memory; images carried inside the message are unchanged. The file's bytes stay out of the command journal; an import report lists what was left out or changed once the file opens. Elbowed and curved connectors without a saved path are routed as FigCraft's board connectors are (right angles, or one curve, from the sides of the layers they join), and a connector routed here takes its line's paint, weight, cap and dashes from the file's generated line record, as one with a saved snapshot does (#1807). A connector's label without a saved snapshot is kept as text centred on its line, without its background. Not read: table cells beyond their own layers, live style and variable links for vector region fills, variables bound to fields the editor can't bind, video fills. Tested on fixtures generated in code (`crates/format/src/fig/tests.rs`, `tail_tests.rs` and the per-feature `*_tests.rs` beside them, fuzzed), `crates/engine/src/shapebuilder_region_paints_tests.rs`, and by reading back what the export writes; the FigJam report sample from #1341 checked locally only; no representative real-world corpus yet | read tail 5–10, write: checks against real files 5–15 | +| `.fig` (Figma Design, `com.figma.document`, `application/x-figma`) | native (cloud; "Save local copy") | **yes, best effort** (`file.open`, `file.import`, drop, CLI, MCP) | **experimental** ([below](#export-to-fig-experimental)) | `.fig` files open (best effort): the zip, its deflate/zstd chunks and the kiwi schema are decoded generically and mapped by field name onto the REST importer, so pages, the layer tree, geometry, paints (styles resolved), strokes, effects, text with styled runs, vectors as editable vector networks with region-specific fill paints (points, curved segments, filled areas with their winding, per-point corner radius and handle mirroring, end caps; outlines when the network is missing or damaged), auto layout (grid included; a flow that records no primary-axis sizing hugs on that axis, an instance that records no auto layout has its main's), constraints, ellipse arcs, boolean operations, components, sets (with their descriptions), instances (expanded from their main with overrides, derived layout and property values; the size and resizing their layers override stay overrides), styles, variables with modes and bindings, prototyping (set-variable, set-variable-mode and conditional actions included) and image fills from the archive come across; sticky notes and shapes with text keep their generated backgrounds, styled text, text paints, saved child bounds and sticky author lines as editable frame children, including saved vector networks without geometry paths, outer fill/stroke outlines when generated geometry is damaged, and outer body text when its generated child is unusable even if an author survives (#1341, #1397); connectors, tables, code blocks, slides and similar layers come in as the closest frames, text layers and vectors, with a warning; anything else is a warning. Since 2026-10-17 (community batches #727, #728): an instance's own identity and the cached library components a file carries, overrides applied by key and order, local text values and instance overrides over a shared text style, grid track sizes (fixed, content-sized, fill), slot content, labels of connectors saved with their drawn path (a static snapshot; the ends aren't live), skip ink, paragraph options and hanging lists, list start numbers, vertical trim, per-point stroke joins, editable text on a path, image adjustments and images carried in the message; since 2026-10-29, style links that name a library style by asset key and version (the file's own copy of it), with override rows above the linking one still winning, and override rows restating a nested level's overrides applied at that level, below the instance's own (#1234), and the line breaks the file saved with a text, followed until an edit or a resize could move one, or where a line would come out more than 3% wider than its box in the fonts at hand (#1236). Budgets come from the file's own size (four decoded values per compressed byte, 20M–128M, lower ceilings on 32-bit targets; the layer cap follows the file's size too), so a 15.4 MB synthetic file with 300,000 layers opens whole; ZIP image reads have a separate total budget of 4 GiB (1 GiB on 32-bit targets) of decompressed ZIP-member bytes containing encoded images, with the 256 MiB per-image cap kept: a member that cannot fit is skipped before its output buffer is allocated, and the import report names the budget and counts skipped images (#1076). Failed reads and invalid image contents still consume the bytes read; a reference used by several layers is read once. This is not a limit on decoded pixels or total import memory; images carried inside the message are unchanged. The file's bytes stay out of the command journal; an import report lists what was left out or changed once the file opens. Elbowed and curved connectors without a saved path are routed as FigCraft's board connectors are (right angles, or one curve, from the sides of the layers they join); an elbowed one saved with its path (`connectorControlPoints`: a point and an axis per run between the first and the last) keeps that path when it leaves and arrives by the ends' sides (#1910), and a curved one's saved `connectorBezierControlPoints` are not read; a connector routed here takes its line's paint, weight, cap and dashes from the file's generated line record, as one with a saved snapshot does (#1807). A connector's label without a saved snapshot is kept as text centred on its line, without its background. Not read: table cells beyond their own layers, live style and variable links for vector region fills, variables bound to fields the editor can't bind, video fills. Tested on fixtures generated in code (`crates/format/src/fig/tests.rs`, `tail_tests.rs` and the per-feature `*_tests.rs` beside them, fuzzed), `crates/engine/src/shapebuilder_region_paints_tests.rs`, and by reading back what the export writes; the FigJam report sample from #1341 checked locally only; no representative real-world corpus yet | read tail 5–10, write: checks against real files 5–15 | | `.penpot` (Penpot 2.x ZIP export) | — | **yes, offline** (open, import, drop, CLI, MCP) | **yes, offline** (export, CLI convert) | Editable layers, supported flex/grid layout, components, tokens and prototypes using the existing model. Unsupported layouts retain saved positions and bounded metadata; toggle-overlay and embedded font binaries are reported. Font references remain editable; no downloads. Synthetic regression coverage; live Penpot and cross-platform QA remain open. See [Penpot reference](penpot.md). | further live Penpot and cross-platform QA | | `.sketch` (Sketch 48 and newer) | import (file browser ▸ Import or drop, desktop app too; converted to a Figma file, symbols as components; per the help center) | **yes, best effort** (`file.open`, `file.import`, drop, CLI, MCP; Open With from Finder, Explorer and Linux file managers once installed; recent files show its `previews/preview.png`) | no (out of scope) | zip + JSON read from the public format description; Sketch 43–47 (text as binary property lists) and older (SQLite) files are refused with a message to resave them in a newer Sketch. Pages, artboards as frames with their background, groups; Sketch 2025 and newer: frames (clipping or not) with their style, graphics, stacks as auto layout (direction, gap, alignment, padding, wrap, hug/fill sizing, stretching filling every item across, items ignoring the stack), corners in the style (rounded, smooth with its smoothing; angled, inside square and inside arc as paths), pins and sizing, per-side borders, lists of blurs (progressive background blurs, glass), inner shadows in the shadow list, tints (a graphic's, group's or instance's fill colouring its layers, and colour overrides; from Sketch 64, before which a group's fill draws nothing), text colour and visibility overrides, text sized by its sizing; rectangles with corner radii, ovals, stars and polygons while their points are the generated ones, paths as editable vector networks, shape groups as their shape, as one compound path (children without an operation, by the group's winding rule) or as boolean operations (mixed operations nested from the left); operands' own borders ignored as Sketch does; open paths filled as if closed, edited ovals and rectangles as paths, bitmaps (their image under their style's fills; colour adjustments as image filters with Sketch's tone curve, contrast and then brightness added), slices, hotspots; transforms (rotation, flips after it), resizing constraints; fills (solid, gradients with Sketch's geometry, gradients mixed in OKLab or OKLCH as sRGB stops along the same colours, image patterns), borders (the first enabled border's width and position), shadows, inner shadows, layer, motion and background blurs (Sketch's radius is the standard deviation), opacity and blend modes; clipping masks (an outline mask that shows its own style draws a copy under itself, as Sketch does, and its opacity fades it and what it clips together; alpha masks only mask; broken mask chains wrapped), progressive opacity (Fade) as an alpha mask of its gradient; text with styled runs (UTF-16 ranges), paragraph and vertical alignment, lines placed by Sketch's line spacing behaviour, box sizing, fonts found by their PostScript names among the installed ones (else the family read from the name), variable font axes, Sketch's natural line (ascent and descent rounded, no line gap, a fifth more for classic Mac fonts) for text without a fixed line height; symbols as components (library copies on a page of their own) and instances carrying their masters' layers with overrides (text, nested swaps and hiding, images, also on shapes' image fills, layer and text styles, nested paths), clipping only where the master clips (`clippingBehavior` 1), laid out for their size the way Sketch does it (proportional sharing per pins from format 110, scaling before) and still live; master backgrounds in instances only when the master includes them in both instances and exports, as on Sketch's canvas and renders; Apple's system fonts found under the names designs use, with the platform's tracking kept as letter spacing; shared layer styles as paint (fills, border colours) and effect styles, shared text styles as text styles; Color Variables (also library ones) as colour variables with bindings; prototype links, flow starts, export options, layout and square grids (hidden, as Sketch shows them only in its layout view). Instances of a stack laid out at their size and texts an override changed measured again on open, an auto-width one growing from its aligned edge. Warnings: noise fills, OKLab and OKLCH gradients, motion and zoom blurs (drawn as plain blurs), fonts embedded with their data (not used), Smart Layout (kept as laid out), locked overrides, scaled instances. Tested on fixtures built in code (`crates/format/src/sketch/*_tests.rs`, fuzzed) and locally (`FIGCRAFT_SKETCH_SAMPLES`) on one real Sketch 50 file and the public Apache-2.0 IBM Carbon Design Kit saved by Sketch 68 and 83 (70,000 layers open in ~3 s, debug build; its edition saved by Sketch 47 is refused, as it should be); compared artboard by artboard with Sketch 2026's own renders (`FIGCRAFT_SKETCHTOOL`, black-box): the Sketch 50 file's 73 artboards differ in at most 2.3% of their pixels (0.8% on average) (text metrics, fonts FigCraft doesn't find, antialiasing), Carbon 11's 69 1.1% on average and at most 4.4% (text in IBM Plex, which the file embeds and FigCraft doesn't use yet), a Sketch 64 file's 65 artboards 2.1% on average, a Sketch 2026 showcase file's 16 frames 0.9% on average (at most 1.9%); the rules for master backgrounds, symbol clipping, mask opacity, bitmap fills, image overrides, stretching stacks, blur radii, colour adjustments, gradient interpolation and text growth checked against Sketch's renders of files built for each case (black-box, synthetic) | 5–10 (Smart Layout as auto layout, motion and zoom blurs, several borders of different widths; fonts embedded in the file once `.figcraft` documents can carry fonts: until then they would only last the session). Known limitations: a plain group (not a frame) that fills a stack keeps its layers' size where Sketch stretches them; a font Sketch can't find draws in the installed family's own weight (Sketch falls back to a regular face); text in the system SF Pro comes out a few percent narrower than Sketch's; macOS's reserved system fonts (PingFang) aren't found; brightness past about +0.4 is approximated (image filters can't add); OKLab gradients become sRGB stops (FigCraft gradients mix in sRGB) | -| `.jam` (whiteboards) | native to FigJam | **yes, best effort** (`file.open`, `file.import`, File ▸ Open, drop, CLI, MCP) | no | the same archive as a `.fig` (its canvas header reads `fig-jam.`) through the same reader (#1342): it opens as a board (the file kind; a `.fig` stays a design file), with generated sticky and shape backgrounds and text kept (#1341) as ordinary layers rather than native board objects (see [boards-parity](boards-parity.md)); tables, stamps, code blocks and the like come in as frames with their text and connectors as vectors, with an import note; a layer type the reader doesn't know is left out with a note naming it; writing `.jam` is not supported | — | +| `.jam` (whiteboards) | native to FigJam | **yes, best effort** (`file.open`, `file.import`, File ▸ Open, drop, CLI, MCP) | no | the same archive as a `.fig` (its canvas header reads `fig-jam.`) through the same reader (#1342): it opens as a board (the file kind; a `.fig` stays a design file), with generated sticky and shape backgrounds and text kept (#1341) as ordinary layers rather than native board objects (see [boards-parity](boards-parity.md)); tables, stamps, code blocks and the like come in as frames with their text and connectors as vectors (an elbowed connector keeps the path it was saved with, #1910), with an import note; a layer type the reader doesn't know is left out with a note naming it; writing `.jam` is not supported | — | | `.deck` (Slides) | native to other Figma products | no | no | out of scope | — | | REST API file JSON (`GET /v1/files/:key`) + local variables JSON + `images/` folder | the API's output | **yes** (`file.open`, `file.import`, CLI) | no | pages, layer tree, geometry, paints, strokes, effects, text runs, vectors, auto layout (sizing modes left out read as hug, as documented; grid track sizes from `gridColumnsSizing` / `gridRowsSizing`: px, fr, auto, `minmax(0, 1fr)`, `repeat()`), constraints, grids, components, sets, instances with overrides (sizes and resizing included), component properties, slots (`SLOT` layers bound to their slot property; an instance's slot keeps its content as the instance's own unless its property value is the main's default content; slot limits and preferred components are warnings), styles, prototyping (incl. conditionals and variable modes), variables with modes, aliases, scopes and bindings, image adjustments (the same tint sign as `.fig`); the import report after opening; warnings for what's skipped (video triggers and actions, modifier keys). Unit tests in `crates/format/src/rest/*_tests.rs` | — | | `.figcraft` (ours: zip of `document.json` + images, versions inside) | — | yes | yes | streamed JSON, 50k layers save ~0.09 s / load ~0.16 s (`cargo xtask bench`); old files keep opening (`large_tests.rs`); image members are `images/`, and a key that can't be one — path text, a space, over 128 chars — is left out with a complaint instead of loaded (`image_tests`); saves write a unique staging file and rename it into place (#284); optional auto-save of files with a path (`pref.autoSave`, #305); Save and auto-save refuse to write over a file another app (figcraft-cli, say) changed since it was opened or saved here, judged by its size and modification time: Revert to saved loads those changes, Save as keeps both, `file.save {overwrite: true}` replaces them (#1330); `kind: "board"` marks a board (left out for design files, so files from before boards are design files; the home screen reads it for the file's mark); board objects keep their `board` metadata on the layer; Dev Mode measurements are kept on the layer they start from (`measurements: [{to} | {side}]`, left out when there are none, so older files open with none) | — | @@ -187,6 +187,7 @@ source paint coordinates. | Date | Change | Summary | |---|---|---| +| 2026-11-04 | minor | `.fig` and `.jam` import, #1910: an elbowed connector saved with its path keeps it. FigJam stores `connectorControlPoints`, one per run between the first and the last, each a point on its run (in the connector's parent's coordinates) with the run's axis; the first run leaves the start's side and the last arrives at the end's. They become the `ConnectorPath::Runs` a board connector reshaped by hand has (`figcraft_doc::route_along`), so a connector drawn around a layer in FigJam stays around it instead of being routed through it. Points that don't make such a path (off both axes, two runs in a row the same way, a first or last run sideways to its side, more runs than a hand could make) leave the connector to the router as before, and only connectors routed here count in the "follow FigCraft's own routing" note. A curved connector's `connectorBezierControlPoints` are still not read. Tests: `tail_tests::an_elbow_connector_saved_with_its_path_keeps_it`, `tail_tests::an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here`. | | 2026-11-01 | patch | `.fig` and `.jam` import: a connector without a saved snapshot (elbowed and curved ones are routed here) took no stroke, so it was invisible (#1807); its line's paint, weight, cap and dashes now come from the file's generated line record, as a saved snapshot's do, and the connector's own values, when it has any, win. Test: `fig::connector_label_tests::a_routed_connector_takes_its_line_style_from_the_generated_record`. Numbers unchanged | | 2026-10-31 | patch | M4: Dash and Custom strokes have a Dash cap (None, Round, Square) in the advanced stroke settings and `node.set {dashCap}`, on both ends of every dash on the canvas and in PNG, PDF and SVG. Unset, dashes keep taking the end point caps, so older files look the same; the saved file writes it only when set. Numbers unchanged | | 2026-10-30 | minor | `.fig` import: a connector's label without a saved snapshot was skipped; now the connector imports as a frame holding its line and the label, as a connector with a saved snapshot does, the label centred on the line's middle by length (in a 200-wide box, laid out again with the fonts at hand), in the connector's fill paints or black. Its background isn't known without the snapshot and is left out. Not checked on real files. Test: `fig::tests::tail::a_labelled_connector_without_a_snapshot_keeps_its_label` | From 5855c8705c81a7f624c8ecbaba1214538cc273f8 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Wed, 4 Nov 2026 02:39:24 -0500 Subject: [PATCH 48/68] docs: boards-parity's status line and revision history move with its .jam row (#1910) Review: the row changed without the status line and a history row, which land together. Co-Authored-By: Claude Fable 5.1 --- docs/boards-parity.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/boards-parity.md b/docs/boards-parity.md index ef7c4a8b3..cf72aaa8c 100644 --- a/docs/boards-parity.md +++ b/docs/boards-parity.md @@ -1,6 +1,6 @@ # Boards parity -> **Last reviewed:** 2026-10-24 · **Last updated:** 2026-10-31 · **Change:** minor (a connector end moved with Cmd/Ctrl held goes on any part of an object, and stays there as the object moves or resizes; a connector end dropped along a side of a shape attaches to that side (#1708); a board connector's path can be reshaped by dragging its path handles (#1710); boards have 16 more shapes (arrows, polygons, star, plus and flowchart symbols), in pickers that lay them out in a grid; a board keeps earlier votes' results, listed newest first in Results and deleted one at a time; a connector's bar sets its start and end points, dashes, weight and any colour (#1596); cells copied from a spreadsheet paste onto a board as a table; Shift+Cmd/Ctrl+Enter on a selected board shape adds the next shape already joined to it, and goes on typing (#1597); "+" handles beside a selected sticky or shape make the next one, joined by a connector (#1597); a FigJam `.jam` file opens as a board (#1342); board grid settings: dots, lines, graph paper or none, spacing, size and contrast; the connector tool shows the connector it will make while dragging, ends snapping to attach points (#1387); templates and tables; facilitation: a shared timer and voting sessions; the dot grid, dragging a connector's end to re-attach it, curved connectors, elbows that go around what they join) · **Target:** the incumbent's whiteboard product (behaviour from its public help centre) +> **Last reviewed:** 2026-10-24 · **Last updated:** 2026-11-04 · **Change:** patch (a `.jam` elbowed connector saved with its path keeps it on import instead of being routed again (#1910); a connector end moved with Cmd/Ctrl held goes on any part of an object, and stays there as the object moves or resizes; a connector end dropped along a side of a shape attaches to that side (#1708); a board connector's path can be reshaped by dragging its path handles (#1710); boards have 16 more shapes (arrows, polygons, star, plus and flowchart symbols), in pickers that lay them out in a grid; a board keeps earlier votes' results, listed newest first in Results and deleted one at a time; a connector's bar sets its start and end points, dashes, weight and any colour (#1596); cells copied from a spreadsheet paste onto a board as a table; Shift+Cmd/Ctrl+Enter on a selected board shape adds the next shape already joined to it, and goes on typing (#1597); "+" handles beside a selected sticky or shape make the next one, joined by a connector (#1597); a FigJam `.jam` file opens as a board (#1342); board grid settings: dots, lines, graph paper or none, spacing, size and contrast; the connector tool shows the connector it will make while dragging, ends snapping to attach points (#1387); templates and tables; facilitation: a shared timer and voting sessions; the dot grid, dragging a connector's end to re-attach it, curved connectors, elbows that go around what they join) · **Target:** the incumbent's whiteboard product (behaviour from its public help centre) **Breadth ~47%, ready ~29% (estimated, erring low).** A board is a FigCraft file of its own kind (`file.newBoard`) with a dot grid on the page, sticky notes, shapes with text, connectors that @@ -70,6 +70,7 @@ all end with the same geometry. | Date | Change | Summary | |---|---|---| +| 2026-11-04 | patch | M6, #1910: a `.jam` elbowed connector saved with its path (FigJam's `connectorControlPoints`) keeps it on import: the points become the `ConnectorPath::Runs` a connector reshaped by hand has and the line is walked along them, so a connector drawn around a layer stays around it; one whose points don't make a path from its ends' sides is routed as before. Still a vector, not a native board object. Details in [`file-format-parity.md`](file-format-parity.md). | | 2026-10-31 | minor | M12: as the help describes, holding Cmd/Ctrl while moving a connector's end places it on any part of an object instead of snapping to a side. It keeps that spot as a fraction of the object's box, so it follows the object when it moves or resizes, and without the key an end snaps as before. `board.connector {fromAt, toAt}` and `board.reattach {at}` take it; saved only when set. Numbers unchanged | | 2026-10-31 | patch | M12, #1708: a connector end dropped on the outer half of a shape takes the side it is towards, instead of only within 10 px of a side's middle, so a drop anywhere along an edge chooses that edge (dragging a selected connector's end and with the connector tool, ring included); a drop in the middle of a shape still takes the facing side. | | 2026-10-31 | minor | M12, #1710: a selected elbow or curved connector shows path handles. Dragging a run moves it and a first or last run gains an extra run to stay on its end; a curve's middle goes where it is dragged (`board.reshape`, one undo step). The shape travels with what the connector joins, is saved with the file, and goes back to routing itself when the style changes or an end moves to something else. | From 31dcd0e5feca2d4ff7b80d69a4b996880c476198 Mon Sep 17 00:00:00 2001 From: Trevor Brown Date: Wed, 4 Nov 2026 03:46:49 -0500 Subject: [PATCH 49/68] M6: a saved connector path going back into its object is routed instead (#1910) Review: the first and last runs were checked for lying at right angles to their sides, not for going out of the object, so a path whose first run went up through the start's box (or whose last arrived from inside the end's) was kept and drawn through it. Both runs now have to go the way the side faces; one along the side or back into the object leaves the connector to the router. Two more cases in the routed-here test. Co-Authored-By: Claude Fable 5.1 --- crates/format/src/fig/map/connector.rs | 12 ++++++++---- crates/format/src/fig/tail_tests.rs | 6 +++++- docs/file-format-parity.md | 2 +- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/crates/format/src/fig/map/connector.rs b/crates/format/src/fig/map/connector.rs index 01c07c00e..e89b875ed 100644 --- a/crates/format/src/fig/map/connector.rs +++ b/crates/format/src/fig/map/connector.rs @@ -440,12 +440,16 @@ fn saved_runs(v: &View<'_>, from: RouteEnd, to: RouteEnd) -> Option, p: Point, q: Point| s.is_none_or(|s| (q - p).dot(s.normal()) > 0.0); let (s0, s1) = attached_sides(from, to); - let fits = s0.is_none_or(|s| faces_across(s) == across) && s1.is_none_or(|s| faces_across(s) != last); + let fits = out_of(s0, p0, onto(across, p0, a0)) && out_of(s1, p1, onto(!last, p1, a1)); fits.then_some(ConnectorPath::Runs { across, at }) } diff --git a/crates/format/src/fig/tail_tests.rs b/crates/format/src/fig/tail_tests.rs index 09e6ed85a..773edd4d8 100644 --- a/crates/format/src/fig/tail_tests.rs +++ b/crates/format/src/fig/tail_tests.rs @@ -927,6 +927,10 @@ fn an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here() { elbow(67, "Sideways", vec![point(100.0, 650.0, 0.0, 1.0)]), elbow(68, "Askew", vec![point(150.0, 740.0, 1.0, 1.0)]), elbow(69, "Repeated", vec![point(150.0, 740.0, 1.0, 0.0), point(150.0, 760.0, 1.0, 0.0)]), + // The first run would go up from A's bottom, through A; the last would arrive at B's left + // from inside B. Each run is at right angles to its side, so only the way it goes is wrong. + elbow(70, "Backwards", vec![point(100.0, 650.0, 1.0, 0.0), point(200.0, 740.0, 0.0, 1.0)]), + elbow(71, "Inside", vec![point(150.0, 740.0, 1.0, 0.0), point(350.0, 800.0, 0.0, 1.0)]), ]); let (doc, warnings) = import(&canvas(&schema(), &message), "Unfit paths").unwrap(); let line = |name: &str| -> Vec<(f64, f64)> { @@ -935,7 +939,7 @@ fn an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here() { }; let plain = line("Plain"); assert!(plain.len() >= 3, "routed in right angles: {plain:?}"); - for name in ["Sideways", "Askew", "Repeated"] { + for name in ["Sideways", "Askew", "Repeated", "Backwards", "Inside"] { assert_eq!(line(name), plain, "{name} is routed as one without a path"); } assert!(warnings.iter().any(|w| w.contains("FigCraft's own routing")), "{warnings:?}"); diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 835e3ac00..d60a70c0d 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -187,7 +187,7 @@ source paint coordinates. | Date | Change | Summary | |---|---|---| -| 2026-11-04 | minor | `.fig` and `.jam` import, #1910: an elbowed connector saved with its path keeps it. FigJam stores `connectorControlPoints`, one per run between the first and the last, each a point on its run (in the connector's parent's coordinates) with the run's axis; the first run leaves the start's side and the last arrives at the end's. They become the `ConnectorPath::Runs` a board connector reshaped by hand has (`figcraft_doc::route_along`), so a connector drawn around a layer in FigJam stays around it instead of being routed through it. Points that don't make such a path (off both axes, two runs in a row the same way, a first or last run sideways to its side, more runs than a hand could make) leave the connector to the router as before, and only connectors routed here count in the "follow FigCraft's own routing" note. A curved connector's `connectorBezierControlPoints` are still not read. Tests: `tail_tests::an_elbow_connector_saved_with_its_path_keeps_it`, `tail_tests::an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here`. | +| 2026-11-04 | minor | `.fig` and `.jam` import, #1910: an elbowed connector saved with its path keeps it. FigJam stores `connectorControlPoints`, one per run between the first and the last, each a point on its run (in the connector's parent's coordinates) with the run's axis; the first run leaves the start's side and the last arrives at the end's. They become the `ConnectorPath::Runs` a board connector reshaped by hand has (`figcraft_doc::route_along`), so a connector drawn around a layer in FigJam stays around it instead of being routed through it. Points that don't make such a path (off both axes, two runs in a row the same way, a first or last run sideways to its side or going back into its object, more runs than a hand could make) leave the connector to the router as before, and only connectors routed here count in the "follow FigCraft's own routing" note. A curved connector's `connectorBezierControlPoints` are still not read. Tests: `tail_tests::an_elbow_connector_saved_with_its_path_keeps_it`, `tail_tests::an_elbow_whose_saved_path_doesnt_fit_its_sides_is_routed_here`. | | 2026-11-01 | patch | `.fig` and `.jam` import: a connector without a saved snapshot (elbowed and curved ones are routed here) took no stroke, so it was invisible (#1807); its line's paint, weight, cap and dashes now come from the file's generated line record, as a saved snapshot's do, and the connector's own values, when it has any, win. Test: `fig::connector_label_tests::a_routed_connector_takes_its_line_style_from_the_generated_record`. Numbers unchanged | | 2026-10-31 | patch | M4: Dash and Custom strokes have a Dash cap (None, Round, Square) in the advanced stroke settings and `node.set {dashCap}`, on both ends of every dash on the canvas and in PNG, PDF and SVG. Unset, dashes keep taking the end point caps, so older files look the same; the saved file writes it only when set. Numbers unchanged | | 2026-10-30 | minor | `.fig` import: a connector's label without a saved snapshot was skipped; now the connector imports as a frame holding its line and the label, as a connector with a saved snapshot does, the label centred on the line's middle by length (in a 200-wide box, laid out again with the fonts at hand), in the connector's fill paints or black. Its background isn't known without the snapshot and is left out. Not checked on real files. Test: `fig::tests::tail::a_labelled_connector_without_a_snapshot_keeps_its_label` | From fccaa431014d9dc3c4565aae05849f74b79f8d8a Mon Sep 17 00:00:00 2001 From: fluid-chey Date: Wed, 4 Nov 2026 12:17:25 -0700 Subject: [PATCH 50/68] M9: a joined live session keeps reconnecting and says when it's disconnected A session you joined could end for reasons that pass, or after about 85 s of retries, and its tab then looked like an unsaved local file. Work done there reached no one, with only a 3 s toast to say so. A live connection now reconnects until you leave, pausing a minute after each 12 attempts. Only refusals that are for good stop it, so "too many messages", "busy" and the like retry. Messages queued while offline go out paced so a long queue can't trip the server's rate limit. A session that ended stays on its tab: the tab shows a red mark and a strip across the canvas offers Retry now or Try again, Save a copy and Dismiss. Joining again uses the same tab, and what changed offline opens beside it as an unsaved copy. A session that gets out of step joins again by itself. Co-Authored-By: Claude Opus 5.5 --- apps/figcraft-server/src/codes_tests.rs | 2 +- apps/figcraft-server/src/server_tests.rs | 2 +- crates/collab-net/src/driver.rs | 47 +++++++-- crates/collab-net/src/driver_tests.rs | 115 +++++++++++++++++++++-- crates/collab-net/src/guest.rs | 23 ++++- crates/collab-net/src/join.rs | 53 +++++++++-- crates/collab-net/src/link.rs | 6 ++ crates/collab-net/src/session_tests.rs | 5 +- crates/collab-net/src/sessions_tests.rs | 4 +- crates/collab-net/src/throttle.rs | 27 ++++++ crates/collab-net/src/web.rs | 4 + crates/engine/src/collab_live_tests.rs | 111 ++++++++++++++++++++++ crates/engine/src/live_tests.rs | 10 +- crates/engine/src/sharing/live.rs | 47 +++++++++ crates/engine/src/sharing/live/events.rs | 58 ++++++++++-- crates/engine/src/sharing/live/join.rs | 27 +++++- crates/engine/src/sharing/live/sync.rs | 9 +- crates/engine/src/sharing/live/types.rs | 2 + crates/ui-egui/locales/en.toml | 7 ++ crates/ui-egui/src/canvas.rs | 10 +- crates/ui-egui/src/icons.rs | 2 + crates/ui-egui/src/icons/draw.rs | 8 ++ crates/ui-egui/src/live.rs | 64 +++++++++++++ crates/ui-egui/src/live_joining_tests.rs | 49 ++++++++++ crates/ui-egui/src/live_tests.rs | 2 +- crates/ui-egui/src/tabs.rs | 26 +++-- docs/collab-protocol.md | 18 +++- docs/collaboration-parity.md | 1 + docs/mcp.md | 5 +- docs/server.md | 2 +- 30 files changed, 687 insertions(+), 59 deletions(-) diff --git a/apps/figcraft-server/src/codes_tests.rs b/apps/figcraft-server/src/codes_tests.rs index cbc7f70a7..42b15961e 100644 --- a/apps/figcraft-server/src/codes_tests.rs +++ b/apps/figcraft-server/src/codes_tests.rs @@ -118,7 +118,7 @@ fn a_file_shared_online_is_joined_by_its_codes() { }); for guest in [&b, &c] { assert!(guest.message.as_deref().unwrap_or_default().contains("Sharing was stopped"), "{:?}", guest.message); - assert_eq!(guest.live().status, Status::Off, "over, not failed: nothing retries"); + assert!(guest.live().rejoinable() && !guest.live().status.active(), "over: nothing retries, and the tab says so"); } assert_eq!(layers(&b), before + 2, "Bo keeps the copy"); let folder = dir.path().join("files").join(&p.file); diff --git a/apps/figcraft-server/src/server_tests.rs b/apps/figcraft-server/src/server_tests.rs index f60150da9..f3d084499 100644 --- a/apps/figcraft-server/src/server_tests.rs +++ b/apps/figcraft-server/src/server_tests.rs @@ -160,7 +160,7 @@ fn revoked_links_stop_working_at_once() { assert_eq!((files.len(), files[0].people), (1, 3)); // Revoked: Cy is out at once, the others stay. assert_eq!(ask(Admin::Revoke { file: file.clone(), link: review.link.id.clone() }), AdminReply::Done); - pump(&mut [&mut a, &mut b, &mut c], "Cy out", |s| s[2].live().status == Status::Off && s[0].live().peers.len() == 1); + pump(&mut [&mut a, &mut b, &mut c], "Cy out", |s| s[2].live().rejoinable() && s[0].live().peers.len() == 1); // Told as when a host stops: the session is over for Cy, whose copy stays open (no retries). assert!(c.message.as_deref().unwrap_or_default().contains("Sharing was stopped"), "{:?}", c.message); assert!(live(&b)); diff --git a/crates/collab-net/src/driver.rs b/crates/collab-net/src/driver.rs index 3ddd3b3c1..d96650371 100644 --- a/crates/collab-net/src/driver.rs +++ b/crates/collab-net/src/driver.rs @@ -18,6 +18,7 @@ use figcraft_collab::message::{self, ClientMsg, Presence, ServerMsg}; use figcraft_engine::live::{Event, Status}; +use std::collections::VecDeque; use std::time::Duration; // `std::time::Instant` on native builds; the browser's clock in the web build. use web_time::Instant; @@ -28,7 +29,7 @@ use crate::invite::Endpoint; use crate::join::{GuestConfig, Next, Outcome, Resuming, Seen, Taken, after, ask, closed, hello, resolved, take, too_large, unresolved}; use crate::limits::NetLimits; use crate::requests::Publish; -use crate::throttle::{PRESENCE_INTERVAL, Throttle, earliest}; +use crate::throttle::{PRESENCE_INTERVAL, Pace, Throttle, earliest}; /// A WebSocket the driver opens, writes and closes; what it receives comes back through the /// driver's event methods. @@ -79,6 +80,9 @@ pub(crate) struct Driver { /// Your latest presence while not welcomed (sent with the welcome). pending: Option, throttle: Throttle, + /// Sync messages waiting their turn (a long queue from while offline), and when each may go. + pace: Pace, + paced: VecDeque<(Instant, ClientMsg)>, reconnect_at: Option, /// What this connection asks a server (a managing one), and what follows its answers. asking: Option<(Box, Then)>, @@ -86,7 +90,7 @@ pub(crate) struct Driver { } impl Driver { - fn new(sock: S, cfg: GuestConfig, inbox: Inbox) -> Self { + fn new(sock: S, cfg: GuestConfig, inbox: Inbox, now: Instant) -> Self { Self { sock, cfg, @@ -97,6 +101,8 @@ impl Driver { resume: Resuming::default(), pending: None, throttle: Throttle::new(PRESENCE_INTERVAL), + pace: Pace::new(now), + paced: VecDeque::new(), reconnect_at: None, asking: None, done: false, @@ -105,7 +111,7 @@ impl Driver { /// Start joining (progress arrives in `inbox`). pub(crate) fn start(sock: S, cfg: GuestConfig, inbox: Inbox, now: Instant) -> Self { - let mut d = Self::new(sock, cfg, inbox); + let mut d = Self::new(sock, cfg, inbox, now); d.inbox.push(Event::Status(Status::Connecting)); d.connect(now); d @@ -114,7 +120,7 @@ impl Driver { /// Start with what `next` asks a server (a background request): the events it ends in go to /// `inbox`, then the join it ends in, if any, as `cfg` says. pub(crate) fn asking(sock: S, cfg: GuestConfig, next: exchange::Next, inbox: Inbox, now: Instant) -> Self { - let mut d = Self::new(sock, cfg, inbox); + let mut d = Self::new(sock, cfg, inbox, now); d.follow(next, now); d } @@ -303,8 +309,31 @@ impl Driver { if !self.conn.as_ref().is_some_and(|c| c.welcomed) { return; } - if !self.write(&msg) { - self.end(Outcome::Retry("the connection dropped".into()), now); + let wait = self.pace.wait(now); + if wait.is_zero() && self.paced.is_empty() { + if !self.write(&msg) { + self.end(Outcome::Retry("the connection dropped".into()), now); + } + } else { + self.paced.push_back((now + wait, msg)); + } + } + + /// Send the sync messages whose turn has come; false when one couldn't go. + fn send_paced(&mut self, now: Instant) -> bool { + while let Some((_, msg)) = self.paced.pop_front_if(|(at, _)| *at <= now) { + if !self.write(&msg) { + return false; + } + } + true + } + + /// Reconnect now, if it is waiting to: the pauses grow from the beginning again. + pub(crate) fn retry(&mut self, now: Instant) { + if !self.done && self.reconnect_at.is_some() { + self.attempt = 0; + self.connect(now); } } @@ -327,7 +356,7 @@ impl Driver { [Some(c.last_ping + l.keepalive), Some(c.last_heard + c.silence_limit(l)), if c.welcomed { self.throttle.due() } else { None }] } }); - earliest(conn.into_iter().flatten().chain([self.reconnect_at])) + earliest(conn.into_iter().flatten().chain([self.reconnect_at, self.paced.front().map(|(at, _)| *at)])) } /// Do what's due at `now`: reconnect, send held presence or a ping, give up on a connection @@ -357,7 +386,7 @@ impl Driver { if now >= last_heard + silence { return self.end(Outcome::Retry("the host stopped answering".into()), now); } - let ok = self.throttle.take_due(now).is_none_or(|p| self.write(&ClientMsg::Presence(p))); + let ok = self.send_paced(now) && self.throttle.take_due(now).is_none_or(|p| self.write(&ClientMsg::Presence(p))); let ok = ok && (now < last_ping + l.keepalive || self.ping(now)); if !ok { self.end(Outcome::Retry("the connection dropped".into()), now); @@ -388,6 +417,8 @@ impl Driver { self.sock.close(); } self.throttle = Throttle::new(PRESENCE_INTERVAL); + // Made for this connection: the sync client sends again what the server didn't get. + self.paced.clear(); match after(outcome, &self.cfg, self.was_live, &mut self.attempt, &self.inbox) { Next::Stop(e) => { if let Some(e) = e { diff --git a/crates/collab-net/src/driver_tests.rs b/crates/collab-net/src/driver_tests.rs index ea7900745..57921df3d 100644 --- a/crates/collab-net/src/driver_tests.rs +++ b/crates/collab-net/src/driver_tests.rs @@ -252,7 +252,7 @@ fn a_silent_host_counts_as_dropped_and_the_client_reconnects() { } #[test] -fn reconnects_back_off_then_give_up() { +fn a_live_connection_reconnects_in_rounds_and_never_gives_up() { let t0 = Instant::now(); let (mut d, inbox) = start(Script::default(), t0); d.opened(t0); @@ -260,7 +260,7 @@ fn reconnects_back_off_then_give_up() { let mut now = t0; let mut pauses = Vec::new(); d.closed(1006, "", now); - while !d.done() { + for _ in 0..26 { let next = d.deadline().unwrap(); pauses.push(next - now); now = next; @@ -269,11 +269,114 @@ fn reconnects_back_off_then_give_up() { d.closed(1006, "", now); } let secs: Vec = pauses.iter().map(Duration::as_secs_f64).collect(); - assert_eq!(secs, [0.5, 1.0, 2.0, 4.0, 8.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0]); + let round = [1.0, 2.0, 4.0, 8.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0]; + assert_eq!(secs[0], 0.5); + assert_eq!(secs[1..12], round); + assert_eq!(secs[12], 60.0, "a longer pause after a round"); + assert_eq!(secs[13..24], round, "then as many again"); + assert_eq!(secs[24], 60.0); + assert!(!d.done()); let st = statuses(&inbox.drain()); - assert_eq!(st.len(), 14, "connecting, 12 reconnects, then failed"); - assert!(matches!(st.last(), Some(Status::Failed { reason }) if reason.starts_with("Lost the connection to the host")), "{st:?}"); - assert_eq!(d.deadline(), None); + assert!(!st.iter().any(|s| matches!(s, Status::Failed { .. })), "{st:?}"); + assert!(matches!(st.last(), Some(Status::Reconnecting { attempt: 27 })), "{st:?}"); +} + +#[test] +fn retry_now_skips_the_pause_and_starts_the_round_over() { + let t0 = Instant::now(); + let (mut d, inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + d.closed(1006, "", t0); + let mut now = t0; + for _ in 0..12 { + now = d.deadline().unwrap(); + d.tick(now); + d.closed(1006, "", now); + } + assert_eq!(d.deadline().unwrap() - now, Duration::from_secs(60)); + let opened = d.sock.opened.len(); + d.retry(now); + assert_eq!(d.sock.opened.len(), opened + 1, "connects at once"); + inbox.drain(); + d.closed(1006, "", now); + assert_eq!(statuses(&inbox.drain()), vec![Status::Reconnecting { attempt: 1 }]); + assert_eq!(d.deadline().unwrap() - now, ms(500), "the pauses grow from the beginning again"); +} + +#[test] +fn a_session_that_was_live_only_stops_for_a_refusal_that_is_for_good() { + let t0 = Instant::now(); + // The words servers turn a session away with for now. + for reason in [ + "too many messages", + "the server is busy: try again in a moment", + "the session is full", + "no hello in time", + "this file can't be opened on the server (its data is damaged); tell the server's owner", + "too many connections from your address lately: wait a minute and try again", + ] { + for frame in [false, true] { + let (mut d, inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + inbox.drain(); + if frame { + d.closed(1008, reason, t0); + } else { + d.message(&encode(&ServerMsg::Refused { reason: reason.into() }), t0); + } + assert!(!d.done(), "{reason}"); + assert_eq!(statuses(&inbox.drain()), vec![Status::Reconnecting { attempt: 1 }], "{reason}"); + } + } + // And the words for good. + for reason in [ + "this link isn't valid (it may have been revoked)", + "this file isn't on the server (it may have been removed)", + "this file was removed from the server", + "you were removed from this session", + "this server no longer accepts connections from your address", + "this server doesn't accept connections from your address", + "wrong session token", + "protocol 9 isn't supported", + "message too large: this server takes at most 64 MiB at once (a change that big can't be kept here)", + ] { + let (mut d, inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + d.closed(1008, reason, t0); + assert!(d.done(), "{reason}"); + assert!(matches!(statuses(&inbox.drain()).last(), Some(Status::Failed { reason: r }) if r.contains(reason)), "{reason}"); + } +} + +#[test] +fn a_long_queue_goes_out_paced_and_in_order() { + let t0 = Instant::now(); + let (mut d, _inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + let before = d.sock.sent.len(); + for seq in 0..500 { + d.send(ClientMsg::Ack { seq }, t0); + } + let at_once = d.sock.sent.len() - before; + assert!((1..=200).contains(&at_once), "{at_once} at once: a server drops a connection past 400"); + let mut now = t0; + while d.sock.sent.iter().filter(|m| matches!(m, ClientMsg::Ack { .. })).count() < 500 { + now = d.deadline().unwrap(); + d.tick(now); + } + let seqs: Vec = d.sock.sent.iter().filter_map(|m| if let ClientMsg::Ack { seq } = m { Some(*seq) } else { None }).collect(); + assert_eq!(seqs, (0..500).collect::>()); + assert!(now - t0 >= Duration::from_secs(4), "the rest take their time: {:?}", now - t0); + // Unsent ones were made for this connection: the sync client sends them again. + for seq in 0..500 { + d.send(ClientMsg::Ack { seq }, now); + } + d.closed(1006, "", now); + assert_eq!(d.deadline().unwrap() - now, ms(500), "nothing left to send but the reconnect"); } #[test] diff --git a/crates/collab-net/src/guest.rs b/crates/collab-net/src/guest.rs index bdb5b98b2..84572b884 100644 --- a/crates/collab-net/src/guest.rs +++ b/crates/collab-net/src/guest.rs @@ -31,7 +31,7 @@ use crate::manage; use crate::net::{Duplex, NetLimits, config, open, shutdown}; use crate::requests; pub use crate::requests::Publish; -use crate::throttle::{PRESENCE_INTERVAL, Throttle, earliest}; +use crate::throttle::{PRESENCE_INTERVAL, Pace, Throttle, earliest}; /// A joined (or joining) session. Dropping it leaves. pub struct Guest { @@ -44,6 +44,8 @@ enum Cmd { /// For the server, in order (document changes). Send(ClientMsg), Leave, + /// Try now rather than after the pause under way (reconnecting). + Retry, /// The reader of connection `epoch` got its welcome. Welcomed(u64), /// Connection `epoch` ended. @@ -133,6 +135,11 @@ impl Guest { let _ = self.cmd.send(Cmd::Send(msg)); } + /// Reconnect now, if it is waiting to. + pub fn retry(&self) { + let _ = self.cmd.send(Cmd::Retry); + } + /// Leave (returns at once: a connection attempt in progress ends on its own). pub fn leave(&mut self) { let _ = self.cmd.send(Cmd::Leave); @@ -227,6 +234,11 @@ fn supervise(cfg: &GuestConfig, inbox: &Inbox, rx: &Receiver, me: &Sender return, Ok(Cmd::Presence(p)) => pending = Some(p), + // A fresh start: the pauses grow from the beginning again. + Ok(Cmd::Retry) => { + attempt = 0; + break; + } // From the old connection's client: the next welcome starts over. Ok(_) => {} Err(RecvTimeoutError::Timeout) => break, @@ -267,6 +279,7 @@ fn session( let hello = hello(cfg, resume); let mut welcomed = false; let mut throttle = Throttle::new(PRESENCE_INTERVAL); + let mut pace = Pace::new(Instant::now()); let outcome = if send(&mut writer, &hello) { loop { let ping_at = last_ping + cfg.limits.keepalive; @@ -274,7 +287,11 @@ fn session( let mut out = None; let mut now_send = Vec::new(); match rx.recv_timeout(wake.saturating_duration_since(Instant::now())) { - Ok(Cmd::Send(m)) if welcomed => now_send.push(m), + Ok(Cmd::Send(m)) if welcomed => { + // A long queue from while offline doesn't go out faster than the server takes it. + std::thread::sleep(pace.wait(Instant::now())); + now_send.push(m); + } // Made for the previous connection (the sync client sends again what the server // didn't get once it has caught up with this connection's welcome). Ok(Cmd::Send(_)) => {} @@ -292,7 +309,7 @@ fn session( break Outcome::Left; } // From an earlier connection. - Ok(Cmd::Welcomed(_) | Cmd::Lost(..)) => {} + Ok(Cmd::Welcomed(_) | Cmd::Lost(..) | Cmd::Retry) => {} Err(RecvTimeoutError::Timeout) => {} } if !now_send.iter().all(|m| send(&mut writer, m)) { diff --git a/crates/collab-net/src/join.rs b/crates/collab-net/src/join.rs index 033186af2..63f94bec2 100644 --- a/crates/collab-net/src/join.rs +++ b/crates/collab-net/src/join.rs @@ -39,8 +39,10 @@ pub struct GuestConfig { /// The pause before the first reconnect; it doubles each time up to `max_backoff`. pub backoff: Duration, pub max_backoff: Duration, - /// Reconnect attempts before giving up. + /// Reconnect attempts in a row before the longer pause (`round_pause`), after which it tries + /// as many again: a connection that was live is never given up on by itself. pub attempts: u32, + pub round_pause: Duration, /// Join as the client you were (an app that starts over after a crash): the first hello /// carries it, and a server that still knows the id gives it back. pub resume: Option, @@ -57,6 +59,7 @@ impl GuestConfig { backoff: Duration::from_millis(500), max_backoff: Duration::from_secs(10), attempts: 12, + round_pause: Duration::from_secs(60), resume: None, } } @@ -65,6 +68,14 @@ impl GuestConfig { pub(crate) fn backoff(&self, attempt: u32) -> Duration { self.backoff.saturating_mul(1u32 << attempt.saturating_sub(1).min(16)).min(self.max_backoff) } + + /// The pause before reconnect attempt `attempt` (from 1): growing within a round of + /// [`attempts`](Self::attempts), and [`round_pause`](Self::round_pause) between rounds. + pub(crate) fn pause(&self, attempt: u32) -> Duration { + let round = self.attempts.max(1); + let into_round = attempt.saturating_sub(1) % round; + if into_round == 0 && attempt > round { self.round_pause } else { self.backoff(into_round + 1) } + } } /// How a connection ended. @@ -143,11 +154,38 @@ pub(crate) enum Next { Reconnect(Duration), } -/// After `outcome`: a refusal or the end of the session is final, and so is a first join that -/// can't reach the host; a live connection that dropped tries again with growing pauses until the -/// attempts run out. +/// What a server refuses for good, whenever you ask: the link, the file or your place in it is +/// gone, or the two versions can't talk. Anything else a server refuses a session with (it is +/// busy, a limit was hit, the file couldn't be read just now) may pass, and servers of any version +/// say so in these words, so a reason not listed here means try again. +const FINAL_REFUSALS: [&str; 11] = [ + "isn't valid", + "isn't on the server", + "was removed from the server", + "were removed from this session", + "no longer accepts connections", + "doesn't accept connections", + "wrong session token", + "isn't supported", + "couldn't be read", + "message too large", + "this version can't read", +]; + +/// Whether `reason`, from a server refusing a session that was live, is for good. +pub(crate) fn final_refusal(reason: &str) -> bool { + FINAL_REFUSALS.iter().any(|f| reason.contains(f)) +} + +/// After `outcome`: the end of the session is final, and so are a refusal for good and a first +/// join that can't reach the host. A live connection that dropped or was turned away for now tries +/// again until you leave: with growing pauses, and a longer one between rounds. pub(crate) fn after(outcome: Outcome, cfg: &GuestConfig, was_live: bool, attempt: &mut u32, inbox: &Inbox) -> Next { let failed = |reason: String| Next::Stop(Some(Event::Status(Status::Failed { reason }))); + let outcome = match outcome { + Outcome::Refused(why) if was_live && !final_refusal(&why) => Outcome::Retry(why), + o => o, + }; match outcome { Outcome::Left => Next::Stop(None), Outcome::Refused(why) => failed(format!("The host refused: {why}")), @@ -155,13 +193,10 @@ pub(crate) fn after(outcome: Outcome, cfg: &GuestConfig, was_live: bool, attempt Outcome::Ended(reason) => Next::Stop(Some(Event::Ended { reason })), Outcome::Retry(why) if !was_live => failed(format!("Couldn't join the live session: {why}")), Outcome::Retry(why) => { - *attempt += 1; - if *attempt > cfg.attempts { - return failed(format!("Lost the connection to the host ({why})")); - } + *attempt = attempt.saturating_add(1); log::info!("live session: connection lost ({why}); reconnecting, attempt {attempt}"); inbox.push(Event::Status(Status::Reconnecting { attempt: *attempt })); - Next::Reconnect(cfg.backoff(*attempt)) + Next::Reconnect(cfg.pause(*attempt)) } } } diff --git a/crates/collab-net/src/link.rs b/crates/collab-net/src/link.rs index fdcba5b97..0024da781 100644 --- a/crates/collab-net/src/link.rs +++ b/crates/collab-net/src/link.rs @@ -266,6 +266,12 @@ impl LiveLink for NetLink { } } + fn retry(&mut self, session: SessionId) { + if let Some(Active::Guest(g)) = self.sessions.get(session) { + g.retry(); + } + } + fn presence(&mut self, session: SessionId, p: &Presence) { match self.sessions.get(session) { Some(Active::Host(h)) => h.presence(p.clone()), diff --git a/crates/collab-net/src/session_tests.rs b/crates/collab-net/src/session_tests.rs index 4d5680eed..51b9e89b6 100644 --- a/crates/collab-net/src/session_tests.rs +++ b/crates/collab-net/src/session_tests.rs @@ -124,8 +124,9 @@ fn following_a_viewport_until_you_move() { fn the_host_stopping_ends_the_session_for_guests() { let (mut host, mut guest, _, _) = host_and_join(); host.execute("collab.stop", &json!({})).unwrap(); - pump(&mut host, &mut guest, "the end", |_, g| g.live().status == Status::Off); - assert!(guest.live().peers.is_empty()); + pump(&mut host, &mut guest, "the end", |_, g| g.live().rejoinable()); + assert!(guest.live().peers.is_empty() && !guest.live().syncing()); + assert!(guest.live().disconnected(), "the tab says so"); assert_eq!(guest.message.as_deref(), Some(crate::host::ENDED)); } diff --git a/crates/collab-net/src/sessions_tests.rs b/crates/collab-net/src/sessions_tests.rs index 4a2579f8e..d21668150 100644 --- a/crates/collab-net/src/sessions_tests.rs +++ b/crates/collab-net/src/sessions_tests.rs @@ -158,8 +158,8 @@ fn two_files_are_hosted_and_joined_independently() { assert!(host.live_of(hb).presence.get(&ada(&host, hb)).is_none_or(|p| p.cursor.is_none()), "no cursor in the file that isn't in front"); // The host closes B: its session ends for everyone, A's goes on. host.execute("file.close", &json!({"index": 1, "force": true})).unwrap(); - pump(&mut [&mut host, &mut guest], "B's session ending", |s| s[0].live.iter().count() == 1 && s[1].live.iter().count() == 1); - assert_eq!(guest.live_of(gb).status, Status::Off); + pump(&mut [&mut host, &mut guest], "B's session ending", |s| s[0].live.iter().count() == 1 && s[1].live_of(gb).rejoinable()); + assert!(guest.live_of(gb).disconnected(), "the guest's tab says so"); assert_eq!(guest.docs.len(), 3, "the guest keeps its copy of B"); assert_eq!((host.live_of(ha).status.clone(), host.live_of(ha).peers.len()), (Status::Live, 1)); assert_eq!(guest.live_of(ga).status, Status::Live); diff --git a/crates/collab-net/src/throttle.rs b/crates/collab-net/src/throttle.rs index beff3e6f8..1f90ff504 100644 --- a/crates/collab-net/src/throttle.rs +++ b/crates/collab-net/src/throttle.rs @@ -10,6 +10,33 @@ use web_time::Instant; /// How often presence goes out at most. pub const PRESENCE_INTERVAL: Duration = Duration::from_millis(33); +/// How many messages other than presence go out at once, and per second after that: with presence +/// and pings that stays under what a server takes from a connection before it drops it. +const PACE_BURST: f64 = 200.0; +const PACE_RATE: f64 = 60.0; + +/// Paces messages that must all go out (everything queued while offline leaves at once when the +/// connection comes back): `wait` says how long until the next may. +#[derive(Debug)] +pub struct Pace { + tokens: f64, + last: Instant, +} + +impl Pace { + pub fn new(now: Instant) -> Self { + Self { tokens: PACE_BURST, last: now } + } + + /// Take one message's turn at `now`: how long to wait before sending it (zero: at once). + pub fn wait(&mut self, now: Instant) -> Duration { + let passed = now.saturating_duration_since(self.last).as_secs_f64(); + self.last = now; + self.tokens = (self.tokens + passed * PACE_RATE).min(PACE_BURST) - 1.0; + if self.tokens >= 0.0 { Duration::ZERO } else { Duration::from_secs_f64(-self.tokens / PACE_RATE) } + } +} + #[derive(Debug)] pub struct Throttle { interval: Duration, diff --git a/crates/collab-net/src/web.rs b/crates/collab-net/src/web.rs index 32fbaad9d..8c54f6c23 100644 --- a/crates/collab-net/src/web.rs +++ b/crates/collab-net/src/web.rs @@ -242,6 +242,10 @@ impl LiveLink for NetLink { } } + fn retry(&mut self, session: SessionId) { + self.with(session, |d, now| d.retry(now)); + } + fn presence(&mut self, session: SessionId, p: &Presence) { self.with(session, |d, now| d.presence(p.clone(), now)); } diff --git a/crates/engine/src/collab_live_tests.rs b/crates/engine/src/collab_live_tests.rs index d53eeff26..6499c1895 100644 --- a/crates/engine/src/collab_live_tests.rs +++ b/crates/engine/src/collab_live_tests.rs @@ -318,6 +318,117 @@ fn a_dropped_connection_keeps_editing_and_catches_up() { assert_eq!((doc.node(r).unwrap().name.as_str(), doc.node(f).unwrap().name.as_str()), ("Sent", "Offline")); } +impl Room { + /// Person `i` has been told to join again: the server takes them as someone new. + fn welcome_anew(&mut self, i: usize) { + let ClientMsg::Hello(h) = Client::hello("f", "t", "Person", "") else { panic!("not a hello") }; + let (id, out) = self.server.join(h).unwrap(); + let w = welcome_of(&out, id); + let p = &mut self.people[i]; + p.id = id; + p.online = true; + p.script.lock().unwrap().events.extend([Event::Welcome { info: info(Role::Guest, id), peers: vec![] }, Event::Sync(w)]); + p.s.live_poll(); + } + + fn event(&mut self, i: usize, e: Event) { + let p = &mut self.people[i]; + p.script.lock().unwrap().events.push(e); + p.s.live_poll(); + } +} + +#[test] +fn reconnecting_can_be_told_to_try_now_and_shows_as_disconnected() { + let mut room = Room::new(base(), 1, 7); + assert!(!room.s(0).live().disconnected()); + assert!(room.s(0).execute("collab.reconnect", &json!({})).is_err(), "nothing was lost"); + room.disconnect(0); + assert!(room.s(0).live().disconnected()); + assert_eq!(room.s(0).execute("collab.reconnect", &json!({})).unwrap()["status"], "reconnecting"); + let session = room.s(0).live().id; + assert_eq!(room.people[0].script.lock().unwrap().retried, [session]); +} + +#[test] +fn a_session_that_cant_go_on_stays_on_its_tab_and_joins_again_there() { + let mut room = Room::new(base(), 2, 7); + let (f, r) = frame_and_rect(room.server.document()); + let uid = room.s(0).ds().unwrap().uid; + let tabs = room.s(0).docs.len(); + room.disconnect(0); + room.s(0).execute("node.set", &json!({"id": r, "props": {"name": "Offline"}})).unwrap(); + room.event(0, Event::Status(Status::Failed { reason: "The host refused: this link isn't valid".into() })); + // The tab says so, and is yours to go on working in. + let live = room.s(0).live(); + assert!(live.disconnected() && live.rejoinable() && live.doc_uid == Some(uid)); + assert!(room.s(0).live_read_only(uid).is_none()); + room.s(0).execute("node.set", &json!({"id": f, "props": {"name": "Offline too"}})).unwrap(); + // A try that fails leaves it just as it was. + assert_eq!(room.s(0).execute("collab.reconnect", &json!({})).unwrap()["status"], "connecting"); + assert!(room.s(0).live().disconnected() && !room.s(0).live().rejoinable()); + assert!(room.s(0).live_read_only(uid).is_none(), "it can still be edited while it tries"); + room.event(0, Event::Status(Status::Failed { reason: "Couldn't join the live session: no answer".into() })); + assert!(room.s(0).live().rejoinable()); + // Someone else's edit lands meanwhile. + room.s(1).execute("transform.move", &json!({"ids": [r], "dx": 5, "dy": 5})).unwrap(); + room.settle(); + // The next try joins in the same tab, and what was done offline opens beside it. + room.s(0).execute("collab.reconnect", &json!({})).unwrap(); + room.welcome_anew(0); + let s = room.s(0); + assert_eq!(s.live().status, Status::Live); + assert!(!s.live().disconnected()); + assert_eq!(s.docs.len(), tabs + 1, "the copy's is the only new tab"); + let (tab, copy) = (s.docs.iter().find(|d| d.uid == uid).unwrap(), s.docs.last().unwrap()); + assert_eq!(s.live().doc_uid, Some(uid)); + assert_ne!(tab.doc.node(r).unwrap().name, "Offline", "the session's tab shows the server's version"); + assert_eq!(copy.doc.name, format!("{} (offline copy)", tab.doc.name)); + assert_eq!(copy.doc.node(r).unwrap().name, "Offline"); + assert_eq!(copy.doc.node(f).unwrap().name, "Offline too"); + assert!(copy.is_dirty(), "closing the copy asks first"); + assert!(s.message.as_deref().is_some_and(|m| m.contains("offline copy"))); +} + +#[test] +fn joining_again_with_nothing_changed_opens_no_copy() { + let mut room = Room::new(base(), 1, 7); + let tabs = room.s(0).docs.len(); + room.disconnect(0); + room.event(0, Event::Ended { reason: "Sharing was stopped".into() }); + assert!(room.s(0).live().rejoinable(), "the end of a session you were in shows on its tab too"); + assert_eq!(room.s(0).message.as_deref(), Some("Sharing was stopped")); + room.s(0).execute("collab.reconnect", &json!({})).unwrap(); + room.welcome_anew(0); + assert_eq!(room.s(0).docs.len(), tabs); + assert_eq!(room.s(0).live().status, Status::Live); +} + +#[test] +fn a_session_out_of_step_joins_again_by_itself() { + let mut room = Room::new(base(), 1, 7); + let joins = room.people[0].script.lock().unwrap().joined.len(); + let tabs = room.s(0).docs.len(); + // A batch from far in the future: it can't be applied. + room.event(0, Event::Sync(ServerMsg::Changes(figcraft_collab::Accepted { seq: 999, author: 42, batch_id: 1, changes: vec![] }))); + assert_eq!(room.s(0).live().status, Status::Connecting); + assert!(room.s(0).live().disconnected()); + assert_eq!(room.people[0].script.lock().unwrap().joined.len(), joins + 1); + room.welcome_anew(0); + assert_eq!(room.s(0).live().status, Status::Live); + assert_eq!(room.s(0).docs.len(), tabs); +} + +#[test] +fn leaving_a_lost_session_makes_the_tab_a_plain_copy() { + let mut room = Room::new(base(), 1, 7); + room.disconnect(0); + room.event(0, Event::Status(Status::Failed { reason: "gone".into() })); + room.s(0).execute("collab.leave", &json!({})).unwrap(); + assert_eq!(room.s(0).live().status, Status::Off); + assert!(!room.s(0).live().disconnected()); +} + #[test] fn random_commands_with_undo_and_drops_converge_through_the_engine() { for seed in 0..6 { diff --git a/crates/engine/src/live_tests.rs b/crates/engine/src/live_tests.rs index 1bae1b106..0b2b7c993 100644 --- a/crates/engine/src/live_tests.rs +++ b/crates/engine/src/live_tests.rs @@ -17,7 +17,9 @@ pub(crate) struct Script { pub(crate) events: Vec, pub(crate) sent: Vec, pub(crate) hosted: Vec, - joined: Vec, + pub(crate) joined: Vec, + /// The sessions told to reconnect now, in order. + pub(crate) retried: Vec, pub(crate) left: usize, pub(crate) msgs: Vec, pub(crate) published: Vec, @@ -46,6 +48,10 @@ impl LiveLink for Mock { i.url = format!("ws://{}/?file=f&token=t", i.address); Ok(i) } + fn retry(&mut self, session: u64) { + self.0.lock().unwrap().retried.push(session); + } + fn join(&mut self, session: u64, link: &str, _: &str) -> Result<(), String> { if !link.starts_with("figcraft://") { return Err("not an invite".into()); @@ -229,7 +235,7 @@ fn events_build_who_is_here() { assert_eq!(s.live_summary()["attempt"], 1); push(&script, vec![Event::Status(Status::Failed { reason: "Lost the connection".into() })]); s.live_poll(); - assert!(s.live().info.is_none()); + assert!(s.live().peers.is_empty() && !s.live().syncing()); assert_eq!(s.live_summary()["reason"], "Lost the connection"); assert_eq!(s.message.as_deref(), Some("Lost the connection")); assert!(!s.live_poll(), "nothing new"); diff --git a/crates/engine/src/sharing/live.rs b/crates/engine/src/sharing/live.rs index 45d56776c..b54331520 100644 --- a/crates/engine/src/sharing/live.rs +++ b/crates/engine/src/sharing/live.rs @@ -140,6 +140,18 @@ pub struct Live { /// The branches of the session's file made or last updated from main in this session: every /// layer of their base was in it (see [`crate::branches`]). branch_bases: BTreeSet, + /// You were in this session and aren't now: what joining it again takes (`collab.reconnect`). + stranded: Option, +} + +/// What's kept of a session you joined once it can't go on by itself. The tab stays yours to work +/// in, and says so. +#[derive(Clone)] +struct Stranded { + /// The invite link you joined with (it holds the token: never shown). + link: String, + /// The server's state when it stopped: what's different from it in the tab is your own work. + confirmed: Box, } impl Live { @@ -158,6 +170,41 @@ impl Live { *self = Live { id: self.id, tab: self.tab, ..Live::default() }; } + /// Keep this session on its tab for joining again (see [`Stranded`]): a session you joined, or + /// one that already is; any other goes back to no session. + fn strand(&mut self) { + let joined = self.info.as_ref().filter(|i| i.role == Role::Guest && !i.link.is_empty()); + let held = self.stranded.take().or_else(|| { + let (client, info) = (self.client.as_ref()?, joined?); + Some(Stranded { link: info.link.clone(), confirmed: Box::new(client.confirmed().clone()) }) + }); + if held.is_none() { + return self.reset(); + } + *self = Live { + id: self.id, + tab: self.tab, + doc_uid: self.doc_uid, + info: self.info.take(), + server: std::mem::take(&mut self.server), + published: self.published.take(), + share: self.share.take(), + stranded: held, + ..Live::default() + }; + } + + /// You were in this session and aren't now: the connection dropped and it is trying again, or + /// it can't go on by itself. What you do in its tab isn't reaching anyone. + pub fn disconnected(&self) -> bool { + matches!(self.status, Status::Reconnecting { .. }) || self.stranded.is_some() + } + + /// The session can be joined again in its tab (`collab.reconnect`). + pub fn rejoinable(&self) -> bool { + self.stranded.is_some() && !self.status.active() + } + /// The document sync client (once the welcome arrived): peers, pending batches, the user's /// undo history. pub fn client(&self) -> Option<&Client> { diff --git a/crates/engine/src/sharing/live/events.rs b/crates/engine/src/sharing/live/events.rs index 757decbc5..5bc94c0f4 100644 --- a/crates/engine/src/sharing/live/events.rs +++ b/crates/engine/src/sharing/live/events.rs @@ -214,8 +214,15 @@ impl Session { // order. Event::Sync(msg) => live.deferred.push(msg), Event::Ended { reason } => { - self.message = Some(if behind.is_empty() { reason } else { format!("{}: {reason}", behind.trim_start()) }); - self.live.end(id); + let joined = live.syncing() && live.role() == Some(Role::Guest); + let text = if behind.is_empty() { reason.clone() } else { format!("{}: {reason}", behind.trim_start()) }; + if joined { + // The tab says so and stays yours: it doesn't pass for a file of your own. + self.live_fail(id, reason); + } else { + self.live.end(id); + } + self.message = Some(text); } Event::Published(p) => { // Shared with a code: the popover shows it, nothing more to say. @@ -389,6 +396,7 @@ impl Session { } (Some(Role::Guest), Some(uid)) => { // Joining again in this tab, or the file you published arriving from the server. + self.live_keep_offline_work(id, uid); let doc = Arc::new(client.document().clone()); let was_dirty = self.docs.iter().find(|d| d.uid == uid).is_some_and(DocState::is_dirty); self.apply_remote(uid, doc.clone()); @@ -435,15 +443,53 @@ impl Session { live.synced = synced; live.client = Some(client); live.deferred.clear(); + live.stranded = None; } - /// Session `id` is over with a message: it couldn't be joined, the connection was lost for - /// good or sync broke. Its tab shows why. + /// Session `id` is back on document `uid` after it couldn't go on, and the server's version is + /// about to replace the tab's: what you did since opens beside it, unsaved, so nothing is lost. + fn live_keep_offline_work(&mut self, id: SessionId, uid: u64) { + let Some(held) = self.live.sessions.get(&id).and_then(|l| l.stranded.as_ref()) else { return }; + let Some(local) = self.docs.iter().find(|d| d.uid == uid).map(|d| d.doc.clone()) else { return }; + let name = local.name.clone(); + // A document that can't be compared is kept too. + if figcraft_collab::diff(&held.confirmed, &local).is_ok_and(|d| d.changes.is_empty()) { + self.message = Some(format!("Reconnected to {name}")); + return; + } + let mut copy = DocState::new((*local).clone(), None); + let copy_name = format!("{name} (offline copy)"); + Arc::make_mut(&mut copy.doc).name.clone_from(©_name); + self.docs.push(copy); + self.message = Some(format!("Reconnected to {name}. What you changed while disconnected is open beside it as “{copy_name}”")); + } + + /// Join session `id` again in its tab (see [`Live::strand`]), as someone new: a fresh join needs + /// nothing from the connection that was lost. + pub(super) fn live_rejoin(&mut self, cmd: &str, id: SessionId) -> Result<()> { + let name = display_name(&self.prefs); + let Some(link) = self.live.sessions.get(&id).and_then(|l| l.stranded.as_ref()).map(|s| s.link.clone()) else { + return Err(crate::bad(cmd, "this file has no live session to join again")); + }; + self.live.leave(id); + if let Some(why) = crate::file_access::network_refused() { + return Err(EngineError::Disabled(cmd.to_string(), why)); + } + let Some(net) = self.live.link() else { return Err(super::unavailable(cmd)) }; + net.join_resuming(id, &link, &name, None).map_err(|e| crate::bad(cmd, e))?; + if let Some(live) = self.live.sessions.get_mut(&id) { + live.status = Status::Connecting; + } + Ok(()) + } + + /// Session `id` is over with a message: it couldn't be joined, it was refused or ended for + /// good, or sync broke. Its tab shows why, and a session you were in can be joined again there. pub(super) fn live_fail(&mut self, id: SessionId, reason: String) { log::warn!("live session: {reason}"); self.live.leave(id); if let Some(live) = self.live.sessions.get_mut(&id) { - live.reset(); + live.strand(); live.status = Status::Failed { reason: reason.clone() }; } self.message = Some(reason); @@ -456,7 +502,7 @@ impl Session { let live = self.live.doc(uid)?; match &live.client { Some(c) => limited_by(c.access()), - None if live.status.active() && live.role() != Some(Role::Host) => Some(PUBLISHING), + None if live.status.active() && live.role() != Some(Role::Host) && !live.disconnected() => Some(PUBLISHING), None => None, } } diff --git a/crates/engine/src/sharing/live/join.rs b/crates/engine/src/sharing/live/join.rs index 836267b2a..75ade0c80 100644 --- a/crates/engine/src/sharing/live/join.rs +++ b/crates/engine/src/sharing/live/join.rs @@ -48,6 +48,24 @@ fn leave(s: &mut Session, p: &Value) -> Result { Ok(json!({"ended": ended.is_some_and(|l| l.status.active())})) } +/// Back into the open file's session now: a reconnect that is waiting tries at once, and a session +/// that couldn't go on is joined again in its tab. +fn reconnect(s: &mut Session, _: &Value) -> Result { + const CMD: &str = "collab.reconnect"; + let live = s.live(); + let (id, reconnecting, rejoinable) = (live.id, matches!(live.status, Status::Reconnecting { .. }), live.rejoinable()); + if reconnecting { + if let Some(net) = s.live.link() { + net.retry(id); + } + } else if rejoinable { + s.live_rejoin(CMD, id)?; + } else { + return Err(bad(CMD, "this file has no lost live session to reconnect")); + } + Ok(json!({"status": s.live().status.id()})) +} + fn stop(s: &mut Session, p: &Value) -> Result { // A file shared online stays its owner's on the server: stopping takes the others' links (and // their codes) away, which disconnects whoever joined with them, and the owner stays in the @@ -192,10 +210,17 @@ pub fn specs() -> Vec { false, join ), + spec!( + "collab.reconnect", + "Reconnect live session", + "{} → {status}: for the open file's session when it is disconnected: a reconnect that is waiting tries now, and a session that couldn't go on (`failed`, the file open in its tab) is joined again there, what you changed since opening beside it. Refused when nothing was lost", + false, + reconnect + ), spec!( "collab.leave", "Leave live session", - "{session? (a session's id from `collab.peers`'s `sessions`, e.g. a join still on its way; default: the open file's session)} → {ended}: the synced file stays open as a local copy", + "{session? (a session's id from `collab.peers`'s `sessions`, e.g. a join still on its way; default: the open file's session)} → {ended}: the synced file stays open as a local copy (also how a tab stops showing a session that couldn't go on)", false, leave ), diff --git a/crates/engine/src/sharing/live/sync.rs b/crates/engine/src/sharing/live/sync.rs index 79f693731..0930151dc 100644 --- a/crates/engine/src/sharing/live/sync.rs +++ b/crates/engine/src/sharing/live/sync.rs @@ -118,7 +118,14 @@ impl Session { for m in std::mem::take(&mut live.deferred) { match client.receive(m, &EngineRecompute) { Ok(more) => out.extend(more), - Err(e) => return self.live_fail(id, format!("The live session got out of step ({e}); join again")), + Err(e) => { + self.live_fail(id, format!("The live session got out of step ({e})")); + // A fresh join has nothing to get out of step with. + if let Err(e) = self.live_rejoin("collab.reconnect", id) { + log::warn!("live session: couldn't join again: {e}"); + } + return; + } } } let doc = Arc::new(client.document().clone()); diff --git a/crates/engine/src/sharing/live/types.rs b/crates/engine/src/sharing/live/types.rs index 93455c0d8..f2108eb36 100644 --- a/crates/engine/src/sharing/live/types.rs +++ b/crates/engine/src/sharing/live/types.rs @@ -496,6 +496,8 @@ pub trait LiveLink: Send { /// End session `session` (stop hosting or leave); the others go on. Nothing for a session /// that is over already. fn leave(&mut self, session: SessionId); + /// Session `session` is waiting to reconnect: try now. + fn retry(&mut self, _session: SessionId) {} /// Your latest presence in `session` (the link throttles and coalesces). fn presence(&mut self, session: SessionId, p: &Presence); /// A message for `session`'s server (document changes), sent in order. diff --git a/crates/ui-egui/locales/en.toml b/crates/ui-egui/locales/en.toml index 11f0bb4ac..e24d81452 100644 --- a/crates/ui-egui/locales/en.toml +++ b/crates/ui-egui/locales/en.toml @@ -406,6 +406,12 @@ name = "English" "Decoration style" = "Decoration style" "Decoration" = "Decoration" "Deep select" = "Deep select" +"Disconnected. Reconnecting…" = "Disconnected. Reconnecting…" +"Disconnected. Your edits stay here and sync when the connection returns. Reconnecting…" = "Disconnected. Your edits stay here and sync when the connection returns. Reconnecting…" +"Dismiss" = "Dismiss" +"Not connected: {reason}. Your work is still in this tab." = "Not connected: {reason}. Your work is still in this tab." +"Retry now" = "Retry now" +"Save a copy…" = "Save a copy…" "Wrap style" = "Wrap style" "Balance" = "Balance" "Pretty" = "Pretty" @@ -415,6 +421,7 @@ name = "English" "Set hug contents" = "Set hug contents" "Set fill container" = "Set fill container" "Double-click an edge of an auto layout frame" = "Double-click an edge of an auto layout frame" +"{name}, disconnected from its live session" = "{name}, disconnected from its live session" "⌥ double-click an edge of an auto layout child" = "⌥ double-click an edge of an auto layout child" "Alt+double-click an edge of an auto layout child" = "Alt+double-click an edge of an auto layout child" "Default" = "Default" diff --git a/crates/ui-egui/src/canvas.rs b/crates/ui-egui/src/canvas.rs index 5ccfe5d46..6cea501c1 100644 --- a/crates/ui-egui/src/canvas.rs +++ b/crates/ui-egui/src/canvas.rs @@ -312,11 +312,13 @@ pub fn show(app: &mut FigApp, ui: &mut Ui, worker: &mut Worker) { crate::live::draw(app, &painter, &ctx); crate::live::agent::draw(app, &painter, &ctx); crate::live::chat_box(app, &ctx); - crate::live::spotlight_banner(app, &ctx, rect); + // The other banners float below the strip that says the session is disconnected. + let banners = rect.with_min_y(rect.min.y + crate::live::connection_banner(app, &ctx, rect)); + crate::live::spotlight_banner(app, &ctx, banners); crate::comments::popovers(app, &ctx); - crate::versions::preview_banner(app, &ctx, rect); - crate::branch_ui::banner(app, &ctx, rect); - crate::dev_mode::focus_bar(app, &ctx, rect); + crate::versions::preview_banner(app, &ctx, banners); + crate::branch_ui::banner(app, &ctx, banners); + crate::dev_mode::focus_bar(app, &ctx, banners); // The cursor: the tool's, unless something on the canvas with its own has the pointer. app.canvas.cursor = None; if let (true, Some(at)) = (own_cursor && resp.hovered(), ctx.input(|i| i.pointer.hover_pos())) { diff --git a/crates/ui-egui/src/icons.rs b/crates/ui-egui/src/icons.rs index f8480127f..cd6f34a08 100644 --- a/crates/ui-egui/src/icons.rs +++ b/crates/ui-egui/src/icons.rs @@ -205,6 +205,8 @@ icons! { Online, /// In a live session others get into: a point sending waves to both sides. LiveShared, + /// Disconnected from a live session: the point and its waves, struck through. + LiveDisconnected, /// A file of yours on a server that only you get into: a point inside a closed ring. LivePrivate, /// A design file: a pen nib leaning to the left, its grip filled. diff --git a/crates/ui-egui/src/icons/draw.rs b/crates/ui-egui/src/icons/draw.rs index 1d3925507..904b54107 100644 --- a/crates/ui-egui/src/icons/draw.rs +++ b/crates/ui-egui/src/icons/draw.rs @@ -809,6 +809,14 @@ fn draw(p: &P, icon: Icon) { p.arc(8.0, 8.0, r, PI - FRAC_PI_4, PI + FRAC_PI_4); } } + LiveDisconnected => { + p.dot(8.0, 8.0, 1.6); + for r in [3.6, 6.0] { + p.arc(8.0, 8.0, r, -FRAC_PI_4, FRAC_PI_4); + p.arc(8.0, 8.0, r, PI - FRAC_PI_4, PI + FRAC_PI_4); + } + p.line(3.0, 13.0, 13.0, 3.0); + } LivePrivate => { p.dot(8.0, 8.0, 1.6); p.circle(8.0, 8.0, 5.0); diff --git a/crates/ui-egui/src/live.rs b/crates/ui-egui/src/live.rs index efa64617c..c80548323 100644 --- a/crates/ui-egui/src/live.rs +++ b/crates/ui-egui/src/live.rs @@ -436,6 +436,70 @@ pub fn chat_box(app: &mut FigApp, ctx: &egui::Context) { app.ui.live.chat = Some(chat); } +/// While the active document's live session is disconnected: a thin strip across the top of the +/// canvas that says so, with what can be done about it. Returns how much of the canvas it takes. +pub fn connection_banner(app: &mut FigApp, ctx: &egui::Context, canvas: Rect) -> f32 { + const H: f32 = 30.0; + let live = app.session.live(); + let Some(uid) = app.session.docs.get(app.session.active).map(|d| d.uid).filter(|u| crate::tabs::live_lost(app, *u)) else { return 0.0 }; + let (text, retry, gone) = match &live.status { + Status::Failed { reason } => { + (trf("Not connected: {reason}. Your work is still in this tab.", &[("reason", &failure_text(reason))]), Some(tr("Try again")), true) + } + Status::Reconnecting { .. } => { + (tr("Disconnected. Your edits stay here and sync when the connection returns. Reconnecting…").to_string(), Some(tr("Retry now")), false) + } + _ => (tr("Disconnected. Reconnecting…").to_string(), None, false), + }; + // Saved as a file of its own: it is one now. + if gone && app.session.docs.iter().any(|d| d.uid == uid && d.path.is_some()) { + app.run("collab.leave", json!({})); + return 0.0; + } + let t = Tokens::get(ctx); + let ink = text_on(t.danger); + let (mut try_now, mut save, mut dismiss) = (false, false, false); + let strip = Rect::from_min_size(canvas.min, vec2(canvas.width(), H)); + egui::Area::new(egui::Id::unique("live_connection_banner")).order(egui::Order::Foreground).fixed_pos(strip.min).show(ctx, |ui| { + ui.set_min_size(strip.size()); + ui.set_max_size(strip.size()); + ui.painter().rect_filled(strip, egui::CornerRadius::ZERO, t.danger); + let button = |ui: &mut Ui, label: &str| { + ui.add( + egui::Button::new(egui::RichText::new(label).font(regular(11.0)).color(ink)) + .fill(Color32::TRANSPARENT) + .stroke(Stroke::new(1.0, ink)) + .corner_radius(egui::CornerRadius::same(4)), + ) + .clicked() + }; + let inner = strip.shrink2(vec2(12.0, 0.0)); + ui.scope_builder(egui::UiBuilder::new().max_rect(inner).layout(egui::Layout::right_to_left(egui::Align::Center)), |ui| { + ui.spacing_mut().item_spacing.x = 8.0; + if gone { + dismiss = button(ui, tr("Dismiss")); + save = button(ui, tr("Save a copy…")); + } + if let Some(label) = retry { + try_now = button(ui, label); + } + ui.with_layout(egui::Layout::left_to_right(egui::Align::Center), |ui| { + ui.add(egui::Label::new(egui::RichText::new(text).font(regular(11.0)).color(ink)).truncate()); + }); + }); + }); + if try_now { + app.run("collab.reconnect", json!({})); + } + if save { + app.save_as_dialog(); + } + if dismiss { + app.run("collab.leave", json!({})); + } + H +} + /// While you spotlight, or someone does and you stopped following them: a banner on the canvas to /// stop, or to follow again. pub fn spotlight_banner(app: &mut FigApp, ctx: &egui::Context, canvas: Rect) { diff --git a/crates/ui-egui/src/live_joining_tests.rs b/crates/ui-egui/src/live_joining_tests.rs index a5d46b8e8..7929a9334 100644 --- a/crates/ui-egui/src/live_joining_tests.rs +++ b/crates/ui-egui/src/live_joining_tests.rs @@ -97,3 +97,52 @@ fn leave_takes_a_session_id() { assert_eq!(h.app.session.execute("collab.leave", &json!({"session": id})).unwrap()["ended"], true); assert!(h.app.session.live.get(id).is_none()); } + +/// Joined, with the file in its tab. +fn joined(h: &mut Harness) -> u64 { + join(h); + h.welcome(); + h.sync(); + h.app.session.docs[h.app.session.active].uid +} + +const STRIP: &str = "Disconnected. Your edits stay here and sync when the connection returns. Reconnecting…"; + +#[test] +fn a_dropped_connection_shows_on_the_tab_and_across_the_canvas_with_retry() { + let (mut h, _) = Harness::new(); + let uid = joined(&mut h); + assert!(!crate::tabs::live_lost(&h.app, uid)); + assert!(!has_text(&h.frames(2), STRIP), "not while connected"); + h.send(vec![LiveEvent::Status(Status::Reconnecting { attempt: 3 })]); + let shapes = h.frames(2); + assert!(crate::tabs::live_lost(&h.app, uid)); + assert!(has_text(&shapes, STRIP)); + h.click(text_center(&shapes, "Retry now")); + assert!(h.app.ui.last_error.is_none(), "{:?}", h.app.ui.last_error); + assert_eq!(h.app.session.live().status, Status::Reconnecting { attempt: 3 }); + // Back: the strip goes. + h.welcome(); + assert!(!has_text(&h.frames(2), STRIP)); + assert!(!crate::tabs::live_lost(&h.app, uid)); +} + +#[test] +fn a_session_that_ended_stays_on_its_tab_until_dismissed() { + let (mut h, _) = Harness::new(); + let uid = joined(&mut h); + h.send(vec![LiveEvent::Status(Status::Failed { reason: "The host refused: this link isn't valid".into() })]); + let shapes = h.frames(2); + assert!(crate::tabs::live_lost(&h.app, uid)); + assert!(has_text(&shapes, "Not connected: The host refused: this link isn't valid. Your work is still in this tab.")); + assert!(has_text(&shapes, "Save a copy…")); + h.click(text_center(&shapes, "Try again")); + assert_eq!(h.app.session.live().status, Status::Connecting); + assert!(crate::tabs::live_lost(&h.app, uid), "still disconnected while it tries"); + h.send(vec![LiveEvent::Status(Status::Failed { reason: "no".into() })]); + let shapes = h.frames(2); + h.click(text_center(&shapes, "Dismiss")); + assert!(!has_text(&h.frames(2), "Try again")); + assert!(!crate::tabs::live_lost(&h.app, uid)); + assert_eq!(h.app.session.live().status, Status::Off); +} diff --git a/crates/ui-egui/src/live_tests.rs b/crates/ui-egui/src/live_tests.rs index cd8454afa..bd2dd4ce2 100644 --- a/crates/ui-egui/src/live_tests.rs +++ b/crates/ui-egui/src/live_tests.rs @@ -126,7 +126,7 @@ impl Harness { color: "#14AE5C".into(), file_name: "Shared".into(), pages: vec![], - link: String::new(), + link: "figcraft://join?host=127.0.0.1:47900&file=f&token=t".into(), url: String::new(), address: "127.0.0.1:47900".into(), network: false, diff --git a/crates/ui-egui/src/tabs.rs b/crates/ui-egui/src/tabs.rs index e59552d12..e043eb2d9 100644 --- a/crates/ui-egui/src/tabs.rs +++ b/crates/ui-egui/src/tabs.rs @@ -149,6 +149,7 @@ pub fn tab_bar(app: &mut FigApp, ui: &mut Ui) { let name = &d.doc.name; // In a live session: a mark after the name says whether others get in. let live = live_mark(app, d.uid); + let lost = live_lost(app, d.uid); let dirty = d.is_dirty(); let r = tab_rects[slot]; let body_r = Rect::from_min_max(r.min, pos2(r.max.x - 32.0, r.max.y)); @@ -171,8 +172,8 @@ pub fn tab_bar(app: &mut FigApp, ui: &mut Ui) { } }); } - let label = tab_label(name, live); - let resp = if live.is_some() { resp.on_hover_text(&label) } else { resp }; + let label = if lost { trf("{name}, disconnected from its live session", &[("name", name)]) } else { tab_label(name, live) }; + let resp = if live.is_some() || lost { resp.on_hover_text(&label) } else { resp }; crate::a11y::tab(&resp, &label, active); let progress = open_progress(&opening, d.uid, now); let tab = TabPaint { @@ -182,6 +183,7 @@ pub fn tab_bar(app: &mut FigApp, ui: &mut Ui) { width: w, state: [active, resp.hovered(), cresp.hovered(), dirty], live, + lost, progress, }; paint_tab(ui, &t, &tab); @@ -432,7 +434,7 @@ fn detach_tab(app: &mut FigApp, ui: &Ui, i: usize, at: Option) { /// How wide document tab `i` wants to be: its name, the live mark and the unsaved dot. fn preferred_width(app: &FigApp, i: usize) -> f32 { let d = &app.session.docs[i]; - let mark_w = if live_mark(app, d.uid).is_some() { 18.0 } else { 0.0 }; + let mark_w = if live_mark(app, d.uid).is_some() || live_lost(app, d.uid) { 18.0 } else { 0.0 }; let dot_w = if d.is_dirty() && mark_w > 0.0 { 12.0 } else { 0.0 }; (regular(12.0).size * 0.6 * d.doc.name.chars().count() as f32 + 64.0 + mark_w + dot_w).clamp(120.0, 220.0) } @@ -457,14 +459,16 @@ struct TabPaint<'a> { state: [bool; 4], /// In a live session: whether others get in. live: Option, + /// Disconnected from its live session. + lost: bool, /// How far the opening animation is (0..=1). progress: f32, } /// Draws a document tab: background, icon, name, live mark, unsaved dot and close button. fn paint_tab(ui: &Ui, t: &Tokens, tab: &TabPaint) { - let TabPaint { name, kind, rects: [r, close_r], width: w, state: [active, hovered, close_hovered, dirty], live, progress } = *tab; - let mark_w = if live.is_some() { 18.0 } else { 0.0 }; + let TabPaint { name, kind, rects: [r, close_r], width: w, state: [active, hovered, close_hovered, dirty], live, lost, progress } = *tab; + let mark_w = if live.is_some() || lost { 18.0 } else { 0.0 }; let paint_r = r.translate(vec2(-28.0 * (1.0 - progress).powi(2), 0.0)); let painter = ui.painter().with_clip_rect(r); if active { @@ -487,8 +491,10 @@ fn paint_tab(ui: &Ui, t: &Tokens, tab: &TabPaint) { t.text.linear_multiply(progress), (w - mark_w - if dirty { 72.0 } else { 60.0 }).max(0.0), ); - if let Some(shared) = live { - let at = Rect::from_center_size(pos2(paint_r.max.x - 38.0, paint_r.center().y), vec2(14.0, 14.0)); + let at = Rect::from_center_size(pos2(paint_r.max.x - 38.0, paint_r.center().y), vec2(14.0, 14.0)); + if lost { + icons::paint(&painter, at, Icon::LiveDisconnected, t.danger.linear_multiply(progress)); + } else if let Some(shared) = live { icons::paint(&painter, at, crate::online::mark(shared), if shared { t.success } else { t.icon_secondary }.linear_multiply(progress)); } if dirty { @@ -672,6 +678,12 @@ pub fn live_mark(app: &FigApp, uid: u64) -> Option { live.shared().filter(|_| live.doc_uid == Some(uid)) } +/// Document `uid` is a live session's whose connection is gone: what happens in it reaches no one. +pub fn live_lost(app: &FigApp, uid: u64) -> bool { + let live = app.session.live_of(uid); + live.disconnected() && live.doc_uid == Some(uid) +} + /// Minimise, maximise/restore and close at the right end of the title bar; returns their width. fn window_buttons(app: &mut FigApp, ui: &mut Ui, bar: Rect) -> f32 { const W: f32 = 46.0; diff --git a/docs/collab-protocol.md b/docs/collab-protocol.md index b4b459afb..9852a1686 100644 --- a/docs/collab-protocol.md +++ b/docs/collab-protocol.md @@ -535,9 +535,21 @@ resuming with its offline edits, and leaving the session going back to snapshot `ws:///` and sends the token only inside its `Hello`. Links are pasted into the Join dialog (its field has the keyboard when it opens; Escape closes it), or opened from anywhere: see *Opening invite links* below. -- Reconnect: a connection that drops after it was live reconnects with growing pauses (0.5 s, - doubling up to 10 s, 12 attempts); a refusal (wrong token, full) or the host ending the session - is final; a first join that can't reach the host fails at once. A reconnect resumes as the same +- Reconnect: a connection that drops after it was live reconnects until you leave, with growing + pauses (0.5 s, doubling up to 10 s, 12 attempts), then a minute's pause and as many again. A + server turning a live session away is taken as passing (busy, a limit, a file it couldn't read + just now) unless it says why in words that are for good: the link, the file or your place in it + is gone, or the versions can't talk (`FINAL_REFUSALS` in `crates/collab-net/src/join.rs`). Those + and the host ending the session are final; a first join that can't reach the host fails at once. + Messages queued while offline go out paced, so they stay within what a server takes from a + connection. +- Disconnected: while it reconnects, and after it can't go on, the tab shows a red mark and a strip + across the top of the canvas says so, with **Retry now** (`collab.reconnect`). The tab can still + be edited. A session you joined that ended stays on its tab with **Try again**, **Save a copy…** + and **Dismiss** (`collab.leave`). **Try again** joins it in the same tab as someone new; if the + tab changed since it lost the server, what changed opens beside it as an unsaved + "offline copy" and the tab shows the server's version. A session that gets out of step does the + same by itself. A reconnect resumes as the same client: the guest's connection keeps the session id, client id and last sequence number from the messages it read and sends them in its next `Hello` (see Offline and reconnect). - The browser build joins and publishes to a server (see *Built (the browser client)*); hosting diff --git a/docs/collaboration-parity.md b/docs/collaboration-parity.md index fb54a8d55..deab037ae 100644 --- a/docs/collaboration-parity.md +++ b/docs/collaboration-parity.md @@ -26,6 +26,7 @@ cursors, selections, text carets, cursor chat and spotlights shown live ([`colla | Date | Change | Summary | |---|---|---| +| 2026-11-04 | minor | M9: a session you joined no longer turns into a local file by itself. A dropped connection reconnects until you leave (a minute's pause after each 12 attempts, a pause Retry now skips); only refusals that are for good stop it; queued messages go out paced. While disconnected the tab shows a red mark and a strip across the canvas says so; a session that ended stays on its tab with Try again, Save a copy and Dismiss, and what changed offline opens beside it when it joins again | | 2026-10-31 | patch | M9, #1665: the document in a live session's welcome goes compressed (deflate) to clients whose hello announces `packed`, about seven times smaller on the wire (a synthetic file of 4,040 layers: 397 KB to 53 KB); older clients keep getting it uncompressed, and the client reads a packed document only up to the size an uncompressed welcome could have had. | | 2026-10-30 | minor | M9, part of #742: a team list on `figcraft-server`. With `team_files = "edit"` (or `comment`, `view`) everyone who reaches the server sees the files shared from it now (a link of theirs has a join code: Share ▸ Start sharing) and joins them by a team list link, `figcraft://join?server=…&file=…&team=1`, which carries no secret: the server hands out the file's team link while it stays shared (`ResolveTeam`, answered like a join code), and Stop sharing revokes it with the others, disconnecting whoever joined with it. Turning the list off or changing its access refuses the old team links at once. `collab.files {refresh}` asks the server in Preferences for its list (`Admin::Team`; not the public server FigCraft ships with), and Home ▸ Online shows it below your own files: a row joins its file, its menu copies the link for the app or, with the server's `web_url`, for the browser build (`#join=…`). A browser build served beside its server names it with ``, the page's default for sharing, codes and the team list. No accounts: the list is for a server only your team reaches. Tests: `team_tests` (the server and apps over loopback), `code_tests` (links and the browser's driver), `online_tests` (the Online section), `query_tests` (the page's server). Percentages and hours unchanged | | 2026-10-30 | minor | M9, #1130: `figcraft-server` compares the SHA-256 digests of the presented and the kept server key instead of the raw strings, as `docs/server.md` says; the key file, `figcraft-server key` and rotation are unchanged. Numbers unchanged. | diff --git a/docs/mcp.md b/docs/mcp.md index b5e49e749..aae5e5860 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -1478,7 +1478,10 @@ only: a host stops hosting it, a guest leaves it. see `FIGCRAFT_CA_FILE` in [`server.md`](server.md#behind-a-reverse-proxy-tls)). `collab.leave {}` leaves the active document's session (or ends a join started from it that is still on its way or failed), and `collab.leave {session}` the session with that id (from `sessions`), whichever - document is active; the synced document stays open as your copy. + document is active; the synced document stays open as your copy. `collab.reconnect {}` acts on + the active document's lost session: a reconnect that is waiting tries now, and a session you + joined that couldn't go on is joined again in its tab. A dropped connection keeps reconnecting + until you leave (see *Reconnect* in [`collab-protocol.md`](collab-protocol.md)). - `collab.publish {server, name?, key?}` puts the active document on a `figcraft-server` ([`server.md`](server.md)) and syncs it from there (as that document's session; others go on): `server` is the address `figcraft-server key` prints (`ws://host:47900/?key=…`; or give `key` separately), `name` the diff --git a/docs/server.md b/docs/server.md index 9d42cb0fc..6fb4056a5 100644 --- a/docs/server.md +++ b/docs/server.md @@ -43,7 +43,7 @@ Releases also ship it ready-built for Linux (`figcraft-server--linux-x8 tells everyone it is restarting. Every change it accepted is on disk before anyone is told about it, so even a hard kill loses nothing confirmed (a file's log is then folded into a new snapshot the next time everyone leaves it). Apps that were in a file keep editing and reconnect once the - server is back (for about a minute and a half), as the same participants. + server is back, as the same participants. ## Publishing a file From 436b893741fcafa3e88f5666ccc8d34e4674e4c0 Mon Sep 17 00:00:00 2001 From: fluid-chey Date: Wed, 4 Nov 2026 12:49:11 -0700 Subject: [PATCH 51/68] M9: pace queued sends without blocking, and address review comments Queued sync messages wait in a list the session loop drains, so Leave, a lost connection, presence and pings are never held up behind them. A text frame from the host stays final. A session that ended stays on its tab after a Save as: ending it there could turn a tab into a plain local file with no word about it. Co-Authored-By: Claude Opus 5.5 --- crates/collab-net/src/driver_tests.rs | 13 +++++++++++++ crates/collab-net/src/guest.rs | 19 ++++++++++++------- crates/collab-net/src/join.rs | 3 ++- crates/ui-egui/src/live.rs | 9 +++------ docs/collaboration-parity.md | 4 ++-- 5 files changed, 32 insertions(+), 16 deletions(-) diff --git a/crates/collab-net/src/driver_tests.rs b/crates/collab-net/src/driver_tests.rs index 57921df3d..df4d5c492 100644 --- a/crates/collab-net/src/driver_tests.rs +++ b/crates/collab-net/src/driver_tests.rs @@ -349,6 +349,19 @@ fn a_session_that_was_live_only_stops_for_a_refusal_that_is_for_good() { assert!(d.done(), "{reason}"); assert!(matches!(statuses(&inbox.drain()).last(), Some(Status::Failed { reason: r }) if r.contains(reason)), "{reason}"); } + // What this end finds it can't talk to: a text frame, or a message it can't read. + for text in [true, false] { + let (mut d, inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + if text { + d.text(t0); + } else { + d.message(&[0xFF, 1, 2, 3], t0); + } + assert!(d.done(), "text: {text}"); + assert!(matches!(statuses(&inbox.drain()).last(), Some(Status::Failed { .. }))); + } } #[test] diff --git a/crates/collab-net/src/guest.rs b/crates/collab-net/src/guest.rs index 84572b884..02685339f 100644 --- a/crates/collab-net/src/guest.rs +++ b/crates/collab-net/src/guest.rs @@ -9,6 +9,7 @@ //! Publishing ([`Guest::publish`]) first uploads the document to a server over a managing //! connection, then joins the new file with its edit link on the same thread. +use std::collections::VecDeque; use std::io; use std::net::TcpStream; use std::sync::Arc; @@ -280,17 +281,17 @@ fn session( let mut welcomed = false; let mut throttle = Throttle::new(PRESENCE_INTERVAL); let mut pace = Pace::new(Instant::now()); + // Sync messages waiting their turn (a long queue from while offline), and when each may go. + let mut paced: VecDeque<(Instant, ClientMsg)> = VecDeque::new(); let outcome = if send(&mut writer, &hello) { loop { let ping_at = last_ping + cfg.limits.keepalive; - let wake = earliest([throttle.due(), Some(ping_at)]).unwrap_or(ping_at); + let wake = earliest([throttle.due(), Some(ping_at), paced.front().map(|(at, _)| *at)]).unwrap_or(ping_at); let mut out = None; - let mut now_send = Vec::new(); match rx.recv_timeout(wake.saturating_duration_since(Instant::now())) { Ok(Cmd::Send(m)) if welcomed => { - // A long queue from while offline doesn't go out faster than the server takes it. - std::thread::sleep(pace.wait(Instant::now())); - now_send.push(m); + let now = Instant::now(); + paced.push_back((now + pace.wait(now), m)); } // Made for the previous connection (the sync client sends again what the server // didn't get once it has caught up with this connection's welcome). @@ -312,10 +313,14 @@ fn session( Ok(Cmd::Welcomed(_) | Cmd::Lost(..) | Cmd::Retry) => {} Err(RecvTimeoutError::Timeout) => {} } - if !now_send.iter().all(|m| send(&mut writer, m)) { + let now = Instant::now(); + let mut sent = true; + while sent && let Some((_, m)) = paced.pop_front_if(|(at, _)| *at <= now) { + sent = send(&mut writer, &m); + } + if !sent { break Outcome::Retry("the connection dropped".into()); } - let now = Instant::now(); let out = out.or_else(|| throttle.take_due(now)); let ok = out.is_none_or(|p| send(&mut writer, &ClientMsg::Presence(p))); let ok = ok diff --git a/crates/collab-net/src/join.rs b/crates/collab-net/src/join.rs index 63f94bec2..aa1c008eb 100644 --- a/crates/collab-net/src/join.rs +++ b/crates/collab-net/src/join.rs @@ -158,7 +158,7 @@ pub(crate) enum Next { /// gone, or the two versions can't talk. Anything else a server refuses a session with (it is /// busy, a limit was hit, the file couldn't be read just now) may pass, and servers of any version /// say so in these words, so a reason not listed here means try again. -const FINAL_REFUSALS: [&str; 11] = [ +const FINAL_REFUSALS: [&str; 12] = [ "isn't valid", "isn't on the server", "was removed from the server", @@ -170,6 +170,7 @@ const FINAL_REFUSALS: [&str; 11] = [ "couldn't be read", "message too large", "this version can't read", + "sent a text message", ]; /// Whether `reason`, from a server refusing a session that was live, is for good. diff --git a/crates/ui-egui/src/live.rs b/crates/ui-egui/src/live.rs index c80548323..ac00b2c4e 100644 --- a/crates/ui-egui/src/live.rs +++ b/crates/ui-egui/src/live.rs @@ -441,7 +441,9 @@ pub fn chat_box(app: &mut FigApp, ctx: &egui::Context) { pub fn connection_banner(app: &mut FigApp, ctx: &egui::Context, canvas: Rect) -> f32 { const H: f32 = 30.0; let live = app.session.live(); - let Some(uid) = app.session.docs.get(app.session.active).map(|d| d.uid).filter(|u| crate::tabs::live_lost(app, *u)) else { return 0.0 }; + if !app.session.docs.get(app.session.active).is_some_and(|d| crate::tabs::live_lost(app, d.uid)) { + return 0.0; + } let (text, retry, gone) = match &live.status { Status::Failed { reason } => { (trf("Not connected: {reason}. Your work is still in this tab.", &[("reason", &failure_text(reason))]), Some(tr("Try again")), true) @@ -451,11 +453,6 @@ pub fn connection_banner(app: &mut FigApp, ctx: &egui::Context, canvas: Rect) -> } _ => (tr("Disconnected. Reconnecting…").to_string(), None, false), }; - // Saved as a file of its own: it is one now. - if gone && app.session.docs.iter().any(|d| d.uid == uid && d.path.is_some()) { - app.run("collab.leave", json!({})); - return 0.0; - } let t = Tokens::get(ctx); let ink = text_on(t.danger); let (mut try_now, mut save, mut dismiss) = (false, false, false); diff --git a/docs/collaboration-parity.md b/docs/collaboration-parity.md index deab037ae..6c4aa9340 100644 --- a/docs/collaboration-parity.md +++ b/docs/collaboration-parity.md @@ -1,6 +1,6 @@ # Collaboration parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-31 · **Change:** minor (a live session's welcome sends the document compressed to clients that read it, about seven times smaller (#1665); a server can list the files shared from it now for everyone who reaches it, Home ▸ Online shows them and their links carry no secret (`team_files`, part of #742); `figcraft-server` checks the server key by comparing SHA-256 digests, not the raw keys (#1130); joining and leaving a file nobody is editing reads and writes nothing on the server: it stays loaded a minute after everyone leaves (#1074); `comment.people` lists names that were only @mentioned, and `comment.next` and `comment.prompt` carry the mentions too (#1415); share links can comment: a third access level beside edit and view, whose holder sees the file live and adds, replies to, reacts to and resolves comments but can't change the design; `comment.list {mentions}` lists only the threads that @mention a name (#1415); the browser build publishes files to a server, so Share ▸ Online and Publish to server work there (#917); an AI agent attached over MCP shows where it works (#1416); one name for live sessions and comments: Preferences ▸ Your name, in the Join dialog too, kept in the browser, and a rename shows at once in the sessions you are in (#1380); the Join dialog shows a join from the click until its file is ready, with Cancel, and a failed join with Try again (#1381); requests that change a server's files have a budget per address, the server key's too, and join codes are found by their hash (#1075); comment.list reports each message's @mentions (#1415); the batches kept for reconnecting apps are bounded in bytes by default, and `figcraft-server` takes `max_log_mb` (#1069); sibling placement in live sessions searches instead of counting (#1065); an AI agent attached over MCP comments under its own name, with an Agent label (#1414); a refused batch's fixes take time linear in the batch (#1063); image entries are checked as they apply; branches in live sessions and branch history entries; server message limits follow `max_file_mb`; a damaged log generation field keeps flushed edits; the web build joins from a `#join=` link; removing someone from a live session; live-session revert guard; live sessions per document; a public figcraft-server: open hosting, owner tokens, per-address limits, idle expiry, moderation, install.sh; cursor chat and spotlight in live sessions; branch version history and finer list merges; comments and version history behaviour suite and fixes; hosting the server: `wss://` in the desktop app, server releases, deployment guide; team libraries on the server and swap library; branches: create, update from main, review and merge; wording: the standalone server with share links to edit or view; numbers unchanged) · **Target:** Figma Design (desktop app 126.10.7) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** minor (M9: a joined live session reconnects until you leave and says when it is disconnected, with a red tab mark and a strip across the canvas; a live session's welcome sends the document compressed to clients that read it, about seven times smaller (#1665); a server can list the files shared from it now for everyone who reaches it, Home ▸ Online shows them and their links carry no secret (`team_files`, part of #742); `figcraft-server` checks the server key by comparing SHA-256 digests, not the raw keys (#1130); joining and leaving a file nobody is editing reads and writes nothing on the server: it stays loaded a minute after everyone leaves (#1074); `comment.people` lists names that were only @mentioned, and `comment.next` and `comment.prompt` carry the mentions too (#1415); share links can comment: a third access level beside edit and view, whose holder sees the file live and adds, replies to, reacts to and resolves comments but can't change the design; `comment.list {mentions}` lists only the threads that @mention a name (#1415); the browser build publishes files to a server, so Share ▸ Online and Publish to server work there (#917); an AI agent attached over MCP shows where it works (#1416); one name for live sessions and comments: Preferences ▸ Your name, in the Join dialog too, kept in the browser, and a rename shows at once in the sessions you are in (#1380); the Join dialog shows a join from the click until its file is ready, with Cancel, and a failed join with Try again (#1381); requests that change a server's files have a budget per address, the server key's too, and join codes are found by their hash (#1075); comment.list reports each message's @mentions (#1415); the batches kept for reconnecting apps are bounded in bytes by default, and `figcraft-server` takes `max_log_mb` (#1069); sibling placement in live sessions searches instead of counting (#1065); an AI agent attached over MCP comments under its own name, with an Agent label (#1414); a refused batch's fixes take time linear in the batch (#1063); image entries are checked as they apply; branches in live sessions and branch history entries; server message limits follow `max_file_mb`; a damaged log generation field keeps flushed edits; the web build joins from a `#join=` link; removing someone from a live session; live-session revert guard; live sessions per document; a public figcraft-server: open hosting, owner tokens, per-address limits, idle expiry, moderation, install.sh; cursor chat and spotlight in live sessions; branch version history and finer list merges; comments and version history behaviour suite and fixes; hosting the server: `wss://` in the desktop app, server releases, deployment guide; team libraries on the server and swap library; branches: create, update from main, review and merge; wording: the standalone server with share links to edit or view; numbers unchanged) · **Target:** Figma Design (desktop app 126.10.7) Figma is multiplayer first; FigCraft is local first. **Ready ~13% (estimated):** comments, version history and branches (review and merge) work inside one file; the real-time collaboration core landed in #103 (sync model, @@ -12,7 +12,7 @@ cursors, selections, text carets, cursor chat and spotlights shown live ([`colla | Feature | Figma | FigCraft | Hours | |---|---|---|---| -| Real-time co-editing | yes | **core built, no networking** (#103): client-scoped ids, per-property change sets with fractional positions, server ordering and validation, optimistic clients, binary messages; randomized multi-client convergence tests over real commands. Live sessions over the network landed (`crates/collab-net`): the WebSocket transport (keep-alive, size and rate limits, reconnect with backoff), hosting from the app (this machine or the local network) with invite links, live cursors with name tags, selections, avatars and follow, `collab.*` commands. Document sync between apps works over them (the host's server orders every batch; guests open the host's file as a new tab). Sessions are per document: each open file has its own or none, several run at once (host one, join another, publish a third) and keep syncing behind the tab in front, and closing a file ends its session only. Revert to saved is refused until the document leaves its live session; its access checks and sync association stay intact. Undo is per person (only your own steps, others' later writes left alone), refused edits roll back with a toast, and a reconnect resumes as the same client with what it missed (or a snapshot) and sends what was made offline. The browser build joins (same messages through the browser's WebSocket API); `figcraft://` invite links open the desktop app and join. Styles, variables, collections, modes and comments made in a session take ids from their creator's space (the server checks it), so concurrent creations all survive; modes, per-mode values and replies inside one entry still resolve last-writer-wins. A standalone `figcraft-server` keeps many files, persists them (a snapshot plus a log, compacted), loses nothing confirmed across a restart (apps resume as the same participants) and takes files published from the app (File ▸ Publish to server…). The desktop app and the CLI open `wss://` links too (TLS through a reverse proxy), and releases ship the server for Linux with a deployment guide (systemd, Caddy, nginx, Docker) and `install.sh`. A server can be open to the public: anyone publishes without the key, within limits per address, and files nobody opens expire. Message limits follow the server's `max_file_mb`, so files above 64 MiB publish and open (the client takes at most 1 GiB from a server, and the server warns when large limits meet open publishing, #705); a damaged generation field in a file's log no longer drops the edits flushed to it (#687). Image entries are checked as they apply: a key must be a plain name (letters, digits, `-`, `_`; it becomes `images/` in a saved file), bytes under a content-hash key must hash to it (lowercase sha256), a side is at most 65 535 px and the decoded bytes at most 256 MiB (what the importers read), a key's bytes can't be replaced and an image a layer shows can't be removed, so no collaborator can poison the shared image store or balloon memory; snapshots and server logs from before these checks open without the images they refuse (#1086). The batches kept for apps that reconnect are bounded in bytes by default (64 MiB; `max_log_mb` on `figcraft-server`), and an app further behind catches up with a snapshot (#1069). Placing a layer among its siblings is a binary search, so large pastes and reorders in one batch no longer take quadratic time (#1065). A refused batch's fixes take time linear in the batch: each deleted layer is restored once and each entry fix looked up once (#1063). Left: server archives beyond Linux | 25–55 | +| Real-time co-editing | yes | **core built, no networking** (#103): client-scoped ids, per-property change sets with fractional positions, server ordering and validation, optimistic clients, binary messages; randomized multi-client convergence tests over real commands. Live sessions over the network landed (`crates/collab-net`): the WebSocket transport (keep-alive, size and rate limits, a live connection reconnecting until you leave), hosting from the app (this machine or the local network) with invite links, live cursors with name tags, selections, avatars and follow, `collab.*` commands. Document sync between apps works over them (the host's server orders every batch; guests open the host's file as a new tab). Sessions are per document: each open file has its own or none, several run at once (host one, join another, publish a third) and keep syncing behind the tab in front, and closing a file ends its session only. Revert to saved is refused until the document leaves its live session; its access checks and sync association stay intact. Undo is per person (only your own steps, others' later writes left alone), refused edits roll back with a toast, and a reconnect resumes as the same client with what it missed (or a snapshot) and sends what was made offline. The browser build joins (same messages through the browser's WebSocket API); `figcraft://` invite links open the desktop app and join. Styles, variables, collections, modes and comments made in a session take ids from their creator's space (the server checks it), so concurrent creations all survive; modes, per-mode values and replies inside one entry still resolve last-writer-wins. A standalone `figcraft-server` keeps many files, persists them (a snapshot plus a log, compacted), loses nothing confirmed across a restart (apps resume as the same participants) and takes files published from the app (File ▸ Publish to server…). The desktop app and the CLI open `wss://` links too (TLS through a reverse proxy), and releases ship the server for Linux with a deployment guide (systemd, Caddy, nginx, Docker) and `install.sh`. A server can be open to the public: anyone publishes without the key, within limits per address, and files nobody opens expire. Message limits follow the server's `max_file_mb`, so files above 64 MiB publish and open (the client takes at most 1 GiB from a server, and the server warns when large limits meet open publishing, #705); a damaged generation field in a file's log no longer drops the edits flushed to it (#687). Image entries are checked as they apply: a key must be a plain name (letters, digits, `-`, `_`; it becomes `images/` in a saved file), bytes under a content-hash key must hash to it (lowercase sha256), a side is at most 65 535 px and the decoded bytes at most 256 MiB (what the importers read), a key's bytes can't be replaced and an image a layer shows can't be removed, so no collaborator can poison the shared image store or balloon memory; snapshots and server logs from before these checks open without the images they refuse (#1086). The batches kept for apps that reconnect are bounded in bytes by default (64 MiB; `max_log_mb` on `figcraft-server`), and an app further behind catches up with a snapshot (#1069). Placing a layer among its siblings is a binary search, so large pastes and reorders in one batch no longer take quadratic time (#1065). A refused batch's fixes take time linear in the batch: each deleted layer is restored once and each entry fix looked up once (#1063). Left: server archives beyond Linux | 25–55 | | Live cursors, selections, viewports; follow / observation mode; spotlight | yes | **done, in live sessions**: named cursors (one name for live sessions and comments: Preferences ▸ Your name, also in the Share popover and the Join dialog, kept in the browser too; a rename shows at once in the sessions you're in, #1380), selection outlines, avatars (an AI agent attached over MCP also shows its avatar and an outline around the layers it last edited or selected while it works, in or out of a session, #1416), follow (click an avatar), others' text carets and selected characters with their names, a note when two people type in one layer; spotlight (your avatar's menu, `collab.spotlight`): everyone follows your view and page, people who join later too, anyone who moves their view stops following and a banner offers to follow again, a newer spotlight takes over. Left: polish (no accounts, so anyone in the session can spotlight) | 2–4 | | Cursor chat, audio, high-fives | yes | **partial, in live sessions**: cursor chat (`/` opens a bubble at your pointer; everyone sees it as you type, it fades a few seconds after the last change, Enter sends and Escape takes it back, 100 characters; `collab.cursorChat` for agents); sent as ephemeral presence the host checks and rate-limits, never stored. No audio, high-fives or emote reactions | 2–5 | | Share links, permissions (view / edit), teams and projects | yes | **partial**: sharing with a join code from the Share popover (online: the file goes to the server in Preferences and the server names its edit, comment and view links with short codes; local network: the app hosts and the code carries its address; one field joins with a code or a link, in the popover and on the home screen, and the Join dialog then shows the join until its file is ready (Cancel), or why it failed (Try again, #1381); the browser build also joins from a link in its URL's fragment, `#join=…`, which never reaches the web host's logs, capped at 6 KiB and checked like a `figcraft://` link (#712; unit-tested, not run in a browser), and shares online and publishes to a server as the desktop app does, though not on the local network (#917; the owner token of a file it puts on an open server lasts as long as the page)); `figcraft-server` share links per file with edit, comment or view access (a viewer sees changes and presence, a "View only" badge and only the moving tools; a commenter also adds, replies to, reacts to and resolves comment threads, with a "Can comment" badge and the comment tool, #1525; the server refuses their other edits), revocable at once, tokens stored as hashes; managed from the app's Share popover (first links), the server's command line or a managing connection. On a server open to the public, whoever published a file manages it with its owner token (links, name, removal: `collab.manageFile`), which the app remembers: Home ▸ Online lists your online files (open again as owner, start and stop sharing, copy the code, rename, remove, forget), with one request per server for what became of them; anyone in a file can report it, and the operator blocks addresses. The person hosting a session, or a file's owner, removes someone from it (right-click their avatar, `collab.removePerson`): they are disconnected and their address can't join that file again while it runs. The list is per computer; a server only a team reaches can also list the files shared from it now for everyone (`team_files`): Home ▸ Online shows that team list for the server in Preferences, a row joins its file, and its links (`figcraft://join?server=…&file=…&team=1`, or the browser build's) carry no secret and stop working with the share. No accounts, teams or projects | 8–17 | From e87078a8ec2c591cde5bc164bda24cbef3c01dda Mon Sep 17 00:00:00 2001 From: fluid-chey Date: Wed, 4 Nov 2026 13:03:09 -0700 Subject: [PATCH 52/68] M9: leaving a live session sends what was waiting its turn Co-Authored-By: Claude Opus 5.5 --- crates/collab-net/src/driver.rs | 6 ++++++ crates/collab-net/src/driver_tests.rs | 15 +++++++++++++++ crates/collab-net/src/guest.rs | 2 ++ docs/collaboration-parity.md | 2 +- 4 files changed, 24 insertions(+), 1 deletion(-) diff --git a/crates/collab-net/src/driver.rs b/crates/collab-net/src/driver.rs index d96650371..622b6c52d 100644 --- a/crates/collab-net/src/driver.rs +++ b/crates/collab-net/src/driver.rs @@ -339,6 +339,12 @@ impl Driver { /// Leave the session. pub(crate) fn leave(&mut self, now: Instant) { + // What you did before leaving still reaches the others, whatever its turn. + while let Some((_, msg)) = self.paced.pop_front() { + if !self.write(&msg) { + break; + } + } self.end(Outcome::Left, now); } diff --git a/crates/collab-net/src/driver_tests.rs b/crates/collab-net/src/driver_tests.rs index df4d5c492..83684db7e 100644 --- a/crates/collab-net/src/driver_tests.rs +++ b/crates/collab-net/src/driver_tests.rs @@ -392,6 +392,21 @@ fn a_long_queue_goes_out_paced_and_in_order() { assert_eq!(d.deadline().unwrap() - now, ms(500), "nothing left to send but the reconnect"); } +#[test] +fn leaving_sends_what_was_waiting_its_turn() { + let t0 = Instant::now(); + let (mut d, _inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + for seq in 0..300 { + d.send(ClientMsg::Ack { seq }, t0); + } + d.leave(t0); + let seqs: Vec = d.sock.sent.iter().filter_map(|m| if let ClientMsg::Ack { seq } = m { Some(*seq) } else { None }).collect(); + assert_eq!(seqs, (0..300).collect::>()); + assert!(d.done()); +} + #[test] fn a_first_join_that_cant_reach_the_host_fails_at_once() { let t0 = Instant::now(); diff --git a/crates/collab-net/src/guest.rs b/crates/collab-net/src/guest.rs index 02685339f..f338fcce2 100644 --- a/crates/collab-net/src/guest.rs +++ b/crates/collab-net/src/guest.rs @@ -306,6 +306,8 @@ fn session( } Ok(Cmd::Lost(e, o)) if e == epoch => break o, Ok(Cmd::Leave) | Err(RecvTimeoutError::Disconnected) => { + // What you did before leaving still reaches the others, whatever its turn. + while paced.pop_front().is_some_and(|(_, m)| send(&mut writer, &m)) {} let _ = writer.close(Some(CloseFrame { code: CloseCode::Normal, reason: "".into() })); break Outcome::Left; } diff --git a/docs/collaboration-parity.md b/docs/collaboration-parity.md index 6c4aa9340..6f1faad8e 100644 --- a/docs/collaboration-parity.md +++ b/docs/collaboration-parity.md @@ -26,7 +26,7 @@ cursors, selections, text carets, cursor chat and spotlights shown live ([`colla | Date | Change | Summary | |---|---|---| -| 2026-11-04 | minor | M9: a session you joined no longer turns into a local file by itself. A dropped connection reconnects until you leave (a minute's pause after each 12 attempts, a pause Retry now skips); only refusals that are for good stop it; queued messages go out paced. While disconnected the tab shows a red mark and a strip across the canvas says so; a session that ended stays on its tab with Try again, Save a copy and Dismiss, and what changed offline opens beside it when it joins again | +| 2026-11-04 | minor | M9: a session you joined no longer turns into a local file by itself. A dropped connection reconnects until you leave (a minute's pause after each 12 attempts, a pause Retry now skips); only the host ending the session and refusals that are for good stop it; queued messages go out paced. While disconnected the tab shows a red mark and a strip across the canvas says so; a session that ended stays on its tab with Try again, Save a copy and Dismiss, and what changed offline opens beside it when it joins again | | 2026-10-31 | patch | M9, #1665: the document in a live session's welcome goes compressed (deflate) to clients whose hello announces `packed`, about seven times smaller on the wire (a synthetic file of 4,040 layers: 397 KB to 53 KB); older clients keep getting it uncompressed, and the client reads a packed document only up to the size an uncompressed welcome could have had. | | 2026-10-30 | minor | M9, part of #742: a team list on `figcraft-server`. With `team_files = "edit"` (or `comment`, `view`) everyone who reaches the server sees the files shared from it now (a link of theirs has a join code: Share ▸ Start sharing) and joins them by a team list link, `figcraft://join?server=…&file=…&team=1`, which carries no secret: the server hands out the file's team link while it stays shared (`ResolveTeam`, answered like a join code), and Stop sharing revokes it with the others, disconnecting whoever joined with it. Turning the list off or changing its access refuses the old team links at once. `collab.files {refresh}` asks the server in Preferences for its list (`Admin::Team`; not the public server FigCraft ships with), and Home ▸ Online shows it below your own files: a row joins its file, its menu copies the link for the app or, with the server's `web_url`, for the browser build (`#join=…`). A browser build served beside its server names it with ``, the page's default for sharing, codes and the team list. No accounts: the list is for a server only your team reaches. Tests: `team_tests` (the server and apps over loopback), `code_tests` (links and the browser's driver), `online_tests` (the Online section), `query_tests` (the page's server). Percentages and hours unchanged | | 2026-10-30 | minor | M9, #1130: `figcraft-server` compares the SHA-256 digests of the presented and the kept server key instead of the raw strings, as `docs/server.md` says; the key file, `figcraft-server key` and rotation are unchanged. Numbers unchanged. | From 0ca48147e5b6cbb35181e042ac942f90c6120d40 Mon Sep 17 00:00:00 2001 From: fluid-chey Date: Wed, 4 Nov 2026 13:21:38 -0700 Subject: [PATCH 53/68] M9: a reconnect starts its pace afresh in the browser, as on the desktop Co-Authored-By: Claude Opus 5.5 --- crates/collab-net/src/driver.rs | 2 ++ crates/collab-net/src/driver_tests.rs | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/crates/collab-net/src/driver.rs b/crates/collab-net/src/driver.rs index 622b6c52d..a570836d3 100644 --- a/crates/collab-net/src/driver.rs +++ b/crates/collab-net/src/driver.rs @@ -165,6 +165,8 @@ impl Driver { fn connect(&mut self, now: Instant) { self.reconnect_at = None; + // A server counts per connection. + self.pace = Pace::new(now); self.conn = Some(Conn::new(now)); if let Err(e) = self.sock.open(&self.server().url()) { self.dropped(e, now); diff --git a/crates/collab-net/src/driver_tests.rs b/crates/collab-net/src/driver_tests.rs index 83684db7e..69cafb929 100644 --- a/crates/collab-net/src/driver_tests.rs +++ b/crates/collab-net/src/driver_tests.rs @@ -392,6 +392,24 @@ fn a_long_queue_goes_out_paced_and_in_order() { assert_eq!(d.deadline().unwrap() - now, ms(500), "nothing left to send but the reconnect"); } +#[test] +fn a_new_connection_starts_with_a_fresh_pace() { + let t0 = Instant::now(); + let (mut d, _inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + for seq in 0..500 { + d.send(ClientMsg::Ack { seq }, t0); + } + d.closed(1006, "", t0); + let back = d.deadline().unwrap(); + d.tick(back); + d.opened(back); + d.message(&welcome(), back); + d.send(ClientMsg::Ack { seq: 900 }, back); + assert!(d.sock.sent.iter().any(|m| matches!(m, ClientMsg::Ack { seq: 900 })), "sent at once"); +} + #[test] fn leaving_sends_what_was_waiting_its_turn() { let t0 = Instant::now(); From c25088c58a9bbaf5ad6a47766868b14d615a7d5e Mon Sep 17 00:00:00 2001 From: fluid-chey Date: Wed, 4 Nov 2026 13:49:15 -0700 Subject: [PATCH 54/68] M9: count the pace of queued sends when they go, and say when leaving early The pace was set when a message was queued, so messages held up by a stalled connection left together afterwards and could trip the server's rate limit. One queue now counts it as they go, for the desktop and the browser alike. Leaving while changes are unconfirmed now says so: an undo waits for its edit, so what was still on its way may not all reach the others. Co-Authored-By: Claude Opus 5.5 --- crates/collab-net/src/driver.rs | 33 +++++++----------- crates/collab-net/src/driver_tests.rs | 16 +++++++++ crates/collab-net/src/guest.rs | 19 ++++------- crates/collab-net/src/throttle.rs | 47 ++++++++++++++++++++------ crates/engine/src/collab_live_tests.rs | 12 +++++++ crates/engine/src/sharing/live/join.rs | 9 +++-- 6 files changed, 92 insertions(+), 44 deletions(-) diff --git a/crates/collab-net/src/driver.rs b/crates/collab-net/src/driver.rs index a570836d3..049a60146 100644 --- a/crates/collab-net/src/driver.rs +++ b/crates/collab-net/src/driver.rs @@ -18,7 +18,6 @@ use figcraft_collab::message::{self, ClientMsg, Presence, ServerMsg}; use figcraft_engine::live::{Event, Status}; -use std::collections::VecDeque; use std::time::Duration; // `std::time::Instant` on native builds; the browser's clock in the web build. use web_time::Instant; @@ -29,7 +28,7 @@ use crate::invite::Endpoint; use crate::join::{GuestConfig, Next, Outcome, Resuming, Seen, Taken, after, ask, closed, hello, resolved, take, too_large, unresolved}; use crate::limits::NetLimits; use crate::requests::Publish; -use crate::throttle::{PRESENCE_INTERVAL, Pace, Throttle, earliest}; +use crate::throttle::{PRESENCE_INTERVAL, Paced, Throttle, earliest}; /// A WebSocket the driver opens, writes and closes; what it receives comes back through the /// driver's event methods. @@ -80,9 +79,8 @@ pub(crate) struct Driver { /// Your latest presence while not welcomed (sent with the welcome). pending: Option, throttle: Throttle, - /// Sync messages waiting their turn (a long queue from while offline), and when each may go. - pace: Pace, - paced: VecDeque<(Instant, ClientMsg)>, + /// Sync messages waiting their turn (a long queue from while offline). + paced: Paced, reconnect_at: Option, /// What this connection asks a server (a managing one), and what follows its answers. asking: Option<(Box, Then)>, @@ -101,8 +99,7 @@ impl Driver { resume: Resuming::default(), pending: None, throttle: Throttle::new(PRESENCE_INTERVAL), - pace: Pace::new(now), - paced: VecDeque::new(), + paced: Paced::new(now), reconnect_at: None, asking: None, done: false, @@ -165,8 +162,8 @@ impl Driver { fn connect(&mut self, now: Instant) { self.reconnect_at = None; - // A server counts per connection. - self.pace = Pace::new(now); + // A server counts per connection, and these were made for the last one. + self.paced = Paced::new(now); self.conn = Some(Conn::new(now)); if let Err(e) = self.sock.open(&self.server().url()) { self.dropped(e, now); @@ -311,19 +308,15 @@ impl Driver { if !self.conn.as_ref().is_some_and(|c| c.welcomed) { return; } - let wait = self.pace.wait(now); - if wait.is_zero() && self.paced.is_empty() { - if !self.write(&msg) { - self.end(Outcome::Retry("the connection dropped".into()), now); - } - } else { - self.paced.push_back((now + wait, msg)); + self.paced.push(msg); + if !self.send_paced(now) { + self.end(Outcome::Retry("the connection dropped".into()), now); } } /// Send the sync messages whose turn has come; false when one couldn't go. fn send_paced(&mut self, now: Instant) -> bool { - while let Some((_, msg)) = self.paced.pop_front_if(|(at, _)| *at <= now) { + while let Some(msg) = self.paced.take_due(now) { if !self.write(&msg) { return false; } @@ -342,7 +335,7 @@ impl Driver { /// Leave the session. pub(crate) fn leave(&mut self, now: Instant) { // What you did before leaving still reaches the others, whatever its turn. - while let Some((_, msg)) = self.paced.pop_front() { + while let Some(msg) = self.paced.take_now() { if !self.write(&msg) { break; } @@ -364,7 +357,7 @@ impl Driver { [Some(c.last_ping + l.keepalive), Some(c.last_heard + c.silence_limit(l)), if c.welcomed { self.throttle.due() } else { None }] } }); - earliest(conn.into_iter().flatten().chain([self.reconnect_at, self.paced.front().map(|(at, _)| *at)])) + earliest(conn.into_iter().flatten().chain([self.reconnect_at, self.paced.due()])) } /// Do what's due at `now`: reconnect, send held presence or a ping, give up on a connection @@ -426,7 +419,7 @@ impl Driver { } self.throttle = Throttle::new(PRESENCE_INTERVAL); // Made for this connection: the sync client sends again what the server didn't get. - self.paced.clear(); + self.paced = Paced::new(now); match after(outcome, &self.cfg, self.was_live, &mut self.attempt, &self.inbox) { Next::Stop(e) => { if let Some(e) = e { diff --git a/crates/collab-net/src/driver_tests.rs b/crates/collab-net/src/driver_tests.rs index 69cafb929..19c282615 100644 --- a/crates/collab-net/src/driver_tests.rs +++ b/crates/collab-net/src/driver_tests.rs @@ -392,6 +392,22 @@ fn a_long_queue_goes_out_paced_and_in_order() { assert_eq!(d.deadline().unwrap() - now, ms(500), "nothing left to send but the reconnect"); } +#[test] +fn messages_held_up_by_a_stall_dont_leave_together() { + let t0 = Instant::now(); + let (mut d, _inbox) = start(Script::default(), t0); + d.opened(t0); + d.message(&welcome(), t0); + for seq in 0..700 { + d.send(ClientMsg::Ack { seq }, t0); + } + let acks = |d: &Driver