Hmbown/CodeWhale · error

failed to parse serialized config for comment merge; file…

Error message

failed to parse serialized config for comment merge; file contents were omitted

What it means

In merge_and_preserve_comments, after the original parses, the newly serialized config string itself is parsed with toml_edit::DocumentMut. If the serialized text is invalid TOML, this error is thrown. This usually indicates an internal bug (the serializer produced bad TOML) rather than user input.

Solutions

1. Upgrade the library / check for fixed serializer bugs if the serialized text was produced internally
2. Validate the serialized string with a TOML parser before calling merge_and_preserve_comments
3. Fix string escaping/quoting in custom code that builds the serialized config
4. Report a bug with the serialized output if the serializer itself is at fault

Example fix

// before
let out = merge_and_preserve_comments(&format!("model = {}", name), &original)?;
// after
let out = merge_and_preserve_comments(&format!("model = {:?}", name), &original)?;

toml::from_str::<toml::Value>(serialized).map_err(|e| format!("serialized config invalid: {e}"))?;

match merge_and_preserve_comments(&serialized, &original) {
    Ok(out) => write(out),
    Err(e) => { log::error!("serializer bug: {e}"); report_bug(); }
}

When it happens

Trigger: Calling merge_and_preserve_comments with a `serialized` argument that is not valid TOML — typically a bug in the code path that generated the serialized config.

Common situations: A library version bug producing malformed TOML (unescaped strings, invalid characters in values); passing hand-built or truncated serialized text into the API.

Understand the failure class

Background: Schema validation failed / invalid input schema: payload rejected because its shape doesn't match the expected schema — this error's family across 28 libraries.

• Parsing and encoding errors: unexpected token, malformed input — why parsers reject input and how to find the real culprit.

Related errors

• Could not parse configuration for route preference…
• Could not parse destination route identity; contents omitted
• could not prepare imported configuration; contents omitted
• failed to parse config at
• failed to parse config at

AI-assisted analysis of Hmbown/CodeWhale@73e0f67d83 (2026-09-22). Data as JSON: /api/errors/2e32a42ceda3c26e. Report an issue: GitHub.

Appendix: source

Thrown at crates/config/src/lib.rs:5606

/// Merge comments and formatting from an original TOML file into a
/// freshly serialized document so user annotations (comments, whitespace,
/// disabled keys) survive config rewrites.
///
/// `original_raw` is the raw text of the file before the change; the
/// function parses it internally with [`toml_edit`] so callers stay free
/// of that dependency.
pub fn merge_and_preserve_comments(serialized: &str, original_raw: &str) -> Result<String> {
    let original = original_raw
        .parse::<toml_edit::DocumentMut>()
        .map_err(|_| {
            anyhow::anyhow!(
                "failed to parse original config for comment merge; file contents were omitted"
            )
        })?;

    let mut new_doc = serialized.parse::<toml_edit::DocumentMut>().map_err(|_| {
        anyhow::anyhow!(
            "failed to parse serialized config for comment merge; file contents were omitted"
        )
    })?;

    // Reuse the original document’s trailing text (file-footer comments /
    // disabled keys) so they survive the rewrite.
    new_doc.set_trailing(original.trailing().clone());

    // Copy the top-level table's decor (document-header comments, whitespace
    // before the first key) which `toml_edit` stores on the root `Table` itself.
    *new_doc.as_table_mut().decor_mut() = original.as_table().decor().clone();

    merge_decor_table(new_doc.as_table_mut(), original.as_table());

    Ok(new_doc.to_string())
}

/// Recursively copy `decor` (prefix/suffix comments and whitespace) from

View on GitHub (pinned to 73e0f67d83)