Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Client Code, part 4/7: command #199

Closed
wants to merge 7 commits into from
Closed

Refactor Client Code, part 4/7: command #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ebe72d7
#196: Follow on from #195.
brandonforster Jan 16, 2020
4b3288d
#196: Applied pattern to core-data clients.
brandonforster Jan 16, 2020
ea0bf61
#196: Updated with PR feedback.
brandonforster Jan 20, 2020
520c9f0
Updated registry tests to better actuate the endpoint code.
brandonforster Jan 21, 2020
dd15615
Formatting. Whoops
brandonforster Jan 21, 2020
d38330e
#196: Updated command client with URLClient
brandonforster Jan 20, 2020
b9178db
#196: url->urlPrefix
brandonforster Jan 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 38 additions & 26 deletions clients/command/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ import (
"github.com/edgexfoundry/go-mod-core-contracts/clients"
"github.com/edgexfoundry/go-mod-core-contracts/clients/interfaces"
"github.com/edgexfoundry/go-mod-core-contracts/clients/types"
"github.com/edgexfoundry/go-mod-core-contracts/clients/urlclient"
)

// The CommandClient interface defines interactions with the EdgeX Core Command microservice.
// CommandClient interface defines interactions with the EdgeX Core Command microservice.
type CommandClient interface {
// Get issues a GET command targeting the specified device, using the specified command id
Get(deviceId string, commandId string, ctx context.Context) (string, error)
Expand All @@ -38,46 +39,57 @@ type CommandClient interface {
}

type commandRestClient struct {
url string
endpoint interfaces.Endpointer
urlClient interfaces.URLClient
}

// NewCommandClient creates an instance of CommandClient
func NewCommandClient(params types.EndpointParams, m interfaces.Endpointer) CommandClient {
c := commandRestClient{endpoint: m}
c.init(params)
return &c
return &commandRestClient{urlClient: urlclient.New(params, m)}
}

func (c *commandRestClient) init(params types.EndpointParams) {
if params.UseRegistry {
go func(ch chan string) {
for {
select {
case url := <-ch:
c.url = url
}
}
}(c.endpoint.Monitor(params))
} else {
c.url = params.Url
func (cc *commandRestClient) Get(deviceId string, commandId string, ctx context.Context) (string, error) {
url, err := cc.urlClient.Prefix()
brandonforster marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return "", err
}
}

func (cc *commandRestClient) Get(deviceId string, commandId string, ctx context.Context) (string, error) {
body, err := clients.GetRequest(cc.url+"/"+deviceId+"/command/"+commandId, ctx)
body, err := clients.GetRequest(url+"/"+deviceId+"/command/"+commandId, ctx)
return string(body), err
}

func (cc *commandRestClient) Put(deviceId string, commandId string, body string, ctx context.Context) (string, error) {
return clients.PutRequest(cc.url+"/"+deviceId+"/command/"+commandId, []byte(body), ctx)
url, err := cc.urlClient.Prefix()
if err != nil {
return "", err
}

return clients.PutRequest(url+"/"+deviceId+"/command/"+commandId, []byte(body), ctx)
}

func (cc *commandRestClient) GetDeviceCommandByNames(deviceName string, commandName string, ctx context.Context) (string, error) {
body, err := clients.GetRequest(cc.url+"/name/"+deviceName+"/command/"+commandName, ctx)
func (cc *commandRestClient) GetDeviceCommandByNames(
deviceName string,
commandName string,
ctx context.Context) (string, error) {

url, err := cc.urlClient.Prefix()
if err != nil {
return "", err
}

body, err := clients.GetRequest(url+"/name/"+deviceName+"/command/"+commandName, ctx)
return string(body), err
}

func (cc *commandRestClient) PutDeviceCommandByNames(deviceName string, commandName string, body string, ctx context.Context) (string, error) {
return clients.PutRequest(cc.url+"/name/"+deviceName+"/command/"+commandName, []byte(body), ctx)
func (cc *commandRestClient) PutDeviceCommandByNames(
deviceName string,
commandName string,
body string,
ctx context.Context) (string, error) {

urlPrefix, err := cc.urlClient.Prefix()
if err != nil {
return "", err
}

return clients.PutRequest(urlPrefix+"/name/"+deviceName+"/command/"+commandName, []byte(body), ctx)
}
143 changes: 98 additions & 45 deletions clients/coredata/event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@
*
*******************************************************************************/

/*
Package coredata provides clients used for integration with the core-data service.
*/
// coredata provides clients used for integration with the core-data service.
package coredata

import (
Expand All @@ -29,6 +27,7 @@ import (
"github.com/edgexfoundry/go-mod-core-contracts/clients"
"github.com/edgexfoundry/go-mod-core-contracts/clients/interfaces"
"github.com/edgexfoundry/go-mod-core-contracts/clients/types"
"github.com/edgexfoundry/go-mod-core-contracts/clients/urlclient"
"github.com/edgexfoundry/go-mod-core-contracts/models"
)

Expand All @@ -50,7 +49,7 @@ type EventClient interface {
EventsForDeviceAndValueDescriptor(deviceId string, vd string, limit int, ctx context.Context) ([]models.Event, error)
// Add will post a new event
Add(event *models.Event, ctx context.Context) (string, error)
//AddBytes posts a new event using an array of bytes, supporting encoding of the event by the caller.
// AddBytes posts a new event using an array of bytes, supporting encoding of the event by the caller.
AddBytes(event []byte, ctx context.Context) (string, error)
// DeleteForDevice will delete events by the specified device name
DeleteForDevice(id string, ctx context.Context) error
Expand All @@ -68,47 +67,43 @@ type EventClient interface {
}

type eventRestClient struct {
url string
endpoint interfaces.Endpointer
urlClient interfaces.URLClient
}

// NewEventClient creates an instance of EventClient
func NewEventClient(params types.EndpointParams, m interfaces.Endpointer) EventClient {
e := eventRestClient{endpoint: m}
e.init(params)
return &e
}

func (e *eventRestClient) init(params types.EndpointParams) {
if params.UseRegistry {
go func(ch chan string) {
for {
select {
case url := <-ch:
e.url = url
}
}
}(e.endpoint.Monitor(params))
} else {
e.url = params.Url
}
return &eventRestClient{urlClient: urlclient.New(params, m)}
}

// Helper method to request and decode an event slice
func (e *eventRestClient) requestEventSlice(url string, ctx context.Context) ([]models.Event, error) {
data, err := clients.GetRequest(url, ctx)
func (e *eventRestClient) requestEventSlice(urlSuffix string, ctx context.Context) ([]models.Event, error) {
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return []models.Event{}, err
}

data, err := clients.GetRequest(urlPrefix+urlSuffix, ctx)
if err != nil {
return []models.Event{}, err
}

eSlice := make([]models.Event, 0)
err = json.Unmarshal(data, &eSlice)
return eSlice, err
if err != nil {
return []models.Event{}, err
}

return eSlice, nil
}

// Helper method to request and decode an event
func (e *eventRestClient) requestEvent(url string, ctx context.Context) (models.Event, error) {
data, err := clients.GetRequest(url, ctx)
func (e *eventRestClient) requestEvent(urlSuffix string, ctx context.Context) (models.Event, error) {
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return models.Event{}, err
}

data, err := clients.GetRequest(urlPrefix+urlSuffix, ctx)
if err != nil {
return models.Event{}, err
}
Expand All @@ -119,65 +114,123 @@ func (e *eventRestClient) requestEvent(url string, ctx context.Context) (models.
}

func (e *eventRestClient) Events(ctx context.Context) ([]models.Event, error) {
return e.requestEventSlice(e.url, ctx)
return e.requestEventSlice("", ctx)
}

func (e *eventRestClient) Event(id string, ctx context.Context) (models.Event, error) {
return e.requestEvent(e.url+"/"+id, ctx)
return e.requestEvent("/"+id, ctx)
}

func (e *eventRestClient) EventCount(ctx context.Context) (int, error) {
return clients.CountRequest(e.url+"/count", ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return 0, err
}

return clients.CountRequest(urlPrefix+"/count", ctx)
}

func (e *eventRestClient) EventCountForDevice(deviceId string, ctx context.Context) (int, error) {
return clients.CountRequest(e.url+"/count/"+url.QueryEscape(deviceId), ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return 0, err
}

return clients.CountRequest(urlPrefix+"/count/"+url.QueryEscape(deviceId), ctx)
}

func (e *eventRestClient) EventsForDevice(deviceId string, limit int, ctx context.Context) ([]models.Event, error) {
return e.requestEventSlice(e.url+"/device/"+url.QueryEscape(deviceId)+"/"+strconv.Itoa(limit), ctx)
return e.requestEventSlice("/device/"+url.QueryEscape(deviceId)+"/"+strconv.Itoa(limit), ctx)
}

func (e *eventRestClient) EventsForInterval(start int, end int, limit int, ctx context.Context) ([]models.Event, error) {
return e.requestEventSlice(e.url+"/"+strconv.Itoa(start)+"/"+strconv.Itoa(end)+"/"+strconv.Itoa(limit), ctx)
return e.requestEventSlice("/"+strconv.Itoa(start)+"/"+strconv.Itoa(end)+"/"+strconv.Itoa(limit), ctx)
}

func (e *eventRestClient) EventsForDeviceAndValueDescriptor(deviceId string, vd string, limit int, ctx context.Context) ([]models.Event, error) {
return e.requestEventSlice(e.url+"/device/"+url.QueryEscape(deviceId)+"/valuedescriptor/"+url.QueryEscape(vd)+"/"+strconv.Itoa(limit), ctx)
func (e *eventRestClient) EventsForDeviceAndValueDescriptor(
deviceId string,
vd string,
limit int,
ctx context.Context) ([]models.Event, error) {

return e.requestEventSlice(
"/device/"+
url.QueryEscape(deviceId)+
"/valuedescriptor/"+
url.QueryEscape(vd)+
"/"+strconv.Itoa(limit),
ctx,
)
}

func (e *eventRestClient) Add(event *models.Event, ctx context.Context) (string, error) {
content := clients.FromContext(clients.ContentType, ctx)

urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return "", err
}

if content == clients.ContentTypeCBOR {
return clients.PostRequest(e.url, event.CBOR(), ctx)
return clients.PostRequest(urlPrefix, event.CBOR(), ctx)
} else {
return clients.PostJsonRequest(e.url, event, ctx)
return clients.PostJsonRequest(urlPrefix, event, ctx)
}
}

func (e *eventRestClient) AddBytes(event []byte, ctx context.Context) (string, error) {
return clients.PostRequest(e.url, event, ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return "", err
}

return clients.PostRequest(urlPrefix, event, ctx)
}

func (e *eventRestClient) Delete(id string, ctx context.Context) error {
return clients.DeleteRequest(e.url+"/id/"+id, ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return err
}

return clients.DeleteRequest(urlPrefix+"/id/"+id, ctx)
}

func (e *eventRestClient) DeleteForDevice(deviceId string, ctx context.Context) error {
return clients.DeleteRequest(e.url+"/device/"+url.QueryEscape(deviceId), ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return err
}

return clients.DeleteRequest(urlPrefix+"/device/"+url.QueryEscape(deviceId), ctx)
}

func (e *eventRestClient) DeleteOld(age int, ctx context.Context) error {
return clients.DeleteRequest(e.url+"/removeold/age/"+strconv.Itoa(age), ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return err
}

return clients.DeleteRequest(urlPrefix+"/removeold/age/"+strconv.Itoa(age), ctx)
}

func (e *eventRestClient) MarkPushed(id string, ctx context.Context) error {
_, err := clients.PutRequest(e.url+"/id/"+id, nil, ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return err
}

_, err = clients.PutRequest(urlPrefix+"/id/"+id, nil, ctx)
return err
}

func (e *eventRestClient) MarkPushedByChecksum(checksum string, ctx context.Context) error {
_, err := clients.PutRequest(e.url+"/checksum/"+checksum, nil, ctx)
urlPrefix, err := e.urlClient.Prefix()
if err != nil {
return err
}

_, err = clients.PutRequest(urlPrefix+"/checksum/"+checksum, nil, ctx)
return err
}

Expand Down
11 changes: 6 additions & 5 deletions clients/coredata/event_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ import (
"net/http"
"net/http/httptest"
"testing"
"time"

"github.com/edgexfoundry/go-mod-core-contracts/clients"
"github.com/edgexfoundry/go-mod-core-contracts/clients/types"
"github.com/edgexfoundry/go-mod-core-contracts/models"

"github.com/ugorji/go/codec"
)

Expand Down Expand Up @@ -182,11 +182,12 @@ func TestNewEventClientWithConsul(t *testing.T) {
t.Error("ec is not of expected type")
}

time.Sleep(25 * time.Millisecond)
if len(r.url) == 0 {
url, err := r.urlClient.Prefix()

if err != nil {
t.Error("url was not initialized")
} else if r.url != deviceUrl {
t.Errorf("unexpected url value %s", r.url)
} else if url != deviceUrl {
t.Errorf("unexpected url value %s", url)
}
}

Expand Down
Loading