Sign upLogin

vzakharchenko/keycloak-api-gateway

View on GitHub
Star
src/apigateway/ApiGateway.ts

Summary

Maintainability
A
2 hrs
Test Coverage

Function middleware has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Wontfix

  async middleware(request: RequestObject, response: ResponseObject, next?: any): Promise<void> {
    if (!this.options.logout) {
      throw new Error('LogoutObject is undefined');
    }
    if (!this.options.jwks) {
Severity: Minor
Found in src/apigateway/ApiGateway.ts - 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

Function middleware has 66 lines of code (exceeds 25 allowed). Consider refactoring.
Wontfix

  async middleware(request: RequestObject, response: ResponseObject, next?: any): Promise<void> {
    if (!this.options.logout) {
      throw new Error('LogoutObject is undefined');
    }
    if (!this.options.jwks) {
Severity: Major
Found in src/apigateway/ApiGateway.ts - About 2 hrs to fix

    Avoid too many return statements within this function.
    Open

            return;
    Severity: Major
    Found in src/apigateway/ApiGateway.ts - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

            return;
      Severity: Major
      Found in src/apigateway/ApiGateway.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                return;
        Severity: Major
        Found in src/apigateway/ApiGateway.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return;
          Severity: Major
          Found in src/apigateway/ApiGateway.ts - About 30 mins to fix

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

                  if (customPageHandler) {
        const sessionToken = getSessionToken(request.cookies[getSessionName(this.options)], true);
        await customPageHandler.execute(request, response, next, {sessionToken, options: this.options});
        return;
      }
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 1 other location - About 1 hr to fix
            src/apigateway/ApiGateway.ts on lines 94..99

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

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

                  if (customPageHandler) {
        const sessionToken = getSessionToken(request.cookies[getSessionName(this.options)], true);

        await customPageHandler.execute(request, response, next, {sessionToken, options: this.options});
        return;
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 1 other location - About 1 hr to fix
            src/apigateway/ApiGateway.ts on lines 108..112

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

            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 4 locations. Consider refactoring.
            Wontfix

                if (this.options.logout.isLogout(request)) {
      await this.options.logout.logout(request, response);
      return;
    }
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 3 other locations - About 35 mins to fix
            src/apigateway/ApiGateway.ts on lines 70..73
            src/apigateway/ApiGateway.ts on lines 74..78
            src/apigateway/ApiGateway.ts on lines 79..82

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

            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 4 locations. Consider refactoring.
            Wontfix

                if (this.options.jwks.isJwksRoute(request)) {
      await this.options.jwks.getPublicKey(request, response);
      return;
    }
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 3 other locations - About 35 mins to fix
            src/apigateway/ApiGateway.ts on lines 66..69
            src/apigateway/ApiGateway.ts on lines 74..78
            src/apigateway/ApiGateway.ts on lines 79..82

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

            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 4 locations. Consider refactoring.
            Wontfix

                if (this.options.callback.isCallBack(request)) {
      await this.options.callback.callback(request, response);
      return;
    }
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 3 other locations - About 35 mins to fix
            src/apigateway/ApiGateway.ts on lines 66..69
            src/apigateway/ApiGateway.ts on lines 70..73
            src/apigateway/ApiGateway.ts on lines 74..78

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

            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 4 locations. Consider refactoring.
            Wontfix

                if (this.options.callback.isCallBack(request)) {

      await this.options.callback.callback(request, response);
      return;
    }
            Severity: Major
            Found in src/apigateway/ApiGateway.ts and 3 other locations - About 35 mins to fix
            src/apigateway/ApiGateway.ts on lines 66..69
            src/apigateway/ApiGateway.ts on lines 70..73
            src/apigateway/ApiGateway.ts on lines 79..82

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

            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