1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
// Eko: A terminal-native social media platform
// Copyright (C) 2025 Kyren223
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package snowflake
import (
"fmt"
"strconv"
"sync"
"time"
"github.com/kyren223/eko/pkg/assert"
)
const (
// NOTE(kyren): Epoch is set to the eko snowflake epoch of August 8 2025 7:07:07.223 PM UTC in milliseconds
Epoch int64 = 1754680027223
nodeBits = 10
stepBits = 12
NodeMax = 1<<nodeBits - 1
nodeMask = NodeMax << stepBits
stepMask = 1<<stepBits - 1
timeShift = nodeBits + stepBits
nodeShift = stepBits
)
type ID int64
const InvalidID = ID(0)
func (id ID) String() string {
return strconv.FormatInt(int64(id), 10)
}
func (id ID) Time() (msSinceEpoch int64) {
return (int64(id) >> timeShift) + Epoch
}
func (id ID) Node() int64 {
return int64(id) & nodeMask >> nodeShift
}
func (id ID) Step() int64 {
return int64(id) & stepMask
}
type Node struct {
mu sync.Mutex
epoch time.Time
time int64
node int64
step int64
}
func (n *Node) String() string {
return fmt.Sprintf("Node%v(epoch: %v, step: %v, time: %v)", n.node, n.epoch, n.step, n.time)
}
// Creates a new node for generating unique IDs.
// To gurantee uniqueness, the given node ID must be unique.
func NewNode(node int64) *Node {
assert.Assert(nodeBits+stepBits == 22, "node and step bits must add up to 22")
assert.Assert(0 <= node && node <= NodeMax, "node must be within 0 and NodeMax", "node", node)
// NOTE(kyren): Credit to https://github.com/bwmarrin/snowflake
currentTime := time.Now()
// add time.Duration to currentTime to make sure we use the monotonic clock if available
epoch := currentTime.Add(time.Unix(Epoch/1000, (Epoch%1000)*1000000).Sub(currentTime))
return &Node{
node: node,
epoch: epoch,
}
}
// Generates a unique snowflake ID.
func (n *Node) Generate() ID {
n.mu.Lock()
defer n.mu.Unlock()
now := time.Since(n.epoch).Milliseconds()
if now == n.time {
n.step = (n.step + 1) & stepMask
for n.step == 0 && now <= n.time {
now = time.Since(n.epoch).Milliseconds()
}
} else {
n.step = 0
}
n.time = now
return ID((now << timeShift) | (n.node << nodeShift) | (n.step))
}
// Json marshling to avoid inprecision of json number (float64)
func (id ID) MarshalJSON() ([]byte, error) {
buffer := make([]byte, 0, 22) // 2 quotes, 19 digits, 1 sign
buffer = append(buffer, '"')
buffer = strconv.AppendInt(buffer, int64(id), 10)
buffer = append(buffer, '"')
return buffer, nil
}
func (id *ID) UnmarshalJSON(data []byte) error {
if len(data) < 3 || data[0] != '"' || data[len(data)-1] != '"' {
return fmt.Errorf("invalid snowflake ID %q", string(data))
}
num, err := strconv.ParseInt(string(data[1:len(data)-1]), 10, 64)
if err != nil {
return err
}
*id = ID(num)
return nil
}
|
