Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
packages/cas-validate/src/validate.ts

Summary

Maintainability
C
1 day
Test Coverage

Function validate has 104 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function validate(options: CasOptions, ticket: string, callback: CasCallback, renew = false): void {
    if (!options.base_url) {
        throw new Error('Required CAS option `base_url` missing.');
    }
Severity: Major
Found in packages/cas-validate/src/validate.ts - About 4 hrs to fix

    Function parseRubyCasAttributes has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    function parseRubyCasAttributes(elemSuccess: Cheerio<any>, cheerio: CheerioAPI): Record<string, string[]> {
    // "RubyCAS Style" attributes
    //
    //    <cas:serviceResponse xmlns:cas='http://www.yale.edu/tp/cas'>
    //        <cas:authenticationSuccess>
    Severity: Minor
    Found in packages/cas-validate/src/validate.ts - 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 parseAttributes has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    function parseAttributes(elemSuccess: Cheerio<any>, cheerio: CheerioAPI): Record<string, string[]> {
    const elemAttribute = elemSuccess.find('cas\\:attributes').first();
    const isJasig = elemAttribute?.children().length > 0;
    const attributes = isJasig ? parseJasigAttributes(elemAttribute, cheerio) : parseRubyCasAttributes(elemSuccess, cheerio);
    Severity: Minor
    Found in packages/cas-validate/src/validate.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

    Function parseJasigAttributes has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    function parseJasigAttributes(elemAttribute: Cheerio<any>, cheerio: CheerioAPI): Record<string, string[]> {
    // "Jasig Style" Attributes:
    //
    //  <cas:serviceResponse xmlns:cas='http://www.yale.edu/tp/cas'>
    //      <cas:authenticationSuccess>
    Severity: Minor
    Found in packages/cas-validate/src/validate.ts - About 35 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

    Avoid too many return statements within this function.
    Open

                        return;
    Severity: Major
    Found in packages/cas-validate/src/validate.ts - About 30 mins to fix

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

      export function validate(options: CasOptions, ticket: string, callback: CasCallback, renew = false): void {
    if (!options.base_url) {
        throw new Error('Required CAS option `base_url` missing.');
    }
      Severity: Minor
      Found in packages/cas-validate/src/validate.ts - 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

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

                          if (!attributes[attrName]) {
                        attributes[attrName] = [attrValue];
                    } else {
                        attributes[attrName].push(attrValue);
                    }
      Severity: Minor
      Found in packages/cas-validate/src/validate.ts and 2 other locations - About 30 mins to fix
      packages/cas-validate/src/validate.ts on lines 49..53
      packages/cas-validate/src/validate.ts on lines 141..145

      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

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

                  if (!attributes[attrName]) {
                attributes[attrName] = [attrValue];
            } else {
                attributes[attrName].push(attrValue);
            }
      Severity: Minor
      Found in packages/cas-validate/src/validate.ts and 2 other locations - About 30 mins to fix
      packages/cas-validate/src/validate.ts on lines 49..53
      packages/cas-validate/src/validate.ts on lines 92..96

      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

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

                  if (!attributes[attrName]) {
                attributes[attrName] = [attrValue];
            } else {
                attributes[attrName].push(attrValue);
            }
      Severity: Minor
      Found in packages/cas-validate/src/validate.ts and 2 other locations - About 30 mins to fix
      packages/cas-validate/src/validate.ts on lines 92..96
      packages/cas-validate/src/validate.ts on lines 141..145

      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