feature symfony#59863 [JsonEncoder] Rename the component to JsonStreamer (mtarld)

This PR was merged into the 7.3 branch.

Discussion
----------

[JsonEncoder] Rename the component to `JsonStreamer`

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        |
| License       | MIT

In order to make the intent of the component clearer, the `JsonEncoder` component should be renamed to `JsonStreamer`, as its main goal is to handle JSON streams as efficiently as possible.

In that way, it'll be harder for developers to get confused between this component and the `Serializer`'s JSON encoder.

In that PR, the following public API has been updated:
- `EncoderInterface::encode()` has been renamed to `StreamWriterInterface::write()`
- `DecoderInterface::decode()` has been renamed to `StreamReaderInterface::read()`
- the `JsonEncoder` class has been renamed to `JsonStreamWriter`
- the `JsonDecoder` class has been renamed to `JsonStreamReader`
- the `JsonEncodable` attribute has been renamed to `JsonStreamable`
- the `EncodedName` attribute has been renamed to `StreamedName`
- `ValueTransformerInterface::getJsonValueType()` has been renamed to `ValueTransformerInterface::getStreamValueType()`
- `ValueTransformer::$toJsonValue` has been renamed to `ValueTransformer::$nativeToStream`
- `ValueTransformer::$toNativeValue` has been renamed to `ValueTransformer::$streamToNative`

Commits
-------

924a01d [JsonStreamer] Rename the component

Author: fabpot

composer.json

@@ -83,7 +83,7 @@
         "symfony/http-foundation": "self.version",
         "symfony/http-kernel": "self.version",
         "symfony/intl": "self.version",
-        "symfony/json-encoder": "self.version",
+        "symfony/json-streamer": "self.version",
         "symfony/ldap": "self.version",
         "symfony/lock": "self.version",
         "symfony/mailer": "self.version",

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -6,7 +6,7 @@ CHANGELOG
 
  * Add support for assets pre-compression
  * Rename `TranslationUpdateCommand` to `TranslationExtractCommand`
- * Add JsonEncoder services and configuration
+ * Add JsonStreamer services and configuration
  * Add new `framework.property_info.with_constructor_extractor` option to allow enabling or disabling the constructor extractor integration
  * Deprecate the `--show-arguments` option of the `container:debug` command, as arguments are now always shown
  * Add `RateLimiterFactoryInterface` as an alias of the `limiter` service

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php

@@ -53,7 +53,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'form.type_guesser',
         'html_sanitizer',
         'http_client.client',
-        'json_encoder.value_transformer',
+        'json_streamer.value_transformer',
         'kernel.cache_clearer',
         'kernel.cache_warmer',
         'kernel.event_listener',

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -31,7 +31,7 @@
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Component\HttpFoundation\IpUtils;
-use Symfony\Component\JsonEncoder\EncoderInterface;
+use Symfony\Component\JsonStreamer\StreamWriterInterface;
 use Symfony\Component\Lock\Lock;
 use Symfony\Component\Lock\Store\SemaphoreStore;
 use Symfony\Component\Mailer\Mailer;
@@ -182,7 +182,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $this->addHtmlSanitizerSection($rootNode, $enableIfStandalone);
         $this->addWebhookSection($rootNode, $enableIfStandalone);
         $this->addRemoteEventSection($rootNode, $enableIfStandalone);
-        $this->addJsonEncoderSection($rootNode, $enableIfStandalone);
+        $this->addJsonStreamerSection($rootNode, $enableIfStandalone);
 
         return $treeBuilder;
     }
@@ -2692,13 +2692,13 @@ private function addHtmlSanitizerSection(ArrayNodeDefinition $rootNode, callable
         ;
     }
 
-    private function addJsonEncoderSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
+    private function addJsonStreamerSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
     {
         $rootNode
             ->children()
-                ->arrayNode('json_encoder')
-                    ->info('JSON encoder configuration')
-                    ->{$enableIfStandalone('symfony/json-encoder', EncoderInterface::class)}()
+                ->arrayNode('json_streamer')
+                    ->info('JSON streamer configuration')
+                    ->{$enableIfStandalone('symfony/json-streamer', StreamWriterInterface::class)}()
                 ->end()
             ->end()
         ;

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -100,11 +100,11 @@
 use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\HttpKernel\Log\DebugLoggerConfigurator;
-use Symfony\Component\JsonEncoder\Attribute\JsonEncodable;
-use Symfony\Component\JsonEncoder\DecoderInterface as JsonEncoderDecoderInterface;
-use Symfony\Component\JsonEncoder\EncoderInterface as JsonEncoderEncoderInterface;
-use Symfony\Component\JsonEncoder\JsonEncoder;
-use Symfony\Component\JsonEncoder\ValueTransformer\ValueTransformerInterface;
+use Symfony\Component\JsonStreamer\Attribute\JsonStreamable;
+use Symfony\Component\JsonStreamer\JsonStreamWriter;
+use Symfony\Component\JsonStreamer\StreamReaderInterface;
+use Symfony\Component\JsonStreamer\StreamWriterInterface;
+use Symfony\Component\JsonStreamer\ValueTransformer\ValueTransformerInterface;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\LockInterface;
 use Symfony\Component\Lock\PersistingStoreInterface;
@@ -436,12 +436,12 @@ public function load(array $configs, ContainerBuilder $container): void
             $this->registerPropertyInfoConfiguration($config['property_info'], $container, $loader);
         }
 
-        if ($this->readConfigEnabled('json_encoder', $container, $config['json_encoder'])) {
+        if ($this->readConfigEnabled('json_streamer', $container, $config['json_streamer'])) {
             if (!$typeInfoEnabled) {
-                throw new LogicException('JsonEncoder support cannot be enabled as the TypeInfo component is not '.(interface_exists(TypeResolverInterface::class) ? 'enabled.' : 'installed. Try running "composer require symfony/type-info".'));
+                throw new LogicException('JsonStreamer support cannot be enabled as the TypeInfo component is not '.(interface_exists(TypeResolverInterface::class) ? 'enabled.' : 'installed. Try running "composer require symfony/type-info".'));
             }
 
-            $this->registerJsonEncoderConfiguration($config['json_encoder'], $container, $loader);
+            $this->registerJsonStreamerConfiguration($config['json_streamer'], $container, $loader);
         }
 
         if ($this->readConfigEnabled('lock', $container, $config['lock'])) {
@@ -755,8 +755,8 @@ static function (ChildDefinition $definition, AsPeriodicTask|AsCronTask $attribu
                 }
             );
         }
-        $container->registerAttributeForAutoconfiguration(JsonEncodable::class, static function (ChildDefinition $definition, JsonEncodable $attribute): void {
-            $definition->addTag('json_encoder.encodable', [
+        $container->registerAttributeForAutoconfiguration(JsonStreamable::class, static function (ChildDefinition $definition, JsonStreamable $attribute): void {
+            $definition->addTag('json_streamer.streamable', [
                 'object' => $attribute->asObject,
                 'list' => $attribute->asList,
             ]);
@@ -2033,26 +2033,26 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
         $container->setParameter('.serializer.named_serializers', $config['named_serializers'] ?? []);
     }
 
-    private function registerJsonEncoderConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
+    private function registerJsonStreamerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
     {
-        if (!class_exists(JsonEncoder::class)) {
-            throw new LogicException('JsonEncoder support cannot be enabled as the JsonEncoder component is not installed. Try running "composer require symfony/json-encoder".');
+        if (!class_exists(JsonStreamWriter::class)) {
+            throw new LogicException('JsonStreamer support cannot be enabled as the JsonStreamer component is not installed. Try running "composer require symfony/json-streamer".');
         }
 
         $container->registerForAutoconfiguration(ValueTransformerInterface::class)
-            ->addTag('json_encoder.value_transformer');
+            ->addTag('json_streamer.value_transformer');
 
-        $loader->load('json_encoder.php');
+        $loader->load('json_streamer.php');
 
-        $container->registerAliasForArgument('json_encoder.encoder', JsonEncoderEncoderInterface::class, 'json.encoder');
-        $container->registerAliasForArgument('json_encoder.decoder', JsonEncoderDecoderInterface::class, 'json.decoder');
+        $container->registerAliasForArgument('json_streamer.stream_writer', StreamWriterInterface::class, 'json.stream_writer');
+        $container->registerAliasForArgument('json_streamer.stream_reader', StreamReaderInterface::class, 'json.stream_reader');
 
-        $container->setParameter('.json_encoder.encoders_dir', '%kernel.cache_dir%/json_encoder/encoder');
-        $container->setParameter('.json_encoder.decoders_dir', '%kernel.cache_dir%/json_encoder/decoder');
-        $container->setParameter('.json_encoder.lazy_ghosts_dir', '%kernel.cache_dir%/json_encoder/lazy_ghost');
+        $container->setParameter('.json_streamer.stream_writers_dir', '%kernel.cache_dir%/json_streamer/stream_writer');
+        $container->setParameter('.json_streamer.stream_readers_dir', '%kernel.cache_dir%/json_streamer/stream_reader');
+        $container->setParameter('.json_streamer.lazy_ghosts_dir', '%kernel.cache_dir%/json_streamer/lazy_ghost');
 
         if (\PHP_VERSION_ID >= 80400) {
-            $container->removeDefinition('.json_encoder.cache_warmer.lazy_ghost');
+            $container->removeDefinition('.json_streamer.cache_warmer.lazy_ghost');
         }
     }
 

src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

@@ -54,7 +54,7 @@
 use Symfony\Component\HttpKernel\DependencyInjection\RemoveEmptyControllerArgumentLocatorsPass;
 use Symfony\Component\HttpKernel\DependencyInjection\ResettableServicePass;
 use Symfony\Component\HttpKernel\KernelEvents;
-use Symfony\Component\JsonEncoder\DependencyInjection\EncodablePass;
+use Symfony\Component\JsonStreamer\DependencyInjection\StreamablePass;
 use Symfony\Component\Messenger\DependencyInjection\MessengerPass;
 use Symfony\Component\Mime\DependencyInjection\AddMimeTypeGuesserPass;
 use Symfony\Component\PropertyInfo\DependencyInjection\PropertyInfoConstructorPass;
@@ -189,7 +189,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new ErrorLoggerCompilerPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
         $container->addCompilerPass(new VirtualRequestStackPass());
         $container->addCompilerPass(new TranslationUpdateCommandPass(), PassConfig::TYPE_BEFORE_REMOVING);
-        $this->addCompilerPassIfExists($container, EncodablePass::class);
+        $this->addCompilerPassIfExists($container, StreamablePass::class);
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 2);