Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e6ec19f

Browse filesBrowse files
fancywebfancyweb
committed
[Uid] Add UidFactory to create Ulid and Uuid from timestamps and randomness/nodes
1 parent b3de641 commit e6ec19f
Copy full SHA for e6ec19f

File tree

13 files changed

+576
-21
lines changed
Filter options

13 files changed

+576
-21
lines changed

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
+61Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@
3434
use Symfony\Component\RateLimiter\Policy\TokenBucketLimiter;
3535
use Symfony\Component\Serializer\Serializer;
3636
use Symfony\Component\Translation\Translator;
37+
use Symfony\Component\Uid\AbstractUid;
38+
use Symfony\Component\Uid\UuidV1;
39+
use Symfony\Component\Uid\UuidV3;
40+
use Symfony\Component\Uid\UuidV5;
41+
use Symfony\Component\Uid\UuidV6;
3742
use Symfony\Component\Validator\Validation;
3843
use Symfony\Component\WebLink\HttpHeaderSerializer;
3944
use Symfony\Component\Workflow\WorkflowEvents;
@@ -136,6 +141,7 @@ public function getConfigTreeBuilder()
136141
$this->addSecretsSection($rootNode);
137142
$this->addNotifierSection($rootNode);
138143
$this->addRateLimiterSection($rootNode);
144+
$this->addUidSection($rootNode);
139145

140146
return $treeBuilder;
141147
}
@@ -1888,4 +1894,59 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode)
18881894
->end()
18891895
;
18901896
}
1897+
1898+
private function addUidSection(ArrayNodeDefinition $rootNode)
1899+
{
1900+
$rootNode
1901+
->children()
1902+
->arrayNode('uid')
1903+
->info('Uid configuration')
1904+
->{class_exists(AbstractUid::class) ? 'canBeDisabled' : 'canBeEnabled'}()
1905+
->children()
1906+
->arrayNode('uid_factory')
1907+
->addDefaultsIfNotSet()
1908+
->children()
1909+
->enumNode('default_named_version')
1910+
->defaultNull()
1911+
->values([null, UuidV5::class, UuidV3::class, 'v5', 'v3'])
1912+
->beforeNormalization()
1913+
->always()
1914+
->then(static function (?string $value): ?string {
1915+
if ('v5' === $value) {
1916+
return UuidV5::class;
1917+
}
1918+
1919+
if ('v3' === $value) {
1920+
return UuidV3::class;
1921+
}
1922+
1923+
return $value;
1924+
})
1925+
->end()
1926+
->end()
1927+
->enumNode('default_timed_version')
1928+
->defaultNull()
1929+
->values([null, UuidV6::class, UuidV1::class, 'v6', 'v1'])
1930+
->beforeNormalization()
1931+
->always()
1932+
->then(static function (?string $value): ?string {
1933+
if ('v6' === $value) {
1934+
return UuidV6::class;
1935+
}
1936+
1937+
if ('v1' === $value) {
1938+
return UuidV1::class;
1939+
}
1940+
1941+
return $value;
1942+
})
1943+
->end()
1944+
->end()
1945+
->end()
1946+
->end()
1947+
->end()
1948+
->end()
1949+
->end()
1950+
;
1951+
}
18911952
}

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
+20Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@
150150
use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
151151
use Symfony\Component\Translation\PseudoLocalizationTranslator;
152152
use Symfony\Component\Translation\Translator;
153+
use Symfony\Component\Uid\AbstractUid;
153154
use Symfony\Component\Validator\ConstraintValidatorInterface;
154155
use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
155156
use Symfony\Component\Validator\ObjectInitializerInterface;
@@ -439,6 +440,14 @@ public function load(array $configs, ContainerBuilder $container)
439440
$loader->load('web_link.php');
440441
}
441442

443+
if ($this->isConfigEnabled($container, $config['uid'])) {
444+
if (!class_exists(AbstractUid::class)) {
445+
throw new LogicException('Uid support cannot be enabled as the Uid component is not installed. Try running "composer require symfony/uid".');
446+
}
447+
448+
$this->registerUidConfiguration($config['uid'], $container, $loader);
449+
}
450+
442451
$this->addAnnotatedClassesToCompile([
443452
'**\\Controller\\',
444453
'**\\Entity\\',
@@ -2292,6 +2301,17 @@ public static function registerRateLimiter(ContainerBuilder $container, string $
22922301
$container->registerAliasForArgument($limiterId, RateLimiterFactory::class, $name.'.limiter');
22932302
}
22942303

2304+
private function registerUidConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
2305+
{
2306+
$loader->load('uid.php');
2307+
2308+
$uidFactory = $container->getDefinition('uid.factory');
2309+
$uidFactory->setArguments([
2310+
$config['uid_factory']['default_named_version'],
2311+
$config['uid_factory']['default_timed_version'],
2312+
]);
2313+
}
2314+
22952315
private function resolveTrustedHeaders(array $headers): int
22962316
{
22972317
$trustedHeaders = 0;

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
+27Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
<xsd:element name="mailer" type="mailer" minOccurs="0" maxOccurs="1" />
3636
<xsd:element name="http-cache" type="http_cache" minOccurs="0" maxOccurs="1" />
3737
<xsd:element name="rate-limiter" type="rate_limiter" minOccurs="0" maxOccurs="1" />
38+
<xsd:element name="uid" type="uid" minOccurs="0" maxOccurs="1" />
3839
</xsd:choice>
3940

4041
<xsd:attribute name="http-method-override" type="xsd:boolean" />
@@ -692,4 +693,30 @@
692693
<xsd:attribute name="interval" type="xsd:string" />
693694
<xsd:attribute name="amount" type="xsd:int" />
694695
</xsd:complexType>
696+
697+
<xsd:complexType name="uid">
698+
<xsd:sequence>
699+
<xsd:element name="uid_factory" type="uid_factory" minOccurs="0" maxOccurs="1" />
700+
</xsd:sequence>
701+
<xsd:attribute name="enabled" type="xsd:boolean" />
702+
</xsd:complexType>
703+
704+
<xsd:complexType name="uid_factory">
705+
<xsd:attribute name="default_named_version" type="uid_named_version" />
706+
<xsd:attribute name="default_timed_version" type="uid_timed_version" />
707+
</xsd:complexType>
708+
709+
<xsd:simpleType name="uid_named_version">
710+
<xsd:restriction base="xsd:string">
711+
<xsd:enumeration value="v5" />
712+
<xsd:enumeration value="v3" />
713+
</xsd:restriction>
714+
</xsd:simpleType>
715+
716+
<xsd:simpleType name="uid_timed_version">
717+
<xsd:restriction base="xsd:string">
718+
<xsd:enumeration value="v6" />
719+
<xsd:enumeration value="v1" />
720+
</xsd:restriction>
721+
</xsd:simpleType>
695722
</xsd:schema>

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/uid.php

Copy file name to clipboard
+25Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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\Component\DependencyInjection\Loader\Configurator;
13+
14+
use Symfony\Component\Uid\UidFactory;
15+
use Symfony\Component\Uid\UlidFactory;
16+
17+
return static function (ContainerConfigurator $container) {
18+
$container->services()
19+
->set('uid.factory', UidFactory::class)
20+
->alias(UidFactory::class, 'uid.factory')
21+
22+
->set('ulid.factory', UlidFactory::class)
23+
->alias(UlidFactory::class, 'ulid.factory')
24+
;
25+
};

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,13 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
535535
'enabled' => false,
536536
'limiters' => [],
537537
],
538+
'uid' => [
539+
'enabled' => true,
540+
'uid_factory' => [
541+
'default_named_version' => null,
542+
'default_timed_version' => null,
543+
],
544+
],
538545
];
539546
}
540547
}

‎src/Symfony/Component/Uid/CHANGELOG.md

Copy file name to clipboardExpand all lines: src/Symfony/Component/Uid/CHANGELOG.md
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
5.3.0
5+
-----
6+
7+
* added UidFactory and UlidFactory
8+
49
5.2.0
510
-----
611

‎src/Symfony/Component/Uid/Tests/UidFactoryTest.php

Copy file name to clipboard
+123Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
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\Component\Uid\Tests;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Component\Uid\UidFactory;
16+
use Symfony\Component\Uid\Uuid;
17+
use Symfony\Component\Uid\UuidV1;
18+
use Symfony\Component\Uid\UuidV3;
19+
use Symfony\Component\Uid\UuidV4;
20+
use Symfony\Component\Uid\UuidV5;
21+
use Symfony\Component\Uid\UuidV6;
22+
23+
final class UidFactoryTest extends TestCase
24+
{
25+
public function testCreateNamedDefaultVersion()
26+
{
27+
$this->assertInstanceOf(UuidV5::class, (new UidFactory())->createNamed('foo'));
28+
$this->assertInstanceOf(UuidV3::class, (new UidFactory(UuidV3::class))->createNamed('foo'));
29+
}
30+
31+
public function testCreateNamed()
32+
{
33+
$uidFactory = new UidFactory();
34+
35+
// Test custom namespace
36+
$uid1 = $uidFactory->createNamed('foo', Uuid::fromString('6f80c216-0492-4421-bd82-c10ab929ae84'));
37+
$this->assertInstanceOf(UuidV5::class, $uid1);
38+
$this->assertSame('d521ceb7-3e31-5954-b873-92992c697ab9', (string) $uid1);
39+
40+
// Test default namespace
41+
$uidFactory = $uidFactory->withDefaultNamespace(Uuid::fromString('6f80c216-0492-4421-bd82-c10ab929ae84'));
42+
$uid2 = $uidFactory->createNamed('foo');
43+
$this->assertInstanceOf(UuidV5::class, $uid2);
44+
$this->assertTrue($uid1->equals($uid2));
45+
46+
// Test default namespace override
47+
$uid3 = $uidFactory->createNamed('foo', Uuid::v4());
48+
$this->assertFalse($uid2->equals($uid3));
49+
50+
// Test version override
51+
$uid4 = $uidFactory->createNamed('foo', null, UuidV3::class);
52+
$this->assertInstanceOf(UuidV3::class, $uid4);
53+
}
54+
55+
public function testCreateNamedWithUnsupportedVersion()
56+
{
57+
$this->expectException(\InvalidArgumentException::class);
58+
$this->expectDeprecationMessage('The "Symfony\Component\Uid\UuidV1" version is unsupported.');
59+
60+
(new UidFactory())->createNamed('foo', null, UuidV1::class);
61+
}
62+
63+
public function testCreateTimedDefaultVersion()
64+
{
65+
$this->assertInstanceOf(UuidV6::class, (new UidFactory())->createTimed());
66+
$this->assertInstanceOf(UuidV1::class, (new UidFactory(null, UuidV1::class))->createTimed());
67+
}
68+
69+
public function testCreateTimed()
70+
{
71+
$uidFactory = new UidFactory();
72+
73+
// Test custom timestamp and node
74+
$uid1 = $uidFactory->createTimed('99999999999999999', Uuid::fromString('6f80c216-0492-4421-bd82-c10ab929ae84'));
75+
$this->assertInstanceOf(UuidV6::class, $uid1);
76+
$this->assertSame('16345785-d89f-6fff-85e9-c10ab929ae84', (string) $uid1);
77+
78+
// Test default timestamp
79+
$uidFactory = $uidFactory->withDefaultTimestamp('99999999999999999');
80+
$uid2 = $uidFactory->createTimed(null, Uuid::fromString('6f80c216-0492-4421-bd82-c10ab929ae84'));
81+
$this->assertInstanceOf(UuidV6::class, $uid1);
82+
$this->assertTrue($uid1->equals($uid2));
83+
$uid3 = $uidFactory->createTimed();
84+
$this->assertFalse($uid2->equals($uid3));
85+
$this->assertSame($uid2->getTime(), $uid3->getTime());
86+
87+
// Test default node
88+
$uidFactory = $uidFactory->withDefaultNode(Uuid::fromString('6f80c216-0492-4421-bd82-c10ab929ae84'));
89+
$uid4 = $uidFactory->createTimed();
90+
$this->assertInstanceOf(UuidV6::class, $uid4);
91+
$this->assertTrue($uid2->equals($uid4));
92+
93+
// Test default timestamp override
94+
$uid5 = $uidFactory->createTimed('888888888888888');
95+
$this->assertInstanceOf(UuidV6::class, $uid5);
96+
$this->assertNotSame($uid4->getTime(), $uid5->getTime());
97+
98+
// Test default node override
99+
$uid6 = $uidFactory->createTimed(null, Uuid::v4());
100+
$this->assertInstanceOf(UuidV6::class, $uid6);
101+
$this->assertFalse($uid4->equals($uid6));
102+
$this->assertSame($uid4->getTime(), $uid6->getTime());
103+
104+
// Test version override
105+
$uid7 = $uidFactory->createTimed(null, null, UuidV1::class);
106+
$this->assertInstanceOf(UuidV1::class, $uid7);
107+
$this->assertSame($uid4->getTime(), $uid7->getTime());
108+
$this->assertSame($uid4->getNode(), $uid7->getNode());
109+
}
110+
111+
public function testCreateTimedWithUnsupportedVersion()
112+
{
113+
$this->expectException(\InvalidArgumentException::class);
114+
$this->expectDeprecationMessage('The "Symfony\Component\Uid\UuidV4" version is unsupported.');
115+
116+
(new UidFactory())->createTimed(null, null, UuidV4::class);
117+
}
118+
119+
public function testCreateRandom()
120+
{
121+
$this->assertInstanceOf(UuidV4::class, (new UidFactory())->createRandom());
122+
}
123+
}

‎src/Symfony/Component/Uid/Tests/UlidFactoryTest.php

Copy file name to clipboard
+54Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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\Component\Uid\Tests;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Component\Uid\UlidFactory;
16+
17+
final class UlidFactoryTest extends TestCase
18+
{
19+
public function testCreate()
20+
{
21+
$ulidFactory = new UlidFactory();
22+
23+
$ulidFactory->create();
24+
25+
$ulidFactory = $ulidFactory->withDefaultTimestamp('999999');
26+
27+
$ulid1 = $ulidFactory->create();
28+
$this->assertSame(999.999, $ulid1->getTime());
29+
$ulid2 = $ulidFactory->create();
30+
$this->assertSame(999.999, $ulid2->getTime());
31+
32+
$this->assertFalse($ulid1->equals($ulid2));
33+
$this->assertSame(-1, ($ulid1->compare($ulid2)));
34+
35+
// Test default timestamp override
36+
$this->assertSame(0.111, $ulidFactory->create('111')->getTime());
37+
}
38+
39+
public function testCreateWithInvalidTimestamp()
40+
{
41+
$this->expectException(\InvalidArgumentException::class);
42+
$this->expectDeprecationMessage('The timestamp must be a positive number.');
43+
44+
(new UlidFactory())->create('-1000');
45+
}
46+
47+
public function testWithDefaultTimestampWithInvalidTimestamp()
48+
{
49+
$this->expectException(\InvalidArgumentException::class);
50+
$this->expectDeprecationMessage('The timestamp must be a positive number.');
51+
52+
(new UlidFactory())->withDefaultTimestamp('foo');
53+
}
54+
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.