[cronet_http] 🏗️ Use dart-define to determine dependency (#1111)

Author: AlexV525

.github/workflows/cronet.yml

@@ -26,7 +26,10 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        package: ['cronet_http', 'cronet_http_embedded']
+        cronetHttpNoPlay: ['false', 'true']
+    defaults:
+      run:
+        working-directory: pkgs/cronet_http
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       - uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93
@@ -36,23 +39,14 @@ jobs:
       - uses: subosito/flutter-action@2783a3f08e1baf891508463f8c6653c258246225
         with:
           channel: 'stable'
-      - name: Make cronet_http_embedded copy
-        if: ${{ matrix.package == 'cronet_http_embedded' }}
-        run: |
-          mv pkgs/cronet_http pkgs/cronet_http_embedded
-          cd pkgs/cronet_http_embedded
-          flutter pub get && dart tool/prepare_for_embedded.dart
       - id: install
         name: Install dependencies
-        working-directory: 'pkgs/${{ matrix.package }}'
         run: flutter pub get
       - name: Check formatting
         if: always() && steps.install.outcome == 'success'
-        working-directory: 'pkgs/${{ matrix.package }}'
         run: dart format --output=none --set-exit-if-changed .
       - name: Analyze code
         if: always() && steps.install.outcome == 'success'
-        working-directory: 'pkgs/${{ matrix.package }}'
         run: flutter analyze --fatal-infos
       - name: Run tests
         uses: reactivecircus/android-emulator-runner@6b0df4b0efb23bb0ec63d881db79aefbc976e4b2
@@ -64,6 +58,6 @@ jobs:
           # - pkgs/cronet_http/example/android/app/build.gradle
           api-level: 21
           arch: x86_64
-          target: ${{ matrix.package == 'cronet_http_embedded' && 'default' || 'google_apis' }}
+          target: ${{ matrix.cronetHttpNoPlay == 'true' && 'default' || 'google_apis' }}
           profile: pixel
-          script: cd pkgs/${{ matrix.package }}/example && flutter test --timeout=1200s integration_test/
+          script: cd pkgs/cronet_http/example && flutter test --dart-define=cronetHttpNoPlay=${{ matrix.cronetHttpNoPlay }} --timeout=1200s integration_test/

pkgs/cronet_http/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.0-wip
+
+* Support the Cronet embedding dependency with `--dart-define=cronetHttpNoPlay=true`.
+
 ## 1.1.1
 
 * Make it possible to construct `CronetClient` with custom a `CronetEngine`

pkgs/cronet_http/README.md

@@ -2,22 +2,20 @@
 [![package publisher](https://img.shields.io/pub/publisher/cronet_http.svg)](https://pub.dev/packages/cronet_http/publisher)
 
 An Android Flutter plugin that provides access to the
-[Cronet][]
-HTTP client.
+[Cronet][] HTTP client.
 
-Cronet is available as part of
-[Google Play Services][]. 
+Cronet is available as part of [Google Play Services][]
+and as [a standalone embedded library][].
 
-This package depends on [Google Play Services][] for its [Cronet][]
-implementation.
-[`package:cronet_http_embedded`](https://pub.dev/packages/cronet_http_embedded)
-is functionally identical to this package but embeds [Cronet][] directly
-instead of relying on [Google Play Services][].
+This package depends on [Google Play Services][]
+for its [Cronet][] implementation.
+To use the embedded version of [Cronet][] without [Google Play Services][],
+see [Use embedded Cronet](#use-embedded-cronet).
 
 ## Motivation
 
-Using [Cronet][], rather than the socket-based [dart:io HttpClient][]
-implemententation, has several advantages:
+Using [Cronet][], rather than the socket-based
+[dart:io HttpClient][] implementation, has several advantages:
 
 1. It automatically supports Android platform features such as HTTP proxies.
 2. It supports configurable caching.
@@ -40,23 +38,46 @@ void main() async {
   final Client httpClient;
   if (Platform.isAndroid) {
     final engine = CronetEngine.build(
-        cacheMode: CacheMode.memory,
-        cacheMaxSize: 2 * 1024 * 1024,
-        userAgent: 'Book Agent');
+      cacheMode: CacheMode.memory,
+      cacheMaxSize: 2 * 1024 * 1024,
+      userAgent: 'Book Agent',
+    );
     httpClient = CronetClient.fromCronetEngine(engine, isOwned: true);
   } else {
     httpClient = IOClient(HttpClient()..userAgent = 'Book Agent');
   }
 
-  final response = await client.get(Uri.https(
+  final response = await client.get(
+    Uri.https(
       'www.googleapis.com',
       '/books/v1/volumes',
-      {'q': 'HTTP', 'maxResults': '40', 'printType': 'books'}));
+      {'q': 'HTTP', 'maxResults': '40', 'printType': 'books'},
+    ),
+  );
   httpClient.close();
 }
 ```
 
+### Use embedded Cronet
+
+If you want your application to work without [Google Play Services][],
+you can instead depend on the `org.chromium.net:cronet-embedded` package
+by using `dart-define` to set `cronetHttpNoPlay` is set to `true`.
+
+For example:
+
+```
+flutter run --dart-define=cronetHttpNoPlay=true
+```
+
+To use the embedded version in `flutter test`:
+
+```
+flutter test --dart-define=cronetHttpNoPlay=true
+```
+
 [Cronet]: https://developer.android.com/guide/topics/connectivity/cronet/reference/org/chromium/net/package-summary
-[dart:io HttpClient]: https://api.dart.dev/stable/dart-io/HttpClient-class.html
 [Google Play Services]: https://developers.google.com/android/guides/overview
+[a standalone embedded library]: https://mvnrepository.com/artifact/org.chromium.net/cronet-embedded
+[dart:io HttpClient]: https://api.dart.dev/stable/dart-io/HttpClient-class.html
 [package:http Client]: https://pub.dev/documentation/http/latest/http/Client-class.html

pkgs/cronet_http/README_EMBEDDED.md

@@ -21,6 +21,17 @@ rootProject.allprojects {
     }
 }
 
+def dartDefines = [
+    cronetHttpNoPlay: 'false'
+]
+if (project.hasProperty('dart-defines')) {
+    def defines = project.property('dart-defines').split(',').collectEntries { entry ->
+        def pair = new String(entry.decodeBase64(), 'UTF-8').split('=')
+        [(pair.first()): pair.last()]
+    }
+    dartDefines = dartDefines + defines
+}
+
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
@@ -65,5 +76,9 @@ android {
 }
 
 dependencies {
-    implementation "com.google.android.gms:play-services-cronet:18.0.1"
+    if (dartDefines.cronetHttpNoPlay == 'true') {
+        implementation 'org.chromium.net:cronet-embedded:113.5672.61'
+    } else {
+        implementation "com.google.android.gms:play-services-cronet:18.0.1"
+    }
 }

pkgs/cronet_http/android/build.gradle

@@ -1,5 +1,5 @@
 name: cronet_http
-version: 1.1.1
+version: 1.2.0-wip
 description: >-
   An Android Flutter plugin that provides access to the Cronet HTTP client.
 repository: https://github.com/dart-lang/http/tree/master/pkgs/cronet_http