[frontend-gray] Increase gray types according to the ratio-weight gray #1291

heimanba · 2024-09-09T16:34:50Z

Ⅰ. Describe what this PR did

增加按照比例灰度的能力,YAML配置如下：
灰度规则 beta-user的灰度范围为 50%

baseDeployment: 
  version: "dev"
grayDeployments: 
- name: "beta-user"
  version: "0.0.1"
  enabled: "true"
  weight: "50"

添加往首页注入脚本的能力
可以分别在 header，body的首部first和尾部last注入相关代码。

---
injection: 
  header: 
  - "<script>console.log('Header')</script>"
  body: 
    first: 
    - "<script>console.log('hello world before')</script>"
    - "<script>console.log('hello world before1')</script>"
    last: 
    - "<script>console.log('hello world after')</script>"
    - "<script>console.log('hello world after2')</script>"

Ⅱ. 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

feat: 🎸 frontend-gray plugin support cdn type deploy

codecov-commenter · 2024-09-10T03:04:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.31%. Comparing base (ef31e09) to head (2728da4).
Report is 105 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1291      +/-   ##
==========================================
+ Coverage   35.91%   44.31%   +8.40%     
==========================================
  Files          69       75       +6     
  Lines       11576     9823    -1753     
==========================================
+ Hits         4157     4353     +196     
+ Misses       7104     5142    -1962     
- Partials      315      328      +13

see 90 files with indirect coverage changes

plugins/wasm-go/extensions/frontend-gray/README.md

plugins/wasm-go/extensions/frontend-gray/main.go

CH3CHO · 2024-09-10T12:17:05Z

plugins/wasm-go/extensions/frontend-gray/util/utils.go

+			return grayConfig.BaseDeployment
+		}
+
+		// 确保每个用户每次访问的都是走同一版本


debug情况就不做用户粘滞咯？

debug情况就不做用户粘滞咯？

是的是的，所以这个debug，命名为 debugGrayWeight了

不是太理解什么时候应该用这个功能。。。

不是太理解什么时候应该用这个功能。。。

这个不算是功能，只是让用户进行观测效果。否则看不出按比率灰度的效果。但是这个透出确实有点奇怪。没有想到好的方式，有什么推荐的建议吗

要不你加一下我钉钉 CH3CHO，我们单独沟通一下。

让用户进行观测效果：观测什么的效果呢？

如果是灰度真实用户，不做粘滞可能会导致用户体验不一致。

如果是开发人员去验证灰度版本，那他自己种一个灰度Cookie就可以了吧？

CH3CHO
好的好，这个debug模式确实可以删除的，已经删除哈

CH3CHO · 2024-09-12T01:53:03Z

plugins/wasm-go/extensions/frontend-gray/config/config.go

-	NotFound       = "not-found"
+	IsNotFound     = "is-not-found"
+	// 2 days
+	MaxAgeCookie = "172800"


这个就是让灰度的粘滞保持多长时间吧？是不是最好支持用户配置？

这个就是让灰度的粘滞保持多长时间吧？是不是最好支持用户配置？

通过配置 userStickyMaxAge 字段支持，默认为172800，2天

CH3CHO · 2024-09-12T01:54:33Z

plugins/wasm-go/extensions/frontend-gray/util/utils.go

@@ -19,7 +20,9 @@ import (

 func LogInfof(format string, args ...interface{}) {
 	format = fmt.Sprintf("[%s] %s", "frontend-gray", format)
-	proxywasm.LogInfof(format, args...)
+	if os.Getenv("TEST_MODE") != "" {


是不是可以在外面把 env get 好并做好判定设置为 bool，这样就不需要每次单独读取和判定了？

如果不是 TEST_MODE，上面的 Sprintf 是不是也没必要调用了？

是不是可以在外面把 env get 好并做好判定设置为 bool，这样就不需要每次单独读取和判定了？

如果不是 TEST_MODE，上面的 Sprintf 是不是也没必要调用了？

是的，这个 debug模式也删除了哈

CH3CHO · 2024-09-12T01:54:46Z

plugins/wasm-go/extensions/frontend-gray/util/utils_test.go

 			config.JsonToGrayConfig(gjson.Parse(test.input), grayConfig)
-			reslut := FilterGrayWeight(grayConfig)
+			reslut := FilterGrayWeight(grayConfig, []string{"base", "1.0.1"}, "192.168.1.1")


result 拼写错误

result 拼写错误

fixed

CH3CHO · 2024-09-12T01:54:54Z

plugins/wasm-go/extensions/frontend-gray/util/utils_test.go

 			config.JsonToGrayConfig(gjson.Parse(test.input), grayConfig)
-			reslut := FilterGrayWeight(grayConfig)
+			reslut := FilterGrayWeight(grayConfig, []string{"base", "1.0.1"}, "192.168.1.1")
 			t.Logf("reslut-----: %v", reslut)


同上，拼写错误

同上，拼写错误

fixed

CH3CHO · 2024-09-12T03:36:00Z

plugins/wasm-go/extensions/frontend-gray/config/config.go

@@ -11,7 +11,9 @@ const (
 	XForwardedFor  = "x-forwarded-for"
 	XPreHigressTag = "x-pre-higress-tag"
 	IsIndex        = "is-index"


isIndex这个名字是不是换一下，改成isPageRequest之类的？

isIndex这个名字是不是换一下，改成isPageRequest之类的？

fixed

CH3CHO · 2024-09-20T11:05:37Z

plugins/wasm-go/extensions/frontend-gray/util/utils.go

@@ -119,8 +119,7 @@ var indexSuffixes = []string{
 	".html", ".htm", ".jsp", ".php", ".asp", ".aspx", ".erb", ".ejs", ".twig",
 }

-// IsIndexRequest determines if the request is an index request
-func IsIndexRequest(fetchMode string, p string) bool {
+func GetIsPageRequest(fetchMode string, p string) bool {


建议是把 Get 去掉，直接就叫 IsPageRequest。另外这个 p 的参数名不太好理解。如果是怕和包名冲突的话，可以考虑把 import 那个 path 起个别名叫 gopath。这个变量还是叫 path。

CH3CHO · 2024-09-20T11:13:41Z

plugins/wasm-go/extensions/frontend-gray/util/utils.go

+	// 用户粘滞，确保每个用户每次访问的都是走同一版本
+	if len(preVersions) > 1 && preVersions[1] != "" && uniqueClientId == preVersions[1] {
+		for _, deployment := range deployments {
+			if deployment.Version == strings.Trim(preVersions[0], " ") {


Trim操作做一次是不是就行了？

CH3CHO · 2024-09-20T11:15:11Z

plugins/wasm-go/extensions/frontend-gray/util/utils.go

+	deployments := append(grayConfig.GrayDeployments, grayConfig.BaseDeployment)
+	LogInfof("uniqueClientId: %s, preVersions: %v", uniqueClientId, preVersions)
+	// 用户粘滞，确保每个用户每次访问的都是走同一版本
+	if len(preVersions) > 1 && preVersions[1] != "" && uniqueClientId == preVersions[1] {


preversion的生成和解析建议抽一个方法并返回一个有语义的结构，现在写Cookie、读Cookie和用这个值分散在不同的地方，不便于理解和管理。

CH3CHO · 2024-09-20T11:17:49Z

plugins/wasm-go/extensions/frontend-gray/README.md

@@ -18,12 +18,12 @@ description: 前端灰度插件配置参考
 |----------------|--------------|----|-----|----------------------------------------------------------------------------------------------------|
 | `grayKey`         | string       | 非必填 | -   | 用户ID的唯一标识，可以来自Cookie或者Header中，比如 userid，如果没有填写则使用`rules[].grayTagKey`和`rules[].grayTagValue`过滤灰度规则 |
 | `graySubKey`    | string       | 非必填 | -   | 用户身份信息可能以JSON形式透出，比如：`userInfo:{ userCode:"001" }`,当前例子`graySubKey`取值为`userCode` |
+| `userStickyMaxAge`         | string       | 非必填 | 172800   | 用户粘滞的时长：单位为秒，默认为`172800`，2天时间 |


这个字段是不是用 int 类型更好一点？

CH3CHO · 2024-09-20T11:18:35Z

plugins/wasm-go/extensions/frontend-gray/main.go

-	ctx.SetContext(config.IsIndex, isIndex)
-	ctx.SetContext(config.XForwardedFor, xForwardedFor)
+	ctx.SetContext(config.IsPageRequest, isPageRequest)
+	ctx.SetContext(config.XUniqueClient, uniqueClientId)


存的是ID，这个常量是不是也叫XUniqueClientId好一点？

CH3CHO · 2024-09-20T11:19:05Z

plugins/wasm-go/extensions/frontend-gray/main.go

 	if grayConfig.Rewrite != nil && grayConfig.Rewrite.Host != "" {
 		// 删除Content-Disposition，避免自动下载文件
 		proxywasm.RemoveHttpResponseHeader("Content-Disposition")
 	}

-	isIndex := ctx.GetContext(config.IsIndex).(bool)
+	isPageRequest := ctx.GetContext(config.IsPageRequest).(bool)


这些地方建议都用两个返回值的 cast 方式，避免 panic。

heimanba and others added 11 commits August 6, 2024 11:54

feat: 🎸 frontend-gray plugin support cdn type deploy

0f298d0

feat: 🎸 frontend-gray plugin support cdn type deploy

fix: 🐛 frontend-gray add ProcessStreamingResponseBody

67a09e8

Merge branch 'main' into main

0d9a738

Merge branch 'main' into main

8a872b9

Merge branch 'alibaba:main' into main

4e5a471

refactor: 💡 优化代码编写以及命名问题

cea1812

docs: ✏️ update frontend gray plugin docs

5513f95

refactor: 💡 优化 IndexRequest 逻辑，以及加上test case

3f8ef30

Merge branch 'main' into main

97260ee

Merge branch 'alibaba:main' into main

b0dc0d0

feat: 🎸 1. 添加按照比率 weight灰度能力，2. 提供注入inject 脚本到首页HTML的能力

1de4f87

heimanba requested review from johnlanni, WeixinX and CH3CHO as code owners September 9, 2024 16:34

Merge branch 'main' into main

e97c616

heimanba added 2 commits September 10, 2024 15:23

feat: 🎸 [frontend-gray]grayKey 可以从cookie或者header中获取

4453f97

Merge branch 'main' of github.com:heimanba/higress

122834e

CH3CHO requested changes Sep 10, 2024

View reviewed changes

heimanba added 2 commits September 10, 2024 21:32

fix: 🐛 [frontend-gray] 修改header -> head， cookie设置默认时间为2天

2d0ddab

Merge branch 'main' into main

230710a

CH3CHO requested changes Sep 12, 2024

View reviewed changes

heimanba added 4 commits September 12, 2024 14:07

chore: 🤖 删除 debugGrayWeight字段，同时按照比例灰度优先支持 grayKey 的用户粘滞

102f5f6

chore: 🤖 优化CR中提出的问题

7a2926e

Merge branch 'main' into main

995dbff

Merge branch 'main' into main

2728da4

CH3CHO requested changes Sep 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[frontend-gray] Increase gray types according to the ratio-weight gray #1291

[frontend-gray] Increase gray types according to the ratio-weight gray #1291

heimanba commented Sep 9, 2024

codecov-commenter commented Sep 10, 2024 •

edited

Loading

CH3CHO Sep 10, 2024

heimanba Sep 10, 2024

CH3CHO Sep 10, 2024

heimanba Sep 11, 2024 •

edited

Loading

CH3CHO Sep 12, 2024

CH3CHO Sep 12, 2024

heimanba Sep 12, 2024

CH3CHO Sep 12, 2024

heimanba Sep 18, 2024

CH3CHO Sep 12, 2024

heimanba Sep 18, 2024

CH3CHO Sep 12, 2024

heimanba Sep 18, 2024

CH3CHO Sep 12, 2024

heimanba Sep 18, 2024

CH3CHO Sep 12, 2024

heimanba Sep 18, 2024

CH3CHO Sep 20, 2024

CH3CHO Sep 20, 2024

CH3CHO Sep 20, 2024

CH3CHO Sep 20, 2024

CH3CHO Sep 20, 2024

CH3CHO Sep 20, 2024

[frontend-gray] Increase gray types according to the ratio-weight gray #1291

Are you sure you want to change the base?

[frontend-gray] Increase gray types according to the ratio-weight gray #1291

Conversation

heimanba commented Sep 9, 2024

Ⅰ. 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 Sep 10, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heimanba Sep 11, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Sep 10, 2024 •

edited

Loading

heimanba Sep 11, 2024 •

edited

Loading