Compare commits
79 Commits
Author | SHA1 | Date | |
---|---|---|---|
d52e22c187 | |||
3cc1cf899a | |||
89b41364c3 | |||
d7ffcd19f8 | |||
6b27204711 | |||
4bee1a7041 | |||
f8f36b157f | |||
7018485fde | |||
dcae9f14ee | |||
510dd16e48 | |||
|
257964fb26 | ||
11fe3f3ef7 | |||
|
ba9aa37eae | ||
d54d71403c | |||
|
d9c127339d | ||
2290d7573b | |||
|
7f449da60b | ||
c01614781a | |||
|
95606b8f21 | ||
c70f6386d0 | |||
|
28c896b8fb | ||
|
0c0e1307bd | ||
|
1f82ecea93 | ||
76101e6ce1 | |||
|
b830dc9749 | ||
8988703465 | |||
|
0ec641747a | ||
fa03d3b557 | |||
|
2cebca91a6 | ||
5204de7cbb | |||
|
dcebdb62f2 | ||
5877222e8a | |||
|
811c83a189 | ||
0b610c430e | |||
|
e441398ab4 | ||
|
df29357782 | ||
dc0b42f998 | |||
|
c9657f0b20 | ||
150d1e57f6 | |||
|
2c31e3b350 | ||
|
7794d7a281 | ||
|
083ef551a0 | ||
|
0ecb1c1659 | ||
|
e49cae189a | ||
909ad599bb | |||
|
784b309405 | ||
9f71fdea5f | |||
|
dc84a2eb2a | ||
|
ad3e3e3247 | ||
|
006ed2929c | ||
3920f11b69 | |||
|
a84556fc6f | ||
|
6a936fa610 | ||
|
a358f95f2e | ||
23e0b7671b | |||
|
a60d877ed1 | ||
3728d5ed05 | |||
|
2ee7357913 | ||
4fbfd6da4d | |||
|
747def6210 | ||
f5fe1f7318 | |||
|
792d9734c2 | ||
697673296b | |||
|
58860cbb4c | ||
76722cd0de | |||
764e827a9e | |||
|
0f185974fe | ||
|
659f0a2446 | ||
|
345f9cc563 | ||
|
d1b85de9ec | ||
|
4fc4a78a77 | ||
|
f9828bcbf2 | ||
|
5810834afd | ||
|
ca1d9e8da5 | ||
|
bded061837 | ||
|
93c1ac7971 | ||
|
3cce97dc16 | ||
|
b09c5e52e3 | ||
2de3b60cd3 |
165
file.go
165
file.go
@@ -1,23 +1,28 @@
|
||||
package file // import "go.unistack.org/micro-config-file/v4"
|
||||
package file // import "go.unistack.org/micro-config-file/v3"
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"github.com/imdario/mergo"
|
||||
"go.unistack.org/micro/v4/codec"
|
||||
"go.unistack.org/micro/v4/config"
|
||||
rutil "go.unistack.org/micro/v4/util/reflect"
|
||||
"dario.cat/mergo"
|
||||
"go.unistack.org/micro/v3/config"
|
||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
||||
"golang.org/x/text/transform"
|
||||
)
|
||||
|
||||
var DefaultStructTag = "file"
|
||||
var (
|
||||
DefaultStructTag = "file"
|
||||
MaxFileSize int64 = 1 * 1024 * 1024
|
||||
)
|
||||
|
||||
type fileConfig struct {
|
||||
opts config.Options
|
||||
path string
|
||||
opts config.Options
|
||||
path string
|
||||
reader io.Reader
|
||||
transformer transform.Transformer
|
||||
}
|
||||
|
||||
func (c *fileConfig) Options() config.Options {
|
||||
@@ -37,13 +42,16 @@ func (c *fileConfig) Init(opts ...config.Option) error {
|
||||
if v, ok := c.opts.Context.Value(pathKey{}).(string); ok {
|
||||
c.path = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(transformerKey{}).(transform.Transformer); ok {
|
||||
c.transformer = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(readerKey{}).(io.Reader); ok {
|
||||
c.reader = v
|
||||
}
|
||||
}
|
||||
|
||||
if c.path == "" {
|
||||
err := fmt.Errorf("file path not exists: %v", c.path)
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
if c.opts.Codec == nil {
|
||||
return fmt.Errorf("Codec must be specified")
|
||||
}
|
||||
|
||||
if err := config.DefaultAfterInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
|
||||
@@ -54,22 +62,49 @@ func (c *fileConfig) Init(opts ...config.Option) error {
|
||||
}
|
||||
|
||||
func (c *fileConfig) Load(ctx context.Context, opts ...config.LoadOption) error {
|
||||
if c.opts.SkipLoad != nil && c.opts.SkipLoad(ctx, c) {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := config.DefaultBeforeLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
path := c.path
|
||||
transformer := c.transformer
|
||||
reader := c.reader
|
||||
|
||||
options := config.NewLoadOptions(opts...)
|
||||
if options.Context != nil {
|
||||
if v, ok := options.Context.Value(pathKey{}).(string); ok && v != "" {
|
||||
path = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(transformerKey{}).(transform.Transformer); ok {
|
||||
transformer = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(readerKey{}).(io.Reader); ok {
|
||||
reader = v
|
||||
}
|
||||
}
|
||||
|
||||
var fp io.Reader
|
||||
var err error
|
||||
|
||||
if path != "" {
|
||||
fp, err = os.OpenFile(path, os.O_RDONLY, os.FileMode(0o400))
|
||||
} else if c.reader != nil {
|
||||
fp = reader
|
||||
} else {
|
||||
err = fmt.Errorf("Path or Reader must be specified")
|
||||
}
|
||||
|
||||
fp, err := os.OpenFile(path, os.O_RDONLY, os.FileMode(0400))
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return fmt.Errorf("file load path %s error: %w", path, err)
|
||||
if c.path != "" {
|
||||
return fmt.Errorf("file load path %s error: %w", path, err)
|
||||
} else {
|
||||
return fmt.Errorf("file load error: %w", err)
|
||||
}
|
||||
}
|
||||
if err = config.DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
@@ -78,9 +113,18 @@ func (c *fileConfig) Load(ctx context.Context, opts ...config.LoadOption) error
|
||||
return nil
|
||||
}
|
||||
|
||||
defer fp.Close()
|
||||
if fpc, ok := fp.(io.Closer); ok {
|
||||
defer fpc.Close()
|
||||
}
|
||||
|
||||
buf, err := ioutil.ReadAll(io.LimitReader(fp, int64(codec.DefaultMaxMsgSize)))
|
||||
var r io.Reader
|
||||
if transformer != nil {
|
||||
r = transform.NewReader(fp, c.transformer)
|
||||
} else {
|
||||
r = fp
|
||||
}
|
||||
|
||||
buf, err := io.ReadAll(io.LimitReader(r, MaxFileSize))
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
@@ -125,6 +169,10 @@ func (c *fileConfig) Load(ctx context.Context, opts ...config.LoadOption) error
|
||||
}
|
||||
|
||||
func (c *fileConfig) Save(ctx context.Context, opts ...config.SaveOption) error {
|
||||
if c.opts.SkipSave != nil && c.opts.SkipSave(ctx, c) {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := config.DefaultBeforeSave(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
@@ -154,7 +202,7 @@ func (c *fileConfig) Save(ctx context.Context, opts ...config.SaveOption) error
|
||||
return nil
|
||||
}
|
||||
|
||||
fp, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE, os.FileMode(0600))
|
||||
fp, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE, os.FileMode(0o600))
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
@@ -220,3 +268,82 @@ func NewConfig(opts ...config.Option) config.Config {
|
||||
}
|
||||
return &fileConfig{opts: options}
|
||||
}
|
||||
|
||||
type EnvTransformer struct {
|
||||
maxMatchSize int
|
||||
Regexp *regexp.Regexp
|
||||
TransformerFunc TransformerFunc
|
||||
overflow []byte
|
||||
}
|
||||
|
||||
var _ transform.Transformer = (*EnvTransformer)(nil)
|
||||
|
||||
// Transform implements golang.org/x/text/transform#Transformer
|
||||
func (t *EnvTransformer) Transform(dst, src []byte, atEOF bool) (nDst, nSrc int, err error) {
|
||||
t.maxMatchSize = 1024
|
||||
var n int
|
||||
// copy any overflow from the last call
|
||||
if len(t.overflow) > 0 {
|
||||
n, err = fullcopy(dst, t.overflow)
|
||||
nDst += n
|
||||
if err != nil {
|
||||
t.overflow = t.overflow[n:]
|
||||
return
|
||||
}
|
||||
t.overflow = nil
|
||||
}
|
||||
for _, index := range t.Regexp.FindAllSubmatchIndex(src, -1) {
|
||||
// copy everything up to the match
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:index[0]])
|
||||
nSrc += n
|
||||
nDst += n
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
// skip the match if it ends at the end the src buffer.
|
||||
// it could potentially match more
|
||||
if index[1] == len(src) && !atEOF {
|
||||
break
|
||||
}
|
||||
// copy the replacement
|
||||
rep := t.TransformerFunc(src, index)
|
||||
n, err = fullcopy(dst[nDst:], rep)
|
||||
nDst += n
|
||||
nSrc = index[1]
|
||||
if err != nil {
|
||||
t.overflow = rep[n:]
|
||||
return
|
||||
}
|
||||
}
|
||||
// if we're at the end, tack on any remaining bytes
|
||||
if atEOF {
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:])
|
||||
nDst += n
|
||||
nSrc += n
|
||||
return
|
||||
}
|
||||
// skip any bytes which exceede the max match size
|
||||
if skip := len(src[nSrc:]) - t.maxMatchSize; skip > 0 {
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:nSrc+skip])
|
||||
nSrc += n
|
||||
nDst += n
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
err = transform.ErrShortSrc
|
||||
return
|
||||
}
|
||||
|
||||
// Reset resets the state and allows a Transformer to be reused.
|
||||
func (t *EnvTransformer) Reset() {
|
||||
t.overflow = nil
|
||||
}
|
||||
|
||||
func fullcopy(dst, src []byte) (n int, err error) {
|
||||
n = copy(dst, src)
|
||||
if n < len(src) {
|
||||
err = transform.ErrShortDst
|
||||
}
|
||||
return
|
||||
}
|
||||
|
59
file_test.go
Normal file
59
file_test.go
Normal file
@@ -0,0 +1,59 @@
|
||||
package file
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"go.unistack.org/micro/v3/codec"
|
||||
"go.unistack.org/micro/v3/config"
|
||||
)
|
||||
|
||||
type jsoncodec struct{}
|
||||
|
||||
func (*jsoncodec) Marshal(v interface{}, opts ...codec.Option) ([]byte, error) {
|
||||
return json.Marshal(v)
|
||||
}
|
||||
|
||||
func (*jsoncodec) Unmarshal(buf []byte, v interface{}, opts ...codec.Option) error {
|
||||
return json.Unmarshal(buf, v)
|
||||
}
|
||||
|
||||
func (*jsoncodec) String() string {
|
||||
return "json"
|
||||
}
|
||||
|
||||
func TestLoadReplace(t *testing.T) {
|
||||
type Config struct {
|
||||
Key string
|
||||
Pass string
|
||||
}
|
||||
os.Setenv("PLACEHOLDER", "test")
|
||||
cfg := &Config{}
|
||||
ctx := context.TODO()
|
||||
buf := bytes.NewReader([]byte(`{"key":"val","pass":"${PLACEHOLDER}"}`))
|
||||
tr, err := NewEnvTransformer(`(?s)\$\{.*?\}`, 2, 1)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
c := NewConfig(config.Codec(
|
||||
&jsoncodec{}),
|
||||
config.Struct(cfg),
|
||||
Reader(buf),
|
||||
Transformer(tr),
|
||||
)
|
||||
|
||||
if err := c.Init(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if err := c.Load(ctx); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if cfg.Pass != "test" {
|
||||
t.Fatalf("not works %#+v\n", cfg)
|
||||
}
|
||||
}
|
18
go.mod
18
go.mod
@@ -1,8 +1,18 @@
|
||||
module go.unistack.org/micro-config-file/v4
|
||||
module go.unistack.org/micro-config-file/v3
|
||||
|
||||
go 1.20
|
||||
go 1.22
|
||||
|
||||
toolchain go1.23.1
|
||||
|
||||
require (
|
||||
github.com/imdario/mergo v0.3.14
|
||||
go.unistack.org/micro/v4 v4.0.1
|
||||
dario.cat/mergo v1.0.1
|
||||
go.unistack.org/micro/v3 v3.10.100
|
||||
golang.org/x/text v0.20.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/google/uuid v1.6.0 // indirect
|
||||
go.unistack.org/micro-proto/v3 v3.4.1 // indirect
|
||||
google.golang.org/protobuf v1.35.2 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
26
go.sum
26
go.sum
@@ -1,7 +1,25 @@
|
||||
github.com/imdario/mergo v0.3.14 h1:fOqeC1+nCuuk6PKQdg9YmosXX7Y7mHX6R/0ZldI9iHo=
|
||||
github.com/imdario/mergo v0.3.14/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
|
||||
go.unistack.org/micro/v4 v4.0.1 h1:xo1IxbVfgh8i0eY0VeYa3cbb13u5n/Mxnp3FOgWD4Jo=
|
||||
go.unistack.org/micro/v4 v4.0.1/go.mod h1:p/J5UcSJjfHsWGT31uKoghQ5rUQZzQJBAFy+Z4+ZVMs=
|
||||
dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s=
|
||||
dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
|
||||
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
go.unistack.org/micro-proto/v3 v3.4.1 h1:UTjLSRz2YZuaHk9iSlVqqsA50JQNAEK2ZFboGqtEa9Q=
|
||||
go.unistack.org/micro-proto/v3 v3.4.1/go.mod h1:okx/cnOhzuCX0ggl/vToatbCupi0O44diiiLLsZ93Zo=
|
||||
go.unistack.org/micro/v3 v3.10.97 h1:8l7fv+i06/PjPrBBhRC/ZQkWGIOuHPg3jJN0vktYE78=
|
||||
go.unistack.org/micro/v3 v3.10.97/go.mod h1:YzMldzHN9Ei+zy5t/Psu7RUWDZwUfrNYiStSQtTz90g=
|
||||
go.unistack.org/micro/v3 v3.10.100 h1:yWOaU0ImCGm5k5MUzlIobJUOr+KLfrR/BoDZvcHyKxM=
|
||||
go.unistack.org/micro/v3 v3.10.100/go.mod h1:YzMldzHN9Ei+zy5t/Psu7RUWDZwUfrNYiStSQtTz90g=
|
||||
golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
|
||||
golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
|
||||
golang.org/x/text v0.20.0 h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=
|
||||
golang.org/x/text v0.20.0/go.mod h1:D4IsuqiFMhST5bX19pQ9ikHC2GsaKyk/oF+pn3ducp4=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
|
||||
google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
||||
google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
|
||||
google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
43
options.go
43
options.go
@@ -1,7 +1,12 @@
|
||||
package file
|
||||
|
||||
import (
|
||||
"go.unistack.org/micro/v4/config"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"go.unistack.org/micro/v3/config"
|
||||
"golang.org/x/text/transform"
|
||||
)
|
||||
|
||||
type pathKey struct{}
|
||||
@@ -21,3 +26,39 @@ func SavePath(path string) config.SaveOption {
|
||||
func WatchPath(path string) config.WatchOption {
|
||||
return config.SetWatchOption(pathKey{}, path)
|
||||
}
|
||||
|
||||
type readerKey struct{}
|
||||
|
||||
func Reader(r io.Reader) config.Option {
|
||||
return config.SetOption(readerKey{}, r)
|
||||
}
|
||||
|
||||
type transformerKey struct{}
|
||||
|
||||
type TransformerFunc func(src []byte, index []int) []byte
|
||||
|
||||
func Transformer(t transform.Transformer) config.Option {
|
||||
return config.SetOption(transformerKey{}, t)
|
||||
}
|
||||
|
||||
func NewEnvTransformer(rs string, trimLeft, trimRight int) (*EnvTransformer, error) {
|
||||
re, err := regexp.Compile(rs)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &EnvTransformer{
|
||||
Regexp: re,
|
||||
TransformerFunc: func(src []byte, index []int) []byte {
|
||||
var envKey string
|
||||
if len(src) > index[1]-trimRight {
|
||||
envKey = string(src[index[0]+trimLeft : index[1]-trimRight])
|
||||
}
|
||||
|
||||
if envVal, ok := os.LookupEnv(envKey); ok {
|
||||
return []byte(envVal)
|
||||
}
|
||||
|
||||
return src[index[0]:index[1]]
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
@@ -7,10 +7,9 @@ import (
|
||||
"os"
|
||||
"reflect"
|
||||
|
||||
"go.unistack.org/micro/v4/codec"
|
||||
"go.unistack.org/micro/v4/config"
|
||||
"go.unistack.org/micro/v4/util/jitter"
|
||||
rutil "go.unistack.org/micro/v4/util/reflect"
|
||||
"go.unistack.org/micro/v3/config"
|
||||
"go.unistack.org/micro/v3/util/jitter"
|
||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
||||
)
|
||||
|
||||
type fileWatcher struct {
|
||||
@@ -44,7 +43,7 @@ func (w *fileWatcher) run() {
|
||||
return
|
||||
}
|
||||
var buf []byte
|
||||
buf, err = ioutil.ReadAll(io.LimitReader(fp, int64(codec.DefaultMaxMsgSize)))
|
||||
buf, err = ioutil.ReadAll(io.LimitReader(fp, MaxFileSize))
|
||||
if err == nil {
|
||||
err = w.opts.Codec.Unmarshal(buf, dst)
|
||||
}
|
||||
|
Reference in New Issue
Block a user