pkg/settings/limits: fix MultiResourcePoolLimiter; normalize contexts.CRE.Owner

Author: jmank88

pkg/contexts/contexts.go

@@ -2,6 +2,7 @@ package contexts
 
 import (
 	"context"
+	"strings"
 )
 
 // Value gets a value from the context and casts it to T.
@@ -15,17 +16,15 @@ func Value[T any](ctx context.Context, key any) T {
 }
 
 // WithCRE returns a derived context with a cre key/val.
+// The values will be normalized via CRE.Normalized.
 func WithCRE(ctx context.Context, cre CRE) context.Context {
-	return context.WithValue(ctx, creCtxKey, &cre)
+	return context.WithValue(ctx, creCtxKey, cre.Normalized())
 }
 
 // CREValue returns the [CRE] key/val, which may be empty.
+// If it is not empty, the values will be normalized.
 func CREValue(ctx context.Context) CRE {
-	v := Value[*CRE](ctx, creCtxKey)
-	if v == nil {
-		return CRE{}
-	}
-	return *v // copy
+	return Value[CRE](ctx, creCtxKey)
 }
 
 // CRE holds contextual Chainlink Runtime Environment metadata.
@@ -37,6 +36,13 @@ type CRE struct {
 	Owner, Workflow string
 }
 
+// Normalized returns a possibly modified CRE with normalized values.
+func (c CRE) Normalized() CRE {
+	c.Owner = strings.TrimPrefix(c.Owner, "0x")
+	c.Owner = strings.ToLower(c.Owner)
+	return c
+}
+
 func (c CRE) LoggerKVs() []any {
 	return []any{
 		"org", c.Org,

pkg/settings/json_test.go

@@ -38,7 +38,7 @@ func Test_jsonSettings_GetScoped(t *testing.T) {
 
 	ctx := contexts.WithCRE(t.Context(), contexts.CRE{
 		Org:      "123",
-		Owner:    "0x8bd112d3f8f92e41c861939545ad387307af9703",
+		Owner:    "8bd112d3f8f92e41c861939545ad387307af9703",
 		Workflow: "15c631d295ef5e32deb99a10ee6804bc4af1385568f9b3363f6552ac6dbb2cef",
 	})
 	gotValue, err := r.GetScoped(ctx, ScopeGlobal, `Foo`)

pkg/settings/keys_test.go

@@ -11,7 +11,7 @@ import (
 func TestTenant_rawKeys(t *testing.T) {
 	const (
 		org      = "AcmeCorporation"
-		owner    = "0x1234abcd"
+		owner    = "1234abcd"
 		workflow = "ABCDEFGH"
 		key      = "foo"
 	)

pkg/settings/limits/resource.go

@@ -296,9 +296,20 @@ func (u *unscopedResourcePoolLimiter[N]) Free(_ context.Context, amount N) error
 	return nil
 }
 
+var _ ResourcePoolLimiter[int] = MultiResourcePoolLimiter[int]{}
+
 // MultiResourcePoolLimiter is a ResourcePoolLimiter backed by other limiters, which are each called in order.
 type MultiResourcePoolLimiter[N Number] []ResourcePoolLimiter[N]
 
+func (m MultiResourcePoolLimiter[N]) Close() (errs error) {
+	for _, l := range m {
+		if err := l.Close(); err != nil {
+			errs = errors.Join(errs, err)
+		}
+	}
+	return
+}
+
 func (m MultiResourcePoolLimiter[N]) Wait(ctx context.Context, amount N) (func(), error) {
 	var frees freeFns
 	for _, l := range m {
@@ -312,17 +323,26 @@ func (m MultiResourcePoolLimiter[N]) Wait(ctx context.Context, amount N) (func()
 	return frees.freeAll, nil
 }
 
-func (m MultiResourcePoolLimiter[N]) Use(ctx context.Context, amount N) (func(), error) {
+func (m MultiResourcePoolLimiter[N]) Use(ctx context.Context, amount N) error {
 	var frees freeFns
 	for _, l := range m {
 		err := l.Use(ctx, amount)
 		if err != nil {
 			frees.freeAll()
-			return nil, err
+			return err
 		}
 		frees = append(frees, func() { l.Free(ctx, amount) })
 	}
-	return frees.freeAll, nil
+	return nil
+}
+
+func (m MultiResourcePoolLimiter[N]) Free(ctx context.Context, amount N) (errs error) {
+	for _, l := range m {
+		if err := l.Free(ctx, amount); err != nil {
+			errs = errors.Join(errs, err)
+		}
+	}
+	return
 }
 
 type freeFns []func()

pkg/settings/limits/resource_test.go

@@ -70,7 +70,9 @@ func ExampleResourceLimiter_Use() {
 }
 
 func ExampleMultiResourcePoolLimiter() {
-	ctx := contexts.WithCRE(context.Background(), contexts.CRE{Org: "orgID", Owner: "ownerID", Workflow: "workflowID"})
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
+	defer cancel()
+	ctx = contexts.WithCRE(ctx, contexts.CRE{Org: "orgID", Owner: "owner-id", Workflow: "workflowID"})
 	global := GlobalResourcePoolLimiter[int](100)
 	freeGlobal, err := global.Wait(ctx, 95)
 	if err != nil {
@@ -93,12 +95,11 @@ func ExampleMultiResourcePoolLimiter() {
 	}
 	multi := MultiResourcePoolLimiter[int]{global, org, user, workflow}
 	tryWork := func() error {
-		free, err := multi.Use(ctx, 10)
+		err := multi.Use(ctx, 10)
 		if err != nil {
 			return err
 		}
-		defer free()
-		return nil
+		return multi.Free(ctx, 10)
 	}
 
 	fmt.Println(tryWork())
@@ -110,15 +111,15 @@ func ExampleMultiResourcePoolLimiter() {
 	fmt.Println(tryWork())
 	freeWorkflow()
 	fmt.Println(tryWork())
-	done, err := multi.Wait(ctx, 10)
+	free, err := multi.Wait(ctx, 10)
 	if err != nil {
 		log.Fatal(err)
 	}
-	done()
+	free()
 	// Output:
 	// resource limited: cannot use 10, already using 95/100
 	// resource limited for org[orgID]: cannot use 10, already using 45/50
-	// resource limited for owner[ownerID]: cannot use 10, already using 15/20
+	// resource limited for owner[owner-id]: cannot use 10, already using 15/20
 	// resource limited for workflow[workflowID]: cannot use 10, already using 5/10
 	// <nil>
 }

pkg/settings/testdata/config.json

@@ -20,13 +20,13 @@
     }
   },
   "owner": {
-    "0x00026b4aa7e57ca7b68ae1bf45653f56b656fd3a": {
+    "00026b4aa7e57ca7b68ae1bf45653f56b656fd3a": {
       "Bar": {
         "Baz": "200"
       },
       "Foo": "75"
     },
-    "0x8bd112d3f8f92e41c861939545ad387307af9703": {
+    "8bd112d3f8f92e41c861939545ad387307af9703": {
       "Bar": {
         "Baz": "43"
       },

pkg/settings/testdata/config.toml

@@ -21,16 +21,16 @@ Baz = "500"
 
 [owner]
 
-[owner.0x00026b4aa7e57ca7b68ae1bf45653f56b656fd3a]
+[owner.00026b4aa7e57ca7b68ae1bf45653f56b656fd3a]
 Foo = "75"
 
-[owner.0x00026b4aa7e57ca7b68ae1bf45653f56b656fd3a.Bar]
+[owner.00026b4aa7e57ca7b68ae1bf45653f56b656fd3a.Bar]
 Baz = "200"
 
-[owner.0x8bd112d3f8f92e41c861939545ad387307af9703]
+[owner.8bd112d3f8f92e41c861939545ad387307af9703]
 Foo = "13"
 
-[owner.0x8bd112d3f8f92e41c861939545ad387307af9703.Bar]
+[owner.8bd112d3f8f92e41c861939545ad387307af9703.Bar]
 Baz = "43"
 
 [workflow]