feat: add option to disable screen view usage (#190)

android/build.gradle

@@ -58,7 +58,7 @@ android {
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     // Customer.io SDK
-    def cioVersion = "4.4.1"
+    def cioVersion = "4.5.0"
     implementation "io.customer.android:datapipelines:$cioVersion"
     implementation "io.customer.android:messaging-push-fcm:$cioVersion"
     implementation "io.customer.android:messaging-in-app:$cioVersion"

android/src/main/kotlin/io/customer/customer_io/CustomerIOPlugin.kt

@@ -9,6 +9,7 @@ import io.customer.customer_io.bridge.nativeNoArgs
 import io.customer.customer_io.messaginginapp.CustomerIOInAppMessaging
 import io.customer.customer_io.messagingpush.CustomerIOPushMessaging
 import io.customer.customer_io.utils.getAs
+import io.customer.datapipelines.config.ScreenView
 import io.customer.sdk.CustomerIO
 import io.customer.sdk.CustomerIOBuilder
 import io.customer.sdk.core.di.SDKComponent
@@ -182,13 +183,15 @@ class CustomerIOPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
         val logLevelRawValue = args.getAs<String>("logLevel")
         val regionRawValue = args.getAs<String>("region")
         val givenRegion = regionRawValue.let { Region.getRegion(it) }
+        val screenViewRawValue = args.getAs<String>("screenViewUse")
 
         CustomerIOBuilder(
             applicationContext = application,
             cdpApiKey = cdpApiKey
         ).apply {
             logLevelRawValue?.let { logLevel(CioLogLevel.getLogLevel(it)) }
             regionRawValue?.let { region(givenRegion) }
+            screenViewRawValue?.let { screenViewUse(ScreenView.getScreenView(it)) }
 
             args.getAs<String>("migrationSiteId")?.let(::migrationSiteId)
             args.getAs<Boolean>("autoTrackDeviceAttributes")?.let(::autoTrackDeviceAttributes)

apps/amiapp_flutter/.gitignore

@@ -5,9 +5,11 @@
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 fastlane/report.xml
 

apps/amiapp_flutter/ios/Podfile

@@ -1,7 +1,7 @@
 # ------------- 
 # This code only used internally for Customer.io testing
 require 'open-uri'
-IO.copy_stream(URI.open('https://raw.githubusercontent.com/customerio/customerio-ios/v2/scripts/cocoapods_override_sdk.rb'), "/tmp/override_cio_sdk.rb")
+IO.copy_stream(URI.open('https://raw.githubusercontent.com/customerio/customerio-ios/main/scripts/cocoapods_override_sdk.rb'), "/tmp/override_cio_sdk.rb")
 load "/tmp/override_cio_sdk.rb"
 # end of internal Customer.io testing code
 # ------------- 

apps/amiapp_flutter/lib/src/customer_io.dart

@@ -72,6 +72,7 @@ class CustomerIOSDK extends ChangeNotifier {
           cdnHost: _sdkConfig?.cdnHost,
           flushAt: _sdkConfig?.flushAt,
           flushInterval: _sdkConfig?.flushInterval?.toInt(),
+          screenViewUse: _sdkConfig?.screenViewUse,
           inAppConfig: inAppConfig,
         ),
       );

apps/amiapp_flutter/lib/src/data/config.dart

@@ -15,6 +15,7 @@ class CustomerIOSDKConfig {
   final String? cdnHost;
   final int? flushAt;
   final int? flushInterval;
+  final ScreenView? screenViewUse;
   final InAppConfig? inAppConfig;
   final PushConfig pushConfig;
 
@@ -29,6 +30,7 @@ class CustomerIOSDKConfig {
     this.cdnHost,
     this.flushAt,
     this.flushInterval,
+    this.screenViewUse,
     this.inAppConfig,
     PushConfig? pushConfig,
   }) : pushConfig = pushConfig ?? PushConfig();
@@ -45,10 +47,11 @@ class CustomerIOSDKConfig {
       throw ArgumentError('cdpApiKey cannot be null');
     }
 
-    final region = prefs.getString(_PreferencesKey.region) != null
-        ? Region.values.firstWhere(
-            (e) => e.name == prefs.getString(_PreferencesKey.region))
-        : null;
+    final region =
+        prefs.getEnumValueFromPrefs(_PreferencesKey.region, Region.values);
+    final screenViewUse = prefs.getEnumValueFromPrefs(
+        _PreferencesKey.screenViewUse, ScreenView.values);
+
     return CustomerIOSDKConfig(
       cdpApiKey: cdpApiKey,
       migrationSiteId: prefs.getString(_PreferencesKey.migrationSiteId),
@@ -63,27 +66,11 @@ class CustomerIOSDKConfig {
       cdnHost: prefs.getString(_PreferencesKey.cdnHost),
       flushAt: prefs.getInt(_PreferencesKey.flushAt),
       flushInterval: prefs.getInt(_PreferencesKey.flushInterval),
+      screenViewUse: screenViewUse,
       inAppConfig: InAppConfig(
           siteId: prefs.getString(_PreferencesKey.migrationSiteId) ?? ""),
     );
   }
-
-  Map<String, dynamic> toMap() {
-    return {
-      'cdpApiKey': cdpApiKey,
-      'migrationSiteId': migrationSiteId,
-      'region': region?.name,
-      'logLevel': debugModeEnabled,
-      'screenTrackingEnabled': screenTrackingEnabled,
-      'autoTrackDeviceAttributes': autoTrackDeviceAttributes,
-      'apiHost': apiHost,
-      'cdnHost': cdnHost,
-      'flushAt': flushAt,
-      'flushInterval': flushInterval,
-      'inAppConfig': inAppConfig?.toMap(),
-      'pushConfig': pushConfig.toMap(),
-    };
-  }
 }
 
 extension ConfigurationPreferencesExtensions on SharedPreferences {
@@ -128,8 +115,18 @@ extension ConfigurationPreferencesExtensions on SharedPreferences {
     result = result &&
         await setOrRemoveInt(
             _PreferencesKey.flushInterval, config.flushInterval);
+    result = result &&
+        await setOrRemoveString(
+            _PreferencesKey.screenViewUse, config.screenViewUse?.name);
     return result;
   }
+
+  T? getEnumValueFromPrefs<T extends Enum>(String key, List<T> values) {
+    final storedValue = getString(key);
+    if (storedValue == null) return null;
+
+    return values.firstWhere((e) => e.name == storedValue);
+  }
 }
 
 class _PreferencesKey {
@@ -143,4 +140,5 @@ class _PreferencesKey {
   static const cdnHost = 'CDN_HOST';
   static const flushAt = 'FLUSH_AT';
   static const flushInterval = 'FLUSH_INTERVAL';
+  static const screenViewUse = 'SCREEN_VIEW_USE';
 }

apps/amiapp_flutter/lib/src/screens/settings.dart

@@ -1,5 +1,6 @@
 import 'package:customer_io/config/in_app_config.dart';
 import 'package:customer_io/customer_io.dart';
+import 'package:customer_io/customer_io_enums.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:go_router/go_router.dart';
@@ -44,6 +45,7 @@ class _SettingsScreenState extends State<SettingsScreen> {
   late final TextEditingController _flushAtValueController;
   late final TextEditingController _flushIntervalValueController;
 
+  late ScreenView _screenViewUse;
   late bool _featureTrackScreens;
   late bool _featureTrackDeviceAttributes;
   late bool _featureDebugMode;
@@ -65,6 +67,7 @@ class _SettingsScreenState extends State<SettingsScreen> {
         TextEditingController(text: cioConfig?.flushAt?.toString());
     _flushIntervalValueController =
         TextEditingController(text: cioConfig?.flushInterval?.toString());
+    _screenViewUse = cioConfig?.screenViewUse ?? ScreenView.all;
     _featureTrackScreens = cioConfig?.screenTrackingEnabled ?? true;
     _featureTrackDeviceAttributes =
         cioConfig?.autoTrackDeviceAttributes ?? true;
@@ -85,6 +88,7 @@ class _SettingsScreenState extends State<SettingsScreen> {
       cdnHost: _cdnHostValueController.text.trim().nullIfEmpty(),
       flushAt: _flushAtValueController.text.trim().toIntOrNull(),
       flushInterval: _flushIntervalValueController.text.trim().toIntOrNull(),
+      screenViewUse: _screenViewUse,
       screenTrackingEnabled: _featureTrackScreens,
       autoTrackDeviceAttributes: _featureTrackDeviceAttributes,
       debugModeEnabled: _featureDebugMode,
@@ -119,6 +123,7 @@ class _SettingsScreenState extends State<SettingsScreen> {
       _flushAtValueController.text = defaultConfig.flushAt?.toString() ?? '';
       _flushIntervalValueController.text =
           defaultConfig.flushInterval?.toString() ?? '';
+      _screenViewUse = defaultConfig.screenViewUse ?? ScreenView.all;
       _featureTrackScreens = defaultConfig.screenTrackingEnabled;
       _featureTrackDeviceAttributes =
           defaultConfig.autoTrackDeviceAttributes ?? true;
@@ -287,6 +292,18 @@ class _SettingsScreenState extends State<SettingsScreen> {
                             updateState: ((value) =>
                                 setState(() => _featureDebugMode = value)),
                           ),
+                          const SizedBox(height: 8),
+                          ChoiceSettingsFormField<ScreenView>(
+                            labelText: 'ScreenView Use',
+                            semanticsLabel: 'ScreenView options',
+                            value: _screenViewUse,
+                            options: ScreenView.values,
+                            updateState: (ScreenView selected) {
+                              setState(() {
+                                _screenViewUse = selected;
+                              });
+                            },
+                          ),
                         ],
                       ),
                     ),

apps/amiapp_flutter/lib/src/utils/extensions.dart

@@ -106,6 +106,10 @@ extension AmiAppStringExtensions on String {
         (min == null || value >= min) &&
         (max == null || value <= max);
   }
+
+  String capitalize() {
+    return '${this[0].toUpperCase()}${substring(1)}';
+  }
 }
 
 extension LocationExtensions on GoRouter {

apps/amiapp_flutter/lib/src/widgets/settings_form_field.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
 
 import '../components/text_field_label.dart';
+import '../utils/extensions.dart';
 
 class TextSettingsFormField extends StatelessWidget {
   const TextSettingsFormField({
@@ -121,3 +122,98 @@ class SwitchSettingsFormField extends StatelessWidget {
     );
   }
 }
+
+class ChoiceSettingsFormField<T> extends StatelessWidget {
+  const ChoiceSettingsFormField({
+    super.key,
+    required this.labelText,
+    required this.semanticsLabel,
+    required this.value,
+    required this.updateState,
+    required this.options,
+    this.enabled = true,
+  });
+
+  final String labelText;
+  final String semanticsLabel;
+  final T value;
+  final List<T> options;
+  final void Function(T) updateState;
+  final bool enabled;
+
+  @override
+  Widget build(BuildContext context) {
+    const double defaultBorderRadius = 8.0;
+
+    return UnmanagedRestorationScope(
+      child: Column(
+        crossAxisAlignment: CrossAxisAlignment.start,
+        children: [
+          Text(
+            labelText,
+            style: Theme.of(context).textTheme.bodyMedium,
+          ),
+          const SizedBox(height: 12),
+          Container(
+            decoration: BoxDecoration(
+              color: enabled
+                  ? Theme.of(context).colorScheme.surface
+                  : Theme.of(context)
+                      .colorScheme
+                      .onSurface
+                      .withValues(alpha: 0.12),
+              borderRadius: BorderRadius.circular(defaultBorderRadius),
+            ),
+            child: Row(
+              children: options.map((option) {
+                final bool isSelected = option == value;
+                return Expanded(
+                  child: GestureDetector(
+                    onTap: enabled
+                        ? () {
+                            updateState(option);
+                          }
+                        : null,
+                    child: Container(
+                      padding: const EdgeInsets.symmetric(vertical: 12.0),
+                      decoration: BoxDecoration(
+                        color: isSelected
+                            ? Theme.of(context).colorScheme.primary
+                            : Theme.of(context)
+                                .colorScheme
+                                .surfaceContainerHighest,
+                        borderRadius: BorderRadius.only(
+                          topLeft: option == options.first
+                              ? const Radius.circular(defaultBorderRadius)
+                              : Radius.zero,
+                          bottomLeft: option == options.first
+                              ? const Radius.circular(defaultBorderRadius)
+                              : Radius.zero,
+                          topRight: option == options.last
+                              ? const Radius.circular(defaultBorderRadius)
+                              : Radius.zero,
+                          bottomRight: option == options.last
+                              ? const Radius.circular(defaultBorderRadius)
+                              : Radius.zero,
+                        ),
+                      ),
+                      child: Text(
+                        option.toString().split('.').last.capitalize(),
+                        textAlign: TextAlign.center,
+                        style: Theme.of(context).textTheme.bodyMedium?.copyWith(
+                              color: isSelected
+                                  ? Theme.of(context).colorScheme.onPrimary
+                                  : Theme.of(context).colorScheme.onSurface,
+                            ),
+                      ),
+                    ),
+                  ),
+                );
+              }).toList(),
+            ),
+          ),
+        ],
+      ),
+    );
+  }
+}