meteor/meteor

View on GitHub
tools/isobuild/import-scanner.ts

Summary

Maintainability
F
1 wk
Test Coverage

File import-scanner.ts has 1234 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import assert from "assert";
import {inspect} from "util";
import {Script} from "vm";
import {
  isString, isObject, isEmpty, has, keys, each, omit,
Severity: Major
Found in tools/isobuild/import-scanner.ts - About 3 days to fix

    ImportScanner has 34 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export default class ImportScanner {
      public name: string;
    
      private bundleArch: string;
      private sourceRoot: string;
    Severity: Minor
    Found in tools/isobuild/import-scanner.ts - About 4 hrs to fix

      Function resolvePkgJsonBrowserAliases has 72 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        private resolvePkgJsonBrowserAliases(pkgFile: File) {
          if (! this.isWeb()) {
            return;
          }
      
      
      Severity: Major
      Found in tools/isobuild/import-scanner.ts - About 2 hrs to fix

        Function scanMissingModules has 69 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          scanMissingModules(missingModules: MissingMap) {
            assert.ok(missingModules);
            assert.ok(typeof missingModules === "object");
            assert.ok(! Array.isArray(missingModules));
        
        
        Severity: Major
        Found in tools/isobuild/import-scanner.ts - About 2 hrs to fix

          Function getSourceRootAbsModuleId has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
          Open

            private getSourceRootAbsModuleId(absPath: string) {
              const relPath = pathRelative(this.sourceRoot, absPath);
          
              if (relPath.startsWith("..")) {
                // absPath is not a subdirectory of this.sourceRoot.
          Severity: Minor
          Found in tools/isobuild/import-scanner.ts - 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 scanFile has 59 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            private scanFile(file: File, forDynamicImport = false) {
              if (file.imported === "static") {
                // If we've already scanned this file non-dynamically, then we don't
                // need to scan it again.
                return;
          Severity: Major
          Found in tools/isobuild/import-scanner.ts - About 2 hrs to fix

            Function combineFiles has 54 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              private combineFiles(oldFile: File, newFile: File) {
                const scanner = this;
            
                function checkProperty(name: "lazy" | "bare") {
                  if (has(oldFile, name)) {
            Severity: Major
            Found in tools/isobuild/import-scanner.ts - About 2 hrs to fix

              Function getSourcePath has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
              Open

                private getSourcePath(file: File) {
                  let sourcePath = file.sourcePath;
                  if (sourcePath) {
                    if (pathIsAbsolute(sourcePath)) {
                      let relPath: string | undefined;
              Severity: Minor
              Found in tools/isobuild/import-scanner.ts - 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 combineFiles has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
              Open

                private combineFiles(oldFile: File, newFile: File) {
                  const scanner = this;
              
                  function checkProperty(name: "lazy" | "bare") {
                    if (has(oldFile, name)) {
              Severity: Minor
              Found in tools/isobuild/import-scanner.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 checkSourceAndTargetPaths has 44 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                private checkSourceAndTargetPaths(file: File) {
                  file.sourcePath = this.getSourcePath(file);
              
                  if (! isString(file.targetPath)) {
                    return;
              Severity: Minor
              Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                Function onMissing has 43 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                  private onMissing(
                    parentFile: File,
                    id: string,
                    forDynamicImport = false,
                  ): Resolution | FileAlias {
                Severity: Minor
                Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

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

                    private getSourceRootAbsModuleId(absPath: string) {
                      const relPath = pathRelative(this.sourceRoot, absPath);
                  
                      if (relPath.startsWith("..")) {
                        // absPath is not a subdirectory of this.sourceRoot.
                  Severity: Minor
                  Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

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

                      private realPath(absPath: string) {
                        if (has(this.realPathCache, absPath)) {
                          return this.realPathCache[absPath];
                        }
                    
                    
                    Severity: Minor
                    Found in tools/isobuild/import-scanner.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 readModule has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                    Open

                      private readModule(absPath: string): RawFile | null {
                        const dotExt = pathExtname(absPath).toLowerCase();
                    
                        if (dotExt === ".node") {
                          const dataString = "throw new Error(" + JSON.stringify(
                    Severity: Minor
                    Found in tools/isobuild/import-scanner.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 readDepFile has 31 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                      private readDepFile(absPath: string): File | null {
                        const absModuleId = this.getAbsModuleId(absPath);
                        if (! absModuleId) {
                          // The given path cannot be installed on this architecture.
                          return null;
                    Severity: Minor
                    Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                      Function readModule has 31 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                        private readModule(absPath: string): RawFile | null {
                          const dotExt = pathExtname(absPath).toLowerCase();
                      
                          if (dotExt === ".node") {
                            const dataString = "throw new Error(" + JSON.stringify(
                      Severity: Minor
                      Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

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

                          private shouldUseNode(absModuleId: string, absPath: string) {
                            if (this.isWeb()) {
                              // Node should never be used in a browser, obviously.
                              return false;
                            }
                        Severity: Minor
                        Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                          Function realPath has 28 lines of code (exceeds 25 allowed). Consider refactoring.
                          Open

                            private realPath(absPath: string) {
                              if (has(this.realPathCache, absPath)) {
                                return this.realPathCache[absPath];
                              }
                          
                          
                          Severity: Minor
                          Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                            Function resolve has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                            Open

                              private resolve(
                                parentFile: File,
                                id: string,
                                forDynamicImport = false,
                              ): Resolution | FileAlias {
                            Severity: Minor
                            Found in tools/isobuild/import-scanner.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 shouldUseNode has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                            Open

                              private shouldUseNode(absModuleId: string, absPath: string) {
                                if (this.isWeb()) {
                                  // Node should never be used in a browser, obviously.
                                  return false;
                                }
                            Severity: Minor
                            Found in tools/isobuild/import-scanner.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 addPkgJsonToOutput has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                            Open

                              private addPkgJsonToOutput(
                                pkgJsonPath: string,
                                pkg: Record<string, any>,
                                forDynamicImport = false,
                              ): File {
                            Severity: Minor
                            Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                              Function resolve has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                              Open

                                private resolve(
                                  parentFile: File,
                                  id: string,
                                  forDynamicImport = false,
                                ): Resolution | FileAlias {
                              Severity: Minor
                              Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

                                Function constructor has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                                Open

                                  constructor({
                                    name,
                                    bundleArch,
                                    extensions,
                                    sourceRoot,
                                Severity: Minor
                                Found in tools/isobuild/import-scanner.ts - About 1 hr to fix

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

                                    private onMissing(
                                      parentFile: File,
                                      id: string,
                                      forDynamicImport = false,
                                    ): Resolution | FileAlias {
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.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 readDepFile has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                    private readDepFile(absPath: string): File | null {
                                      const absModuleId = this.getAbsModuleId(absPath);
                                      if (! absModuleId) {
                                        // The given path cannot be installed on this architecture.
                                        return null;
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.ts - About 45 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 scanFile has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                    private scanFile(file: File, forDynamicImport = false) {
                                      if (file.imported === "static") {
                                        // If we've already scanned this file non-dynamically, then we don't
                                        // need to scan it again.
                                        return;
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.ts - About 45 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 addFile has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                    private addFile(absPath: string, file: File): File | null {
                                      if (! file || file[fakeSymbol]) {
                                        // Return file without adding it to this.outputFiles.
                                        return file;
                                      }
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.ts - About 45 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 reifyCompileWithCache has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                  const reifyCompileWithCache = Profile("reifyCompileWithCache", wrap(function (
                                    source,
                                    _hash,
                                    bundleArch,
                                    cacheFilePath,
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.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

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

                                    private checkSourceAndTargetPaths(file: File) {
                                      file.sourcePath = this.getSourcePath(file);
                                  
                                      if (! isString(file.targetPath)) {
                                        return;
                                  Severity: Minor
                                  Found in tools/isobuild/import-scanner.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 tools/isobuild/import-scanner.ts - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                            return ensureLeadingSlash(relPath);
                                    Severity: Major
                                    Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                              return false;
                                      Severity: Major
                                      Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                            return null;
                                        Severity: Major
                                        Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                          Avoid too many return statements within this function.
                                          Open

                                              return this.realPathCache[absPath] = absPath;
                                          Severity: Major
                                          Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                            Avoid too many return statements within this function.
                                            Open

                                                return true;
                                            Severity: Major
                                            Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                              Avoid too many return statements within this function.
                                              Open

                                                      return;
                                              Severity: Major
                                              Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                                Avoid too many return statements within this function.
                                                Open

                                                    return ensureLeadingSlash(relPath);
                                                Severity: Major
                                                Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                                  Avoid too many return statements within this function.
                                                  Open

                                                            return;
                                                  Severity: Major
                                                  Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

                                                    Avoid too many return statements within this function.
                                                    Open

                                                              return;
                                                    Severity: Major
                                                    Found in tools/isobuild/import-scanner.ts - About 30 mins to fix

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

                                                          try {
                                                            var info = this.readFile(absPath);
                                                          } catch (e: any) {
                                                            if (e.code !== "ENOENT") throw e;
                                                            return null;
                                                      Severity: Minor
                                                      Found in tools/isobuild/import-scanner.ts and 1 other location - About 45 mins to fix
                                                      tools/isobuild/import-scanner.ts on lines 1215..1220

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

                                                      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

                                                          try {
                                                            var info = this.readFile(absPath);
                                                          } catch (e: any) {
                                                            if (e.code !== "ENOENT") throw e;
                                                            return null;
                                                      Severity: Minor
                                                      Found in tools/isobuild/import-scanner.ts and 1 other location - About 45 mins to fix
                                                      tools/isobuild/import-scanner.ts on lines 1258..1263

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

                                                      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