Merge pull request #159 from qonversion/release/4.4.0

SpertsyanKM · web-flow · commit dca30f4a756b · 2022-08-26T15:26:50.000+03:00
Release 4.4.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 4.4.0
+* Added support of network connection lack or unexpected backend errors. Now Qonversion SDK will handle user permissions correctly even if it can't reach out to the API and will actualize them with the next successful request. Also, products and offerings become permanently available after the first successful launch - nothing will interfere user from the purchase.
+* Added method `setPermissionsCacheLifetime` to configure the lifetime of permissions cache. It is used if we faced any error trying to get permissions from our API. Defaults to one month.
+* Added a new defined property `FirebaseAppInstanceId` for Firebase integration.
+* _(Android only)_ Fixed a bug with introductory price tracking causing wrong data in the analytics dashboard for some purchases.
+
 ## 4.3.4
 * Updated native SDK versions. Android 3.2.4 -> 3.2.9. iOS 2.18.3 -> 2.19.1.
 
diff --git a/android/build.gradle b/android/build.gradle
@@ -1,9 +1,9 @@
 group 'com.qonversion.flutter.sdk.qonversion_flutter_sdk'
-version '4.3.4'
+version '4.4.0'
 
 buildscript {
     ext.kotlin_version = '1.3.50'
-    ext.qonversion_version = '3.2.9'
+    ext.qonversion_version = '3.3.0'
     repositories {
         google()
         jcenter()
diff --git a/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/FlutterResult+CustomErrors.kt b/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/FlutterResult+CustomErrors.kt
@@ -71,6 +71,10 @@ fun MethodChannel.Result.noSdkInfo() {
     return this.error("15", "Could not find sdk info", passValidValue)
 }
 
+fun MethodChannel.Result.noLifetime() {
+    return this.error("16", "Could not find lifetime", passValidValue)
+}
+
 fun MethodChannel.Result.noProductIdField(details: String?) {
     return this.error("NoProductIdField", "Could not find qonversionId in Product", details)
 }
diff --git a/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/Mapper.kt b/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/Mapper.kt
@@ -12,6 +12,7 @@ import com.qonversion.android.sdk.automations.QActionResult
 import com.qonversion.android.sdk.automations.QActionResultType
 import com.qonversion.android.sdk.dto.QLaunchResult
 import com.qonversion.android.sdk.dto.QPermission
+import com.qonversion.android.sdk.dto.QPermissionsCacheLifetime
 import com.qonversion.android.sdk.dto.eligibility.QEligibility
 import com.qonversion.android.sdk.dto.eligibility.QIntroEligibilityStatus
 import com.qonversion.android.sdk.dto.offerings.QOffering
@@ -199,4 +200,19 @@ fun AutomationsEventType.toInt(): Int {
         AutomationsEventType.SubscriptionDowngraded -> 15
         AutomationsEventType.SubscriptionProductChanged -> 16
     }
+}
+
+fun parsePermissionsCacheLifetime(lifetime: String): QPermissionsCacheLifetime? {
+    val lifetimes = mapOf(
+        "Week" to QPermissionsCacheLifetime.WEEK,
+        "TwoWeeks" to QPermissionsCacheLifetime.TWO_WEEKS,
+        "Month" to QPermissionsCacheLifetime.MONTH,
+        "TwoMonths" to QPermissionsCacheLifetime.TWO_MONTHS,
+        "ThreeMonths" to QPermissionsCacheLifetime.THREE_MONTHS,
+        "SixMonths" to QPermissionsCacheLifetime.SIX_MONTHS,
+        "Year" to QPermissionsCacheLifetime.YEAR,
+        "Unlimited" to QPermissionsCacheLifetime.UNLIMITED
+    )
+
+    return lifetimes[lifetime]
 }
diff --git a/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/QonversionFlutterSdkPlugin.kt b/android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/QonversionFlutterSdkPlugin.kt
@@ -10,6 +10,7 @@ import com.google.gson.JsonSyntaxException
 import com.qonversion.android.sdk.*
 import com.qonversion.android.sdk.dto.QLaunchResult
 import com.qonversion.android.sdk.dto.QPermission
+import com.qonversion.android.sdk.dto.QPermissionsCacheLifetime
 import com.qonversion.android.sdk.dto.eligibility.QEligibility
 import com.qonversion.android.sdk.dto.offerings.QOfferings
 import com.qonversion.android.sdk.dto.products.QProduct
@@ -115,6 +116,7 @@ class QonversionFlutterSdkPlugin : MethodCallHandler, FlutterPlugin, ActivityAwa
             "checkTrialIntroEligibility" -> checkTrialIntroEligibility(args, result)
             "storeSdkInfo" -> storeSdkInfo(args, result)
             "identify" -> identify(args["userId"] as? String, result)
+            "setPermissionsCacheLifetime" -> setPermissionsCacheLifetime(args, result)
             "setNotificationsToken" -> setNotificationsToken(args["notificationsToken"] as? String, result)
             "handleNotification" -> handleNotification(args, result)
             else -> result.notImplemented()
@@ -341,6 +343,18 @@ class QonversionFlutterSdkPlugin : MethodCallHandler, FlutterPlugin, ActivityAwa
         })
     }
 
+    private fun setPermissionsCacheLifetime(args: Map<String, Any>, result: Result) {
+        val rawLifetime = args["lifetime"] as? String ?: return result.noLifetime()
+
+        val lifetime = parsePermissionsCacheLifetime(rawLifetime) ?: run {
+            result.parsingError("No permissions cache lifetime associated with the provided value: $rawLifetime")
+            return
+        }
+
+        Qonversion.setPermissionsCacheLifetime(lifetime)
+        result.success(null)
+    }
+
     private fun setNotificationsToken(token: String?, result: Result) {
         token?.let {
             Qonversion.setNotificationsToken(it)
diff --git a/ios/Classes/FlutterError+Custom.swift b/ios/Classes/FlutterError+Custom.swift
@@ -75,7 +75,11 @@ extension FlutterError {
   static let noSdkInfo = FlutterError(code: "15",
                                       message: "Could not find sdk info",
                                       details: passValidValue)
-  
+
+  static let noLifetime = FlutterError(code: "16",
+                                       message: "Could not find lifetime",
+                                       details: passValidValue)
+
   static func promoPurchaseError(_ productId: String) -> FlutterError {
     return FlutterError (code: "PromoPurchase",
                          message: "Could not find completion block for Product ID: \(productId)",
diff --git a/ios/Classes/Mapper.swift b/ios/Classes/Mapper.swift
@@ -120,6 +120,9 @@ extension Qonversion.Property {
       
     case "CustomUserId":
       return .userID
+
+    case "FirebaseAppInstanceId":
+      return .firebaseAppInstanceId
       
     default:
       throw ParsingError.runtimeError("Could not parse Qonversion.Property")
@@ -210,3 +213,36 @@ extension QONAutomationsEvent {
             "date": date.toMilliseconds()]
   }
 }
+
+extension Qonversion.PermissionsCacheLifetime {
+  static func fromString(_ string: String) throws -> Self {
+    switch string {
+    case "Week":
+      return .week;
+    
+    case "TwoWeeks":
+      return .twoWeeks;
+    
+    case "Month":
+      return .month;
+    
+    case "TwoMonths":
+      return .twoMonth;
+    
+    case "ThreeMonths":
+      return .threeMonth;
+    
+    case "SixMonths":
+      return .sixMonth;
+    
+    case "Year":
+      return .year;
+      
+    case "Unlimited":
+      return .unlimited;
+      
+    default:
+      throw ParsingError.runtimeError("Could not parse Qonversion.PermissionsCacheLifetime");
+    }
+  }
+}
diff --git a/ios/Classes/SwiftQonversionFlutterSdkPlugin.swift b/ios/Classes/SwiftQonversionFlutterSdkPlugin.swift
@@ -111,6 +111,9 @@ public class SwiftQonversionFlutterSdkPlugin: NSObject, FlutterPlugin {
     case "setAppleSearchAdsAttributionEnabled":
       let enable = args["enable"] as? Bool ?? false
       return setAppleSearchAdsAttributionEnabled(enable, result)
+
+    case "setPermissionsCacheLifetime":
+      return setPermissionsCacheLifetime(args, result)
       
     case "setNotificationsToken":
       return setNotificationsToken(args["notificationsToken"] as? String, result)
@@ -356,7 +359,26 @@ public class SwiftQonversionFlutterSdkPlugin: NSObject, FlutterPlugin {
     }
     result(nil)
   }
-  
+
+  private func setPermissionsCacheLifetime(_ args: [String: Any], _ result: @escaping FlutterResult) {
+    guard let rawLifetime = args["lifetime"] as? String else {
+      return result(FlutterError.noLifetime)
+    }
+    
+    do {
+      let lifetime = try Qonversion.PermissionsCacheLifetime.fromString(rawLifetime)
+      
+      Qonversion.setPermissionsCacheLifetime(lifetime)
+      result(nil)
+    } catch ParsingError.runtimeError(let message) {
+      result(FlutterError.parsingError(message))
+    } catch {
+      if let nsError = error as NSError? {
+        result(FlutterError.qonversionError(nsError))
+      }
+    }
+  }
+
   private func setNotificationsToken(_ token: String?, _ result: @escaping FlutterResult) {
     guard let token = token else {
       result(FlutterError.noArgs)
diff --git a/ios/qonversion_flutter.podspec b/ios/qonversion_flutter.podspec
@@ -4,7 +4,7 @@
 #
 Pod::Spec.new do |s|
   s.name             = 'qonversion_flutter'
-  s.version          = '4.3.4'
+  s.version          = '4.4.0'
   s.summary          = 'Flutter Qonversion SDK'
   s.description      = <<-DESC
   Powerful yet simple subscription analytics
@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
   s.platform = :ios, '9.0'
-  s.dependency 'Qonversion', '2.19.1'
+  s.dependency 'Qonversion', '2.20.0'
 
   # Flutter.framework does not contain a i386 slice. Only x86_64 simulators are supported.
   s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'VALID_ARCHS[sdk=iphonesimulator*]' => 'x86_64' }
diff --git a/lib/qonversion_flutter.dart b/lib/qonversion_flutter.dart
@@ -18,5 +18,6 @@ export 'src/models/qonversion_error.dart';
 export 'src/models/sk_product/discount_payment_mode.dart';
 export 'src/models/sk_product/subscription_period_unit.dart';
 export 'src/models/user_property.dart';
+export 'src/models/permissions_cache_lifetime.dart';
 export 'src/qa_provider.dart';
 export 'src/qonversion.dart';
diff --git a/lib/src/constants.dart b/lib/src/constants.dart
@@ -19,6 +19,7 @@ class Constants {
   static const kEnableAppleSearchAdsAttribution = 'enable';
   static const kNotificationsToken = 'notificationsToken';
   static const kNotificationData = 'notificationData';
+  static const kLifetime = 'lifetime';
 
   // MethodChannel methods names
   static const mLaunch = 'launch';
@@ -32,6 +33,7 @@ class Constants {
   static const mRestore = 'restore';
   static const mSetProperty = 'setProperty';
   static const mSetUserProperty = 'setUserProperty';
+  static const mSetPermissionsCacheLifetime = 'setPermissionsCacheLifetime';
   static const mSyncPurchases = 'syncPurchases';
   static const mAddAttributionData = 'addAttributionData';
   static const mSetDebugMode = 'setDebugMode';
diff --git a/lib/src/models/permissions_cache_lifetime.dart b/lib/src/models/permissions_cache_lifetime.dart
@@ -0,0 +1,10 @@
+enum QPermissionsCacheLifetime {
+  week,
+  twoWeeks,
+  month,
+  twoMonths,
+  threeMonths,
+  sixMonths,
+  year,
+  unlimited,
+}
diff --git a/lib/src/models/user_property.dart b/lib/src/models/user_property.dart
@@ -5,4 +5,5 @@ enum QUserProperty {
   adjustAdId,
   kochavaDeviceId,
   customUserId,
+  firebaseAppInstanceId,
 }
diff --git a/lib/src/qonversion.dart b/lib/src/qonversion.dart
@@ -7,6 +7,7 @@ import 'package:flutter/services.dart';
 import 'package:qonversion_flutter/qonversion_flutter.dart';
 import 'package:qonversion_flutter/src/models/offerings.dart';
 import 'package:qonversion_flutter/src/models/user_property.dart';
+import 'package:qonversion_flutter/src/models/permissions_cache_lifetime.dart';
 import 'package:qonversion_flutter/src/models/utils/mapper.dart';
 import 'package:qonversion_flutter/src/utils/string.dart';
 
@@ -16,7 +17,7 @@ import 'models/purchase_exception.dart';
 import 'qa_provider.dart';
 
 class Qonversion {
-  static const String _sdkVersion = "4.3.4";
+  static const String _sdkVersion = "4.4.0";
 
   static const MethodChannel _channel = MethodChannel('qonversion_flutter_sdk');
 
@@ -306,6 +307,17 @@ class Qonversion {
         {Constants.kEnableAppleSearchAdsAttribution: enable});
   }
 
+  /// Permissions cache is used when there are problems with the Qonversion API
+  /// or internet connection. If so, Qonversion will return the last successfully loaded
+  /// permissions. The current method allows you to configure how long that cache may be used.
+  /// The default value is [QPermissionsCacheLifetime.month].
+  ///
+  /// [lifetime] Desired permissions cache lifetime duration.
+  static Future<void> setPermissionsCacheLifetime(QPermissionsCacheLifetime lifetime) =>
+      _channel.invokeMethod(Constants.mSetPermissionsCacheLifetime, {
+        Constants.kLifetime: StringUtils.capitalize(describeEnum(lifetime)),
+      });
+
   /// Set push token to Qonversion to enable Qonversion push notifications
   /// [token] Firebase device token on Android. APNs device token on iOS
   static Future<void> setNotificationsToken(String token) {
diff --git a/macos/Classes/FlutterError+Custom.swift b/macos/Classes/FlutterError+Custom.swift
@@ -77,4 +77,9 @@ extension FlutterError {
   static let noSdkInfo = FlutterError(code: "15",
                                       message: "Could not find sdk info",
                                       details: passValidValue)
+
+  static let noLifetime = FlutterError(code: "16",
+                                       message: "Could not find lifetime",
+                                       details: passValidValue)
+
 }
diff --git a/macos/Classes/Mapper.swift b/macos/Classes/Mapper.swift
@@ -81,7 +81,10 @@ extension Qonversion.Property {
       
     case "KochavaDeviceId":
       return .kochavaDeviceID
-      
+
+    case "FirebaseAppInstanceId":
+      return .firebaseAppInstanceId
+
     default:
       throw ParsingError.runtimeError("Could not parse Qonversion.Property")
     }
@@ -113,6 +116,39 @@ extension Qonversion.IntroEligibility {
   }
 }
 
+extension Qonversion.PermissionsCacheLifetime {
+  static func fromString(_ string: String) throws -> Self {
+    switch string {
+    case "Week":
+      return .week;
+
+    case "TwoWeeks":
+      return .twoWeeks;
+
+    case "Month":
+      return .month;
+
+    case "TwoMonths":
+      return .twoMonth;
+
+    case "ThreeMonths":
+      return .threeMonth;
+
+    case "SixMonths":
+      return .sixMonth;
+
+    case "Year":
+      return .year;
+
+    case "Unlimited":
+      return .unlimited;
+
+    default:
+      throw ParsingError.runtimeError("Could not parse Qonversion.PermissionsCacheLifetime");
+    }
+  }
+}
+
 // MARK: - JSON Encoding
 extension Dictionary {
   func toJson() -> String? {
diff --git a/macos/Classes/SwiftQonversionFlutterSdkPlugin.swift b/macos/Classes/SwiftQonversionFlutterSdkPlugin.swift
@@ -97,7 +97,10 @@ public class SwiftQonversionFlutterSdkPlugin: NSObject, FlutterPlugin {
         
     case "identify":
         return identify(args["userId"] as? String, result)
-      
+
+    case "setPermissionsCacheLifetime":
+      return setPermissionsCacheLifetime(args, result)
+
     default:
       return result(FlutterMethodNotImplemented)
     }
@@ -316,6 +319,25 @@ public class SwiftQonversionFlutterSdkPlugin: NSObject, FlutterPlugin {
     
     result(nil)
   }
+
+  private func setPermissionsCacheLifetime(_ args: [String: Any], _ result: @escaping FlutterResult) {
+    guard let rawLifetime = args["lifetime"] as? String else {
+      return result(FlutterError.noLifetime)
+    }
+
+    do {
+      let lifetime = try Qonversion.PermissionsCacheLifetime.fromString(rawLifetime)
+
+      Qonversion.setPermissionsCacheLifetime(lifetime)
+      result(nil)
+    } catch ParsingError.runtimeError(let message) {
+      result(FlutterError.parsingError(message))
+    } catch {
+      if let nsError = error as NSError? {
+        result(FlutterError.qonversionError(nsError))
+      }
+    }
+  }
 }
 
 extension SwiftQonversionFlutterSdkPlugin: Qonversion.PurchasesDelegate {
diff --git a/macos/qonversion_flutter.podspec b/macos/qonversion_flutter.podspec
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,10 @@ fun MethodChannel.Result.noSdkInfo() {`
`71`	`71`	`return this.error("15", "Could not find sdk info", passValidValue)`
`72`	`72`	`}`
`73`	`73`
	`74`	`+fun MethodChannel.Result.noLifetime() {`
	`75`	`+ return this.error("16", "Could not find lifetime", passValidValue)`
	`76`	`+}`
	`77`	`+`
`74`	`78`	`fun MethodChannel.Result.noProductIdField(details: String?) {`
`75`	`79`	`return this.error("NoProductIdField", "Could not find qonversionId in Product", details)`
`76`	`80`	`}`