forci/http-logger-bundle

A Symfony 3.0 Bundle for hosting HTTP Request/Responses, as well as exceptions that occur during the handling of those

Purpose

The purpose of this Bundle is to log HTTP Request/Responses in logs. In addition to that, you can host exceptions (\Throwable). This is especially useful when working with terribly written APIs you have no control of, that tend to easily break libxml (and thus Symfony's Crawler)., _(*1)

Presentation

At this point, the bundle has no presentation of the data it collects. You should implement that on your own., _(*2)

Basic Usage

<?php

/** @var \Forci\Bundle\HttpLogger\Logger\AbstractLogger $manager */
$manager = $this->container->get('some.logger');
/** @var \Forci\Bundle\HttpLogger\Entity\RequestLog $log */
$log = $manager->log('This is some message with any information that would eventually help you once you need to debug something');

try {
    $client = new \GuzzleHttp\Client();
    $request = new \GuzzleHttp\Psr7\Request('GET', 'http://some-website.com/');

    $manager->logRequest($log, $request, \Forci\Bundle\HttpLogger\Entity\RequestLogMessageType::ID_TEXT_PLAIN);

    $response = $client->send($request);

    $manager->logResponse($log, $response, \Forci\Bundle\HttpLogger\Entity\RequestLogMessageType::ID_HTML);

    $ex = new \Exception('First Exception');

    throw new \Exception('Second Exception', 0, $ex);
} catch (\Throwable $e) {
    $manager->logException($log, $e);
}

Advanced Usage

<?php

$log = $this->log('SomeClass::someMethod()');

try {
    $request = new \GuzzleHttp\Psr7\Request('POST', 'https://someUri.com/API', [
        \GuzzleHttp\RequestOptions::BODY => 'SomeBody'
    ]);

    $this->logRequest($log, $request, \Forci\Bundle\HttpLogger\Entity\RequestLogMessageType::ID_XML);

    $this->pool->sendAsync($request, function (\Psr\Http\Message\ResponseInterface $response) use ($log) {
        try {
            $rawResponse = $response->getBody()->getContents();

            $this->logResponse($log, $response, \Forci\Bundle\HttpLogger\Entity\RequestLogMessageType::ID_XML);

            /** @var \Symfony\Component\DomCrawler\Crawler $crawler */
            $crawler = new \Symfony\Component\DomCrawler\Crawler($rawResponse);

            try {
                $crawler->filterXPath('//some/path');
                // do some Crawler work
            } catch (\InvalidArgumentException $ex) {
                $this->exception($log, $ex, $crawler->html());
            }
        } catch (\Throwable $ex) {
            $this->exception($log, $ex);
        }
    }, function (\GuzzleHttp\Exception\RequestException $ex) use ($log) {
        $this->requestException($log, $ex, \Forci\Bundle\HttpLogger\Entity\RequestLogMessageType::ID_XML);
    });
} catch (\Throwable $ex) {
    $this->exception($log, $ex);
}

There is also a method called "logGuzzleException". It is a shorthand for logging the response, if any, upon HTTP 500 and such. Keep in mind that this is a very basic example. The real power of this bundle comes when you have to execute tons of requests asynchronously, without human overview, via curl, and where it is painfully hard to find which one exactly went broke, without proper logging., _(*3)

Installation & Setup

config.yml

forci_http_logger:
    configs:
        bookings:
            table_prefix: some_logs__
            log_class: Some\Name\Space\RequestLog
            log_message_class: Some\Name\Space\RequestLogMessage
            log_message_type_class: Some\Name\Space\RequestLogMessageType
            log_exception_class: Some\Name\Space\RequestLogException

AppKernel

<?php

// Add this to your AppKernel.php
$bundles = [
    // ...
    new \Forci\Bundle\HttpLogger\ForciHttpLoggerBundle(),
    // ...
];

You need to extend each of the entities and create your own. You can freely add any additional fields and map them via your preferred method. The base mapping is done via a Subscriber in the bundle., _(*4)

<?php

namespace Some\Name\Space;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="SomeRepositoryClass")
 */
class YourRequestLog extends \Forci\Bundle\HttpLogger\Entity\RequestLog {

    /**
     * @ORM\ManyToOne(targetEntity="Some\Name\Space\SomeOtherEntity", inversedBy="inverseSideField")
     * @ORM\JoinColumn(name="relation_id", referencedColumnName="id", nullable=alse)
     */
    protected $someOtherEntity;

}    

Finally, before you can use the logger, you must create a Logger that extends \Wucdbm\Bundle\WucdbmHttpLoggerBundle\Logger\AbstractLogger You must implement the factory methods for creating each of your entities. This may be automated in future versions, so I would advise against creating constructors on these, unless I get enough time and get a proper implementation using an interface and a base factory that just works out of the box., _(*5)

<?php

namespace App\Logger;

// any other use, dopped for brevity
use Forci\Bundle\HttpLogger\Logger\AbstractLogger;

class YourRequestLogLogger extends AbstractLogger {

    /**
     * @return YourRequestLog
     */
    public function createLog() {
        return new YourRequestLog();
    }

    /**
     * @return RequestLogMessage
     */
    public function createLogMessage() {
        return new RequestLogMessage();
    }

    /**
     * @return RequestLogException
     */
    public function createLogException() {
        return new RequestLogException();
    }

    /**
     * @return RequestLogMessageType
     */
    public function createLogMessageType() {
        return new RequestLogMessageType();
    }

    /**
     * @return YourRequestLog
     */
    public function log(string $msg, SomeOtherEntity $entity) {
        /** @var RequestLog $log */
        $log = parent::_log($msg);

        $log->setSomeOtherEntity($entity);

        $this->save($log);

        return $log;
    }

}