-
Notifications
You must be signed in to change notification settings - Fork 26
/
base.go
197 lines (172 loc) · 4.3 KB
/
base.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Package agent provides the agent implementations and base tooling.
package agent
import (
"bufio"
"encoding/json"
"fmt"
"net/http"
"os"
"strconv"
"time"
"github.com/aunum/gold/pkg/v1/ui"
"github.com/aunum/gold/pkg/v1/ui/sse"
"github.com/phayes/freeport"
"github.com/aunum/gold/pkg/v1/common"
envv1 "github.com/aunum/gold/pkg/v1/env"
"github.com/aunum/gold/pkg/v1/track"
"github.com/aunum/log"
"github.com/skratchdot/open-golang/open"
)
// Base is an agents base functionality.
type Base struct {
// Name of the agent.
Name string
// Port agent is serving on.
Port string
// Tracker for the agent.
Tracker *track.Tracker
// Logger for the agent.
Logger *log.Logger
address string
broker *sse.Broker
noTracker bool
noServer bool
}
// Opt is an option for the base agent.
type Opt func(*Base)
// WithPort sets the port that the agent serves on.
func WithPort(port string) func(*Base) {
return func(b *Base) {
b.Port = port
}
}
// WithTracker sets the tracker being used by the agent
func WithTracker(tracker *track.Tracker) func(*Base) {
return func(b *Base) {
b.Tracker = tracker
}
}
// WithoutTracker prevents tracker from being created.
func WithoutTracker() func(*Base) {
return func(b *Base) {
b.noTracker = true
}
}
// WithLogger adds a logger to the base.
func WithLogger(logger *log.Logger) func(*Base) {
return func(b *Base) {
b.Logger = logger
}
}
// WithoutServer will prevent the provisioning of a server for the agent.
func WithoutServer() func(*Base) {
return func(b *Base) {
b.noServer = true
}
}
// NewBase returns a new base agent. Any errors will be fatal.
func NewBase(name string, opts ...Opt) *Base {
b := &Base{Name: name}
for _, opt := range opts {
opt(b)
}
if b.Logger == nil {
b.Logger = log.DefaultLogger
}
if b.Tracker == nil && !b.noTracker {
tracker, err := track.NewTracker(track.WithLogger(b.Logger))
if err != nil {
log.Fatal(err)
}
b.Tracker = tracker
}
if !b.noServer {
if b.Port == "" {
var port int
// Note: this can panic https://github.com/phayes/freeport/issues/5
err := common.Retry(10, time.Millisecond*1, func() (err error) {
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("caught freeport panic: %v", err)
}
}()
port, err = freeport.GetFreePort()
return err
})
if err != nil {
log.Fatal(err)
}
b.Port = strconv.Itoa(port)
}
b.broker = sse.NewBroker()
}
return b
}
// MakeEpisodes creates a set of episodes for training and stores the number for configuration.
func (b *Base) MakeEpisodes(num int) track.Episodes {
b.Logger.Infof("running for %d episodes", num)
eps := b.Tracker.MakeEpisodes(num)
return eps
}
// Serve the agent api/ui.
func (b *Base) Serve() {
if b.noServer {
b.Logger.Fatal("trying to serve an agent that was created with WithoutServer option")
}
mux := http.NewServeMux()
b.ApplyHandlers(mux)
b.address = fmt.Sprintf("http://localhost:%s", b.Port)
b.Logger.Infof("serving agent api/ui on %s", b.address)
go http.ListenAndServe(fmt.Sprintf(":%s", b.Port), mux)
}
// View starts the local agent server and opens a browser to it.
func (b *Base) View() {
b.Serve()
err := open.Run(b.address)
if err != nil {
b.Logger.Fatalf(`could not open browser; err: %v
see github.com/skratchdot/open-golang
if running in remote terminal consider removing the View() command from the agent`, err)
}
}
// Wait before exiting with a prompt.
func (b *Base) Wait() {
fmt.Print("\npress enter to exit\n")
input := bufio.NewScanner(os.Stdin)
input.Scan()
}
// Render the given data to the ui.
func (b *Base) Render(env *envv1.Env) error {
frame, err := env.Render()
if err != nil {
return err
}
b.broker.Notifier <- frame.Data
return nil
}
// ApplyHandlers adds the base handlers.
func (b *Base) ApplyHandlers(mux *http.ServeMux) error {
b.Tracker.ApplyHandlers(mux)
err := ui.ApplyHandlers(mux)
if err != nil {
return err
}
mux.HandleFunc("/live", b.broker.Handler)
mux.HandleFunc("/info", b.InfoHandler)
return nil
}
// InfoHandler returns info about the agent.
func (b *Base) InfoHandler(w http.ResponseWriter, req *http.Request) {
info := struct {
Name string `json:"name"`
}{
Name: b.Name,
}
bts, err := json.Marshal(info)
if err != nil {
w.WriteHeader(500)
w.Write([]byte(err.Error()))
}
w.WriteHeader(200)
w.Write(bts)
}