crabmusket/hscuid

Collision-resistant IDs for horizontal scaling

hscuid

A Haskell port of the JavaScript library for collision-resistant identifiers. To install, cabal install hscuid.

What is a CUID?

CUIDs are short random strings designed so that you can generate a lot of them over many different machines and not get collisions. They are intended to be usable in situations from HTML element IDs to database keys. You can read more about them at usecuid.org.

How do I use this library?

>>> import Web.Cuid (newCuid, newSlug)
>>> newCuid
"cib3c3tcu0000zwowx9ho2gh4"
>>> newSlug
"y900001wmf"

Developing

I am currently developing with stack. To install dependencies and compile the library and test suites:

stack build

To run the collision test suite (which generates 1.2M IDs and makes sure they're all unique):

stack test

To test performance with criterion:

stack exec perf-test -- --regress allocated:iters +RTS -T

hscuid's Issues

Add a client-side implementation

Looks like one can do GHCJS conditional compilation like so. And so.

luite but keep in mind that ghcjs is considered a flavor of ghc by cabal
so impl(ghc) is still true when compiling with ghcjs
you can do tests like if impl(ghc >= 7.2) && impl(ghcjs >= 0.1) to test for ghcjs version 0.1 or higher built against ghc 7.2 or higher

Performance

Currently best-case performance in the 1.2M benchmark is ~9x slower than the Go port. Not sure how much of that is CUID generation and how much is Data.Set, but it would be good to get that number down. Obvious candidate is formatting. AFAICT some of the code inside formatting goes though String at times, so that might want replacing with bespoke functions.

Cuid standard is deprecated.

Due to security concerns (which also exist in database auto-increment ids, uuid/guid, and most other id standrads), the Cuid standard is now deprecated in favor of Cuid2.