mod: deprecate deployment key

floydkim · floydkim · commit 352276b59e21 · 2025-02-24T15:09:36.000+09:00
diff --git a/CodePush.js b/CodePush.js
@@ -7,7 +7,9 @@ import { SemverVersioning } from './versioning/SemverVersioning'
 let NativeCodePush = require("react-native").NativeModules.CodePush;
 const PackageMixins = require("./package-mixins")(NativeCodePush);
 
-async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchCallback = null) {
+const DEPLOYMENT_KEY = 'deprecated_deployment_key';
+
+async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
   /*
    * Before we ask the server if an update exists, we
    * need to retrieve three pieces of information from the
@@ -18,14 +20,6 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
    * different from the CodePush update they have already installed.
    */
   const nativeConfig = await getConfiguration();
-  /*
-   * If a deployment key was explicitly provided,
-   * then let's override the one we retrieved
-   * from the native-side of the app. This allows
-   * dynamically "redirecting" end-users at different
-   * deployments (e.g. an early access deployment for insiders).
-   */
-  const config = deploymentKey ? { ...nativeConfig, ...{ deploymentKey } } : nativeConfig;
 
   // Use dynamically overridden getCurrentPackage() during tests.
   const localPackage = await module.exports.getCurrentPackage();
@@ -42,22 +36,20 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
   if (localPackage) {
     queryPackage = localPackage;
   } else {
-    queryPackage = { appVersion: config.appVersion };
-    if (Platform.OS === "ios" && config.packageHash) {
-      queryPackage.packageHash = config.packageHash;
+    queryPackage = { appVersion: nativeConfig.appVersion };
+    if (Platform.OS === "ios" && nativeConfig.packageHash) {
+      queryPackage.packageHash = nativeConfig.packageHash;
     }
   }
 
   const update = await (async () => {
     try {
-      // refer to `UpdateCheckRequest` type inside code-push SDK
       const updateRequest = {
-        deployment_key: config.deploymentKey,
         app_version: queryPackage.appVersion,
         package_hash: queryPackage.packageHash,
-        is_companion: config.ignoreAppVersion,
+        is_companion: nativeConfig.ignoreAppVersion,
         label: queryPackage.label,
-        client_unique_id: config.clientUniqueId,
+        client_unique_id: nativeConfig.clientUniqueId,
       };
 
       /**
@@ -68,7 +60,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
       if (updateChecker) {
         const { update_info } = await updateChecker(updateRequest);
 
-        return mapToRemotePackageMetadata(update_info, config.deploymentKey);
+        return mapToRemotePackageMetadata(update_info);
       } else {
         /**
          * `releaseHistory`
@@ -128,7 +120,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
           should_run_binary_version: false,
         }
 
-        return mapToRemotePackageMetadata(updateInfo, config.deploymentKey);
+        return mapToRemotePackageMetadata(updateInfo);
       }
     } catch (error) {
       log(`An error has occurred at update checker :`);
@@ -158,7 +150,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
    */
   if (!update || update.updateAppVersion ||
       localPackage && (update.packageHash === localPackage.packageHash) ||
-      (!localPackage || localPackage._isDebugOnly) && config.packageHash === update.packageHash) {
+      (!localPackage || localPackage._isDebugOnly) && nativeConfig.packageHash === update.packageHash) {
     if (update && update.updateAppVersion) {
       log("An update is available but it is not targeting the binary version of your app.");
       if (handleBinaryVersionMismatchCallback && typeof handleBinaryVersionMismatchCallback === "function") {
@@ -170,17 +162,15 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
   } else {
     const remotePackage = { ...update, ...PackageMixins.remote() };
     remotePackage.failedInstall = await NativeCodePush.isFailedUpdate(remotePackage.packageHash);
-    remotePackage.deploymentKey = deploymentKey || nativeConfig.deploymentKey;
     return remotePackage;
   }
 }
 
 /**
  * @param updateInfo {UpdateCheckResponse}
- * @param deploymentKey {string}
  * @return {RemotePackage | null}
  */
-function mapToRemotePackageMetadata(updateInfo, deploymentKey) {
+function mapToRemotePackageMetadata(updateInfo) {
   if (!updateInfo) {
     return null;
   } else if (!updateInfo.download_url) {
@@ -192,7 +182,7 @@ function mapToRemotePackageMetadata(updateInfo, deploymentKey) {
 
   // refer to `RemotePackage` type inside code-push SDK
   return {
-    deploymentKey: deploymentKey,
+    deploymentKey: DEPLOYMENT_KEY,
     description: updateInfo.description ?? '',
     label: updateInfo.label ?? '',
     appVersion: updateInfo.target_binary_range ?? '',
@@ -253,15 +243,9 @@ async function notifyApplicationReadyInternal() {
 }
 
 async function tryReportStatus(statusReport, retryOnAppResume) {
-  const config = await getConfiguration();
-
   try {
     if (statusReport.appVersion) {
       log(`Reporting binary update (${statusReport.appVersion})`);
-
-      if (!config.deploymentKey) {
-        throw new Error("Deployment key is missed");
-      }
     } else {
       const label = statusReport.package.label;
       if (statusReport.status === "DeploymentSucceeded") {
@@ -275,6 +259,7 @@ async function tryReportStatus(statusReport, retryOnAppResume) {
     NativeCodePush.recordStatusReported(statusReport);
     retryOnAppResume && retryOnAppResume.remove();
   } catch (e) {
+    log(`${e}`)
     log(`Report status failed: ${JSON.stringify(statusReport)}`);
     NativeCodePush.saveStatusReportForRetry(statusReport);
     // Try again when the app resumes
@@ -480,7 +465,7 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
     await CodePush.notifyApplicationReady();
 
     syncStatusChangeCallback(CodePush.SyncStatus.CHECKING_FOR_UPDATE);
-    const remotePackage = await checkForUpdate(syncOptions.deploymentKey, handleBinaryVersionMismatchCallback);
+    const remotePackage = await checkForUpdate(handleBinaryVersionMismatchCallback);
 
     const doDownloadAndInstall = async () => {
       syncStatusChangeCallback(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
diff --git a/android/app/src/main/java/com/microsoft/codepush/react/CodePush.java b/android/app/src/main/java/com/microsoft/codepush/react/CodePush.java
@@ -50,20 +50,20 @@ public class CodePush implements ReactPackage {
     private static ReactInstanceHolder mReactInstanceHolder;
     private static CodePush mCurrentInstance;
 
-    public CodePush(String deploymentKey, Context context) {
-        this(deploymentKey, context, false);
+    public CodePush(Context context) {
+        this(context, false);
     }
 
     public static String getServiceUrl() {
         return mServerUrl;
     }
 
-    public CodePush(String deploymentKey, Context context, boolean isDebugMode) {
+    public CodePush(Context context, boolean isDebugMode) {
         mContext = context.getApplicationContext();
 
         mUpdateManager = new CodePushUpdateManager(context.getFilesDir().getAbsolutePath());
         mTelemetryManager = new CodePushTelemetryManager(mContext);
-        mDeploymentKey = deploymentKey;
+        mDeploymentKey = "deprecated_deployment_key";
         mIsDebugMode = isDebugMode;
         mSettingsManager = new SettingsManager(mContext);
 
@@ -88,19 +88,19 @@ public CodePush(String deploymentKey, Context context, boolean isDebugMode) {
         initializeUpdateAfterRestart();
     }
 
-    public CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl) {
-        this(deploymentKey, context, isDebugMode);
+    public CodePush(Context context, boolean isDebugMode, String serverUrl) {
+        this(context, isDebugMode);
         mServerUrl = serverUrl;
     }
 
-    public CodePush(String deploymentKey, Context context, boolean isDebugMode, int publicKeyResourceDescriptor) {
-        this(deploymentKey, context, isDebugMode);
+    public CodePush(Context context, boolean isDebugMode, int publicKeyResourceDescriptor) {
+        this(context, isDebugMode);
 
         mPublicKey = getPublicKeyByResourceDescriptor(publicKeyResourceDescriptor);
     }
 
-    public CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl, Integer publicKeyResourceDescriptor) {
-        this(deploymentKey, context, isDebugMode);
+    public CodePush(Context context, boolean isDebugMode, String serverUrl, Integer publicKeyResourceDescriptor) {
+        this(context, isDebugMode);
 
         if (publicKeyResourceDescriptor != null) {
             mPublicKey = getPublicKeyByResourceDescriptor(publicKeyResourceDescriptor);
@@ -129,18 +129,18 @@ private String getPublicKeyByResourceDescriptor(int publicKeyResourceDescriptor)
 
     private String getCustomPropertyFromStringsIfExist(String propertyName) {
         String property;
-      
+
         String packageName = mContext.getPackageName();
         int resId = mContext.getResources().getIdentifier("CodePush" + propertyName, "string", packageName);
-        
+
         if (resId != 0) {
             property = mContext.getString(resId);
 
             if (!property.isEmpty()) {
                 return property;
             } else {
                 CodePushUtils.log("Specified " + propertyName + " is empty");
-            } 
+            }
         }
 
         return null;
diff --git a/android/app/src/main/java/com/microsoft/codepush/react/CodePushBuilder.java b/android/app/src/main/java/com/microsoft/codepush/react/CodePushBuilder.java
@@ -10,8 +10,8 @@ public class CodePushBuilder {
     private String mServerUrl;
     private Integer mPublicKeyResourceDescriptor;
 
-    public CodePushBuilder(String deploymentKey, Context context) {
-        this.mDeploymentKey = deploymentKey;
+    public CodePushBuilder(Context context) {
+        this.mDeploymentKey = "deprecated_deployment_key";
         this.mContext = context;
         this.mServerUrl = CodePush.getServiceUrl();
     }
@@ -32,6 +32,6 @@ public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescr
     }
 
     public CodePush build() {
-        return new CodePush(this.mDeploymentKey, this.mContext, this.mIsDebugMode, this.mServerUrl, this.mPublicKeyResourceDescriptor);
+        return new CodePush(this.mContext, this.mIsDebugMode, this.mServerUrl, this.mPublicKeyResourceDescriptor);
     }
 }
diff --git a/ios/CodePush/CodePush.m b/ios/CodePush/CodePush.m
@@ -31,7 +31,7 @@ @implementation CodePush {
     long long _latestExpectedContentLength;
     long long _latestReceivedConentLength;
     BOOL _didUpdateProgress;
-    
+
     BOOL _allowed;
     BOOL _restartInProgress;
     NSMutableArray *_restartQueue;
@@ -216,7 +216,7 @@ + (void)overrideAppVersion:(NSString *)appVersion
 
 + (void)setDeploymentKey:(NSString *)deploymentKey
 {
-    [CodePushConfig current].deploymentKey = deploymentKey;
+    [CodePushConfig current].deploymentKey = @"deprecated_deployment_key";
 }
 
 /*
@@ -376,7 +376,7 @@ - (instancetype)init
     _allowed = YES;
     _restartInProgress = NO;
     _restartQueue = [NSMutableArray arrayWithCapacity:1];
-    
+
     self = [super init];
     if (self) {
         [self initializeUpdateAfterRestart];
@@ -582,7 +582,7 @@ - (void)saveFailedUpdate:(NSDictionary *)failedPackage
     if ([[self class] isFailedHash:[failedPackage objectForKey:PackageHashKey]]) {
         return;
     }
-    
+
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
     if (failedUpdates == nil) {
@@ -913,7 +913,7 @@ - (void)restartAppInternal:(BOOL)onlyIfUpdateIsPending
                                                          selector:@selector(applicationDidBecomeActive)
                                                              name:UIApplicationDidBecomeActiveNotification
                                                            object:RCTSharedApplication()];
-                                                           
+
                 [[NSNotificationCenter defaultCenter] addObserver:self
                                                          selector:@selector(applicationWillEnterForeground)
                                                              name:UIApplicationWillEnterForegroundNotification
diff --git a/ios/CodePush/CodePushConfig.m b/ios/CodePush/CodePushConfig.m
@@ -36,7 +36,7 @@ - (instancetype)init
     NSString *deploymentKey = [infoDictionary objectForKey:@"CodePushDeploymentKey"];
     NSString *serverURL = [infoDictionary objectForKey:@"CodePushServerURL"];
     NSString *publicKey = [infoDictionary objectForKey:@"CodePushPublicKey"];
-    
+
     NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
     NSString *clientUniqueId = [userDefaults stringForKey:ClientUniqueIDConfigKey];
     if (clientUniqueId == nil) {
diff --git a/react-native.config.js b/react-native.config.js
@@ -4,7 +4,7 @@ module.exports = {
             android: {
                 packageImportPath: "import com.microsoft.codepush.react.CodePush;",
                 packageInstance:
-                    "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)",
+                    "new CodePush(getApplicationContext(), BuildConfig.DEBUG)",
                 sourceDir: './android/app'
             }
         }
diff --git a/typings/react-native-code-push.d.ts b/typings/react-native-code-push.d.ts
@@ -2,12 +2,10 @@ export type DownloadProgressCallback = (progress: DownloadProgress) => void;
 export type SyncStatusChangedCallback = (status: CodePush.SyncStatus) => void;
 export type HandleBinaryVersionMismatchCallback = (update: RemotePackage) => void;
 
-// from code-push SDK
 export interface UpdateCheckRequest {
     /** The native version, not in package.json. */
     app_version: string;
     client_unique_id?: string;
-    deployment_key: string;
     is_companion?: boolean;
     label?: string;
     package_hash?: string;

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,8 @@ public class CodePushBuilder {`
`10`	`10`	`private String mServerUrl;`
`11`	`11`	`private Integer mPublicKeyResourceDescriptor;`
`12`	`12`
`13`		`- public CodePushBuilder(String deploymentKey, Context context) {`
`14`		`- this.mDeploymentKey = deploymentKey;`
	`13`	`+ public CodePushBuilder(Context context) {`
	`14`	`+ this.mDeploymentKey = "deprecated_deployment_key";`
`15`	`15`	`this.mContext = context;`
`16`	`16`	`this.mServerUrl = CodePush.getServiceUrl();`
`17`	`17`	`}`
`@@ -32,6 +32,6 @@ public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescr`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public CodePush build() {`
`35`		`- return new CodePush(this.mDeploymentKey, this.mContext, this.mIsDebugMode, this.mServerUrl, this.mPublicKeyResourceDescriptor);`
	`35`	`+ return new CodePush(this.mContext, this.mIsDebugMode, this.mServerUrl, this.mPublicKeyResourceDescriptor);`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ module.exports = {`
`4`	`4`	`android: {`
`5`	`5`	`packageImportPath: "import com.microsoft.codepush.react.CodePush;",`
`6`	`6`	`packageInstance:`
`7`		`- "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)",`
	`7`	`+ "new CodePush(getApplicationContext(), BuildConfig.DEBUG)",`
`8`	`8`	`sourceDir: './android/app'`
`9`	`9`	`}`
`10`	`10`	`}`