Skip to content

Latest commit

 

History

History
225 lines (168 loc) · 9.26 KB

CHANGELOG.md

File metadata and controls

225 lines (168 loc) · 9.26 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

unreleased

cuid2 v0.1.3, cuid 1.3.3

Upcoming

  • The next major release will be a breaking release, dropping the top-level cuid(), slug(), and is_cuid() functions in favor of their version-specific counterparts (see below).
  • I also intend to split the v1 CUID functionality out into its own crate and publish it independently, like I have done for cuid2. The top-level cuid crate will then pull in the sub-crates depending on features, making it easy to just pull the CUID version you need.

Added

  • Provide new top-level functions from the cuid library to disambiguate CUID versions:
    • cuid::cuid1(): generate a v1 CUID, replacement for deprecated cuid()
    • cuid::cuid1_slug(): generate a v1 CUID slug, replacement for deprecated slug()
    • cuid::is_cuid1() - check whether a string looks like it could be a v1 CUID, replacement for deprecated is_cuid()
    • cuid::is_cuid1_slug() - check whether a string looks like it could be a v1 CUID slug, replacement for deprecated is_cuid()
    • cuid::cuid2_slug() - generate a v2 CUID of length 10
    • cuid::is_cuid2_slug() - check whether a string looks like could be a v2 CUID slug
    • cuid::Cuid2Constructor - expose the v2 CUID constructor interface
  • Added a couple of functions to cuid2 for parity with v1 functions:
    • cuid2::slug() - generate a v2 CUID of length 10
    • cuid2::is_slug() - check whether a string looks like could be a v2 CUID slug
  • Added support for webassembly builds. Builds are tested for wasm32-unknown-unknown and wasm32-wasi targets. I intend to add Javascript bindings and publish npm packages in an upcoming update.
    • The system hostname is not available to WASM, so for the CUID v1 fingerprint algorithm, we instead use a v4 UUID. This does mean the fingerprint will not be consistent on a host over time, which slightly diverges from the behavior of CUIDs on other targets. Please open an issue if this is a problem for you.

Changed

  • CUID v1 functions are no longer marked as deprecated. The original JS library was marked as insecure and deprecated by its creators, but this was merely due to their personal stance that any k-sortable IDs are insecure and should not be used. This library's author does not share the same view. New functions have been provided to better disambiguate creating v1 vs v2 IDs, and functions that do not explicitly specify a version are still marked as deprecated.
  • The CUID binaries now randomize the counter prior to generating an ID, rather than always starting at 0. This ensures that commandline-generated CUIDs do not lose entropy relative to library-generated CUIDs due to always having the same counter value.
  • The cuid2::is_cuid()/cuid::is_cuid2() function has been improved and now rejects more strings that are invalid CUIDs (contribution by @stormshield-kg)
  • The cuid2 binary now supports an optional --length|-l argument, which enables specifying the length of the generated CUID (contribution by @der-fruhling)

Removed

  • Removed old benchmarks and #[cfg(nightly)] blocks. Criterion benchmarks are the important ones, and those remain.

cuid2 v0.1.2

Changed

  • Internal updates to match updated CUID construction logic in the reference implementation, specifically:
    • Simplified hashing function, no longer adding additional entropy in addition to building a hash
    • Increased range of possible values for counter initialization
    • Random numbers for entropy are now random numbers from [0, 36), rather than a random choice from a static array of prime numbers

cuid 1.3.2, cuid2 0.1.1

Added

  • cuid/cuid2: Moved common utility logic out into a cuid-util crate
  • cuid2: #10: New is_cuid2 function and is_cuid alias

Changed

  • cuid: Replaced base conversion logic in cuid with the logic in cuid-util, yielding a solid performance improvement for CUID generation (10-20%)
  • cuid2: Added #[inline] annotations for main cuid2 functions

Fixed

  • cuid: 94d4cd0: Removed unused bigint dependency
  • cuid2: #11: Moved proptest to dev dependencies

cuid 1.3.1

Changed

  • Updated deprecation warnings to mention the cuid2 crate

cuid 1.3.0, cuid2 0.1.0

Deprecated

  • The CUID v1 algorithm is now deprecated, so all cuid v1 functions have been marked as such. Please use the new cuid2 crate or the cuid2() function re-exported from the cuid crate.

Added

  • The CI suite now runs both cargo clippy and cargo audit (edb22b5)
  • Added nix files for dependency management (8d2c180)
  • Added the cuid2 crate, providing library and binary for v2 of the CUID standard
  • Added cuid2() function in the cuid crate

Changed

  • Upgraded to use the Rust 2021 edition (cdc594c)
  • Switched from lazy_static to once_cell (3333dd4)
  • Added inline directive to external functions (8714f67)

1.2.0 - 2021-10-03

Added

  • Added --slug, --version, and --help arguments to cuid binary (b93b5b3)

Changed

  • ~10-20% performance improvement overall through optimization of pad_with_char()(b5503d6)

1.1.0 - 2021-08-03

Fixed

  • 0-length strings now return false when being checked by is_cuid() rather than panicking (a4fca2f, reported by @DeppLearning)

Changed

  • Improved specificity of is_cuid() and is_slug() checks (a4fca2f)
  • Use references for is_cuid() and is_slug() rather than converting to strings (a4fca2f)

1.0.2 - 2021-04-01

Changed

  • Significant performance improvements for multithreaded usage (~30-35%) due to the counter now using AtomicU32 again rather than Arc<Mutex<32>>, enabled thanks to the stabilization of fetch_update (3a5cc2e)
  • Generating CUIDs and slugs is now ~15-20% faster, thanks to reductions in the number of allocated strings and improvements to how space is pre-allocated during the generation of radix strings (a09bfad)
  • Updated non-v1 requirements to require minor version compatibility
  • Updated rand requirement from ~0.7 to ~0.8.0
  • Switched from Travis to GH Actions

1.0.1 - 2020-10-01

Fixed

  • Generated CUIDs now have a consistent length, aligning with the reference implementation (#2, thanks @rasendubi!)

1.0.0 - 2020-02-22

Added

  • Support for stable Rust (2018 edition)
  • The crate now includes a simple binary (cuid) that can be used to generate CUIDs on the commandline

Changed

  • The atomic counter is now an Arc<Mutex<u32>> rather than an AtomicUsize. This change was made to ensure that the counter could be fetched and updated simultaneously without using the nightly-only fetch_update
  • Updated dependencies
  • Ensured documentation examples are run in the test suite

0.1.0 - 2019-02-04

Added

  • Initial release
  • CUID & CUID slug generation
  • Benchmark suite