ipfs/ipfs-cluster

View on GitHub

Showing 105 of 124 total issues

Function main has 923 lines of code (exceeds 80 allowed). Consider refactoring.
Open

func main() {
    ctx := context.Background()

    app := cli.NewApp()
    app.Name = programName
Severity: Major
Found in cmd/ipfs-cluster-ctl/main.go - About 4 days to fix

    File cluster.go has 1596 lines of code (exceeds 500 allowed). Consider refactoring.
    Open

    package ipfscluster
    
    import (
        "context"
        "encoding/json"
    Severity: Major
    Found in cluster.go - About 3 days to fix

      Function main has a Cognitive Complexity of 125 (exceeds 15 allowed). Consider refactoring.
      Open

      func main() {
          ctx := context.Background()
      
          app := cli.NewApp()
          app.Name = programName
      Severity: Minor
      Found in cmd/ipfs-cluster-ctl/main.go - About 2 days 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

      Function main has 488 lines of code (exceeds 80 allowed). Consider refactoring.
      Open

      func main() {
          app := cli.NewApp()
          app.Name = programName
          app.Usage = "IPFS Cluster peer"
          app.Description = Description
      Severity: Major
      Found in cmd/ipfs-cluster-service/main.go - About 2 days to fix

        File main.go has 1111 lines of code (exceeds 500 allowed). Consider refactoring.
        Open

        // The ipfs-cluster-ctl application.
        package main
        
        import (
            "context"
        Severity: Major
        Found in cmd/ipfs-cluster-ctl/main.go - About 2 days to fix

          File ipfsproxy.go has 796 lines of code (exceeds 500 allowed). Consider refactoring.
          Open

          // Package ipfsproxy implements the Cluster API interface by providing an
          // IPFS HTTP interface as exposed by the go-ipfs daemon.
          //
          // In this API, select endpoints like pin*, add*, and repo* endpoints are used
          // to instead perform cluster operations. Requests for any other endpoints are
          Severity: Major
          Found in api/ipfsproxy/ipfsproxy.go - About 1 day to fix

            Cluster has 59 methods (exceeds 20 allowed). Consider refactoring.
            Open

            type Cluster struct {
                ctx    context.Context
                cancel func()
            
                id        peer.ID
            Severity: Major
            Found in cluster.go - About 1 day to fix

              File restapi.go has 748 lines of code (exceeds 500 allowed). Consider refactoring.
              Open

              // Package rest implements an IPFS Cluster API component. It provides
              // a REST-ish API to interact with Cluster.
              //
              // The implented API is based on the common.API component (refer to module
              // description there). The only thing this module does is to provide route
              Severity: Minor
              Found in api/rest/restapi.go - About 7 hrs to fix

                Function main has a Cognitive Complexity of 56 (exceeds 15 allowed). Consider refactoring.
                Open

                func main() {
                    app := cli.NewApp()
                    app.Name = programName
                    app.Usage = "IPFS Cluster peer"
                    app.Description = Description
                Severity: Minor
                Found in cmd/ipfs-cluster-service/main.go - About 7 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

                File api.go has 617 lines of code (exceeds 500 allowed). Consider refactoring.
                Open

                // Package common implements all the things that an IPFS Cluster API component
                // must do, except the actual routes that it handles.
                //
                // This is meant for re-use when implementing actual REST APIs by saving most
                // of the efforts and automatically getting a lot of the setup and things like
                Severity: Minor
                Found in api/common/api.go - About 4 hrs to fix

                  Method API.StreamResponse has a Cognitive Complexity of 40 (exceeds 15 allowed). Consider refactoring.
                  Open

                  func (api *API) StreamResponse(w http.ResponseWriter, next StreamIterator, errCh chan error) {
                      api.SetHeaders(w)
                      enc := json.NewEncoder(w)
                      flusher, flush := w.(http.Flusher)
                      w.Header().Set("Trailer", "X-Stream-Error")
                  Severity: Minor
                  Found in api/common/api.go - About 4 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 API.listPins has a Cognitive Complexity of 40 (exceeds 15 allowed). Consider refactoring.
                  Open

                  func (api *API) listPins(w http.ResponseWriter, r *http.Request) {
                      opts := &pinsvc.ListOptions{}
                      err := opts.FromQuery(r.URL.Query())
                      if err != nil {
                          api.SendResponse(w, common.SetStatusAutomatically, err, nil)
                  Severity: Minor
                  Found in api/pinsvcapi/pinsvcapi.go - About 4 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 Consensus.batchWorker has a Cognitive Complexity of 37 (exceeds 15 allowed). Consider refactoring.
                  Open

                  func (css *Consensus) batchWorker() {
                      defer close(css.batchingDone)
                  
                      maxSize := css.config.Batching.MaxBatchSize
                      maxAge := css.config.Batching.MaxBatchAge
                  Severity: Minor
                  Found in consensus/crdt/consensus.go - About 3 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

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

                  func defaultFunc(cfg *common.Config) error {
                      // http
                      addrs := make([]ma.Multiaddr, 0, len(DefaultHTTPListenAddrs))
                      for _, def := range DefaultHTTPListenAddrs {
                          httpListen, err := ma.NewMultiaddr(def)
                  Severity: Major
                  Found in api/rest/config.go and 1 other location - About 3 hrs to fix
                  api/pinsvcapi/config.go on lines 90..131

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

                  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

                  func defaultFunc(cfg *common.Config) error {
                      // http
                      addrs := make([]ma.Multiaddr, 0, len(DefaultHTTPListenAddrs))
                      for _, def := range DefaultHTTPListenAddrs {
                          httpListen, err := ma.NewMultiaddr(def)
                  Severity: Major
                  Found in api/pinsvcapi/config.go and 1 other location - About 3 hrs to fix
                  api/rest/config.go on lines 89..130

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

                  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

                  File consensus.go has 564 lines of code (exceeds 500 allowed). Consider refactoring.
                  Open

                  // Package crdt implements the IPFS Cluster consensus interface using
                  // CRDT-datastore to replicate the cluster global state to every peer.
                  package crdt
                  
                  import (
                  Severity: Minor
                  Found in consensus/crdt/consensus.go - About 3 hrs to fix

                    Method API.routes has 141 lines of code (exceeds 80 allowed). Consider refactoring.
                    Open

                    func (api *API) routes(c *rpc.Client) []common.Route {
                        api.rpcClient = c
                        return []common.Route{
                            {
                                Name:        "ID",
                    Severity: Major
                    Found in api/rest/restapi.go - About 3 hrs to fix

                      Function runCmd has 141 lines of code (exceeds 80 allowed). Consider refactoring.
                      Open

                      func runCmd(c *cli.Context) error {
                          clusterName := c.String(clusterNameFlag)
                      
                          if cfgURL := c.String("init"); cfgURL != "" {
                              err := initCluster(c, true, cfgURL)
                      Severity: Major
                      Found in cmd/ipfs-cluster-follow/commands.go - About 3 hrs to fix

                        Method dotWriter.print has a Cognitive Complexity of 33 (exceeds 15 allowed). Consider refactoring.
                        Open

                        func (dW *dotWriter) print() error {
                            dW.dotGraph.AddComment("The nodes of the connectivity graph")
                            dW.dotGraph.AddComment("The cluster-service peers")
                            // Write cluster nodes, use sorted order for consistent labels
                            sGraphCluster := dot.NewGraph("")
                        Severity: Minor
                        Found in cmd/ipfs-cluster-ctl/graph.go - About 3 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 PinOptions.FromQuery has a Cognitive Complexity of 32 (exceeds 15 allowed). Consider refactoring.
                        Open

                        func (po *PinOptions) FromQuery(q url.Values) error {
                            po.Name = q.Get("name")
                        
                            po.Mode = PinModeFromString(q.Get("mode"))
                        
                        
                        Severity: Minor
                        Found in api/types.go - About 3 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

                        Severity
                        Category
                        Status
                        Source
                        Language