Flutter support

.gitignore

@@ -27,6 +27,7 @@ doc/api/
 .history
 .vscode
 compile_commands.json
+*.log
 
 # IntelliJ
 *.iml

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.4
+
+* Added support for Android and Flutter Desktops (Windows/Linux).
+
 ## 0.0.3
 
 * Using `package:args` for handling CLI arguments.

README.md

@@ -56,8 +56,10 @@ Currently, 64 bit Desktop Platforms (Linux, Windows and MacOS) are supported.
 
 ## Run Example
 
+### Dart CLI
+
 ```bash
-cd example
+cd example/cli
 dart run cronet:setup # Downloads the cronet binaries.
 dart run
 ```

analysis_options.yaml

@@ -5,6 +5,7 @@
 include: package:lints/recommended.yaml
 
 analyzer:
+  exclude: [example/flutter/**]
   strong-mode:
     implicit-casts: false
     implicit-dynamic: false

android/.gitignore

@@ -0,0 +1,8 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures

android/build.gradle

@@ -0,0 +1,50 @@
+group 'dev.google.cronet'
+version '1.0-SNAPSHOT'
+
+buildscript {
+    ext.kotlin_version = '1.3.50'
+    repositories {
+        google()
+        jcenter()
+    }
+
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.1.0'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+rootProject.allprojects {
+    repositories {
+        google()
+        jcenter()
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    compileSdkVersion 30
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    externalNativeBuild {
+        // Encapsulates your CMake build configurations.
+        cmake {
+            // Provides a relative path to your CMake build script.
+            path "../src/CMakeLists.txt"
+        }
+    }
+
+    defaultConfig {
+        minSdkVersion 16
+    }
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation files(fileTree(dir: 'libs', includes: ['*.jar']))
+}

android/gradle.properties

@@ -0,0 +1,3 @@
+org.gradle.jvmargs=-Xmx1536M
+android.useAndroidX=true
+android.enableJetifier=true

android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip

android/settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'cronet'

android/src/main/AndroidManifest.xml

@@ -0,0 +1,5 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="dev.google.cronet">
+  <uses-permission android:name="android.permission.INTERNET" />
+  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+</manifest>

android/src/main/kotlin/dev/google/cronet/CronetPlugin.kt

@@ -0,0 +1,41 @@
+package dev.google.cronet
+
+import androidx.annotation.NonNull
+
+import io.flutter.embedding.engine.plugins.FlutterPlugin
+import io.flutter.plugin.common.MethodCall
+import io.flutter.plugin.common.MethodChannel
+import io.flutter.plugin.common.MethodChannel.MethodCallHandler
+import io.flutter.plugin.common.MethodChannel.Result
+import io.flutter.plugin.common.PluginRegistry.Registrar
+
+import org.chromium.base.ContextUtils
+
+/** CronetPlugin */
+class CronetPlugin: FlutterPlugin, MethodCallHandler {
+  /// The MethodChannel that will the communication between Flutter and native Android
+  ///
+  /// This local reference serves to register the plugin with the Flutter Engine and unregister it
+  /// when the Flutter Engine is detached from the Activity
+  private lateinit var channel : MethodChannel
+
+  override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
+    System.loadLibrary("cronet.86.0.4240.198")
+    System.loadLibrary("wrapper")
+    ContextUtils.initApplicationContext(flutterPluginBinding.applicationContext)
+    channel = MethodChannel(flutterPluginBinding.binaryMessenger, "cronet")
+    channel.setMethodCallHandler(this)
+  }
+
+  override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
+    if (call.method == "getPlatformVersion") {
+      result.success("Android ${android.os.Build.VERSION.RELEASE}")
+    } else {
+      result.notImplemented()
+    }
+  }
+
+  override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) {
+    channel.setMethodCallHandler(null)
+  }
+}

bin/setup.dart

@@ -9,6 +9,7 @@ import 'package:args/command_runner.dart';
 import 'package:cli_util/cli_logging.dart' show Ansi, Logger;
 import 'package:cronet/src/constants.dart';
 import 'package:cronet/src/third_party/ffigen/find_resource.dart';
+import 'package:path/path.dart';
 
 // Extracts a tar.gz file.
 void extract(String fileName, [String dir = '']) {
@@ -28,13 +29,40 @@ void extract(String fileName, [String dir = '']) {
   }
 }
 
+/// Places downloaded mobile binaries to proper location.
+void placeMobileBinaries(String platform, String fileName) {
+  final android =
+      '${findPackageRoot().toFilePath(windows: Platform.isWindows)}/android';
+  Directory('$android/libs').createSync();
+  Directory('$binaryStorageDir/$platform/libs').listSync().forEach((jar) {
+    if (jar is File) {
+      jar.renameSync('$android/libs/${basename(jar.path)}');
+    }
+  });
+  Directory('$android/src/main/jniLibs').createSync();
+  Directory('$binaryStorageDir/$platform/jniLibs')
+      .listSync(recursive: true)
+      .forEach((cronet) {
+    if (cronet is File) {
+      Directory('$android/src/main/jniLibs/${basename(cronet.parent.path)}')
+          .createSync();
+      cronet.renameSync(
+          '$android/src/main/jniLibs/${basename(cronet.parent.path)}'
+          '/${basename(cronet.path)}');
+    }
+  });
+}
+
 /// Places downloaded binaries to proper location.
 void placeBinaries(String platform, String fileName) {
   final logger = Logger.standard();
   final ansi = Ansi(Ansi.terminalSupportsAnsi);
   logger.stdout('${ansi.yellow}Extracting Cronet for $platform${ansi.none}');
   Directory(binaryStorageDir).createSync(recursive: true);
   extract(fileName, binaryStorageDir);
+  if (mobilePlatforms.contains(platform)) {
+    placeMobileBinaries(platform, fileName);
+  }
   logger.stdout('Done! Cleaning up...');
 
   File(fileName).deleteSync();
@@ -238,6 +266,9 @@ Future<void> main(List<String> args) async {
     if (validPlatforms.contains('${Platform.operatingSystem}64')) {
       await downloadCronetBinaries('${Platform.operatingSystem}64');
     }
+    if (Directory('android').existsSync()) {
+      await downloadCronetBinaries('android');
+    }
   } else {
     await runner.run(args);
   }

example/README.md

@@ -1,4 +1,5 @@
 ## Examples
 
 - [Bare Minimum](https://github.com/google/cronet.dart#example)
-- [Simple (Dart CLI)](https://github.com/google/cronet.dart/tree/main/example/)
+- [Simple (Dart CLI)](https://github.com/google/cronet.dart/tree/main/example/cli)
+- [Simple (Flutter)](https://github.com/google/cronet.dart/tree/main/example/flutter)

example/cli/analysis_options.yaml

@@ -0,0 +1,14 @@
+# Copyright (c) 2021, the Dart project authors.  Please see the AUTHORS file
+# for details. All rights reserved. Use of this source code is governed by a
+# BSD-style license that can be found in the LICENSE file.
+
+include: package:lints/recommended.yaml
+
+analyzer:
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+linter:
+  rules:
+    - directives_ordering
+    - lines_longer_than_80_chars

example/cli/bin/example_dart.dart

@@ -0,0 +1,33 @@
+// Copyright (c) 2021, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:convert';
+
+import 'package:cronet/cronet.dart';
+
+/* Trying to re-impliment: https://chromium.googlesource.com/chromium/src/+/master/components/cronet/native/sample/main.cc */
+
+void main(List<String> args) {
+  final stopwatch = Stopwatch()..start();
+  final client = HttpClient();
+  for (var i = 0; i < 3; i++) {
+    // Demo - with concurrent requests
+    client
+        .getUrl(Uri.parse('https://example.com'))
+        .then((HttpClientRequest request) {
+      if (i == 2) {
+        client.close(); // We will shut down the client after 3 connections.
+      }
+      return request.close();
+    }).then((HttpClientResponse response) {
+      response.transform(utf8.decoder).listen((contents) {
+        print(contents);
+      }, onDone: () {
+        print('cronet implemenation took: ${stopwatch.elapsedMilliseconds} ms');
+      }, onError: (Object e) {
+        print(e);
+      });
+    });
+  }
+}

example/pubspec.yaml → example/cli/pubspec.yaml

@@ -8,7 +8,7 @@ environment:
 
 dependencies:
   cronet:
-    path: ../
+    path: ../../
 
 dev_dependencies:
   lints: ^1.0.1

example/flutter/.gitignore

@@ -0,0 +1,46 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

example/flutter/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 1d9032c7e1d867f071f2277eb1673e8f9b0274e3
+  channel: stable
+
+project_type: app

example/flutter/README.md

@@ -0,0 +1,16 @@
+# cronet_example
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+
+For help getting started with Flutter, view our
+[online documentation](https://flutter.dev/docs), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

example/flutter/analysis_options.yaml

@@ -0,0 +1,14 @@
+# Copyright (c) 2021, the Dart project authors.  Please see the AUTHORS file
+# for details. All rights reserved. Use of this source code is governed by a
+# BSD-style license that can be found in the LICENSE file.
+
+include: package:lints/recommended.yaml
+
+analyzer:
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+linter:
+  rules:
+    - directives_ordering
+    - lines_longer_than_80_chars

example/flutter/android/.gitignore

@@ -0,0 +1,11 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties