From 355ca28b5d2dbd0a0a4161db3ce6b893ffced024 Mon Sep 17 00:00:00 2001 From: Nick Gerleman Date: Fri, 17 May 2024 19:12:13 -0700 Subject: [PATCH] Reland: Sanitize measure function results Summary: D57285584 was reverted because we have service code with a faulty measure function, and adding logging to Yoga when invalid measurements were received was enough to spike error rate to elevated levels and block release. This is a reland of the below change, with a couple modifications: 1. We log warnings instead of errors, which from what I heard, shouldn't block release, but should still make signal 2. We only zero the dimension which was NaN, to preserve exact behavior ## Original We've started seeing assertion failures in Yoga where a `NaN` value makes its way to an `availableHeight` constraint when measuring Litho tree. Because it's only happening on Litho, I have some suspicion this might be originating from a Litho-specific measure function. This adds sanitization in Yoga to measure function results, where we will log an error, and set size to zero, if either dimension ends up being negative of `NaN`. This doesn't really help track down where the error was happening, but Yoga doesn't have great context to show this to begin with. If we see this is issue, next steps would be Litho internal intrumentation to find culprit. Changelog: [Internal] Reviewed By: sbuggay Differential Revision: D57473295 fbshipit-source-id: 979f1b9a51f5550a8d3ca534276ec191a3cb7b9e --- .../ReactCommon/yoga/yoga/node/Node.cpp | 28 ++++++++++++++++--- .../ReactCommon/yoga/yoga/node/Node.h | 4 +-- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/packages/react-native/ReactCommon/yoga/yoga/node/Node.cpp b/packages/react-native/ReactCommon/yoga/yoga/node/Node.cpp index adb63663bed..31ad09f8c98 100644 --- a/packages/react-native/ReactCommon/yoga/yoga/node/Node.cpp +++ b/packages/react-native/ReactCommon/yoga/yoga/node/Node.cpp @@ -10,6 +10,7 @@ #include #include +#include #include #include @@ -49,12 +50,31 @@ Node::Node(Node&& node) noexcept } YGSize Node::measure( - float width, + float availableWidth, MeasureMode widthMode, - float height, + float availableHeight, MeasureMode heightMode) { - return measureFunc_( - this, width, unscopedEnum(widthMode), height, unscopedEnum(heightMode)); + const auto size = measureFunc_( + this, + availableWidth, + unscopedEnum(widthMode), + availableHeight, + unscopedEnum(heightMode)); + + if (yoga::isUndefined(size.height) || size.height < 0 || + yoga::isUndefined(size.width) || size.width < 0) { + yoga::log( + this, + LogLevel::Warn, + "Measure function returned an invalid dimension to Yoga: [width=%f, height=%f]", + size.width, + size.height); + return { + .width = maxOrDefined(0.0f, size.width), + .height = maxOrDefined(0.0f, size.height)}; + } + + return size; } float Node::baseline(float width, float height) const { diff --git a/packages/react-native/ReactCommon/yoga/yoga/node/Node.h b/packages/react-native/ReactCommon/yoga/yoga/node/Node.h index 8f5ee591cc5..cd029b40d46 100644 --- a/packages/react-native/ReactCommon/yoga/yoga/node/Node.h +++ b/packages/react-native/ReactCommon/yoga/yoga/node/Node.h @@ -66,9 +66,9 @@ class YG_EXPORT Node : public ::YGNode { } YGSize measure( - float width, + float availableWidth, MeasureMode widthMode, - float height, + float availableHeight, MeasureMode heightMode); bool hasBaselineFunc() const noexcept {