Skip to content

feat: stable API versioning checks #9105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjzel merged 2 commits into from
Mar 18, 2026
Merged

feat: stable API versioning checks #9105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01cbda2
feat: stable API versioning checks
tjzel Mar 16, 2026
314bb2d
chore: formatting
tjzel Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions packages/react-native-reanimated/Common/cpp/reanimated/AnimatedSensor/AnimatedSensorModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
#pragma once

#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>

#include <worklets/Compat/StableApi.h>

#include <jsi/jsi.h>

#include <memory>
Expand Down
3 changes: 1 addition & 2 deletions packages/react-native-reanimated/Common/cpp/reanimated/CSS/common/values/CSSValueVariant.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
#include <reanimated/CSS/svg/values/SVGPath.h>
#include <reanimated/CSS/svg/values/SVGStops.h>
#include <reanimated/CSS/svg/values/SVGStrokeDashArray.h>

#include <worklets/Compat/StableApi.h>
#include <reanimated/Compat/WorkletsApi.h>

#include <string>
#include <utility>
Expand Down
3 changes: 1 addition & 2 deletions .../react-native-reanimated/Common/cpp/reanimated/CSS/interpolation/PropertyInterpolator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#include <reanimated/CSS/interpolation/PropertyInterpolator.h>

#include <worklets/Compat/StableApi.h>
#include <reanimated/Compat/WorkletsApi.h>

#include <memory>
#include <utility>
Expand Down
13 changes: 13 additions & 0 deletions packages/react-native-reanimated/Common/cpp/reanimated/Compat/WorkletsApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#pragma once

#include <worklets/Compat/StableApi.h>
#include <string>

#define EXPECTED_WORKLETS_STABLE_API_VERSION "0.8.0"

static_assert(
std::string(WORKLETS_STABLE_API_VERSION) == EXPECTED_WORKLETS_STABLE_API_VERSION,
"Incompatible worklets stable API version. Expected " EXPECTED_WORKLETS_STABLE_API_VERSION
", but got " WORKLETS_STABLE_API_VERSION ".");
Comment thread
tjzel marked this conversation as resolved.

#undef EXPECTED_WORKLETS_STABLE_API_VERSION
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/Common/cpp/reanimated/Events/UIEventHandler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <jsi/jsi.h>
#include <worklets/Compat/StableApi.h>
#include <reanimated/Compat/WorkletsApi.h>

#include <memory>
#include <string>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/Common/cpp/reanimated/Events/UIEventHandlerRegistry.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <jsi/jsi.h>
#include <worklets/Compat/StableApi.h>
#include <reanimated/Compat/WorkletsApi.h>

#include <map>
#include <memory>
Expand Down
3 changes: 1 addition & 2 deletions .../react-native-reanimated/Common/cpp/reanimated/LayoutAnimations/LayoutAnimationsManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

#include <react/renderer/graphics/Transform.h>
#include <react/renderer/mounting/ShadowView.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/LayoutAnimations/LayoutAnimationType.h>

#include <worklets/Compat/StableApi.h>

#include <jsi/jsi.h>
#include <stdio.h>
#include <functional>
Expand Down
2 changes: 1 addition & 1 deletion ...ct-native-reanimated/Common/cpp/reanimated/LayoutAnimations/LayoutAnimationsProxyCommon.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
#include <react/renderer/componentregistry/ComponentDescriptorFactory.h>
#include <react/renderer/mounting/MountingOverrideDelegate.h>
#include <react/renderer/uimanager/UIManager.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsManager.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>
#include <worklets/Compat/StableApi.h>

#include <memory>
#include <optional>
Expand Down
3 changes: 1 addition & 2 deletions ...ve-reanimated/Common/cpp/reanimated/LayoutAnimations/LayoutAnimationsProxy_Experimental.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
#pragma once

#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsManager.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsProxyCommon.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsUtils.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>

#include <worklets/Compat/StableApi.h>

#include <react/renderer/componentregistry/ComponentDescriptorFactory.h>
#include <react/renderer/graphics/Transform.h>
#include <react/renderer/mounting/MountingOverrideDelegate.h>
Expand Down
2 changes: 1 addition & 1 deletion ...t-native-reanimated/Common/cpp/reanimated/LayoutAnimations/LayoutAnimationsProxy_Legacy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
#include <react/renderer/scheduler/Scheduler.h>
#include <react/renderer/uimanager/UIManagerAnimationDelegate.h>
#include <react/renderer/uimanager/UIManagerBinding.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsManager.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsProxyCommon.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsUtils.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>
#include <worklets/Compat/StableApi.h>

#include <memory>
#include <string>
Expand Down
2 changes: 1 addition & 1 deletion ...ges/react-native-reanimated/Common/cpp/reanimated/NativeModules/ReanimatedModuleProxy.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#include <react/renderer/scheduler/Scheduler.h>
#include <react/renderer/uimanager/UIManagerBinding.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/Events/UIEventHandler.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsProxy_Experimental.h>
#include <reanimated/LayoutAnimations/LayoutAnimationsProxy_Legacy.h>
Expand All @@ -8,7 +9,6 @@
#include <reanimated/RuntimeDecorators/UIRuntimeDecorator.h>
#include <reanimated/Tools/FeatureFlags.h>
#include <reanimated/Tools/ReanimatedSystraceSection.h>
#include <worklets/Compat/StableApi.h>

#ifdef __ANDROID__
#include <fbjni/fbjni.h>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/Common/cpp/reanimated/NativeModules/ReanimatedModuleProxy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include <reanimated/CSS/registries/CSSKeyframesRegistry.h>
#include <reanimated/CSS/registries/CSSTransitionsRegistry.h>
#include <reanimated/CSS/registries/StaticPropsRegistry.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/Events/UIEventHandlerRegistry.h>
#include <reanimated/Fabric/ReanimatedCommitHook.h>
#include <reanimated/Fabric/ReanimatedCommitShadowNode.h>
Expand All @@ -24,7 +25,6 @@
#include <reanimated/NativeModules/ReanimatedModuleProxySpec.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>
#include <reanimated/Tools/SingleInstanceChecker.h>
#include <worklets/Compat/StableApi.h>

#include <memory>
#include <set>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/android/src/main/cpp/reanimated/android/NativeProxy.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#include <react/fabric/Binding.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/RuntimeDecorators/RNRuntimeDecorator.h>
#include <reanimated/Tools/PlatformDepMethodsHolder.h>
#include <reanimated/Tools/ReanimatedVersion.h>
Expand All @@ -7,7 +8,6 @@
#include <reanimated/android/KeyboardWorkletWrapper.h>
#include <reanimated/android/NativeProxy.h>
#include <reanimated/android/SensorSetter.h>
#include <worklets/Compat/StableApi.h>

#include <memory>
#include <string>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/android/src/main/cpp/reanimated/android/NativeProxy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
#include <react/fabric/JFabricUIManager.h>
#include <react/jni/WritableNativeMap.h>
#include <react/renderer/scheduler/Scheduler.h>
#include <reanimated/Compat/WorkletsApi.h>
#include <reanimated/NativeModules/ReanimatedModuleProxy.h>
#include <worklets/Compat/StableApi.h>

#include <memory>
#include <string>
Expand Down
3 changes: 1 addition & 2 deletions packages/react-native-reanimated/apple/reanimated/apple/ReanimatedModule.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#import <React/RCTScheduler.h>
#import <React/RCTSurfacePresenter.h>

#import <reanimated/Compat/WorkletsApi.h>
#import <reanimated/RuntimeDecorators/RNRuntimeDecorator.h>
#import <reanimated/Tools/SingleInstanceChecker.h>
#import <reanimated/apple/REAAssertJavaScriptQueue.h>
Expand All @@ -11,8 +12,6 @@
#import <reanimated/apple/ReanimatedModule.h>
#import <reanimated/apple/native/NativeProxy.h>

#import <worklets/Compat/StableApi.h>

using namespace facebook::react;
using namespace reanimated;
using namespace worklets;
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/apple/reanimated/apple/native/NativeProxy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#if __cplusplus

#import <reanimated/Compat/WorkletsApi.h>
#import <reanimated/NativeModules/ReanimatedModuleProxy.h>
#import <reanimated/apple/REANodesManager.h>
#import <worklets/Compat/StableApi.h>

namespace reanimated {

Expand Down
7 changes: 7 additions & 0 deletions packages/react-native-worklets/Common/cpp/worklets/Compat/StableApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
#pragma once

/**
* Version of `react-native-worklets` which introduced current stable API.
* It can be used by libraries to verify they use a compatible version
* of `react-native-worklets` installed when integrating in C++.
Comment thread
tjzel marked this conversation as resolved.
*/
#define WORKLETS_STABLE_API_VERSION "0.8.0"

#include <cstdint>
#include <functional>
#include <memory>
Expand Down
Loading