Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
gpui: Fix out-of-bounds panic rendering GIFs (#54701)
Smit Barmase749fcfdfd860
diff --git a/crates/gpui/src/elements/img.rs b/crates/gpui/src/elements/img.rsindex 595052ac210..6f01182f9e7 100644--- a/crates/gpui/src/elements/img.rs+++ b/crates/gpui/src/elements/img.rs@@ -294,7 +294,7 @@ impl Element for Img {})});- let frame_index = state.as_ref().map(|state| state.frame_index).unwrap_or(0);+ let mut frame_index = state.as_ref().map(|state| state.frame_index).unwrap_or(0);let layout_id = self.interactivity.request_layout(global_id,@@ -312,8 +312,11 @@ impl Element for Img {cx,) {Some(Ok(data)) => {+ let frame_count = data.frame_count();+ let max_frame_index = frame_count.saturating_sub(1);+if let Some(state) = &mut state {- let frame_count = data.frame_count();+ state.frame_index = state.frame_index.min(max_frame_index);if frame_count > 1 {if window.is_window_active() {let current_time = Instant::now();@@ -334,8 +337,11 @@ impl Element for Img {} else {state.last_frame_time = None;}+ } else {+ state.last_frame_time = None;}state.started_loading = None;+ frame_index = state.frame_index;}let image_size = data.render_size(frame_index);@@ -799,14 +805,59 @@ impl From<image::ImageError> for ImageCacheError {#[cfg(test)]mod tests {use super::*;- use crate::{TestAppContext, point, px, size};+ use crate::{ParentElement as _, TestAppContext, canvas, div, point, px, size};+ use image::{Frame, ImageBuffer, Rgba};++ const TEST_IMG_ID: &str = "test-img";++ fn test_image(frame_count: usize) -> Arc<RenderImage> {+ let frame = Frame::new(ImageBuffer::from_pixel(1, 1, Rgba([0, 0, 0, 0])));+ Arc::new(RenderImage::new(SmallVec::from_iter(+ (0..frame_count).map(|_| frame.clone()),+ )))+ }++ /// Overwrites the cached `frame_index` of the sibling `img` during paint.+ fn seed_frame_index(frame_index: usize) -> impl IntoElement {+ canvas(+ |_, _, _| (),+ move |_, _, window, _| {+ window.with_global_id(TEST_IMG_ID.into(), |id, window| {+ window.with_element_state::<ImgState, _>(id, |state, _| {+ let mut state = state.expect("img state should be initialized");+ state.frame_index = frame_index;+ ((), state)+ });+ });+ },+ )+ }#[gpui::test]fn zero_frame_image_does_not_panic_on_paint(cx: &mut TestAppContext) {- let cx = cx.add_empty_window();- let image = Arc::new(RenderImage::new(SmallVec::new()));- cx.draw(point(px(0.), px(0.)), size(px(100.), px(100.)), |_, _| {- img(ImageSource::Render(image)).into_any_element()+ cx.add_empty_window()+ .draw(point(px(0.), px(0.)), size(px(100.), px(100.)), |_, _| {+ img(ImageSource::Render(test_image(0))).into_any_element()+ });+ }++ #[gpui::test]+ fn stale_frame_index_is_clamped_when_image_changes(cx: &mut TestAppContext) {+ let window = cx.add_empty_window();++ // Assert that a cached frame_index from a previous multi-frame image+ // does not cause an out-of-bounds panic when the image is replaced+ // with one that has fewer frames.+ window.draw(point(px(0.), px(0.)), size(px(100.), px(100.)), |_, _| {+ div()+ .child(img(ImageSource::Render(test_image(5))).id(TEST_IMG_ID))+ .child(seed_frame_index(4))+ .into_any_element()+ });+ window.draw(point(px(0.), px(0.)), size(px(100.), px(100.)), |_, _| {+ img(ImageSource::Render(test_image(1)))+ .id(TEST_IMG_ID)+ .into_any_element()});}}