Rename deploymentKey to releaseChannelPublicId for clarity

Author: Minishlink

CodePush.js

@@ -8,25 +8,25 @@ import hoistStatics from 'hoist-non-react-statics';
 let NativeCodePush = require("react-native").NativeModules.CodePush;
 const PackageMixins = require("./package-mixins")(NativeCodePush);
 
-async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchCallback = null) {
+async function checkForUpdate(releaseChannelPublicId = null, handleBinaryVersionMismatchCallback = null) {
   /*
    * Before we ask the server if an update exists, we
    * need to retrieve three pieces of information from the
-   * native side: deployment key, app version (e.g. 1.0.1)
+   * native side: release channel, app version (e.g. 1.0.1)
    * and the hash of the currently running update (if there is one).
    * This allows the client to only receive updates which are targetted
-   * for their specific deployment and version and which are actually
+   * for their specific release channel and version and which are actually
    * different from the CodePush update they have already installed.
    */
   const nativeConfig = await getConfiguration();
   /*
-   * If a deployment key was explicitly provided,
+   * If a release channel 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).
+   * release channels (e.g. an early access release channel for insiders).
    */
-  const config = deploymentKey ? { ...nativeConfig, ...{ deploymentKey } } : nativeConfig;
+  const config = releaseChannelPublicId ? { ...nativeConfig, ...{ releaseChannelPublicId } } : nativeConfig;
   const sdk = getPromisifiedSdk(requestFetchAdapter, config);
 
   // Use dynamically overridden getCurrentPackage() during tests.
@@ -84,7 +84,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
   } else {
     const remotePackage = { ...update, ...PackageMixins.remote(sdk.reportStatusDownload) };
     remotePackage.failedInstall = await NativeCodePush.isFailedUpdate(remotePackage.packageHash);
-    remotePackage.deploymentKey = deploymentKey || nativeConfig.deploymentKey;
+    remotePackage.releaseChannelPublicId = releaseChannelPublicId || nativeConfig.releaseChannelPublicId;
     return remotePackage;
   }
 }
@@ -118,6 +118,9 @@ async function getUpdateMetadata(updateState) {
 }
 
 function getPromisifiedSdk(requestFetchAdapter, config) {
+  // TODO MIGRATION Temporary retro-compat while we still use code-push module
+  config.deploymentKey = config.releaseChannelPublicId;
+
   // Use dynamically overridden AcquisitionSdk during tests.
   const sdk = new module.exports.AcquisitionSdk(requestFetchAdapter, config);
   sdk.queryUpdateWithCurrentPackage = (queryPackage) => {
@@ -132,9 +135,9 @@ function getPromisifiedSdk(requestFetchAdapter, config) {
     });
   };
 
-  sdk.reportStatusDeploy = (deployedPackage, status, previousLabelOrAppVersion, previousDeploymentKey) => {
+  sdk.reportStatusDeploy = (deployedPackage, status, previousLabelOrAppVersion, previousReleaseChannelPublicId) => {
     return new Promise((resolve, reject) => {
-      module.exports.AcquisitionSdk.prototype.reportStatusDeploy.call(sdk, deployedPackage, status, previousLabelOrAppVersion, previousDeploymentKey, (err) => {
+      module.exports.AcquisitionSdk.prototype.reportStatusDeploy.call(sdk, deployedPackage, status, previousLabelOrAppVersion, previousReleaseChannelPublicId, (err) => {
         if (err) {
           reject(err);
         } else {
@@ -183,17 +186,17 @@ async function notifyApplicationReadyInternal() {
 async function tryReportStatus(statusReport, retryOnAppResume) {
   const config = await getConfiguration();
   const previousLabelOrAppVersion = statusReport.previousLabelOrAppVersion;
-  const previousDeploymentKey = statusReport.previousDeploymentKey || config.deploymentKey;
+  const previousReleaseChannelPublicId = statusReport.previousReleaseChannelPublicId || config.releaseChannelPublicId;
   try {
     if (statusReport.appVersion) {
       log(`Reporting binary update (${statusReport.appVersion})`);
 
-      if (!config.deploymentKey) {
-        throw new Error("Deployment key is missed");
+      if (!config.releaseChannelPublicId) {
+        throw new Error("Release channel is missing");
       }
 
       const sdk = getPromisifiedSdk(requestFetchAdapter, config);
-      await sdk.reportStatusDeploy(/* deployedPackage */ null, /* status */ null, previousLabelOrAppVersion, previousDeploymentKey);
+      await sdk.reportStatusDeploy(/* deployedPackage */ null, /* status */ null, previousLabelOrAppVersion, previousReleaseChannelPublicId);
     } else {
       const label = statusReport.package.label;
       if (statusReport.status === "DeploymentSucceeded") {
@@ -203,9 +206,9 @@ async function tryReportStatus(statusReport, retryOnAppResume) {
         await NativeCodePush.setLatestRollbackInfo(statusReport.package.packageHash);
       }
 
-      config.deploymentKey = statusReport.package.deploymentKey;
+      config.releaseChannelPublicId = statusReport.package.releaseChannelPublicId;
       const sdk = getPromisifiedSdk(requestFetchAdapter, config);
-      await sdk.reportStatusDeploy(statusReport.package, statusReport.status, previousLabelOrAppVersion, previousDeploymentKey);
+      await sdk.reportStatusDeploy(statusReport.package, statusReport.status, previousLabelOrAppVersion, previousReleaseChannelPublicId);
     }
 
     NativeCodePush.recordStatusReported(statusReport);
@@ -363,7 +366,7 @@ const sync = (() => {
 async function syncInternal(options = {}, syncStatusChangeCallback, downloadProgressCallback, handleBinaryVersionMismatchCallback) {
   let resolvedInstallMode;
   const syncOptions = {
-    deploymentKey: null,
+    releaseChannelPublicId: null,
     ignoreFailedUpdates: true,
     rollbackRetryOptions: null,
     installMode: CodePush.InstallMode.ON_NEXT_RESTART,
@@ -416,7 +419,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(syncOptions.releaseChannelPublicId, handleBinaryVersionMismatchCallback);
 
     const doDownloadAndInstall = async () => {
       syncStatusChangeCallback(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
@@ -479,8 +482,8 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
             }
           });
         }
-        
-        // Since the install button should be placed to the 
+
+        // Since the install button should be placed to the
         // right of any other button, add it last
         dialogButtons.push({
           text: installButtonText,

Examples/CodePushDemoApp/android/app/src/main/res/values/strings.xml

@@ -1,4 +1,4 @@
 <resources>
-	<string moduleConfig="true" name="CodePushDeploymentKey">deployment-key-here</string>
+	<string moduleConfig="true" name="CodePushReleaseChannelPublicId">release-channel-public-id-here</string>
     <string name="app_name">CodePushDemoApp</string>
 </resources>

Examples/CodePushDemoApp/ios/CodePushDemoApp/Info.plist

@@ -51,7 +51,7 @@
 	</array>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<false/>
-	<key>CodePushDeploymentKey</key>
-	<string>deployment-key-here</string>
+	<key>CodePushReleaseChannelPublicId</key>
+	<string>release-channel-public-id-here</string>
 </dict>
 </plist>

Examples/CodePushDemoAppCpp/windows/CodePushDemoAppCpp/App.cpp

@@ -56,7 +56,7 @@ App::App() noexcept
     m_host.InstanceSettings().PackageProviders().Append(make<ReactPackageProvider>()); // Includes all modules in this project
 
     InitializeComponent();
-    
+
     Suspending({ this, &App::OnSuspending });
 
 #if defined _DEBUG && !defined DISABLE_XAML_GENERATED_BREAK_ON_UNHANDLED_EXCEPTION
@@ -81,7 +81,7 @@ void App::OnLaunched(activation::LaunchActivatedEventArgs const& e)
     winrt::Microsoft::CodePush::ReactNative::CodePushConfig::SetHost(Host());
     auto configMap{ winrt::single_threaded_map<hstring, hstring>() };
     configMap.Insert(L"appVersion", L"1.0.0");
-    configMap.Insert(L"deploymentKey", L"<app deployment key>");
+    configMap.Insert(L"releaseChannelPublicId", L"<app release channel public id>");
     winrt::Microsoft::CodePush::ReactNative::CodePushConfig::Init(configMap);
 
     Frame rootFrame{ nullptr };

Examples/create-app.js

@@ -61,8 +61,8 @@ console.log(`App name: ${appName}`);
 console.log(`React Native version: ${reactNativeVersion}`);
 console.log(`React Native Module for CodePush version: ${reactNativeCodePushVersion} \n`);
 
-let androidStagingDeploymentKey = null;
-let iosStagingDeploymentKey = null;
+let androidStagingReleaseChannelPublicId = null;
+let iosStagingReleaseChannelPublicId = null;
 
 
 
@@ -73,45 +73,47 @@ createCodePushApp(appNameIOS, 'iOS');
 generatePlainReactNativeApp(appName, reactNativeVersion);
 process.chdir(appName);
 installCodePush(reactNativeCodePushVersion);
-linkCodePush(androidStagingDeploymentKey, iosStagingDeploymentKey);
+linkCodePush();
 //GENERATE END
 
 
 
 function createCodePushApp(name, os) {
     try {
+        // TODO MIGRATION
         console.log(`Creating CodePush app "${name}" to release updates for ${os}...`);
         try {
-            const appResult = execCommand(`appcenter apps create -d ${name} -n ${name} -o ${os} -p React-Native --output json`);
+            const appResult = execCommand(`appzung applications create -d ${name} -n ${name} -o ${os} -p React-Native --output json`);
             const app = JSON.parse(appResult);
             owner = app.owner.name;
             console.log(`App "${name}" has been created \n`);
         } catch (e) {
             console.error(`Error: Unable to create CodePush app. Please check that you haven't application with "${name}" name on portal.`,);
             console.error("Error: ", e.toString());
         }
-        execCommand(`appcenter codepush deployment add -a ${owner}/${name} Staging`);
+        execCommand(`appzung releases-channels create`); // TODO MIGRATION
     } catch (e) {
         console.error("Error", e.toString());
     }
 
     try {
-        const deploymentKeysResult = execCommand(`appcenter codepush deployment list -a ${owner}/${name} -k --output json`);
-        const deploymentKeys = JSON.parse(deploymentKeysResult);
-        const stagingDeploymentKey = deploymentKeys[0][1];
-        console.log(`Deployment key for ${os}: ${stagingDeploymentKey}`);
-        console.log(`Use "appcenter codepush release-react ${owner}/${name}" command to release updates for ${os} \n`);
+        // TODO MIGRATION
+        const releaseChannelPublicIdsResult = execCommand(`appzung release-channels list --output json`);
+        const releaseChannelPublicIds = JSON.parse(releaseChannelPublicIdsResult);
+        const stagingReleaseChannelPublicId = releaseChannelPublicIds[0][1];
+        console.log(`Release channel public ID for ${os}: ${stagingReleaseChannelPublicId}`);
+        console.log(`Use "appzung releases deploy-react-native" command to release updates for ${os} \n`);
 
         switch (os) {
             case 'Android':
-                androidStagingDeploymentKey = stagingDeploymentKey;
+                androidStagingReleaseChannelPublicId = stagingReleaseChannelPublicId;
                 break;
             case 'iOS':
-                iosStagingDeploymentKey = stagingDeploymentKey;
+                iosStagingReleaseChannelPublicId = stagingReleaseChannelPublicId;
                 break;
         }
     } catch (e) {
-        console.error("Error: Unable to load deployment keys");
+        console.error("Error: Unable to load release channels");
         console.error("Error: ", e.toString());
     }
 
@@ -129,33 +131,16 @@ function installCodePush(reactNativeCodePushVersion) {
     console.log(`React Native Module for CodePush has been installed \n`);
 }
 
-function linkCodePush(androidStagingDeploymentKey, iosStagingDeploymentKey) {
+function linkCodePush() {
     console.log(`Linking React Native Module for CodePush...`);
-    if (isReactNativeVersionLowerThan(60)) {
-        nexpect.spawn(`react-native link react-native-code-push`)
-            .wait("What is your CodePush deployment key for Android (hit <ENTER> to ignore)")
-            .sendline(androidStagingDeploymentKey)
-            .wait("What is your CodePush deployment key for iOS (hit <ENTER> to ignore)")
-            .sendline(iosStagingDeploymentKey)
-            .run(function (err) {
-                if (!err) {
-                    console.log(`React Native Module for CodePush has been linked \n`);
-                    setupAssets();
-                }
-                else {
-                    console.log(err);
-                }
-            });
+    androidSetup();
+    if (process.platform === 'darwin') {
+        iosSetup();
     } else {
-        androidSetup();
-        if (process.platform === 'darwin') {
-            iosSetup();
-        } else {
-            console.log('Your OS is not "Mac OS" so the iOS application will not be configured')
-        }
-        setupAssets();
-        console.log(`React Native Module for CodePush has been linked \n`);
+        console.log('Your OS is not "Mac OS" so the iOS application will not be configured')
     }
+    setupAssets();
+    console.log(`React Native Module for CodePush has been linked \n`);
 }
 
 function setupAssets() {
@@ -198,15 +183,6 @@ function setupAssets() {
 
 function optimizeToTestInDebugMode() {
     const rnXcodeShLocationFolder = 'scripts';
-    try {
-        const rnVersions = JSON.parse(execCommand(`npm view react-native versions --json`));
-        const currentRNversion = JSON.parse(fs.readFileSync('./package.json'))['dependencies']['react-native'];
-        if (rnVersions.indexOf(currentRNversion) > -1 &&
-            rnVersions.indexOf(currentRNversion) < rnVersions.indexOf("0.46.0-rc.0")) {
-            rnXcodeShLocationFolder = 'packager';
-        }
-    } catch (e) { }
-
     const rnXcodeShPath = `node_modules/react-native/${rnXcodeShLocationFolder}/react-native-xcode.sh`;
     // Replace "if [[ "$PLATFORM_NAME" == *simulator ]]; then" with "if false; then" to force bundling
     execCommand(`sed -ie 's/if \\[\\[ "\$PLATFORM_NAME" == \\*simulator \\]\\]; then/if false; then/' ${rnXcodeShPath}`);
@@ -253,8 +229,8 @@ function androidSetup() {
 
     let stringsResourcesContent = fs.readFileSync(stringsResourcesPath, "utf8");
     const insertAfterString = "<resources>";
-    const deploymentKeyString = `\t<string moduleConfig="true" name="CodePushDeploymentKey">${androidStagingDeploymentKey || "deployment-key-here"}</string>`;
-    stringsResourcesContent = stringsResourcesContent.replace(insertAfterString, `${insertAfterString}\n${deploymentKeyString}`);
+    const releaseChannelPublicIdString = `\t<string moduleConfig="true" name="CodePushReleaseChannelPublicId">${androidStagingReleaseChannelPublicId || "release-channel-public-id-here"}</string>`;
+    stringsResourcesContent = stringsResourcesContent.replace(insertAfterString, `${insertAfterString}\n${releaseChannelPublicIdString}`);
     fs.writeFileSync(stringsResourcesPath, stringsResourcesContent);
 
     let buildGradleContents = fs.readFileSync(buildGradlePath, "utf8");
@@ -327,9 +303,9 @@ function iosSetup() {
 
     const dictPlistTag = `</dict>\n</plist>`;
 
-    const codePushDeploymentKey = iosStagingDeploymentKey || 'deployment-key-here';
+    const codePushReleaseChannelPublicId = iosStagingReleaseChannelPublicId || 'release-channel-public-id-here';
     plistContents = plistContents.replace(dictPlistTag,
-        `\t<key>CodePushDeploymentKey</key>\n\t<string>${codePushDeploymentKey}</string>${dictPlistTag}`);
+        `\t<key>CodePushReleaseChannelPublicId</key>\n\t<string>${codePushReleaseChannelPublicId}</string>${dictPlistTag}`);
     fs.writeFileSync(plistPath, plistContents);
 
     let appDelegateContents = fs.readFileSync(appDelegatePath, "utf8");