bahlo/sonyflake-rs

🃏 A distributed unique ID generator inspired by Twitter's Snowflake.

sonyflake-rs

A distributed unique ID generator inspired by Twitter's Snowflake.

This is a Rust implementation of the original sony/sonyflake, which is written in Go.

A Sonyflake ID is composed of

• 39 bits for time in units of 10 msec
• 8 bits for a sequence number
• 16 bits for a machine id

Install

Add the following to your Cargo.toml:

[dependencies]
sonyflake = "0.2"

Quickstart

use sonyflake::Sonyflake;

let sf = Sonyflake::new().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);

Benchmarks

Benchmarks were run on a MacBook Pro (15-inch, 2017) with a 2,8GHz i7 and 16 GB memory. Run them yourself with cargo bench.

test bench_decompose ... bench:       1,066 ns/iter (+/- 132)
test bench_new       ... bench:     738,129 ns/iter (+/- 318,192)
test bench_next_id   ... bench:      37,390 ns/iter (+/- 499)

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

sonyflake-rs's Issues

Test `Error::OverTimeLimit`

We need a test that verifies next_id will return an error once it's over the time limit.

RUSTSEC-2018-0015: term is looking for a new maintainer

term is looking for a new maintainer

Details
Status	unmaintained
Package	term
Version	0.4.6
URL	Stebalien/term#93
Date	2018-11-19

The author of the term crate does not have time to maintain it and is looking
for a new maintainer.

Some maintained alternatives you can potentially switch to instead, depending
on your needs:

• crossterm
• termcolor
• yansi

See advisory page for additional details.

RUSTSEC-2020-0071: Potential segfault in the time crate

Potential segfault in the time crate

Details
Package	time
Version	0.1.44
URL	time-rs/time#293
Date	2020-11-18
Patched versions	>=0.2.23
Unaffected versions	=0.2.0,=0.2.1,=0.2.2,=0.2.3,=0.2.4,=0.2.5,=0.2.6

Impact

Unix-like operating systems may segfault due to dereferencing a dangling pointer in specific circumstances. This requires an environment variable to be set in a different thread than the affected functions. This may occur without the user's knowledge, notably in a third-party library.

The affected functions from time 0.2.7 through 0.2.22 are:

• time::UtcOffset::local_offset_at
• time::UtcOffset::try_local_offset_at
• time::UtcOffset::current_local_offset
• time::UtcOffset::try_current_local_offset
• time::OffsetDateTime::now_local
• time::OffsetDateTime::try_now_local

The affected functions in time 0.1 (all versions) are:

• at
• at_utc

Non-Unix targets (including Windows and wasm) are unaffected.

Patches

Pending a proper fix, the internal method that determines the local offset has been modified to always return None on the affected operating systems. This has the effect of returning an Err on the try_* methods and UTC on the non-try_* methods.

Users and library authors with time in their dependency tree should perform cargo update, which will pull in the updated, unaffected code.

Users of time 0.1 do not have a patch and should upgrade to an unaffected version: time 0.2.23 or greater or the 0.3. series.

Workarounds

No workarounds are known.

References

time-rs/time#293

See advisory page for additional details.

Simple next_id benchmark

Would be nice to have a simple benchmark for next_id.

Since this library is using stable and the whole test crate is nightly-only, we should use a stable alternative. bencher looks good.

how do i conver this into a date time?

After converting the generated id into ints components using the decompose function,
i got this

{"machine-id": 376, "id": 435182517281096056, "time": 25938899355, "sequence": 0, "msb": 0}

How do i convert 25938899355 in to a date? is this possible?

RUSTSEC-2020-0159: Potential segfault in `localtime_r` invocations

Potential segfault in localtime_r invocations

Details
Package	chrono
Version	0.4.19
URL	chronotope/chrono#499
Date	2020-11-10

Impact

Unix-like operating systems may segfault due to dereferencing a dangling pointer in specific circumstances. This requires an environment variable to be set in a different thread than the affected functions. This may occur without the user's knowledge, notably in a third-party library.

Workarounds

No workarounds are known.

References

• time-rs/time#293

See advisory page for additional details.

Decompose into struct

...instead of HashMap.

next_id repeat in a loop

Hi, Thanks for the great lib!

I run a simple test, when in a for loop, the generated id is repeated, am I missing anything?

Here is a example:

use sonyflake::Sonyflake;
pub fn next_id() -> i64 {
    let mut sf = Sonyflake::new().unwrap();
    let next_id = sf.next_id().unwrap();
    next_id as i64
}

// test
#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashMap;
    #[test]
    fn test_next_id() {
        let mut id_map = HashMap::new();
        // loop
        for _ in 0..100 {
            let id = next_id();
            println!("id: {}", id);
            if id_map.contains_key(&id) {
                panic!("id is repeated");
            }
            id_map.insert(id, true);
            assert!(id > 0);
        }
    }
}

Doesn't work with Rust 1.72.0 + x86-64-windows-gnu toolchain

When building I'm getting the following error:

error: linking with 'x86_64-w64-mingw32-gcc' failed: exit code: 1
  |
  = note: "x86_64-w64-mingw32-gcc" "-fno-use-linker-plugin" "-Wl,--dynamicbase" "-Wl,--disable-auto-image-base" "-m64" "-Wl,--high-entropy-va" "[ <bunch of paths> ]"
  = note: ld: cannot find -lPacket: No such file or directory

This only happens when snowflake is imported into my project.

rustc --version --verbose (just incase its needed)

rustc 1.72.0 (5680fa18f 2023-08-23)
binary: rustc
commit-hash: 5680fa18feaa87f3ff04063800aec256c3d4b4be
commit-date: 2023-08-23
host: x86_64-pc-windows-gnu
release: 1.72.0
LLVM version: 16.0.5

When switched to stable-x86_64-pc-windows-msvc toolchain the error changes to:

error: linking with `link.exe` failed: exit code: 1181
  |
  = note: "C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC\\14.36.32532\\bin\\HostX64\\x64\\link.exe" "/NOLOGO" "[ <bunch of paths> ]"
  = note: LINK : fatal error LNK1181: cannot open input file 'Packet.lib'

After some research I think it might be something related with pnet library. Their README mentions Packet.lib as a requirement to build for Windows. If my guess is correct, I think this file and other possible requirements should be added to snowflake so its easier for the end user (like me).