Use package:http_image_provider in all Client implementation examples (#1089)

Author: brianquinlan

.github/workflows/cronet.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Make cronet_http_embedded copy
         if: ${{ matrix.package == 'cronet_http_embedded' }}
         run: |
-          cp -r pkgs/cronet_http pkgs/cronet_http_embedded
+          mv pkgs/cronet_http pkgs/cronet_http_embedded
           cd pkgs/cronet_http_embedded
           flutter pub get && dart tool/prepare_for_embedded.dart
       - id: install

pkgs/cronet_http/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.1-wip
+
+* Use `package:http_image_provider` in the example application.
+
 ## 1.0.0
 
 * No functional changes. 

pkgs/cronet_http/README.md

@@ -37,7 +37,7 @@ import 'package:http/http.dart';
 import 'package:http/io_client.dart';
 
 void main() async {
-  late Client httpClient;
+  final Client httpClient;
   if (Platform.isAndroid) {
     final engine = CronetEngine.build(
         cacheMode: CacheMode.memory,

pkgs/cronet_http/example/lib/book.dart

@@ -5,7 +5,7 @@
 class Book {
   String title;
   String description;
-  String imageUrl;
+  Uri imageUrl;
 
   Book(this.title, this.description, this.imageUrl);
 
@@ -21,7 +21,7 @@ class Book {
                 'description': final String description,
                 'imageLinks': {'smallThumbnail': final String thumbnail}
               }) {
-            books.add(Book(title, description, thumbnail));
+            books.add(Book(title, description, Uri.parse(thumbnail)));
           }
         }
       }

pkgs/cronet_http/example/lib/main.dart

@@ -5,21 +5,31 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:cached_network_image/cached_network_image.dart';
 import 'package:cronet_http/cronet_http.dart';
 import 'package:flutter/material.dart';
 import 'package:http/http.dart';
+import 'package:http/io_client.dart';
+import 'package:http_image_provider/http_image_provider.dart';
+import 'package:provider/provider.dart';
 
 import 'book.dart';
 
 void main() {
-  var clientFactory = Client.new; // Constructs the default client.
+  final Client httpClient;
   if (Platform.isAndroid) {
     final engine = CronetEngine.build(
-        cacheMode: CacheMode.memory, userAgent: 'Book Agent');
-    clientFactory = () => CronetClient.fromCronetEngine(engine);
+        cacheMode: CacheMode.memory,
+        cacheMaxSize: 2 * 1024 * 1024,
+        userAgent: 'Book Agent');
+    httpClient = CronetClient.fromCronetEngine(engine);
+  } else {
+    httpClient = IOClient(HttpClient()..userAgent = 'Book Agent');
   }
-  runWithClient(() => runApp(const BookSearchApp()), clientFactory);
+
+  runApp(Provider<Client>(
+      create: (_) => httpClient,
+      child: const BookSearchApp(),
+      dispose: (_, client) => client.close()));
 }
 
 class BookSearchApp extends StatelessWidget {
@@ -44,20 +54,22 @@ class HomePage extends StatefulWidget {
 class _HomePageState extends State<HomePage> {
   List<Book>? _books;
   String? _lastQuery;
+  late Client _client;
 
   @override
   void initState() {
     super.initState();
+    _client = context.read<Client>();
   }
 
   // Get the list of books matching `query`.
   // The `get` call will automatically use the `client` configurated in `main`.
   Future<List<Book>> _findMatchingBooks(String query) async {
-    final response = await get(
+    final response = await _client.get(
       Uri.https(
         'www.googleapis.com',
         '/books/v1/volumes',
-        {'q': query, 'maxResults': '40', 'printType': 'books'},
+        {'q': query, 'maxResults': '20', 'printType': 'books'},
       ),
     );
 
@@ -129,11 +141,10 @@ class _BookListState extends State<BookList> {
         itemBuilder: (context, index) => Card(
           key: ValueKey(widget.books[index].title),
           child: ListTile(
-            leading: CachedNetworkImage(
-                placeholder: (context, url) =>
-                    const CircularProgressIndicator(),
-                imageUrl:
-                    widget.books[index].imageUrl.replaceFirst('http', 'https')),
+            leading: Image(
+                image: HttpImage(
+                    widget.books[index].imageUrl.replace(scheme: 'https'),
+                    client: context.read<Client>())),
             title: Text(widget.books[index].title),
             subtitle: Text(widget.books[index].description),
           ),

pkgs/cronet_http/example/pubspec.yaml

@@ -7,13 +7,14 @@ environment:
   sdk: ^3.0.0
 
 dependencies:
-  cached_network_image: ^3.2.3
   cronet_http:
     path: ../
   cupertino_icons: ^1.0.2
   flutter:
     sdk: flutter
   http: ^1.0.0
+  http_image_provider: ^0.0.2
+  provider: ^6.1.1
 
 dev_dependencies:
   dart_flutter_team_lints: ^2.0.0

pkgs/cronet_http/pubspec.yaml

@@ -1,5 +1,5 @@
 name: cronet_http
-version: 1.0.0
+version: 1.0.1-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

pkgs/cupertino_http/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.1-wip
+
+* Use `package:http_image_provider` in the example application.
+
 ## 1.2.0
 
 * Add support for setting additional http headers in

pkgs/cupertino_http/README.md

@@ -24,49 +24,25 @@ This approach allows the same HTTP code to be used on all platforms, while
 still allowing platform-specific setup.
 
 ```dart
-late Client client;
-if (Platform.isIOS) {
-  final config = URLSessionConfiguration.ephemeralSessionConfiguration()
-    ..allowsCellularAccess = false
-    ..allowsConstrainedNetworkAccess = false
-    ..allowsExpensiveNetworkAccess = false;
-  client = CupertinoClient.fromSessionConfiguration(config);
-} else {
-  client = IOClient(); // Uses an HTTP client based on dart:io
-}
-
-final response = await client.get(Uri.https(
-    'www.googleapis.com',
-    '/books/v1/volumes',
-    {'q': 'HTTP', 'maxResults': '40', 'printType': 'books'}));
-```
-
-[package:http runWithClient][] can be used to configure the
-[package:http Client][] for the entire application.
-
-```dart
-void main() {
-  late Client client;
-  if (Platform.isIOS) {
-    client = CupertinoClient.defaultSessionConfiguration();
+import 'package:cupertino_http/cupertino_http.dart';
+import 'package:http/http.dart';
+import 'package:http/io_client.dart';
+
+void main() async {
+  final Client httpClient;
+  if (Platform.isIOS || Platform.isMacOS) {
+    final config = URLSessionConfiguration.ephemeralSessionConfiguration()
+      ..cache = URLCache.withCapacity(memoryCapacity: 2 * 1024 * 1024)
+      ..httpAdditionalHeaders = {'User-Agent': 'Book Agent'};
+    httpClient = CupertinoClient.fromSessionConfiguration(config);
   } else {
-    client = IOClient();
+    httpClient = IOClient(HttpClient()..userAgent = 'Book Agent');
   }
 
-  runWithClient(() => runApp(const MyApp()), () => client);
-}
-
-...
-
-class MainPageState extends State<MainPage> {
-  void someMethod() {
-    // Will use the Client configured in main.
-    final response = await get(Uri.https(
-        'www.googleapis.com',
-        '/books/v1/volumes',
-        {'q': 'HTTP', 'maxResults': '40', 'printType': 'books'}));
-  }
-  ...
+  final response = await client.get(Uri.https(
+      'www.googleapis.com',
+      '/books/v1/volumes',
+      {'q': 'HTTP', 'maxResults': '40', 'printType': 'books'}));
 }
 ```
 
@@ -88,6 +64,5 @@ task.resume();
 ```
 
 [package:http Client]: https://pub.dev/documentation/http/latest/http/Client-class.html
-[package:http runWithClient]: https://pub.dev/documentation/http/latest/http/runWithClient.html
 [Foundation URL Loading System]: https://developer.apple.com/documentation/foundation/url_loading_system
 [dart:io HttpClient]: https://api.dart.dev/stable/dart-io/HttpClient-class.html

pkgs/cupertino_http/example/lib/book.dart

@@ -5,7 +5,7 @@
 class Book {
   String title;
   String description;
-  String imageUrl;
+  Uri imageUrl;
 
   Book(this.title, this.description, this.imageUrl);
 
@@ -21,7 +21,7 @@ class Book {
                 'description': final String description,
                 'imageLinks': {'smallThumbnail': final String thumbnail}
               }) {
-            books.add(Book(title, description, thumbnail));
+            books.add(Book(title, description, Uri.parse(thumbnail)));
           }
         }
       }

pkgs/cupertino_http/example/lib/main.dart

@@ -5,22 +5,30 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:cached_network_image/cached_network_image.dart';
 import 'package:cupertino_http/cupertino_http.dart';
 import 'package:flutter/material.dart';
 import 'package:http/http.dart';
+import 'package:http/io_client.dart';
+import 'package:http_image_provider/http_image_provider.dart';
+import 'package:provider/provider.dart';
 
 import 'book.dart';
 
 void main() {
-  var clientFactory = Client.new; // The default Client.
+  final Client httpClient;
   if (Platform.isIOS || Platform.isMacOS) {
     final config = URLSessionConfiguration.ephemeralSessionConfiguration()
       ..cache = URLCache.withCapacity(memoryCapacity: 2 * 1024 * 1024)
       ..httpAdditionalHeaders = {'User-Agent': 'Book Agent'};
-    clientFactory = () => CupertinoClient.fromSessionConfiguration(config);
+    httpClient = CupertinoClient.fromSessionConfiguration(config);
+  } else {
+    httpClient = IOClient(HttpClient()..userAgent = 'Book Agent');
   }
-  runWithClient(() => runApp(const BookSearchApp()), clientFactory);
+
+  runApp(Provider<Client>(
+      create: (_) => httpClient,
+      child: const BookSearchApp(),
+      dispose: (_, client) => client.close()));
 }
 
 class BookSearchApp extends StatelessWidget {
@@ -45,20 +53,22 @@ class HomePage extends StatefulWidget {
 class _HomePageState extends State<HomePage> {
   List<Book>? _books;
   String? _lastQuery;
+  late Client _client;
 
   @override
   void initState() {
     super.initState();
+    _client = context.read<Client>();
   }
 
   // Get the list of books matching `query`.
   // The `get` call will automatically use the `client` configurated in `main`.
   Future<List<Book>> _findMatchingBooks(String query) async {
-    final response = await get(
+    final response = await _client.get(
       Uri.https(
         'www.googleapis.com',
         '/books/v1/volumes',
-        {'q': query, 'maxResults': '40', 'printType': 'books'},
+        {'q': query, 'maxResults': '20', 'printType': 'books'},
       ),
     );
 
@@ -130,11 +140,10 @@ class _BookListState extends State<BookList> {
         itemBuilder: (context, index) => Card(
           key: ValueKey(widget.books[index].title),
           child: ListTile(
-            leading: CachedNetworkImage(
-                placeholder: (context, url) =>
-                    const CircularProgressIndicator(),
-                imageUrl:
-                    widget.books[index].imageUrl.replaceFirst('http', 'https')),
+            leading: Image(
+                image: HttpImage(
+                    widget.books[index].imageUrl.replace(scheme: 'https'),
+                    client: context.read<Client>())),
             title: Text(widget.books[index].title),
             subtitle: Text(widget.books[index].description),
           ),

pkgs/cupertino_http/example/pubspec.yaml

@@ -10,13 +10,14 @@ environment:
   flutter: '>=3.10.0'
 
 dependencies:
-  cached_network_image: ^3.2.3
   cupertino_http:
     path: ../
   cupertino_icons: ^1.0.2
   flutter:
     sdk: flutter
   http: ^1.0.0
+  http_image_provider: ^0.0.2
+  provider: ^6.1.1
 
 dev_dependencies:
   convert: ^3.1.1

pkgs/cupertino_http/pubspec.yaml

@@ -1,5 +1,5 @@
 name: cupertino_http
-version: 1.2.0
+version: 1.2.1-wip
 description: >-
   A macOS/iOS Flutter plugin that provides access to the Foundation URL
   Loading System.

pkgs/flutter_http_example/README.md

@@ -9,8 +9,7 @@ A Flutter sample app that illustrates how to configure and use
   including:
 
     * configuration for multiple platforms.
-    * using `runWithClient` and `package:provider` to pass `Client`s through
-      an application.
+    * using `package:provider` to pass `Client`s through an application.
     * writing tests using `MockClient`.
 
 ## The important bits
@@ -34,9 +33,8 @@ This library demonstrates how to:
 
 * import `http_client_factory.dart` or `http_client_factory_web.dart`,
   depending on whether we are targeting the web browser or not.
-* share a `package:http` `Client` by using `runWithClient` and
-  `package:provider`.
-* call `package:http` functions.
+* share a `package:http` `Client` by using `package:provider`.
+* call `package:http` `Client` methods.
 
 ### `widget_test.dart`
 

pkgs/flutter_http_example/lib/book.dart

@@ -5,7 +5,7 @@
 class Book {
   String title;
   String description;
-  String imageUrl;
+  Uri imageUrl;
 
   Book(this.title, this.description, this.imageUrl);
 
@@ -21,7 +21,7 @@ class Book {
                 'description': final String description,
                 'imageLinks': {'smallThumbnail': final String thumbnail}
               }) {
-            books.add(Book(title, description, thumbnail));
+            books.add(Book(title, description, Uri.parse(thumbnail)));
           }
         }
       }