Library - Slim down the NodeManagerWorker

[etorreborre]

The purpose of the NodeManagerWorker is to be started as a Worker on a node and receive requests to create entities on that node: inlets, outlets, secure channels, etc...

This should be the only responsibility of the NodeManagerWorker:

• accept Requests, with a specific path
• based on the path, unpack the request arguments and call the relevant method on the NodeManager
• get a value back from the NodeManager and make a Response out of it

Example

For example if we look at this dispatched request:

(Get, ["node", "tcp", "connection", address]) => {
    encode_request_result(self.get_tcp_connection(req, address.to_string()).await)?
}

The implementation in the NodeManagerWorker is:

pub async fn get_tcp_connection(&self, req: &RequestHeader, address: String) 
    -> Result<Response<TransportStatus>, Response<Error>> {
    let tcp_transport = &self.node_manager.tcp_transport;
    let sender = match Self::find_connection(tcp_transport, address.to_string()) {
        None => {
            return Err(Response::not_found(
                req,
                &format!("Connection {address} was not found in the registry."),
            ));
        }
        Some(sender) => sender,
    };
    let status = TransportStatus::new(ApiTransport {
        tt: TransportType::Tcp,
        tm: (*sender.mode()).into(),
        socket_address: sender.socket_address(),
        worker_address: sender.address().to_string(),
        processor_address: sender.receiver_address().to_string(),
        flow_control_id: sender.flow_control_id().clone(),
    });
    Ok(Response::ok(req).body(status))
}

It should actually be something like:

pub async fn get_tcp_connection(&self, req: &RequestHeader, address: String) 
    -> Result<Response<TransportStatus>, Response<Error>> {
    match &self.node_manager.get_tcp_connection(address.to_string()).await? {
        Some(transport_status) => Ok(Response::ok(req).body(transport_status),
        None => {
            Err(Response::not_found(
                req,
                &format!("Connection {address} was not found in the registry."),
            ))
         }
    }
}

In the code above all the logic is handled by the NodeManager and the NodeManagerWorker only deals with Request/Responses.

Stories

The following independent stories can be carved out this epic (each line corresponds to some paths in the handle_request method):

• node / node status
• node / tcp connection
• node / tcp listener
• node / credentials
• node / secure channel
• node / secure channel listener
• node / services / kafka
• node / services / other services
• node / inlet
• node / outlet
• node / flow controls
• node / workers
• policy

Additional notes

You can follow the way relays are handled in this PR (here is the section on relays).

You will notice that the NodeManagerWorker does not contain a direct reference to a NodeManager but to an InMemoryNode, which itself contains a NodeManager.

This intermediary layer is only required to monitor sessions for relays and portals. In most cases when you call self.node_manager in NodeManagerWorker the node_manager can be dereferenced to a NodeManager on which regular calls can be made: to list workers, get a credential etc....

Note

Github project tracking these issues: https://github.com/orgs/build-trust/projects/37/views/1?filterQuery=eric+

Related issues:

• Library - Slim down the NodeManagerWorker for node / node status #6707
• Library - Slim down the NodeManagerWorker for node / tcp #6708
• Library - Slim down the NodeManagerWorker for node / credentials #6709
• Library - Slim down the NodeManagerWorker for node / secure channel #6710
• Library - Slim down the NodeManagerWorker for node / services / kafka #6711
• Library - Slim down the NodeManagerWorker for node / services / other services #6712
• Library - Slim down the NodeManagerWorker for node / inlet and node / outlet #6713
• Library - Slim down the NodeManagerWorker for node / flow controls #6714
• Library - Slim down the NodeManagerWorker for node / workers #6715
• Library - Slim down the NodeManagerWorker for policy #6716