minio/internal/dsync
Klaus Post 51aa59a737
perf: websocket grid connectivity for all internode communication (#18461)
This PR adds a WebSocket grid feature that allows servers to communicate via 
a single two-way connection.

There are two request types:

* Single requests, which are `[]byte => ([]byte, error)`. This is for efficient small
  roundtrips with small payloads.

* Streaming requests which are `[]byte, chan []byte => chan []byte (and error)`,
  which allows for different combinations of full two-way streams with an initial payload.

Only a single stream is created between two machines - and there is, as such, no
server/client relation since both sides can initiate and handle requests. Which server
initiates the request is decided deterministically on the server names.

Requests are made through a mux client and server, which handles message
passing, congestion, cancelation, timeouts, etc.

If a connection is lost, all requests are canceled, and the calling server will try
to reconnect. Registered handlers can operate directly on byte 
slices or use a higher-level generics abstraction.

There is no versioning of handlers/clients, and incompatible changes should
be handled by adding new handlers.

The request path can be changed to a new one for any protocol changes.

First, all servers create a "Manager." The manager must know its address 
as well as all remote addresses. This will manage all connections.
To get a connection to any remote, ask the manager to provide it given
the remote address using.

```
func (m *Manager) Connection(host string) *Connection
```

All serverside handlers must also be registered on the manager. This will
make sure that all incoming requests are served. The number of in-flight 
requests and responses must also be given for streaming requests.

The "Connection" returned manages the mux-clients. Requests issued
to the connection will be sent to the remote.

* `func (c *Connection) Request(ctx context.Context, h HandlerID, req []byte) ([]byte, error)`
   performs a single request and returns the result. Any deadline provided on the request is
   forwarded to the server, and canceling the context will make the function return at once.

* `func (c *Connection) NewStream(ctx context.Context, h HandlerID, payload []byte) (st *Stream, err error)`
   will initiate a remote call and send the initial payload.

```Go
// A Stream is a two-way stream.
// All responses *must* be read by the caller.
// If the call is canceled through the context,
//The appropriate error will be returned.
type Stream struct {
	// Responses from the remote server.
	// Channel will be closed after an error or when the remote closes.
	// All responses *must* be read by the caller until either an error is returned or the channel is closed.
	// Canceling the context will cause the context cancellation error to be returned.
	Responses <-chan Response

	// Requests sent to the server.
	// If the handler is defined with 0 incoming capacity this will be nil.
	// Channel *must* be closed to signal the end of the stream.
	// If the request context is canceled, the stream will no longer process requests.
	Requests chan<- []byte
}

type Response struct {
	Msg []byte
	Err error
}
```

There are generic versions of the server/client handlers that allow the use of type
safe implementations for data types that support msgpack marshal/unmarshal.
2023-11-20 17:09:35 -08:00
..
.gitignore rename all remaining packages to internal/ (#12418) 2021-06-01 14:59:40 -07:00
drwmutex.go Update to minio/pkg/v2 (#17967) 2023-09-04 12:57:37 -07:00
drwmutex_test.go debug: Add X-Amz-Request-ID to lock/unlock calls (#16309) 2022-12-23 19:49:07 -08:00
dsync-client_test.go tests: Remove RPC wording from the code (#14142) 2022-01-20 09:36:09 -08:00
dsync-server_test.go add missing gorilla/mux migration, update credits (#16461) 2023-01-23 08:46:37 -08:00
dsync.go tests: Clean up dsync package (#14415) 2022-03-01 11:14:28 -08:00
dsync_test.go debug: Add X-Amz-Request-ID to lock/unlock calls (#16309) 2022-12-23 19:49:07 -08:00
lock-args.go perf: websocket grid connectivity for all internode communication (#18461) 2023-11-20 17:09:35 -08:00
lock-args_gen.go perf: websocket grid connectivity for all internode communication (#18461) 2023-11-20 17:09:35 -08:00
lock-args_gen_test.go perf: websocket grid connectivity for all internode communication (#18461) 2023-11-20 17:09:35 -08:00
locked_rand.go re-use rand.New() do not repeat allocate. (#13448) 2021-10-18 08:39:59 -07:00
locker.go cleanup dsync tests and remove net/rpc references (#14118) 2022-01-18 12:44:38 -08:00
utils.go lock: Retry locking with an increasing random interval (#17200) 2023-05-13 08:42:21 -07:00