utils.IterateOrderedMap: Use as intended, via for:=range

Require Go 1.23

Imported from Icinga/icinga-notifications@ac235b7

Author: Al2Klimov

utils/utils.go

@@ -9,6 +9,7 @@ import (
 	"github.com/lib/pq"
 	"github.com/pkg/errors"
 	"golang.org/x/exp/utf8string"
+	"iter"
 	"net"
 	"os"
 	"path/filepath"
@@ -170,11 +171,7 @@ func PrintErrorThenExit(err error, exitCode int) {
 //
 // This function returns a func yielding key-value-pairs from a given map in the order of their keys, if their type
 // is cmp.Ordered.
-//
-// Please note that currently - being at Go 1.22 - rangefuncs are still an experimental feature and cannot be directly
-// used unless compiled with `GOEXPERIMENT=rangefunc`. However, they can still be invoked normally.
-// https://go.dev/wiki/RangefuncExperiment
-func IterateOrderedMap[K cmp.Ordered, V any](m map[K]V) func(func(K, V) bool) {
+func IterateOrderedMap[K cmp.Ordered, V any](m map[K]V) iter.Seq2[K, V] {
 	keys := make([]K, 0, len(m))
 	for key := range m {
 		keys = append(keys, key)

utils/utils_test.go

@@ -85,18 +85,10 @@ func TestIterateOrderedMap(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			var outKeys []int
-
-			// Either run with GOEXPERIMENT=rangefunc or wait for rangefuncs to land in the next Go release.
-			// for k, _ := range IterateOrderedMap(tt.in) {
-			// 	outKeys = append(outKeys, k)
-			// }
-
-			// In the meantime, it can be invoked as follows.
-			IterateOrderedMap(tt.in)(func(k int, v string) bool {
+			for k, v := range IterateOrderedMap(tt.in) {
 				assert.Equal(t, tt.in[k], v)
 				outKeys = append(outKeys, k)
-				return true
-			})
+			}
 
 			assert.Equal(t, tt.outKeys, outKeys)
 		})