Sign upLogin

senecajs/seneca-refer

View on GitHub
Star

Showing 10 of 11 total issues

Function refer has a Cognitive Complexity of 61 (exceeds 5 allowed). Consider refactoring.
Open

function refer(this: any, options: ReferOptions) {
  const seneca: any = this

  const genToken = this.util.Nid(options.token)
  const genCode = this.util.Nid(options.code)
Severity: Minor
Found in src/refer.ts - About 1 day 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

File refer.ts has 396 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/* Copyright © 2022 Seneca Project Contributors, MIT License. */


type ReferOptions = {
  debug?: boolean
Severity: Minor
Found in src/refer.ts - About 5 hrs to fix

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

              if (rule.where.kind === 'accept') {
            rule.call.forEach((callmsg: any) => {
              callmsg.ent = seneca.entity(rule.ent)
              callmsg.entry_id = msg.q.entry_id
              callmsg.entry_kind = msg.q.entry_kind
    Severity: Major
    Found in src/refer.ts and 1 other location - About 3 hrs to fix
    src/refer.ts on lines 466..473

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

    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 (rule.where.kind === 'lost' && msg.q.kind === 'accept') {
            rule.call.forEach((callmsg: any) => {
              callmsg.ent = seneca.entity(rule.ent)
              callmsg.email = msg.q.email
              callmsg.userWinner = msg.q.user_id
    Severity: Major
    Found in src/refer.ts and 1 other location - About 3 hrs to fix
    src/refer.ts on lines 454..462

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

    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

    Function msgAcceptEntry has 82 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async function msgAcceptEntry(this: any, msg: any) {
    const seneca = this

    // If check=true, do not update occur
    let check = true === msg.check ? true : false
    Severity: Major
    Found in src/refer.ts - About 3 hrs to fix

      Function msgCreateEntry has 68 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        async function msgCreateEntry(this: any, msg: any) {
    const seneca = this

    // Sending user, not required
    let user_id = msg.user_id
      Severity: Major
      Found in src/refer.ts - About 2 hrs to fix

        Function msgLoadRules has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          async function msgLoadRules(this: any, msg: any) {
    const seneca = this

    const rules = await seneca.entity('refer/rule').list$()
        Severity: Minor
        Found in src/refer.ts - About 1 hr to fix

          Avoid too many return statements within this function.
          Open

                return {
        ok: false,
        why: 'entry-used',
      }
          Severity: Major
          Found in src/refer.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                  return {
        ok: false,
        why: 'entry-limit',
        details: {
          limit: entry.limit,
            Severity: Major
            Found in src/refer.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                  return {
      ok: true,
      entry,
      occur, // NOTE: will be undef if check=true
    }
              Severity: Major
              Found in src/refer.ts - About 30 mins to fix
                Severity
                Category
                Status
                Source
                Language