Sign upLogin

oaeproject/Hilary

View on GitHub
Star
packages/oae-activity/emailTemplates/mail.shared.js

Summary

Maintainability
C
1 day
Test Coverage
A
96%

Function getEmailSummary has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

const getEmailSummary = function (util, recipient, activities, baseUrl) {
  if (isEmail(recipient.id)) {
    // For an email invitation, we always use the subject invitation language, even for the
    // summary
    const actors = _getAllEntities(activities, 'actor');
Severity: Minor
Found in packages/oae-activity/emailTemplates/mail.shared.js - 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 getEmailSubject has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

const getEmailSubject = (util, recipient, activities) => {
  if (isEmail(recipient.id)) {
    // If this is an invitation to a user who doesn't have an account yet, we speak to them
    // a little bit differently because we have to legitimize our email quicker (i.e., in the
    // subject)
Severity: Minor
Found in packages/oae-activity/emailTemplates/mail.shared.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

Avoid too many return statements within this function.
Open

  return message;
Severity: Major
Found in packages/oae-activity/emailTemplates/mail.shared.js - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

        return '__MSG__ACTIVITY_EMAIL_SUMMARY_WEEKLY__';
    Severity: Major
    Found in packages/oae-activity/emailTemplates/mail.shared.js - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

          return '__MSG__ACTIVITY_EMAIL_SUMMARY_DAILY__';
      Severity: Major
      Found in packages/oae-activity/emailTemplates/mail.shared.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return '__MSG__ACTIVITY_EMAIL_SUMMARY_IMMEDIATE_MULTIPLE_ACTORS__';
        Severity: Major
        Found in packages/oae-activity/emailTemplates/mail.shared.js - About 30 mins to fix

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

              if (_.size(actors) === 2) {
      return util.i18n.translate('__MSG__ACTIVITY_EMAIL_SUBJECT_INVITE_ACTOR_2__', {
        actor1DisplayName: actors[0].displayName,
        actor2DisplayName: actors[1].displayName
      });
          Severity: Major
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 1 hr to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 66..71

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

          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

              if (_.size(actors) === 2) {
      return util.i18n.translate('__MSG__ACTIVITY_EMAIL_SUBJECT_INVITE_ACTOR_2__', {
        actor1DisplayName: actors[0].displayName,
        actor2DisplayName: actors[1].displayName
      });
          Severity: Major
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 1 hr to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 136..141

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

          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

              } else {
      const entityId = entity[ActivityConstants.properties.OAE_ID];
      if (!seenIds[entityId]) {
        seenIds[entityId] = true;
        entities.push(entity);
          Severity: Major
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 1 hr to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 208..214

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

          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

                _.each(entity[ActivityConstants.properties.OAE_COLLECTION], (entity) => {
        const entityId = entity[ActivityConstants.properties.OAE_ID];
        if (!seenIds[entityId]) {
          seenIds[entityId] = true;
          entities.push(entity);
          Severity: Major
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 1 hr to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 215..221

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

          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

              if (_.size(actors) === 1) {
      return util.i18n.translate('__MSG__ACTIVITY_EMAIL_SUBJECT_INVITE_ACTOR_1__', {
        actor1DisplayName: actors[0].displayName
      });
    }
          Severity: Minor
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 40 mins to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 60..64

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

          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

              if (_.size(actors) === 1) {
      return util.i18n.translate('__MSG__ACTIVITY_EMAIL_SUBJECT_INVITE_ACTOR_1__', {
        actor1DisplayName: actors[0].displayName
      });
    }
          Severity: Minor
          Found in packages/oae-activity/emailTemplates/mail.shared.js and 1 other location - About 40 mins to fix
          packages/oae-activity/emailTemplates/mail.shared.js on lines 130..134

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

          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