@appzung/react-native-code-push 11.0.0-rc1 → 11.0.0-rc10

package/CodePush.podspec

@@ -14,14 +14,12 @@ Pod::Spec.new do |s|
   s.tvos.deployment_target = '15.5'
   s.preserve_paths = '*.js'
   s.library        = 'z'
-  s.source_files = 'ios/CodePush/*.{h,m}'
+  s.source_files = 'ios/CodePush/*.{h,m,mm}'
   s.public_header_files = ['ios/CodePush/CodePush.h']
   s.pod_target_xcconfig = { "DEFINES_MODULE" => "YES" }
 
-  # Note: Even though there are copy/pasted versions of some of these dependencies in the repo,
-  # we explicitly let CocoaPods pull in the versions below so all dependencies are resolved and
-  # linked properly at a parent workspace level.
-  s.dependency 'React-Core'
+  install_modules_dependencies(s)
+
   s.dependency 'SSZipArchive', '~> 2.5.5'
   s.dependency 'JWT', '~> 3.0.0-beta.12'
   s.dependency 'Base64', '~> 1.1'

package/README.md

@@ -21,7 +21,7 @@
 [AppZung](https://appzung.com) is a robust solution for CodePush functionality, created in response to AppCenter's retirement.
 CodePush allows you to easily add a dynamic update experience to your React Native apps.
 
-We offer feature-parity with the original CodePush and will introduce advanced capabilities in:
+We offer feature-parity with the original CodePush and introduce advanced capabilities in:
 
 - Hosting
 - Delivery
@@ -55,13 +55,13 @@ Otherwise:
 npm install --save @appzung/react-native-code-push
 ```
 
-_NOTE: For Expo apps a plugin will be made available soon. In the meantime, you may eject._
-
 Then continue with installing the native module:
 
-- [iOS Setup](docs/setup-ios.md)
-- [Android Setup](docs/setup-android.md)
-- [Windows Setup](docs/setup-windows.md)
+- [iOS setup](docs/setup-ios.md)
+- [Android setup](docs/setup-android.md)
+- [Windows setup](docs/setup-windows.md)
+
+Or if your app is managed by the Expo framework, install and configure [@appzung/expo-config-code-push](https://github.com/AppZung/expo-config-code-push).
 
 ## Migrating to AppZung CodePush
 
@@ -109,8 +109,9 @@ We try our best to maintain backwards compatibility of our plugin with previous
 | v0.60-v0.61             | 4.1+ (TLS 1.2+) | 7    | ✅       | ❌       | v6.3.1                         |
 | v0.62-v0.64             | 4.1+ (TLS 1.2+) | 7    | ✅       | ❌       | v6.4.2                         |
 | v0.65-v0.70             | 4.1+ (TLS 1.2+) | 9    | ✅       | ❌       | v7.1.1                         |
-| v0.71+                  | 4.1+ (TLS 1.2+) | 9    | ✅       | ❌       | v8.3.2                         |
-| v0.71+                  | 4.1+ (TLS 1.2+) | 15.5 | ✅       | ❌       | v9.0.2 or v10+                 |
+| v0.71-v0.79             | 4.1+ (TLS 1.2+) | 9    | ✅       | ❌       | v8.3.2                         |
+| v0.71-v0.79             | 4.1+ (TLS 1.2+) | 15.5 | ✅       | ❌       | v9.0.2                         |
+| v0.71+                  | 4.1+ (TLS 1.2+) | 15.5 | ✅       | ❌       | v10+                           |
 | v0.74+                  | 4.1+ (TLS 1.2+) | 15.5 | ✅       | ✅       | v11+                           |
 
 We work hard to respond to new RN releases, but they do occasionally break us. We will update this chart with each RN release, so that users can check to see what our "official" support is.
@@ -142,14 +143,14 @@ If you would like your app to discover updates more quickly, you can also choose
 withCodePush({ checkFrequency: CheckFrequency.ON_APP_RESUME })(MyApp);
 ```
 
-Alternatively, if you want fine-grained control over when the check happens (like a button press or timer interval), eg. in a staging environment, you can call [`CodePush.sync()`](docs/api-js.md#codepushsync) at any time with your desired `SyncOptions`, and turn off CodePush's automatic checking by specifying a manual `checkFrequency`:
+Alternatively, if you want fine-grained control over when the check happens (like a button press or timer interval), eg. in a staging environment, you can call [`CodePush.sync()`](docs/api-js/functions/sync.md) at any time with your desired `SyncOptions`, and turn off CodePush's automatic checking by specifying a manual `checkFrequency`:
 
 ```javascript
-import withCodePush, { CheckFrequency, InstallMode } from '@appzung/react-native-code-push';
+import withCodePush, { CheckFrequency, InstallMode, sync } from '@appzung/react-native-code-push';
 
 class MyApp extends Component {
   onButtonPress() {
-    CodePush.sync({
+    sync({
       updateDialog: true,
       installMode: InstallMode.IMMEDIATE,
     });
@@ -169,11 +170,11 @@ class MyApp extends Component {
 export default withCodePush({ checkFrequency: CheckFrequency.MANUAL })(MyApp);
 ```
 
-If you would like to display an update confirmation dialog (an "active install"), configure when an available update is installed (like force an immediate restart) or customize the update experience in any other way, refer to the [`codePush()`](docs/api-js.md#codepush) API reference for information on how to tweak this default behavior.
+If you would like to display an update confirmation dialog (an "active install"), configure when an available update is installed (like force an immediate restart) or customize the update experience in any other way, refer to the [`withCodePush()`](docs/api-js/functions/withCodePush.md) API reference for information on how to tweak this default behavior.
 
 ## Releasing updates
 
-Once your app is configured and distributed to your users, and you have made some JS or asset changes, it's time to release them. The recommended way to release them is using the `appzung releases deploy-react-native` command in the AppZung CLI, which will bundle your JavaScript files, asset files, and release the update to the CodePush server.
+Once your app is configured and distributed to your users, and you have made some JS or asset changes, it's time to release them. The recommended way to release them is running the `appzung releases deploy-react-native` command (or `appzung releases deploy-expo` if using Expo) in the AppZung CLI, which will bundle your JavaScript files, asset files, and release the update to the CodePush server.
 
 ### Locally
 
@@ -252,13 +253,13 @@ This is not necessarily the case for `updateDialog`, since it won't force the us
 
 ## API Reference
 
-- [JavaScript API](docs/api-js.md)
+- [JavaScript API](docs/api-js/README.md)
 - [Objective-C API Reference (iOS)](docs/api-ios.md)
 - [Java API Reference (Android)](docs/api-android.md)
 
 ## Debugging / Troubleshooting
 
-The `sync` method includes a lot of diagnostic logging out-of-the-box, so if you're encountering an issue when using it, the best thing to try first is examining the output logs of your app. This will tell you whether the app is configured correctly (like can the plugin find your release channel public ID?), if the app is able to reach the server, if an available update is being discovered, if the update is being successfully downloaded/installed, etc. We want to continue improving the logging to be as intuitive/comprehensive as possible, so please [let us know](mailto:support@appzung.com) if you find it to be confusing or missing anything.
+The `withCodePush`/`sync` methods include a lot of diagnostic logging out-of-the-box, so if you're encountering an issue when using it, the best thing to try first is examining the output logs of your app. This will tell you whether the app is configured correctly (like can the plugin find your release channel public ID?), if the app is able to reach the server, if an available update is being discovered, if the update is being successfully downloaded/installed, etc. We want to continue improving the logging to be as intuitive/comprehensive as possible, so please [let us know](mailto:support@appzung.com) if you find it to be confusing or missing anything.
 
 Start up the Chrome DevTools Console, the Xcode Console (iOS) and/or ADB logcat (Android), and look for messages which are prefixed with `[CodePush]`.
 
@@ -274,12 +275,13 @@ Note that by default, React Native logs are disabled on iOS in release builds, s
 
 Now you'll be able to see CodePush logs in either debug or release mode, on both iOS or Android. If examining the logs don't provide an indication of the issue, please refer to the following common issues for additional resolution ideas:
 
-| Issue / Symptom                                                                          | Possible Solution                                                                                                                                                                                                                                                                                                  |
-| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| Compilation Error                                                                        | Clean your build folders and double-check that your version of React Native is [compatible](#compatibility-table) with the CodePush version you are using.                                                                                                                                                         |
-| Network timeout / hang when calling `sync` or `checkForUpdate` in the iOS Simulator      | Try resetting the simulator by selecting the `Simulator -> Reset Content and Settings..` menu item, and then re-running your app.                                                                                                                                                                                  |
-| Server responds with a `404` when calling `sync` or `checkForUpdate`                     | Double-check that the release channel public ID you added to your `Info.plist` (iOS), `strings.xml` or `app/build.gradle` (Android) or that you're passing to `sync`/`checkForUpdate`, is in fact correct. You can run `appzung release-channels list` to view the correct public ID for your app release channel. |
-| Update not being discovered                                                              | Double-check that the version of your running app (like `1.0.0`) matches the version you specified when releasing the update to CodePush. Additionally, make sure that you are releasing to the same release channel that your app is configured to sync with.                                                     |
-| Update not being displayed after restart                                                 | If you're not using the withCodePush HOC or calling `sync` on app start (like within `componentDidMount` of your root component), then you need to explicitly call `notifyAppReady` on app start, otherwise, the plugin will think your update failed and roll it back.                                            |
-| I've released an update for iOS but my Android app also shows an update and it breaks it | Be sure you have different release channels for each platform in order to receive updates correctly                                                                                                                                                                                                                |
-| I've released new update but changes are not reflected                                   | Be sure that you are running app in modes other than Debug. In Debug mode, React Native app always downloads JS bundle generated by packager, so JS bundle downloaded by CodePush does not apply.                                                                                                                  |
+| Issue / Symptom                                                                                                                                                                                                             | Possible Solution                                                                                                                                                                                                                                                                                                  |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Compilation Error                                                                                                                                                                                                           | Clean your build folders and double-check that your version of React Native is [compatible](#compatibility-table) with the CodePush version you are using.                                                                                                                                                         |
+| Network timeout / hang when calling `sync` or `checkForUpdate` in the iOS Simulator                                                                                                                                         | Try resetting the simulator by selecting the `Simulator -> Reset Content and Settings..` menu item, and then re-running your app.                                                                                                                                                                                  |
+| Server responds with a `404` when calling `sync` or `checkForUpdate`                                                                                                                                                        | Double-check that the release channel public ID you added to your `Info.plist` (iOS), `strings.xml` or `app/build.gradle` (Android) or that you're passing to `sync`/`checkForUpdate`, is in fact correct. You can run `appzung release-channels list` to view the correct public ID for your app release channel. |
+| Update not being discovered                                                                                                                                                                                                 | Double-check that the version of your running app (like `1.0.0`) matches the version you specified when releasing the update to CodePush. Additionally, make sure that you are releasing to the same release channel that your app is configured to sync with.                                                     |
+| Update not being displayed after restart                                                                                                                                                                                    | If you're not using the withCodePush HOC or calling `sync` on app start (like within `componentDidMount` of your root component), then you need to explicitly call `notifyAppReady` on app start, otherwise, the plugin will think your update failed and roll it back.                                            |
+| I've released an update for iOS but my Android app also shows an update and it breaks it                                                                                                                                    | Be sure you have different release channels for each platform in order to receive updates correctly                                                                                                                                                                                                                |
+| I've released new update but changes are not reflected                                                                                                                                                                      | Be sure that you are running app in modes other than Debug. In Debug mode, React Native app always downloads JS bundle generated by packager, so JS bundle downloaded by CodePush does not apply.                                                                                                                  |
+| Android compilation fails after migrating to AppZung with error "Task :app:checkReleaseAarMetadata FAILED A problem was found with the configuration of task ':app:checkReleaseAarMetadata' (type 'CheckAarMetadataTask')". | In `android/settings.gradle` remove the lines about CodePush. Be sure to read the other [migration steps](./docs/migrating-to-v10.md) carefully to review if you missed any others.                                                                                                                                |

package/android/app/proguard-rules.pro

@@ -20,6 +20,11 @@
 -keepclassmembers class com.facebook.react.ReactInstanceManager {
     private final ** mBundleLoader;
 }
+-keepclassmembers class com.facebook.react.runtime.ReactHostImpl {
+    private final ** mReactHostDelegate;
+}
+-keep interface com.facebook.react.runtime.ReactHostDelegate { *; }
+-keep class * implements com.facebook.react.runtime.ReactHostDelegate { *; }
 
 # Can't find referenced class org.bouncycastle.**
 -dontwarn com.nimbusds.jose.**

package/android/app/src/main/java/com/appzung/codepush/react/CodePush.java

@@ -100,6 +100,9 @@ public class CodePush implements ReactPackage {
         }
 
         String serverUrlFromStrings = getCustomPropertyFromStringsIfExist("ServerUrl");
+        if (serverUrlFromStrings == null) {
+            serverUrlFromStrings = getCustomPropertyFromStringsIfExist("ServerURL");
+        }
         if (serverUrlFromStrings != null) {
             CodePushUtils.log("Executing CodePush with a custom server URL.");
             mServerUrl = serverUrlFromStrings;
@@ -200,6 +203,7 @@ public class CodePush implements ReactPackage {
 
     public static String getJSBundleFile(String assetsBundleFileName) {
         if (mCurrentInstance == null) {
+            CodePushUtils.log("A CodePush instance has not been created yet. Have you added it to your app's list of ReactPackages?");
             throw new CodePushNotInitializedException("A CodePush instance has not been created yet. Have you added it to your app's list of ReactPackages?");
         }
 

package/android/app/src/main/java/com/appzung/codepush/react/CodePushConstants.java

@@ -32,4 +32,6 @@ public class CodePushConstants {
     public static final String LATEST_ROLLBACK_TIME_KEY = "time";
     public static final String LATEST_ROLLBACK_COUNT_KEY = "count";
     public static final String CLIENT_UNIQUE_ID_KEY = "clientUniqueId";
+    public static final String TELEMETRY_ENABLED_KEY = "telemetryEnabled";
+    public static final String DATA_TRANSMISSION_ENABLED_KEY = "dataTransmissionEnabled";
 }

package/android/app/src/main/java/com/appzung/codepush/react/CodePushNativeModule.java

@@ -5,6 +5,7 @@ import android.content.SharedPreferences;
 import android.os.AsyncTask;
 import android.os.Handler;
 import android.os.Looper;
+import android.view.Choreographer;
 import android.view.View;
 
 import androidx.annotation.OptIn;
@@ -24,7 +25,6 @@ import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.common.annotations.UnstableReactNativeAPI;
 import com.facebook.react.devsupport.interfaces.DevSupportManager;
-import com.facebook.react.modules.core.ChoreographerCompat;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 import com.facebook.react.modules.core.ReactChoreographer;
 import com.facebook.react.modules.debug.interfaces.DeveloperSettings;
@@ -49,6 +49,9 @@ import java.util.UUID;
 public class CodePushNativeModule extends BaseJavaModule {
     private String mBinaryContentsHash = null;
     private String mClientUniqueId = null;
+    private boolean mTelemetryEnabled = true;
+    private boolean mDataTransmissionEnabled = true;
+    private boolean mIsExpoApp = false;
     private LifecycleEventListener mLifecycleEventListener = null;
     private int mMinimumBackgroundDuration = 0;
 
@@ -69,6 +72,8 @@ public class CodePushNativeModule extends BaseJavaModule {
         mTelemetryManager = codePushTelemetryManager;
         mUpdateManager = codePushUpdateManager;
 
+        mIsExpoApp = ExpoUtils.detectExpoEnvironment(reactContext);
+
         // Initialize module state while we have a reference to the current context.
         mBinaryContentsHash = CodePushUpdateUtils.getHashForBinaryContents(reactContext, mCodePush.isDebugMode());
 
@@ -78,6 +83,28 @@ public class CodePushNativeModule extends BaseJavaModule {
             mClientUniqueId = UUID.randomUUID().toString();
             preferences.edit().putString(CodePushConstants.CLIENT_UNIQUE_ID_KEY, mClientUniqueId).apply();
         }
+
+        if (preferences.contains(CodePushConstants.TELEMETRY_ENABLED_KEY)) {
+            mTelemetryEnabled = preferences.getBoolean(CodePushConstants.TELEMETRY_ENABLED_KEY, true);
+        } else {
+            int defaultTelemetryEnabledResId = reactContext.getResources().getIdentifier("CodePushDefaultTelemetryEnabled", "bool", reactContext.getPackageName());
+            if (defaultTelemetryEnabledResId != 0) {
+                mTelemetryEnabled = reactContext.getResources().getBoolean(defaultTelemetryEnabledResId);
+            } else {
+                mTelemetryEnabled = true;
+            }
+        }
+
+        if (preferences.contains(CodePushConstants.DATA_TRANSMISSION_ENABLED_KEY)) {
+            mDataTransmissionEnabled = preferences.getBoolean(CodePushConstants.DATA_TRANSMISSION_ENABLED_KEY, true);
+        } else {
+            int defaultDataTransmissionEnabledResId = reactContext.getResources().getIdentifier("CodePushDefaultDataTransmissionEnabled", "bool", reactContext.getPackageName());
+            if (defaultDataTransmissionEnabledResId != 0) {
+                mDataTransmissionEnabled = reactContext.getResources().getBoolean(defaultDataTransmissionEnabledResId);
+            } else {
+                mDataTransmissionEnabled = true;
+            }
+        }
     }
 
     @Override
@@ -186,8 +213,11 @@ public class CodePushNativeModule extends BaseJavaModule {
 
                 String latestJSBundleFile = mCodePush.getJSBundleFileInternal(mCodePush.getAssetsBundleFileName());
 
-                // #2) Update the locally stored JS bundle file path
-                setJSBundle(getReactHostDelegate((ReactHostImpl) reactHost), latestJSBundleFile);
+                // if expo and new arch this is unnecessary, see https://github.com/expo/expo/blob/8113ce44edaef0311e2daff3ab1a63b9731d2d6c/packages/expo-updates/android/src/main/java/expo/modules/updates/procedures/RelaunchProcedure.kt#L148
+                if (!mIsExpoApp) {
+                    // #2) Update the locally stored JS bundle file path
+                    setJSBundle(getReactHostDelegate((ReactHostImpl) reactHost), latestJSBundleFile);
+                }
 
                 // #3) Get the context creation method
                 try {
@@ -438,7 +468,7 @@ public class CodePushNativeModule extends BaseJavaModule {
                             getReactApplicationContext().runOnUiQueueThread(new Runnable() {
                                 @Override
                                 public void run() {
-                                    ReactChoreographer.getInstance().postFrameCallback(ReactChoreographer.CallbackType.TIMERS_EVENTS, new ChoreographerCompat.FrameCallback() {
+                                    ReactChoreographer.getInstance().postFrameCallback(ReactChoreographer.CallbackType.TIMERS_EVENTS, new Choreographer.FrameCallback() {
                                         @Override
                                         public void doFrame(long frameTimeNanos) {
                                             if (!latestDownloadProgress.isCompleted()) {
@@ -485,6 +515,8 @@ public class CodePushNativeModule extends BaseJavaModule {
             configMap.putString("clientUniqueId", mClientUniqueId);
             configMap.putString("releaseChannelPublicId", mCodePush.getReleaseChannelPublicId());
             configMap.putString("serverUrl", mCodePush.getServerUrl());
+            configMap.putBoolean("telemetryEnabled", mTelemetryEnabled);
+            configMap.putBoolean("dataTransmissionEnabled", mDataTransmissionEnabled);
 
             // The binary hash may be null in debug builds
             if (mBinaryContentsHash != null) {
@@ -820,6 +852,56 @@ public class CodePushNativeModule extends BaseJavaModule {
         mCodePush.clearUpdates();
     }
 
+    @ReactMethod
+    public void resetClientUniqueId(Promise promise) {
+        try {
+            String newClientUniqueId = UUID.randomUUID().toString();
+            SharedPreferences preferences = mCodePush.getContext().getSharedPreferences(CodePushConstants.CODE_PUSH_PREFERENCES, 0);
+            preferences.edit().putString(CodePushConstants.CLIENT_UNIQUE_ID_KEY, newClientUniqueId).apply();
+            mClientUniqueId = newClientUniqueId;
+            promise.resolve(mClientUniqueId);
+        } catch (Exception e) {
+            CodePushUtils.log(e);
+            promise.reject(e);
+        }
+    }
+
+    @ReactMethod
+    public void setTelemetryEnabled(boolean enabled, Promise promise) {
+        try {
+            SharedPreferences preferences = mCodePush.getContext().getSharedPreferences(CodePushConstants.CODE_PUSH_PREFERENCES, 0);
+            preferences.edit().putBoolean(CodePushConstants.TELEMETRY_ENABLED_KEY, enabled).apply();
+            mTelemetryEnabled = enabled;
+            promise.resolve(null);
+        } catch (Exception e) {
+            CodePushUtils.log(e);
+            promise.reject(e);
+        }
+    }
+
+    @ReactMethod
+    public void getTelemetryEnabled(Promise promise) {
+        promise.resolve(mTelemetryEnabled);
+    }
+
+    @ReactMethod
+    public void setDataTransmissionEnabled(boolean enabled, Promise promise) {
+        try {
+            SharedPreferences preferences = mCodePush.getContext().getSharedPreferences(CodePushConstants.CODE_PUSH_PREFERENCES, 0);
+            preferences.edit().putBoolean(CodePushConstants.DATA_TRANSMISSION_ENABLED_KEY, enabled).apply();
+            mDataTransmissionEnabled = enabled;
+            promise.resolve(null);
+        } catch (Exception e) {
+            CodePushUtils.log(e);
+            promise.reject(e);
+        }
+    }
+
+    @ReactMethod
+    public void getDataTransmissionEnabled(Promise promise) {
+        promise.resolve(mDataTransmissionEnabled);
+    }
+
     @ReactMethod
     public void addListener(String eventName) {
         // Set up any upstream listeners or background tasks as necessary

package/android/app/src/main/java/com/appzung/codepush/react/ExpoUtils.java

@@ -0,0 +1,22 @@
+package com.appzung.codepush.react;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+
+public class ExpoUtils {
+
+    /**
+     * Detects if the app is running in an Expo environment by checking for
+     * the presence of Expo's ReactNativeHostWrapper class.
+     *
+     * @param reactContext The React application context
+     * @return true if Expo environment is detected, false otherwise
+     */
+    public static boolean detectExpoEnvironment(ReactApplicationContext reactContext) {
+        try {
+            Class.forName("expo.modules.ReactNativeHostWrapper");
+            return true;
+        } catch (ClassNotFoundException e) {
+            return false;
+        }
+    }
+}

package/ios/CodePush/CodePush.h

@@ -63,12 +63,6 @@
 + (BOOL)isFailedHash:(NSString*)packageHash;
 
 
-/*
- * This method is used to get information about the latest rollback.
- * This information will be used to decide whether the application
- * should ignore the update or not.
- */
-+ (NSDictionary*)getRollbackInfo;
 /*
  * This method is used to save information about the latest rollback.
  * This information will be used to decide whether the application
@@ -101,8 +95,11 @@
 @property (readonly) NSString *buildVersion;
 @property (readonly) NSDictionary *configuration;
 @property (copy) NSString *releaseChannelPublicId;
+@property (readonly) NSString *clientUniqueId;
 @property (copy) NSString *serverURL;
 @property (copy) NSString *publicKey;
+@property (nonatomic) BOOL telemetryEnabled;
+@property (nonatomic) BOOL dataTransmissionEnabled;
 
 + (instancetype)current;
 
@@ -219,8 +216,16 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 @end
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 void CPLog(NSString *formatString, ...);
 
+#ifdef __cplusplus
+}
+#endif
+
 typedef NS_ENUM(NSInteger, CodePushInstallMode) {
     CodePushInstallModeImmediate,
     CodePushInstallModeOnNextRestart,