symfony · fabpot · Dec 10, 2024 · Mar 20, 2023
diff --git a/.gitattributes b/.gitattributes
@@ -7,5 +7,7 @@
 /src/Symfony/Component/Translation/Bridge export-ignore
 /src/Symfony/Component/Emoji/Resources/data/* linguist-generated=true
 /src/Symfony/Component/Intl/Resources/data/*/* linguist-generated=true
+/src/Symfony/Component/JsonEncoder/Tests/Fixtures/encoder/* linguist-generated=true
+/src/Symfony/Component/JsonEncoder/Tests/Fixtures/decoder/* linguist-generated=true
 /src/Symfony/**/.github/workflows/close-pull-request.yml linguist-generated=true
 /src/Symfony/**/.github/PULL_REQUEST_TEMPLATE.md linguist-generated=true
diff --git a/composer.json b/composer.json
@@ -83,6 +83,7 @@
         "symfony/http-foundation": "self.version",
         "symfony/http-kernel": "self.version",
         "symfony/intl": "self.version",
+        "symfony/json-encoder": "self.version",
         "symfony/ldap": "self.version",
         "symfony/lock": "self.version",
         "symfony/mailer": "self.version",

diff --git a/src/Symfony/Component/JsonEncoder/.gitattributes b/src/Symfony/Component/JsonEncoder/.gitattributes
@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
diff --git a/src/Symfony/Component/JsonEncoder/.gitignore b/src/Symfony/Component/JsonEncoder/.gitignore
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml
diff --git a/src/Symfony/Component/JsonEncoder/Attribute/Denormalizer.php b/src/Symfony/Component/JsonEncoder/Attribute/Denormalizer.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\Attribute;
+
+/**
+ * Defines a callable or a {@see \Symfony\Component\JsonEncoder\Decode\Denormalizer\DenormalizerInterface} service id
+ * that will be used to denormalize the property data during decoding.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @experimental
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class Denormalizer
+{
+    private string|\Closure $denormalizer;
+
+    /**
+     * @param string|(callable(mixed, array<string, mixed>?): mixed)|(callable(mixed): mixed) $denormalizer
+     */
+    public function __construct(mixed $denormalizer)
+    {
+        if (\is_callable($denormalizer)) {
+            $denormalizer = \Closure::fromCallable($denormalizer);
+        }
+
+        $this->denormalizer = $denormalizer;
+    }
+
+    public function getDenormalizer(): string|\Closure
+    {
+        return $this->denormalizer;
+    }
+}
diff --git a/src/Symfony/Component/JsonEncoder/Attribute/EncodedName.php b/src/Symfony/Component/JsonEncoder/Attribute/EncodedName.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\Attribute;
+
+/**
+ * Defines the encoded property name.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @experimental
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+final class EncodedName
+{
+    public function __construct(
+        private string $name,
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Symfony/Component/JsonEncoder/Attribute/Normalizer.php b/src/Symfony/Component/JsonEncoder/Attribute/Normalizer.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\Attribute;
+
+/**
+ * Defines a callable or a {@see \Symfony\Component\JsonEncoder\Encode\Normalizer\NormalizerInterface} service id
+ * that will be used to normalize the property data during encoding.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @experimental
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class Normalizer
+{
+    private string|\Closure $normalizer;
+
+    /**
+     * @param string|(callable(mixed, array<string, mixed>?): mixed)|(callable(mixed): mixed) $normalizer
+     */
+    public function __construct(mixed $normalizer)
+    {
+        if (\is_callable($normalizer)) {
+            $normalizer = \Closure::fromCallable($normalizer);
+        }
+
+        $this->normalizer = $normalizer;
+    }
+
+    public function getNormalizer(): string|\Closure
+    {
+        return $this->normalizer;
+    }
+}
diff --git a/src/Symfony/Component/JsonEncoder/CHANGELOG.md b/src/Symfony/Component/JsonEncoder/CHANGELOG.md
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+7.3
+---
+
+ * Introduce the component as experimental
diff --git a/src/Symfony/Component/JsonEncoder/CacheWarmer/EncoderDecoderCacheWarmer.php b/src/Symfony/Component/JsonEncoder/CacheWarmer/EncoderDecoderCacheWarmer.php
@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\CacheWarmer;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+use Symfony\Component\JsonEncoder\Decode\DecoderGenerator;
+use Symfony\Component\JsonEncoder\Encode\EncoderGenerator;
+use Symfony\Component\JsonEncoder\Exception\ExceptionInterface;
+use Symfony\Component\JsonEncoder\Mapping\PropertyMetadataLoaderInterface;
+use Symfony\Component\TypeInfo\Type;
+
+/**
+ * Generates encoders and decoders PHP files.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @internal
+ */
+final class EncoderDecoderCacheWarmer implements CacheWarmerInterface
+{
+    private EncoderGenerator $encoderGenerator;
+    private DecoderGenerator $decoderGenerator;
+
+    /**
+     * @param iterable<class-string> $encodableClassNames
+     */
+    public function __construct(
+        private iterable $encodableClassNames,
+        PropertyMetadataLoaderInterface $encodePropertyMetadataLoader,
+        PropertyMetadataLoaderInterface $decodePropertyMetadataLoader,
+        string $encodersDir,
+        string $decodersDir,
+        bool $forceEncodeChunks = false,
+        private LoggerInterface $logger = new NullLogger(),
+    ) {
+        $this->encoderGenerator = new EncoderGenerator($encodePropertyMetadataLoader, $encodersDir, $forceEncodeChunks);
+        $this->decoderGenerator = new DecoderGenerator($decodePropertyMetadataLoader, $decodersDir);
+    }
+
+    public function warmUp(string $cacheDir, ?string $buildDir = null): array
+    {
+        foreach ($this->encodableClassNames as $className) {
+            $type = Type::object($className);
+
+            $this->warmUpEncoder($type);
+            $this->warmUpDecoders($type);
+        }
+
+        return [];
+    }
+
+    public function isOptional(): bool
+    {
+        return true;
+    }
+
+    private function warmUpEncoder(Type $type): void
+    {
+        try {
+            $this->encoderGenerator->generate($type);
+        } catch (ExceptionInterface $e) {
+            $this->logger->debug('Cannot generate "json" encoder for "{type}": {exception}', ['type' => (string) $type, 'exception' => $e]);
+        }
+    }
+
+    private function warmUpDecoders(Type $type): void
+    {
+        try {
+            $this->decoderGenerator->generate($type, decodeFromStream: false);
+        } catch (ExceptionInterface $e) {
+            $this->logger->debug('Cannot generate "json" decoder for "{type}": {exception}', ['type' => (string) $type, 'exception' => $e]);
+        }
+
+        try {
+            $this->decoderGenerator->generate($type, decodeFromStream: true);
+        } catch (ExceptionInterface $e) {
+            $this->logger->debug('Cannot generate "json" streaming decoder for "{type}": {exception}', ['type' => (string) $type, 'exception' => $e]);
+        }
+    }
+}
diff --git a/src/Symfony/Component/JsonEncoder/CacheWarmer/LazyGhostCacheWarmer.php b/src/Symfony/Component/JsonEncoder/CacheWarmer/LazyGhostCacheWarmer.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\CacheWarmer;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmer;
+use Symfony\Component\JsonEncoder\Exception\RuntimeException;
+use Symfony\Component\VarExporter\ProxyHelper;
+
+/**
+ * Generates lazy ghost {@see \Symfony\Component\VarExporter\LazyGhostTrait}
+ * PHP files for $encodable types.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @internal
+ */
+final class LazyGhostCacheWarmer extends CacheWarmer
+{
+    private Filesystem $fs;
+
+    /**
+     * @param iterable<class-string> $encodableClassNames
+     */
+    public function __construct(
+        private iterable $encodableClassNames,
+        private string $lazyGhostsDir,
+    ) {
+        $this->fs = new Filesystem();
+    }
+
+    public function warmUp(string $cacheDir, ?string $buildDir = null): array
+    {
+        if (!$this->fs->exists($this->lazyGhostsDir)) {
+            $this->fs->mkdir($this->lazyGhostsDir);
+        }
+
+        foreach ($this->encodableClassNames as $className) {
+            $this->warmClassLazyGhost($className);
+        }
+
+        return [];
+    }
+
+    public function isOptional(): bool
+    {
+        return true;
+    }
+
+    /**
+     * @param class-string $className
+     */
+    private function warmClassLazyGhost(string $className): void
+    {
+        $path = \sprintf('%s%s%s.php', $this->lazyGhostsDir, \DIRECTORY_SEPARATOR, hash('xxh128', $className));
+
+        try {
+            $classReflection = new \ReflectionClass($className);
+        } catch (\ReflectionException $e) {
+            throw new RuntimeException($e->getMessage(), $e->getCode(), $e);
+        }
+
+        $this->writeCacheFile($path, \sprintf(
+            'class %s%s',
+            \sprintf('%sGhost', preg_replace('/\\\\/', '', $className)),
+            ProxyHelper::generateLazyGhost($classReflection),
+        ));
+    }
+}
diff --git a/src/Symfony/Component/JsonEncoder/DataModel/DataAccessorInterface.php b/src/Symfony/Component/JsonEncoder/DataModel/DataAccessorInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\DataModel;
+
+use PhpParser\Node\Expr;
+
+/**
+ * Represents a way to access data on PHP.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @internal
+ */
+interface DataAccessorInterface
+{
+    /**
+     * Converts to "nikic/php-parser" PHP expression.
+     */
+    public function toPhpExpr(): Expr;
+}
diff --git a/src/Symfony/Component/JsonEncoder/DataModel/Decode/BackedEnumNode.php b/src/Symfony/Component/JsonEncoder/DataModel/Decode/BackedEnumNode.php
@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\DataModel\Decode;
+
+use Symfony\Component\TypeInfo\Type\BackedEnumType;
+
+/**
+ * Represents a backed enum in the data model graph representation.
+ *
+ * Backed enums are leaves in the data model tree.
+ *
+ * @author Mathias Arlaud <[email protected]>
+ *
+ * @internal
+ */
+final class BackedEnumNode implements DataModelNodeInterface
+{
+    public function __construct(
+        public BackedEnumType $type,
+    ) {
+    }
+
+    public function getIdentifier(): string
+    {
+        return (string) $this->type;
+    }
+
+    public function getType(): BackedEnumType
+    {
+        return $this->type;
+    }
+}