TraceableEncoder.php

<?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\Component\Serializer\Debug;

use Symfony\Component\Serializer\DataCollector\SerializerDataCollector;
use Symfony\Component\Serializer\Encoder\DecoderInterface;
use Symfony\Component\Serializer\Encoder\EncoderInterface;
use Symfony\Component\Serializer\Encoder\NormalizationAwareInterface;
use Symfony\Component\Serializer\SerializerAwareInterface;
use Symfony\Component\Serializer\SerializerInterface;

/**
 * Collects some data about encoding.
 *
 * @author Mathias Arlaud <mathias.arlaud@gmail.com>
 *
 * @final
 */
class TraceableEncoder implements EncoderInterface, DecoderInterface, SerializerAwareInterface {
    public function __construct(EncoderInterface|DecoderInterface $encoder, SerializerDataCollector $dataCollector, string $serializerName = 'default') {
    }
    public function encode(mixed $data, string $format, array $context = []) : string {
        if (!$this->encoder instanceof EncoderInterface) {
            throw new \BadMethodCallException(\sprintf('The "%s()" method cannot be called as nested encoder doesn\'t implements "%s".', __METHOD__, EncoderInterface::class));
        }
        $startTime = microtime(true);
        $encoded = $this->encoder
            ->encode($data, $format, $context);
        $time = microtime(true) - $startTime;
        if ($traceId = $context[TraceableSerializer::DEBUG_TRACE_ID] ?? null) {
            $this->dataCollector
                ->collectEncoding($traceId, $this->encoder::class, $time, $this->serializerName);
        }
        return $encoded;
    }
    public function supportsEncoding(string $format, array $context = []) : bool {
        if (!$this->encoder instanceof EncoderInterface) {
            return false;
        }
        return $this->encoder
            ->supportsEncoding($format, $context);
    }
    public function decode(string $data, string $format, array $context = []) : mixed {
        if (!$this->encoder instanceof DecoderInterface) {
            throw new \BadMethodCallException(\sprintf('The "%s()" method cannot be called as nested encoder doesn\'t implements "%s".', __METHOD__, DecoderInterface::class));
        }
        $startTime = microtime(true);
        $encoded = $this->encoder
            ->decode($data, $format, $context);
        $time = microtime(true) - $startTime;
        if ($traceId = $context[TraceableSerializer::DEBUG_TRACE_ID] ?? null) {
            $this->dataCollector
                ->collectDecoding($traceId, $this->encoder::class, $time, $this->serializerName);
        }
        return $encoded;
    }
    public function supportsDecoding(string $format, array $context = []) : bool {
        if (!$this->encoder instanceof DecoderInterface) {
            return false;
        }
        return $this->encoder
            ->supportsDecoding($format, $context);
    }
    public function setSerializer(SerializerInterface $serializer) : void {
        if (!$this->encoder instanceof SerializerAwareInterface) {
            return;
        }
        $this->encoder
            ->setSerializer($serializer);
    }
    public function needsNormalization() : bool {
        return !$this->encoder instanceof NormalizationAwareInterface;
    }
    
    /**
     * Proxies all method calls to the original encoder.
     */
    public function __call(string $method, array $arguments) : mixed {
        return $this->encoder
            ->{$method}(...$arguments);
    }

}