A logging middleware library for the Dart HTTP library

19 August 2023
0
202

pretty_http_logger

A middleware logger library for Dart http library.

Getting Started

pretty_http_logger is a module that lets you log request and response for Dart's http package.

Installing

Include this library in your package.

pretty_http_logger: any

YAML

Importing

import 'package:pretty_http_logger/pretty_http_logger.dart';

Dart

Using `pretty_http_logger`

Create an object of HttpWithMiddleware by using the build factory constructor.

The build constructor takes in a list of middlewares that are built already by pretty_http_logger.

(You can also build your own middleware for `pretty_http_logger`. Check out Build your own middleware)

HttpWithMiddleware http = HttpWithMiddleware.build(middlewares: [
    HttpLogger(logLevel: LogLevel.BODY),
]);

Dart

That is it! Now go ahead and use this http object as you would normally do.

//Simple POST request
var response = await http.post('https://jsonplaceholder.typicode.com/posts/',
    body: {"testing", "1234"});

//Simple GET request
var response = await http.get('https://jsonplaceholder.typicode.com/posts/');

Dart

Request Timeout

With pretty_http_logger you can also specify the timeout of requests. So if you want a request to be timeout in 30 seconds:

HttpWithMiddleware http = HttpWithMiddleware.build(
  requestTimeout: Duration(seconds: 30),
  middlewares: [
    HttpLogger(logLevel: LogLevel.BODY),
]);

Dart

HttpWithMiddleware supports all the functions that http provides.

http.get(...);
http.post(...);
http.put(...);
http.delete(...);
http.head(...);
http.patch(...);
http.read(...);
http.readBytes(...);

Dart

Using a Client

If you want to use a http.Client in order to keep the connection alive with the server, use HttpClientWithMiddleware.

HttpClientWithMiddleware httpClient = HttpClientWithMiddleware.build(middlewares: [
    HttpLogger(logLevel: LogLevel.BODY),
]);

var response = await httpClient.post('https://jsonplaceholder.typicode.com/posts/',
    body: {"testing", "1234"});

var response = await httpClient.get('https://jsonplaceholder.typicode.com/posts/');

//Don't forget to close the client once done.
httpClient.close();

Dart

Building your own middleware

Building your own middleware with pretty_http_logger is very easy, whether you want to create a package for pretty_http_logger or you want to build a middleware solely for your own project.

Once you have the necessary imports, all you have to do is extend the MiddlewareContract class which will give you access to 3 functions.

interceptRequest(RequestData) is the method called before any request is made.

interceptResponse(ResponseData) is the method called after the response from request is received.

interceptError(error) is the method called when an exception occurs.

You can then @override all the required functions you need to add middleware to.

Example (A simple logger that logs data in all requests):

class Logger extends MiddlewareContract {
  @override
  void interceptRequest(RequestData data) {
    print("Method: ${data.method}");
    print("Url: ${data.url}");
    print("Body: ${data.body}");
  }

  @override
  void interceptResponse(ResponseData data) {
    print("Status Code: ${data.statusCode}");
    print("Method: ${data.method}");
    print("Url: ${data.url}");
    print("Body: ${data.body}");
    print("Headers: ${data.headers}");
  }
  @override
  void interceptError(err) {
    print("Error: $err");
  }
}

Dart

You can also modify the RequestData before the request is made and every ResponseData after every response is received. For Example, if you want to wrap your data in a particular structure before sending, or you want every request header to have Content-Type set to application/json.

class Logger extends MiddlewareContract {
  @override
  void interceptRequest(RequestData data) {
    //Adding content type to every request
    data.headers["Content-Type"] = "application/json";
    
    data.body = jsonEncode({
      uniqueId: "some unique id",
      data: data.body,
    });
  }

  @override
  void interceptResponse(ResponseData data) {
    //Unwrapping response from a structure
    data.body = jsonDecode(data.body)["data"];
  }
  @override
  void interceptError(err) {
    print("Error: $err");
  }
}

Dart

Package `pretty_http_logger` is inspired by

pretty_http_logger(https://github.com/mithunadhikari40/pretty_http_logger) : Easy request and response logging.
pretty_http_logger is inspired by http_logger(https://github.com/gurleensethi/http_logger)
pretty_http_logger is inspired by http_middleware(https://github.com/TEDConsulting/http_middleware)
pretty_http_logger is inspired by pretty_dio_logger(https://github.com/Milad-Akarie/pretty_dio_logger)
pretty_http_logger is a combination of packages mentioned above and uses the code provided by these libraries and keeps everything up to date