Sign upLogin

Workfront/workfront-api

View on GitHub
Star
src/Api.ts

Summary

Maintainability
F
3 days
Test Coverage

File Api.ts has 550 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 * Copyright 2015 Workfront
 *
 * Licensed under the Apache License, Version 2.0 (the "License")
 * you may not use this file except in compliance with the License.
Severity: Major
Found in src/Api.ts - About 1 day to fix

    Api has 27 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class Api {
    static Methods = {
        GET: 'GET',
        PUT: 'PUT',
        DELETE: 'DELETE',
    Severity: Minor
    Found in src/Api.ts - About 3 hrs to fix

      Function populateQueryStringAndBodyParams has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

          private populateQueryStringAndBodyParams(clonedParams, options) {
        let bodyParams = null,
            queryString = '',
            contentType = null
        if (typeof FormData !== 'undefined' && clonedParams instanceof FormData) {
      Severity: Minor
      Found in src/Api.ts - 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

      Function batchApiFactory has 49 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function batchApiFactory(api: Api): IBatchApi {
    const apiClone = Object.create(api) as Api
    apiClone._uriGenerationMode = true
    return {
        copy: (
      Severity: Minor
      Found in src/Api.ts - About 1 hr to fix

        Function populateQueryStringAndBodyParams has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private populateQueryStringAndBodyParams(clonedParams, options) {
        let bodyParams = null,
            queryString = '',
            contentType = null
        if (typeof FormData !== 'undefined' && clonedParams instanceof FormData) {
        Severity: Minor
        Found in src/Api.ts - About 1 hr to fix

          Function request has 30 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              request(
        path: string,
        params,
        fields: TFields = [],
        method: string = Api.Methods.GET
          Severity: Minor
          Found in src/Api.ts - About 1 hr to fix

            Function batch has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                batch(
        uriCollector: (batchApi: IBatchApi) => string[],
        isAtomic?: boolean,
        isConcurrent?: boolean
    ): Promise<any[] | void> {
            Severity: Minor
            Found in src/Api.ts - About 1 hr to fix

              Function success has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  success: (response) => {
        if (response.ok) {
            return response.json().then((data) => {
                if (data.error) {
                    throw {
              Severity: Minor
              Found in src/Api.ts - About 1 hr to fix

                Function getApiKey has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    getApiKey(username: string, password: string, subdomain?: string): Promise<string> {
        const loginParams = {
            username,
            password,
        }
                Severity: Minor
                Found in src/Api.ts - About 1 hr to fix

                  Function request has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                  Open

                      request(
        path: string,
        params,
        fields: TFields = [],
        method: string = Api.Methods.GET
                  Severity: Minor
                  Found in src/Api.ts - 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

                  Function constructor has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                  Open

                      constructor(config: IApiConfig) {
        this.serverAcceptsJSON = true
        this._uriGenerationMode = false
        this._httpOptions = {
            url: config.url,
                  Severity: Minor
                  Found in src/Api.ts - 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

                  Function get has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      get(objCode: string, objIDs: string | string[], fields?: TFields) {
        if (typeof objIDs === 'string') {
            objIDs = [objIDs]
        }
        let endPoint = objCode,
                  Severity: Minor
                  Found in src/Api.ts - About 25 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

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

                          if (useHttpPost) {
            reportQuery = {...query, method: Api.Methods.GET}
            method = Api.Methods.POST
        } else {
            reportQuery = query
                  Severity: Major
                  Found in src/Api.ts and 1 other location - About 1 hr to fix
                  src/Api.ts on lines 474..480

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

                  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

                          if (useHttpPost) {
            searchQuery = {...query, method: Api.Methods.GET}
            method = Api.Methods.POST
        } else {
            searchQuery = query
                  Severity: Major
                  Found in src/Api.ts and 1 other location - About 1 hr to fix
                  src/Api.ts on lines 400..406

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

                  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

                                      } else {
                        this._httpOptions.headers.apiKey = getApiKeyData.result
                        resolve(this._httpOptions.headers.apiKey)
                    }
                  Severity: Minor
                  Found in src/Api.ts and 1 other location - About 30 mins to fix
                  src/Api.ts on lines 124..127

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

                  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

                                          ;(req2 as Promise<any>).then((generateApiKeyData) => {
                            this._httpOptions.headers.apiKey = generateApiKeyData.result
                            resolve(this._httpOptions.headers.apiKey)
                        }, reject)
                  Severity: Minor
                  Found in src/Api.ts and 1 other location - About 30 mins to fix
                  src/Api.ts on lines 128..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 45.

                  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