feat: Sync publishes streaming update #371
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package model | ||
|
|
||
| // Event for individual flag overrides | ||
| type UpsertOverrideEvent struct { | ||
| FlagKey string | ||
| ProjectKey string | ||
| FlagState FlagState | ||
| } | ||
|
|
||
| // Event for full project sync | ||
| type SyncEvent struct { | ||
| ProjectKey string | ||
| AllFlagsState FlagsState | ||
| } | ||
|
Comment on lines
+1
to
+14
There was a problem hiding this comment. Pulled these into a catalog file of events. |
||
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 |
|---|---|---|
|
|
@@ -50,23 +50,34 @@ func (c clientFlagsObserver) Handle(event interface{}) { | |
| log.Printf("clientFlagsObserver: handling flag state event: %v", event) | ||
| switch event := event.(type) { | ||
| case model.UpsertOverrideEvent: | ||
| err := SendMessage(c.updateChan, TYPE_PATCH, clientFlag{ | ||
| Key: event.FlagKey, | ||
| Version: event.FlagState.Version, | ||
| Value: event.FlagState.Value, | ||
| }) | ||
| if err != nil { | ||
| panic(errors.Wrap(err, "failed to marshal flag state in observer")) | ||
| } | ||
| case model.SyncEvent: | ||
| clientFlags := clientFlags{} | ||
| for flagKey, flagState := range event.AllFlagsState { | ||
| clientFlags[flagKey] = clientFlag{ | ||
| Version: flagState.Version, | ||
| Value: flagState.Value, | ||
| } | ||
| } | ||
|
|
||
| err := SendMessage(c.updateChan, TYPE_PUT, clientFlags) | ||
| if err != nil { | ||
| panic(errors.Wrap(err, "failed to marshal flag state in observer")) | ||
|
Comment on lines
+65
to
+76
There was a problem hiding this comment. Tried to follow this format as closely as possible - https://launchdarkly.atlassian.net/wiki/spaces/PD/pages/521668284/SDK+streaming+specification#Client-side-%E2%80%9Cput%E2%80%9D-message |
||
| } | ||
| } | ||
| } | ||
|
|
||
| type clientFlag struct { | ||
| Key string `json:"key,omitempty"` | ||
| Version int `json:"version"` | ||
| Value ldvalue.Value `json:"value"` | ||
| } | ||
|
|
||
| type clientFlags map[string]clientFlag | ||
|
Comment on lines
+81
to
+87
There was a problem hiding this comment. Declaring a new struct didn't feel super useful at the moment vs using |
||
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 |
|---|---|---|
| @@ -1,15 +1,23 @@ | ||
| package sdk | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| type MessageType string | ||
|
|
||
| const ( | ||
| TYPE_PUT MessageType = "put" | ||
| TYPE_PATCH MessageType = "patch" | ||
| ) | ||
|
|
||
| type Message struct { | ||
| Event MessageType | ||
| Data []byte | ||
| } | ||
|
|
||
|
|
@@ -67,3 +75,21 @@ func OpenStream(w http.ResponseWriter, done <-chan struct{}, initialMessage Mess | |
| }() | ||
| return updateChan, errChan | ||
| } | ||
|
|
||
| func SendMessage( | ||
| updateChan chan<- Message, | ||
| msgType MessageType, | ||
| data interface{}, | ||
| ) error { | ||
| payload, err := json.Marshal(data) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| updateChan <- Message{ | ||
| Event: msgType, | ||
| Data: payload, | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
Comment on lines
+79
to
+95
There was a problem hiding this comment. Not really sure how / if to unit test this - I've used Go channels only sparingly. On the other hand - emitting messages worked fine before this PR, and testing There was a problem hiding this comment. Might be good to add to the integration tests for syncing the project. RE: unit testing, you could do something like the following. ...
func TestSendMessage(t *testing.T) {
chan := make(chan Message, 1) // needs to be buffered or else you'll deadlock
err := SendMessage(chan, PUT_TYPE, "cat")
require.NoError(t, err)
message := <-chan
...do assertions
}I don't think it's super important to unit test this function: it doesn't really have any logic & it is already being exercised through the integration tests. There was a problem hiding this comment. I decided to implement the integration test for anyone reading this after the fact |
||
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.
This got renamed from
FlagsStatetoAllFlagsStatejust to add a smidge of clarityThere 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.
Nice! It was very confusing.