Add Postgres connection option to use the pgcrypto extension to generate UUIDs

[typokign]

The uuid-ossp module is effectively deprecated. It is unmaintained, and Postgres does not compile with the module included by default. Therefore, some installations of Postgres, as well as some popular docker images, do not include this module. Attempting to create an Entity with a PrimaryGeneratedColumn('uuid') will throw an error that the uuid_generate_v4() function is unavailable.

Visiting the Postgres documentation at https://www.postgresql.org/docs/9.4/uuid-ossp.html shows:

Note: If you only need randomly-generated (version 4) UUIDs, consider using the gen_random_uuid() function from the pgcrypto module instead.

The pgcrypto module is included by default in Postgres and offers the same functionality.

Solution: To maintain backwards compatibility, the extension to be used defaults to the old uuid-ossp extension. Users running an instance of Postgres that does not include this module can manually set the uuidExtension property on the Postgres connection options to pgcrypto. I strongly recommend changing the default to pgcrypto in the next breaking release.

[luozhihua]

I have encountered an error where the uuid_generate_v4() function is not available because the postgresql docker image I am using does not support the uuid-ossp module, so I hope to support pgcrypto as soon as possible. Thank you very much!

[typokign]

Travis build is acting up, forgive the open/close spam please :)

[luozhihua]

@pleerock @AlexMesser @daniel-lang

I am sorry to bother, I am not sure who can promote this problem. I also don't know if this PR can be accepted and released. If it can be merged, it is very pleasant. If it can't be merged, please let us know so that I can seek other solutions as soon as possible.

I have used Typeorm + Postgresql to be perfect, but after I upgraded the Docker Postgresql image, Postgresql no longer supports the uuid-ossp module (meaning that the uuid_generate_v4() method called by Typeorm is no longer available), in fact this is not a problem with Typeorm. Instead, Postgresql abolished the interface, but we still hope that Typeorm can follow up on this issue, thanks to all those who contributed to Typeorm!

[typokign]

@luozhihua You're welcome to import my forked version with the fix at dacruz21/typeorm, master branch. Of course I would recommend pinning the commit hash in case I were to slip some malware in without your knowledge (but I pinky promise I won't 😉). Not a permanent solution but hopefully one that will unblock you until this PR has undergone the scrutiny it requires.

[luozhihua]

@dacruz21 Thanks for your amazing work, I have Clone your branch yesterday and temporarily solved the problem that I can't operate the database's table containing the uuid field, but this is not a long-term solution, thank you again for your work.

[pleerock]

doesn't postgres his own uuid generator in the latest versions? If no and we have to merge this PR, then we need to make sure it doesn't introduce a breaking change.

[pleerock]

We already have same PR - #3176 . Please checkout exist conversation as well.

[typokign]

We already have same PR - #3176 . Please checkout exist conversation as well.

This will not affect users who have existing UUID columns. New columns will be generated from a different function, but the underlying data type does not change, as postgres does not use a uuid column type. There will be no visible difference between old columns and new.

[typokign]

doesn't postgres his own uuid generator in the latest versions? If no and we have to merge this PR, then we need to make sure it doesn't introduce a breaking change.

Define "own"? The pgcrypto module is included with all newer postgres installs, so although it needs to be imported, the import should never fail. I am not aware of any UUID generation function that does not need to be imported.

[vlapo]

We already have same PR - #3176 . Please checkout exist conversation as well.

This will not affect users who have existing UUID columns. New columns will be generated from a different function, but the underlying data type does not change, as postgres does not use a uuid column type. There will be no visible difference between old columns and new.

But if you use uuid-ossp extension in old version of typeorm and you migrate to new one and do not have pgcrypto installed you have to change something in your setup. --- this is main reason why to merge this into next major release as breaking change

[pleerock]

I think best if we support both extension and add postgres connection option uuidExtension: "pgcrypto"|"uuid-ossp" defaulted to "uuid-ossp". This way everyone can used what they need without any breaking changes. In the future versions we'll switch default to "pgcrypto"

[typokign]

I think best if we support both extension and add postgres connection option uuidExtension: "pgcrypto"|"uuid-ossp" defaulted to "uuid-ossp". This way everyone can used what they need without any breaking changes. In the future versions we'll switch default to "pgcrypto"

Sounds like a good plan - I'll throw that together this weekend and update the PR soon.

[typokign]

The diff isn't exactly clear what I did here - I actually renamed the uuid-postgres tests to uuid-ossp, and configured the tests to use the uuid-ossp extension. Then I copied the uuid-ossp.ts file to pgcrypto.ts, left all the tests the same, and set the extension to pgcrypto. Looks like Git linked the old uuid-postgres file to the new pgcrypto file, but if you manually diff the two files you'll see that none of the tests have been changed.

[typokign]

@pleerock @vlapo I believe this is ready for re-review. Thanks!

[vlapo]

Looks fine for me. Just do not let this feature fall into forgotten and add some documentation https://github.com/typeorm/typeorm/blob/master/docs/connection-options.md

[pleerock]

Looks great, thank you very much for this awesome contribution!