app rolls back to the version before update after closed and opened again

[metalllus]

I am testing this on an Ionic/Capacitor/Angular/Firebase project, NOT Cordova.
What I have done so far:

Created new app with appcenter apps create -d <appDisplayName> -o iOS -p Cordova
Created new deployment with appcenter codepush deployment add -a <ownerName>/<appName> Production
Built new app version ready for release with ionic capacitor build
Released new version with appcenter codepush release -a <ownerName>/<appName> -c ./PATH_TO_BUILD -m -t 1.0 -d Production
In the angular app I have this:

codePush
      .sync(
        {
          installMode: InstallMode.ON_NEXT_RESUME,
          mandatoryInstallMode: InstallMode.IMMEDIATE,
          onSyncStatusChanged: (status) => {
            console.log(status)
          },
        },
        (progress) => {
          console.log(progress)
          );
        }
      )
      .then((status) => {
        console.log(status)
      });

If I make an update available via Codepush, the update downloads and installs, the app restarts, I can see the changes, everything works.
But if I close the app and open it again, it loads in the state before the update was applied.
Tested on emulator and real device. Same behavior.
If anyone has a suggestion where I got it wrong, please do let me know.

*UPDATE: Today I tested also on Android, behavior is exactly the same as on iOS.
*UPDATE 2: Another thing that does not work for me are the callbacks that should be returning the update download progress and onSyncStatusChanged. Even though the update gets downloaded and installed these callbacks never seem to fire.

[metalllus]

@leo6104 @o-alexandrov @Clovel could you help me out with this please? I desperately need to get it working...

[PIXPOINT]

Same problem. The app instaliert itself, but after restarting it resets itself.

EDIT: solved by using codePush.notifyApplicationReady()

[metalllus]

@PIXPOINT Yep, that did help thx. Did you manage to get the downloadProgress callback working? For me it does not fire at all.

[PIXPOINT]

Yes:

remotePackage.download().then((localPackage) => {
    localPackage.install({
        installMode: InstallMode.ON_NEXT_RESUME,
        minimumBackgroundDuration: 120,
        mandatoryInstallMode: InstallMode.IMMEDIATE
    }).then(onInstallSuccess, onError);
});

[Clovel]

Hi @metalllus @PIXPOINT,

I do not have any insights on this issue for now, but we might have this issue too. I'll look into it in a few days to see if I can reproduce this issue and to pinpoint where it comes from.

@PIXPOINT, you said that you solved your issue using codePush.notifyApplicationReady(), but then showed us code without that function. Can you be more specific on the steps you took to solve your issue please ?

[PIXPOINT]

Hi @Clovel @metalllus,

far down in the README I found the following:
https://github.com/mapiacompany/capacitor-codepush#codepushnotifyapplicationready

After successfully installing the update, I run codePush.notifyApplicationReady(). Also before I check whether a new update is available. That solved the reset. The way I understood it, it takes care of it. The CodePush knows that the update was successfully installed.

Here's the code I'm using and it works. Maybe someone can update the readme?

let onError = (error) => {
    console.log("Error,", error);
};

let onInstallSuccess = () => {
    
    console.log("Installation succeeded.");

    /*
        Time delay, otherwise the installation fails for me at the next start.
    */
    setTimeout(() => {
        codePush.restartApplication();
    }, 200);
    
};

let onPackageDownloaded = (localPackage) => {
    
    console.log("Downlaod succeeded.", localPackage);
    
    localPackage.install({
        installMode: InstallMode.ON_NEXT_RESUME,
        minimumBackgroundDuration: 0,
        mandatoryInstallMode: InstallMode.IMMEDIATE
    }).then(onInstallSuccess, onError);
    
};

let onUpdateCheck = (remotePackage) => {
    if (!remotePackage) {
        
        console.log("The application is up to date.");
        
        // NOTIFY CODE PUSH
        codePush.notifyApplicationReady();
        
    } else {
        if (!remotePackage.failedInstall) {
            
            console.log("A CodePush update is available. Package hash: ", remotePackage);
            
            // DOWNLOAD UPDATE
            remotePackage.download().then(onPackageDownloaded).catch(onError);
            
        } else {
            
            console.log("The available update was attempted before and failed.");
            
        }
    }
};

codePush.checkForUpdate(onUpdateCheck, onError);

[Clovel]

Ok, interesting stuff. I have a few questions for you @PIXPOINT.

• Do you need to restart even for mandatory updates (configured w/ mandatoryInstallMode: InstallMode.IMMEDIATE in you code) ? Or does this apply only to the non mandatory updates (configured w/ installMode: InstallMode.ON_NEXT_RESUME)
• Any reason why you d'ont use the codePush.sync method ? It is specified in the README.md that sync calls codePush.notifyApplicationReady(); for us. Perhaps this sync method doesn't work as intended.
• How/chen does your code manage rollbacks ?

[metalllus]

@Clovel I can answer with experience from my testing so far.

1. Yes, you always need to restart after the update has been installed. No matter if the update is mandatory or not. The only reason why the mandatory flag exists in my opinion is so that you can choose a different install mode/install strategy for each option based on your preferences.
2. a 3. That is the thing. codepush.sync() does not work as it should in my opinion. It should run codePush.notifyApplicationReady() after the update is installed and app restarts but for some reason it doesn't. You have to run it manually after the restart to confirm that the install was successful so that the update does not roll back to the previous version on next launch. I can confirm this does work.

@PIXPOINT The codePush.notifyApplicationReady() should be called (as per the docs) after the restart occurs NOT before. That is because if something gets corrupted on install and the app does not load you will end up with a bricked app if you call it before restart.

The only thing that does not work for me at the moment is the downloadProgress callback (remotePackage.download((downloadProgress) => console.log(downloadProgress.receivedBytes))) If anyone manages to get it working I think we are done here.

[PIXPOINT]

@Clovel as with @metalllus, codepush.sync() doesn't work for me either. Therefore my modified code. In my app, information is displayed for the user during the various processes (not included in my post).
I adjusted the code post so that codePush.notifyApplicationReady() is only executed after the start.
For the rollback. If the installation fails, the re-installation is blocked by remotePackage.failedInstall.

[Clovel]

I believe the nominal flow of sync should be :

• Check if there is an update
• If there is an update available
  • Download the update
  • Install the update
  • Notify the app that the update has been successful
  • If the install mode for this update is IMMEDIATE
    • restart the app.
  • Else
    • Wait for the next app restart (depending on the install mode of course)
• Else
  • If an update been downloaded previously (before app start)
    • If it was successful
      • call codePush.notifyApplicationReady().

The sync method should restart if the InstallMode requires it to.
Personally, I always set the install mode to IMMEDIATE.

@metalllus are you saying that the "post-(re)start" actions aren't executed ?

Also :

If anyone manages to get it working I think we are done here.

It doesn't work for me either.

Nevertheless, we should find a way to fix codePush.sync.

[metalllus]

@Clovel what I am saying is that codePush.notifyApplicationReady() is not executed automatically if you use codePush.sync() to update even if the update download and install is successful. It should run automatically after app restart as per the docs but for me it does not. Hence the problem with the app rolling back to previous version if you do not run the codePush.notifyApplicationReady() manually after the restart. It should be fixed, yes, definetely but it is not a deal breaker for me as it can be worked around.

The only thing that bugs me is the downloadProgress callback (remotePackage.download((downloadProgress) => console.log(downloadProgress.receivedBytes))) not working. It should fire repeatedly during the download process and give you totalBytes and receivedBytes on the downloadProgress object. I need this to display the download progress indicator to the user.

[Clovel]

Seems that the notifyApplicationReady method is called in syncInternal, called by sync. Take a look here : https://github.com/mapiacompany/capacitor-codepush/blob/36e607c659948ef66effffb8e38c2dae8a90cab9/src/codePush.ts#L388

This line is not called if :

• CodePush.SyncInProgress === true
• There is a JS error before this line

When using sync, did you get any kind of errors @metalllus ?

[metalllus]

@Clovel I sent you the console output from Xcode on your gmail address.

[Clovel]

Perhaps notifyApplicationReady is called too late...

Another possibilty would be that the native code doesn't handle the notifyApplicationReady call.

Here is the code (for iOS) of notifyApplicationReady's native implemntation :
https://github.com/mapiacompany/capacitor-codepush/blob/36e607c659948ef66effffb8e38c2dae8a90cab9/ios/Plugin/CodePush.m#L143

Whatever happens, this function ends w/

    // Mark the update as confirmed and not requiring a rollback
    [CodePushPackageManager clearInstallNeedsConfirmation];
    [CodePushPackageManager cleanOldPackage];
    [call resolve];

[Clovel]

Honestly I'm not sure what is happening here.

It should run codePush.notifyApplicationReady() after the update is installed and app restarts but for some reason it doesn't.

It really seems like sync DOES call notifyApplicationReady... 🤔