snowflakeid_ex

defmodule SnowflakeID.Util do
  @moduledoc """
  The Util module helps users work with snowflake IDs.

  Util module can do the following:
  - Deriving timestamp based on ID
  - Creating buckets based on days since epoch...
  - get real timestamp of any ID
  """
  import Bitwise

  @sequence_bits 12

  @doc """
  First Snowflake for timestamp, useful if you have a timestamp and want
  to find snowflakes before or after a certain millesecond
  """
  @spec first_snowflake_for_timestamp(integer) :: integer
  def first_snowflake_for_timestamp(timestamp) do
    ts = timestamp - SnowflakeID.Helper.epoch()
    %{timestamp_bits: timestamp_bits, machine_bits: machine_bits} = layout()

    <<new_id::unsigned-integer-size(64)>> = <<
      ts::unsigned-integer-size(timestamp_bits),
      0::unsigned-integer-size(machine_bits),
      0::unsigned-integer-size(@sequence_bits)
    >>

    new_id
  end

  @doc """
  Get timestamp in ms from your config epoch from any snowflake ID
  """
  @spec timestamp_of_id(integer) :: integer
  def timestamp_of_id(id) do
    %{machine_bits: machine_bits} = layout()
    id >>> (machine_bits + @sequence_bits)
  end

  @doc """
  Get timestamp from computer epoch - January 1, 1970, Midnight
  """
  @spec real_timestamp_of_id(integer) :: integer
  def real_timestamp_of_id(id) do
    timestamp_of_id(id) + SnowflakeID.Helper.epoch()
  end

  @doc """
  Get bucket value based on segments of N days
  """
  @spec bucket(integer, atom, integer) :: integer
  def bucket(units, unit_type, id) do
    round(timestamp_of_id(id) / bucket_size(unit_type, units))
  end

  @doc """
  When no id is provided, we generate a bucket for the current time
  """
  @spec bucket(integer, atom) :: integer
  def bucket(units, unit_type) do
    timestamp = System.os_time(:millisecond) - SnowflakeID.Helper.epoch()
    round(timestamp / bucket_size(unit_type, units))
  end

  defp bucket_size(unit_type, units) do
    case unit_type do
      :hours -> 1000 * 60 * 60 * units
      # days is default
      _ -> 1000 * 60 * 60 * 24 * units
    end
  end

  defp layout do
    timestamp_bits = SnowflakeID.Helper.timestamp_bits()

    %{
      timestamp_bits: timestamp_bits,
      machine_bits: SnowflakeID.Helper.machine_id_bits(timestamp_bits)
    }
  end
end