Added support for centralized dynamic config #24
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| package relay | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| log "github.com/Sirupsen/logrus" | ||
| "github.com/go-yaml/yaml" | ||
| "github.com/operable/go-relay/relay/bus" | ||
| "github.com/operable/go-relay/relay/messages" | ||
| "io/ioutil" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
| "time" | ||
| ) | ||
|
|
||
| // DynamicConfigUpdater periodically updates bundle dynamic configurations from Cog | ||
| type DynamicConfigUpdater struct { | ||
| id string | ||
| configTopic string | ||
| options bus.ConnectionOptions | ||
| conn bus.Connection | ||
| dynamicConfigRoot string | ||
| lastSignature string | ||
| control chan interface{} | ||
| refreshInterval time.Duration | ||
| refreshTimer *time.Timer | ||
| } | ||
|
|
||
| // NewDynamicConfigUpdater creates a new updater | ||
| func NewDynamicConfigUpdater(relayID string, busOpts bus.ConnectionOptions, dynamicConfigRoot string, | ||
| refreshInterval time.Duration) *DynamicConfigUpdater { | ||
| return &DynamicConfigUpdater{ | ||
| id: relayID, | ||
| configTopic: fmt.Sprintf("bot/relays/%s/dynconfigs", relayID), | ||
| options: busOpts, | ||
| dynamicConfigRoot: dynamicConfigRoot, | ||
| refreshInterval: refreshInterval, | ||
| control: make(chan interface{}), | ||
| } | ||
| } | ||
|
|
||
| // Run connects the announcer to Cog and starts its main | ||
| // loop in a goroutine | ||
| func (dcu *DynamicConfigUpdater) Run() error { | ||
| log.Infof("Managed bundle dynamic configs enabled.") | ||
| log.Infof("Refreshing bundle dynamic configs every %v.", dcu.refreshInterval) | ||
| dcu.options.AutoReconnect = true | ||
| dcu.options.EventsHandler = dcu.handleBusEvents | ||
| conn := &bus.MQTTConnection{} | ||
| if err := conn.Connect(dcu.options); err != nil { | ||
| return err | ||
| } | ||
| dcu.refreshConfigs() | ||
| dcu.refreshTimer = time.AfterFunc(dcu.refreshInterval, dcu.refreshConfigs) | ||
| go func() { | ||
| dcu.loop() | ||
| }() | ||
| return nil | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) Halt() { | ||
| dcu.control <- 1 | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) handleBusEvents(conn bus.Connection, event bus.Event) { | ||
| if event == bus.ConnectedEvent { | ||
| dcu.conn = conn | ||
| if err := dcu.conn.Subscribe(dcu.configTopic, dcu.dynConfigUpdate); err != nil { | ||
| log.Errorf("Failed to set up dynamic config updater subscriptions: %s.", err) | ||
| panic(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) dynConfigUpdate(conn bus.Connection, topic string, payload []byte) { | ||
| defer dcu.refreshTimer.Reset(dcu.refreshInterval) | ||
| var envelope messages.DynamicConfigsResponseEnvelope | ||
| decoder := json.NewDecoder(bytes.NewReader(payload)) | ||
| decoder.UseNumber() | ||
|
There was a problem hiding this comment. One day, we should try and pull all the JSON decoding into a module so we don't have to keep repeating this same song and dance... 😦 . I'm afraid one day we're going to add something new and forget about this little wrinkle. There was a problem hiding this comment. One day, we should try and pull all the JSON decoding into a module so we don't have to keep repeating this same song and dance... 😦 . I'm afraid one day we're going to add something new and forget about this little wrinkle. |
||
| if err := decoder.Decode(&envelope); err != nil { | ||
| log.Errorf("Error decoding GetDynamicConfigs result: %s.", err) | ||
| } | ||
| if envelope.Signature != dcu.lastSignature && envelope.Changed == true { | ||
| if dcu.updateConfigs(envelope.Signature, envelope.Configs) { | ||
| dcu.lastSignature = envelope.Signature | ||
| dcu.cleanOldConfigs() | ||
| log.Info("Updated bundle dynamic configs.") | ||
|
|
||
| } | ||
| } | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) refreshConfigs() { | ||
| request := messages.GetDynamicConfigsEnvelope{ | ||
| GetDynamicConfigs: &messages.GetDynamicConfigs{ | ||
| RelayID: dcu.id, | ||
| ReplyTo: dcu.configTopic, | ||
| Signature: dcu.lastSignature, | ||
| }, | ||
| } | ||
| raw, _ := json.Marshal(request) | ||
| if err := dcu.conn.Publish("bot/relays/info", raw); err != nil { | ||
| log.Errorf("Error requesting bundle dynamic configuration update: %s.", err) | ||
| dcu.refreshTimer.Reset(dcu.refreshInterval) | ||
| } | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) loop() { | ||
| <-dcu.control | ||
| dcu.refreshTimer.Stop() | ||
| dcu.conn.Disconnect() | ||
|
There was a problem hiding this comment. How does this loop? |
||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) updateConfigs(signature string, configs []messages.DynamicConfig) bool { | ||
| if !dcu.verifyManagedConfigPath() { | ||
| return false | ||
| } | ||
| updateDir := path.Join(dcu.dynamicConfigRoot, "..", signature) | ||
| if err := os.MkdirAll(updateDir, 0755); err != nil { | ||
| log.Errorf("Error preparing directory %s for updated bundle dynamic configs: %s.", updateDir, err) | ||
| return false | ||
| } | ||
| for _, config := range configs { | ||
| convertedContents, err := yaml.Marshal(config.Config) | ||
| if err != nil { | ||
| log.Errorf("Error preparing dynamic config for bundle %s: %s.", config.BundleName, err) | ||
| return false | ||
| } | ||
| if err := os.MkdirAll(path.Join(updateDir, config.BundleName), 0755); err != nil { | ||
| log.Errorf("Error preparing dynamic config for bundle %s: %s.", config.BundleName, err) | ||
| return false | ||
| } | ||
| configFileName := path.Join(updateDir, config.BundleName, "config.yml") | ||
| if err := ioutil.WriteFile(configFileName, convertedContents, 0644); err != nil { | ||
| log.Errorf("Error writing dynamic config file to path %s: %s.", configFileName, err) | ||
| return false | ||
| } | ||
| log.Debugf("Wrote bundle dynamic config file %s.", configFileName) | ||
| } | ||
| // Create and rename new symlink should make config updates atomic | ||
| symlinkTarget := path.Join(dcu.dynamicConfigRoot, "..", "new") | ||
| if err := os.Symlink(updateDir, symlinkTarget); err != nil { | ||
| log.Errorf("Error replacing existing bundle dynamic configs with updated contents: %s.", err) | ||
| return false | ||
| } | ||
| if err := os.Rename(symlinkTarget, dcu.dynamicConfigRoot); err != nil { | ||
| log.Errorf("Error replacing existing bundle dynamic configs with updated contents: %s.", err) | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) cleanOldConfigs() { | ||
| entries, _ := filepath.Glob(path.Join(dcu.dynamicConfigRoot, "..", "*")) | ||
| for _, entry := range entries { | ||
| if entry == dcu.dynamicConfigRoot || strings.HasSuffix(entry, dcu.lastSignature) { | ||
| continue | ||
| } | ||
| os.RemoveAll(entry) | ||
| } | ||
| } | ||
|
|
||
| func (dcu *DynamicConfigUpdater) verifyManagedConfigPath() bool { | ||
| info, err := os.Lstat(dcu.dynamicConfigRoot) | ||
| if err != nil { | ||
| if strings.HasSuffix(err.Error(), "no such file or directory") { | ||
| return true | ||
| } | ||
| log.Errorf("Error stat-ing dynamic config root directory: %s.", err) | ||
| return false | ||
| } | ||
| if info.Mode()&os.ModeSymlink == 0 { | ||
| log.Errorf("Managed dynamic config root directory %s is not a symlink. Update ABORTED.", dcu.dynamicConfigRoot) | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need to add these to the doc site: http://docs.operable.io/docs/relay-environment-variables
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already done: http://docs.operable.io/v0.8/docs/relay-environment-variables-2
Will flip this page when we release 0.9.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍