Migrate Essentials v0.0.1: Implement Client with openUrl method

.github/workflows/test-package.yml

@@ -60,6 +60,9 @@ jobs:
       - id: install
         name: Install dependencies
         run: dart pub get
+      - id: get_binaries
+        name: Download Cronet Binaries
+        run: pub run cronet linux64
       - name: Run VM tests
         run: dart test --platform vm
         if: always() && steps.install.outcome == 'success'

.gitignore

@@ -6,6 +6,9 @@
 build/
 pubspec.lock
 
+# wrapper build directory
+lib/src/native/wrapper/out
+
 # Directory created by dartdoc.
 doc/api/
 
@@ -33,3 +36,30 @@ compile_commands.json
 
 # Mac
 .DS_Store
+
+# Cronet pre-built binaries
+cronet_binaries/
+
+# Generated shared libraries.
+*.so
+*.so.*
+*.dylib
+*.dll
+
+# AOT compiled files.
+*.exe
+
+*.jar
+*.cxx
+
+*.flutter-plugins
+*.flutter-plugins-dependencies
+
+*.idea
+
+# Directory for quick experiments.
+experiments/
+
+# Files generated by tests for debugging purposes.
+test/debug_generated/*
+!test/debug_generated/readme.md

.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: plugin

.pubignore

@@ -0,0 +1,55 @@
+# See https://dart.dev/guides/libraries/private-files
+
+# Files and directories created by pub.
+.dart_tool/
+.packages
+pubspec.lock
+
+# IDE and debugger files.
+.clangd
+.gdb_history
+.history
+.vscode
+compile_commands.json
+
+# Avoid committing generated Javascript files:
+*.dart.js
+*.info.json      # Produced by the --dump-info flag.
+*.js             # When generated by dart2js. Don't specify *.js if your
+                 # project includes source files written in JavaScript.
+*.js_
+*.js.deps
+*.js.map
+
+# Cronet pre-built binaries
+cronet_binaries/
+
+# Generated shared libraries.
+*.so
+*.so.*
+*.dylib
+*.dll
+
+# AOT compiled files.
+*.exe
+
+*.jar
+*.cxx
+
+# Jar dependencies should be published to pub
+!android/libs/*
+
+# Cronet binaries for android should be published to pub
+!android/src/main/jniLibs/**
+
+*.flutter-plugins
+*.flutter-plugins-dependencies
+
+*.idea
+
+# Directory for quick experiments.
+experiments/
+
+# Files generated by tests for debugging purposes.
+test/debug_generated/*
+!test/debug_generated/readme.md

AUTHORS

@@ -4,3 +4,5 @@
 #   Name/Organization <email address>
 
 Google LLC
+
+Soumyadip Mondal <[email protected]>

CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.0.1
+
+* HttpClient with QUIC, HTTP2, brotli support.
+* HttpClient with a customizable user agent string.
+* HttpClient close method (without force close).
+* Implemented open, openUrl & other associated methods.
+* Response is consumable using 2 styles of APIs. dart:io style and callback based style.
+* Different types of Exceptions are implemented.
+
+**Breaking Changes:**
+
+* Custom `SecurityContext` is no longer handled by the client. Users have to handle it in other ways. (To be documented later).
+* `userAgent` property is now read-only. Custom userAgent should be passed as a constructor argument.

README.md

@@ -3,3 +3,89 @@
 This package binds to Cronet's [native API](https://chromium.googlesource.com/chromium/src/+/master/components/cronet/native/test_instructions.md) to expose them in Dart.
 
 This is a [GSoC 2021 project](https://summerofcode.withgoogle.com/projects/#4757095741652992).
+
+## Usage
+
+1. Add package as a dependency in your `pubspec.yaml`.
+
+2. Run this from the `root` of your project.
+
+   **Dart CLI**
+
+   ```bash
+   dart pub get
+   dart run cronet <platform> # Downloads the cronet binaries.
+   ```
+
+   **Flutter**
+
+   ```bash
+   flutter pub get
+   flutter run cronet <platform> # Downloads the cronet binaries.
+   ```
+
+   Supported platforms: `linux64` and `windows64`.
+
+3. Import
+
+   ```dart
+   import 'package:cronet/cronet.dart';
+   ```
+
+**Note:** Internet connection is required to download cronet binaries.
+
+## Example
+
+### `dart:io` style API
+
+```dart
+  final client = HttpClient();
+  client
+      .getUrl(Uri.parse('http://info.cern.ch/'))
+      .then((HttpClientRequest request) {
+    return request.close();
+  }).then((HttpClientResponse response) {
+    response.transform(utf8.decoder).listen((contents) {
+      print(contents);
+    },
+      onDone: () => print(
+        'Done!'));
+  });
+```
+
+### Alternate API
+
+```dart
+  final client = HttpClient();
+  client
+      .getUrl(Uri.parse('http://info.cern.ch/'))
+      .then((HttpClientRequest request) {
+    request.registerCallbacks((data, bytesRead, responseCode) {
+      print(utf8.decoder.convert(data));
+      print('Status: $responseCode');
+    },
+        onSuccess: (responseCode) =>
+            print('Done with status: $responseCode')).catchError(
+        (Object e) {print(e);});
+  });
+```
+
+## Run Example
+
+```bash
+cd example_dart
+dart run cronet <platform> # Downloads the cronet binaries.
+dart run
+```
+
+Replace `<platform>` with `linux64` or `windows64`.
+
+## Run Tests
+
+```bash
+dart pub get
+dart run cronet <platform> # Downloads the cronet binaries.
+dart test --platform vm
+```
+
+**Wrapper & Cronet binaries build guide**: [BUILD.md](lib/src/native/wrapper/BUILD.md)

analysis_options.yaml

@@ -3,3 +3,8 @@
 # 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

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,40 @@
+group 'com.example.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'
+    }
+    defaultConfig {
+        minSdkVersion 16
+    }
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}

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,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="com.example.cronet">
+</manifest>

android/src/main/kotlin/com/example/cronet/CronetPlugin.kt

@@ -0,0 +1,36 @@
+package com.example.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
+
+/** 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) {
+    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/cronet.dart

@@ -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.
+
+import 'package:cronet/src/prepare_cronet.dart';
+
+Future<void> main(List<String> platforms) async {
+  for (final platform in platforms) {
+    if (platform.startsWith('linux')) {
+      buildWrapper();
+    }
+    await downloadCronetBinaries(platform);
+  }
+}

cronet.iml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/.dart_tool" />
+      <excludeFolder url="file://$MODULE_DIR$/.idea" />
+      <excludeFolder url="file://$MODULE_DIR$/.pub" />
+      <excludeFolder url="file://$MODULE_DIR$/build" />
+      <excludeFolder url="file://$MODULE_DIR$/example/.pub" />
+      <excludeFolder url="file://$MODULE_DIR$/example/build" />
+    </content>
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Dart Packages" level="project" />
+    <orderEntry type="library" name="Dart SDK" level="project" />
+    <orderEntry type="library" name="Flutter Plugins" level="project" />
+  </component>
+</module>