Sign upLogin

sillygod/cdp-cache

View on GitHub
Star

Showing 20 of 20 total issues

Method Handler.UnmarshalCaddyfile has a Cognitive Complexity of 94 (exceeds 20 allowed). Consider refactoring.
Open

func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
    config := getDefaultConfig()

    for d.Next() {
Severity: Minor
Found in caddyfile.go - About 1 day 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

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

package influxlog

import "github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"

const (
Severity: Major
Found in extends/influxlog/Caddyfile.go and 1 other location - About 4 hrs to fix
extends/distributed/caddyfile.go on lines 1..73

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

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

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

package distributed

import (
    "github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
)
Severity: Major
Found in extends/distributed/caddyfile.go and 1 other location - About 4 hrs to fix
extends/influxlog/Caddyfile.go on lines 1..72

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

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

Method Handler.ServeHTTP has a Cognitive Complexity of 31 (exceeds 20 allowed). Consider refactoring.
Open

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
    // add a log here to record the elapsed time (from receiving the request to send the response)
    start := time.Now()
    upstreamDuration := time.Duration(0)
Severity: Minor
Found in handler.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 Handler.UnmarshalCaddyfile has 23 return statements (exceeds 4 allowed).
Open

func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
    config := getDefaultConfig()

    for d.Next() {
Severity: Major
Found in caddyfile.go - About 2 hrs to fix

    Method Handler.UnmarshalCaddyfile has 126 lines of code (exceeds 100 allowed). Consider refactoring.
    Open

    func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
    config := getDefaultConfig()

    for d.Next() {
    Severity: Major
    Found in caddyfile.go - About 2 hrs to fix

      Method Handler.ServeHTTP has 14 return statements (exceeds 4 allowed).
      Open

      func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
    // add a log here to record the elapsed time (from receiving the request to send the response)
    start := time.Now()
    upstreamDuration := time.Duration(0)
      Severity: Major
      Found in handler.go - About 1 hr to fix

        Function judgeResponseShouldCacheOrNot has 7 return statements (exceeds 4 allowed).
        Open

        func judgeResponseShouldCacheOrNot(req *http.Request,
    statusCode int,
    respHeaders http.Header,
    privateCache bool) ([]cacheobject.Reason, time.Time, []cacheobject.Warning, *cacheobject.Object, error) {
        Severity: Major
        Found in cache.go - About 45 mins to fix

          Function getCacheStatus has 7 return statements (exceeds 4 allowed).
          Open

          func getCacheStatus(req *http.Request, response *Response, config *Config) (bool, time.Time) {
    // NOTE: it seems that we can remove lock timeout
    if response.Code == http.StatusPartialContent || response.snapHeader.Get("Content-Range") != "" {
        return false, now().Add(config.LockTimeout)
    }
          Severity: Major
          Found in cache.go - About 45 mins to fix

            Method Storage.Delete has 5 return statements (exceeds 4 allowed).
            Open

            func (s *Storage) Delete(ctx context.Context, key string) error {
    kv, _, err := s.KV.Get(s.generateKey(key), &api.QueryOptions{RequireConsistent: true})
    if err != nil {
        return fmt.Errorf("unable to get data: %s, key: %s", err.Error(), s.generateKey(key))
    }
            Severity: Major
            Found in extends/storage/consul.go - About 35 mins to fix

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

                          case keyCacheMaxMemorySize:
                if len(args) != 1 {
                    return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyCacheMaxMemorySize))
                }
                num, err := strconv.Atoi(args[0])
              Severity: Minor
              Found in caddyfile.go and 1 other location - About 30 mins to fix
              caddyfile.go on lines 234..242

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

              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

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

                          case keyCacheBucketsNum:
                if len(args) != 1 {
                    return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyCacheBucketsNum))
                }
                num, err := strconv.Atoi(args[0])
              Severity: Minor
              Found in caddyfile.go and 1 other location - About 30 mins to fix
              caddyfile.go on lines 243..251

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

              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

              exported var LogUTCTimeFormat should have comment or be unexported
              Open

              var LogUTCTimeFormat = "2006/01/02 15:04:05"
              Severity: Minor
              Found in pkg/helper/helper.go by golint

              type name will be used as distributed.DistributedLock by other packages, and that stutters; consider calling this Lock
              Open

              type DistributedLock struct {
              Severity: Minor
              Found in extends/distributed/register.go by golint

              TODO found
              Open

                  // TODO: consider to do this in background worker
              Severity: Minor
              Found in extends/influxlog/influx.go by fixme

              TODO found
              Open

                  // TODO: think a proper way to log these info
              Severity: Minor
              Found in handler.go by fixme

              TODO found
              Open

                  // TODO: Is there anywhere to distinguish reload or shutdown
              Severity: Minor
              Found in extends/distributed/register.go by fixme

              TODO found
              Open

                  // TODO: to figure out why get context cancel here
              Severity: Minor
              Found in backends/memory.go by fixme

              TODO found
              Open

                  // TODO: Maybe we can redesign here to get a better performance
              Severity: Minor
              Found in cache.go by fixme

              TODO found
              Open

                  // TODO: how to handle when the bucket's num is changed
              Severity: Minor
              Found in cache.go by fixme
              Severity
              Category
              Status
              Source
              Language