What causes "Invalid 'summary' in UpdateProgressForm" in sxyazi/yazi?

Include a `"summary"` field in the update-progress action payload.

Invalid 'summary' in UpdateProgressForm

Error message

Invalid 'summary' in UpdateProgressForm

What it means

`UpdateProgressForm::try_from(ActionCow)` requires the action payload to carry an arbitrary-typed `"summary"` key via `a.take_any("summary")`. If the key is absent, the form cannot be constructed and this error is thrown. It is a payload-validation error for the app's `update-progress` action.

Source

Thrown at yazi-parser/src/app/update_progress.rs:16

use anyhow::bail;
use mlua::{ExternalError, FromLua, IntoLua, Lua, Value};
use yazi_scheduler::TaskSummary;
use yazi_shared::event::ActionCow;

#[derive(Debug)]
pub struct UpdateProgressForm {
	pub summary: TaskSummary,
}

impl TryFrom<ActionCow> for UpdateProgressForm {
	type Error = anyhow::Error;

	fn try_from(mut a: ActionCow) -> Result<Self, Self::Error> {
		let Some(summary) = a.take_any("summary") else {
			bail!("Invalid 'summary' in UpdateProgressForm");
		};

		Ok(Self { summary })
	}
}

impl FromLua for UpdateProgressForm {
	fn from_lua(_: Value, _: &Lua) -> mlua::Result<Self> { Err("unsupported".into_lua_err()) }
}

impl IntoLua for UpdateProgressForm {
	fn into_lua(self, _: &Lua) -> mlua::Result<Value> { Err("unsupported".into_lua_err()) }
}

View on GitHub (pinned to 5f901b886b)

Solutions

Include a `"summary"` field in the update-progress action payload.
Check the key spelling and that the value is set with the same mechanism (`set_any`/deserialize) the parser reads with `take_any`.
Consult the current yazi version's action schema — payload keys may have changed.

Example fix

-- before (Lua)
local a = Action("update_progress")
-- after
local a = Action("update_progress", { summary = "Copying 3/10 files" })

Defensive patterns

Strategy: validation

Validate before calling

assert!(payload.contains_key("summary"), "update-progress action requires 'summary'");

Type guard

fn is_valid_update_progress(a: &Action) -> bool {
    a.get("summary").is_some()
}

Try / catch

match UpdateProgressForm::try_from(action) {
    Ok(form) => apply(form),
    Err(e) if e.to_string().contains("Invalid 'summary'") => {
        eprintln!("update-progress action missing 'summary': {e}")
    }
    Err(e) => return Err(e),
}

Prevention

Always set "summary" via the action builder before emitting update-progress.
Reuse the same key constants for set and take to avoid typos.
Update plugin code when upgrading yazi — payload keys can change between versions.

When it happens

Trigger: Sending an `update-progress` ActionCow (e.g. from Lua or IPC) without a `"summary"` entry, or with the value stored under a misspelled key, or as something not consumable via `take_any`.

Common situations: Plugin authors emitting `app:update_progress` / progress actions with partial fields; API drift after renaming payload keys across yazi versions; IPC clients constructing actions by hand.

Understand the failure class

Background: "missing required argument" and "the following required arguments were not provided": what required-argument errors mean and how to fix them — this error's family across 20 libraries.

Related errors

AI-assisted analysis of sxyazi/yazi@5f901b886b (2026-09-02). Data as JSON: /api/errors/2f09da6ffcd2ad70. Report an issue: GitHub.