senecajs/seneca-s3-store

View on GitHub
src/s3-store.ts

Summary

Maintainability
B
4 hrs
Test Coverage

Function s3_store has 360 lines of code (exceeds 25 allowed). Consider refactoring.
Invalid

async function s3_store(this: any, options: any) {
  const seneca = this
  const init = seneca.export('entity/init')

  let generate_id = options.generate_id || seneca.export('entity/generate_id')
Severity: Major
Found in src/s3-store.ts - About 1 day to fix

    Function s3_store has a Cognitive Complexity of 67 (exceeds 5 allowed). Consider refactoring.
    Invalid

    async function s3_store(this: any, options: any) {
      const seneca = this
      const init = seneca.export('entity/init')
    
      let generate_id = options.generate_id || seneca.export('entity/generate_id')
    Severity: Minor
    Found in src/s3-store.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 s3-store.ts has 427 lines of code (exceeds 250 allowed). Consider refactoring.
    Invalid

    /* Copyright (c) 2020-2023 Richard Rodger, MIT License */
    
    import Path from 'path'
    import Fsp from 'fs/promises'
    
    
    Severity: Minor
    Found in src/s3-store.ts - About 6 hrs to fix

      Function load has 99 lines of code (exceeds 25 allowed). Consider refactoring.
      Invalid

          load: function (msg: any, reply: any) {
            let canon = msg.ent.entity$
            let qent = msg.qent
            let id = '' + msg.q.id
            let entSpec = options.ent[canon]
      Severity: Major
      Found in src/s3-store.ts - About 3 hrs to fix

        Function save has 74 lines of code (exceeds 25 allowed). Consider refactoring.
        Invalid

            save: function (msg: any, reply: any) {
              let canon = msg.ent.entity$
              let id = '' + (msg.ent.id || msg.ent.id$ || generate_id(msg.ent))
              let d = msg.ent.data$()
              d.id = id
        Severity: Major
        Found in src/s3-store.ts - About 2 hrs to fix

          Function remove has 34 lines of code (exceeds 25 allowed). Consider refactoring.
          Invalid

              remove: function (msg: any, reply: any) {
                let canon = (msg.ent || msg.qent).entity$
                let id = '' + msg.q.id
                let entSpec = options.ent[canon]
                let bin = entSpec?.bin || msg.bin$ || msg.q.bin$
          Severity: Minor
          Found in src/s3-store.ts - About 1 hr to fix

            Avoid deeply nested control flow statements.
            Invalid

                          if (keyPath.startsWith(prefix)) {
                            const event = {
                              Records: [
                                {
                                  s3: {
            Severity: Major
            Found in src/s3-store.ts - About 45 mins to fix

              Function make_s3id has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Invalid

              function make_s3id(id: string, ent: any, options: any, bin: boolean) {
                let s3id =
                  null == id
                    ? null
                    : (null == options.folder
              Severity: Minor
              Found in src/s3-store.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

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

                async function get_upload_url(msg: any) {
                  const bucket = msg.bucket
                  const filepath = msg.filepath
                  const expire = msg.expire
              
              
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 4 hrs to fix
              src/s3-store.ts on lines 447..465

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

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

                async function get_download_url(msg: any) {
                  const bucket = msg.bucket
                  const filepath = msg.filepath
                  const expire = msg.expire
              
              
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 4 hrs to fix
              src/s3-store.ts on lines 426..445

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

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

                      aws_s3
                        .send(s3cmd)
                        .then((_res: any) => {
                          reply()
                        })
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 2 hrs to fix
              src/s3-store.ts on lines 364..373

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

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

                      Fsp.unlink(full)
                        .then((_res: any) => {
                          reply()
                        })
                        .catch((err: any) => {
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 2 hrs to fix
              src/s3-store.ts on lines 380..391

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

              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

                        aws_s3
                          .send(s3cmd)
                          .then(() => {
                            replyEnt(null)
                          })
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 2 hrs to fix
              src/s3-store.ts on lines 277..286

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

              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

                        Fsp.stat(full)
                          .then(() => {
                            replyEnt(null)
                          })
                          .catch((err: any) => {
              Severity: Major
              Found in src/s3-store.ts and 1 other location - About 2 hrs to fix
              src/s3-store.ts on lines 309..320

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

              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