Added OnHttpCall hook to the Client (#62)

Author: f3ath

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0] - 2019-12-04
+### Added
+- `onHttpCall` hook to enable raw http request/response logging ([#60](https://github.com/f3ath/json-api-dart/issues/60)).
+
 ## [2.0.3] - 2019-09-29
 ### Fixed
 - Documentation links got broken due to pub.dev update.

lib/src/client/client.dart

@@ -17,12 +17,20 @@ import 'package:json_api/src/document_builder.dart';
 /// JSON:API client
 class JsonApiClient {
   static const contentType = 'application/vnd.api+json';
-
   final http.Client httpClient;
+  final OnHttpCall _onHttpCall;
   final SimpleDocumentBuilder _build;
 
-  const JsonApiClient(this.httpClient, {SimpleDocumentBuilder builder})
-      : _build = builder ?? const DocumentBuilder();
+  /// Creates an instance of JSON:API client.
+  /// You have to create and pass an instance of the [httpClient] yourself.
+  /// Do not forget to call [httpClient.close()] when you're done using
+  /// the JSON:API client.
+  /// The [onHttpCall] hook, if passed,  gets called when an http response is
+  /// received from the HTTP Client.
+  const JsonApiClient(this.httpClient,
+      {SimpleDocumentBuilder builder, OnHttpCall onHttpCall})
+      : _build = builder ?? const DocumentBuilder(),
+        _onHttpCall = onHttpCall ?? _doNothing;
 
   /// Fetches a resource collection by sending a GET query to the [uri].
   /// Use [headers] to pass extra HTTP headers.
@@ -161,7 +169,7 @@ class JsonApiClient {
       http.Request request, D decodePrimaryData(Object _)) async {
     final response =
         await http.Response.fromStream(await httpClient.send(request));
-
+    _onHttpCall(request, response);
     if (response.body.isEmpty) {
       return Response(response.statusCode, response.headers);
     }
@@ -177,3 +185,9 @@ class JsonApiClient {
             body == null ? null : Document.decodeJson(body, decodePrimaryData));
   }
 }
+
+/// Defines the hook which gets called when the HTTP response is received from
+/// the HTTP Client.
+typedef void OnHttpCall(http.Request request, http.Response response);
+
+_doNothing(http.Request request, http.Response response) {}

pubspec.yaml

@@ -1,15 +1,15 @@
-author: "Alexey Karapetov <karapetov@gmail.com>"
-description: "JSON:API Client for Flutter, Web and VM. Supports JSON:API v1.0 (http://jsonapi.org)"
-homepage: "https://github.com/f3ath/json-api-dart"
-name: "json_api"
-version: "2.0.3"
+name: json_api
+author: Alexey Karapetov <karapetov@gmail.com>
+version: 2.1.0
+homepage: https://github.com/f3ath/json-api-dart
+description: JSON:API Client for Flutter, Web and VM. Supports JSON:API v1.0 (http://jsonapi.org)
+environment:
+  sdk: '>=2.3.0 <3.0.0'
 dependencies:
-  collection: "^1.14.11"
-  http: "^0.12.0"
+  http: ^0.12.0
+  collection: ^1.14.11
 dev_dependencies:
-  json_matcher: "^0.2.3"
-  stream_channel: "^1.6.8"
-  test: "^1.6.1"
-  uuid: "^2.0.1"
-environment:
-  sdk: ">=2.3.0 <3.0.0"
+  test: ^1.6.1
+  json_matcher: ^0.2.3
+  stream_channel: ^1.6.8
+  uuid: ^2.0.1

test/functional/browser_compat_test.dart

@@ -1,18 +1,29 @@
-import 'package:http/http.dart';
+import 'package:http/http.dart' as http;
 import 'package:json_api/json_api.dart';
 import 'package:test/test.dart';
 
 void main() async {
+  http.Request request;
+  http.Response response;
+  final httpClient = http.Client();
+  final client = JsonApiClient(httpClient, onHttpCall: (req, resp) {
+    request = req;
+    response = resp;
+  });
+
   test('can fetch collection', () async {
     final channel = spawnHybridUri('test_server.dart');
-    final httpClient = Client();
-    final client = JsonApiClient(httpClient);
     final port = await channel.stream.first;
     final r = await client
         .fetchCollection(Uri.parse('http://localhost:$port/companies'));
+
     httpClient.close();
     expect(r.status, 200);
     expect(r.isSuccessful, true);
     expect(r.data.unwrap().first.attributes['name'], 'Tesla');
+
+    expect(request, isNotNull);
+    expect(response, isNotNull);
+    expect(response.body, isNotEmpty);
   }, testOn: 'browser');
 }

test/functional/hooks_test.dart

@@ -0,0 +1,42 @@
+import 'dart:io';
+
+import 'package:http/http.dart' as http;
+import 'package:json_api/json_api.dart';
+import 'package:json_api/server.dart';
+import 'package:test/test.dart';
+
+import '../../example/cars_server.dart';
+
+void main() async {
+  HttpServer server;
+  http.Client httpClient;
+  JsonApiClient client;
+  http.Request request;
+  http.Response response;
+  final port = 8083;
+  final urlDesign = PathBasedUrlDesign(Uri.parse('http://localhost:$port'));
+
+  setUp(() async {
+    httpClient = http.Client();
+    client = JsonApiClient(httpClient, onHttpCall: (req, resp) {
+      request = req;
+      response = resp;
+    });
+    server = await createServer(InternetAddress.loopbackIPv4, port);
+  });
+
+  tearDown(() async {
+    httpClient.close();
+    await server.close();
+  });
+
+  group('hooks', () {
+    test('onHttpCall gets called', () async {
+      await client.fetchCollection(urlDesign.collection('companies'));
+
+      expect(request, isNotNull);
+      expect(response, isNotNull);
+      expect(response.body, isNotEmpty);
+    });
+  }, testOn: 'vm');
+}