feat: add response-cache plugin #2025

mirror58229 · 2025-04-08T03:11:31Z

Ⅰ. Describe what this PR did

Enable caching responses for Higress. This feature supports extracting keys from request headers or request bodies, and caching values extracted from response bodies. If the response is in JSON format, it supports GJSON PATH.

This function is similar to ai-cache, but it focuses more on common scenarios, such as caching HTTP responses or other static results.

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

codecov-commenter · 2025-04-08T03:14:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.72%. Comparing base (ef31e09) to head (1861889).
Report is 424 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2025      +/-   ##
==========================================
+ Coverage   35.91%   43.72%   +7.81%     
==========================================
  Files          69       79      +10     
  Lines       11576    12728    +1152     
==========================================
+ Hits         4157     5565    +1408     
+ Misses       7104     6816     -288     
- Partials      315      347      +32

see 75 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

CH3CHO

先看了一下文档，逻辑还没看。

CH3CHO · 2025-04-11T05:26:07Z

plugins/wasm-go/extensions/response-cache/README.md

+**Note**
+
+> 需要数据面的proxy wasm版本大于等于0.2.100
+> 编译时，需要带上版本的tag，例如：`tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags="custommalloc nottinygc_finalizer proxy_wasm_version_0_2_100" ./`


需要加这个tag的话，请参考ai-proxy等插件添加.buildrc文件。

如果不需要再 onRequestBody 阶段修改 header，可以不需要加这个 tag。

CH3CHO · 2025-04-11T05:27:18Z

plugins/wasm-go/extensions/response-cache/README.md

+| --- | --- | --- | --- | --- |
+| cacheResponseCode | array of number | optional | 200 | 表示支持缓存的响应状态码列表；默认为200|
+| cacheKeyFromHeader | string | required | "" | 表示提取header中的固定字段的值作为缓存key；cacheKeyFromHeader和cacheKeyFromBody**非空情况下只支持配置一项**|
+| cacheKeyFromBody | string | required | "" | 配置为空时，表示提取所有body作为缓存key；否则按json响应格式，从请求 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |


那如果cacheKey完全不看body要怎么配呢？

CH3CHO · 2025-04-11T05:28:01Z

plugins/wasm-go/extensions/response-cache/README.md

+| cacheResponseCode | array of number | optional | 200 | 表示支持缓存的响应状态码列表；默认为200|
+| cacheKeyFromHeader | string | required | "" | 表示提取header中的固定字段的值作为缓存key；cacheKeyFromHeader和cacheKeyFromBody**非空情况下只支持配置一项**|
+| cacheKeyFromBody | string | required | "" | 配置为空时，表示提取所有body作为缓存key；否则按json响应格式，从请求 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |
+| cacheValueFromBodyType | string | optional | "application/json" | 表示缓存body的类型，命中cache时content-type会返回该值；默认为json |


这个感觉有点奇怪，为什么不是返回缓存数据的content type呢？

默认为json

这里要写也得写完整的。

CH3CHO · 2025-04-11T05:28:19Z

plugins/wasm-go/extensions/response-cache/README.md

+
+其中，缓存key的拼接逻辑为以下中一个： 
+1. `cacheKeyPrefix` + 从请求头中`cacheKeyFromHeader`对应字段提取的内容
+2. `cacheKeyPrefix` + 从请求体中`cacheKeyFromBody`对应字段提取的内容


两个都不为空呢？

CH3CHO · 2025-04-11T05:29:03Z

plugins/wasm-go/extensions/response-cache/README.md

+
+## 常见问题
+
+1. 如果返回的错误为 `error status returned by host: bad argument`，请检查`serviceName`是否正确包含了服务的类型后缀(.dns等)。


端口也要注意的，尤其是 static 类型的服务端口现在固定为 80。

CH3CHO · 2025-04-11T05:29:17Z

plugins/wasm-go/extensions/response-cache/README.md

+| cacheKeyFromHeader | string | required | "" | 表示提取header中的固定字段的值作为缓存key；cacheKeyFromHeader和cacheKeyFromBody**非空情况下只支持配置一项**|
+| cacheKeyFromBody | string | required | "" | 配置为空时，表示提取所有body作为缓存key；否则按json响应格式，从请求 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |
+| cacheValueFromBodyType | string | optional | "application/json" | 表示缓存body的类型，命中cache时content-type会返回该值；默认为json |
+| cacheValueFromBody | string | optional | "" | 配置为空时，表示缓存所有body；当cacheValueFromBodyType为json时，支持从响应 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |


不太能理解什么场景下需要这个功能。

当cacheValueFromBodyType为json时

这里要写完整的 application/json

CH3CHO · 2025-04-14T01:56:24Z

plugins/wasm-go/extensions/response-cache/config/config.go

+	}
+
+	if len(c.CacheResponseCode) == 0 { 
+		c.CacheResponseCode = []int32{200}	


行尾空格请删除

CH3CHO · 2025-04-14T02:07:08Z

plugins/wasm-go/extensions/response-cache/main.go

+		wrapper.ParseConfigBy(parseConfig),
+		wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
+		wrapper.ProcessRequestBodyBy(onHttpRequestBody),
+		wrapper.ProcessResponseHeadersBy(onHttpResponseHeaders),
+		wrapper.ProcessResponseBodyBy(onHttpResponseBody),


作为新插件，这些 deprecated 的写法可以更新了。具体可以参考 ai-proxy 插件的代码。

CH3CHO · 2025-04-14T02:18:06Z

plugins/wasm-go/extensions/response-cache/main.go

+
+	// cache from request header
+	if c.CacheKeyFromHeader != "" {
+		key, _ := proxywasm.GetHttpRequestHeader((c.CacheKeyFromHeader))


多了一层括号

CH3CHO · 2025-04-14T02:18:41Z

plugins/wasm-go/extensions/response-cache/main.go

+		if key == "" {
+			log.Warnf("[onHttpRequestHeaders] cache key from header: %s is empty, skip cache", c.CacheKeyFromHeader)
+			ctx.DontReadRequestBody()
+			return types.ActionContinue


这里是不是也需要跳过 response 的处理流程？感觉现在的处理有点问题。

CH3CHO · 2025-04-14T02:20:16Z

plugins/wasm-go/extensions/response-cache/core.go

+}
+
+// handleInternalError logs an error and resumes the HTTP request.
+func handleInternalError(err error, message string, log wrapper.Log) {


这个函数好像没用到？

CH3CHO · 2025-04-14T02:20:35Z

plugins/wasm-go/extensions/response-cache/main.go

+}
+
+func onHttpResponseBody(ctx wrapper.HttpContext, c config.PluginConfig, body []byte, log wrapper.Log) types.Action {
+


多余空行

CH3CHO · 2025-04-14T02:45:43Z

plugins/wasm-go/extensions/response-cache/README.md

+| cacheResponseCode | array of number | optional | 200 | 表示支持缓存的响应状态码列表；默认为200|
+| cacheKeyFromHeader | string | required | "" | 表示提取header中的固定字段的值作为缓存key；cacheKeyFromHeader和cacheKeyFromBody**非空情况下只支持配置一项**|
+| cacheKeyFromBody | string | required | "" | 配置为空时，表示提取所有body作为缓存key；否则按json响应格式，从请求 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |
+| cacheValueFromBodyType | string | optional | "application/json" | 表示缓存body的类型，命中cache时content-type会返回该值；默认为json |


默认为json

这里要写也得写完整的。

CH3CHO · 2025-04-14T02:46:03Z

plugins/wasm-go/extensions/response-cache/README.md

+| cacheKeyFromHeader | string | required | "" | 表示提取header中的固定字段的值作为缓存key；cacheKeyFromHeader和cacheKeyFromBody**非空情况下只支持配置一项**|
+| cacheKeyFromBody | string | required | "" | 配置为空时，表示提取所有body作为缓存key；否则按json响应格式，从请求 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |
+| cacheValueFromBodyType | string | optional | "application/json" | 表示缓存body的类型，命中cache时content-type会返回该值；默认为json |
+| cacheValueFromBody | string | optional | "" | 配置为空时，表示缓存所有body；当cacheValueFromBodyType为json时，支持从响应 Body 中基于 [GJSON PATH](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) 语法提取字符串 |


当cacheValueFromBodyType为json时

这里要写完整的 application/json

mirror58229 added 2 commits April 8, 2025 11:05

add response-cache

c110fe5

add disable reroute for response-cache

1861889

mirror58229 requested review from johnlanni, CH3CHO and rinfx as code owners April 8, 2025 03:11

CH3CHO requested changes Apr 11, 2025

View reviewed changes

CH3CHO requested changes Apr 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add response-cache plugin #2025

feat: add response-cache plugin #2025

mirror58229 commented Apr 8, 2025

codecov-commenter commented Apr 8, 2025

CH3CHO left a comment

CH3CHO Apr 11, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 11, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025

CH3CHO Apr 14, 2025


		## 常见问题

		1. 如果返回的错误为 `error status returned by host: bad argument`，请检查`serviceName`是否正确包含了服务的类型后缀(.dns等)。

		}

		func onHttpResponseBody(ctx wrapper.HttpContext, c config.PluginConfig, body []byte, log wrapper.Log) types.Action {

feat: add response-cache plugin #2025

Are you sure you want to change the base?

feat: add response-cache plugin #2025

Conversation

mirror58229 commented Apr 8, 2025

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

codecov-commenter commented Apr 8, 2025

Codecov Report

CH3CHO left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment