[Uid] add command to generate UIDs #36405

guillbdx · 2020-04-09T16:16:03Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	#36102
License	MIT
Doc PR	symfony/symfony-docs#...

Command to generate UUID and ULID.

javiereguiluz · 2020-04-09T16:58:38Z

@guillbdx thanks for this and all your other contributions related to Uids.

I'd like to ask something: is this really a common need? Do people generate Uids often in the console?

sstok · 2020-04-09T17:33:13Z

FYI. Ramsey/uuid has a console library for the UUID component. I runs on Symfony, but I stopped using it because it kept being outdated.

It's mostly usable during development when you need it a value for your tests or fixtures.

wouterj · 2020-04-09T17:41:30Z

My go-to solution has always been https://www.uuidgenerator.net/ There is also the uuidgen command, available on Linux and MacOS, that does a great and easy job.

However, for password, we also have a command to generate them, while there are also online bcrypt and libsodium generators. So I think it can make sense to include a UID generate command?

MichaelDemeyer · 2020-04-09T17:52:46Z

I usually use website to generate uuid when needed. I think it will be slower to use command line 🤔

tarlepp · 2020-04-09T18:01:59Z

I have always used that https://www.uuidgenerator.net/ to generate some UUIDs when needed, I don't think that I would never use cli command for that.

stof · 2020-04-09T18:23:09Z

@wouterj for hashing password, there is a good reason not to use a third-party site: that would require that you give them the plaintext password.
Another reason is that the command is hashing password with the config used in the project.

For the UUID generation, I'm not sure having a command for it in the core is worth it (there is no configuration needing to match).

nicolas-grekas · 2020-04-09T18:54:05Z

https://www.uuidgenerator.net/ doesn't support eg. ULID

nicolas-grekas · 2020-04-09T19:03:19Z

Oh, another reason to have the command: the ability to represent uids in base58/base32 (aka shorter identifiers) - this needs to be added to the command btw.

src/Symfony/Bundle/FrameworkBundle/Command/UidGenerateCommand.php

src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml

derrabus · 2020-04-09T19:07:01Z

src/Symfony/Bundle/FrameworkBundle/Command/UidGenerateCommand.php

+                break;
+        }
+
+        $io->title('Generated UID:');


Just a thought: I understand that you want to provide a friendly user interface. However, this command could be consumed by shell scripts if we provided a way to produce a UUID without any additional interaction or output.

Maybe we should (if that possible) output everything except from the UID to stderr instead of stdout?

I've updated the code, so it just outputs the result now.

Taluu

I think having an interactive way of covering the null defaults isn't such a good idea TBH

src/Symfony/Bundle/FrameworkBundle/Command/UidGenerateCommand.php

guillbdx · 2020-04-10T19:09:22Z

Oh, another reason to have the command: the ability to represent uids in base58/base32 (aka shorter identifiers) - this needs to be added to the command btw.

@nicolas-grekas ok, i've added base32 and base58 as options.

guillbdx · 2020-04-10T19:25:19Z

Hi, i've updated my PR accordingly to your feedbacks. Main changes are:

the definition is removed if the Uid component is not installed
options base32 and base58 to represent the result in base32 or base58.
use uuid-1, uuid-3, etc instead of 1, 3 etc
removed the interactive stuff and made the type argument required.

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

src/Symfony/Component/Uid/Command/UidGenerateCommand.php

ro0NL · 2020-04-11T10:16:37Z

src/Symfony/Component/Uid/Command/UidGenerateCommand.php

+        $name = $input->getArgument('name');
+
+        if (\in_array($type, [self::UUID_3, self::UUID_5], true) && !Uuid::isValid($namespace)) {
+            throw new InvalidArgumentException('You must specify a valid namespace as a second argument.');


worth generating/outputting one? perhaps toggle name/namespace args

Do you mean that, in case the user hasn't provided a namespace, we should generate/output a random one?

src/Symfony/Component/Uid/Command/UidGenerateCommand.php

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

src/Symfony/Component/Uid/Command/UidGenerateCommand.php

derrabus · 2020-04-11T19:55:18Z

To get the tests green, use PHPUnit's TestCase class instead of the one from FrameworkBundle and add symfony/console to the require-dev section of the Uid component.

fabpot · 2020-04-12T07:22:18Z

I'd like to add one more reason to NOT have this command: cluttering the CLI output. We've work hard in the past to get rid of commands (by way of removing optional deps) so that the "default" list of commands is at short as possible. I'm leaning towards a 👎 for adding this one.

nicolas-grekas · 2020-05-04T16:36:28Z

Let's close then, time we tell if we really miss this.

Command to generate UIDs.

e127cb1

carsonbot added Status: Needs Review Feature labels Apr 9, 2020

guillbdx mentioned this pull request Apr 9, 2020

[FWB][Serializer][Form][Validator] Uid integration #36317

Closed

javiereguiluz added FrameworkBundle Uid labels Apr 9, 2020

derrabus requested changes Apr 9, 2020

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Apr 9, 2020

Taluu reviewed Apr 9, 2020

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/UidGenerateCommand.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Command/UidGenerateCommand.php Outdated Show resolved Hide resolved

Guillaume Pédelagrabe added 6 commits April 10, 2020 19:30

Remove command if UID component is not installed.

d9bb05a

Change values from 1, 3, etc to uuid-1, uuid-3, etc.

a645108

Options for base 32 and 58.

1dab679

Improve help.

ea5c6a3

Tests in base 32 and 58.

8c9f691

CS fix

e164a17

constant TYPES

0a024d1

nicolas-grekas reviewed Apr 10, 2020

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php Outdated Show resolved Hide resolved

nicolas-grekas changed the title ~~[FWB] Command to generate UIDs.~~ [Uid] add command to generate UIDs Apr 10, 2020

nicolas-grekas added this to the next milestone Apr 10, 2020

Guillaume Pédelagrabe added 4 commits April 10, 2020 22:39

Move removing of definition.

8c0bf6b

Move command to Uid Component.

e8bf438

Move UidGenerateCommandTest to Uid Component.

0f02fec

Uid Component Changelog.

78c8e2b

guillbdx force-pushed the fwb-command-generate-uid branch from 9cdd200 to 78c8e2b Compare April 10, 2020 23:49

ro0NL reviewed Apr 11, 2020

View reviewed changes

derrabus requested changes Apr 11, 2020

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php Outdated Show resolved Hide resolved

src/Symfony/Component/Uid/Command/UidGenerateCommand.php Outdated Show resolved Hide resolved

Guillaume Pédelagrabe added 2 commits April 11, 2020 20:15

Minor fixes.

838f92a

CS fix

c0bd623

nicolas-grekas closed this May 4, 2020

nicolas-grekas modified the milestones: next, 5.1 May 5, 2020

stof mentioned this pull request Jan 18, 2021

[Uid] Add Generate and Inspect commands #39883

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uid] add command to generate UIDs #36405

[Uid] add command to generate UIDs #36405

guillbdx commented Apr 9, 2020

javiereguiluz commented Apr 9, 2020

sstok commented Apr 9, 2020

wouterj commented Apr 9, 2020

MichaelDemeyer commented Apr 9, 2020

tarlepp commented Apr 9, 2020

stof commented Apr 9, 2020

nicolas-grekas commented Apr 9, 2020

nicolas-grekas commented Apr 9, 2020 •

edited

Loading

derrabus Apr 9, 2020

wouterj Apr 9, 2020

guillbdx Apr 10, 2020

Taluu left a comment

guillbdx commented Apr 10, 2020

guillbdx commented Apr 10, 2020 •

edited

Loading

ro0NL Apr 11, 2020

guillbdx Apr 11, 2020

derrabus commented Apr 11, 2020

fabpot commented Apr 12, 2020

nicolas-grekas commented May 4, 2020

[Uid] add command to generate UIDs #36405

[Uid] add command to generate UIDs #36405

Conversation

guillbdx commented Apr 9, 2020

javiereguiluz commented Apr 9, 2020

sstok commented Apr 9, 2020

wouterj commented Apr 9, 2020

MichaelDemeyer commented Apr 9, 2020

tarlepp commented Apr 9, 2020

stof commented Apr 9, 2020

nicolas-grekas commented Apr 9, 2020

nicolas-grekas commented Apr 9, 2020 • edited Loading

derrabus Apr 9, 2020

Choose a reason for hiding this comment

wouterj Apr 9, 2020

Choose a reason for hiding this comment

guillbdx Apr 10, 2020

Choose a reason for hiding this comment

Taluu left a comment

Choose a reason for hiding this comment

guillbdx commented Apr 10, 2020

guillbdx commented Apr 10, 2020 • edited Loading

ro0NL Apr 11, 2020

Choose a reason for hiding this comment

guillbdx Apr 11, 2020

Choose a reason for hiding this comment

derrabus commented Apr 11, 2020

fabpot commented Apr 12, 2020

nicolas-grekas commented May 4, 2020

nicolas-grekas commented Apr 9, 2020 •

edited

Loading

guillbdx commented Apr 10, 2020 •

edited

Loading