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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
package server
import (
"context"
"fmt"
"os"
"os/exec"
"strings"
"github.com/spiral/errors"
"github.com/spiral/roadrunner/v2/plugins/config"
"github.com/spiral/roadrunner/v2/plugins/logger"
// core imports
"github.com/spiral/roadrunner/v2/interfaces/events"
"github.com/spiral/roadrunner/v2/interfaces/pool"
"github.com/spiral/roadrunner/v2/interfaces/worker"
"github.com/spiral/roadrunner/v2/pkg/pipe"
poolImpl "github.com/spiral/roadrunner/v2/pkg/pool"
"github.com/spiral/roadrunner/v2/pkg/socket"
"github.com/spiral/roadrunner/v2/util"
)
const PluginName = "server"
// Plugin manages worker
type Plugin struct {
cfg Config
log logger.Logger
factory worker.Factory
}
// Init application provider.
func (server *Plugin) Init(cfg config.Configurer, log logger.Logger) error {
const op = errors.Op("Init")
err := cfg.UnmarshalKey(PluginName, &server.cfg)
if err != nil {
return errors.E(op, errors.Init, err)
}
server.cfg.InitDefaults()
server.log = log
server.factory, err = server.initFactory()
if err != nil {
return errors.E(errors.Op("Init factory"), err)
}
return nil
}
// Name contains service name.
func (server *Plugin) Name() string {
return PluginName
}
func (server *Plugin) Serve() chan error {
errCh := make(chan error, 1)
return errCh
}
func (server *Plugin) Stop() error {
if server.factory == nil {
return nil
}
return server.factory.Close()
}
// CmdFactory provides worker command factory associated with given context.
func (server *Plugin) CmdFactory(env Env) (func() *exec.Cmd, error) {
const op = errors.Op("cmd factory")
var cmdArgs []string
// create command according to the config
cmdArgs = append(cmdArgs, strings.Split(server.cfg.Command, " ")...)
if len(cmdArgs) < 2 {
return nil, errors.E(op, errors.Str("should be in form of `php <script>"))
}
if cmdArgs[0] != "php" {
return nil, errors.E(op, errors.Str("first arg in command should be `php`"))
}
_, err := os.Stat(cmdArgs[1])
if err != nil {
return nil, errors.E(op, err)
}
return func() *exec.Cmd {
cmd := exec.Command(cmdArgs[0], cmdArgs[1:]...) //nolint:gosec
util.IsolateProcess(cmd)
// if user is not empty, and OS is linux or macos
// execute php worker from that particular user
if server.cfg.User != "" {
err := util.ExecuteFromUser(cmd, server.cfg.User)
if err != nil {
return nil
}
}
cmd.Env = server.setEnv(env)
return cmd
}, nil
}
// NewWorker issues new standalone worker.
func (server *Plugin) NewWorker(ctx context.Context, env Env, listeners ...events.Listener) (worker.BaseProcess, error) {
const op = errors.Op("new worker")
list := make([]events.Listener, 0, len(listeners))
list = append(list, server.collectWorkerLogs)
spawnCmd, err := server.CmdFactory(env)
if err != nil {
return nil, errors.E(op, err)
}
w, err := server.factory.SpawnWorkerWithTimeout(ctx, spawnCmd(), list...)
if err != nil {
return nil, errors.E(op, err)
}
return w, nil
}
// NewWorkerPool issues new worker pool.
func (server *Plugin) NewWorkerPool(ctx context.Context, opt poolImpl.Config, env Env, listeners ...events.Listener) (pool.Pool, error) {
const op = errors.Op("server plugins new worker pool")
spawnCmd, err := server.CmdFactory(env)
if err != nil {
return nil, errors.E(op, err)
}
list := make([]events.Listener, 0, len(listeners))
list = append(list, server.collectPoolLogs)
p, err := poolImpl.Initialize(ctx, spawnCmd, server.factory, opt, poolImpl.AddListeners(list...))
if err != nil {
return nil, errors.E(op, err)
}
return p, nil
}
// creates relay and worker factory.
func (server *Plugin) initFactory() (worker.Factory, error) {
const op = errors.Op("network factory init")
if server.cfg.Relay == "" || server.cfg.Relay == "pipes" {
return pipe.NewPipeFactory(), nil
}
dsn := strings.Split(server.cfg.Relay, "://")
if len(dsn) != 2 {
return nil, errors.E(op, errors.Network, errors.Str("invalid DSN (tcp://:6001, unix://file.sock)"))
}
lsn, err := util.CreateListener(server.cfg.Relay)
if err != nil {
return nil, errors.E(op, errors.Network, err)
}
switch dsn[0] {
// sockets group
case "unix":
return socket.NewSocketServer(lsn, server.cfg.RelayTimeout), nil
case "tcp":
return socket.NewSocketServer(lsn, server.cfg.RelayTimeout), nil
default:
return nil, errors.E(op, errors.Network, errors.Str("invalid DSN (tcp://:6001, unix://file.sock)"))
}
}
func (server *Plugin) setEnv(e Env) []string {
env := append(os.Environ(), fmt.Sprintf("RR_RELAY=%s", server.cfg.Relay))
for k, v := range e {
env = append(env, fmt.Sprintf("%s=%s", strings.ToUpper(k), v))
}
return env
}
func (server *Plugin) collectPoolLogs(event interface{}) {
if we, ok := event.(events.PoolEvent); ok {
switch we.Event {
case events.EventMaxMemory:
server.log.Info("worker max memory reached", "pid", we.Payload.(worker.BaseProcess).Pid())
case events.EventNoFreeWorkers:
server.log.Info("no free workers in pool", "error", we.Payload.(error).Error())
case events.EventPoolError:
server.log.Info("pool error", "error", we.Payload.(error).Error())
case events.EventSupervisorError:
server.log.Info("pool supervizor error", "error", we.Payload.(error).Error())
case events.EventTTL:
server.log.Info("worker TTL reached", "pid", we.Payload.(worker.BaseProcess).Pid())
case events.EventWorkerConstruct:
if _, ok := we.Payload.(error); ok {
server.log.Error("worker construction error", "error", we.Payload.(error).Error())
return
}
server.log.Info("worker constructed", "pid", we.Payload.(worker.BaseProcess).Pid())
case events.EventWorkerDestruct:
server.log.Info("worker destructed", "pid", we.Payload.(worker.BaseProcess).Pid())
case events.EventExecTTL:
server.log.Info("EVENT EXEC TTL PLACEHOLDER")
case events.EventIdleTTL:
server.log.Info("worker IDLE timeout reached", "pid", we.Payload.(worker.BaseProcess).Pid())
}
}
if we, ok := event.(events.WorkerEvent); ok {
switch we.Event {
case events.EventWorkerError:
server.log.Info(we.Payload.(error).Error(), "pid", we.Worker.(worker.BaseProcess).Pid())
case events.EventWorkerLog:
server.log.Info(strings.TrimRight(string(we.Payload.([]byte)), " \n\t"), "pid", we.Worker.(worker.BaseProcess).Pid())
}
}
}
func (server *Plugin) collectWorkerLogs(event interface{}) {
if we, ok := event.(events.WorkerEvent); ok {
switch we.Event {
case events.EventWorkerError:
server.log.Error(we.Payload.(error).Error(), "pid", we.Worker.(worker.BaseProcess).Pid())
case events.EventWorkerLog:
server.log.Info(strings.TrimRight(string(we.Payload.([]byte)), " \n\t"), "pid", we.Worker.(worker.BaseProcess).Pid())
}
}
}
|
