cordova-plugin-hot-updates 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -0,0 +1,239 @@
+# Changelog
+
+All notable changes to cordova-plugin-hot-updates will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.0] - 2025-11-04
+
+### 🛠️ Fixed
+
+- **getUpdate() duplicate downloads**: Added check for already installed version - `getUpdate()` now returns success without re-downloading if the requested version is already installed
+- **Duplicate code**: Removed duplicate `setBool:YES forKey:kPendingUpdateReady` call in `saveDownloadedUpdate()`
+
+### 🧹 Improved
+
+- **Cleaner logs**: Removed all emoji and debug messages from native code - logs are now professional and suitable for production
+- **Code cleanup**: Removed 3 unused internal methods (~80 lines of dead code):
+  - `removeVersionFromIgnoreList()`
+  - `isVersionIgnored()`
+  - `compareVersion:withVersion:`
+- **Updated documentation**: Header comment now accurately reflects frontend-controlled architecture
+
+### 📊 Technical Details
+
+**Files changed**: 1 (HotUpdates.m)
+- Added: ~15 lines
+- Removed: ~80 lines
+- Methods removed: 3
+
+**No breaking changes** - API remains fully compatible with v2.0.0
+
+---
+
+## [2.0.0] - 2025-10-30
+
+### 🔥 Breaking Changes
+
+- **Rollback behavior changed**: After successful rollback, `previousVersion` is now cleared to prevent infinite rollback loops. This means you can only rollback once without performing a new update first.
+
+### ✨ Added
+
+- **Loop Prevention**: Added protection against infinite update/rollback cycles
+  - `forceUpdate` now rejects attempts to install already installed version (error: `version_already_installed`)
+  - `rollback` validates that previous version differs from current (error: `same_version`)
+  - `rollback` clears `previousVersion` metadata after successful rollback
+
+- **Enhanced Error Codes**: 13 detailed error codes for better error handling
+  - **forceUpdate**: 9 error codes (`version_already_installed`, `version_ignored`, `version_incompatible`, `download_failed`, `http_error`, `unzip_failed`, `invalid_package`, `install_failed`, `Download already in progress`)
+  - **rollback**: 4 error codes (`no_previous_version`, `previous_files_missing`, `same_version`, `file_operation_failed`)
+
+- **Improved Version Checking**: `getVersionInfo` now properly validates all conditions for rollback availability
+  - Checks: folder exists + metadata exists + versions are different
+  - New fields: `rollbackAvailable` (folder exists), `rollbackReady` (all conditions met)
+
+- **Enhanced API Responses**:
+  - `rollback` success response includes `canRollbackAgain: false` field
+  - `rollback` error response includes detailed error information: `error`, `message`, `currentVersion`, `previousVersion`, `canRollback`, `hasPreviousMetadata`
+  - `forceUpdate` error includes `currentVersion` and `requestedVersion` for `version_already_installed` error
+
+### 🛠️ Fixed
+
+- Fixed infinite rollback loop caused by version metadata swapping
+- Fixed `canRollback` incorrectly returning `true` when versions are identical
+- Fixed ability to install the same version multiple times
+- Fixed rollback not detecting corrupted metadata
+
+### 📝 Changed
+
+- Reduced excessive debug logging, keeping only essential logs
+- Improved log clarity and consistency across all methods
+- Metadata management now uses strict version validation
+
+### 🔒 Security
+
+- Added validation to prevent rollback to same version (potential attack vector)
+- Enhanced version comparison logic to prevent bypass attempts
+
+## [1.0.0] - 2025-10-27
+
+### ✨ Initial Release
+
+- Frontend-controlled WebView Reload approach
+- Automatic background update checking
+- Force update capability with instant WebView reload
+- Rollback mechanism with automatic backup
+- IgnoreList for blocking problematic versions
+- Canary system for version verification
+- Semantic version comparison
+- minAppVersion compatibility checking
+- Auto-update toggle (disabled by default)
+- First launch detection and handling
+- Support for iOS 11.2+
+
+---
+
+## Migration Guide: 1.0.0 → 2.0.0
+
+### Breaking Changes
+
+**1. Rollback Behavior**
+
+**Before (v1.0.0):**
+```
+Installed: 2.7.8, Previous: 2.7.7
+rollback() → Installed: 2.7.7, Previous: 2.7.8 ⚠️ (could create infinite loop)
+```
+
+**After (v2.0.0):**
+```
+Installed: 2.7.8, Previous: 2.7.7
+rollback() → Installed: 2.7.7, Previous: nil ✅ (loop prevented)
+```
+
+### What You Need to Update
+
+**1. Error Handling for forceUpdate**
+
+Add handler for new `version_already_installed` error:
+
+```javascript
+window.HotUpdates.forceUpdate(data, function(result) {
+  if (result.error === 'version_already_installed') {
+    // New in v2.0.0: Handle already installed version
+    showNotification('This version is already installed');
+    return;
+  }
+  // ... rest of error handling
+});
+```
+
+**2. Error Handling for rollback**
+
+Update rollback error handling with new detailed errors:
+
+```javascript
+window.HotUpdates.rollback(function(result) {
+  if (!result.success) {
+    // New in v2.0.0: Detailed error codes
+    switch(result.error) {
+      case 'no_previous_version':
+        showError('No previous version to rollback to');
+        break;
+      case 'previous_files_missing':
+        showError('Previous version files not found');
+        break;
+      case 'same_version':
+        showError('Cannot rollback to the same version');
+        break;
+      case 'file_operation_failed':
+        showError('Rollback failed');
+        break;
+    }
+  }
+});
+```
+
+**3. UI Updates for Rollback**
+
+Check `canRollbackAgain` field after rollback:
+
+```javascript
+window.HotUpdates.rollback(function(result) {
+  if (result.success) {
+    console.log('Rollback successful');
+    console.log('Can rollback again:', result.canRollbackAgain); // Always false in v2.0.0
+
+    // Hide rollback button after successful rollback
+    if (!result.canRollbackAgain) {
+      hideRollbackButton();
+    }
+  }
+});
+```
+
+**4. Version Info Checks**
+
+Use improved `canRollback` field:
+
+```javascript
+window.HotUpdates.getVersionInfo(function(info) {
+  // v2.0.0: More accurate rollback availability check
+  if (info.canRollback) {
+    // All conditions met: folder + metadata + different versions
+    enableRollbackButton();
+  } else {
+    disableRollbackButton();
+  }
+
+  // New fields in v2.0.0:
+  console.log('Rollback folder exists:', info.rollbackAvailable);
+  console.log('Rollback ready:', info.rollbackReady);
+});
+```
+
+### Testing After Migration
+
+Run these tests to ensure v2.0.0 works correctly:
+
+```javascript
+// Test 1: Prevent duplicate installation
+window.HotUpdates.getCurrentVersion(function(current) {
+  window.HotUpdates.forceUpdate({
+    url: 'http://example.com/update.zip',
+    version: current // Same as current!
+  }, function(result) {
+    // Should return error: version_already_installed ✅
+    console.assert(result.error === 'version_already_installed');
+  });
+});
+
+// Test 2: Rollback loop prevention
+window.HotUpdates.forceUpdate({url: '...', version: '2.7.8'}, function(r1) {
+  if (r1.status === 'installed') {
+    window.HotUpdates.rollback(function(r2) {
+      if (r2.success) {
+        // First rollback: should succeed ✅
+        window.HotUpdates.rollback(function(r3) {
+          // Second rollback: should fail with no_previous_version ✅
+          console.assert(!r3.success);
+          console.assert(r3.error === 'no_previous_version');
+        });
+      }
+    });
+  }
+});
+```
+
+### Performance Impact
+
+- **No performance degradation**: All changes are optimizations
+- **Reduced log output**: Less console spam in production
+- **Faster error detection**: Version checks happen earlier
+
+### Support
+
+- Documentation: [README.md](README.md)
+- Issues: [GitHub Issues](https://github.com/vladimirDarksy/Cordova_hot_update/issues)
+- Version comparison: [1.0.0...2.0.0](https://github.com/vladimirDarksy/Cordova_hot_update/compare/v1.0.0...v2.0.0)