hyperledger-labs / fabric-smart-client / 37199935160

91%

Build Type

push

github

Committed by web-flow

Commit Message

fix(fabric): read the network's client keepalive settings (#2034)

ClientKeepAliveConfig only enabled keepalive when keepalive.interval
was set, a key grpc.ClientKeepAliveConfig does not have. The documented
keys are time, timeout and permit-without-stream, so a node configured
as documented sent no keepalive pings, and a peer connection that died
without an error went unnoticed until the OS TCP keepalive gave up.

Both ClientKeepAliveConfig and ClientConnTimeout also checked for their
key at the configuration root while reading the value under
fabric.<network>, so a network's keepalive.connectionTimeout was
ignored as well. Both now look up fabric.<network>.keepalive.

Keepalive is enabled by a positive keepalive.time. Zero or omitted
disables it: grpc.WithKeepaliveParams would raise a zero time to 10s,
which Fabric peers and orderers reject as too many pings.

TestKeepAliveAccessors loads YAML through the real configuration
provider and covers the documented keys, a zero or missing time, and
connectionTimeout on its own. TestClientKeepAliveConfig_UnmarshalError
now sets a positive time and checks that the section is decoded.

docs/configuration.md documents keepalive.connectionTimeout, says that
zero or omitted time disables keepalive and that values below 10s are
raised to 10s, and warns that Fabric peers and orderers close
connections that ping more often than their minimum interval. The
environment variable example sets KEEPALIVE_TIME instead of
KEEPALIVE_TIMEOUT, which has no effect on its own.

Fixes #2033

Signed-off-by: Marcus Brandenburger <bur@zurich.ibm.com>

Coverage Stats

2 of 2 new or added lines in 1 file covered. (100.0%)

14 existing lines in 5 files now uncovered.

28959 of 31933 relevant lines covered (90.69%)

2786.97 hits per line