bcgov/common-object-management-service

View on GitHub
app/src/controllers/bucket.js

Summary

Maintainability
C
7 hrs
Test Coverage
D
60%

Function createBucketChild has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  async createBucketChild(req, res, next) {
    try {
      // Get Parent bucket data
      const parentBucketId = addDashesToUuid(req.params.bucketId);
      const parentBucket = await bucketService.read(parentBucketId);
Severity: Minor
Found in app/src/controllers/bucket.js - About 1 hr to fix

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

      _processS3Headers(s3Resp, res) {
        // TODO: Consider adding 'x-coms-public' and 'x-coms-path' headers into API spec?
        const exposedHeaders = [];
    
        if (s3Resp.ContentLength) res.set('Content-Length', s3Resp.ContentLength);
    Severity: Minor
    Found in app/src/controllers/bucket.js - About 1 hr to fix

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

        _processS3Headers(s3Resp, res) {
          // TODO: Consider adding 'x-coms-public' and 'x-coms-path' headers into API spec?
          const exposedHeaders = [];
      
          if (s3Resp.ContentLength) res.set('Content-Length', s3Resp.ContentLength);
      Severity: Minor
      Found in app/src/controllers/bucket.js - 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 createBucket has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

        async createBucket(req, res, next) {
          const data = {
            ...req.body,
            endpoint: stripDelimit(req.body.endpoint),
            key: req.body.key ? joinPath(stripDelimit(req.body.key)) : undefined
      Severity: Minor
      Found in app/src/controllers/bucket.js - 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

      TODO found
      Open

          // TODO: Consider adding 'x-coms-public' and 'x-coms-path' headers into API spec?
      Severity: Minor
      Found in app/src/controllers/bucket.js by fixme

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

            Object.entries(s3Resp.Metadata).forEach(([key, value]) => {
              const metadata = `x-amz-meta-${key}`;
              res.set(metadata, value);
              exposedHeaders.push(metadata);
            });
      Severity: Major
      Found in app/src/controllers/bucket.js and 1 other location - About 1 hr to fix
      app/src/controllers/object.js on lines 69..73

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

      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 6 locations. Consider refactoring.
      Open

          if (s3Resp.ServerSideEncryption) {
            const sse = 'x-amz-server-side-encryption';
            res.set(sse, s3Resp.ServerSideEncryption);
            exposedHeaders.push(sse);
          }
      Severity: Major
      Found in app/src/controllers/bucket.js and 5 other locations - About 30 mins to fix
      app/src/controllers/bucket.js on lines 41..45
      app/src/controllers/bucket.js on lines 61..65
      app/src/controllers/object.js on lines 62..66
      app/src/controllers/object.js on lines 76..80
      app/src/controllers/object.js on lines 81..85

      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

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

          if (s3Resp.VersionId) {
            const s3VersionId = 'x-amz-version-id';
            res.set(s3VersionId, s3Resp.VersionId);
            exposedHeaders.push(s3VersionId);
          }
      Severity: Major
      Found in app/src/controllers/bucket.js and 5 other locations - About 30 mins to fix
      app/src/controllers/bucket.js on lines 41..45
      app/src/controllers/bucket.js on lines 56..60
      app/src/controllers/object.js on lines 62..66
      app/src/controllers/object.js on lines 76..80
      app/src/controllers/object.js on lines 81..85

      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

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

          if (s3Resp.ETag) {
            const etag = 'ETag';
            res.set(etag, s3Resp.ETag);
            exposedHeaders.push(etag);
          }
      Severity: Major
      Found in app/src/controllers/bucket.js and 5 other locations - About 30 mins to fix
      app/src/controllers/bucket.js on lines 56..60
      app/src/controllers/bucket.js on lines 61..65
      app/src/controllers/object.js on lines 62..66
      app/src/controllers/object.js on lines 76..80
      app/src/controllers/object.js on lines 81..85

      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