Skip to content

Commit

Permalink
deprecate ReactModuleWithSpec (#36673)
Browse files Browse the repository at this point in the history 
Summary:
Pull Request resolved: #36673

Changelog: [Android][Deprecated]

in this change, we deprecate ReactModuleWithSpec because it can be replaced with the TurboModule interface which better describes our generated modules.

Reviewed By: cortinico

Differential Revision: D44450959

fbshipit-source-id: adab192593843926f35bdbeb346ef374dd80e615
  • Loading branch information
@philIip @facebook-github-bot
philIip authored and facebook-github-bot committed Mar 29, 2023
1 parent 0328a8d commit a4fe9b2
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 26 deletions.
3 changes: 1 addition & 2 deletions packages/react-native-codegen/src/generators/modules/GenerateModuleJavaSpec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ package ${packageName};
${imports}
public abstract class ${className} extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class ${className} extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = "${jsName}";
public ${className}(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -463,7 +463,6 @@ module.exports = {
'com.facebook.react.bridge.ReactApplicationContext',
'com.facebook.react.bridge.ReactContextBaseJavaModule',
'com.facebook.react.bridge.ReactMethod',
'com.facebook.react.bridge.ReactModuleWithSpec',
'com.facebook.react.turbomodule.core.interfaces.TurboModule',
'com.facebook.proguard.annotations.DoNotStrip',
'javax.annotation.Nonnull',
Expand Down
27 changes: 9 additions & 18 deletions ...odegen/src/generators/modules/__tests__/__snapshots__/GenerateModuleJavaSpec-test.js.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule\\";
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -63,7 +62,6 @@ import com.facebook.react.bridge.Callback;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.bridge.WritableArray;
Expand All @@ -72,7 +70,7 @@ import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule\\";
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -138,11 +136,10 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule\\";
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -180,12 +177,11 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class AliasTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class AliasTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"AliasTurboModule\\";
public AliasTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -226,13 +222,12 @@ import com.facebook.react.bridge.Promise;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeCameraRollManagerSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeCameraRollManagerSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"CameraRollManager\\";
public NativeCameraRollManagerSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -275,13 +270,12 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeExceptionsManagerSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeExceptionsManagerSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"ExceptionsManager\\";
public NativeExceptionsManagerSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -339,7 +333,6 @@ import com.facebook.react.bridge.Promise;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.bridge.WritableArray;
Expand All @@ -353,7 +346,7 @@ import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule\\";
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -469,11 +462,10 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule\\";
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
Expand Down Expand Up @@ -508,11 +500,10 @@ import com.facebook.proguard.annotations.DoNotStrip;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.turbomodule.core.interfaces.TurboModule;
import javax.annotation.Nonnull;
public abstract class NativeSampleTurboModule2Spec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
public abstract class NativeSampleTurboModule2Spec extends ReactContextBaseJavaModule implements TurboModule {
public static final String NAME = \\"SampleTurboModule2\\";
public NativeSampleTurboModule2Spec(ReactApplicationContext reactContext) {
Expand Down
6 changes: 2 additions & 4 deletions ...eact-native/ReactAndroid/src/main/java/com/facebook/react/bridge/ReactModuleWithSpec.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@

import com.facebook.proguard.annotations.DoNotStrip;

/**
* An interface to be implemented by react modules that extends from the generated spec class. This
* is experimental.
*/
/** @deprecated Use {@link TurboModule} to identify generated specs */
@DoNotStrip
@Deprecated
public interface ReactModuleWithSpec {}
3 changes: 1 addition & 2 deletions .../ReactCommon/react/nativemodule/samples/platform/android/NativeSampleTurboModuleSpec.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.ReactModuleWithSpec;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.bridge.ReadableMap;
import com.facebook.react.bridge.WritableArray;
Expand All @@ -28,7 +27,7 @@
import javax.annotation.Nullable;

public abstract class NativeSampleTurboModuleSpec extends ReactContextBaseJavaModule
implements ReactModuleWithSpec, TurboModule {
implements TurboModule {
public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
super(reactContext);
}
Expand Down

0 comments on commit a4fe9b2

Please sign in to comment.