From e3190468a5a37a8cd325f559c63d5b2524f6de90 Mon Sep 17 00:00:00 2001
From: Nick Gerleman <ngerlem@meta.com>
Date: Thu, 27 Apr 2023 09:44:18 -0700
Subject: [PATCH] Deprecate YGConfigSetUseLegacyStretchBehaviour (#37117)

Summary:
X-link: https://github.com/facebook/react-native/pull/37117

Pull Request resolved: https://github.com/facebook/yoga/pull/1265

This deprecates `YGConfigSetUseLegacyStretchBehaviour` and `YGConfigGetUseLegacyStretchBehaviour`and points users to errata APIs instead. Using the C API will fire deprecation warnings, which should create errors in builds with `-Werror`, though they can be ignored if truly needed (like we do with the language bindings which need to expose their own deprecated interface).

Reviewed By: rshest

Differential Revision: D45337198

fbshipit-source-id: ac6d251e43475444e68fec91e14dd6aea46e9e0e
---
 java/jni/YGJNIVanilla.cpp       |  3 +++
 javascript/src_native/Config.cc |  6 ++++++
 tests/YGDefaultValuesTest.cpp   |  2 +-
 yoga/YGMacros.h                 |  8 ++++++++
 yoga/Yoga.h                     | 15 +++++++++++++--
 5 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/java/jni/YGJNIVanilla.cpp b/java/jni/YGJNIVanilla.cpp
index 8e6079483a..e32f14b17e 100644
--- a/java/jni/YGJNIVanilla.cpp
+++ b/java/jni/YGJNIVanilla.cpp
@@ -91,7 +91,10 @@ static void jni_YGConfigSetUseLegacyStretchBehaviourJNI(
     jlong nativePointer,
     jboolean useLegacyStretchBehaviour) {
   const YGConfigRef config = _jlong2YGConfigRef(nativePointer);
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated"
   YGConfigSetUseLegacyStretchBehaviour(config, useLegacyStretchBehaviour);
+#pragma clang diagnostic pop
 }
 
 static void jni_YGConfigSetErrataJNI(
diff --git a/javascript/src_native/Config.cc b/javascript/src_native/Config.cc
index ebcfe44a1d..edd5294bbb 100644
--- a/javascript/src_native/Config.cc
+++ b/javascript/src_native/Config.cc
@@ -33,7 +33,10 @@ void Config::setPointScaleFactor(float pixelsInPoint) {
 }
 
 void Config::setUseLegacyStretchBehaviour(bool useLegacyStretchBehaviour) {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated"
   YGConfigSetUseLegacyStretchBehaviour(m_config, useLegacyStretchBehaviour);
+#pragma clang diagnostic pop
 }
 
 void Config::setErrata(int errata) {
@@ -50,7 +53,10 @@ bool Config::isExperimentalFeatureEnabled(int feature) const {
 }
 
 bool Config::useLegacyStretchBehaviour() const {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated"
   return YGConfigGetUseLegacyStretchBehaviour(m_config);
+#pragma clang diagnostic pop
 }
 
 int Config::getErrata() const {
diff --git a/tests/YGDefaultValuesTest.cpp b/tests/YGDefaultValuesTest.cpp
index d606c6379e..7124d3968d 100644
--- a/tests/YGDefaultValuesTest.cpp
+++ b/tests/YGDefaultValuesTest.cpp
@@ -118,7 +118,7 @@ TEST(YogaTest, assert_webdefault_values_reset) {
 
 TEST(YogaTest, assert_legacy_stretch_behaviour) {
   YGConfig* config = YGConfigNew();
-  YGConfigSetUseLegacyStretchBehaviour(config, true);
+  YGConfigSetErrata(config, YGErrataStretchFlexBasis);
   const YGNodeRef root = YGNodeNewWithConfig(config);
   YGNodeStyleSetWidth(root, 500);
   YGNodeStyleSetHeight(root, 500);
diff --git a/yoga/YGMacros.h b/yoga/YGMacros.h
index 0ce8c2eed4..b4e4e95fae 100644
--- a/yoga/YGMacros.h
+++ b/yoga/YGMacros.h
@@ -19,6 +19,14 @@
 #define YG_EXTERN_C_END
 #endif
 
+#if defined(__cplusplus)
+#define YG_DEPRECATED(message) [[deprecated(message)]]
+#elif defined(_MSC_VER)
+#define YG_DEPRECATED(message) __declspec(depreacted(message))
+#else
+#define YG_DEPRECATED(message) __attribute__((deprecated(message)))
+#endif
+
 #ifdef _WINDLL
 #define WIN_EXPORT __declspec(dllexport)
 #else
diff --git a/yoga/Yoga.h b/yoga/Yoga.h
index b5f09cca21..94a8abfed9 100644
--- a/yoga/Yoga.h
+++ b/yoga/Yoga.h
@@ -330,8 +330,19 @@ WIN_EXPORT void YGConfigSetPointScaleFactor(
 // resulted in implicit behaviour similar to align-self: stretch; Because this
 // was such a long-standing bug we must allow legacy users to switch back to
 // this behaviour.
-WIN_EXPORT bool YGConfigGetUseLegacyStretchBehaviour(YGConfigRef config);
-WIN_EXPORT void YGConfigSetUseLegacyStretchBehaviour(
+WIN_EXPORT YG_DEPRECATED(
+    "Please use "
+    "\"YGConfigGetErrata()\"") bool YGConfigGetUseLegacyStretchBehaviour(YGConfigRef
+                                                                             config);
+WIN_EXPORT
+YG_DEPRECATED(
+    "\"YGConfigSetUseLegacyStretchBehaviour\" will be removed in the next "
+    "release. Usage should be replaced with \"YGConfigSetErrata(YGErrataAll)\" "
+    "to opt out of all future breaking conformance fixes, or "
+    "\"YGConfigSetErrata(YGErrataStretchFlexBasis)\" to opt out of the "
+    "specific conformance fix previously disabled by "
+    "\"UseLegacyStretchBehaviour\".")
+void YGConfigSetUseLegacyStretchBehaviour(
     YGConfigRef config,
     bool useLegacyStretchBehaviour);