Make and Keep Swarm's Code Race Free

[frncmx]

Recently we found a data race in our code base and almost introduced a new one. We need an automated way to keep our code race free, but first we need to make it clean again.

Tasks

• Identify data races currently present in our code and create tasks for fixing them
• Fix all data races
• Create a CI job which ensures the code remains data race free - Create a separate CI job for race detection #741

Data Races

• Data race in swarm/network fetcher_test.go #1109 - fetcher_test.go
• Data race in swarm/network/stream stream.(*Peer) #1086 - swarm/network
• Data race in swarm/network/simulation tests #1110 - p2p/simulations - TestUpDownNodeIDs, TestStartStopNode, TestStartStopRandomNode, TestStartStopRandomNodes
• Data race in swarm/network.TestNetworkID() (kademlia, hive, pot) #1112 - kademlia - TestNetworkID
• Data race in swarm/network/protocol.go TestBzzHandshakeLightNode #1115 - protocol.go - TestBzzHandshakeLightNode
• Data races in PSS - (*Pss).deregister() vs (*Pss).executeHandlers() #1116 - pss deregister - TestProtocol, TestProxShortCircuit, TestSendRaw
• Data race in storage.(*mockNetFetcher).Request() #1117 - storage.(*mockNetFetcher).Request()
• Data race in storage.testLDBStoreCollectGarbage() #1118 - storage.testLDBStoreCollectGarbage()
• Data race in swarm.go #1154 - swarm.go
• Data races in PSS - TestProtocol #1157 - swarm/pss TestProtocol
• Data race in pss/notify tests #1158 - pss/notify tests
• Data race in Peer.Handshake() (p2p/protocols/protocol.go) #1160 - protocol.go Handshake
• Data race in swarm/network/stream #1197 - swarm/network/stream

[frncmx]

The following import paths contain data race:

FAIL	github.com/ethereum/go-ethereum/swarm	68.952s
FAIL	github.com/ethereum/go-ethereum/swarm/network	14.767s
FAIL	github.com/ethereum/go-ethereum/swarm/network/simulation	10.920s
FAIL	github.com/ethereum/go-ethereum/swarm/network/stream	600.060s
FAIL	github.com/ethereum/go-ethereum/swarm/pss	34.629s
FAIL	github.com/ethereum/go-ethereum/swarm/storage	217.360s

Note: The tests for storage may get stuck and time out.

How to reproduce?
go test -count 1 -race github.com/ethereum/go-ethereum/swarm...