phpunit-bridge/HttpRecorder.php at 8.2 · symfony/phpunit-bridge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Bridge\PhpUnit;

use Symfony\Component\HttpClient\Recorder\RecorderConfigurationInterface;
use Symfony\Component\HttpClient\Recorder\RecorderMode;

/**
 * Process-wide recorder configuration driven by #[UseRecord], read by RecorderHttpClient at each request.
 */
final class HttpRecorder implements RecorderConfigurationInterface
{
    private static RecorderMode $mode = RecorderMode::Passthrough;
    private static string $harFilePath = '';
    private static array $consumedEntries = [];
    private static array $misses = [];
    private static array $recordedEntries = [];

    /**
     * Starts a recording session, which ends with the next call to this method or to reset().
     *
     * In record mode, a session continues the ones recorded earlier in the process into the same file, so that the tests sharing a file all add their entries to it.
     */
    public static function configure(RecorderMode $mode, string $harFilePath): void
    {
        self::$mode = $mode;
        self::$harFilePath = $harFilePath;
        self::$consumedEntries = RecorderMode::Record === $mode ? self::$recordedEntries[$harFilePath] ?? [] : [];
        self::$misses = [];
    }

    public static function reset(): void
    {
        self::$mode = RecorderMode::Passthrough;
        self::$harFilePath = '';
        self::$consumedEntries = [];
        self::$misses = [];
    }

    /**
     * @return list<string> The requests of the current session that had no recorded response, as "METHOD url"
     *
     * @internal
     */
    public static function getMisses(): array
    {
        return self::$misses;
    }

    public function getMode(): RecorderMode
    {
        return self::$mode;
    }

    public function getHarFilePath(): string
    {
        return self::$harFilePath;
    }

    public function getConsumedEntries(): array
    {
        return self::$consumedEntries;
    }

    public function consumeEntry(int $index): void
    {
        self::$consumedEntries[] = $index;

        if (RecorderMode::Record === self::$mode) {
            self::$recordedEntries[self::$harFilePath][] = $index;
        }
    }

    public function reportMiss(string $method, string $url): void
    {
        self::$misses[] = $method.' '.$url;
    }
}