Check for webgl2 validation errors and catch issues (#3296)

cwfitzgerald · web-flow · commit 6b6bc69ba076 · 2022-12-20T15:51:17.000-05:00
diff --git a/wgpu/examples/boids/main.rs b/wgpu/examples/boids/main.rs
@@ -329,7 +329,10 @@ fn main() {
     framework::run::<Example>("boids");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn boids() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/boids/screenshot.png",
diff --git a/wgpu/examples/bunnymark/main.rs b/wgpu/examples/bunnymark/main.rs
@@ -357,7 +357,10 @@ fn main() {
     framework::run::<Example>("bunnymark");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn bunnymark() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/bunnymark/screenshot.png",
diff --git a/wgpu/examples/capture/main.rs b/wgpu/examples/capture/main.rs
@@ -225,7 +225,10 @@ mod tests {
     use super::*;
     use wgpu::BufferView;
 
+    wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
     #[test]
+    #[wasm_bindgen_test::wasm_bindgen_test]
     fn ensure_generated_data_matches_expected() {
         assert_generated_data_matches_expected();
     }
diff --git a/wgpu/examples/conservative-raster/main.rs b/wgpu/examples/conservative-raster/main.rs
@@ -314,7 +314,10 @@ fn main() {
     framework::run::<Example>("conservative-raster");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn conservative_raster() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/conservative-raster/screenshot.png",
diff --git a/wgpu/examples/cube/main.rs b/wgpu/examples/cube/main.rs
@@ -406,7 +406,10 @@ fn main() {
     framework::run::<Example>("cube");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn cube() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/cube/screenshot.png",
@@ -420,6 +423,7 @@ fn cube() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn cube_lines() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/cube/screenshot-lines.png",
diff --git a/wgpu/examples/hello-compute/tests.rs b/wgpu/examples/hello-compute/tests.rs
@@ -6,7 +6,10 @@ use std::sync::Arc;
 use super::*;
 use common::{initialize_test, TestParameters};
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn test_compute_1() {
     initialize_test(
         TestParameters::default()
@@ -27,6 +30,7 @@ fn test_compute_1() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn test_compute_2() {
     initialize_test(
         TestParameters::default()
@@ -47,6 +51,7 @@ fn test_compute_2() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn test_compute_overflow() {
     initialize_test(
         TestParameters::default()
@@ -66,6 +71,7 @@ fn test_compute_overflow() {
 }
 
 #[test]
+// Wasm doesn't support threads
 fn test_multithreaded_compute() {
     initialize_test(
         TestParameters::default()
diff --git a/wgpu/examples/mipmap/main.rs b/wgpu/examples/mipmap/main.rs
@@ -487,7 +487,10 @@ fn main() {
     framework::run::<Example>("mipmap");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn mipmap() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/mipmap/screenshot.png",
diff --git a/wgpu/examples/msaa-line/main.rs b/wgpu/examples/msaa-line/main.rs
@@ -310,7 +310,10 @@ fn main() {
     framework::run::<Example>("msaa-line");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn msaa_line() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/msaa-line/screenshot.png",
diff --git a/wgpu/examples/shadow/main.rs b/wgpu/examples/shadow/main.rs
@@ -841,7 +841,10 @@ fn main() {
     framework::run::<Example>("shadow");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn shadow() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/shadow/screenshot.png",
@@ -850,6 +853,7 @@ fn shadow() {
         optional_features: wgpu::Features::default(),
         base_test_parameters: framework::test_common::TestParameters::default()
             .downlevel_flags(wgpu::DownlevelFlags::COMPARISON_SAMPLERS)
+            .specific_failure(Some(wgpu::Backends::GL), None, Some("ANGLE"), false)
             // rpi4 on VK doesn't work: https://gitlab.freedesktop.org/mesa/mesa/-/issues/3916
             .specific_failure(Some(wgpu::Backends::VULKAN), None, Some("V3D"), false)
             // llvmpipe versions in CI are flaky: https://github.com/gfx-rs/wgpu/issues/2594
diff --git a/wgpu/examples/skybox/main.rs b/wgpu/examples/skybox/main.rs
@@ -465,20 +465,29 @@ fn main() {
     framework::run::<Skybox>("skybox");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn skybox() {
     framework::test::<Skybox>(framework::FrameworkRefTest {
         image_path: "/examples/skybox/screenshot.png",
         width: 1024,
         height: 768,
         optional_features: wgpu::Features::default(),
-        base_test_parameters: framework::test_common::TestParameters::default(),
+        base_test_parameters: framework::test_common::TestParameters::default().specific_failure(
+            Some(wgpu::Backends::GL),
+            None,
+            Some("ANGLE"),
+            false,
+        ),
         tolerance: 3,
         max_outliers: 207, // bounded by swiftshader
     });
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn skybox_bc1() {
     framework::test::<Skybox>(framework::FrameworkRefTest {
         image_path: "/examples/skybox/screenshot-bc1.png",
@@ -492,6 +501,7 @@ fn skybox_bc1() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn skybox_etc2() {
     framework::test::<Skybox>(framework::FrameworkRefTest {
         image_path: "/examples/skybox/screenshot-etc2.png",
@@ -505,6 +515,7 @@ fn skybox_etc2() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn skybox_astc() {
     framework::test::<Skybox>(framework::FrameworkRefTest {
         image_path: "/examples/skybox/screenshot-astc.png",
diff --git a/wgpu/examples/texture-arrays/main.rs b/wgpu/examples/texture-arrays/main.rs
@@ -406,7 +406,10 @@ fn main() {
     framework::run::<Example>("texture-arrays");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn texture_arrays_uniform() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/texture-arrays/screenshot.png",
@@ -420,6 +423,7 @@ fn texture_arrays_uniform() {
 }
 
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn texture_arrays_non_uniform() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/texture-arrays/screenshot.png",
diff --git a/wgpu/examples/water/main.rs b/wgpu/examples/water/main.rs
@@ -818,7 +818,10 @@ fn main() {
     framework::run::<Example>("water");
 }
 
+wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
+
 #[test]
+#[wasm_bindgen_test::wasm_bindgen_test]
 fn water() {
     framework::test::<Example>(framework::FrameworkRefTest {
         image_path: "/examples/water/screenshot.png",
diff --git a/wgpu/src/backend/direct.rs b/wgpu/src/backend/direct.rs
@@ -2072,7 +2072,7 @@ impl crate::Context for Context {
     fn queue_write_buffer(
         &self,
         queue: &Self::QueueId,
-        _queue_data: &Self::QueueData,
+        queue_data: &Self::QueueData,
         buffer: &Self::BufferId,
         _buffer_data: &Self::BufferData,
         offset: wgt::BufferAddress,
@@ -2083,46 +2083,54 @@ impl crate::Context for Context {
             *queue => global.queue_write_buffer(*queue, *buffer, offset, data)
         ) {
             Ok(()) => (),
-            Err(err) => self.handle_error_fatal(err, "Queue::write_buffer"),
+            Err(err) => {
+                self.handle_error_nolabel(&queue_data.error_sink, err, "Queue::write_buffer")
+            }
         }
     }
 
     fn queue_validate_write_buffer(
         &self,
         queue: &Self::QueueId,
-        _queue_data: &Self::QueueData,
+        queue_data: &Self::QueueData,
         buffer: &Self::BufferId,
         _buffer_data: &Self::BufferData,
         offset: wgt::BufferAddress,
         size: wgt::BufferSize,
-    ) {
+    ) -> Option<()> {
         let global = &self.0;
         match wgc::gfx_select!(
             *queue => global.queue_validate_write_buffer(*queue, *buffer, offset, size.get())
         ) {
-            Ok(()) => (),
-            Err(err) => self.handle_error_fatal(err, "Queue::write_buffer_with"),
+            Ok(()) => Some(()),
+            Err(err) => {
+                self.handle_error_nolabel(&queue_data.error_sink, err, "Queue::write_buffer_with");
+                None
+            }
         }
     }
 
     fn queue_create_staging_buffer(
         &self,
         queue: &Self::QueueId,
-        _queue_data: &Self::QueueData,
+        queue_data: &Self::QueueData,
         size: wgt::BufferSize,
-    ) -> Box<dyn crate::context::QueueWriteBuffer> {
+    ) -> Option<Box<dyn crate::context::QueueWriteBuffer>> {
         let global = &self.0;
         match wgc::gfx_select!(
             *queue => global.queue_create_staging_buffer(*queue, size, ())
         ) {
-            Ok((buffer_id, ptr)) => Box::new(QueueWriteBuffer {
+            Ok((buffer_id, ptr)) => Some(Box::new(QueueWriteBuffer {
                 buffer_id,
                 mapping: BufferMappedRange {
                     ptr,
                     size: size.get() as usize,
                 },
-            }),
-            Err(err) => self.handle_error_fatal(err, "Queue::write_buffer_with"),
+            })),
+            Err(err) => {
+                self.handle_error_nolabel(&queue_data.error_sink, err, "Queue::write_buffer_with");
+                None
+            }
         }
     }
 
diff --git a/wgpu/src/backend/web.rs b/wgpu/src/backend/web.rs
@@ -2250,38 +2250,44 @@ impl crate::context::Context for Context {
         _buffer_data: &Self::BufferData,
         offset: wgt::BufferAddress,
         size: wgt::BufferSize,
-    ) {
+    ) -> Option<()> {
         let usage = wgt::BufferUsages::from_bits_truncate(buffer.0.usage());
+        // TODO: actually send this down the error scope
         if !usage.contains(wgt::BufferUsages::COPY_DST) {
-            panic!("Destination buffer is missing the `COPY_DST` usage flag");
+            log::error!("Destination buffer is missing the `COPY_DST` usage flag");
+            return None;
         }
         let write_size = u64::from(size);
         if write_size % wgt::COPY_BUFFER_ALIGNMENT != 0 {
-            panic!(
+            log::error!(
                 "Copy size {} does not respect `COPY_BUFFER_ALIGNMENT`",
                 size
             );
+            return None;
         }
         if offset % wgt::COPY_BUFFER_ALIGNMENT != 0 {
-            panic!(
+            log::error!(
                 "Buffer offset {} is not aligned to block size or `COPY_BUFFER_ALIGNMENT`",
                 offset
             );
+            return None;
         }
         if write_size + offset > buffer.0.size() as u64 {
-            panic!("copy of {}..{} would end up overrunning the bounds of the destination buffer of size {}", offset, offset + write_size, buffer.0.size());
+            log::error!("copy of {}..{} would end up overrunning the bounds of the destination buffer of size {}", offset, offset + write_size, buffer.0.size());
+            return None;
         }
+        Some(())
     }
 
     fn queue_create_staging_buffer(
         &self,
         _queue: &Self::QueueId,
         _queue_data: &Self::QueueData,
         size: wgt::BufferSize,
-    ) -> Box<dyn QueueWriteBuffer> {
-        Box::new(WebQueueWriteBuffer(
+    ) -> Option<Box<dyn QueueWriteBuffer>> {
+        Some(Box::new(WebQueueWriteBuffer(
             vec![0; size.get() as usize].into_boxed_slice(),
-        ))
+        )))
     }
 
     fn queue_write_staging_buffer(
diff --git a/wgpu/src/context.rs b/wgpu/src/context.rs
@@ -538,13 +538,13 @@ pub trait Context: Debug + Send + Sized + Sync {
         buffer_data: &Self::BufferData,
         offset: wgt::BufferAddress,
         size: wgt::BufferSize,
-    );
+    ) -> Option<()>;
     fn queue_create_staging_buffer(
         &self,
         queue: &Self::QueueId,
         queue_data: &Self::QueueData,
         size: BufferSize,
-    ) -> Box<dyn QueueWriteBuffer>;
+    ) -> Option<Box<dyn QueueWriteBuffer>>;
     fn queue_write_staging_buffer(
         &self,
         queue: &Self::QueueId,
@@ -1438,13 +1438,13 @@ pub(crate) trait DynContext: Debug + Send + Sync {
         buffer_data: &crate::Data,
         offset: wgt::BufferAddress,
         size: wgt::BufferSize,
-    );
+    ) -> Option<()>;
     fn queue_create_staging_buffer(
         &self,
         queue: &ObjectId,
         queue_data: &crate::Data,
         size: BufferSize,
-    ) -> Box<dyn QueueWriteBuffer>;
+    ) -> Option<Box<dyn QueueWriteBuffer>>;
     fn queue_write_staging_buffer(
         &self,
         queue: &ObjectId,
@@ -2785,7 +2785,7 @@ where
         buffer_data: &crate::Data,
         offset: wgt::BufferAddress,
         size: wgt::BufferSize,
-    ) {
+    ) -> Option<()> {
         let queue = <T::QueueId>::from(*queue);
         let queue_data = downcast_ref(queue_data);
         let buffer = <T::BufferId>::from(*buffer);
@@ -2806,7 +2806,7 @@ where
         queue: &ObjectId,
         queue_data: &crate::Data,
         size: BufferSize,
-    ) -> Box<dyn QueueWriteBuffer> {
+    ) -> Option<Box<dyn QueueWriteBuffer>> {
         let queue = <T::QueueId>::from(*queue);
         let queue_data = downcast_ref(queue_data);
         Context::queue_create_staging_buffer(self, &queue, queue_data, size)
diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs
diff --git a/wgpu/tests/buffer_copy.rs b/wgpu/tests/buffer_copy.rs
diff --git a/wgpu/tests/clear_texture.rs b/wgpu/tests/clear_texture.rs
diff --git a/wgpu/tests/common/image.rs b/wgpu/tests/common/image.rs
diff --git a/wgpu/tests/common/isolation.rs b/wgpu/tests/common/isolation.rs
diff --git a/wgpu/tests/common/mod.rs b/wgpu/tests/common/mod.rs
diff --git a/wgpu/tests/zero_init_texture_after_discard.rs b/wgpu/tests/zero_init_texture_after_discard.rs
