Plugin requires that iosExtraFilesystems contains library-nosync, but this is not documented

elijahr commented 4 years ago

Description

fileUtil references cordova.file.dataDirectory in several places. According to cordova's docs, cordova.file.dataDirectory is available if iosExtraFilesystems includes library-nosync. The default value for iosExtraFilesystems includes library-nosync, so for many users, there is no issue.

However, if a developer's config.xml explicitly specifies an iosExtraFilesystems which does not include library-nosync, codePush will behave in unexpected ways. From what I was seeing, one of several things could happen, inconsistently:

The remote package would install correctly, and on app restart, the update would apply and everything would work as expected.
The remote package would install correctly, and on app restart, the update would apply. On subsequent restarts, the update would be rolled back, despite notifyApplicationReady() having been called on each app start.
The remote package would download but fail to install. It would fail with a rather unhelpful "Cannot perform diff-update." error message.

I suspect that this is because when library-nosync is not specified, the corresponding directory Library/NoCloud/ is still created by FileUtil.getDirectory(), but is synchronized to iCloud, since it is a subdirectory of Library/. It's not clear to me why this makes a difference, but it may have to do with a user's available iCloud storage space (I am maxed out on storage at the moment, but this issue was affecting most of our end users). It may be something else; the behavior of reading/writing data in Library/NoCloud without library-nosync is unspecified.

Adding library-nosync to iosExtraFilesystems fixed codePush for me; the updates consistently finished installing and "stuck". I couldn't find any documentation on this requirement, though I did find this unresolved issue that seemed possibly related.

Given that fileUtil references cordova.file.dataDirectory, and cordova.file.dataDirectory is only configured correctly if library-nosync is specified, at the very least this requirement should be documented somewhere. More ideally, the build should fail if iosExtraFilesystems does not contain library-nosync, a more helpful error message should be shown, or the plugin should simply override/append the library-nosync value to iosExtraFileSystems if it is not present.

Reproduction

Create a cordova application with the following additional configuration:

    <preference name="iosExtraFilesystems" value="library" />
    <plugin name="cordova-plugin-code-push" />

And observe that updates do not consistently install or "stick".

Additional Information

cordova-plugin-code-push version: master

List of installed plugins:

cordova-plugin-whitelist
cordova-plugin-file
cordova-plugin-ionic-webview
phonegap-plugin-push
cordova-launch-review
cordova-plugin-dialogs
cordova-plugin-inappbrowser
cordova-plugin-x-socialsharing
cordova-plugin-appavailability
cordova-plugin-file-transfer
cordova-plugin-customurlscheme
org.devgeeks.Canvas2ImagePlugin
cordova-universal-links-plugin-fixed
cordova-plugin-contacts
cordova-plugin-telerik-imagepicker
cordova-plugin-camera
cordova-plugin-calendar
cordova-plugin-geolocation
cordova-plugin-ios-location-permissions
cordova-plugin-ios-camera-permissions
cordova-plugin-googleplus
cordova-plugin-statusbar
cordova-plugin-device
cordova-plugin-vibration
cordova-plugin-taptic-engine
cordova-plugin-android-permissions
cordova-plugin-code-push
com.kochava.sdk
cordova-plugin-screen-orientation
cordova-plugin-zip
cordova-android-play-services-gradle-release
cordova-android-firebase-gradle-release
cordova-plugin-facebook4

Cordova version: 9
iOS/Android/Windows version: iOS 13.4
Does this reproduce on a debug build or release build? both
Does this reproduce on a simulator, or only on a physical device? haven't tried simulator

phyr0s commented 4 years ago

@elijahr i think that your issue is related to this --> https://github.com/microsoft/cordova-plugin-code-push/pull/608

Krasavinigor commented 4 years ago

Hi @elijahr! Thank you for reporting! We reproduced this issue. We will investigate it as soon as possible.

microsoft / cordova-plugin-code-push