elgigi/har-parser

Library to parse HAR files

v1.0.0-beta5 2022-11-04 17:19 UTC

This package is auto-updated.

Last update: 2022-11-04 17:20:37 UTC


README

Latest Version Software license Build Status Quality Grade Total Downloads

Library to parse and generate HAR file format.

Usage

Load you HAR file with an Parser object or with Log entity.

With Parser class:

use ElGigi\HarParser\Parser;

$harFile = new Parser();

$log = $harFile->parse('/path/of/my/file.har', contentIsFile: true);
$log = $harFile->parse(['my' => 'har decoded']);

With Log entity class:

use ElGigi\HarParser\Entities\Log;

$log = Log::load(json_decode(file_get_contents('/path/of/my/file.har'), true));

Entities

The HAR file is distributed in several entities:

  • Log
    • Creator
    • Browser
    • Page[]
      • PageTimings
    • Entry[]
      • Request
        • Cookie[]
        • Header[]
        • PostData
      • Response
        • Cookie[]
        • Header[]
        • Content
      • Timings

Builder

Two builders are available to construct an HAR file from entities:

  • Builder: build a Log entity from others entities
  • BuilderStream: build directly the JSON file in stream to prevent memory usage

Both implements BuilderInterface:

  • BuilderInterface::reset(): void: reset builder data
  • BuilderInterface::setVersion(string $version): void: define version of HAR file (default: 1.2)
  • BuilderInterface::setCreator(string $creator): void: set creator entity
  • BuilderInterface::setBrowser(string $browser): void: set browser entity
  • BuilderInterface::addPage(Page ...$page): void: add a page entity (or multiple pages)
  • BuilderInterface::addEntry(Entry ...$entry): void: add an entry entity (or multiple entries)
  • BuilderInterface::setComment(?string $comment): void: define comment of HAR file

For stream builder, the constructor attempt a valid resource (writeable and seekable).

For standard builder, the constructor accept an HAR file, for example, complete an existent HAR.

Anonymize HAR

In some cases, like unit tests, you need to anonymize your HAR file.

The Anonymizer class it's do for that!

class Anonymizer
{
    /**
     * Add header to redact.
     *
     * @param string ...$regex
     *
     * @return void
     */
    public function addHeaderToRedact(string ...$regex): void;

    /**
     * Add query string to redact.
     *
     * @param string ...$regex
     *
     * @return void
     */
    public function addQueryStringToRedact(string ...$regex): void;

    /**
     * Add post data to redact.
     *
     * @param string ...$regex
     *
     * @return void
     */
    public function addPostDataToRedact(string ...$regex): void;

    /**
     * Add accepted mime.
     *
     * @param string ...$mime
     *
     * @return void
     */
    public function addAcceptedMime(string ...$mime): void;

    /**
     * Add content to redact.
     *
     * @param array $regexes
     *
     * @return void
     */
    public function addContentToRedact(array $regexes): void;

    /**
     * Add callback.
     *
     * @param callable ...$callback
     *
     * @return void
     */
    public function addCallback(callable ...$callback): void;

    /**
     * Anonymize HAR file.
     *
     * @param Log $log
     *
     * @return Log
     * @throws InvalidArgumentException
     */
    public function anonymize(Log $log): Log;
}