Kaleido doesn't generate the image output on MacOS / Windows

[alceal]

I'm using the example from the README.md to test the write_image function, but it neither generates nor panics. I'm on MacOS 15.0.1 (Sequoia).

plotly = { version = "0.10.0", features = ["kaleido"]}

use plotly::{ImageFormat, Plot, Scatter};

fn main() {
    let mut plot = Plot::new();
    let trace = Scatter::new(vec![0, 1, 2], vec![2, 1, 0]);
    plot.add_trace(trace);

    plot.write_image("out.png", ImageFormat::PNG, 800, 600, 1.0);
}

[andrei-ng]

@alceal thanks for reporting the issue. I was under the false impression that only the CI had issues. This means that indeed there is something wrong on MacOS. I will try to see if I can get to the bottom of it using the GitHub runners (don't own a Mac) .
It might also be a Kaleido issue in itself, not a plotly-rs one, but worth looking into.

[ndrezn]

Just a heads up, we're working on a rebuild of Kaleido. The new versions are on PyPi as v1.0.0rc0. See: https://github.com/plotly/kaleido for a bit more. I'm not sure how Kaleido is integrated into plotly.rs but if there is a coupling on the PyPi project this may have broken it.

We released a few minors (v0.4.0-v0.4.2) but we yanked them as we worked out naming scheme: This is a complete rebuild so we might end up publishing it under a new name.

The timing of this ticket is about when we published the new versions, but as they're now yanked I wouldn't expect further issues.

[andrei-ng]

Hi Nathan, thank you for this info. I noticed that Greg commented on a few tickets on other projects related to Kaleido that a new version is coming out and I am looking forward to that. There is something broken in Kaleido or our integration with which causes this issue on plotly-rs, just didn't have the time to look into it. Will have to take the leap soon.

We are using an older version though. Need to check if the newer release candidate improves things. FYI , in this crate, Kaleido gets downloaded at build time on the users machine and the package version is hardcoded here https://github.com/plotly/plotly.rs/blob/main/plotly_kaleido/build.rs

[andrei-ng]

Hi @alceal, is the architecture of your Mac by any chance arm?

[emilbratt]

Hi @alceal, is the architecture of your Mac by any chance arm?

@andrei-ng
Not the person you asked, but I wanted to share that I tried this on my Macbook Air to verify.
It does indeed hang (no panic and nothing generated), just as described in this issue.

MacOS Sonoma 14.1.1 (23B81)
Arm CPU (the M1 Apple silicon)

[andrei-ng]

Hi @alceal, is the architecture of your Mac by any chance arm?

@andrei-ng Not the person you asked, but I wanted to share that I tried this on my Macbook Air to verify. It does indeed hang (no panic and nothing generated), just as described in this issue.

MacOS Sonoma 14.1.1 (23B81) Arm CPU (the M1 Apple silicon)

Thank you @emilbratt!

[andrei-ng]

Been trying to track down the problem. It seems that is an Apple M1 Sillicon issue with Kaleido itslef. I asked a colleague to test it on his MacOS and he had no issues with Apple M3 Max . I am inclined to consider it to be a Kaleido issue as there have been some reports in the past related to that plotly/Kaleido#129

I will investigate further and provide another update once I know more.

[alceal]

Hi @alceal, is the architecture of your Mac by any chance arm?

Yes, it's Apple Silicon M1 Max

[andrei-ng]

Thank you for confirming.

[joaquinbejar]

Extra info – new failing test (Apple Silicon, macOS 15.4.1 / Rust 1.86.0)

I’ve reproduced #241 on the latest Sequoia release. The minimal test below hangs and spits the familiar locale_file_path.empty() warning before Kaleido gives up.

#[cfg(target_os = "macos")]
#[cfg(feature = "kaleido")]
#[test]
fn save_surface_to_png() {
    use plotly::{ImageFormat, Plot, Surface};
    use std::path::PathBuf;

    let mut plot = Plot::new();
    let surface = Surface::new(
        vec![
            vec![1.0, 2.0, 3.0],
            vec![4.0, 5.0, 6.0],
            vec![7.0, 8.0, 9.0],
        ])
        .x(vec![1.0, 2.0, 3.0])
        .y(vec![4.0, 5.0, 6.0])
        .name("Surface");

    plot.add_trace(surface);

    let dst = PathBuf::from("out.png");
    plot.write_image(dst.to_str().unwrap(), ImageFormat::PNG, 800, 600, 1.0);

    // sanity checks
    assert!(dst.exists());
    assert!(std::fs::remove_file(&dst).is_ok());
    assert!(!dst.exists());
    assert!(!plot.to_base64(ImageFormat::PNG, 1024, 680, 1.0).is_empty()); // Fail!
}

Stderr (trimmed)

Kaleido failed to generate static image for format: png
[0511/100833.547058:WARNING:resource_bundle.cc(431)] locale_file_path.empty() for locale en-US

assertion failed: !plot.to_base64(ImageFormat::PNG, 1024, 680, 1.0).is_empty()

Environment

• macOS 15.4.1 (Sequoia) – Apple M4 Max (arm64)
• rustc 1.86.0 (stable)
• plotly = "0.12.1", plotly_kaleido = "0.12.1"
• Kaleido binary Version 0.2.1

Happy to run more tests on Apple Silicon if that helps!

—Joaquín