Cache config value to optimize Get config API

Author: x-xy-y

archaius_test.go

@@ -3,15 +3,14 @@ package archaius_test
 import (
 	"bytes"
 	"fmt"
-	"io"
-	"os"
-	"path/filepath"
-	"testing"
-
 	"github.com/go-chassis/go-archaius"
 	"github.com/go-chassis/go-archaius/event"
 	"github.com/go-chassis/openlog"
 	"github.com/stretchr/testify/assert"
+	"io"
+	"os"
+	"path/filepath"
+	"testing"
 )
 
 type EListener struct{}
@@ -58,6 +57,8 @@ exist: true
 	t.Run("add mem config", func(t *testing.T) {
 		archaius.Set("age", "16")
 		assert.Equal(t, "16", archaius.Get("age"))
+		archaius.Set("age", "17")
+		assert.Equal(t, "17", archaius.Get("age"))
 	})
 	t.Run("delete mem config", func(t *testing.T) {
 		archaius.Delete("age")

benchmark/benchmark_test.go

@@ -0,0 +1,154 @@
+package benchmark
+
+import (
+	"github.com/go-chassis/go-archaius"
+	"github.com/stretchr/testify/assert"
+	"io"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+var f1Content = `
+age0: 1
+age1: 1
+age2: 1
+age3: 1
+age4: 1
+age5: 1
+age6: 1
+age7: 1
+age8: 1
+age9: 1
+age10: 1
+age11: 1
+age12: 1
+age13: 1
+age14: 1
+age15: 1
+age16: 1
+age17: 1
+age18: 1
+age19: 1
+age20: 1
+age21: 1
+age22: 1
+age23: 1
+age24: 1
+age25: 1
+age26: 1
+age27: 1
+age28: 1
+age29: 1
+age30: 1
+age31: 1
+age32: 1
+age33: 1
+age34: 1
+age35: 1
+age36: 1
+age37: 1
+age38: 1
+age39: 1
+age40: 1
+age41: 1
+age42: 1
+age43: 1
+age44: 1
+age45: 1
+age46: 1
+age47: 1
+age48: 1
+age49: 1
+age50: 1
+age51: 1
+age52: 1
+age53: 1
+age54: 1
+age55: 1
+age56: 1
+age57: 1
+age58: 1
+age59: 1
+age60: 1
+age61: 1
+age62: 1
+age63: 1
+age64: 1
+age65: 1
+age66: 1
+age67: 1
+age68: 1
+age69: 1
+age70: 1
+age71: 1
+age72: 1
+age73: 1
+age74: 1
+age75: 1
+age76: 1
+age77: 1
+age78: 1
+age79: 1
+age80: 1
+age81: 1
+age82: 1
+age83: 1
+age84: 1
+age85: 1
+age86: 1
+age87: 1
+age88: 1
+age89: 1
+age90: 1
+age91: 1
+age92: 1
+age93: 1
+age94: 1
+age95: 1
+age96: 1
+age97: 1
+age98: 1
+age99: 0
+`
+
+func createFile(content string, name string, dir string) string {
+	filename := filepath.Join(dir, name)
+	f1, _ := os.Create(filename)
+	_, _ = io.WriteString(f1, content)
+	f1.Close()
+	return filename
+}
+
+func TestMain(m *testing.M) {
+	filename := createFile(f1Content, "f1.yaml", "/tmp")
+	defer os.Remove(filename)
+
+	err := archaius.Init(archaius.WithOptionalFiles([]string{filename}))
+	if err != nil {
+		os.Exit(-1)
+	}
+	os.Exit(m.Run())
+}
+
+func BenchmarkFileSource(b *testing.B) {
+	s := 0
+	b.ResetTimer()
+
+	for i := 0; i < b.N; i++ {
+		s += archaius.GetInt("age99", 1)
+	}
+	assert.Zero(b, s)
+}
+
+func BenchmarkFileSourceParallelism(b *testing.B) {
+	s := 0
+	b.ResetTimer()
+	b.SetParallelism(200)
+	b.RunParallel(func(pb *testing.PB) {
+		for pb.Next() {
+			s += archaius.GetInt("age99", 1)
+		}
+	})
+	assert.Zero(b, s)
+}

source/manager.go

@@ -36,8 +36,8 @@ import (
 
 //errors
 var (
-	ErrKeyNotExist = errors.New("key does not exist")
-	ErrIgnoreChange = errors.New("ignore key changed")
+	ErrKeyNotExist   = errors.New("key does not exist")
+	ErrIgnoreChange  = errors.New("ignore key changed")
 	ErrWriterInvalid = errors.New("writer is invalid")
 )
 
@@ -55,6 +55,8 @@ type Manager struct {
 	sourceMapMux sync.RWMutex
 	Sources      map[string]ConfigSource
 
+	ConfigValueCache sync.Map
+
 	ConfigurationMap sync.Map
 
 	dispatcher *event.Dispatcher
@@ -79,6 +81,9 @@ func (m *Manager) Cleanup() error {
 			return err
 		}
 	}
+
+	m.ConfigValueCache = sync.Map{}
+
 	return nil
 }
 
@@ -139,8 +144,8 @@ func (m *Manager) Marshal(w io.Writer) error {
 	}
 	allConfig := make(map[string]map[string]interface{})
 	for name, source := range m.Sources {
-		config, err :=  source.GetConfigurations()
-		if err != nil  {
+		config, err := source.GetConfigurations()
+		if err != nil {
 			openlog.Error("get source " + name + " error " + err.Error())
 			continue
 		}
@@ -215,12 +220,11 @@ func (m *Manager) pullSourceConfigs(source string) error {
 func (m *Manager) Configs() map[string]interface{} {
 	config := make(map[string]interface{}, 0)
 
-	m.ConfigurationMap.Range(func(key, value interface{}) bool {
-		sValue := m.configValueBySource(key.(string), value.(string))
-		if sValue == nil {
+	m.ConfigValueCache.Range(func(key, value interface{}) bool {
+		if value == nil {
 			return true
 		}
-		config[key.(string)] = sValue
+		config[key.(string)] = value
 		return true
 	})
 
@@ -236,8 +240,8 @@ func (m *Manager) ConfigsWithSourceNames() map[string]interface{} {
 	config := make(map[string]interface{}, 0)
 
 	m.ConfigurationMap.Range(func(key, value interface{}) bool {
-		sValue := m.configValueBySource(key.(string), value.(string))
-		if sValue == nil {
+		sValue, ok := m.ConfigValueCache.Load(key.(string))
+		if !ok || sValue == nil {
 			return true
 		}
 		// each key stores its value and source name
@@ -317,43 +321,23 @@ func (m *Manager) IsKeyExist(key string) bool {
 
 // GetConfig returns the value for a particular key from cache
 func (m *Manager) GetConfig(key string) interface{} {
-	sourceName, ok := m.ConfigurationMap.Load(key)
-	if !ok {
-		return nil
-	}
-	return m.configValueBySource(key, sourceName.(string))
+	val, _ := m.ConfigValueCache.Load(key)
+	return val
 }
 
 func (m *Manager) updateConfigurationMap(source ConfigSource, configs map[string]interface{}) error {
 	for key := range configs {
-		sourceName, ok := m.ConfigurationMap.Load(key)
-		if !ok { // if key do not exist then add source
-			m.ConfigurationMap.Store(key, source.GetSourceName())
-			continue
-		}
-
-		m.sourceMapMux.RLock()
-		currentSource, ok := m.Sources[sourceName.(string)]
-		m.sourceMapMux.RUnlock()
-		if !ok {
-			m.ConfigurationMap.Store(key, source.GetSourceName())
-			continue
-		}
 
-		currentSrcPriority := currentSource.GetPriority()
-		if currentSrcPriority > source.GetPriority() { // lesser value has high priority
-			m.ConfigurationMap.Store(key, source.GetSourceName())
+		val, err := source.GetConfigurationByKey(key)
+		if err != nil {
+			return err
 		}
-	}
-
-	return nil
-}
 
-func (m *Manager) updateConfigurationMapByDI(source ConfigSource, configs map[string]interface{}) error {
-	for key := range configs {
 		sourceName, ok := m.ConfigurationMap.Load(key)
 		if !ok { // if key do not exist then add source
 			m.ConfigurationMap.Store(key, source.GetSourceName())
+
+			m.ConfigValueCache.Store(key, val)
 			continue
 		}
 
@@ -362,12 +346,15 @@ func (m *Manager) updateConfigurationMapByDI(source ConfigSource, configs map[st
 		m.sourceMapMux.RUnlock()
 		if !ok {
 			m.ConfigurationMap.Store(key, source.GetSourceName())
+
+			m.ConfigValueCache.Store(key, val)
 			continue
 		}
 
 		currentSrcPriority := currentSource.GetPriority()
 		if currentSrcPriority > source.GetPriority() { // lesser value has high priority
 			m.ConfigurationMap.Store(key, source.GetSourceName())
+			m.ConfigValueCache.Store(key, val)
 		}
 	}
 
@@ -409,23 +396,39 @@ func (m *Manager) updateEvent(e *event.Event) error {
 		return nil
 	}
 	openlog.Info("config update event received")
+
 	switch e.EventType {
 	case event.Create, event.Update:
+
 		sourceName, ok := m.ConfigurationMap.Load(e.Key)
+
+		val := m.configValueBySource(e.Key, e.EventSource)
+
 		if !ok {
 			m.ConfigurationMap.Store(e.Key, e.EventSource)
+
+			m.ConfigValueCache.Store(e.Key, val)
+
 			e.EventType = event.Create
 		} else if sourceName == e.EventSource {
+
+			m.ConfigValueCache.Store(e.Key, val)
+
 			e.EventType = event.Update
 		} else if sourceName != e.EventSource {
+
 			prioritySrc := m.getHighPrioritySource(sourceName.(string), e.EventSource)
+
 			if prioritySrc != nil && prioritySrc.GetSourceName() == sourceName {
 				// if event generated from less priority source then ignore
 				openlog.Info(fmt.Sprintf("the event source %s's priority is less then %s's, ignore",
 					e.EventSource, sourceName))
 				return ErrIgnoreChange
 			}
 			m.ConfigurationMap.Store(e.Key, e.EventSource)
+
+			m.ConfigValueCache.Store(e.Key, val)
+
 			e.EventType = event.Update
 		}
 
@@ -441,8 +444,12 @@ func (m *Manager) updateEvent(e *event.Event) error {
 			source := m.findNextBestSource(e.Key, sourceName.(string))
 			if source == nil {
 				m.ConfigurationMap.Delete(e.Key)
+
+				m.ConfigValueCache.Delete(e.Key)
 			} else {
 				m.ConfigurationMap.Store(e.Key, source.GetSourceName())
+
+				m.ConfigValueCache.Store(e.Key, m.configValueBySource(e.Key, source.GetSourceName()))
 			}
 		}