Get Client History #132
Get Client History #132
Conversation
There was a problem hiding this comment.
Hello, and thank you for your contribution! I'm just leaving a few notes before @platinummonkey gets in here.
| params.Add("onlyNonBlocked", fmt.Sprint(opts.OnlyNonBlocked)) | ||
| params.Add("includeUnifiDevices", fmt.Sprint(opts.IncludeUnifiDevices)) | ||
| params.Add("withinHours", fmt.Sprint(opts.WithinHours)) | ||
| paramStr := params.Encode() |
There was a problem hiding this comment.
This string is only used in one place; recommend relocating params.Encode() to that place.
There was a problem hiding this comment.
The single place that params.Encode() is used is within a for loop ranging sites.
Would it be beneficial to update this?
| @@ -134,6 +134,26 @@ func (m *MockUnifi) GetClientsDPI(_ []*unifi.Site) ([]*unifi.DPITable, error) { | |||
| return results, nil | |||
| } | |||
|
|
|||
| // GetClientHistory returns a response full of client history from the UniFi Controller | |||
| func (m *MockUnifi) GetClientHistory(_ []*unifi.Site, _ *unifi.ClientHistoryOpts) ([]unifi.ClientHistory, error) { | |||
| // TODO : add logic to generate data based on ClientHistoryOpts | |||
There was a problem hiding this comment.
we do this in unpoller with gofakeit so it's possible.
There was a problem hiding this comment.
My initial thought was just manually changing certain fields based on the ClientHistoryOpts.
Please let me know if there is an easier way with gofakeit and if adding this type of functionality would be useful for the mock client.
There was a problem hiding this comment.
Either works for me may be more predictable for tests with a static response
|
The client mocks are mainly for other people trying to integrate and want to write tests. They aren't actually exercised in this repo |
also change the return type of ClientHistory to be a slice of pointers
|
@davidnewhall & @platinummonkey Thank you for taking the time to review my PR! |
|
go ahead and merge from master and the linting errors will be fixed 👍 |
Hello!
I wanted an easy way to pull the client history which included offline devices.
The latest version of the UniFi Controller uses the following URL to pull device history, /proxy/network/v2/api/site/%s/clients/history?%s where the first string substitution is the site name and the second substitution are the following query parameters:
I have added the required URL and function stub in the types.go and the implementation in the clients.go source files. I started to write the test, but do need some advice on how I should proceed with the test.
I am also a little confused if the client mock is being used anywhere, but added the necessary implementation in the mock files as well.
Thanks!