implemented adapter-specific cache key transform (#4764)

Co-authored-by: Ivaylo Novakov <inovakov@gmail.com>
Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>

Author: 3 people

packages/streams-adapter/helpers/aliases.go

@@ -268,10 +268,7 @@ func BuildCacheKeyParams(data map[string]interface{}) (types.RequestParams, erro
 		}
 	}
 
-	// Normalize all other parameters through the alias index if available.
-	// Also, filter to only those canonical parameters that are required for this endpoint
-	// when we have requirement metadata.
-	requiredForEndpoint, haveReq := activeAliasIndex.requiredParams[canonicalEndpoint]
+	overriddenKeys := make(map[string]bool)
 
 	for k, v := range data {
 		// Ignore the `endpoint` and `overrides` keys.
@@ -287,35 +284,30 @@ func BuildCacheKeyParams(data map[string]interface{}) (types.RequestParams, erro
 			continue
 		}
 
+		canonicalKey := keyLower
+		if pm, ok := activeAliasIndex.paramAlias[canonicalEndpoint]; ok {
+			if pIdx, ok := pm[keyLower]; ok {
+				canonicalKey = pIdx.CanonicalName
+			}
+		}
+
 		value := rawValue
 
 		// If there are per-adapter overrides, and the current value has an
 		// override defined for the active adapter, use the override instead.
 		if adapterOverrides != nil {
 			if ov, ok := adapterOverrides[strings.ToUpper(rawValue)]; ok && ov != "" {
 				value = ov
+				overriddenKeys[canonicalKey] = true
 			}
 		}
 
-		valueUpper := strings.ToUpper(value)
-
-		canonicalKey := keyLower
-		if pm, ok := activeAliasIndex.paramAlias[canonicalEndpoint]; ok {
-			if pIdx, ok := pm[keyLower]; ok {
-				canonicalKey = pIdx.CanonicalName
-			}
-		}
-
-		// If we don't have requirement metadata for this endpoint, keep all params.
-		if !haveReq {
-			out[canonicalKey] = valueUpper
-			continue
-		}
+		out[canonicalKey] = strings.ToUpper(value)
+	}
 
-		// Otherwise, only keep parameters that are marked as required.
-		if required, ok := requiredForEndpoint[canonicalKey]; ok && required {
-			out[canonicalKey] = valueUpper
-		}
+	// Apply adapter-specific cache key transform if registered.
+	if transform, ok := adapterTransforms[activeAdapter]; ok {
+		transform(out, overriddenKeys)
 	}
 
 	return out, nil

packages/streams-adapter/helpers/aliases_test.go

@@ -258,18 +258,12 @@ func TestBuildCacheKeyParams_BasicCanonical(t *testing.T) {
 		"endpoint": "price",
 		"base":     "eth",
 		"quote":    "usd",
-		"amount":   "100",
 	})
 	require.NoError(t, err)
 
 	assertParam(t, result, "endpoint", "price")
 	assertParam(t, result, "base", "ETH")
 	assertParam(t, result, "quote", "USD")
-
-	// "amount" is not required, should be absent even if passed.
-	if _, ok := result["amount"]; ok {
-		t.Error("non-required param 'amount' should not be in output")
-	}
 }
 
 func TestBuildCacheKeyParams_EndpointAlias(t *testing.T) {

packages/streams-adapter/helpers/helpers_test.go

@@ -70,17 +70,6 @@ func TestRequestParamsFromKey_ParamAliasesResolved(t *testing.T) {
 	assertParam(t, result, "quote", "USD")
 }
 
-func TestRequestParamsFromKey_NonRequiredParamsOmitted(t *testing.T) {
-	initTestAdapter(t)
-
-	result, err := RequestParamsFromKey(`adapter-price-{"endpoint":"price","base":"eth","quote":"usd","amount":"100"}`)
-	require.NoError(t, err)
-
-	if _, ok := result["amount"]; ok {
-		t.Error("non-required param 'amount' should be filtered out")
-	}
-}
-
 func TestRequestParamsFromKey_AliasIndexNotInitialized(t *testing.T) {
 	resetGlobals()
 

packages/streams-adapter/helpers/transforms.go

@@ -0,0 +1,41 @@
+package helpers
+
+import (
+	types "streams-adapter/common"
+)
+
+// CacheKeyTransformFunc transforms canonical request params for cache keying.
+// It receives the already-canonicalized params (with overrides applied) and a set
+// of canonical param names whose values were changed by adapter overrides.
+type CacheKeyTransformFunc func(params types.RequestParams, overriddenKeys map[string]bool)
+
+// adapterTransforms maps adapter name to its cache key transform function.
+// To add support for a new adapter, define a transform function and register it here.
+var adapterTransforms = map[string]CacheKeyTransformFunc{
+	"cfbenchmarks": cfbenchmarksTransform,
+}
+
+// cfbenchmarksTransform computes a CFBenchmarks index from base/quote and removes
+// the individual base/quote params so the cache key uses only the index.
+// Applies to the "crypto" and "crypto-lwba" endpoints.
+func cfbenchmarksTransform(params types.RequestParams, overriddenKeys map[string]bool) {
+	endpoint := params["endpoint"]
+	if endpoint != "crypto" && endpoint != "crypto-lwba" {
+		return
+	}
+
+	base, hasBase := params["base"]
+	if !hasBase {
+		return
+	}
+
+	if overriddenKeys["base"] {
+		params["index"] = base
+	} else if _, hasIndex := params["index"]; !hasIndex {
+		quote := params["quote"]
+		params["index"] = "U_" + base + quote + "_RTI"
+	}
+	params["adapterNameOverride"] = "cfbenchmarks2"
+	delete(params, "base")
+	delete(params, "quote")
+}