Skip to content

Commit

Permalink
Add toMatchRenderedOutput() API
Browse files Browse the repository at this point in the history 
Summary: Changelog: [Internal]

Differential Revision: D65617491
  • Loading branch information
@andrewdacenko @facebook-github-bot
andrewdacenko authored and facebook-github-bot committed Nov 26, 2024
1 parent df7b6ae commit a1ad3ce
Show file tree
Hide file tree
Showing 5 changed files with 142 additions and 39 deletions.
1 change: 0 additions & 1 deletion jest/integration/config/metro.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ const config = {
? [
path.join(JS_DIR, 'RKJSModules', 'vendor', 'react'),
path.join(JS_DIR, 'tools', 'metro'),
path.join(JS_DIR, 'node_modules'),
path.join(JS_DIR, 'public', 'node_modules'),
]
: [],
Expand Down
21 changes: 21 additions & 0 deletions jest/integration/runtime/setup.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@
* @oncall react_native
*/

import type {RenderOutputConfig} from 'react-native/src/private/__tests__/ReactNativeTester.fb';

import deepEqual from 'deep-equal';
import nullthrows from 'nullthrows';
import {maybeRoot} from 'react-native/src/private/__tests__/ReactNativeTester.fb';
import {toMatchRenderedOutput} from 'react-native/src/private/__tests__/RenderOutputMatcher.fb';

export type TestCaseResult = {
ancestorTitles: Array<string>,
Expand Down Expand Up @@ -275,6 +279,23 @@ class Expect {
}
}

toMatchRenderedOutput(
expected: React.Node,
config: RenderOutputConfig = {},
): void {
const root = maybeRoot(this.#received);
if (root == null) {
throw new Error(
`Expected ${String(this.#received)}${this.#maybeNotLabel()} to be a ReactTestRenderer`,
);
}

const result = toMatchRenderedOutput(root, expected, config);
if (!result.pass) {
throw new Error(`Mismatch in rendered output:\n${result.reason}`);
}
}

#isExpectedResult(pass: boolean): boolean {
return this.#isNot ? !pass : pass;
}
Expand Down
40 changes: 31 additions & 9 deletions packages/react-native/ReactCommon/react/renderer/attributedstring/ParagraphAttributes.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,38 @@ bool ParagraphAttributes::operator!=(const ParagraphAttributes& rhs) const {

#if RN_DEBUG_STRING_CONVERTIBLE
SharedDebugStringConvertibleList ParagraphAttributes::getDebugProps() const {
auto paragraphAttributes = ParagraphAttributes{};
return {
debugStringConvertibleItem("maximumNumberOfLines", maximumNumberOfLines),
debugStringConvertibleItem("ellipsizeMode", ellipsizeMode),
debugStringConvertibleItem("textBreakStrategy", textBreakStrategy),
debugStringConvertibleItem("adjustsFontSizeToFit", adjustsFontSizeToFit),
debugStringConvertibleItem("minimumFontSize", minimumFontSize),
debugStringConvertibleItem("maximumFontSize", maximumFontSize),
debugStringConvertibleItem("includeFontPadding", includeFontPadding),
debugStringConvertibleItem(
"android_hyphenationFrequency", android_hyphenationFrequency)};
debugStringConvertibleItem(
"maximumNumberOfLines",
maximumNumberOfLines,
paragraphAttributes.maximumNumberOfLines),
debugStringConvertibleItem(
"ellipsizeMode", ellipsizeMode, paragraphAttributes.ellipsizeMode),
debugStringConvertibleItem(
"textBreakStrategy",
textBreakStrategy,
paragraphAttributes.textBreakStrategy),
debugStringConvertibleItem(
"adjustsFontSizeToFit",
adjustsFontSizeToFit,
paragraphAttributes.adjustsFontSizeToFit),
debugStringConvertibleItem(
"minimumFontSize",
minimumFontSize,
paragraphAttributes.minimumFontSize),
debugStringConvertibleItem(
"maximumFontSize",
maximumFontSize,
paragraphAttributes.maximumFontSize),
debugStringConvertibleItem(
"includeFontPadding",
includeFontPadding,
paragraphAttributes.includeFontPadding),
debugStringConvertibleItem(
"android_hyphenationFrequency",
android_hyphenationFrequency,
paragraphAttributes.android_hyphenationFrequency)};
}
#endif

Expand Down
106 changes: 77 additions & 29 deletions packages/react-native/ReactCommon/react/renderer/attributedstring/TextAttributes.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,49 +197,97 @@ TextAttributes TextAttributes::defaultTextAttributes() {

#if RN_DEBUG_STRING_CONVERTIBLE
SharedDebugStringConvertibleList TextAttributes::getDebugProps() const {
auto textAttributes = TextAttributes::defaultTextAttributes();
return {
// Color
debugStringConvertibleItem("backgroundColor", backgroundColor),
debugStringConvertibleItem("foregroundColor", foregroundColor),
debugStringConvertibleItem("opacity", opacity),
debugStringConvertibleItem(
"backgroundColor", backgroundColor, textAttributes.backgroundColor),
debugStringConvertibleItem(
"foregroundColor", foregroundColor, textAttributes.foregroundColor),
debugStringConvertibleItem("opacity", opacity, textAttributes.opacity),

// Font
debugStringConvertibleItem("fontFamily", fontFamily),
debugStringConvertibleItem("fontSize", fontSize),
debugStringConvertibleItem("fontSizeMultiplier", fontSizeMultiplier),
debugStringConvertibleItem("fontWeight", fontWeight),
debugStringConvertibleItem("fontStyle", fontStyle),
debugStringConvertibleItem("fontVariant", fontVariant),
debugStringConvertibleItem("allowFontScaling", allowFontScaling),
debugStringConvertibleItem("dynamicTypeRamp", dynamicTypeRamp),
debugStringConvertibleItem("letterSpacing", letterSpacing),
debugStringConvertibleItem(
"fontFamily", fontFamily, textAttributes.fontFamily),
debugStringConvertibleItem("fontSize", fontSize, textAttributes.fontSize),
debugStringConvertibleItem(
"fontSizeMultiplier",
fontSizeMultiplier,
textAttributes.fontSizeMultiplier),
debugStringConvertibleItem(
"fontWeight", fontWeight, textAttributes.fontWeight),
debugStringConvertibleItem(
"fontStyle", fontStyle, textAttributes.fontStyle),
debugStringConvertibleItem(
"fontVariant", fontVariant, textAttributes.fontVariant),
debugStringConvertibleItem(
"allowFontScaling",
allowFontScaling,
textAttributes.allowFontScaling),
debugStringConvertibleItem(
"dynamicTypeRamp", dynamicTypeRamp, textAttributes.dynamicTypeRamp),
debugStringConvertibleItem(
"letterSpacing", letterSpacing, textAttributes.letterSpacing),

// Paragraph Styles
debugStringConvertibleItem("lineHeight", lineHeight),
debugStringConvertibleItem("alignment", alignment),
debugStringConvertibleItem("baseWritingDirection", baseWritingDirection),
debugStringConvertibleItem("lineBreakStrategyIOS", lineBreakStrategy),
debugStringConvertibleItem("lineBreakModeIOS", lineBreakMode),
debugStringConvertibleItem(
"lineHeight", lineHeight, textAttributes.lineHeight),
debugStringConvertibleItem(
"alignment", alignment, textAttributes.alignment),
debugStringConvertibleItem(
"baseWritingDirection",
baseWritingDirection,
textAttributes.baseWritingDirection),
debugStringConvertibleItem(
"lineBreakStrategyIOS",
lineBreakStrategy,
textAttributes.lineBreakStrategy),
debugStringConvertibleItem(
"lineBreakModeIOS", lineBreakMode, textAttributes.lineBreakMode),

// Decoration
debugStringConvertibleItem("textDecorationColor", textDecorationColor),
debugStringConvertibleItem(
"textDecorationLineType", textDecorationLineType),
debugStringConvertibleItem("textDecorationStyle", textDecorationStyle),
"textDecorationColor",
textDecorationColor,
textAttributes.textDecorationColor),
debugStringConvertibleItem(
"textDecorationLineType",
textDecorationLineType,
textAttributes.textDecorationLineType),
debugStringConvertibleItem(
"textDecorationStyle",
textDecorationStyle,
textAttributes.textDecorationStyle),

// Shadow
debugStringConvertibleItem("textShadowOffset", textShadowOffset),
debugStringConvertibleItem("textShadowRadius", textShadowRadius),
debugStringConvertibleItem("textShadowColor", textShadowColor),
debugStringConvertibleItem(
"textShadowOffset",
textShadowOffset,
textAttributes.textShadowOffset),
debugStringConvertibleItem(
"textShadowRadius",
textShadowRadius,
textAttributes.textShadowRadius),
debugStringConvertibleItem(
"textShadowColor", textShadowColor, textAttributes.textShadowColor),

// Special
debugStringConvertibleItem("isHighlighted", isHighlighted),
debugStringConvertibleItem("isPressable", isPressable),
debugStringConvertibleItem("layoutDirection", layoutDirection),
debugStringConvertibleItem("accessibilityRole", accessibilityRole),
debugStringConvertibleItem("role", role),
debugStringConvertibleItem(
"isHighlighted", isHighlighted, textAttributes.isHighlighted),
debugStringConvertibleItem(
"isPressable", isPressable, textAttributes.isPressable),
debugStringConvertibleItem(
"layoutDirection", layoutDirection, textAttributes.layoutDirection),
debugStringConvertibleItem(
"accessibilityRole",
accessibilityRole,
textAttributes.accessibilityRole),
debugStringConvertibleItem("role", role, textAttributes.role),

debugStringConvertibleItem("textAlignVertical", textAlignVertical),
debugStringConvertibleItem(
"textAlignVertical",
textAlignVertical,
textAttributes.textAlignVertical),
};
}
#endif
Expand Down
13 changes: 13 additions & 0 deletions packages/react-native/ReactCommon/react/renderer/debug/debugStringConvertibleUtils.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,24 @@

#include <react/renderer/debug/DebugStringConvertible.h>
#include <react/renderer/debug/DebugStringConvertibleItem.h>
#include <react/utils/FloatComparison.h>

namespace facebook::react {

#if RN_DEBUG_STRING_CONVERTIBLE

inline SharedDebugStringConvertible debugStringConvertibleItem(
std::string name,
float value,
float defaultValue = {}) {
if (floatEquality(value, defaultValue)) {
return nullptr;
}

return std::make_shared<DebugStringConvertibleItem>(
name, facebook::react::toString(value));
}

template <typename T>
inline SharedDebugStringConvertible
debugStringConvertibleItem(std::string name, T value, T defaultValue = {}) {
Expand Down

0 comments on commit a1ad3ce

Please sign in to comment.