fission-suite/webnative

View on GitHub
src/fs/root/tree.ts

Summary

Maintainability
D
2 days
Test Coverage

File tree.ts has 383 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import * as DagCBOR from "@ipld/dag-cbor"
import * as Uint8arrays from "uint8arrays"
import { CID } from "multiformats/cid"

import { BareNameFilter } from "../protocol/private/namefilter.js"
Severity: Minor
Found in src/fs/root/tree.ts - About 5 hrs to fix

    Function fromCID has 59 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      static async fromCID({ accountDID, dependencies, cid, permissions }: {
        accountDID: string
        dependencies: Dependencies
        cid: CID
        permissions?: Permissions
    Severity: Major
    Found in src/fs/root/tree.ts - About 2 hrs to fix

      Function fromCID has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

        static async fromCID({ accountDID, dependencies, cid, permissions }: {
          accountDID: string
          dependencies: Dependencies
          cid: CID
          permissions?: Permissions
      Severity: Minor
      Found in src/fs/root/tree.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 addPrivateLogEntry has 34 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        async addPrivateLogEntry(depot: Depot.Implementation, cid: CID): Promise<void> {
          const log = [ ...this.privateLog ]
          let idx = Math.max(0, log.length - 1)
      
          // get last chunk
      Severity: Minor
      Found in src/fs/root/tree.ts - About 1 hr to fix

        Function empty has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          static async empty({ accountDID, dependencies, rootKey, wnfsWasm }: {
            accountDID: string
            dependencies: Dependencies
            rootKey: Uint8Array
            wnfsWasm?: boolean
        Severity: Minor
        Found in src/fs/root/tree.ts - About 1 hr to fix

          Function findBareNameFilter has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

          async function findBareNameFilter(
            crypto: Crypto.Implementation,
            storage: Storage.Implementation,
            accountDID: string,
            map: Record<string, PrivateNode>,
          Severity: Minor
          Found in src/fs/root/tree.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 findBareNameFilter has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            crypto: Crypto.Implementation,
            storage: Storage.Implementation,
            accountDID: string,
            map: Record<string, PrivateNode>,
            path: DistinctivePath<Path.Segments>
          Severity: Minor
          Found in src/fs/root/tree.ts - About 35 mins to fix

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

              updateLink(name: string, result: Depot.PutResult): this {
                const { cid, size, isFile } = result
                this.links[ name ] = Link.make(name, cid, isFile, size)
                return this
              }
            Severity: Major
            Found in src/fs/root/tree.ts and 1 other location - About 2 hrs to fix
            src/fs/bare/tree.ts on lines 145..149

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

            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

            type Dependencies = {
              crypto: Crypto.Implementation
              depot: Depot.Implementation
              manners: Manners.Implementation
              reference: Reference.Implementation
            Severity: Major
            Found in src/fs/root/tree.ts and 1 other location - About 1 hr to fix
            src/fs/filesystem.ts on lines 48..54

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

            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

                this.updateLink(RootBranch.PrivateLog, {
                  cid: logCID,
                  isFile: false,
                  size: await this.dependencies.depot.size(logCID)
                })
            Severity: Minor
            Found in src/fs/root/tree.ts and 1 other location - About 45 mins to fix
            src/fs/root/tree.ts on lines 361..365

            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

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

                this.updateLink(RootBranch.Shared, {
                  cid: cid,
                  isFile: false,
                  size: await this.dependencies.depot.size(cid)
                })
            Severity: Minor
            Found in src/fs/root/tree.ts and 1 other location - About 45 mins to fix
            src/fs/root/tree.ts on lines 329..333

            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

              constructor({ dependencies, links, mmpt, privateLog, sharedCounter, sharedLinks, publicTree, prettyTree, privateNodes }: {
                dependencies: Dependencies
            
                links: SimpleLinks
                mmpt: MMPT
            Severity: Minor
            Found in src/fs/root/tree.ts and 1 other location - About 35 mins to fix
            src/fs/root/tree.ts on lines 224..237

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

            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 tree = new RootTree({
                  dependencies,
            
                  links,
                  mmpt,
            Severity: Minor
            Found in src/fs/root/tree.ts and 1 other location - About 35 mins to fix
            src/fs/root/tree.ts on lines 69..82

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

            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