jaevor / go-nanoid Goto Github PK

View Code? Open in Web Editor NEW

432.0 2.0 18.0 216 KB

Nano ID for Go

Home Page: https://pkg.go.dev/github.com/jaevor/go-nanoid

License: GNU General Public License v3.0

Makefile 1.03% Go 98.97%

go nanoid guid uuid golang

go-nanoid's Introduction

go-nanoid

This module is a Go implementation of ai/nanoid.

go get github.com/jaevor/go-nanoid

import (
	"log"
	"github.com/jaevor/go-nanoid"
)

func main() {
	gen, err := nanoid.Canonic()
	if err != nil {
		panic(err)
	}

	id1 := gen()
	log.Printf("ID 1: %s", id1) // eLySUP3NTA48paA9mLK3V

	// Makes sense to use CustomASCII since 0-9 is ASCII.
	decenaryID, err := nanoid.CustomASCII("0123456789", 12)
	if err != nil {
		panic(err)
	}

	id2 := decenaryID()
	log.Printf("ID 2: %s", id2) // 817411560404
}

Note

This module's functions use an internal buffered slice of random bytes, and thus also a mutex. This slight (but constant) overhead of memory per generator allows it to be very efficient, but may not be ideal if you are only generating an ID every now and then.

Security

Benchmarks

All benchmarks & tests are in nanoid_test.go.

These are all benchmarks of nanoid.Standard(#)

# of characters & # of IDs	benchmark screenshot
8, ~21,800,000
21, ~16,400,000
36, ~11,500,000
255, ~2,500,000

Credits & references

License

GNU General Public License v3.0

go-nanoid's People

Contributors

Stargazers

Watchers

Forkers

imfantuan 0xflotus 0xforked suminwen xuwupeng2000 zn-yuan b26 phial3 spokelse-net anima-os-dev sjclijie gozelle andy-v-h erebusbat mryee2023 ramonberrutti cheyunhua metcalfc

go-nanoid's Issues

Why is used sync.Mutex?

Reading this function I noticed you use sync,Mutex to lock a variable, however you are not using any go routine, so my question is about the purpose of this?

https://github.com/jaevor/go-nanoid/blob/master/nanoid.go#L84C9-L84C19

As 21 is the "canonic" length for `nanoid.Standard(int length)`, why not add a `nanoid.StandardCanonic()` method?

I was wondering if it made sense to create a nanoid.StandardCanonical() method (with no parameters) in order to avoid having to remember that 21 is the canonic length every time.

In other words, whoever wants a canonic generator could choose one between:

nanoid.Standard(21)

nanoid.StandardCanonic()

nanoid.ASCII doesn't have a flat distribution and isn't using the full charset

Notice the lack of numbers and lowercase letters in the below sample. Using go 1.22.2 and github.com/jaevor/go-nanoid v1.4.0

	generator, err = nanoid.ASCII(32)
	if err != nil {
		panic(err)
	}

	for range 10 {
		fmt.Println(generator())
	}

Result:

IJ!YZQ#YI@}}~Q@},AJB~}AR+Q?RBIIB
?}!}R,~?YQ,I!R,IR,BA#A+~}A+AYQ@A
#~@!Y}IQ#JQ,QQBYBRQI}}#,QZZB}YB~
BI?J,Y+YI@~+Y#??Q@ZYY+Y?@#YJ}AR+
B+,A}Z@IQZZIA,!!#}!ZB?Y,I#Q}IA!!
}~RQBI@+AZ~@B}RB~?~,?}#R}AQ@B}AA
RQ}I+A#YAQB~Y?I}BI!~I!Q?,QI~??YY
@Q+}~!,R}~,RJ#+?+#@#IJJI~!J!Z@YA
?~!~!IQB~+YI~,I~#}!BZ+!?#JZ!YJ?,
#Y}!@~~R#YZ}Y,A!+}!JZ!RAQ?RQ+IJ+

It fails the below test that I added manually in my local environment.

func TestASCIIFlatDistribution(t *testing.T) {
	tries := 500_000

	length := 90
	hits := make(map[rune]int)

	f, err := nanoid.ASCII(length)
	if err != nil {
		panic(err)
	}

	for i := 0; i < tries; i++ {
		id := f()
		for _, r := range id {
			hits[r]++
		}
	}

	for _, count := range hits {
		require.InEpsilon(t, length*tries/90, count, 0.01, "should have flat-distribution")
	}
}

runtime error: index out of range [90] with length 90

Some times I'm getting this panic on nanoid use.

github.com/jaevor/go-nanoid.ASCII.func1()
/Users/deferbot/go/pkg/mod/github.com/jaevor/[email protected]/nanoid.go:269 +0x1f0

REF: MustCompile

Would be nice to have MustCompile option like regex module.

Example with init()

var newNanoId func() string

func init() {
    var err error
    newNanoId, err = nanoid.CustomASCII("0123456789abcdefghijklmnopqrstuvxyz", 4)
    if err != nil {
        panic("nanoid: " + err.Error())
    }
}

This would be nicer

var newNanoId = nanoid.MustCompileCustomASCII("0123456789abcdefghijklmnopqrstuvxyz", 4)

Nanoid version? Advantages over matoous?

Can you comment on what major version of nanoid this library is based on? Their current library is at v4.

What are the advantages against matoous? Any benchmark improvement vs that library?