waku-org/go-waku

View on GitHub
waku/v2/node/localnode.go

Summary

Maintainability
B
6 hrs
Test Coverage
C
74%

Method WakuNode.watchTopicShards has a Cognitive Complexity of 34 (exceeds 20 allowed). Consider refactoring.
Open

func (w *WakuNode) watchTopicShards(ctx context.Context) error {
    evtRelaySubscribed, err := w.Relay().Events().Subscribe(new(relay.EvtRelaySubscribed))
    if err != nil {
        return err
    }
Severity: Minor
Found in waku/v2/node/localnode.go - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method WakuNode.updateLocalNode has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

func (w *WakuNode) updateLocalNode(localnode *enode.LocalNode, multiaddrs []ma.Multiaddr, ipAddr *net.TCPAddr, udpPort uint, wakuFlags wenr.WakuEnrBitfield, advertiseAddr []ma.Multiaddr, shouldAutoUpdate bool) error {
Severity: Major
Found in waku/v2/node/localnode.go - About 50 mins to fix

    Function extractIPAddressForENR has 8 return statements (exceeds 4 allowed).
    Open

    func extractIPAddressForENR(addr ma.Multiaddr) (*net.TCPAddr, error) {
        // It's a p2p-circuit address. We shouldnt use these
        // for building the ENR record default keys
        _, err := addr.ValueForProtocol(ma.P_CIRCUIT)
        if err == nil {
    Severity: Major
    Found in waku/v2/node/localnode.go - About 50 mins to fix

      Method WakuNode.getENRAddresses has 5 return statements (exceeds 4 allowed).
      Open

      func (w *WakuNode) getENRAddresses(ctx context.Context, addrs []ma.Multiaddr) (extAddr *net.TCPAddr, multiaddr []ma.Multiaddr, err error) {
          extAddr, err = selectMostExternalAddress(addrs)
          if err != nil {
              return nil, nil, err
          }
      Severity: Major
      Found in waku/v2/node/localnode.go - About 35 mins to fix

        Function decapsulateCircuitRelayAddr has 5 return statements (exceeds 4 allowed).
        Open

        func decapsulateCircuitRelayAddr(ctx context.Context, addr ma.Multiaddr) (ma.Multiaddr, error) {
            _, err := addr.ValueForProtocol(ma.P_CIRCUIT)
            if err != nil {
                return nil, errors.New("not a circuit relay address")
            }
        Severity: Major
        Found in waku/v2/node/localnode.go - About 35 mins to fix

          Identical blocks of code found in 2 locations. Consider refactoring.
          Open

                      if ip4 == nil && ip6 != nil && !ip6.IsUnspecified() {
                          localnode.Set(enr.IPv6(ip6))
                          localnode.Set(enr.TCP6(ipAddr.Port))
                      } else {
                          localnode.Delete(enr.IPv6{})
          Severity: Minor
          Found in waku/v2/node/localnode.go and 1 other location - About 40 mins to fix
          waku/v2/protocol/enr/enr_test.go on lines 60..66

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 111.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          There are no issues that match your filters.

          Category
          Status