Skip to content

Commit

Permalink
refactor guid out of utils (#730)
Browse files Browse the repository at this point in the history
* refactor guid out of utils

* cleanup
  • Loading branch information
paulwe authored Jun 6, 2024
1 parent 90207b4 commit d5e9f0a
Show file tree
Hide file tree
Showing 5 changed files with 214 additions and 148 deletions.
3 changes: 2 additions & 1 deletion auth/accesstoken_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (

"github.com/livekit/protocol/livekit"
"github.com/livekit/protocol/utils"
"github.com/livekit/protocol/utils/guid"
)

func TestAccessToken(t *testing.T) {
Expand Down Expand Up @@ -100,5 +101,5 @@ func TestAccessToken(t *testing.T) {
}

func apiKeypair() (string, string) {
return utils.NewGuid(utils.APIKeyPrefix), utils.RandomSecret()
return guid.New(utils.APIKeyPrefix), utils.RandomSecret()
}
5 changes: 3 additions & 2 deletions sip/sip.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ import (
"github.com/livekit/protocol/logger"
"github.com/livekit/protocol/rpc"
"github.com/livekit/protocol/utils"
"github.com/livekit/protocol/utils/guid"
)

func NewCallID() string {
return utils.NewGuid(utils.SIPCallPrefix)
return guid.New(utils.SIPCallPrefix)
}

type ErrNoDispatchMatched struct {
Expand Down Expand Up @@ -419,7 +420,7 @@ func EvaluateDispatchRule(rule *livekit.SIPDispatchRuleInfo, req *rpc.EvaluateSI
case *livekit.SIPDispatchRule_DispatchRuleIndividual:
// TODO: Do we need to escape specific characters in the number?
// TODO: Include actual SIP call ID in the room name?
room = fmt.Sprintf("%s_%s_%s", rule.DispatchRuleIndividual.GetRoomPrefix(), from, utils.NewGuid(""))
room = fmt.Sprintf("%s_%s_%s", rule.DispatchRuleIndividual.GetRoomPrefix(), from, guid.New(""))
}
return &rpc.EvaluateSIPDispatchRulesResponse{
SipDispatchRuleId: rule.SipDispatchRuleId,
Expand Down
178 changes: 178 additions & 0 deletions utils/guid/id.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
// Copyright 2023 LiveKit, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package guid

import (
"crypto/rand"
"crypto/sha1"
"fmt"
mrand "math/rand/v2"
"os"
"sync"

"github.com/jxskiss/base62"
"github.com/lithammer/shortuuid/v4"

"github.com/livekit/protocol/livekit"
"github.com/livekit/protocol/utils/must"
)

const (
Size = 12
guidScratchSize = Size + 10
)

const (
RoomPrefix = "RM_"
NodePrefix = "ND_"
ParticipantPrefix = "PA_"
TrackPrefix = "TR_"
APIKeyPrefix = "API"
EgressPrefix = "EG_"
IngressPrefix = "IN_"
SIPTrunkPrefix = "ST_"
SIPDispatchRulePrefix = "SDR_"
SIPCallPrefix = "SCL_"
RPCPrefix = "RPC_"
WHIPResourcePrefix = "WH_"
RTMPResourcePrefix = "RT_"
URLResourcePrefix = "UR_"
AgentWorkerPrefix = "AW_"
AgentJobPrefix = "AJ_"
)

var guidGeneratorPool = sync.Pool{
New: func() any {
return must.Get(newGenerator(guidScratchSize))
},
}

func New(prefix string) string {
g := guidGeneratorPool.Get().(*guidGenerator)
defer guidGeneratorPool.Put(g)
return g.New(prefix)
}

// HashedID creates a hashed ID from a unique string
func HashedID(id string) string {
h := sha1.New()
h.Write([]byte(id))
val := h.Sum(nil)

return base62.EncodeToString(val)
}

func LocalNodeID() (string, error) {
hostname, err := os.Hostname()
if err != nil {
return "", err
}
return fmt.Sprintf("%s%s", NodePrefix, HashedID(hostname)[:8]), nil
}

var b57Index = newB57Index()
var b57Chars = []byte(shortuuid.DefaultAlphabet)

func newB57Index() [256]byte {
var index [256]byte
for i := 0; i < len(b57Chars); i++ {
index[b57Chars[i]] = byte(i)
}
return index
}

type guidGenerator struct {
scratch []byte
rng *mrand.ChaCha8
}

func newGenerator(scratchSize int) (*guidGenerator, error) {
var seed [32]byte
if _, err := rand.Read(seed[:]); err != nil {
return nil, err
}

return &guidGenerator{
scratch: make([]byte, scratchSize),
rng: mrand.NewChaCha8(seed),
}, nil
}

func (g *guidGenerator) readIDChars(b []byte) {
var n int
for {
r := g.rng.Uint64()
for i := 0; i < 10; i++ {
if int(r&0x3f) < len(b57Chars) {
b[n] = b57Chars[r&0x3f]
n++
if n == len(b) {
return
}
}
r >>= 6
}
}
}

func (g *guidGenerator) New(prefix string) string {
s := append(g.scratch[:0], make([]byte, len(prefix)+Size)...)
copy(s, prefix)
g.readIDChars(s[len(prefix):])
return string(s)
}

func guidPrefix[T livekit.Guid]() string {
var id T
switch any(id).(type) {
case livekit.TrackID:
return TrackPrefix
case livekit.ParticipantID:
return ParticipantPrefix
case livekit.RoomID:
return RoomPrefix
default:
panic("unreachable")
}
}

func Marshal[T livekit.Guid](id T) livekit.GuidBlock {
var b livekit.GuidBlock
idb := []byte(id)[len(id)-Size:]
for i := 0; i < 3; i++ {
j := i * 3
k := i * 4
b[j] = b57Index[idb[k]]<<2 | b57Index[idb[k+1]]>>4
b[j+1] = b57Index[idb[k+1]]<<4 | b57Index[idb[k+2]]>>2
b[j+2] = b57Index[idb[k+2]]<<6 | b57Index[idb[k+3]]
}
return b
}

func Unmarshal[T livekit.Guid](b livekit.GuidBlock) T {
prefix := guidPrefix[T]()
id := make([]byte, len(prefix)+Size)
copy(id, []byte(prefix))
idb := id[len(prefix):]
for i := 0; i < 3; i++ {
j := i * 3
k := i * 4
idb[k] = b57Chars[b[j]>>2]
idb[k+1] = b57Chars[(b[j]&3)<<4|b[j+1]>>4]
idb[k+2] = b57Chars[(b[j+1]&15)<<2|b[j+2]>>6]
idb[k+3] = b57Chars[b[j+2]&63]
}
return T(id)
}
16 changes: 8 additions & 8 deletions utils/id_test.go → utils/guid/id_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package utils
package guid

import (
"testing"
Expand All @@ -22,20 +22,20 @@ import (
"github.com/livekit/protocol/livekit"
)

func TestMarshalUnmarshalGuid(t *testing.T) {
id0 := livekit.TrackID(NewGuid(TrackPrefix))
b0 := MarshalGuid(id0)
id1 := UnmarshalGuid[livekit.TrackID](b0)
b1 := MarshalGuid(id1)
func TestMarshalUnmarshal(t *testing.T) {
id0 := livekit.TrackID(New(TrackPrefix))
b0 := Marshal(id0)
id1 := Unmarshal[livekit.TrackID](b0)
b1 := Marshal(id1)
require.EqualValues(t, id0, id1)
require.EqualValues(t, b0, b1)
}

func BenchmarkNewGuid(b *testing.B) {
func BenchmarkNew(b *testing.B) {
b.Run("new", func(b *testing.B) {
var guid string
for i := 0; i < b.N; i++ {
guid = NewGuid(TrackPrefix)
guid = New(TrackPrefix)
}
_ = guid
})
Expand Down
Loading

0 comments on commit d5e9f0a

Please sign in to comment.