feat: add support for duration type with parsing, arithmetic operations, and program formatting

Author: ziflex

examples/google-search.fql

@@ -4,9 +4,9 @@ LET google = DOCUMENT("https://www.google.com/", {
 })
 
 HOVER(google, 'input[name="q"]')
-WAIT(RAND(100))
+WAIT(RAND(100) * 1ms)
 INPUT(google, 'input[name="q"]', @criteria, 30)
-WAIT(RAND(100))
+WAIT(RAND(100) * 1ms)
 CLICK(google, 'input[name="btnK"]')
 
 WAITFOR EVENT "navigation" IN google
@@ -20,4 +20,4 @@ FOR el IN results
         title: INNER_TEXT(el, 'h3')?,
         description: INNER_TEXT(el, X("//em/parent::*")),
         url: ELEMENT(el, 'a')?.attributes.href
-    }
+    }

examples/lazy-loading.fql

@@ -11,7 +11,7 @@ LET lastItem = 50
 
 LET preload = (
     FOR i DO WHILE !ELEMENT_EXISTS(doc, '.chartTracksEnd')
-        LET initial = i > 0 ? SCROLL_BOTTOM(doc) && WAIT(500) && SCROLL_TOP(doc) && false : true
+        LET initial = i > 0 ? SCROLL_BOTTOM(doc) && WAIT(500ms) && SCROLL_TOP(doc) && false : true
 
         RETURN NONE
 )
@@ -26,4 +26,3 @@ FOR track, i IN ELEMENTS(list, 'li')
     }
 
 
-

examples/pagination.fql

@@ -7,7 +7,7 @@ CLICK(amazon, '#nav-search-submit-button')
 
 WAITFOR EVENT "navigation" IN amazon
     FILTER current.url =~ "www\.amazon\.com\/s\?k="
-    TIMEOUT 50000
+    TIMEOUT 50s
 
 WAIT_ELEMENT(amazon, '[class*="template=PAGINATION"]')
 
@@ -84,4 +84,3 @@ LET result = (
 
 RETURN FLATTEN(result)
 
-

examples/pagination_uncontrolled.fql

@@ -6,7 +6,7 @@ CLICK(amazon, '#nav-search-submit-button')
 
 WAITFOR EVENT "navigation" IN amazon
     FILTER current.url =~ "www\.amazon\.com\/s\?k="
-    TIMEOUT 50000
+    TIMEOUT 50s
 
 LET resultListSelector = '[data-component-type="s-search-results"]'
 LET resultItemSelector = '[data-component-type="s-search-result"]'
@@ -39,4 +39,4 @@ LET result = (
         RETURN items
 )
 
-RETURN FLATTEN(result)
+RETURN FLATTEN(result)

examples/pagination_while.fql

@@ -6,7 +6,7 @@ WAIT_ELEMENT(doc, elementsSelector)
 
 FOR i DO WHILE ELEMENT_EXISTS(doc, nextSelector)
 	LET wait = i > 0 ? CLICK(doc, nextSelector) : false
-	LET nav = wait ? WAIT(2000) && WAIT_ELEMENT(doc, elementsSelector) : false
+	LET nav = wait ? WAIT(2s) && WAIT_ELEMENT(doc, elementsSelector) : false
 
 	FOR el IN ELEMENTS(doc, elementsSelector)
 		RETURN el

pkg/asm/duration_test.go

@@ -0,0 +1,16 @@
+package asm
+
+import (
+	"testing"
+	"time"
+
+	"github.com/MontFerret/ferret/v2/pkg/runtime"
+)
+
+func TestDurationConstantFormatting(t *testing.T) {
+	t.Parallel()
+
+	if got := constantAsText(runtime.NewDuration(1500 * time.Millisecond)); got != "1.5s" {
+		t.Fatalf("duration constant = %q, want 1.5s", got)
+	}
+}

pkg/asm/formatter.go

@@ -26,6 +26,10 @@ func constantAsText(constant runtime.Value) string {
 		return fmt.Sprintf("%d", constant)
 	}
 
+	if _, ok := constant.(runtime.Duration); ok {
+		return constant.String()
+	}
+
 	return fmt.Sprintf("%q", constant.String())
 }
 

pkg/bytecode/encoding.go

@@ -50,6 +50,13 @@ func encodeConstant(value runtime.Value) (constantJSON, error) {
 		return constantJSON{Type: encodeConstantType(runtime.TypeInt), Value: stdjson.RawMessage(strconv.FormatInt(int64(v), 10))}, nil
 	case runtime.Float:
 		return constantJSON{Type: encodeConstantType(runtime.TypeFloat), Value: stdjson.RawMessage(strconv.FormatFloat(float64(v), 'g', -1, 64))}, nil
+	case runtime.Duration:
+		encoded, err := json.Marshal(v.String())
+		if err != nil {
+			return constantJSON{}, err
+		}
+
+		return constantJSON{Type: encodeConstantType(runtime.TypeDuration), Value: encoded}, nil
 	case runtime.String:
 		encoded, err := json.Marshal(string(v))
 
@@ -123,6 +130,13 @@ func decodeConstant(frame constantJSON) (runtime.Value, error) {
 		}
 
 		return runtime.NewFloat(value), nil
+	case encodeConstantType(runtime.TypeDuration):
+		var value string
+		if err := json.Unmarshal(frame.Value, &value); err != nil {
+			return runtime.ZeroDuration, err
+		}
+
+		return runtime.ParseDuration(value)
 	case encodeConstantType(runtime.TypeString):
 		var value string
 

pkg/bytecode/format/json/format_test.go

@@ -42,6 +42,10 @@ func TestFormatRoundTrip(t *testing.T) {
 	if got := decoded.Metadata.AggregatePlans[0].Index["group"]; got != 0 {
 		t.Fatalf("expected aggregate plan index to be rebuilt, got %d", got)
 	}
+
+	if got := decoded.Constants[1]; got != runtime.NewDuration(1500*time.Millisecond) {
+		t.Fatalf("duration constant = %v (%T)", got, got)
+	}
 }
 
 func TestFormatRejectsMalformedPayload(t *testing.T) {
@@ -77,6 +81,16 @@ func TestFormatRejectsInvalidConstants(t *testing.T) {
 	if !errors.Is(err, bytecode.ErrInvalidConstant) {
 		t.Fatalf("expected ErrInvalidConstant for missing bool value, got %v", err)
 	}
+
+	invalidDuration := "not-a-duration"
+	frame = validFrame()
+	frame.Constants = []persist.ConstantFrame{{Type: "duration", Duration: &invalidDuration}}
+
+	data = mustMarshalFrame(t, frame)
+	_, err = Default.Unmarshal(data)
+	if !errors.Is(err, bytecode.ErrInvalidConstant) {
+		t.Fatalf("expected ErrInvalidConstant for malformed duration, got %v", err)
+	}
 }
 
 func TestFormatRejectsDuplicateHostsAndLabels(t *testing.T) {
@@ -165,6 +179,7 @@ func newTestProgram() *bytecode.Program {
 		},
 		Constants: []runtime.Value{
 			runtime.NewFloat(1.5),
+			runtime.NewDuration(1500 * time.Millisecond),
 			runtime.NewString("hello"),
 			runtime.NewBinary([]byte("abc")),
 			runtime.NewDateTime(time.Unix(1700000000, 0).UTC()),

pkg/bytecode/format/msgpack/format_test.go

@@ -35,6 +35,10 @@ func TestFormatRoundTrip(t *testing.T) {
 		t.Fatalf("expected aggregate plan index to be rebuilt, got %d", got)
 	}
 
+	if got := decoded.Constants[1]; got != runtime.NewDuration(1500*time.Millisecond) {
+		t.Fatalf("duration constant = %v (%T)", got, got)
+	}
+
 	if line, col := decoded.Source.LocationAt(source.Span{Start: 7, End: 7}); line == 0 || col == 0 {
 		t.Fatalf("expected source lines to be rebuilt, got line=%d col=%d", line, col)
 	}
@@ -73,6 +77,16 @@ func TestFormatRejectsInvalidConstants(t *testing.T) {
 	if !errors.Is(err, bytecode.ErrInvalidConstant) {
 		t.Fatalf("expected ErrInvalidConstant for missing datetime value, got %v", err)
 	}
+
+	invalidDuration := "not-a-duration"
+	frame = validFrame()
+	frame.Constants = []persist.ConstantFrame{{Type: "duration", Duration: &invalidDuration}}
+
+	data = mustMarshalFrame(t, frame)
+	_, err = Default.Unmarshal(data)
+	if !errors.Is(err, bytecode.ErrInvalidConstant) {
+		t.Fatalf("expected ErrInvalidConstant for malformed duration, got %v", err)
+	}
 }
 
 func TestFormatRejectsDuplicateHostsAndLabels(t *testing.T) {
@@ -161,6 +175,7 @@ func newTestProgram() *bytecode.Program {
 		},
 		Constants: []runtime.Value{
 			runtime.NewFloat(1.5),
+			runtime.NewDuration(1500 * time.Millisecond),
 			runtime.NewString("hello"),
 			runtime.NewBinary([]byte("abc")),
 			runtime.NewDateTime(time.Unix(1700000000, 0).UTC()),