v0.0.29

syncext/atomic.go

@@ -1,16 +1,21 @@
-package dataext
+package syncext
 
-import "sync/atomic"
+import (
+	"context"
+	"sync/atomic"
+	"time"
+)
 
 type AtomicBool struct {
-	v int32
+	v      int32
+	waiter chan bool // unbuffered
 }
 
 func NewAtomicBool(value bool) *AtomicBool {
 	if value {
-		return &AtomicBool{v: 0}
+		return &AtomicBool{v: 1, waiter: make(chan bool)}
 	} else {
-		return &AtomicBool{v: 1}
+		return &AtomicBool{v: 0, waiter: make(chan bool)}
 	}
 }
 
@@ -24,4 +29,76 @@ func (a *AtomicBool) Set(value bool) {
 	} else {
 		atomic.StoreInt32(&a.v, 0)
 	}
+
+	select {
+	case a.waiter <- value:
+		// message sent
+	default:
+		// no receiver on channel
+	}
+}
+
+func (a *AtomicBool) Wait(waitFor bool) {
+	if a.Get() == waitFor {
+		return
+	}
+
+	for {
+		if v, ok := ReadChannelWithTimeout(a.waiter, 128*time.Millisecond); ok {
+			if v == waitFor {
+				return
+			}
+		} else {
+			if a.Get() == waitFor {
+				return
+			}
+		}
+	}
+}
+
+func (a *AtomicBool) WaitWithTimeout(timeout time.Duration, waitFor bool) error {
+	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+	defer cancel()
+	return a.WaitWithContext(ctx, waitFor)
+}
+
+func (a *AtomicBool) WaitWithContext(ctx context.Context, waitFor bool) error {
+	if err := ctx.Err(); err != nil {
+		return err
+	}
+
+	if a.Get() == waitFor {
+		return nil
+	}
+
+	for {
+		if err := ctx.Err(); err != nil {
+			return err
+		}
+
+		timeOut := 128 * time.Millisecond
+
+		if dl, ok := ctx.Deadline(); ok {
+			timeOutMax := dl.Sub(time.Now())
+			if timeOutMax <= 0 {
+				timeOut = 0
+			} else if 0 < timeOutMax && timeOutMax < timeOut {
+				timeOut = timeOutMax
+			}
+		}
+
+		if v, ok := ReadChannelWithTimeout(a.waiter, timeOut); ok {
+			if v == waitFor {
+				return nil
+			}
+		} else {
+			if err := ctx.Err(); err != nil {
+				return err
+			}
+
+			if a.Get() == waitFor {
+				return nil
+			}
+		}
+	}
 }

syncext/channel.go

@@ -0,0 +1,45 @@
+package syncext
+
+import (
+	"time"
+)
+
+// https://gobyexample.com/non-blocking-channel-operations
+// https://gobyexample.com/timeouts
+// https://groups.google.com/g/golang-nuts/c/Oth9CmJPoqo
+
+func ReadChannelWithTimeout[T any](c chan T, timeout time.Duration) (T, bool) {
+	select {
+	case msg := <-c:
+		return msg, true
+	case <-time.After(timeout):
+		return *new(T), false
+	}
+}
+
+func WriteChannelWithTimeout[T any](c chan T, msg T, timeout time.Duration) bool {
+	select {
+	case c <- msg:
+		return true
+	case <-time.After(timeout):
+		return false
+	}
+}
+
+func ReadNonBlocking[T any](c chan T) (T, bool) {
+	select {
+	case msg := <-c:
+		return msg, true
+	default:
+		return *new(T), false
+	}
+}
+
+func WriteNonBlocking[T any](c chan T, msg T) bool {
+	select {
+	case c <- msg:
+		return true
+	default:
+		return false
+	}
+}

syncext/channel_test.go

@@ -0,0 +1,121 @@
+package syncext
+
+import (
+	"testing"
+	"time"
+)
+
+func TestTimeoutReadBuffered(t *testing.T) {
+	c := make(chan int, 1)
+
+	go func() {
+		time.Sleep(200 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if ok {
+		t.Error("Read success, but should timeout")
+	}
+}
+
+func TestTimeoutReadBigBuffered(t *testing.T) {
+	c := make(chan int, 128)
+
+	go func() {
+		time.Sleep(200 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if ok {
+		t.Error("Read success, but should timeout")
+	}
+}
+
+func TestTimeoutReadUnbuffered(t *testing.T) {
+	c := make(chan int)
+
+	go func() {
+		time.Sleep(200 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if ok {
+		t.Error("Read success, but should timeout")
+	}
+}
+
+func TestNoTimeoutAfterStartReadBuffered(t *testing.T) {
+	c := make(chan int, 1)
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if !ok {
+		t.Error("Read timeout, but should have succeeded")
+	}
+}
+
+func TestNoTimeoutAfterStartReadBigBuffered(t *testing.T) {
+	c := make(chan int, 128)
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if !ok {
+		t.Error("Read timeout, but should have succeeded")
+	}
+}
+
+func TestNoTimeoutAfterStartReadUnbuffered(t *testing.T) {
+	c := make(chan int)
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		c <- 112
+	}()
+
+	_, ok := ReadChannelWithTimeout(c, 100*time.Millisecond)
+
+	if !ok {
+		t.Error("Read timeout, but should have succeeded")
+	}
+
+}
+
+func TestNoTimeoutBeforeStartReadBuffered(t *testing.T) {
+	c := make(chan int, 1)
+
+	c <- 112
+
+	_, ok := ReadChannelWithTimeout(c, 10*time.Millisecond)
+
+	if !ok {
+		t.Error("Read timeout, but should have succeeded")
+	}
+}
+
+func TestNoTimeoutBeforeStartReadBigBuffered(t *testing.T) {
+	c := make(chan int, 128)
+
+	c <- 112
+
+	_, ok := ReadChannelWithTimeout(c, 10*time.Millisecond)
+
+	if !ok {
+		t.Error("Read timeout, but should have succeeded")
+	}
+}

timeext/parser.go

@@ -0,0 +1,152 @@
+package timeext
+
+import (
+	"errors"
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+)
+
+var durationShortStringMap = map[string]time.Duration{
+	"ns":          time.Nanosecond,
+	"nanosecond":  time.Nanosecond,
+	"nanoseconds": time.Nanosecond,
+
+	"us":           time.Microsecond,
+	"microsecond":  time.Microsecond,
+	"microseconds": time.Microsecond,
+
+	"ms":           time.Millisecond,
+	"millisecond":  time.Millisecond,
+	"milliseconds": time.Millisecond,
+
+	"s":       time.Second,
+	"sec":     time.Second,
+	"second":  time.Second,
+	"seconds": time.Second,
+
+	"m":       time.Minute,
+	"min":     time.Minute,
+	"minute":  time.Minute,
+	"minutes": time.Minute,
+
+	"h":     time.Hour,
+	"hour":  time.Hour,
+	"hours": time.Hour,
+
+	"d":    24 * time.Hour,
+	"day":  24 * time.Hour,
+	"days": 24 * time.Hour,
+
+	"w":     7 * 24 * time.Hour,
+	"wk":    7 * 24 * time.Hour,
+	"week":  7 * 24 * time.Hour,
+	"weeks": 7 * 24 * time.Hour,
+}
+
+// ParseDurationShortString parses a duration in string format to a time.Duration
+// Examples for allowed formats:
+//   - '10m'
+//   - '10min'
+//   - '1minute'
+//   - '10minutes'
+//   - '10.5minutes'
+//   - '50s'
+//   - '50sec'
+//   - '1second'
+//   - '50seconds'
+//   - '100ms'
+//   - '100millisseconds'
+//   - '1h'
+//   - '1hour'
+//   - '2hours'
+//   - '1d'
+//   - '1day'
+//   - '10days'
+//   - '1d10m'
+//   - '1d10m200sec'
+//   - '1d:10m'
+//   - '1d 10m'
+//   - '1d,10m'
+func ParseDurationShortString(s string) (time.Duration, error) {
+	s = strings.ToLower(s)
+
+	segments := make([]string, 0)
+	collector := ""
+
+	prevWasNum := true
+	for _, chr := range s {
+		if chr >= '0' && chr <= '9' || chr == '.' {
+			if prevWasNum {
+				collector += string(chr)
+			} else {
+				segments = append(segments, collector)
+				prevWasNum = true
+				collector = string(chr)
+			}
+		} else if chr == ' ' || chr == ':' || chr == ',' {
+			continue
+		} else if chr >= 'a' && chr <= 'z' {
+			prevWasNum = false
+			collector += string(chr)
+		} else {
+			return 0, errors.New("unexpected character: " + string(chr))
+		}
+	}
+	if !prevWasNum {
+		segments = append(segments, collector)
+	}
+
+	result := time.Duration(0)
+	for _, seg := range segments {
+		segDur, err := parseDurationShortStringSegment(seg)
+		if err != nil {
+			return 0, err
+		}
+		result += segDur
+	}
+	return result, nil
+}
+
+func parseDurationShortStringSegment(segment string) (time.Duration, error) {
+	num := ""
+	unit := ""
+
+	part0 := true
+	for _, chr := range segment {
+		if part0 {
+
+			if chr >= 'a' && chr <= 'z' {
+				part0 = false
+				unit += string(chr)
+			} else if chr >= '0' && chr <= '9' || chr == '.' {
+				num += string(chr)
+			} else {
+				return 0, errors.New(fmt.Sprintf("Unexpected character '%s' in segment [%s]", string(chr), segment))
+			}
+
+		} else {
+
+			if chr >= 'a' && chr <= 'z' {
+				unit += string(chr)
+			} else if chr >= '0' && chr <= '9' || chr == '.' {
+				return 0, errors.New(fmt.Sprintf("Unexpected number '%s' in segment [%s]", string(chr), segment))
+			} else {
+				return 0, errors.New(fmt.Sprintf("Unexpected character '%s' in segment [%s]", string(chr), segment))
+			}
+
+		}
+	}
+
+	fpnum, err := strconv.ParseFloat(num, 64)
+	if err != nil {
+		return 0, errors.New(fmt.Sprintf("Failed to parse floating-point number '%s' in segment [%s]", num, segment))
+	}
+
+	if mult, ok := durationShortStringMap[unit]; ok {
+		return time.Duration(int64(fpnum * float64(mult))), nil
+	} else {
+		return 0, errors.New(fmt.Sprintf("Unknown unit '%s' in segment [%s]", unit, segment))
+	}
+}

timeext/parser_test.go

@@ -0,0 +1,70 @@
+package timeext
+
+import (
+	"testing"
+	"time"
+)
+
+func TestParseDurationShortString(t *testing.T) {
+
+	assertPDSSEqual(t, FromSeconds(1), "1s")
+	assertPDSSEqual(t, FromSeconds(1), "1sec")
+	assertPDSSEqual(t, FromSeconds(1), "1second")
+	assertPDSSEqual(t, FromSeconds(1), "1seconds")
+	assertPDSSEqual(t, FromSeconds(100), "100second")
+	assertPDSSEqual(t, FromSeconds(100), "100seconds")
+	assertPDSSEqual(t, FromSeconds(1883639.77), "1883639.77second")
+	assertPDSSEqual(t, FromSeconds(1883639.77), "1883639.77seconds")
+	assertPDSSEqual(t, FromSeconds(50), "50s")
+	assertPDSSEqual(t, FromSeconds(50), "50sec")
+	assertPDSSEqual(t, FromSeconds(1), "1second")
+	assertPDSSEqual(t, FromSeconds(50), "50seconds")
+
+	assertPDSSEqual(t, FromMinutes(10), "10m")
+	assertPDSSEqual(t, FromMinutes(10), "10min")
+	assertPDSSEqual(t, FromMinutes(1), "1minute")
+	assertPDSSEqual(t, FromMinutes(10), "10minutes")
+	assertPDSSEqual(t, FromMinutes(10.5), "10.5minutes")
+
+	assertPDSSEqual(t, FromMilliseconds(100), "100ms")
+	assertPDSSEqual(t, FromMilliseconds(100), "100milliseconds")
+	assertPDSSEqual(t, FromMilliseconds(100), "100millisecond")
+
+	assertPDSSEqual(t, FromNanoseconds(99235), "99235ns")
+	assertPDSSEqual(t, FromNanoseconds(99235), "99235nanoseconds")
+	assertPDSSEqual(t, FromNanoseconds(99235), "99235nanosecond")
+
+	assertPDSSEqual(t, FromMicroseconds(99235), "99235us")
+	assertPDSSEqual(t, FromMicroseconds(99235), "99235microseconds")
+	assertPDSSEqual(t, FromMicroseconds(99235), "99235microsecond")
+
+	assertPDSSEqual(t, FromHours(1), "1h")
+	assertPDSSEqual(t, FromHours(1), "1hour")
+	assertPDSSEqual(t, FromHours(2), "2hours")
+
+	assertPDSSEqual(t, FromDays(1), "1d")
+	assertPDSSEqual(t, FromDays(1), "1day")
+	assertPDSSEqual(t, FromDays(10), "10days")
+	assertPDSSEqual(t, FromDays(1), "1days")
+	assertPDSSEqual(t, FromDays(10), "10day")
+
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10), "1d10m")
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10)+FromSeconds(200), "1d10m200sec")
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10), "1d:10m")
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10), "1d 10m")
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10), "1d,10m")
+	assertPDSSEqual(t, FromDays(1)+FromMinutes(10), "1d, 10m")
+	assertPDSSEqual(t, FromDays(1)+FromSeconds(1000), "1d   1000seconds")
+
+	assertPDSSEqual(t, FromDays(1), "86400s")
+}
+
+func assertPDSSEqual(t *testing.T, expected time.Duration, fmt string) {
+	actual, err := ParseDurationShortString(fmt)
+	if err != nil {
+		t.Errorf("ParseDurationShortString('%s') failed with %v", fmt, err)
+	}
+	if actual != expected {
+		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual.String(), expected.String())
+	}
+}