bcgov/common-object-management-service

View on GitHub
app/src/services/user.js

Summary

Maintainability
C
1 day
Test Coverage
B
87%

Function updateUser has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

  updateUser: async (userId, data, etrx = undefined) => {
    let trx;
    try {
      // Check if any user values have changed
      const oldUser = await service.readUser(userId);
Severity: Minor
Found in app/src/services/user.js - About 1 hr 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 createUser has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

  createUser: async (data, etrx = undefined) => {
    let trx;
    try {
      let response;
      trx = etrx ? etrx : await User.startTransaction();
Severity: Minor
Found in app/src/services/user.js - About 1 hr 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 createUser has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  createUser: async (data, etrx = undefined) => {
    let trx;
    try {
      let response;
      trx = etrx ? etrx : await User.startTransaction();
Severity: Minor
Found in app/src/services/user.js - About 1 hr to fix

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

      updateUser: async (userId, data, etrx = undefined) => {
        let trx;
        try {
          // Check if any user values have changed
          const oldUser = await service.readUser(userId);
    Severity: Minor
    Found in app/src/services/user.js - About 1 hr to fix

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

        createIdp: async (idp, etrx = undefined) => {
          let trx;
          try {
            trx = etrx ? etrx : await IdentityProvider.startTransaction();
      
      
      Severity: Minor
      Found in app/src/services/user.js - 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

      TODO found
      Open

              // TODO: add support for updating userId primary key in the event it changes
      Severity: Minor
      Found in app/src/services/user.js by fixme

      TODO found
      Open

          // TODO: Consider conditionally skipping when identityId is undefined?
      Severity: Minor
      Found in app/src/services/user.js by fixme

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

          return User.query()
            .modify('filterUserId', params.userId)
            .modify('filterIdentityId', params.identityId)
            .modify('filterIdp', params.idp)
            .modify('filterUsername', params.username)
      Severity: Major
      Found in app/src/services/user.js and 1 other location - About 1 hr to fix
      app/src/services/objectPermission.js on lines 144..148

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

      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

            const exists = await User.query(trx)
              .where({ 'identityId': data.identityId, idp: data.idp })
              .first();
      Severity: Minor
      Found in app/src/services/user.js and 1 other location - About 45 mins to fix
      app/src/services/user.js on lines 152..154

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

      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

            const oldUser = await User.query(trx)
              .where({ 'identityId': newUser.identityId, idp: newUser.idp })
              .first();
      Severity: Minor
      Found in app/src/services/user.js and 1 other location - About 45 mins to fix
      app/src/services/user.js on lines 76..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 50.

      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