tariff: support cron expressions for refresh scheduling

Author: tilalx

assets/js/components/Config/PropertyField.vue

@@ -94,7 +94,7 @@
 				:list="datalistId"
 				:type="inputType"
 				:step="step"
-				:placeholder="placeholder"
+				:placeholder="effectivePlaceholder"
 				:required="required"
 				:pattern="patternRegex"
 				:title="patternTitle"
@@ -191,13 +191,40 @@ export default {
 	},
 	emits: ["update:modelValue"],
 	data: () => {
-		return { selectMode: false, unitOverride: null };
+		return { selectMode: false, unitOverride: null, cronMode: false };
+	},
+	created() {
+		// start in cron mode if the existing value isn't a parseable duration
+		if (
+			this.cronCapable &&
+			typeof this.modelValue === "string" &&
+			this.modelValue !== "" &&
+			parseGoDuration(this.modelValue) === null
+		) {
+			this.cronMode = true;
+		}
 	},
 	computed: {
+		cronCapable() {
+			return this.property === "interval" && this.type === "Duration";
+		},
+		cronActive() {
+			return this.cronCapable && this.cronMode;
+		},
+		effectivePlaceholder() {
+			if (this.cronActive) return "15 0 * * *";
+			return this.placeholder;
+		},
+		// loose guardrail matching cron forms while rejecting a plain duration like "1h"; backend is authoritative
+		cronPattern() {
+			return "@(annually|yearly|monthly|weekly|daily|midnight|hourly|reboot)|@every\\s+\\S+|(\\S+\\s+){4,5}\\S+";
+		},
 		patternRegex() {
+			if (this.cronActive) return this.cronPattern;
 			return this.pattern.Regex || null;
 		},
 		patternTitle() {
+			if (this.cronActive) return this.$t("config.form.cronInvalid");
 			const examples = this.pattern.Examples || [];
 			if (!examples.length) return null;
 			return examples.join(", ");
@@ -229,6 +256,9 @@ export default {
 			if (this.masked) {
 				return "password";
 			}
+			if (this.cronActive) {
+				return "text";
+			}
 			if (["Int", "Float", "Duration", "PricePerKWh"].includes(this.type)) {
 				return "number";
 			}
@@ -254,6 +284,9 @@ export default {
 			return result;
 		},
 		endAlign() {
+			if (this.cronActive) {
+				return false;
+			}
 			return ["Int", "Float", "Duration", "PricePerKWh"].includes(this.type);
 		},
 		step() {
@@ -263,6 +296,9 @@ export default {
 			return null;
 		},
 		unitValue() {
+			if (this.cronActive) {
+				return this.$t("config.form.cron");
+			}
 			if (this.type === "Duration") {
 				return this.fmtDurationUnit(this.value, this.durationUnit);
 			}
@@ -324,16 +360,27 @@ export default {
 			return displayFactors[this.durationUnit] ?? 1;
 		},
 		durationUnit() {
+			if (this.cronActive) {
+				return "cron";
+			}
 			return this.unitOverride ?? goDurationUnit(this.modelValue) ?? this.unit ?? "second";
 		},
 		unitSelectable() {
 			return this.type === "Duration" && !this.legacyDuration && !this.disabled;
 		},
 		unitOptions() {
-			return durationUnits.map((value) => ({
+			const options = durationUnits.map((value) => ({
 				value,
 				name: this.fmtDurationUnit(2, value),
 			}));
+			// interval fields can also be driven by a cron expression
+			if (this.cronCapable) {
+				options.push({
+					value: "cron",
+					name: this.$t("config.form.cron"),
+				});
+			}
+			return options;
 		},
 		selectOptions() {
 			if (this.chargeModes) {
@@ -363,6 +410,10 @@ export default {
 		},
 		value: {
 			get() {
+				if (this.cronActive) {
+					return this.modelValue ?? "";
+				}
+
 				if (this.select && this.modelValue == null) {
 					return "";
 				}
@@ -399,6 +450,11 @@ export default {
 				return this.modelValue;
 			},
 			set(value) {
+				if (this.cronActive) {
+					this.$emit("update:modelValue", value);
+					return;
+				}
+
 				let newValue = value;
 
 				if (this.scale) {
@@ -431,12 +487,22 @@ export default {
 			return val;
 		},
 		onUnitChange(e) {
-			// read display value before override changes the getter's unit
-			const num = this.value;
-			this.unitOverride = e.target.value;
-			if (typeof num === "number") {
-				this.$emit("update:modelValue", toGoDuration(num, this.unitOverride));
+			const unit = e.target.value;
+
+			if (unit === "cron") {
+				this.cronMode = true;
+				this.$emit("update:modelValue", "");
+				return;
+			}
+
+			// a cron expression can't convert to a duration, so clear it
+			if (this.cronActive) {
+				this.cronMode = false;
+				this.unitOverride = unit;
+				this.$emit("update:modelValue", "");
+				return;
 			}
+			this.unitOverride = unit;
 		},
 		onFieldChange(e) {
 			// unparsable input (e.g. locale decimal separator mismatch)

go.mod

@@ -82,6 +82,7 @@ require (
 	github.com/prometheus/client_golang v1.24.1
 	github.com/prometheus/common v0.70.1
 	github.com/robertkrimen/otto v0.5.1
+	github.com/robfig/cron/v3 v3.0.1
 	github.com/samber/lo v1.53.0
 	github.com/sandrolain/httpcache v1.4.2
 	github.com/sethvargo/go-password v0.4.0

go.sum

@@ -461,6 +461,8 @@ github.com/rickb777/plural v1.4.7 h1:rBRAxp9aTFYzWTLWIE/UTwKcaqSSAV2ml7aOUFYpAGo
 github.com/rickb777/plural v1.4.7/go.mod h1:DB19dtrplGS5s6VJVHn7tvmFYPoE83p1xqio3oVnNRM=
 github.com/robertkrimen/otto v0.5.1 h1:avDI4ToRk8k1hppLdYFTuuzND41n37vPGJU7547dGf0=
 github.com/robertkrimen/otto v0.5.1/go.mod h1:bS433I4Q9p+E5pZLu7r17vP6FkE6/wLxBdmKjoqJXF8=
+github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
+github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=

i18n/de.json

@@ -314,6 +314,8 @@
       "titleEdit": "Zusätzlichen Zähler bearbeiten"
     },
     "form": {
+      "cron": "Cron",
+      "cronInvalid": "Cron-Ausdruck wie 15 0 * * * oder @daily eingeben, keine Dauer",
       "danger": "Achtung",
       "deprecated": "veraltet",
       "durationUnit": "Zeiteinheit für {label}",

i18n/en.json

@@ -314,6 +314,8 @@
       "titleEdit": "Edit Additional Meter"
     },
     "form": {
+      "cron": "cron",
+      "cronInvalid": "Enter a cron expression like 15 0 * * * or @daily, not a duration",
       "danger": "Danger",
       "deprecated": "deprecated",
       "durationUnit": "Time unit for {label}",

tariff/amber.go

@@ -23,6 +23,7 @@ type Amber struct {
 	uri     string
 	channel string
 	data    *util.Monitor[api.Rates]
+	timer   *refreshTimer
 }
 
 var _ api.Tariff = (*Amber)(nil)
@@ -33,10 +34,11 @@ func init() {
 
 func NewAmberFromConfig(other map[string]any) (api.Tariff, error) {
 	var cc struct {
-		embed   `mapstructure:",squash"`
-		Token   string
-		SiteID  string
-		Channel string
+		embed    `mapstructure:",squash"`
+		schedule `mapstructure:",squash"`
+		Token    string
+		SiteID   string
+		Channel  string
 	}
 
 	if err := util.DecodeOther(other, &cc); err != nil {
@@ -55,6 +57,11 @@ func NewAmberFromConfig(other map[string]any) (api.Tariff, error) {
 		return nil, errors.New("missing channel")
 	}
 
+	timer, err := cc.schedule.timer(time.Minute)
+	if err != nil {
+		return nil, err
+	}
+
 	log := util.NewLogger("amber").Redact(cc.Token)
 
 	t := &Amber{
@@ -63,7 +70,8 @@ func NewAmberFromConfig(other map[string]any) (api.Tariff, error) {
 		Helper:  request.NewHelper(log),
 		uri:     fmt.Sprintf(amber.URI, strings.ToUpper(cc.SiteID)),
 		channel: strings.ToLower(cc.Channel),
-		data:    util.NewMonitor[api.Rates](2 * time.Hour),
+		data:    util.NewMonitor[api.Rates](max(2*time.Hour, timer.window())),
+		timer:   timer,
 	}
 
 	t.Client.Transport = &transport.Decorator{
@@ -79,7 +87,7 @@ func NewAmberFromConfig(other map[string]any) (api.Tariff, error) {
 func (t *Amber) run(done chan error) {
 	var once sync.Once
 
-	for tick := time.Tick(time.Minute); ; <-tick {
+	for tick := t.timer.C(); ; <-tick {
 		var res []amber.PriceInfo
 
 		if err := backoff.Retry(func() error {

tariff/awattar.go

@@ -16,9 +16,10 @@ import (
 
 type Awattar struct {
 	*embed
-	log  *util.Logger
-	uri  string
-	data *util.Monitor[api.Rates]
+	log   *util.Logger
+	uri   string
+	data  *util.Monitor[api.Rates]
+	timer *refreshTimer
 }
 
 var _ api.Tariff = (*Awattar)(nil)
@@ -29,8 +30,9 @@ func init() {
 
 func NewAwattarFromConfig(other map[string]any) (api.Tariff, error) {
 	cc := struct {
-		embed  `mapstructure:",squash"`
-		Region string
+		embed    `mapstructure:",squash"`
+		schedule `mapstructure:",squash"`
+		Region   string
 	}{
 		Region: "DE",
 	}
@@ -43,11 +45,17 @@ func NewAwattarFromConfig(other map[string]any) (api.Tariff, error) {
 		return nil, err
 	}
 
+	timer, err := cc.schedule.timer(time.Hour)
+	if err != nil {
+		return nil, err
+	}
+
 	t := &Awattar{
 		embed: &cc.embed,
 		log:   util.NewLogger("awattar"),
 		uri:   fmt.Sprintf(awattar.RegionURI, strings.ToLower(cc.Region)),
-		data:  util.NewMonitor[api.Rates](2 * time.Hour),
+		data:  util.NewMonitor[api.Rates](max(2*time.Hour, timer.window())),
+		timer: timer,
 	}
 
 	return runOrError(t)
@@ -58,7 +66,7 @@ func (t *Awattar) run(done chan error) {
 
 	client := request.NewHelper(t.log)
 
-	for tick := time.Tick(time.Hour); ; <-tick {
+	for tick := t.timer.C(); ; <-tick {
 		var res awattar.Prices
 
 		// Awattar publishes prices for next day around 13:00 CET/CEST, so up to 35h of price data are available

tariff/edf-tempo.go

@@ -27,6 +27,7 @@ type EdfTempo struct {
 	basic  string
 	data   *util.Monitor[api.Rates]
 	prices map[string]float64
+	timer  *refreshTimer
 }
 
 var _ api.Tariff = (*EdfTempo)(nil)
@@ -38,6 +39,7 @@ func init() {
 func NewEdfTempoFromConfig(other map[string]any) (api.Tariff, error) {
 	var cc struct {
 		embed        `mapstructure:",squash"`
+		schedule     `mapstructure:",squash"`
 		ClientID     string
 		ClientSecret string
 		Prices       struct {
@@ -57,6 +59,11 @@ func NewEdfTempoFromConfig(other map[string]any) (api.Tariff, error) {
 		return nil, err
 	}
 
+	timer, err := cc.schedule.timer(time.Hour)
+	if err != nil {
+		return nil, err
+	}
+
 	basic := transport.BasicAuthHeader(cc.ClientID, cc.ClientSecret)
 	log := util.NewLogger("edf-tempo").Redact(basic)
 
@@ -65,7 +72,8 @@ func NewEdfTempoFromConfig(other map[string]any) (api.Tariff, error) {
 		log:    log,
 		basic:  basic,
 		Helper: request.NewHelper(log),
-		data:   util.NewMonitor[api.Rates](2 * time.Hour),
+		data:   util.NewMonitor[api.Rates](max(2*time.Hour, timer.window())),
+		timer:  timer,
 	}
 
 	prices := structs.Map(cc.Prices)
@@ -103,7 +111,7 @@ func (t *EdfTempo) refreshToken() (*oauth2.Token, error) {
 func (t *EdfTempo) run(done chan error) {
 	var once sync.Once
 
-	for tick := time.Tick(time.Hour); ; <-tick {
+	for tick := t.timer.C(); ; <-tick {
 		var res struct {
 			Data struct {
 				Values []struct {