feat: use latest Amplitude Browser 2 SDK (2.11.10) for flutter SDK web (

#216) Primary changes: - Update web files for using Browser SDK 2 as opposed to maintenance Javascript SDK - Update web bridge file - Update dart-js interface file - Update example app to use new script loader - Add web-specific configuration options - Session replay, autocapture are not currently supported (autocapture functionality to be investigated later) - Use js_interop and js_interop_unsafe rather than package:js/js.dart and package:js/js_util.dart - Added minimum flutter version of 3.3 to dependency matrix to support js_interop Extras: - Improved documentation for members of Configuration in configuration.dart - Fixed lint issues/linter github actions workflow Note: - No tests have been added for web since dart tests default to the Dart VM platform which does not have access to js libraries (e.g. js_interop, package:js/js.dart) Jira tickets: - Update web bridge https://amplitude.atlassian.net/browse/AMP-89343 - Update dart-js interface file https://amplitude.atlassian.net/browse/AMP-89344 - Migrate to js_interop https://amplitude.atlassian.net/browse/AMP-104922
amplitude · Jan 8, 2025 · 3ba2a54 · 3ba2a54
1 parent 6bcf2aa
commit 3ba2a54
Show file tree

Hide file tree

Showing 35 changed files with 458 additions and 371 deletions.
diff --git a/.github/workflows/swift-lint.yml b/.github/workflows/swift-lint.yml
@@ -4,12 +4,12 @@ on: [pull_request]
 
 jobs:
   lint:
-    runs-on: macos-12
+    runs-on: macos-13
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Set Xcode 14
+      - name: Set Xcode 14.1
         run: |
           sudo xcode-select -switch /Applications/Xcode_14.1.app
 

diff --git a/README.md b/README.md
@@ -22,9 +22,9 @@ From Amplitude Flutter v4, we bump up the kotlin version to v1.9.22 to support l
 
 The following matrix lists the minimum support for Amplitude Flutter SDK version.
 
-| Amplitude Flutter | Gradle | Android Gradle Plugin | Kotlin Gradle Plugin |
-|-------------------|-------|-----------------------|----------------------|
-| `4.+`             | `8.2` | `8.2.2`               | `1.9.22`             |
+| Flutter | Amplitude Flutter | Gradle | Android Gradle Plugin | Kotlin Gradle Plugin |
+|---------|-------------------|-------|-----------------------|-----------------------|
+|`3.3+`   | `4.+`             | `8.2` | `8.2.2`               | `1.9.22`              |
 
 
 Learn more about the Android [Gradle Plugin compatibility](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle), [Gradle compatibility](https://docs.gradle.org/current/userguide/compatibility.html#kotlin), and [Kotlin compatibility](https://kotlinlang.org/docs/whatsnew17.html#bumping-minimum-supported-versions).

diff --git a/example/README.md b/example/README.md
@@ -11,13 +11,13 @@ A few resources to get you started if this is your first Flutter project:
 - [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
 - [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
 
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.io/docs), which offers tutorials, 
+For help getting started with Flutter, view our
+[online documentation](https://flutter.io/docs), which offers tutorials,
 samples, guidance on mobile development, and a full API reference.
 
 
 ## Run the example
-Assuming you have Flutter setup on your machine. 
+Assuming you have Flutter setup on your machine.
 
 Update your Amplitude API key in `lib/main.dart`.
 
@@ -31,3 +31,8 @@ flutter run
 ```shell
 flutter run -d chrome
 ```
+In some cases (e.g. Chrome with forced sign-in), above command may not work well.
+Use the below command to start the server, then follow the printed link in console.
+```shell
+flutter run -d web-server --web-port=5000 --web-enable-expression-evaluation
+```
diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle
@@ -41,7 +41,7 @@ android {
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.example.amplitude_flutter_example"
-        minSdkVersion 16
+        minSdkVersion flutter.minSdkVersion
         targetSdkVersion 33
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName

diff --git a/example/android/build.gradle b/example/android/build.gradle
@@ -26,6 +26,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }
diff --git a/example/ios/Flutter/AppFrameworkInfo.plist b/example/ios/Flutter/AppFrameworkInfo.plist
@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>9.0</string>
+  <string>12.0</string>
 </dict>
 </plist>
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -26,8 +26,8 @@ SPEC CHECKSUMS:
   amplitude_flutter: aed4ad5d2da06894245fde7e8c56fed39ac6dca8
   AmplitudeSwift: cc22038404dc5581e2dea5dc2501302959dd3c90
   AnalyticsConnector: a53214d38ae22734c6266106c0492b37832633a9
-  Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
+  Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
 
 PODFILE CHECKSUM: cc1f88378b4bfcf93a6ce00d2c587857c6008d3b
 
-COCOAPODS: 1.15.2
+COCOAPODS: 1.16.2
diff --git a/example/ios/Runner.xcodeproj/project.pbxproj b/example/ios/Runner.xcodeproj/project.pbxproj
@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 46;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -164,7 +164,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0910;
+				LastUpgradeCheck = 1510;
 				ORGANIZATIONNAME = "The Chromium Authors";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {
@@ -232,10 +232,12 @@
 		};
 		3B06AD1E1E4923F5004D2608 /* Thin Binary */ = {
 			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
 			buildActionMask = 2147483647;
 			files = (
 			);
 			inputPaths = (
+				"${TARGET_BUILD_DIR}/${INFOPLIST_PATH}",
 			);
 			name = "Thin Binary";
 			outputPaths = (
@@ -246,6 +248,7 @@
 		};
 		9740EEB61CF901F6004384FC /* Run Script */ = {
 			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
 			buildActionMask = 2147483647;
 			files = (
 			);
@@ -349,7 +352,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -427,7 +430,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
@@ -474,7 +477,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";

diff --git a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0910"
+   LastUpgradeVersion = "1510"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/example/ios/Runner/AppDelegate.swift b/example/ios/Runner/AppDelegate.swift
@@ -1,7 +1,7 @@
 import UIKit
 import Flutter
 
-@UIApplicationMain
+@main
 @objc class AppDelegate: FlutterAppDelegate {
   override func application(
     _ application: UIApplication,

diff --git a/example/ios/Runner/Info.plist b/example/ios/Runner/Info.plist
@@ -41,5 +41,9 @@
 	</array>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<false/>
+	<key>CADisableMinimumFrameDurationOnPhone</key>
+	<true/>
+	<key>UIApplicationSupportsIndirectInputEvents</key>
+	<true/>
 </dict>
 </plist>
diff --git a/example/lib/app_state.dart b/example/lib/app_state.dart
@@ -1,3 +1,4 @@
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/amplitude.dart';
 import 'package:flutter/material.dart';
 

diff --git a/example/lib/device_id_form.dart b/example/lib/device_id_form.dart
@@ -3,7 +3,8 @@ import 'app_state.dart';
 
 class DeviceIdForm extends StatefulWidget {
   @override
-  _DeviceIdFormState createState() => _DeviceIdFormState();
+  // ignore: library_private_types_in_public_api
+  State<DeviceIdForm> createState() => _DeviceIdFormState();
 }
 
 class _DeviceIdFormState extends State<DeviceIdForm> {
@@ -12,7 +13,7 @@ class _DeviceIdFormState extends State<DeviceIdForm> {
       AppState
           .of(context)
           .analytics
-        ..setDeviceId(deviceId);
+          .setDeviceId(deviceId);
     };
   }
 
@@ -23,7 +24,7 @@ class _DeviceIdFormState extends State<DeviceIdForm> {
       children: <Widget>[
         Text('Device Id', style: Theme.of(context).textTheme.headlineSmall),
         const SizedBox(height: 10),
-        new TextField(
+        TextField(
           autocorrect: false,
           decoration: InputDecoration(labelText: 'Device Id'),
           onChanged: makeHandler(context),

diff --git a/example/lib/event_form.dart b/example/lib/event_form.dart
@@ -1,11 +1,13 @@
 import 'package:flutter/material.dart';
+
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/events/base_event.dart';
 
 import 'app_state.dart';
 
 class EventForm extends StatefulWidget {
   @override
-  _EventFormState createState() => _EventFormState();
+  State<EventForm> createState() => _EventFormState();
 }
 
 class _EventFormState extends State<EventForm> {

diff --git a/example/lib/flush_thresholds_form.dart b/example/lib/flush_thresholds_form.dart
@@ -4,7 +4,7 @@ import 'app_state.dart';
 
 class FlushThresholdForm extends StatefulWidget {
   @override
-  _FlushThresholdFormState createState() => _FlushThresholdFormState();
+  State<FlushThresholdForm> createState() => _FlushThresholdFormState();
 }
 
 class _FlushThresholdFormState extends State<FlushThresholdForm> {
@@ -20,7 +20,7 @@ class _FlushThresholdFormState extends State<FlushThresholdForm> {
     if (eventUploadThresholdInput.text.isNotEmpty && value != null) {
       AppState.of(context)
         // ..analytics.setEventUploadThreshold(value)
-        ..setMessage('Event upload threshold set.');
+        .setMessage('Event upload threshold set.');
     }
   }
 
@@ -30,7 +30,7 @@ class _FlushThresholdFormState extends State<FlushThresholdForm> {
     if (eventUploadPeriodMillisInput.text.isNotEmpty && value != null) {
       AppState.of(context)
         // ..analytics.setEventUploadPeriodMillis(value)
-        ..setMessage('Event upload period millis set.');
+        .setMessage('Event upload period millis set.');
     }
   }
 

diff --git a/example/lib/group_form.dart b/example/lib/group_form.dart
@@ -4,7 +4,7 @@ import 'app_state.dart';
 
 class GroupForm extends StatefulWidget {
   @override
-  _GroupFormState createState() => _GroupFormState();
+  State<GroupForm> createState() => _GroupFormState();
 }
 
 class _GroupFormState extends State<GroupForm> {

diff --git a/example/lib/group_identify_form.dart b/example/lib/group_identify_form.dart
@@ -1,11 +1,12 @@
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/events/identify.dart';
 import 'package:flutter/material.dart';
 
 import 'app_state.dart';
 
 class GroupIdentifyForm extends StatefulWidget {
   @override
-  _GroupIdentifyFormState createState() => _GroupIdentifyFormState();
+  State<GroupIdentifyForm> createState() => _GroupIdentifyFormState();
 }
 
 class _GroupIdentifyFormState extends State<GroupIdentifyForm> {

diff --git a/example/lib/identify_form.dart b/example/lib/identify_form.dart
@@ -1,11 +1,12 @@
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/events/identify.dart';
 import 'package:flutter/material.dart';
 
 import 'app_state.dart';
 
 class IdentifyForm extends StatefulWidget {
   @override
-  _IdentifyFormState createState() => _IdentifyFormState();
+  State<IdentifyForm> createState() => _IdentifyFormState();
 }
 
 class _IdentifyFormState extends State<IdentifyForm> {

diff --git a/example/lib/my_app.dart b/example/lib/my_app.dart
@@ -1,5 +1,6 @@
 import 'dart:async';
 
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/amplitude.dart';
 import 'package:amplitude_flutter/configuration.dart';
 import 'package:amplitude_flutter/constants.dart';
@@ -22,7 +23,7 @@ class MyApp extends StatefulWidget {
   final String apiKey;
 
   @override
-  _MyAppState createState() => _MyAppState();
+  State<MyApp> createState() => _MyAppState();
 }
 
 class _MyAppState extends State<MyApp> {

diff --git a/example/lib/reset.dart b/example/lib/reset.dart
@@ -4,7 +4,7 @@ import 'app_state.dart';
 
 class ResetForm extends StatefulWidget {
   @override
-  _DeviceState createState() => _DeviceState();
+  State<ResetForm> createState() => _DeviceState();
 }
 
 class _DeviceState extends State<ResetForm> {

diff --git a/example/lib/revenue_form.dart b/example/lib/revenue_form.dart
@@ -1,12 +1,13 @@
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
+// ignore_for_file: depend_on_referenced_packages
 import 'package:amplitude_flutter/events/revenue.dart';
 
 import 'app_state.dart';
 
 class RevenueForm extends StatefulWidget {
   @override
-  _RevenueFormState createState() => _RevenueFormState();
+  State<RevenueForm> createState() => _RevenueFormState();
 }
 
 class _RevenueFormState extends State<RevenueForm> {

diff --git a/example/lib/user_id_form.dart b/example/lib/user_id_form.dart
@@ -1,16 +1,18 @@
 import 'package:flutter/material.dart';
-
 import 'app_state.dart';
 
 class UserIdForm extends StatefulWidget {
   @override
-  _UserIdFormState createState() => _UserIdFormState();
+  State<UserIdForm> createState() => _UserIdFormState();
 }
 
 class _UserIdFormState extends State<UserIdForm> {
   void Function(String) makeHandler(BuildContext context) {
     return (String userId) {
-      AppState.of(context).analytics..setUserId(userId.isEmpty ? null : userId);
+      AppState
+        .of(context)
+        .analytics
+        .setUserId(userId.isEmpty ? null : userId);
     };
   }
 
@@ -19,17 +21,9 @@ class _UserIdFormState extends State<UserIdForm> {
     return Column(
       crossAxisAlignment: CrossAxisAlignment.start,
       children: <Widget>[
-        // Text('Current User Id', style: Theme.of(context).textTheme.headlineSmall),
-        // FutureBuilder(
-        //   // future: AppState.of(context).analytics.getUserId(),
-        //   builder: (BuildContext context, AsyncSnapshot<dynamic> snapshot) {
-        //     return Text(snapshot.data.toString());
-        //   },
-        // ),
-        // const SizedBox(height: 10),
         Text('User Id', style: Theme.of(context).textTheme.headlineSmall),
         const SizedBox(height: 10),
-        new TextField(
+        TextField(
             autocorrect: false,
             decoration: InputDecoration(labelText: 'User Id'),
             onChanged: makeHandler(context)),