Merge pull request #452 from spiral/refactor/splitv2.0.0-alpha23

Refactor/split

2 files changed, 818 insertions, 0 deletions

diff --git a/pkg/socket/socket_factory.go b/pkg/socket/socket_factory.go
new file mode 100755
index 00000000..f721ad66
--- /dev/null
+++ b/pkg/socket/socket_factory.go
@@ -0,0 +1,228 @@
+package socket
+
+import (
+	"context"
+	"net"
+	"os/exec"
+	"sync"
+	"time"
+
+	"github.com/shirou/gopsutil/process"
+	"github.com/spiral/errors"
+	"github.com/spiral/roadrunner/v2/interfaces/worker"
+	"github.com/spiral/roadrunner/v2/internal"
+	workerImpl "github.com/spiral/roadrunner/v2/pkg/worker"
+
+	"github.com/spiral/goridge/v3"
+	"go.uber.org/multierr"
+	"golang.org/x/sync/errgroup"
+)
+
+// Factory connects to external stack using socket server.
+type Factory struct {
+	// listens for incoming connections from underlying processes
+	ls net.Listener
+
+	// relay connection timeout
+	tout time.Duration
+
+	// sockets which are waiting for process association
+	// relays map[int64]*goridge.SocketRelay
+	relays sync.Map
+
+	ErrCh chan error
+}
+
+// todo: review
+
+// NewSocketServer returns Factory attached to a given socket listener.
+// tout specifies for how long factory should serve for incoming relay connection
+func NewSocketServer(ls net.Listener, tout time.Duration) worker.Factory {
+	f := &Factory{
+		ls:     ls,
+		tout:   tout,
+		relays: sync.Map{},
+		ErrCh:  make(chan error, 10),
+	}
+
+	// Be careful
+	// https://github.com/go101/go101/wiki/About-memory-ordering-guarantees-made-by-atomic-operations-in-Go
+	// https://github.com/golang/go/issues/5045
+	go func() {
+		f.ErrCh <- f.listen()
+	}()
+
+	return f
+}
+
+// blocking operation, returns an error
+func (f *Factory) listen() error {
+	errGr := &errgroup.Group{}
+	errGr.Go(func() error {
+		for {
+			conn, err := f.ls.Accept()
+			if err != nil {
+				return err
+			}
+
+			rl := goridge.NewSocketRelay(conn)
+			pid, err := internal.FetchPID(rl)
+			if err != nil {
+				return err
+			}
+
+			f.attachRelayToPid(pid, rl)
+		}
+	})
+
+	return errGr.Wait()
+}
+
+type socketSpawn struct {
+	w   worker.BaseProcess
+	err error
+}
+
+// SpawnWorker creates Process and connects it to appropriate relay or returns error
+func (f *Factory) SpawnWorkerWithContext(ctx context.Context, cmd *exec.Cmd) (worker.BaseProcess, error) {
+	const op = errors.Op("spawn_worker_with_context")
+	c := make(chan socketSpawn)
+	go func() {
+		ctx, cancel := context.WithTimeout(ctx, f.tout)
+		defer cancel()
+		w, err := workerImpl.InitBaseWorker(cmd)
+		if err != nil {
+			c <- socketSpawn{
+				w:   nil,
+				err: err,
+			}
+			return
+		}
+
+		err = w.Start()
+		if err != nil {
+			c <- socketSpawn{
+				w:   nil,
+				err: errors.E(op, err),
+			}
+			return
+		}
+
+		rl, err := f.findRelayWithContext(ctx, w)
+		if err != nil {
+			err = multierr.Combine(
+				err,
+				w.Kill(),
+				w.Wait(),
+			)
+
+			c <- socketSpawn{
+				w:   nil,
+				err: errors.E(op, err),
+			}
+			return
+		}
+
+		w.AttachRelay(rl)
+		w.State().Set(internal.StateReady)
+
+		c <- socketSpawn{
+			w:   w,
+			err: nil,
+		}
+	}()
+
+	select {
+	case <-ctx.Done():
+		return nil, ctx.Err()
+	case res := <-c:
+		if res.err != nil {
+			return nil, res.err
+		}
+
+		return res.w, nil
+	}
+}
+
+func (f *Factory) SpawnWorker(cmd *exec.Cmd) (worker.BaseProcess, error) {
+	const op = errors.Op("spawn_worker")
+	w, err := workerImpl.InitBaseWorker(cmd)
+	if err != nil {
+		return nil, err
+	}
+
+	err = w.Start()
+	if err != nil {
+		return nil, errors.E(op, err)
+	}
+
+	rl, err := f.findRelay(w)
+	if err != nil {
+		err = multierr.Combine(
+			err,
+			w.Kill(),
+			w.Wait(),
+		)
+		return nil, err
+	}
+
+	w.AttachRelay(rl)
+	w.State().Set(internal.StateReady)
+
+	return w, nil
+}
+
+// Close socket factory and underlying socket connection.
+func (f *Factory) Close(ctx context.Context) error {
+	return f.ls.Close()
+}
+
+// waits for Process to connect over socket and returns associated relay of timeout
+func (f *Factory) findRelayWithContext(ctx context.Context, w worker.BaseProcess) (*goridge.SocketRelay, error) {
+	ticker := time.NewTicker(time.Millisecond * 100)
+	for {
+		select {
+		case <-ctx.Done():
+			return nil, ctx.Err()
+		case <-ticker.C:
+			_, err := process.NewProcess(int32(w.Pid()))
+			if err != nil {
+				return nil, err
+			}
+		default:
+			tmp, ok := f.relays.Load(w.Pid())
+			if !ok {
+				continue
+			}
+			return tmp.(*goridge.SocketRelay), nil
+		}
+	}
+}
+
+func (f *Factory) findRelay(w worker.BaseProcess) (*goridge.SocketRelay, error) {
+	const op = errors.Op("find_relay")
+	// poll every 1ms for the relay
+	pollDone := time.NewTimer(f.tout)
+	for {
+		select {
+		case <-pollDone.C:
+			return nil, errors.E(op, errors.Str("relay timeout"))
+		default:
+			tmp, ok := f.relays.Load(w.Pid())
+			if !ok {
+				continue
+			}
+			return tmp.(*goridge.SocketRelay), nil
+		}
+	}
+}
+
+// chan to store relay associated with specific pid
+func (f *Factory) attachRelayToPid(pid int64, relay goridge.Relay) {
+	f.relays.Store(pid, relay)
+}
+
+// deletes relay chan associated with specific pid
+func (f *Factory) removeRelayFromPid(pid int64) {
+	f.relays.Delete(pid)
+}
diff --git a/pkg/socket/socket_factory_test.go b/pkg/socket/socket_factory_test.go
new file mode 100755
index 00000000..f1a7d637
--- /dev/null
+++ b/pkg/socket/socket_factory_test.go
@@ -0,0 +1,590 @@
+package socket
+
+import (
+	"context"
+	"net"
+	"os/exec"
+	"sync"
+	"testing"
+	"time"
+
+	"github.com/spiral/roadrunner/v2/internal"
+	"github.com/spiral/roadrunner/v2/pkg/worker"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Tcp_Start(t *testing.T) {
+	ctx := context.Background()
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "tcp")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	assert.NoError(t, err)
+	assert.NotNil(t, w)
+
+	go func() {
+		assert.NoError(t, w.Wait())
+	}()
+
+	err = w.Stop(ctx)
+	if err != nil {
+		t.Errorf("error stopping the Process: error %v", err)
+	}
+}
+
+func Test_Tcp_StartCloseFactory(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "tcp")
+
+	f := NewSocketServer(ls, time.Minute)
+	defer func() {
+		err := ls.Close()
+		if err != nil {
+			t.Errorf("error closing the listener: error %v", err)
+		}
+	}()
+
+	w, err := f.SpawnWorkerWithContext(ctx, cmd)
+	assert.NoError(t, err)
+	assert.NotNil(t, w)
+
+	err = w.Stop(ctx)
+	if err != nil {
+		t.Errorf("error stopping the Process: error %v", err)
+	}
+}
+
+func Test_Tcp_StartError(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "pipes")
+	err = cmd.Start()
+	if err != nil {
+		t.Errorf("error executing the command: error %v", err)
+	}
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	assert.Error(t, err)
+	assert.Nil(t, w)
+}
+
+func Test_Tcp_Failboot(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err3 := ls.Close()
+			if err3 != nil {
+				t.Errorf("error closing the listener: error %v", err3)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/failboot.php")
+
+	w, err2 := NewSocketServer(ls, time.Second*5).SpawnWorkerWithContext(ctx, cmd)
+	assert.Nil(t, w)
+	assert.Error(t, err2)
+	assert.Contains(t, err2.Error(), "failboot")
+}
+
+func Test_Tcp_Timeout(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/slow-client.php", "echo", "tcp", "200", "0")
+
+	w, err := NewSocketServer(ls, time.Millisecond*1).SpawnWorkerWithContext(ctx, cmd)
+	assert.Nil(t, w)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "context deadline exceeded")
+}
+
+func Test_Tcp_Invalid(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/invalid.php")
+
+	w, err := NewSocketServer(ls, time.Second*1).SpawnWorkerWithContext(ctx, cmd)
+	assert.Error(t, err)
+	assert.Nil(t, w)
+}
+
+func Test_Tcp_Broken(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "broken", "tcp")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	if err != nil {
+		t.Fatal(err)
+	}
+	wg := sync.WaitGroup{}
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		err := w.Wait()
+		assert.Error(t, err)
+		assert.Contains(t, err.Error(), "undefined_function()")
+	}()
+
+	defer func() {
+		time.Sleep(time.Second)
+		err2 := w.Stop(ctx)
+		// write tcp 127.0.0.1:9007->127.0.0.1:34204: use of closed network connection
+		assert.Error(t, err2)
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	res, err := sw.Exec(internal.Payload{Body: []byte("hello")})
+	assert.Error(t, err)
+	assert.Nil(t, res.Body)
+	assert.Nil(t, res.Context)
+	wg.Wait()
+}
+
+func Test_Tcp_Echo(t *testing.T) {
+	time.Sleep(time.Millisecond * 10) // to ensure free socket
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if assert.NoError(t, err) {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "tcp")
+
+	w, _ := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	go func() {
+		assert.NoError(t, w.Wait())
+	}()
+	defer func() {
+		err = w.Stop(ctx)
+		if err != nil {
+			t.Errorf("error stopping the Process: error %v", err)
+		}
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	res, err := sw.Exec(internal.Payload{Body: []byte("hello")})
+
+	assert.NoError(t, err)
+	assert.NotNil(t, res)
+	assert.NotNil(t, res.Body)
+	assert.Empty(t, res.Context)
+
+	assert.Equal(t, "hello", res.String())
+}
+
+func Test_Unix_Start(t *testing.T) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "unix")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	assert.NoError(t, err)
+	assert.NotNil(t, w)
+
+	go func() {
+		assert.NoError(t, w.Wait())
+	}()
+
+	err = w.Stop(ctx)
+	if err != nil {
+		t.Errorf("error stopping the Process: error %v", err)
+	}
+}
+
+func Test_Unix_Failboot(t *testing.T) {
+	ls, err := net.Listen("unix", "sock.unix")
+	ctx := context.Background()
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/failboot.php")
+
+	w, err := NewSocketServer(ls, time.Second*5).SpawnWorkerWithContext(ctx, cmd)
+	assert.Nil(t, w)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "failboot")
+}
+
+func Test_Unix_Timeout(t *testing.T) {
+	ls, err := net.Listen("unix", "sock.unix")
+	ctx := context.Background()
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/slow-client.php", "echo", "unix", "200", "0")
+
+	w, err := NewSocketServer(ls, time.Millisecond*100).SpawnWorkerWithContext(ctx, cmd)
+	assert.Nil(t, w)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "context deadline exceeded")
+}
+
+func Test_Unix_Invalid(t *testing.T) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/invalid.php")
+
+	w, err := NewSocketServer(ls, time.Second*10).SpawnWorkerWithContext(ctx, cmd)
+	assert.Error(t, err)
+	assert.Nil(t, w)
+}
+
+func Test_Unix_Broken(t *testing.T) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "broken", "unix")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	if err != nil {
+		t.Fatal(err)
+	}
+	wg := &sync.WaitGroup{}
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		err := w.Wait()
+		assert.Error(t, err)
+		assert.Contains(t, err.Error(), "undefined_function()")
+	}()
+
+	defer func() {
+		time.Sleep(time.Second)
+		err = w.Stop(ctx)
+		assert.Error(t, err)
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	res, err := sw.Exec(internal.Payload{Body: []byte("hello")})
+
+	assert.Error(t, err)
+	assert.Nil(t, res.Context)
+	assert.Nil(t, res.Body)
+	wg.Wait()
+}
+
+func Test_Unix_Echo(t *testing.T) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				t.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		t.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "unix")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	if err != nil {
+		t.Fatal(err)
+	}
+	go func() {
+		assert.NoError(t, w.Wait())
+	}()
+	defer func() {
+		err = w.Stop(ctx)
+		if err != nil {
+			t.Errorf("error stopping the Process: error %v", err)
+		}
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	res, err := sw.Exec(internal.Payload{Body: []byte("hello")})
+
+	assert.NoError(t, err)
+	assert.NotNil(t, res)
+	assert.NotNil(t, res.Body)
+	assert.Empty(t, res.Context)
+
+	assert.Equal(t, "hello", res.String())
+}
+
+func Benchmark_Tcp_SpawnWorker_Stop(b *testing.B) {
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if err == nil {
+		defer func() {
+			err = ls.Close()
+			if err != nil {
+				b.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		b.Skip("socket is busy")
+	}
+
+	f := NewSocketServer(ls, time.Minute)
+	for n := 0; n < b.N; n++ {
+		cmd := exec.Command("php", "../../tests/client.php", "echo", "tcp")
+
+		w, err := f.SpawnWorkerWithContext(ctx, cmd)
+		if err != nil {
+			b.Fatal(err)
+		}
+		go func() {
+			assert.NoError(b, w.Wait())
+		}()
+
+		err = w.Stop(ctx)
+		if err != nil {
+			b.Errorf("error stopping the Process: error %v", err)
+		}
+	}
+}
+
+func Benchmark_Tcp_Worker_ExecEcho(b *testing.B) {
+	ctx := context.Background()
+	ls, err := net.Listen("tcp", "localhost:9007")
+	if err == nil {
+		defer func() {
+			err = ls.Close()
+			if err != nil {
+				b.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		b.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "tcp")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	if err != nil {
+		b.Fatal(err)
+	}
+	defer func() {
+		err = w.Stop(ctx)
+		if err != nil {
+			b.Errorf("error stopping the Process: error %v", err)
+		}
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		b.Fatal(err)
+	}
+
+	for n := 0; n < b.N; n++ {
+		if _, err := sw.Exec(internal.Payload{Body: []byte("hello")}); err != nil {
+			b.Fail()
+		}
+	}
+}
+
+func Benchmark_Unix_SpawnWorker_Stop(b *testing.B) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				b.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		b.Skip("socket is busy")
+	}
+
+	f := NewSocketServer(ls, time.Minute)
+	for n := 0; n < b.N; n++ {
+		cmd := exec.Command("php", "../../tests/client.php", "echo", "unix")
+
+		w, err := f.SpawnWorkerWithContext(ctx, cmd)
+		if err != nil {
+			b.Fatal(err)
+		}
+		err = w.Stop(ctx)
+		if err != nil {
+			b.Errorf("error stopping the Process: error %v", err)
+		}
+	}
+}
+
+func Benchmark_Unix_Worker_ExecEcho(b *testing.B) {
+	ctx := context.Background()
+	ls, err := net.Listen("unix", "sock.unix")
+	if err == nil {
+		defer func() {
+			err := ls.Close()
+			if err != nil {
+				b.Errorf("error closing the listener: error %v", err)
+			}
+		}()
+	} else {
+		b.Skip("socket is busy")
+	}
+
+	cmd := exec.Command("php", "../../tests/client.php", "echo", "unix")
+
+	w, err := NewSocketServer(ls, time.Minute).SpawnWorkerWithContext(ctx, cmd)
+	if err != nil {
+		b.Fatal(err)
+	}
+	defer func() {
+		err = w.Stop(ctx)
+		if err != nil {
+			b.Errorf("error stopping the Process: error %v", err)
+		}
+	}()
+
+	sw, err := worker.From(w)
+	if err != nil {
+		b.Fatal(err)
+	}
+
+	for n := 0; n < b.N; n++ {
+		if _, err := sw.Exec(internal.Payload{Body: []byte("hello")}); err != nil {
+			b.Fail()
+		}
+	}
+}