react-native-update 8.1.0 → 9.0.0-beta.1

package/lib/{main.js → main.ts}

@@ -2,7 +2,6 @@ import {
   tryBackupEndpoints,
   getCheckUrl,
   setCustomEndpoints,
-  getReportUrl,
 } from './endpoint';
 import {
   NativeEventEmitter,
@@ -10,82 +9,114 @@ import {
   Platform,
   PermissionsAndroid,
 } from 'react-native';
+import {
+  EventType,
+  ProgressData,
+  UpdateAvailableResult,
+  UpdateEventsListener,
+} from './type';
 export { setCustomEndpoints };
 const {
   version: v,
 } = require('react-native/Libraries/Core/ReactNativeVersion');
 const RNVersion = `${v.major}.${v.minor}.${v.patch}`;
+const isTurboModuleEnabled = global.__turboModuleProxy != null;
 
-let Pushy = NativeModules.Pushy;
+export const PushyModule = isTurboModuleEnabled
+  ? require('./NativeUpdate').default
+  : NativeModules.Pushy;
 
-if (!Pushy) {
+if (!PushyModule) {
   throw new Error('react-native-update模块无法加载，请对照安装文档检查配置。');
 }
+const PushyConstants = isTurboModuleEnabled
+  ? PushyModule.getConstants()
+  : PushyModule;
 
-export const downloadRootDir = Pushy.downloadRootDir;
-export const packageVersion = Pushy.packageVersion;
-export const currentVersion = Pushy.currentVersion;
-export const isFirstTime = Pushy.isFirstTime;
-const rolledBackVersion = Pushy.rolledBackVersion;
+export const downloadRootDir = PushyConstants.downloadRootDir;
+export const packageVersion = PushyConstants.packageVersion;
+export const currentVersion = PushyConstants.currentVersion;
+export const isFirstTime = PushyConstants.isFirstTime;
+const rolledBackVersion = PushyConstants.rolledBackVersion;
 export const isRolledBack = typeof rolledBackVersion === 'string';
 
-export const buildTime = Pushy.buildTime;
-let blockUpdate = Pushy.blockUpdate;
-let uuid = Pushy.uuid;
+export const buildTime = PushyConstants.buildTime;
+let blockUpdate = PushyConstants.blockUpdate;
+let uuid = PushyConstants.uuid;
 
-if (Platform.OS === 'android' && !Pushy.isUsingBundleUrl) {
+if (Platform.OS === 'android' && !PushyConstants.isUsingBundleUrl) {
   throw new Error(
     'react-native-update模块无法加载，请对照文档检查Bundle URL的配置',
   );
 }
 
-function setLocalHashInfo(hash, info) {
-  Pushy.setLocalHashInfo(hash, JSON.stringify(info));
+function setLocalHashInfo(hash: string, info: Record<string, any>) {
+  PushyModule.setLocalHashInfo(hash, JSON.stringify(info));
 }
 
-async function getLocalHashInfo(hash) {
-  return JSON.parse(await Pushy.getLocalHashInfo(hash));
+async function getLocalHashInfo(hash: string) {
+  return JSON.parse(await PushyModule.getLocalHashInfo(hash));
 }
 
-export async function getCurrentVersionInfo() {
+export async function getCurrentVersionInfo(): Promise<{
+  name?: string;
+  description?: string;
+  metaInfo?: string;
+}> {
   return currentVersion ? (await getLocalHashInfo(currentVersion)) || {} : {};
 }
 
-const eventEmitter = new NativeEventEmitter(Pushy);
+const eventEmitter = new NativeEventEmitter(PushyModule);
 
 if (!uuid) {
   uuid = require('nanoid/non-secure').nanoid();
-  Pushy.setUuid(uuid);
+  PushyModule.setUuid(uuid);
 }
 
-function logger(text) {
-  console.log(`Pushy: ${text}`);
+function logger(...args: string[]) {
+  console.log('Pushy: ', ...args);
 }
 
-function report(hash, type) {
-  logger(type);
-  fetch(getReportUrl(), {
-    method: 'POST',
-    headers: {
-      Accept: 'application/json',
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({
-      hash,
-      type,
+const noop = () => {};
+let reporter: UpdateEventsListener = noop;
+
+export function onEvents(customReporter: UpdateEventsListener) {
+  reporter = customReporter;
+  if (isRolledBack) {
+    report({
+      type: 'rollback',
+      data: {
+        rolledBackVersion,
+      },
+    });
+  }
+}
+
+function report({
+  type,
+  message = '',
+  data = {},
+}: {
+  type: EventType;
+  message?: string;
+  data?: Record<string, string | number>;
+}) {
+  logger(type + ' ' + message);
+  reporter({
+    type,
+    data: {
+      currentVersion,
       cInfo,
       packageVersion,
       buildTime,
-    }),
-  }).catch((_e) => {});
+      message,
+      ...data,
+    },
+  });
 }
 
 logger('uuid: ' + uuid);
 
-if (isRolledBack) {
-  report(rolledBackVersion, 'rollback');
-}
-
 export const cInfo = {
   pushy: require('../package.json').version,
   rn: RNVersion,
@@ -94,13 +125,14 @@ export const cInfo = {
 };
 
 function assertRelease() {
+  // @ts-expect-error
   if (__DEV__) {
     throw new Error('react-native-update 只能在 RELEASE 版本中运行.');
   }
 }
 
 let checkingThrottling = false;
-export async function checkUpdate(APPKEY, isRetry) {
+export async function checkUpdate(APPKEY: string, isRetry?: boolean) {
   assertRelease();
   if (checkingThrottling) {
     logger('repeated checking, ignored');
@@ -111,16 +143,14 @@ export async function checkUpdate(APPKEY, isRetry) {
     checkingThrottling = false;
   }, 3000);
   if (blockUpdate && blockUpdate.until > Date.now() / 1000) {
-    throw new Error(
-      `热更新已暂停，原因：${blockUpdate.reason}。请在"${new Date(
+    return report({
+      type: 'errorChecking',
+      message: `热更新已暂停，原因：${blockUpdate.reason}。请在"${new Date(
         blockUpdate.until * 1000,
       ).toLocaleString()}"之后重试。`,
-    );
-  }
-  if (typeof APPKEY !== 'string') {
-    throw new Error('未检查到合法的APPKEY，请查看update.json文件是否正确生成');
+    });
   }
-  logger('checking update');
+  report({ type: 'checking' });
   let resp;
   try {
     resp = await fetch(getCheckUrl(APPKEY), {
@@ -138,7 +168,10 @@ export async function checkUpdate(APPKEY, isRetry) {
     });
   } catch (e) {
     if (isRetry) {
-      throw new Error('无法连接更新服务器，请检查网络连接后重试');
+      return report({
+        type: 'errorChecking',
+        message: '无法连接更新服务器，请检查网络连接后重试',
+      });
     }
     await tryBackupEndpoints();
     return checkUpdate(APPKEY, true);
@@ -147,13 +180,15 @@ export async function checkUpdate(APPKEY, isRetry) {
   checkOperation(result.op);
 
   if (resp.status !== 200) {
-    throw new Error(result.message);
+    return report({ type: 'errorChecking', message: result.message });
   }
 
   return result;
 }
 
-function checkOperation(op) {
+function checkOperation(
+  op: { type: string; reason: string; duration: number }[],
+) {
   if (!Array.isArray(op)) {
     return;
   }
@@ -163,14 +198,19 @@ function checkOperation(op) {
         reason: action.reason,
         until: Math.round((Date.now() + action.duration) / 1000),
       };
-      Pushy.setBlockUpdate(blockUpdate);
+      PushyModule.setBlockUpdate(blockUpdate);
     }
   });
 }
 
 let downloadingThrottling = false;
-let downloadedHash;
-export async function downloadUpdate(options, eventListeners) {
+let downloadedHash: string;
+export async function downloadUpdate(
+  options: UpdateAvailableResult,
+  eventListeners?: {
+    onDownloadProgress?: (data: ProgressData) => void;
+  },
+) {
   assertRelease();
   if (!options.update) {
     return;
@@ -206,10 +246,11 @@ export async function downloadUpdate(options, eventListeners) {
     }
   }
   let succeeded = false;
+  report({ type: 'downloading' });
   if (options.diffUrl) {
     logger('downloading diff');
     try {
-      await Pushy.downloadPatchFromPpk({
+      await PushyModule.downloadPatchFromPpk({
         updateUrl: options.diffUrl,
         hash: options.hash,
         originHash: currentVersion,
@@ -222,7 +263,7 @@ export async function downloadUpdate(options, eventListeners) {
   if (!succeeded && options.pdiffUrl) {
     logger('downloading pdiff');
     try {
-      await Pushy.downloadPatchFromPackage({
+      await PushyModule.downloadPatchFromPackage({
         updateUrl: options.pdiffUrl,
         hash: options.hash,
       });
@@ -234,7 +275,7 @@ export async function downloadUpdate(options, eventListeners) {
   if (!succeeded && options.updateUrl) {
     logger('downloading full patch');
     try {
-      await Pushy.downloadFullUpdate({
+      await PushyModule.downloadFullUpdate({
         updateUrl: options.updateUrl,
         hash: options.hash,
       });
@@ -245,8 +286,7 @@ export async function downloadUpdate(options, eventListeners) {
   }
   progressHandler && progressHandler.remove();
   if (!succeeded) {
-    report(options.hash, 'error');
-    throw new Error('all update attempts failed');
+    return report({ type: 'errorUpdate', data: { newVersion: options.hash } });
   }
   setLocalHashInfo(options.hash, {
     name: options.name,
@@ -257,7 +297,7 @@ export async function downloadUpdate(options, eventListeners) {
   return options.hash;
 }
 
-function assertHash(hash) {
+function assertHash(hash: string) {
   if (!downloadedHash) {
     logger(`no downloaded hash`);
     return;
@@ -269,19 +309,19 @@ function assertHash(hash) {
   return true;
 }
 
-export function switchVersion(hash) {
+export function switchVersion(hash: string) {
   assertRelease();
   if (assertHash(hash)) {
     logger('switchVersion: ' + hash);
-    Pushy.reloadUpdate({ hash });
+    PushyModule.reloadUpdate({ hash });
   }
 }
 
-export function switchVersionLater(hash) {
+export function switchVersionLater(hash: string) {
   assertRelease();
   if (assertHash(hash)) {
     logger('switchVersionLater: ' + hash);
-    Pushy.setNeedUpdate({ hash });
+    PushyModule.setNeedUpdate({ hash });
   }
 }
 
@@ -293,22 +333,31 @@ export function markSuccess() {
     return;
   }
   marked = true;
-  Pushy.markSuccess();
-  report(currentVersion, 'success');
+  PushyModule.markSuccess();
+  report({ type: 'markSuccess' });
 }
 
-export async function downloadAndInstallApk({ url, onDownloadProgress }) {
-  logger('downloadAndInstallApk');
-  if (Platform.OS === 'android' && Platform.Version <= 23) {
+export async function downloadAndInstallApk({
+  url,
+  onDownloadProgress,
+}: {
+  url: string;
+  onDownloadProgress?: (data: ProgressData) => void;
+}) {
+  if (Platform.OS !== 'android') {
+    return;
+  }
+  report({ type: 'downloadingApk' });
+  if (Platform.Version <= 23) {
     try {
       const granted = await PermissionsAndroid.request(
         PermissionsAndroid.PERMISSIONS.WRITE_EXTERNAL_STORAGE,
       );
       if (granted !== PermissionsAndroid.RESULTS.GRANTED) {
-        return;
+        return report({ type: 'rejectStoragePermission' });
       }
     } catch (err) {
-      console.warn(err);
+      return report({ type: 'errorStoragePermission' });
     }
   }
   let hash = Date.now().toString();
@@ -316,17 +365,19 @@ export async function downloadAndInstallApk({ url, onDownloadProgress }) {
   if (onDownloadProgress) {
     progressHandler = eventEmitter.addListener(
       'RCTPushyDownloadProgress',
-      (progressData) => {
+      (progressData: ProgressData) => {
         if (progressData.hash === hash) {
           onDownloadProgress(progressData);
         }
       },
     );
   }
-  await Pushy.downloadAndInstallApk({
+  await PushyModule.downloadAndInstallApk({
     url,
     target: 'update.apk',
     hash,
+  }).catch(() => {
+    report({ type: 'errowDownloadAndInstallApk' });
   });
   progressHandler && progressHandler.remove();
 }

package/lib/{simpleUpdate.js → simpleUpdate.tsx}

@@ -1,4 +1,4 @@
-import React, { Component } from 'react';
+import React, { PureComponent } from 'react';
 import { Platform, Alert, Linking, AppState } from 'react-native';
 
 import {
@@ -10,16 +10,25 @@ import {
   switchVersionLater,
   markSuccess,
   downloadAndInstallApk,
+  onEvents,
 } from './main';
+import { UpdateEventsListener } from './type';
 
-export function simpleUpdate(WrappedComponent, options = {}) {
-  const { appKey } = options;
+export function simpleUpdate(
+  WrappedComponent: JSX.Element,
+  options: { appKey?: string; onEvents?: UpdateEventsListener } = {},
+) {
+  const { appKey, onEvents: eventListeners } = options;
   if (!appKey) {
     throw new Error('appKey is required for simpleUpdate()');
   }
+  if (typeof eventListeners === 'function') {
+    onEvents(eventListeners);
+  }
+  // @ts-expect-error
   return __DEV__
     ? WrappedComponent
-    : class AppUpdate extends Component {
+    : class AppUpdate extends PureComponent {
         componentDidMount() {
           if (isRolledBack) {
             Alert.alert('抱歉', '刚刚更新遭遇错误，已为您恢复到更新前版本');

package/lib/type.ts

@@ -0,0 +1,70 @@
+export interface ExpiredResult {
+  upToDate?: false;
+  expired: true;
+  downloadUrl: string;
+}
+
+export interface UpTodateResult {
+  expired?: false;
+  upToDate: true;
+  paused?: 'app' | 'package';
+}
+
+export interface UpdateAvailableResult {
+  expired?: false;
+  upToDate?: false;
+  update: true;
+  name: string; // version name
+  hash: string;
+  description: string;
+  metaInfo: string;
+  pdiffUrl: string;
+  diffUrl?: string;
+  updateUrl?: string;
+}
+
+export type CheckResult =
+  | ExpiredResult
+  | UpTodateResult
+  | UpdateAvailableResult;
+
+export interface ProgressData {
+  hash: string;
+  received: number;
+  total: number;
+}
+
+export type EventType =
+  | 'rollback'
+  | 'errorChecking'
+  | 'checking'
+  | 'downloading'
+  | 'errorUpdate'
+  | 'markSuccess'
+  | 'downloadingApk'
+  | 'rejectStoragePermission'
+  | 'errorStoragePermission'
+  | 'errowDownloadAndInstallApk';
+
+export interface EventData {
+  currentVersion: string;
+  cInfo: {
+    pushy: string;
+    rn: string;
+    os: string;
+    uuid: string;
+  };
+  packageVersion: string;
+  buildTime: number;
+  message?: string;
+  rolledBackVersion?: string;
+  newVersion?: string;
+  [key: string]: any;
+}
+export type UpdateEventsListener = ({
+  type,
+  data,
+}: {
+  type: EventType;
+  data: EventData;
+}) => void;

package/package.json

@@ -1,13 +1,27 @@
 {
   "name": "react-native-update",
-  "version": "8.1.0",
+  "version": "9.0.0-beta.1",
   "description": "react-native hot update",
-  "main": "lib/index.js",
+  "main": "lib/index.ts",
   "scripts": {
     "prepublish": "yarn submodule",
     "submodule": "git submodule update --init --recursive",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build-lib": "yarn submodule && $ANDROID_HOME/ndk/20.1.5948944/ndk-build NDK_PROJECT_PATH=android APP_BUILD_SCRIPT=android/jni/Android.mk NDK_APPLICATION_MK=android/jni/Application.mk NDK_LIBS_OUT=android/lib"
+    "build-lib": "yarn submodule && $ANDROID_HOME/ndk/20.1.5948944/ndk-build NDK_PROJECT_PATH=android APP_BUILD_SCRIPT=android/jni/Android.mk NDK_APPLICATION_MK=android/jni/Application.mk NDK_LIBS_OUT=android/lib",
+    "build:ios-debug": "cd Example/testHotUpdate && yarn && detox build --configuration ios.sim.debug",
+    "build:ios-release": "cd Example/testHotUpdate && yarn && detox build --configuration ios.sim.release",
+    "test:ios-debug": "cd Example/testHotUpdate && detox test --configuration ios.sim.debug",
+    "test:ios-release": "cd Example/testHotUpdate && yarn detox test --configuration ios.sim.release",
+    "build:android-debug": "cd Example/testHotUpdate && yarn && detox build --configuration android.emu.debug",
+    "build:android-release": "cd Example/testHotUpdate && yarn && detox build --configuration android.emu.release",
+    "test:android-release": "cd Example/testHotUpdate && yarn detox test --configuration android.emu.release --headless --record-logs all",
+    "test:android-debug": "cd Example/testHotUpdate && detox test --configuration android.emu.debug --headless --record-logs all",
+    "e2e:ios": "npm run build:ios-release && npm run test:ios-release",
+    "e2e:android": "npm run build:android-release && npm run test:android-release",
+    "tests:emulator:prepare": "cd .github/workflows/scripts/functions && yarn && yarn build",
+    "tests:emulator:start-ci": "yarn tests:emulator:prepare && cd ./.github/workflows/scripts && ./start-firebase-emulator.sh",
+    "tests:packager:jet-ci": "cd Example/testHotUpdate && cross-env TMPDIR=$HOME/.metro REACT_DEBUGGER=\"echo nope\" node_modules/.bin/react-native start --no-interactive",
+    "tests:ios:pod:install": "cd Example/testHotUpdate && yarn && yarn pod-install"
   },
   "repository": {
     "type": "git",
@@ -30,5 +44,25 @@
   "homepage": "https://github.com/reactnativecn/react-native-pushy#readme",
   "dependencies": {
     "nanoid": "^3.3.3"
+  },
+  "codegenConfig": {
+    "libraries": [
+      {
+        "name": "RCTPushySpec",
+        "type": "modules",
+        "jsSrcsDir": "lib"
+      }
+    ]
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^29.2.1",
+    "detox": "^20.5.0",
+    "firebase-tools": "^11.24.1",
+    "fs-extra": "^9.1.0",
+    "jest": "^29.2.1",
+    "pod-install": "^0.1.37",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.1.3"
   }
 }

package/react-native-update.podspec

@@ -1,7 +1,8 @@
 require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
-
+folly_version = '2021.06.28.00-v2'
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
 Pod::Spec.new do |s|
   s.name         = package['name']
   s.version      = package['version']
@@ -13,7 +14,9 @@ Pod::Spec.new do |s|
 
   s.cocoapods_version = '>= 1.6.0'
   s.platform = :ios, "8.0"
+  s.platforms = { :ios => "11.0" }
   s.source = { :git => 'https://github.com/reactnativecn/react-native-pushy.git', :tag => '#{s.version}' }
+  s.source_files    = "ios/**/*.{h,m,mm,swift}"
   s.libraries = 'bz2', 'z'
   s.vendored_libraries = 'RCTPushy/libRCTPushy.a'
   s.pod_target_xcconfig = { 'USER_HEADER_SEARCH_PATHS' => '"$(SRCROOT)/../node_modules/react-native-update/ios"' }
@@ -21,10 +24,11 @@ Pod::Spec.new do |s|
   s.script_phase = { :name => 'Generate build time', :script => 'set -x;date +%s > ${PODS_ROOT}/../../node_modules/react-native-update/ios/pushy_build_time.txt', :execution_position => :before_compile }
 
   s.dependency 'React'
+  s.dependency "React-Core"
   s.dependency 'SSZipArchive'
 
   s.subspec 'RCTPushy' do |ss|
-    ss.source_files = 'ios/RCTPushy/*.{h,m}'
+    ss.source_files = 'ios/RCTPushy/*.{h,m,mm,swift}'
     ss.public_header_files = ['ios/RCTPushy/RCTPushy.h']
   end
   
@@ -37,4 +41,18 @@ Pod::Spec.new do |s|
                        'android/jni/lzma/C/Lzma2Dec.{h,c}']
     ss.private_header_files = 'ios/RCTPushy/HDiffPatch/**/*.h'
   end
+  # This guard prevent to install the dependencies when we run `pod install` in the old architecture.
+if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+  s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+  s.pod_target_xcconfig    = {
+      "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+      "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+  }
+
+  s.dependency "React-Codegen"
+  s.dependency "RCT-Folly", folly_version
+  s.dependency "RCTRequired"
+  s.dependency "RCTTypeSafety"
+  s.dependency "ReactCommon/turbomodule/core"
+end
 end

package/lib/index.d.ts

@@ -1,94 +0,0 @@
-export const downloadRootDir: string;
-export const packageVersion: string;
-export const currentVersion: string;
-export const isFirstTime: boolean;
-export const isRolledBack: boolean;
-
-export interface ExpiredResult {
-  upToDate?: false;
-  expired: true;
-  downloadUrl: string;
-}
-
-export interface UpTodateResult {
-  expired?: false;
-  upToDate: true;
-  paused?: 'app' | 'package';
-}
-
-export interface UpdateAvailableResult {
-  expired?: false;
-  upToDate?: false;
-  update: true;
-  name: string; // version name
-  hash: string;
-  description: string;
-  metaInfo: string;
-  pdiffUrl: string;
-  diffUrl?: string;
-}
-
-export type CheckResult =
-  | ExpiredResult
-  | UpTodateResult
-  | UpdateAvailableResult;
-
-export function checkUpdate(appkey: string): Promise<CheckResult>;
-
-export function downloadUpdate(
-  info: UpdateAvailableResult,
-  eventListeners?: {
-    onDownloadProgress?: (data: ProgressData) => void;
-  },
-): Promise<undefined | string>;
-
-export function switchVersion(hash: string): void;
-
-export function switchVersionLater(hash: string): void;
-
-export function markSuccess(): void;
-
-export function downloadAndInstallApk({
-  url,
-  onDownloadProgress,
-}: {
-  url: string;
-  onDownloadProgress?: (data: ProgressData) => void;
-}): Promise<void>;
-
-/**
- * @param {string} main - The main api endpoint
- * @param {string[]} [backups] - The back up endpoints.
- * @param {string} [backupQueryUrl] - An url that return a json file containing an array of endpoint.
- *                                    like: ["https://backup.api/1", "https://backup.api/2"]
- */
-export function setCustomEndpoints({
-  main,
-  backups,
-  backupQueryUrl,
-}: {
-  main: string;
-  backups?: string[];
-  backupQueryUrl?: string;
-}): void;
-
-export function getCurrentVersionInfo(): Promise<{
-  name?: string;
-  description?: string;
-  metaInfo?: string;
-}>;
-
-interface ProgressData {
-  hash: string;
-  received: number;
-  total: number;
-}
-
-interface SimpleUpdateOptions {
-  appKey: string;
-}
-
-export function simpleUpdate(
-  wrappedComponent: any,
-  options: SimpleUpdateOptions,
-): any;