Sign upLogin

ipfs/ipfs-cluster

View on GitHub
Star
api/rest/restapi.go

Summary

Maintainability
D
1 day
Test Coverage

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

    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

      API has 23 methods (exceeds 20 allowed). Consider refactoring.
      Wontfix

      type API struct {
    *common.API

    rpcClient *rpc.Client
    config    *Config
      Severity: Minor
      Found in api/rest/restapi.go - About 2 hrs to fix

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

        func (api *API) allocationsHandler(w http.ResponseWriter, r *http.Request) {
    queryValues := r.URL.Query()
    filterStr := queryValues.Get("filter")
    var filter types.PinType
    for _, f := range strings.Split(filterStr, ",") {
        Severity: Minor
        Found in api/rest/restapi.go - About 55 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

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

        func (api *API) statusCidsHandler(w http.ResponseWriter, r *http.Request) {
    ctx, cancel := context.WithCancel(r.Context())
    defer cancel()

    queryValues := r.URL.Query()
        Severity: Minor
        Found in api/rest/restapi.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

        FIXME found
        Open

            // FIXME: This is a bit lazy, as "invalidxx,pinned" would result in a
        Severity: Minor
        Found in api/rest/restapi.go by fixme

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

        func NewAPIWithHost(ctx context.Context, cfg *Config, h host.Host) (*API, error) {
    api := API{
        config: cfg,
    }
    capi, err := common.NewAPIWithHost(ctx, &cfg.Config, h, api.routes)
        Severity: Minor
        Found in api/rest/restapi.go and 1 other location - About 35 mins to fix
        api/pinsvcapi/pinsvcapi.go on lines 132..139

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

        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