Allow to disable deploy updates with DisableDeploy preference (#142)

Author: jcesarmobile

README.md

@@ -17,12 +17,21 @@ The plugin will be available on `window` as `IonicCordova`
 
 * `APP_ID` **Required** - Your Ionic Pro app ID
 * `CHANNEL_NAME` **Required** - The channel to check for updates from
-* `WARN_DEBUG` - Set false if you do not want the check when apk/ipa is in debug mode.
 * `UPDATE_API` - The location of the Ionic Pro API (only change this for development)
 * `UPDATE_METHOD` - `auto`, `background`, or `none`.  Dictates the behavior of the plugin.  `auto` will download and apply the latest update on app start, potentially leading to long splash screen loads if the connection is slow.  `background` will only download the update in the background on app start, but will allow full functionality while doing so, only redirecting users the _next_ time the app is loaded.  `none` will do nothing, leaving full plugin functionality in the hands of the developer.  **Default is `background`**
 * `MAX_STORE` - The maximum number of downloaded versions to store on the device for quick loading.  More versions means less downloading, but can increase the app size greatly.  **Default is 3 (Defaults is 2 in V5)**
 * `MIN_BACKGROUND_DURATION` - The minimum duration in seconds after which the app in background checks for an update. **Default is 30 (New in V5)**
 
+### Preferences
+
+* `DisableDeploy` - Default value is `false`.
+
+Allows to disable deploy updates by adding this preference in the config.xml
+
+```
+<preference name="DisableDeploy" value="true" />
+```
+
 ## API Docs
 
 * [IonicCordova](docs/interfaces/_ioniccordova_d_.ipluginbaseapi.md)

create-local-app.sh

@@ -26,7 +26,6 @@ cordova plugin add ../cordova-plugin-ionic --save \
 --variable MIN_BACKGROUND_DURATION="$BACKGROUND_DURATION" \
 --variable APP_ID="${APP_ID}" \
 --variable CHANNEL_NAME="${CHANNEL}" \
---variable UPDATE_METHOD="${UPDATE_METHOD}" \
---variable WARN_DEBUG="false" --link
+--variable UPDATE_METHOD="${UPDATE_METHOD}" --link
 cordova prepare ios
 cordova prepare android

plugin.xml

@@ -16,7 +16,6 @@
     </js-module>
     <preference name="APP_ID"/>
     <preference name="CHANNEL_NAME"/>
-    <preference name="WARN_DEBUG" default="true"/>
     <preference name="UPDATE_API" default="https://api.ionicjs.com"/>
     <preference name="UPDATE_METHOD" default="background"/>
     <preference name="MAX_STORE" default="2"/>
@@ -29,16 +28,13 @@
             <feature name="IonicCordovaCommon">
                 <param name="ios-package" value="IonicCordovaCommon" onload="true"/>
             </feature>
+            <preference name="DisableDeploy" value="false" />
         </config-file>
 
         <config-file target="*-Info.plist" parent="IonAppId">
             <string>$APP_ID</string>
         </config-file>
 
-        <config-file target="*-Info.plist" parent="IonDebug">
-            <string>$WARN_DEBUG</string>
-        </config-file>
-
         <config-file target="*-Info.plist" parent="IonChannelName">
             <string>$CHANNEL_NAME</string>
         </config-file>
@@ -70,11 +66,11 @@
             <feature name="IonicCordovaCommon">
                 <param name="android-package" value="com.ionicframework.common.IonicCordovaCommon" onload="true"/>
             </feature>
+            <preference name="DisableDeploy" value="false" />
         </config-file>
 
         <config-file target="res/values/strings.xml" parent="/resources">
             <string name="ionic_app_id">$APP_ID</string>
-            <string name="ionic_debug">$WARN_DEBUG</string>
             <string name="ionic_channel_name">$CHANNEL_NAME</string>
             <string name="ionic_update_api">$UPDATE_API</string>
             <string name="ionic_update_method">$UPDATE_METHOD</string>

src/android/IonicCordovaCommon.java

@@ -229,7 +229,7 @@ private JSONObject getNativeConfig() throws JSONException {
 
     String appId = getStringResourceByName("ionic_app_id");
     j.put("appId", appId);
-    j.put("debug", getStringResourceByName("ionic_debug"));
+    j.put("disabled", preferences.getBoolean("DisableDeploy", false));
     j.put("channel", getStringResourceByName("ionic_channel_name"));
     j.put("host", getStringResourceByName("ionic_update_api"));
     j.put("updateMethod", getStringResourceByName("ionic_update_method"));

src/ios/IonicCordovaCommon.m

@@ -114,7 +114,7 @@ - (void) setPreferences:(CDVInvokedUrlCommand*)command {
 - (NSMutableDictionary*) getNativeConfig {
     // Get preferences from cordova
     NSString *appId = [NSString stringWithFormat:@"%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"IonAppId"]];
-    NSString *debug = [NSString stringWithFormat:@"%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"IonDebug"]];
+    NSNumber * disabled = [NSNumber numberWithBool:[[self.commandDelegate.settings objectForKey:[@"DisableDeploy" lowercaseString]] boolValue]];
     NSString *host = [NSString stringWithFormat:@"%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"IonApi"]];
     NSString *updateMethod = [NSString stringWithFormat:@"%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"IonUpdateMethod"]];
     NSString *channel = [NSString stringWithFormat:@"%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"IonChannelName"]];
@@ -124,7 +124,7 @@ - (NSMutableDictionary*) getNativeConfig {
     // Build the preferences json object
     NSMutableDictionary *json = [[NSMutableDictionary alloc] init];
     json[@"appId"] = appId;
-    json[@"debug"] = debug;
+    json[@"disabled"] = disabled;
     json[@"channel"] = channel;
     json[@"host"] = host;
     json[@"updateMethod"] = updateMethod;
@@ -159,4 +159,4 @@ - (void) configure:(CDVInvokedUrlCommand *)command {
     [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:newConfig] callbackId:command.callbackId];
 }
 
-@end
+@end

tests/test_common.ts

@@ -25,7 +25,7 @@ function callbackMock(returnValue: any, succeed: boolean) {
 
 const pluginConfig = {
   appId: 'myapp',
-  debug: 'false',
+  disabled: false,
   host: 'https://myhost.com',
   channel: 'mychannel',
   updateMethod: 'auto',
@@ -122,7 +122,7 @@ describe('IonicCordova', () => {
         expect(await pluginBase.deploy._pluginConfig).toEqual(pluginConfig);
         const newConfig = {
           appId: 'newappid',
-          debug: 'true',
+          disabled: true,
           host: 'http://newhost.com',
           channel: 'newchannel',
         }
@@ -191,7 +191,7 @@ describe('IonicCordova', () => {
         const pluginBase = IonicCordova;
         const newConfig = {
           appId: 'newappid',
-          debug: 'true',
+          disabled: true,
           host: 'http://newhost.com',
           channel: 'newchannel',
         }
@@ -234,7 +234,7 @@ describe('IonicCordova', () => {
         expect(pluginBase.deploy._pluginConfig).resolves.toBe(pluginConfig);
         const newConfig = {
           appId: 'newappid',
-          debug: 'true',
+          disabled: true,
           host: 'http://newhost.com',
           channel: 'newchannel',
         }
@@ -249,7 +249,7 @@ describe('IonicCordova', () => {
         const pluginBase = IonicCordova;
         const newConfig = {
           appId: 'newappid',
-          debug: 'true',
+          disabled: true,
           host: 'http://newhost.com',
           channel: 'newchannel',
         }

types/IonicCordova.d.ts

@@ -202,9 +202,9 @@ interface ICurrentConfig {
   binaryVersionCode: string;
 
   /**
-   * Whether the plugin is in debug mode or not.
+   * Whether the user disabled deploy updates or not.
    */
-  debug: string;
+  disabled: boolean;
 
   /**
    * The host API the plugin is configured to check for updates from.

www/common.ts

@@ -620,6 +620,7 @@ class IonicDeploy implements IDeployPluginAPI {
   private fetchIsAvailable: boolean;
   private lastPause = 0;
   private minBackgroundDuration = 10;
+  private disabled = false;
 
   constructor(parent: IPluginBaseAPI) {
     this.parent = parent;
@@ -632,14 +633,19 @@ class IonicDeploy implements IDeployPluginAPI {
     await this.platformReady();
     const preferences = await this._initPreferences();
     this.minBackgroundDuration = preferences.minBackgroundDuration;
+    this.disabled = preferences.disabled || !this.fetchIsAvailable;
     const appInfo = await this.parent.getAppDetails();
     preferences.binaryVersionName = appInfo.binaryVersionName;
     preferences.binaryVersionCode = appInfo.binaryVersionCode;
     preferences.binaryVersion = appInfo.binaryVersionName;
     const delegate = new IonicDeployImpl(appInfo, preferences);
-    // Only initialize start the plugin if fetch is available
-    if (!this.fetchIsAvailable) {
-      console.warn('Fetch is unavailable so cordova-plugin-ionic has been disabled.');
+    // Only initialize start the plugin if fetch is available and DisableDeploy preference is false
+    if (this.disabled) {
+      let disabledMessage = 'cordova-plugin-ionic has been disabled.';
+      if (!this.fetchIsAvailable) {
+        disabledMessage = 'Fetch is unavailable so ' + disabledMessage;
+      }
+      console.warn(disabledMessage);
       await new Promise<string>( (resolve, reject) => {
         cordova.exec(resolve, reject, 'IonicCordovaCommon', 'clearSplashFlag');
       });
@@ -695,7 +701,7 @@ class IonicDeploy implements IDeployPluginAPI {
   }
 
   async onResume() {
-    if (this.fetchIsAvailable && this.lastPause && this.minBackgroundDuration && Date.now() - this.lastPause > this.minBackgroundDuration * 1000) {
+    if (!this.disabled && this.lastPause && this.minBackgroundDuration && Date.now() - this.lastPause > this.minBackgroundDuration * 1000) {
       await (await this.delegate)._handleInitialPreferenceState();
     }
   }
@@ -714,15 +720,15 @@ class IonicDeploy implements IDeployPluginAPI {
 
   async checkForUpdate(): Promise<CheckDeviceResponse> {
     await this.platformReady();
-    if (this.fetchIsAvailable) {
+    if (!this.disabled) {
       return (await this.delegate).checkForUpdate();
     }
     return  {available: false};
   }
 
   async configure(config: IDeployConfig): Promise<void> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).configure(config);
+    if (!this.disabled) return (await this.delegate).configure(config);
   }
 
   async getConfiguration(): Promise<ICurrentConfig> {
@@ -746,49 +752,49 @@ class IonicDeploy implements IDeployPluginAPI {
 
   async deleteVersionById(version: string): Promise<boolean> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).deleteVersionById(version);
+    if (!this.disabled) return (await this.delegate).deleteVersionById(version);
     return true;
   }
 
   async downloadUpdate(progress?: CallbackFunction<number>): Promise<boolean> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).downloadUpdate(progress);
+    if (!this.disabled) return (await this.delegate).downloadUpdate(progress);
     return false;
   }
 
   async extractUpdate(progress?: CallbackFunction<number>): Promise<boolean> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).extractUpdate(progress);
+    if (!this.disabled) return (await this.delegate).extractUpdate(progress);
     return false;
   }
 
   async getAvailableVersions(): Promise<ISnapshotInfo[]> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).getAvailableVersions();
+    if (!this.disabled) return (await this.delegate).getAvailableVersions();
     return [];
   }
 
   async getCurrentVersion(): Promise<ISnapshotInfo | undefined> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).getCurrentVersion();
+    if (!this.disabled) return (await this.delegate).getCurrentVersion();
     return;
   }
 
   async getVersionById(versionId: string): Promise<ISnapshotInfo> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).getVersionById(versionId);
+    if (!this.disabled) return (await this.delegate).getVersionById(versionId);
     throw Error(`No update available with versionId ${versionId}`);
   }
 
   async reloadApp(): Promise<boolean> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).reloadApp();
+    if (!this.disabled) return (await this.delegate).reloadApp();
     return false;
   }
 
   async sync(syncOptions: ISyncOptions = {}): Promise<ISnapshotInfo | undefined> {
     await this.platformReady();
-    if (this.fetchIsAvailable) return (await this.delegate).sync(syncOptions);
+    if (!this.disabled) return (await this.delegate).sync(syncOptions);
     return;
   }
 }

www/guards.ts

@@ -1,6 +1,6 @@
 export function isPluginConfig(o: object): o is IDeployConfig {
   const obj = <IDeployConfig>o;
-  const allowedKeys = ['appId', 'channel', 'debug', 'host', 'maxVersions', 'minBackgroundDuration', 'updateMethod'];
+  const allowedKeys = ['appId', 'channel', 'disabled', 'host', 'maxVersions', 'minBackgroundDuration', 'updateMethod'];
   if (!obj) return false;
   for (const key in obj) {
     if (allowedKeys.indexOf(key) === -1) {