From 8f5adeb9c382eddd8c7c658383d74950db46e409 Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Thu, 9 Nov 2023 18:00:17 -0500 Subject: [PATCH] Improve error conditions when parsing hex colors --- crates/gpui2/src/color.rs | 37 ++++++++++++++++++++--------- crates/theme2/src/default_colors.rs | 6 ++--- 2 files changed, 28 insertions(+), 15 deletions(-) diff --git a/crates/gpui2/src/color.rs b/crates/gpui2/src/color.rs index a49b372e869a2c76fb0cbcf84334b818b5ddef88..781551223f9daf4f35a9125e1474f2d0a63dbbd5 100644 --- a/crates/gpui2/src/color.rs +++ b/crates/gpui2/src/color.rs @@ -1,8 +1,8 @@ #![allow(dead_code)] +use anyhow::bail; use serde::de::{self, Deserialize, Deserializer, Visitor}; use std::fmt; -use std::num::ParseIntError; pub fn rgb>(hex: u32) -> C { let r = ((hex >> 16) & 0xFF) as f32 / 255.0; @@ -70,12 +70,7 @@ impl<'de> Visitor<'de> for RgbaVisitor { } fn visit_str(self, value: &str) -> Result { - match value.len() { - 4 | 5 | 7 | 9 => Rgba::try_from(value).map_err(E::custom), - _ => Err(E::custom( - "Bad format for RGBA. Expected #rgb, #rgba, #rrggbb, or #rrggbbaa.", - )), - } + Rgba::try_from(value).map_err(E::custom) } } @@ -116,7 +111,7 @@ impl From for Rgba { } impl TryFrom<&'_ str> for Rgba { - type Error = ParseIntError; + type Error = anyhow::Error; fn try_from(value: &'_ str) -> Result { const RGB: usize = "rgb".len(); @@ -124,12 +119,18 @@ impl TryFrom<&'_ str> for Rgba { const RRGGBB: usize = "rrggbb".len(); const RRGGBBAA: usize = "rrggbbaa".len(); - let Some(("", hex)) = value.split_once('#') else { - panic!("invalid color: {value}"); + const EXPECTED_FORMATS: &'static str = "Expected #rgb, #rgba, #rrggbb, or #rrggbbaa"; + + let Some(("", hex)) = value.trim().split_once('#') else { + bail!("invalid RGBA hex color: '{value}'. {EXPECTED_FORMATS}"); }; let (r, g, b, a) = match hex.len() { RGB | RGBA => { + // There's likely a better way to handle 3 and 4-value hex codes without + // needing to use `.repeat` and incur additional allocations. + // What we probably want to do is parse the single hex digit and then perform + // bit-shifting to "duplicate" the digit. let r = u8::from_str_radix(&hex[0..1].repeat(2), 16)?; let g = u8::from_str_radix(&hex[1..2].repeat(2), 16)?; let b = u8::from_str_radix(&hex[2..3].repeat(2), 16)?; @@ -151,7 +152,7 @@ impl TryFrom<&'_ str> for Rgba { }; (r, g, b, a) } - _ => panic!("invalid color: {value}"), + _ => bail!("invalid RGBA hex color: '{value}'. {EXPECTED_FORMATS}"), }; Ok(Rgba { @@ -367,4 +368,18 @@ mod tests { assert_eq!(actual, rgba(0xff0099ff)) } + + #[test] + fn test_deserialize_eight_value_hex_with_padding_to_rgba() { + let actual: Rgba = serde_json::from_value(json!(" #f5f5f5ff ")).unwrap(); + + assert_eq!(actual, rgba(0xf5f5f5ff)) + } + + #[test] + fn test_deserialize_eight_value_hex_with_mixed_case_to_rgba() { + let actual: Rgba = serde_json::from_value(json!("#DeAdbEeF")).unwrap(); + + assert_eq!(actual, rgba(0xdeadbeef)) + } } diff --git a/crates/theme2/src/default_colors.rs b/crates/theme2/src/default_colors.rs index 92e38ed39e6cc938b02b888e12f5fc5bfbf6daa1..6cfda37a2a632a2d7228152409c1deb1c00c2aa5 100644 --- a/crates/theme2/src/default_colors.rs +++ b/crates/theme2/src/default_colors.rs @@ -1,5 +1,3 @@ -use std::num::ParseIntError; - use gpui::{hsla, Hsla, Rgba}; use crate::colors::{StatusColors, SystemColors, ThemeColors}; @@ -413,10 +411,10 @@ struct StaticColorScaleSet { } impl TryFrom for ColorScaleSet { - type Error = ParseIntError; + type Error = anyhow::Error; fn try_from(value: StaticColorScaleSet) -> Result { - fn to_color_scale(scale: StaticColorScale) -> Result { + fn to_color_scale(scale: StaticColorScale) -> Result { scale .into_iter() .map(|color| Rgba::try_from(color).map(Hsla::from))