Skip to content

CHANGELOG.md

Latest commit

 

History

History
183 lines (133 loc) · 17.3 KB

CHANGELOG.md

File metadata and controls

183 lines (133 loc) · 17.3 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.7.0 - 2026-09-04

Added

  • Settings page has a "Reload database" button that re-reads the data file from disk into the running server, so a restored backup or manually-edited spoolman.json takes effect without a restart. Invalid or unreadable files are rejected and the currently-loaded data is kept.

1.6.1 - 2026-09-03

Added

  • Spool create/edit color picker now has a #rrggbb text field next to the swatch for typing or pasting an exact hex value.
  • Spool and filament list filters (text search, material, location, colour level, colour pick, show-archived) now persist for the browser tab session, so they survive opening a detail page or reloading the tab. They reset when the tab is closed.
  • "Clear filters" button on the spool and filament list headers, shown only when a filter is active, resets every filter at once.

Fixed

  • Spool edit form now preselects the spool's current storage location in the Location drop-down instead of showing "— none —".

Changed

  • Removed the black square marker from the spool list "Material" column header when a material filter is active; the drop-down already shows the selected value.

1.6.0 - 2026-09-01

Added

  • Spool list text search now also matches storage location name, in addition to filament name, colour name, and material.

Fixed

  • Spool edit form now shows today's date in empty First used / Last used pickers instead of leaving them blank. An untouched default is not saved, so the fields stay unset unless the user picks a date.
  • New spool form: a SpoolmanDB search that returns no match no longer disables the filament selector when the query matches a filament you already have. The matching local filament is selected automatically.

Changed

  • Spool creation now requires a valid location_id: the API rejects a spool with no location, or a location that does not exist, with HTTP 422. Spool updates that set location_id are validated against existing locations.
  • Filament edit page heading now reads "Edit " instead of a generic "Edit Filament".
  • Spool list: clicking the filament name in the first column now opens the spool detail page instead of the filament detail page.
  • Filament detail page heading is prefixed with "Filament:" so it is distinguishable from a spool detail page at a glance.

1.5.0 - 2026-04-12

Added

  • Spool list sorts by closest color match (ascending ΔE*00) when a color search level is active. Switching back to "Off" restores the default column sort order.
  • "Color" column header in the spool list is now clickable — clicking it (or pressing Enter/Space when focused) activates the color picker filter in the page header. The header shows a pointer cursor and accent hover style to signal interactivity.
  • Playwright test suite (tests/playwright/) covering navigation, filament list/detail/create/edit, spool list/detail/create/edit/clone, and API schema validation (38 tests, all passing).
  • Light theme colour palette derived from the Spoolman Light logo: cyan accent (#4DC8E8), charcoal text (#3D4555), and off-white sidebar background (#F0F2F5) replace the previous generic greys and blue. Dark mode tokens are unchanged.
  • CSS styling via stylers 0.3.2 — every Leptos component now has a scoped style! block. Global styles (CSS custom properties, dark-mode overrides, reset, buttons, shared page classes) live in style/spoolman.css bundled via Leptos.toml style-file. The app is no longer completely unstyled (fixes B4).
  • Rust integration test suite — 24 tests covering health, filament, spool, location, and settings endpoints via in-process Axum dispatch; runs with cargo test -p spoolman-server, no Docker required.

Removed

  • remaining_pct field dropped from SpoolResponse API and all UI surfaces (spool list column, spool detail row). The value was redundant — derivable as remaining_filament / net_weight × 100 — and only meaningful when net_weight is set, causing confusing "unknown" states otherwise.

Fixed

  • Docker build no longer fails when GitHub Releases is unreachable: wasm-bindgen-cli is now pre-installed via cargo install in the builder stage so cargo-leptos finds it on $PATH instead of downloading a pre-built binary at build time.
  • scripts/run-e2e.sh now cds into tests/e2e/ before running Playwright so playwright.config.ts (and its baseURL) is picked up correctly. Previously all 15 E2E tests failed with "Cannot navigate to invalid URL" because Playwright ran from the repo root without a config.
  • Spool detail view now shows first_used alongside registered and last_used, with dates formatted as human-readable YYYY-MM-DD HH:MM UTC instead of raw RFC 3339. The edit form gains First used and Last used datetime-local inputs that round-trip dates through the UpdateSpool API (fixes B14).
  • B15 Delete buttons now show inline "Sure?" / "Cancel" confirmation before removing any entity.
  • B15 Location list rows disappear immediately after delete (replaced refetch() with a version-counter reactive source).
  • B15 Spool and Filament list pages now have Delete buttons per row.
  • B15 FilamentShow now has a Delete button.
  • B15 Navigating to a deleted spool or filament (HTTP 404) redirects to the list view instead of showing an error.
  • Spool create and edit dialogs now reject the form with an error message when no location is selected — previously the form submitted with location_id: None silently (fixes B16).
  • Help page had three issues: the "Data file" section linked to /api/v1/setting (returns an empty map) with misleading text; the NFC section displayed the literal text &lt;id&gt; instead of <id> due to double-escaping in the Leptos text node; and no /info endpoint existed. Added GET /api/v1/info (returns { version, data_file }), updated the link and label to point to /api/v1/info, and corrected the NFC URL string (fixes B17).
  • /api/v1/info returned empty — the client was fetching /info but the route is mounted at /api/v1/info; corrected the client path.
  • Opacity (alpha) of spool colours was hardcoded to 255 — the native <input type="color"> element has no alpha channel. Added an <input type="range"> opacity slider (0–255) next to the colour picker in both the create and edit spool forms. The current percentage is shown as a label; the edit form pre-fills the slider from the saved colour's alpha value (fixes B7).
  • Spool create and edit both returned HTTP 500 when the selected filament had net_weight = Some(0.0) — division by zero in SpoolResponse::new produced NaN/±inf for remaining_pct, which serde_json cannot serialize, causing Axum to return 500 instead of the expected 201/200. Added .filter(|&nw| nw > 0.0) before the .map() so remaining_pct is None when net_weight is zero or absent. Regression test create_spool_with_zero_net_weight_filament_returns_201 added (fixes B8, B12). Also fixed spool edit navigation: after a successful save the client now navigates to /spools (list) instead of /spools/{id} (detail) (fixes B9).
  • Filament list sorting was completely non-functional — same root cause as spool list (sort signals tracked for display only, never applied to data). Added sorted closure with numeric comparison for density and date comparison for registered. Added ColHeader for the Density column (was a plain <th>). Manufacturer and Material sort by case-insensitive string; None values sort last regardless of direction (fixes B11).
  • Spool list sorting was completely non-functional — sort_field/sort_asc state was tracked for display but never applied to the data. Added a sorted closure that sorts the filtered items before pagination using numeric comparison for IDs, weights, and percentages (not lexicographic), and string comparison for filament names. Remaining (g) and Location columns previously had no sort button (<th> with no ColHeader); replaced with ColHeader wired to remaining_weight and location fields respectively. None values always sort last regardless of direction (fixes B6, B10).
  • Locations Delete button rendered raw Leptos macro source as its label (0 on : click = move | _ | on_delete(id) >Delete) — > in disabled=move || count > 0 was parsed as the closing > of the <button tag; extracted to let delete_disabled = count > 0 before the view! block (same fix pattern as Pagination "Next →"). Also added .btn:disabled CSS rule so disabled buttons keep their color identity rather than looking like unstyled pagination buttons (fixes B5).
  • Pagination Next/Prev buttons were always disabled — the previous fix for the >= parsing issue extracted next_disabled as a Signal::derive(…), but Leptos 0.6 does not create reactive attribute bindings for a bare Signal<bool> passed by name: it reads the initial value (always true before data loads) and never updates. Changed next_disabled to a plain move || … closure so the attribute binding is reactive (fixes B13).
  • Spool create form sent filament_id: 0 causing a 404 — added a create_effect that initializes the signal to the first loaded filament's ID when the resource resolves.
  • Spool create and edit forms always sent an empty colors array — added <input type="color"> picker wired through hex_to_rgba; edit form pre-fills the picker from the spool's existing first color.

1.4.0 - 2026-03-24

Removed

  • Python/FastAPI backend (spoolman/) — the Rust/Axum server is now the sole backend. No API changes for consumers.
  • Docker-based Python integration test suite (tests_integration/) — no longer applicable to the Rust stack. Rust integration tests are tracked as a follow-up.
  • entrypoint.sh — the uvicorn launcher is not needed; the Rust binary binds SPOOLMAN_HOST/SPOOLMAN_PORT directly.
  • scripts/install.sh and scripts/start.sh — Python/venv install helpers; superseded by docker compose up or cargo leptos build.
  • pyproject.toml, pdm.lock, uv.lock — Python package management files.
  • CI jobs style (Python pre-commit) and build-client (Node/pdm) replaced by cargo check and cargo clippy jobs.

Changed

  • PUID/PGID env vars no longer supported — the Docker image runs as a fixed app user (uid 1000). Ensure volume mounts are accessible by uid 1000.

1.3.0 - 2026-03-24

Removed

  • React/TypeScript frontend (client/) — the Leptos WASM frontend (crates/spoolman-client) is now the sole UI. The client/ directory, npm tooling, and all Node.js build configuration have been deleted.

1.2.0 - 2026-03-24

Added

  • Color proximity filter on spool list: a color picker and threshold slider let users find spools by color similarity using CIEDE2000 (ΔE*00) — a perceptually uniform metric that matches human color vision. Default threshold is 10 ΔE (≈ "acceptably similar"). Replaces the earlier Euclidean RGB distance.

1.1.0 - 2026-03-22

Added

  • MaterialType enum in spoolman-types based on the OpenPrintTag material_type_enum spec (42 named variants + Other(String) catch-all). Serializes as uppercase abbreviation (e.g. "PLA"); unknown strings round-trip without error.
  • Material <select> on filament create/edit forms — replaces free-text input with a dropdown of all 42 spec-defined types plus a "select" blank option.
  • Material filter dropdown on the Filament list page; filters are applied server-side via ?material= query param.
  • Spool list text filter now also matches on filament.material abbreviation (e.g. typing "PLA" narrows spool results).
  • GET /api/v1/material client wrapper (api::list_materials) for future datalist/autocomplete use.
  • .env file support via dotenvy: the server silently loads a .env file from the working directory on startup, before reading environment variables. Missing file is not an error.

1.0.0 - 2026-03-23

Added

  • Full Rust rewrite: Axum backend + Leptos WASM frontend in a Cargo workspace (crates/spoolman-types, crates/spoolman-server, crates/spoolman-client). Build with cargo leptos build --release.
  • docker-compose.yml at repo root for quick local deployment; data persisted in a named Docker volume at /data/spoolman.json.
  • rust-toolchain.toml declares the stable toolchain with wasm32-unknown-unknown target so rustup installs it automatically.
  • spoolman-types shared crate: Spool, Filament, Location, DataStore types used by both server and client, ensuring compile-time API contract consistency.
  • Location as a first-class entity with full CRUD (GET/POST/PATCH/DELETE /api/v1/location) — replaces the previous freeform string field on Spool.
  • GET /api/v1/filament/search?q= endpoint: proxies SpoolmanDB on demand (no background scheduler or local cache).
  • GET /api/v1/export endpoint: downloads the full data store as JSON (useful for backup and migration).
  • Dark mode toggle with CSS variable switching, persisted in localStorage.
  • Spool clone action (POST /api/v1/spool/<id>/clone).
  • SPOOLMAN_DATA_FILE environment variable to configure the path of the JSON data file (default: ~/.local/share/spoolman/spoolman.json).

Changed

  • BREAKING: Entire stack replaced — Python/FastAPI backend and React/Refine/Ant Design frontend superseded by a Rust Cargo workspace (Axum + Leptos WASM). Docker image no longer requires Python runtime or Node.js build artifacts.
  • BREAKING: JSON storage format redesigned for Rust/serde ergonomics. No existing data to migrate (format was unconstrained).
  • BREAKING: Spool and Filament IDs are now random u32 values (previously sequential integers), stable across export/reimport for NFC tag URL durability.
  • BREAKING: Colors represented as Vec<RGBA> (OpenTag3D/OpenPrintTag compatible) instead of hex strings. Color lives on Spool, not Filament.
  • BREAKING: Weight tracked as initial_weight + current_weight (full scale readings). Three-mode weight entry (used/remaining/measured) removed.
  • BREAKING: The Vendor entity removed; vendor is a plain string on Filament.
  • BREAKING: article_number, external_id, lot_nr, extra fields removed from all entities.
  • BREAKING: WebSocket live-update endpoint removed.
  • BREAKING: Backup download endpoint removed (backup still runs automatically in background).
  • Spool NFC Online Data URL maps to /api/v1/spool/<id> (OpenTag3D-compatible).
  • Dockerfile: SPOOLMAN_DATA_FILE defaults to /data/spoolman.json and LEPTOS_SITE_ROOT defaults to /site in the container, matching the volume mount convention.
  • Static asset path in the server is now read from LEPTOS_SITE_ROOT env var (fallback: target/site), enabling the production Docker layout without recompilation.
  • Integration test suite (tests_integration/) rewritten for the Rust API: new Filament/Spool/Location models, RGBA color schema, current_weight weight tracking, new Location CRUD tests, settings tests updated for PUT /api/v1/setting/:key, fields/ tests deleted, test_use.py and test_find_by_color.py deleted, test_measure.py rewritten as current_weight PATCH tests, test_backup.py replaced with export test.

Fixed

  • entrypoint.sh had Windows-style CRLF line endings, causing the Docker container to fail to start on Linux with "no such file or directory".
  • JsonStore._flush could raise FileNotFoundError under concurrent requests due to multiple threads racing to rename the same .tmp file; writes are now serialized with a reentrant lock.
  • Filtering spools by empty filament.name, filament.material, or filament.vendor now correctly returns spools whose filament has no value set for that field.

Removed

  • Vendor entity and all /api/v1/vendor endpoints.
  • color_hex, multi_color_hexes, multi_color_direction from Filament (moved to Spool as colors: Vec<RGBA>).
  • price, weight, spool_weight, article_number, external_id from Filament.
  • lot_nr, external_id from Spool.
  • /api/v1/spool/find-by-color endpoint (no replacement; color filter is a planned enhancement).
  • /api/v1/field/* extra-fields system.
  • Database backends: SQLite, PostgreSQL, MySQL, CockroachDB.
  • Python dependencies: SQLAlchemy, alembic, aiosqlite, asyncpg, aiomysql, psycopg2-binary, sqlalchemy-cockroachdb.
  • Alembic migration directory (migrations/) and alembic.ini.
  • Prometheus metrics endpoint (GET /metrics) and the SPOOLMAN_METRICS_ENABLED environment variable.
  • WebSocket support on all REST endpoints — use polling instead.