feat: support local config file watcher of client and server #1

ozline · 2023-10-02T06:58:34Z

What type of PR is this?

feat

Check the PR title.

This PR title match the format: <type>(optional scope): <description>
The description of this PR title is user-oriented and clear enough for others to understand.
Attach the PR updating the user documentation if the current PR requires user awareness at the usage level. User docs repo

(Optional) Translate the PR title into Chinese.

支持将本地文件作为配置并持续监听文件变更以更新配置

(Optional) Which issue(s) this PR fixes:

Fixes cloudwego/kitex#1081

CLAassistant · 2023-10-02T06:58:39Z

All committers have signed the CLA.

README.md

README_CN.md

client/retry.go

client/watch.go

client/suite.go

utils/utils.go

go.mod

server/watch.go

example/go.mod

server/suite.go

server/limit.go

utils/filewatcher.go

parser/client.go

monitor/monitor.go

monitor/test.json

parser/parser.go

…ch other

li-jin-gou

CI 没过，可以修一下

ozline · 2023-12-09T18:49:57Z

CI 没过，可以修一下

刚刚检查了一下，CI 未通过是因为使用到了atomic.Int64来对 callback 做 unique id。这个类型在 1.19 版本引入，先前的sync/atomic中没有这个类型。

查看了一下其他的 config 仓库，我目前移除了 1.17 和 1.18 版本的测试

XZ0730

感觉日志可以加一些，好像很多地方没打日志
文档中的支持解析的文件类型可以说明一下

README_CN.md

ozline · 2023-12-15T18:04:58Z

感觉日志可以加一些，好像很多地方没打日志

文档中的支持解析的文件类型可以说明一下

文档已经修正&补充，日志这边我在RegisterCallback添加了额外的 Debug 日志

这边同时修复了一个潜在的导致 panic 的情况：获取配置时 Interface 断言类型错误。尽管在正常操作时不会发生，保险起见还是加上了。

bytedance-oss-robot · 2023-12-16T15:54:55Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: li-jin-gou, ozline

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* feat: support local file config of client and server * del: .DS_Store * add: license header * fix: staticcheck error report * fix: use NewRetryContainerWithPercentageLimit to create retry container * docs: correct sentence placement * fix: use individual module in example folder * feat: merge ClientWatcher and ServerWatcher into ConfigWatcher * fix: update error judgment of utils.PathExists() * docs: update README.md * chore: move example folder to kitex-contrib/example * fix: set alias for client/server to avoid same package name * fix: delete useless log * fix: add recover for new goroutines to avoid crashing * add: comments for exported symbols * del: monitor/key.go * feat: separating filewatch and configmonitor * docs: update README.md * fix: README.md usage import package error * add: monitor test cases * test: add entire progress test * fix: add mutex for start/stop file watching * fix: staticcheck error report * fix: multiple clients can listen to the same key without affecting each other * delete: remove the gomock module and use self-made simple mock instead * feat: upgrade required module version * fix: remove redundant golang versions in workflow tests * add: use example of this lib * fix: README_CN.md spell error * chore: README add supported file types * fix: panic when type assertion fails at runtime * chore: add log while callback is nil * fix: README.md lib name error * chore: add licenses --------- Co-authored-by: kinggo <lilong.21@bytedance.com>

…ontrib#1) (kitex-contrib#2) * feat: support local file config of client and server * del: .DS_Store * add: license header * fix: staticcheck error report * fix: use NewRetryContainerWithPercentageLimit to create retry container * docs: correct sentence placement * fix: use individual module in example folder * feat: merge ClientWatcher and ServerWatcher into ConfigWatcher * fix: update error judgment of utils.PathExists() * docs: update README.md * chore: move example folder to kitex-contrib/example * fix: set alias for client/server to avoid same package name * fix: delete useless log * fix: add recover for new goroutines to avoid crashing * add: comments for exported symbols * del: monitor/key.go * feat: separating filewatch and configmonitor * docs: update README.md * fix: README.md usage import package error * add: monitor test cases * test: add entire progress test * fix: add mutex for start/stop file watching * fix: staticcheck error report * fix: multiple clients can listen to the same key without affecting each other * delete: remove the gomock module and use self-made simple mock instead * feat: upgrade required module version * fix: remove redundant golang versions in workflow tests * add: use example of this lib * fix: README_CN.md spell error * chore: README add supported file types * fix: panic when type assertion fails at runtime * chore: add log while callback is nil * fix: README.md lib name error * chore: add licenses --------- Co-authored-by: kinggo <lilong.21@bytedance.com>

ozline added 2 commits October 2, 2023 14:50

feat: support local file config of client and server

3b34e7c

del: .DS_Store

c47a4f1

ozline changed the base branch from main to dev October 2, 2023 07:00

add: license header

9e01f04