bookbrainz/bookbrainz-site

View on GitHub
src/server/helpers/revisions.ts

Summary

Maintainability
C
1 day
Test Coverage

Function getAssociatedEntityRevisions has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export async function getAssociatedEntityRevisions(revisions, orm) {
    const revisionIDs = revisions.map(({revisionId}) => revisionId);
    const RevisionModels = getRevisionModels(orm);
    const {Entity} = orm;
    for (let i = 0; i < RevisionModels.length; i++) {
Severity: Minor
Found in src/server/helpers/revisions.ts - About 1 hr to fix

    Function getAssociatedEntityRevisions has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    export async function getAssociatedEntityRevisions(revisions, orm) {
        const revisionIDs = revisions.map(({revisionId}) => revisionId);
        const RevisionModels = getRevisionModels(orm);
        const {Entity} = orm;
        for (let i = 0; i < RevisionModels.length; i++) {
    Severity: Minor
    Found in src/server/helpers/revisions.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 getOrderedRevisionsForEntityPage has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function getOrderedRevisionsForEntityPage(orm: any, from: number, size: number, RevisionModel, bbid: string) {
        const otherMergedBBIDs = await recursivelyGetMergedEntitiesBBIDs(orm, [bbid]);
    
        const revisions = await new RevisionModel()
            .query((qb) => {
    Severity: Minor
    Found in src/server/helpers/revisions.ts - About 1 hr to fix

      Function getOrderedRevisionForEditorPage has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export async function getOrderedRevisionForEditorPage(from, size, req) {
          const {Editor, Revision} = req.app.locals.orm;
      
          // If editor isn't present, throw an error
          await new Editor({id: req.params.id})
      Severity: Minor
      Found in src/server/helpers/revisions.ts - About 1 hr to fix

        Function getOrderedRevisionsForEntityPage has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        export async function getOrderedRevisionsForEntityPage(orm: any, from: number, size: number, RevisionModel, bbid: string) {
        Severity: Minor
        Found in src/server/helpers/revisions.ts - About 35 mins to fix

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

              const formattedRevisions = revisionsJSON.map(rev => {
                  delete rev.authorId;
                  const {author: editor, id: revisionId, ...otherProps} = rev;
                  return {editor, entities: [], revisionId, ...otherProps};
              });
          Severity: Major
          Found in src/server/helpers/revisions.ts and 1 other location - About 1 hr to fix
          src/server/helpers/revisions.ts on lines 120..124

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

          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

              const formattedRevisions = revisionsJSON.map(rev => {
                  delete rev.authorId;
                  const {author: editor, id: revisionId, ...otherProps} = rev;
                  return {editor, entities: [], revisionId, ...otherProps};
              });
          Severity: Major
          Found in src/server/helpers/revisions.ts and 1 other location - About 1 hr to fix
          src/server/helpers/revisions.ts on lines 168..172

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

          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