bcgov/common-object-management-service

View on GitHub
app/src/controllers/invite.js

Summary

Maintainability
D
2 days
Test Coverage
A
94%

Function createInvite has 91 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  async createInvite(req, res, next) {
    let resource, type;

    try {
      // Reject if expiresAt is more than 30 days away
Severity: Major
Found in app/src/controllers/invite.js - About 3 hrs to fix

    Function createInvite has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

      async createInvite(req, res, next) {
        let resource, type;
    
        try {
          // Reject if expiresAt is more than 30 days away
    Severity: Minor
    Found in app/src/controllers/invite.js - 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 useInvite has 55 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async useInvite(req, res, next) {
        const token = addDashesToUuid(req.params.token);
    
        try {
          const userId = await userService.getCurrentUserId(getCurrentIdentity(req.currentUser, SYSTEM_USER));
    Severity: Major
    Found in app/src/controllers/invite.js - About 2 hrs to fix

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

        async useInvite(req, res, next) {
          const token = addDashesToUuid(req.params.token);
      
          try {
            const userId = await userService.getCurrentUserId(getCurrentIdentity(req.currentUser, SYSTEM_USER));
      Severity: Minor
      Found in app/src/controllers/invite.js - 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

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

            } else if (invite.type === ResourceType.BUCKET) {
              // Check for object existence
              await bucketService.read(invite.resource).catch(() => {
                inviteService.delete(token);
                throw new Problem(409, {
      Severity: Major
      Found in app/src/controllers/invite.js and 1 other location - About 5 hrs to fix
      app/src/controllers/invite.js on lines 174..202

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

      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 (invite.type === ResourceType.OBJECT) {
              // Check for object existence
              await objectService.read(invite.resource).catch(() => {
                inviteService.delete(token);
                throw new Problem(409, {
      Severity: Major
      Found in app/src/controllers/invite.js and 1 other location - About 5 hrs to fix
      app/src/controllers/invite.js on lines 188..202

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

      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 (!bucketPermissions.length) {
                  throw new Problem(403, {
                    detail: `User lacks ${Permissions.MANAGE} permission for the bucket`,
                    instance: req.originalUrl,
                    bucketId: resource
      Severity: Minor
      Found in app/src/controllers/invite.js and 1 other location - About 30 mins to fix
      app/src/controllers/invite.js on lines 84..90

      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

                if (!objectPermissions.length && !bucketPermissions.length) {
                  throw new Problem(403, {
                    detail: `User lacks ${Permissions.MANAGE} permission for the object`,
                    instance: req.originalUrl,
                    objectId: resource
      Severity: Minor
      Found in app/src/controllers/invite.js and 1 other location - About 30 mins to fix
      app/src/controllers/invite.js on lines 107..113

      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