Migrate Essentials v0.0.1: Implement Client with openUrl method (#2)

Author: unsuitable001

.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: dart run cronet:setup
       - name: Run VM tests
         run: dart test --platform vm
         if: always() && steps.install.outcome == 'success'

.gitignore

@@ -6,6 +6,9 @@
 build/
 pubspec.lock
 
+# cmake build directories
+out
+
 # Directory created by dartdoc.
 doc/api/
 
@@ -33,3 +36,35 @@ compile_commands.json
 
 # Mac
 .DS_Store
+
+# Cronet pre-built binaries
+cronet_binaries/
+
+# Generated shared libraries.
+*.so
+*.so.*
+*.dylib
+*.dll
+*.lib
+
+# Compiled executables.
+*.o
+*.out
+
+# 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

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,74 @@
 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).
+
+## Supported Platforms
+
+Currently, 64 bit Linux and Windows systems are supported.
+
+## 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:setup # Downloads the cronet binaries.
+   ```
+
+3. Import
+
+   ```dart
+   import 'package:cronet/cronet.dart';
+   ```
+
+**Note:** Internet connection is required to download cronet binaries.
+
+## Example
+
+```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!'));
+  });
+```
+
+[See the API comparison with `dart:io`.](dart_io_comparison.md)
+
+## Run Example
+
+```bash
+cd example_dart
+dart run cronet:setup # Downloads the cronet binaries.
+dart run
+```
+
+## Run Tests
+
+```bash
+dart pub get
+dart run cronet:setup # Downloads the cronet binaries.
+dart test --platform vm
+```
+
+You can also verify your cronet binaries using `dart run cronet:setup verify`.
+Make sure to have `cmake 3.15`.
+
+## Building Your Own
+
+1. Make sure you've downloaded your custom version of cronet shared library and filename follows the pattern `cronet.86.0.4240.198.<extension>` with a prefix `lib` if on `linux`. Else, you can build cronet from [source](https://www.chromium.org/developers/how-tos/get-the-code) using the [provided instuctions](https://chromium.googlesource.com/chromium/src/+/master/components/cronet/build_instructions.md). Then copy the library to the designated folder. For linux, the files are under `.dart_tool/cronet/linux64`.
+
+2. Run `dart run cronet:setup build` from the root of your project.
+
+**Note for Windows:** Run `step 2` from `x64 Native Tools Command Prompt for VS 2019` shell.

analysis_options.yaml

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

bin/setup.dart

@@ -0,0 +1,192 @@
+// 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:io';
+
+import 'package:archive/archive.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';
+
+// Extracts a tar.gz file.
+void extract(String fileName, [String dir = '']) {
+  final tarGzFile = File(fileName).readAsBytesSync();
+  final archive = GZipDecoder().decodeBytes(tarGzFile, verify: true);
+  final tarData = TarDecoder().decodeBytes(archive, verify: true);
+  for (final file in tarData) {
+    final filename = file.name;
+    if (file.isFile) {
+      final data = file.content as List<int>;
+      File(dir + filename)
+        ..createSync(recursive: true)
+        ..writeAsBytesSync(data);
+    } else {
+      Directory(dir + filename).createSync(recursive: true);
+    }
+  }
+}
+
+/// 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);
+  logger.stdout('Done! Cleaning up...');
+
+  File(fileName).deleteSync();
+  logger.stdout(
+      '${ansi.green}Done! Cronet support for $platform is now available!'
+      '${ansi.none}');
+}
+
+/// Download `cronet` library from Github Releases.
+Future<void> downloadCronetBinaries(String platform) async {
+  final logger = Logger.standard();
+  final ansi = Ansi(Ansi.terminalSupportsAnsi);
+  if (!isCronetAvailable(platform)) {
+    final fileName = platform + '.tar.gz';
+    logger.stdout('Downloading Cronet for $platform');
+    final downloadUrl = cronetBinaryUrl + fileName;
+    logger.stdout(downloadUrl);
+    try {
+      final httpClient = HttpClient();
+      final request = await httpClient.getUrl(Uri.parse(downloadUrl));
+      final response = await request.close();
+      final fileSink = File(fileName).openWrite();
+      await response.pipe(fileSink);
+      await fileSink.flush();
+      await fileSink.close();
+      httpClient.close();
+    } catch (error) {
+      Exception("Can't download. Check your network connection!");
+    }
+
+    placeBinaries(platform, fileName);
+  } else {
+    logger.stdout('${ansi.yellow}Cronet $platform is already available.'
+        ' No need to download.${ansi.none}');
+  }
+}
+
+/// Builds wrapper from source for the current platform.
+void buildWrapper() {
+  final logger = Logger.standard();
+  final ansi = Ansi(Ansi.terminalSupportsAnsi);
+  final wrapperPath = wrapperSourcePath();
+  final pwd = Directory.current;
+  Directory.current = Directory(wrapperPath);
+  logger.stdout('Building Wrapper...');
+  try {
+    final result = Process.runSync(
+        'cmake', ['CMakeLists.txt', '-B', 'out/${Platform.operatingSystem}']);
+    print(result.stdout);
+    print(result.stderr);
+  } catch (error) {
+    Directory.current = pwd;
+    logger.stdout("${ansi.red}Build failed.${ansi.none}");
+    if (Platform.isWindows) {
+      logger.stdout(
+          'Open ${ansi.yellow}x64 Native Tools Command Prompt for VS 2019.'
+          '${ansi.none} Then run:\n'
+          'cd ${pwd.path}\ndart run cronet:setup build');
+    }
+    return;
+  }
+  var result =
+      Process.runSync('cmake', ['--build', 'out/${Platform.operatingSystem}']);
+  print(result.stdout);
+  print(result.stderr);
+  if (result.exitCode != 0) return;
+  Directory.current = pwd;
+  final moveLocation = '$binaryStorageDir${Platform.operatingSystem}64';
+  Directory(moveLocation).createSync(recursive: true);
+  final buildOutputPath = Platform.isLinux
+      ? '$wrapperPath/out/${Platform.operatingSystem}/${getWrapperName()}'
+      : '$wrapperPath\\out\\${Platform.operatingSystem}\\Debug\\${getWrapperName()}';
+  File(buildOutputPath).copySync('$moveLocation/${getWrapperName()}');
+  logger.stdout(
+      '${ansi.green}Wrapper moved to $moveLocation. Success!${ansi.none}');
+  return;
+}
+
+/// Verify if cronet binary is working correctly.
+void verifyCronetBinary() {
+  final logger = Logger.standard();
+  final ansi = Ansi(Ansi.terminalSupportsAnsi);
+  final sampleSource = findPackageRoot()
+      .resolve('third_party/cronet_sample')
+      .toFilePath(windows: Platform.isWindows);
+  final buildName = Platform.isLinux ? 'cronet_sample' : 'cronet_sample.exe';
+  final pwd = Directory.current;
+  if (!isCronetAvailable('${Platform.operatingSystem}64')) {
+    logger.stderr('${ansi.red}Cronet binaries are not available.${ansi.none}');
+    logger.stdout('Get the cronet binaries by running: dart run cronet:setup');
+    return;
+  }
+
+  logger.stdout('Building Sample...');
+  var result = Process.runSync('cmake', [
+    '$sampleSource/CMakeLists.txt',
+    '-B',
+    '$sampleSource/out/${Platform.operatingSystem}'
+  ], environment: {
+    'CURRENTDIR': pwd.path
+  });
+  print(result.stdout);
+  print(result.stderr);
+  result = Process.runSync(
+      'cmake', ['--build', '$sampleSource/out/${Platform.operatingSystem}'],
+      environment: {'CURRENTDIR': pwd.path});
+  print(result.stdout);
+  print(result.stderr);
+  final buildOutputPath = Platform.isLinux
+      ? '$sampleSource/out/${Platform.operatingSystem}/$buildName'
+      : '$sampleSource\\out\\${Platform.operatingSystem}\\Debug\\$buildName';
+
+  logger.stdout('Copying...');
+  final sample = File(buildOutputPath)
+      .copySync('.dart_tool/cronet/${Platform.operatingSystem}64/$buildName');
+
+  logger.stdout('Verifying...');
+  result = Process.runSync(
+      '.dart_tool/cronet/${Platform.operatingSystem}64/$buildName', []);
+  if (result.exitCode == 0) {
+    logger.stdout('${ansi.green}Verified! Cronet is working fine.${ansi.none}');
+  } else {
+    logger.stderr('${ansi.red}Verification failed!${ansi.none}');
+  }
+  sample.deleteSync();
+}
+
+Future<void> main(List<String> args) async {
+  const docStr = """
+dart run cronet:setup [option]
+Downloads the cronet binaries.\n
+clean\tClean downloaded or built binaries.
+build\tBuilds the wrapper. Requires cmake.
+verify\tVerifies the cronet binary.
+  """;
+  final logger = Logger.standard();
+  if (args.length > 1) {
+    logger.stderr('Expected 1 argument only.');
+    logger.stdout(docStr);
+  } else if (args.contains('-h')) {
+    logger.stdout(docStr);
+  } else if (args.contains('clean')) {
+    logger.stdout('cleaning...');
+    Directory(binaryStorageDir).deleteSync(recursive: true);
+    logger.stdout('Done!');
+  } else if (args.contains('build')) {
+    buildWrapper();
+  } else if (args.contains('verify')) {
+    verifyCronetBinary();
+  } else {
+    // Targeting only 64bit OS. (At least for the time being.)
+    if (validPlatforms.contains('${Platform.operatingSystem}64')) {
+      await downloadCronetBinaries('${Platform.operatingSystem}64');
+    }
+  }
+}

dart_io_comparison.md

@@ -0,0 +1,18 @@
+# Comparing APIs with dart:io
+
+## userAgent
+
+### dart:io
+
+```dart
+final client = HttpClient();
+client.userAgent = 'myUA/1.0'; // using custom UA string.
+print(client.userAgent); // Will print myUA/1.0.
+```
+
+### Cronet
+
+```dart
+final client = HttpClient(userAgent: 'myUA/1.0'); // using custom UA string.
+print(client.userAgent); // Will print myUA/1.0.
+```