Howard86/next-api-handler

View on GitHub

Showing 7 of 7 total issues

Function build has 63 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public build(): NextApiHandler {
    return async (req: NextApiRequest, res: NextApiResponse<ApiResponse>) => {
      const initiatedTime = Date.now();
      const routerMethod = (req.method || 'GET') as RouterMethod;

Severity: Major
Found in packages/next-api-handler/src/lib/router-builder.ts - About 2 hrs to fix

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

        return list.map(async (middleware) => {
          const middlewareValue = await middleware(req, res);
    
          if (middlewareValue) {
            for (const middlewareKey of Object.keys(middlewareValue)) {
    Severity: Major
    Found in packages/next-api-handler/src/lib/router-builder.ts and 1 other location - About 1 hr to fix
    packages/next-api-handler/src/lib/router-builder.ts on lines 333..341

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

    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

        for (const middleware of queue) {
          const middlewareValue = await middleware(req, res);
    
          if (middlewareValue) {
            for (const middlewareKey of Object.keys(middlewareValue)) {
    Severity: Major
    Found in packages/next-api-handler/src/lib/router-builder.ts and 1 other location - About 1 hr to fix
    packages/next-api-handler/src/lib/router-builder.ts on lines 304..312

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

    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

    Function logHandler has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      private logHandler(
        type: HandlerLogType,
        routerMethod: RouterMethod,
        url?: string,
        initiatedTime?: number,
    Severity: Minor
    Found in packages/next-api-handler/src/lib/router-builder.ts - About 1 hr to fix

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

        (showMessage: boolean): ApiErrorHandler =>
        /**
         * Handles the given `error` and sends an appropriate error response to the client.
         */
        (_req, res, error): void => {
      Severity: Minor
      Found in packages/next-api-handler/src/lib/error-handler.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 logHandler has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

        private logHandler(
          type: HandlerLogType,
          routerMethod: RouterMethod,
          url?: string,
          initiatedTime?: number,
      Severity: Minor
      Found in packages/next-api-handler/src/lib/router-builder.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 resolveMiddlewareQueue has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

        private async resolveMiddlewareQueue(
          method: MiddlewareRouterMethod,
          req: NextApiRequestWithMiddleware,
          res: NextApiResponse<ApiResponse>
        ): Promise<void> {
      Severity: Minor
      Found in packages/next-api-handler/src/lib/router-builder.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

      Severity
      Category
      Status
      Source
      Language