utils

Documentation

Index

• func GenerateRandomPin() string
• func GetFirst[T any](opts []T) *T
• func GetRandomName() (string, error)
• func HasDryRun(r *http.Request) bool
• func HashName(b []byte) string
• func Must[T any](t T, err error) T
• func ResolveAndStripSemver(v string) ([]string, error)
• func SelfCheck(limits SelfCheckLimit, log logger.AppLogger, unhealhtyStreak int)
• func SortedMapKeys[T any](input map[string]T) []string
• type Batcher
  • func NewDirWatcher(path string) (*Batcher, error)
  • func (b *Batcher) Close()
• type BinaryMeta
  • func NewBinaryMeta(a interface{}) (*BinaryMeta, error)
  • func NewBinaryMetaFromBytes(b []byte) BinaryMeta
  • func (bm BinaryMeta) Equal(bm2 BinaryMeta) bool
• type IdentiHash
  • func NewIdentiHash(hash []byte) IdentiHash
• type ProjectDiffResponse
  • func NewProjectDiff(a, b any, input models.DiffSnapshotInput) (*ProjectDiffResponse, error)
• type ProjectStats
• type SelfCheckLimit
• type Suggestion
• type Suggestions
  • func SuggestionsFor(typedName string, stringSlice []string, maxDistance int, maxItems int) Suggestions
  • func (s Suggestions) Len() int
  • func (s Suggestions) Less(i, j int) bool
  • func (s Suggestions) String() string
  • func (s Suggestions) Swap(i, j int)
  • func (s Suggestions) ToStringSlice() []string

Examples

• ResolveAndStripSemver (Major)
• ResolveAndStripSemver (Minor)
• ResolveAndStripSemver (Patch)
• ResolveAndStripSemver (Prerelease)
• ResolveAndStripSemver (Sample)

Functions

func GenerateRandomPin

func GenerateRandomPin() string

func GetFirst

func GetFirst[T any](opts []T) *T

func GetRandomName

func GetRandomName() (string, error)

GetRandomName returns mnemonicoded random name

func HasDryRun

func HasDryRun(r *http.Request) bool

func HashName

func HashName(b []byte) string

func Must

func Must[T any](t T, err error) T

unwraps the first value, panics if err

func ResolveAndStripSemver

func ResolveAndStripSemver(v string) ([]string, error)

Example (Major)

vs, err := ResolveAndStripSemver("v1")
fmt.Println(err)
fmt.Println(vs)

Output:

<nil>
[1.0.0 1.0 1]

Example (Minor)

vs, err := ResolveAndStripSemver("v1.2")
fmt.Println(err)
fmt.Println(vs)

Output:

<nil>
[1.2.0 1.2 1]

Example (Patch)

vs, err := ResolveAndStripSemver("v1.2.3")
fmt.Println(err)
fmt.Println(vs)

Output:

<nil>
[1.2.3 1.2 1]

Example (Prerelease)

vs, err := ResolveAndStripSemver("v1.2.3-beta.1")
fmt.Println(err)
fmt.Println(vs)

Output:

<nil>
[1.2.3-beta.1]

Example (Sample)

vs, err := ResolveAndStripSemver("2.0.4")
fmt.Println(err)
fmt.Println(vs)

Output:

<nil>
[2.0.4 2.0 2]

func SelfCheck

func SelfCheck(limits SelfCheckLimit, log logger.AppLogger, unhealhtyStreak int)

SelfCheck will watch the applications metrics, and crash it if it is considered to be unhealthy. This is only for use outside of kubernetes/docker

func SortedMapKeys

func SortedMapKeys[T any](input map[string]T) []string

Types

type Batcher

type Batcher struct {
	Watcher *fsnotify.Watcher

	Events chan []fsnotify.Event // Events are returned on this channel
	// contains filtered or unexported fields
}

Batcher batches file watch events in a given interval.

func NewDirWatcher

func NewDirWatcher(path string) (*Batcher, error)

Watches a directory recursively Caller must call .Close

func (*Batcher) Close

func (b *Batcher) Close()

type BinaryMeta

type BinaryMeta struct {
	Hash          string `json:"hash"`
	Size          uint64 `json:"size"`
	SizeHumanized string `json:"size_humanized"`
	IdentiHash    []byte `json:"identi_hash"`
}

BinaryMeta is a humanized version of the raw data of an object

func NewBinaryMeta

func NewBinaryMeta(a interface{}) (*BinaryMeta, error)

func NewBinaryMetaFromBytes

func NewBinaryMetaFromBytes(b []byte) BinaryMeta

For consistency, input is expectd to be the return-type of json.Marshal(input), but works with any []byte

func (BinaryMeta) Equal

func (bm BinaryMeta) Equal(bm2 BinaryMeta) bool

type IdentiHash

type IdentiHash struct {
	Img  []byte
	Hash []byte
}

func NewIdentiHash

func NewIdentiHash(hash []byte) IdentiHash

type ProjectDiffResponse

type ProjectDiffResponse struct {
	Diff diff.Changelog `json:"diff"`
	A    ProjectStats   `json:"a"`
	B    ProjectStats   `json:"b"`
}

func NewProjectDiff

func NewProjectDiff(a, b any, input models.DiffSnapshotInput) (*ProjectDiffResponse, error)

type ProjectStats

type ProjectStats struct {
	BinaryMeta
	ProjectID string `json:"project_id"`
	Tag       string `json:"tag"`
}

type SelfCheckLimit

type SelfCheckLimit struct {
	MemoryMB   uint64
	GoRoutines int
	Streaks    int
}

type Suggestion

type Suggestion struct {
	Index               int
	Value               string
	LevenshteinDistance int
	From                string
}

type Suggestions

type Suggestions []Suggestion

func SuggestionsFor

func SuggestionsFor(typedName string, stringSlice []string, maxDistance int, maxItems int) Suggestions

func (Suggestions) Len

func (s Suggestions) Len() int

func (Suggestions) Less

func (s Suggestions) Less(i, j int) bool

func (Suggestions) String

func (s Suggestions) String() string

func (Suggestions) Swap

func (s Suggestions) Swap(i, j int)

func (Suggestions) ToStringSlice

func (s Suggestions) ToStringSlice() []string