snowflaked 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d467289c785dd03c1de80d82d2ad25657b43677affd2c3112090f42109f5ef5
-  data.tar.gz: 701ea640497cbf5555570ca8eb03c3d47cb88742d4b80b0a331fd72cdb345168
+  metadata.gz: 4a6f86e1432fc8b11f282674da8568ffecb835bb5aba3d5c52c124acb4a55ace
+  data.tar.gz: 2d13a338cceed05710c0afa3e56896d8199d90b1934ac259e256bed49ba8c3cf
 SHA512:
-  metadata.gz: f46bb795c7a598091deb5983e0ef3cec686dc515e129712258d67e4d7858a6e0ac07127275b60477a5d01170ebd11ff6c5fd9ebac195934c44935f675e03ff70
-  data.tar.gz: f3ac6a668615e9c4bbc0657c3bd360e1e5da63e982880bbdce91d2d97fa562d01547c7e8af3b3ba732aeb88a84e230ba09affd61f6e95244718161f4fe6cf999
+  metadata.gz: 54d45cfb0b0f503e8cc839ac7530439582e08ee11a98e3ec8a79bd9cc3bb0539cd8a0096e2d6618a9015c712bc02e8423ee18dc3d325eb695bdb4e413ad998dd
+  data.tar.gz: 4f291445d0e558e1e856f146d5972d52ac068ee907cb20aa4a2ea8d9eb0be818c3d4b53738e0b3ade960662aa8a5f05e6e616f210e0c7a3de7c37d089cbe9454

data/README.md

@@ -5,7 +5,7 @@
 [![Downloads](https://img.shields.io/gem/dt/snowflaked.svg)](https://rubygems.org/gems/snowflaked)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
 
-A high-performance, thread-safe Snowflake ID generator for Ruby, powered by Rust.
+A database-agnostic, high-performance, thread-safe Snowflake ID generator for Ruby, powered by Rust.
 
 Snowflake IDs are 64-bit unique identifiers that encode a timestamp, machine ID, and sequence number. They're time-sortable (IDs created later are always larger), making them ideal for distributed systems where you need unique IDs without coordination between machines. Unlike UUIDs, Snowflake IDs are smaller, sortable, and index-friendly for databases.
 
@@ -87,6 +87,13 @@ Snowflaked.configure do |config|
 end
 ```
 
+### Machine ID
+
+> [!TIP]
+> For multi-process servers like Puma, it is recommended to **not** configure `machine_id` explicitly. The gem automatically calculates a unique machine ID using `(hostname.hash ^ pid) % 1024`, which ensures each forked worker process gets a different ID and avoids duplicate Snowflake IDs.
+
+If you must set `machine_id` explicitly, use environment variables that differ per worker process.
+
 ### Machine ID Resolution
 
 If `machine_id` is not explicitly configured, it resolves in this order:
@@ -136,6 +143,12 @@ Snowflaked.machine_id(id)
 # => 42
 ```
 
+## Benchmarks
+
+See [BENCHMARKS.md](benchmarks/BENCHMARKS.md) for more details.
+
+tl;dr: Snowflake IDs have a negligible performance impact compared to database-backed IDs.
+
 ## Requirements
 
 - Ruby >= 3.2
@@ -151,6 +164,10 @@ bundle install
 bundle exec rake
 ```
 
+## Acknowledgments
+
+- [snowflaked-rs](https://github.com/MrGunflame/snowflaked-rs) - the Rust implementation of Snowflake IDs
+
 ## License
 
 MIT

data/ext/snowflaked/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "snowflaked"
-version = "0.1.2"
+version = "0.1.4"
 edition = "2021"
 publish = false
 

data/ext/snowflaked/src/lib.rs

@@ -1,50 +1,65 @@
 use magnus::{function, prelude::*, Error, RHash, Ruby};
 use snowflaked::sync::Generator;
 use snowflaked::{Builder, Snowflake};
-use std::sync::OnceLock;
+use std::sync::RwLock;
 use std::time::UNIX_EPOCH;
 
 struct GeneratorState {
     generator: Generator,
     epoch_offset: u64,
     machine_id: u16,
+    init_pid: u32,
 }
 
-static STATE: OnceLock<GeneratorState> = OnceLock::new();
+static STATE: RwLock<Option<GeneratorState>> = RwLock::new(None);
 
 fn init_generator(machine_id: u16, epoch_ms: Option<u64>) -> bool {
-    let was_empty = STATE.get().is_none();
+    let current_pid = std::process::id();
     let epoch_offset = epoch_ms.unwrap_or(0);
 
-    STATE.get_or_init(|| {
-        let epoch = UNIX_EPOCH + std::time::Duration::from_millis(epoch_offset);
+    let mut state = STATE.write().unwrap();
 
-        let generator = Builder::new().instance(machine_id).epoch(epoch).build();
+    if state.as_ref().is_some_and(|s| s.init_pid == current_pid) {
+        return false;
+    }
 
-        GeneratorState {
-            generator,
-            epoch_offset,
-            machine_id,
-        }
+    let epoch = UNIX_EPOCH + std::time::Duration::from_millis(epoch_offset);
+    let generator = Builder::new().instance(machine_id).epoch(epoch).build();
+
+    *state = Some(GeneratorState {
+        generator,
+        epoch_offset,
+        machine_id,
+        init_pid: current_pid,
     });
 
-    was_empty
+    true
 }
 
 fn generate(ruby: &Ruby) -> Result<u64, Error> {
-    let state = STATE.get().ok_or_else(|| {
+    let state = STATE.read().unwrap();
+
+    let s = state.as_ref().ok_or_else(|| {
         Error::new(
             ruby.exception_runtime_error(),
             "Generator not initialized. Call Snowflaked.configure or Snowflaked.id first.",
         )
     })?;
 
-    Ok(state.generator.generate())
+    if s.init_pid != std::process::id() {
+        return Err(Error::new(
+            ruby.exception_runtime_error(),
+            "Fork detected: generator was initialized in a different process. This should not happen if using Snowflaked.id - please report this bug.",
+        ));
+    }
+
+    Ok(s.generator.generate())
 }
 
 fn timestamp_ms(id: u64) -> u64 {
     let timestamp_raw = id.timestamp();
-    let epoch_offset = STATE.get().map(|s| s.epoch_offset).unwrap_or(0);
+    let state = STATE.read().unwrap();
+    let epoch_offset = state.as_ref().map(|s| s.epoch_offset).unwrap_or(0);
     timestamp_raw.saturating_add(epoch_offset)
 }
 
@@ -67,11 +82,13 @@ fn sequence(id: u64) -> u64 {
 }
 
 fn is_initialized() -> bool {
-    STATE.get().is_some()
+    let state = STATE.read().unwrap();
+    state.as_ref().is_some_and(|s| s.init_pid == std::process::id())
 }
 
 fn configured_machine_id() -> Option<u16> {
-    STATE.get().map(|s| s.machine_id)
+    let state = STATE.read().unwrap();
+    state.as_ref().and_then(|s| if s.init_pid == std::process::id() { Some(s.machine_id) } else { None })
 }
 
 #[magnus::init]

data/lib/snowflaked/model_extensions.rb

@@ -5,8 +5,8 @@ module Snowflaked
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :_snowflake_attributes, instance_writer: false, default: [:id] # rubocop:disable ThreadSafety/ClassAndModuleAttributes -- false positive
-      before_validation :_generate_snowflake_ids, on: :create
+      class_attribute :_snowflake_attributes, instance_writer: false, default: [:id]
+      after_initialize :_generate_snowflake_ids, if: :new_record?
     end
 
     class_methods do
@@ -14,19 +14,29 @@ module Snowflaked
         attrs = attributes.map(&:to_sym)
         attrs |= [:id] if id
         self._snowflake_attributes = attrs
+        @_snowflake_attributes_with_columns = nil
       end
 
       def _snowflake_columns_from_comments
-        return [] unless table_exists?
+        return @_snowflake_columns_from_comments if defined?(@_snowflake_columns_from_comments)
 
-        columns.filter_map { |col| col.name.to_sym if col.comment == Snowflaked::SchemaDefinitions::COMMENT }
+        @_snowflake_columns_from_comments = if table_exists?
+          columns.filter_map { |col| col.name.to_sym if col.comment == Snowflaked::SchemaDefinitions::COMMENT }
+        else
+          []
+        end
+      end
+
+      def _snowflake_attributes_with_columns
+        @_snowflake_attributes_with_columns ||= (_snowflake_attributes | _snowflake_columns_from_comments)
       end
     end
 
     private
 
     def _generate_snowflake_ids
-      attributes_to_generate = self.class._snowflake_attributes | self.class._snowflake_columns_from_comments
+      attributes_to_generate = self.class._snowflake_attributes_with_columns
+      return if attributes_to_generate.empty?
 
       attributes_to_generate.each do |attribute|
         next if self[attribute].present?

data/lib/snowflaked/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snowflaked
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/snowflaked.rb

@@ -57,7 +57,7 @@ module Snowflaked
 
   class << self
     def configuration
-      @configuration ||= Configuration.new # rubocop:disable ThreadSafety/ClassInstanceVariable -- not changed after initialization
+      @configuration ||= Configuration.new
     end
 
     def configure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snowflaked
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Luiz Eduardo Kowalski