Sign upLogin

erxes/erxes

View on GitHub
Star
api/src/db/models/Dashboard.ts

Summary

Maintainability
F
5 days
Test Coverage

Function loadDashBoardClass has 134 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const loadDashBoardClass = () => {
  class Dashboard {
    public static async getDashboard(_id: string) {
      const dashboard = await Dashboards.findOne({ _id });
Severity: Major
Found in api/src/db/models/Dashboard.ts - About 5 hrs to fix

    Function loadDashBoardClass has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
    Open

    export const loadDashBoardClass = () => {
  class Dashboard {
    public static async getDashboard(_id: string) {
      const dashboard = await Dashboards.findOne({ _id });
    Severity: Minor
    Found in api/src/db/models/Dashboard.ts - About 4 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 editDashboard has 50 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static async editDashboard(_id: string, doc: IDashboard) {
      const isUnique = await Dashboards.validateUniqueness({ _id }, doc.name);

      if (!isUnique) {
        throw new Error('Dashboard duplicated');
    Severity: Minor
    Found in api/src/db/models/Dashboard.ts - About 2 hrs to fix

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

      const setRelatedIds = async (dashboard: IDashboardDocument) => {
  if (dashboard.parentId) {
    const parentDashboard = await Dashboards.findOne({
      _id: dashboard.parentId
    });
      Severity: Minor
      Found in api/src/db/models/Dashboard.ts - 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

            if (dashboard && dashboard.order) {
        const childDashboards = await Dashboards.find({
          $and: [
            {
              order: { $regex: new RegExp(escapeRegExp(dashboard.order), 'i') }
      Severity: Major
      Found in api/src/db/models/Dashboard.ts and 1 other location - About 1 day to fix
      api/src/db/models/Tags.ts on lines 274..310

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

      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 removeRelatedIds = async (dashboard: IDashboardDocument) => {
  const dashboards = await Dashboards.find({
    relatedIds: { $in: dashboard._id }
  });
      Severity: Major
      Found in api/src/db/models/Dashboard.ts and 1 other location - About 1 day to fix
      api/src/db/models/Tags.ts on lines 48..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 292.

      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

          public static async generateOrder(
      parentDashboard: IDashboardDocument,
      { name }: { name: string }
    ) {
      const order = `${name}`;
      Severity: Major
      Found in api/src/db/models/Dashboard.ts and 1 other location - About 4 hrs to fix
      api/src/db/models/ProductTemplates.ts on lines 243..267

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

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

          public static async editDashboardItem(_id: string, feilds: IDashboard) {
      await DashboardItems.updateOne({ _id }, { $set: feilds });

      return DashboardItems.findOne({ _id });
    }
      Severity: Major
      Found in api/src/db/models/Dashboard.ts and 3 other locations - About 1 hr to fix
      api/src/db/models/Integrations.ts on lines 414..421
      engages-email-sender/src/models/SmsRequests.ts on lines 53..57
      integrations/src/telnyx/models.ts on lines 136..143

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

      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 5 locations. Consider refactoring.
      Open

          public static async getDashboard(_id: string) {
      const dashboard = await Dashboards.findOne({ _id });

      if (!dashboard) {
        throw new Error('Dashboard not found');
      Severity: Major
      Found in api/src/db/models/Dashboard.ts and 4 other locations - About 1 hr to fix
      api/src/db/models/Checklists.ts on lines 46..54
      api/src/db/models/MessengerApps.ts on lines 16..24
      api/src/db/models/Permissions.ts on lines 119..127
      api/src/db/models/Users.ts on lines 105..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 55.

      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