8000 [Uid] Add UuidFactory to create Ulid and Uuid from timestamps, namesp… · symfony/symfony@9d310d5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9d310d5

Browse files
fancywebnicolas-grekas
fancyweb
authored and
nicolas-grekas
committed
[Uid] Add UuidFactory to create Ulid and Uuid from timestamps, namespaces and nodes
1 parent 47da664 commit 9d310d5

File tree

23 files changed

+834
-27
lines changed

23 files changed

+834
-27
lines changed

‎src/Symfony/Bridge/Doctrine/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ CHANGELOG
66

77
* Deprecate `DoctrineTestHelper` and `TestRepositoryFactory`
88
* [BC BREAK] Remove `UuidV*Generator` classes
9+
* Add `UuidGenerator`
910

1011
5.2.0
1112
-----

‎src/Symfony/Bridge/Doctrine/IdGenerator/UlidGenerator.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,24 @@
1313

1414
use Doctrine\ORM\EntityManager;
1515
use Doctrine\ORM\Id\AbstractIdGenerator;
16+
use Symfony\Component\Uid\Factory\UlidFactory;
1617
use Symfony\Component\Uid\Ulid;
1718

1819
final class UlidGenerator extends AbstractIdGenerator
1920
{
21+
private $factory;
22+
23+
public function __construct(UlidFactory $factory = null)
24+
{
25+
$this->factory = $factory;
26+
}
27+
2028
public function generate(EntityManager $em, $entity): Ulid
2129
{
30+
if ($this->factory) {
31+
return $this->factory->create();
32+
}
33+
2234
return new Ulid();
2335
}
2436
}

‎src/Symfony/Bridge/Doctrine/IdGenerator/UuidGenerator.php

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bridge\Doctrine\IdGenerator;
13+
14+
use Doctrine\ORM\EntityManager;
15+
use Doctrine\ORM\Id\AbstractIdGenerator;
16+
use Symfony\Component\Uid\Factory\UuidFactory;
17+
use Symfony\Component\Uid\Uuid;
18+
19+
final class UuidGenerator extends AbstractIdGenerator
20+
{
21+
private $protoFactory;
22+
private $factory;
23+
private $entityGetter;
24+
25+
public function __construct(UuidFactory $factory = null)
26+
{
27+
$this->protoFactory = $this->factory = $factory ?? new UuidFactory();
28+
}
29+
30+
public function generate(EntityManager $em, $entity): Uuid
31+
{
32+
if (null !== $this->entityGetter) {
33+
if (method_exists($entity, $this->entityGetter)) {
34+
return $this->factory->create($entity->{$this->entityGetter}());
35+
}
36+
37+
return $this->factory->create($entity->{$this->entityGetter});
38+
}
39+
40+
return $this->factory->create();
41+
}
42+
43+
/**
44+
* @param Uuid|string|null $node
45+
*
10000 46+
* @return static
47+
*/
48+
public function nameBased(string $entityGetter, $namespace = null): self
49+
{
50+
$clone = clone $this;
51+
$clone->factory = $clone->protoFactory->nameBased($namespace);
52+
$clone->entityGetter = $entityGetter;
53+
54+
return $clone;
55+
}
56+
57+
/**
58+
* @return static
59+
*/
60+
public function randomBased(): self
61+
{
62+
$clone = clone $this;
63+
$clone->factory = $clone->protoFactory->randomBased();
64+
$clone->entityGetter = null;
65+
66+
return $clone;
67+
}
68+
69+
/**
70+
* @param Uuid|string|null $node
71+
*
72+
* @return static
73+
*/
74+
public function timeBased($node = null): self
75+
{
76+
$clone = clone $this;
77+
$clone->factory = $clone->protoFactory->timeBased($node);
78+
$clone->entityGetter = null;
79+
80+
return $clone;
81+
}
82+
}

‎src/Symfony/Bridge/Doctrine/Tests/IdGenerator/UlidGeneratorTest.php

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use Doctrine\ORM\Mapping\Entity;
1515
use PHPUnit\Framework\TestCase;
1616
use Symfony\Bridge\Doctrine\IdGenerator\UlidGenerator;
17-
use Symfony\Component\Uid\AbstractUid;
17+
use Symfony\Component\Uid\Factory\UlidFactory;
1818
use Symfony\Component\Uid\Ulid;
1919

2020
class UlidGeneratorTest extends TestCase
@@ -25,8 +25,23 @@ public function testUlidCanBeGenerated()
2525
$generator = new UlidGenerator();
2626
$ulid = $generator->generate($em, new Entity());
2727

28-
$this->assertInstanceOf(AbstractUid::class, $ulid);
2928
$this->assertInstanceOf(Ulid::class, $ulid);
3029
$this->assertTrue(Ulid::isValid($ulid));
3130
}
31+
32+
/**
33+
* @requires function \Symfony\Component\Uid\Factory\UlidFactory::create
34+
*/
35+
public function testUlidfactory()
36+
{
37+
$ulid = new Ulid('00000000000000000000000000');
38+
$em = new EntityManager();
39+
$factory = $this->createMock(UlidFactory::class);
40+
$factory->expects($this->any())
41+
->method('create')
42+
->willReturn($ulid);
43+
$generator = new UlidGenerator($factory);
44+
45+
$this->assertSame($ulid, $generator->generate($em, new Entity()));
46+
}
3247
}

‎src/Symfony/Bridge/Doctrine/Tests/IdGenerator/UuidGeneratorTest.php

Lines changed: 92 additions & 0 deletions
55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bridge\Doctrine\Tests\IdGenerator;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
16+
use Symfony\Component\Uid\Factory\UuidFactory;
17+
use Symfony\Component\Uid\NilUuid;
18+
use Symfony\Component\Uid\Uuid;
19+
use Symfony\Component\Uid\UuidV4;
20+
use Symfony\Component\Uid\UuidV5;
21+
use Symfony\Component\Uid\UuidV6;
22+
23+
/**
24+
* @requires function \Symfony\Component\Uid\Factory\UuidFactory::create
25+
*/
26+
class UuidGeneratorTest extends TestCase
27+
{
28+
public function testUuidCanBeGenerated()
29+
{
30+
$em = new EntityManager();
31+
$generator = new UuidGenerator();
32+
$uuid = $generator->generate($em, new Entity());
33+
34+
$this->assertInstanceOf(Uuid::class, $uuid);
35+
}
36+
37+
public function testCustomUuidfactory()
38+
{
39+
$uuid = new NilUuid();
40+
$em = new EntityManager();
41+
$factory = $this->createMock(UuidFactory::class);
42+
$factory->expects($this->any())
43+
->method('create')
44+
->willReturn($uuid);
45+
$generator = new UuidGenerator($factory);
46+
47+
$this->assertSame($uuid, $generator->generate($em, new Entity()));
48+
}
49+
50+
public function testUuidfactory()
51+
{
52+
$em = new EntityManager();
53+
$generator = new UuidGenerator();
54+
$this->assertInstanceOf(UuidV6::class, $generator->generate($em, new Entity()));
+
56+
$generator = $generator->randomBased();
57+
$this->assertInstanceOf(UuidV4::class, $generator->generate($em, new Entity()));
58+
59+
$generator = $generator->timeBased();
60+
$this->assertInstanceOf(UuidV6::class, $generator->generate($em, new Entity()));
61+
62+
$generator = $generator->nameBased('prop1', Uuid::NAMESPACE_OID);
63+
$this->assertEquals(Uuid::v5(new Uuid(Uuid::NAMESPACE_OID), '3'), $generator->generate($em, new Entity()));
64+
65+
$generator = $generator->nameBased('prop2', Uuid::NAMESPACE_OID);
66+
$this->assertEquals(Uuid::v5(new Uuid(Uuid::NAMESPACE_OID), '2'), $generator->generate($em, new Entity()));
67+
68+
$generator = $generator->nameBased('getProp4', Uuid::NAMESPACE_OID);
69+
$this->assertEquals(Uuid::v5(new Uuid(Uuid::NAMESPACE_OID), '4'), $generator->generate($em, new Entity()));
70+
71+
$factory = new UuidFactory(6, 6, 5, 5, null, Uuid::NAMESPACE_OID);
72+
$generator = new UuidGenerator($factory);
73+
$generator = $generator->nameBased('prop1');
74+
$this->assertEquals(Uuid::v5(new Uuid(Uuid::NAMESPACE_OID), '3'), $generator->generate($em, new Entity()));
75+
}
76+
}
77+
78+
class Entity
79+
{
80+
public $prop1 = 1;
81+
public $prop2 = 2;
82+
83+
public function prop1()
84+
{
85+
return 3;
86+
}
87+
88+
public function getProp4()
89+
{
90+
return 4;
91+
}
92+
}

‎src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ CHANGELOG
1010
* Added the `dispatcher` option to `debug:event-dispatcher`
1111
* Added the `event_dispatcher.dispatcher` tag
1212
* Added `assertResponseFormatSame()` in `BrowserKitAssertionsTrait`
13+
* Add support for configuring UUID factory services
1314

1415
5.2.0
1516
-----

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
use Symfony\Component\RateLimiter\Policy\TokenBucketLimiter;
3535
use Symfony\Component\Serializer\Serializer;
3636
use Symfony\Component\Translation\Translator;
37+
use Symfony\Component\Uid\Factory\UuidFactory;
3738
use Symfony\Component\Validator\Validation;
3839
use Symfony\Component\WebLink\HttpHeaderSerializer;
3940
use Symfony\Component\Workflow\WorkflowEvents;
@@ -136,6 +137,7 @@ public function getConfigTreeBuilder()
136137
$this->addSecretsSection($rootNode);
137138
$this->addNotifierSection($rootNode);
138139
$this->addRateLimiterSection($rootNode);
140+
$this->addUidSection($rootNode);
139141

140142
return $treeBuilder;
141143
}
@@ -1891,4 +1893,37 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode)
18911893
->end()
18921894
;
18931895
}
1896+
1897+
private function addUidSection(ArrayNodeDefinition $rootNode)
1898+
{
1899+
$rootNode
1900+
->children()
1901+
->arrayNode('uid')
1902+
->info('Uid configuration')
1903+
->{class_exists(UuidFactory::class) ? 'canBeDisabled' : 'canBeEnabled'}()
1904+
->addDefaultsIfNotSet()
1905+
->children()
1906+
->enumNode('default_uuid_version')
1907+
->defaultValue(6)
1908+
->values([6, 4, 1])
1909+
->end()
1910+
->enumNode('name_based_uuid_version')
1911+
->defaultValue(5)
1912+
->values([5, 3])
1913+
->end()
1914+
->scalarNode('name_based_uuid_namespace')
1915+
->cannotBeEmpty()
1916+
->end()
1917+
->enumNode('time_based_uuid_version')
1918+
->defaultValue(6)
1919+
->values([6, 1])
1920+
->end()
1921+
->scalarNode('time_based_uuid_node')
1922+
->cannotBeEmpty()
1923+
->end()
1924+
->end()
1925+
->end()
1926+
->end()
1927+
;
1928+
}
18941929
}

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@
159159
use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
160160
use Symfony\Component\Translation\PseudoLocalizationTranslator;
161161
use Symfony\Component\Translation\Translator;
162+
use Symfony\Component\Uid\Factory\UuidFactory;
163+
use Symfony\Component\Uid\UuidV4;
162164
use Symfony\Component\Validator\ConstraintValidatorInterface;
163165
use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
164166
use Symfony\Component\Validator\ObjectInitializerInterface;
@@ -448,6 +450,14 @@ public function load(array $configs, ContainerBuilder $container)
448450
$loader->load('web_link.php');
449451
}
450452

453+
if ($this->isConfigEnabled($container, $config['uid'])) {
454+
if (!class_exists(UuidFactory::class)) {
455+
throw new LogicException('Uid support cannot be enabled as the Uid component is not installed. Try running "composer require symfony/uid".');
456+
}
457+
458+
$this->registerUidConfiguration($config['uid'], $container, $loader);
459+
}
460+
451461
$this->addAnnotatedClassesToCompile([
452462
'**\\Controller\\',
453463
'**\\Entity\\',
@@ -2315,6 +2325,27 @@ public static function registerRateLimiter(ContainerBuilder $container, string $
23152325
$container->registerAliasForArgument($limiterId, RateLimiterFactory::class, $name.'.limiter');
23162326
}
23172327

2328+
private function registerUidConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
2329+
{
2330+
$loader->load('uid.php');
2331+
2332+
$container->getDefinition('uuid.factory')
2333+
->setArguments([
2334+
$config['default_uuid_version'],
2335+
$config['time_based_uuid_version'],
2336+
$config['name_based_uuid_version'],
2337+
UuidV4::class,
2338+
$config['time_based_uuid_node'] ?? null,
2339+
$config['name_based_uuid_namespace'] ?? null,
2340+
])
2341+
;
2342+
2343+
if (isset($config['name_based_uuid_namespace'])) {
2344+
$container->getDefinition('name_based_uuid.factory')
2345+
->setArguments([$config['name_based_uuid_namespace']]);
2346+
}
2347+
}
2348+
23182349
private function resolveTrustedHeaders(array $headers): int
23192350
{
23202351
$trustedHeaders = 0;

0 commit comments

Comments
 (0)
0