johnsonjh/gfsmux

View on GitHub
stream.go

Summary

Maintainability
D
2 days
Test Coverage

File stream.go has 715 lines of code (exceeds 500 allowed). Consider refactoring.
Open

package gfsmux

import (
    "encoding/binary"
    "io"
Severity: Minor
Found in stream.go - About 7 hrs to fix

    Method Stream.writeV2 has 95 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func (
        s *Stream,
    ) writeV2(
        b []byte,
    ) (
    Severity: Major
    Found in stream.go - About 2 hrs to fix

      Stream has 23 methods (exceeds 20 allowed). Consider refactoring.
      Open

      type Stream struct {
          id   uint32
          sess *Session
      
          // slice heads kept for recycle
      Severity: Minor
      Found in stream.go - About 2 hrs to fix

        Method Stream.writeV2 has a Cognitive Complexity of 30 (exceeds 20 allowed). Consider refactoring.
        Open

        func (
            s *Stream,
        ) writeV2(
            b []byte,
        ) (
        Severity: Minor
        Found in stream.go - About 1 hr 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 Stream.writeTov2 has 55 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func (
            s *Stream,
        ) writeTov2(
            w io.Writer,
        ) (
        Severity: Minor
        Found in stream.go - About 1 hr to fix

          Method Stream.tryReadv2 has 51 lines of code (exceeds 50 allowed). Consider refactoring.
          Open

          func (
              s *Stream,
          ) tryReadv2(
              b []byte,
          ) (
          Severity: Minor
          Found in stream.go - About 1 hr to fix

            Method Stream.writeV2 has 9 return statements (exceeds 4 allowed).
            Open

            func (
                s *Stream,
            ) writeV2(
                b []byte,
            ) (
            Severity: Major
            Found in stream.go - About 55 mins to fix

              Method Stream.waitRead has 7 return statements (exceeds 4 allowed).
              Open

              func (
                  s *Stream,
              ) waitRead() error {
                  var timer *time.Timer
                  var deadline <-chan time.Time
              Severity: Major
              Found in stream.go - About 45 mins to fix

                Method Stream.tryReadv2 has 5 return statements (exceeds 4 allowed).
                Open

                func (
                    s *Stream,
                ) tryReadv2(
                    b []byte,
                ) (
                Severity: Major
                Found in stream.go - About 35 mins to fix

                  Method Stream.tryRead has 5 return statements (exceeds 4 allowed).
                  Open

                  func (
                      s *Stream,
                  ) tryRead(
                      b []byte,
                  ) (
                  Severity: Major
                  Found in stream.go - About 35 mins to fix

                    Method Stream.writeTov2 has a Cognitive Complexity of 22 (exceeds 20 allowed). Consider refactoring.
                    Open

                    func (
                        s *Stream,
                    ) writeTov2(
                        w io.Writer,
                    ) (
                    Severity: Minor
                    Found in stream.go - About 35 mins 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

                    BUG found
                    Open

                            // BUG(xtaci): Fix for https://github.com/xtaci/smux/issues/82 // XXX
                    Severity: Minor
                    Found in stream.go by fixme

                    XXX found
                    Open

                            // BUG(xtaci): Fix for https://github.com/xtaci/smux/issues/82 // XXX
                    Severity: Minor
                    Found in stream.go by fixme

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

                        if len(
                            s.buffers,
                        ) > 0 {
                            n = copy(
                                b,
                    Severity: Major
                    Found in stream.go and 1 other location - About 1 hr to fix
                    stream.go on lines 132..150

                    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 149.

                    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

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

                        if len(
                            s.buffers,
                        ) > 0 {
                            n = copy(
                                b,
                    Severity: Major
                    Found in stream.go and 1 other location - About 1 hr to fix
                    stream.go on lines 184..203

                    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 149.

                    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