Added new output binding for Cosmos Graph DB - Gremlin #885
There are no files selected for viewing
This file contains hidden or 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,123 @@ | ||
| // ------------------------------------------------------------ | ||
| // Copyright (c) Microsoft Corporation and Dapr Contributors. | ||
| // Licensed under the MIT License. | ||
| // ------------------------------------------------------------ | ||
|
|
||
| package cosmosgraphdb | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/dapr/components-contrib/bindings" | ||
| "github.com/dapr/kit/logger" | ||
| gremcos "github.com/supplyon/gremcos" | ||
| ) | ||
|
|
||
| const ( | ||
| queryOperation bindings.OperationKind = "query" | ||
|
|
||
| // keys from request's Data | ||
| commandGremlinKey = "gremlin" | ||
|
|
||
| // keys from response's Data | ||
| respGremlinKey = "gremlin" | ||
| respOpKey = "operation" | ||
| respStartTimeKey = "start-time" | ||
| respEndTimeKey = "end-time" | ||
| respDurationKey = "duration" | ||
| ) | ||
|
|
||
| // CosmosGraphDB allows performing state operations on collections | ||
| type CosmosGraphDB struct { | ||
| metadata *cosmosGraphDBCredentials | ||
| client *gremcos.Cosmos | ||
| logger logger.Logger | ||
| } | ||
|
|
||
| type cosmosGraphDBCredentials struct { | ||
| URL string `json:"url"` | ||
| MasterKey string `json:"masterKey"` | ||
| Username string `json:"username"` | ||
| } | ||
|
|
||
| // NewCosmosGraphDB returns a new CosmosGraphDB instance | ||
| func NewCosmosGraphDB(logger logger.Logger) *CosmosGraphDB { | ||
| return &CosmosGraphDB{logger: logger} | ||
| } | ||
|
|
||
| // Init performs CosmosDB connection parsing and connecting | ||
| func (c *CosmosGraphDB) Init(metadata bindings.Metadata) error { | ||
| c.logger.Debug("Initializing Cosmos Graph DB binding") | ||
|
|
||
| m, err := c.parseMetadata(metadata) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| c.metadata = m | ||
| client, err := gremcos.New(c.metadata.URL, | ||
| gremcos.WithAuth(c.metadata.Username, c.metadata.MasterKey), | ||
| ) | ||
| if err != nil { | ||
| return errors.New("CosmosGraphDB Error: failed to create the Cosmos Graph DB connector") | ||
| } | ||
|
|
||
| c.client = client | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (c *CosmosGraphDB) parseMetadata(metadata bindings.Metadata) (*cosmosGraphDBCredentials, error) { | ||
| b, err := json.Marshal(metadata.Properties) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var creds cosmosGraphDBCredentials | ||
| err = json.Unmarshal(b, &creds) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &creds, nil | ||
| } | ||
|
|
||
| func (c *CosmosGraphDB) Operations() []bindings.OperationKind { | ||
| return []bindings.OperationKind{queryOperation} | ||
| } | ||
|
|
||
| func (c *CosmosGraphDB) Invoke(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { | ||
| var jsonPoint map[string]interface{} | ||
| err := json.Unmarshal(req.Data, &jsonPoint) | ||
| if err != nil { | ||
| return nil, errors.New("CosmosGraphDB Error: Cannot convert request data") | ||
| } | ||
|
|
||
| gq := fmt.Sprintf("%s", jsonPoint[commandGremlinKey]) | ||
|
Member
There was a problem hiding this comment. Nit: It might more sense to unmarshal into an inline struct instead of type gremlinData struct {
Gremlin string `json:"gremlin"` // Note sure if this is always a string, use `interface{}` otherwise.
}
var jsonPoint gremlinDataAlso, using gq := fmt.Sprintf("%v", jsonPoint[commandGremlinKey]) |
||
|
|
||
| if gq == "" { | ||
| return nil, errors.New("CosmosGraphDB Error: missing data - gremlin query not set") | ||
| } | ||
| startTime := time.Now().UTC() | ||
| resp := &bindings.InvokeResponse{ | ||
| Metadata: map[string]string{ | ||
| respOpKey: string(req.Operation), | ||
| respGremlinKey: gq, | ||
| respStartTimeKey: startTime.Format(time.RFC3339Nano), | ||
| }, | ||
| } | ||
| d, err := c.client.Execute(gq) | ||
| if err != nil { | ||
| return nil, errors.New("CosmosGraphDB Error:error excuting gremlin") | ||
| } | ||
| if len(d) > 0 { | ||
| resp.Data = d[0].Result.Data | ||
| } | ||
| endTime := time.Now().UTC() | ||
| resp.Metadata[respEndTimeKey] = endTime.Format(time.RFC3339Nano) | ||
| resp.Metadata[respDurationKey] = endTime.Sub(startTime).String() | ||
|
|
||
| return resp, nil | ||
| } | ||
This file contains hidden or 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,25 @@ | ||
| // ------------------------------------------------------------ | ||
| // Copyright (c) Microsoft Corporation and Dapr Contributors. | ||
| // Licensed under the MIT License. | ||
| // ------------------------------------------------------------ | ||
|
|
||
| package cosmosgraphdb | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/dapr/components-contrib/bindings" | ||
| "github.com/dapr/kit/logger" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestParseMetadata(t *testing.T) { | ||
| m := bindings.Metadata{} | ||
| m.Properties = map[string]string{"Url": "a", "masterKey": "a", "username": "a"} | ||
yaron2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| cosmosgraphdb := CosmosGraphDB{logger: logger.NewLogger("test")} | ||
| im, err := cosmosgraphdb.parseMetadata(m) | ||
| assert.Nil(t, err) | ||
| assert.Equal(t, "a", im.URL) | ||
| assert.Equal(t, "a", im.MasterKey) | ||
| assert.Equal(t, "a", im.Username) | ||
| } | ||
This file contains hidden or 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 hidden or 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
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.
Nit: You can use the configuration decoding pattern we have instead of Marshaling/Unmarshaling JSON.
Example:
https://github.com/dapr/components-contrib/blob/master/bindings/alicloud/nacos/nacos.go#L59-L66
https://github.com/dapr/components-contrib/blob/master/bindings/alicloud/nacos/settings.go