Sign upLogin

forattini-dev/s3db.js

View on GitHub
Star
src/cache/s3-cache.class.ts

Summary

Maintainability
B
5 hrs
Test Coverage

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

  async _get({ key }: { key: string }) {
    try {
      const res = await this.s3Client.getObject(key);

      if (!res.Body) return "";
Severity: Minor
Found in src/cache/s3-cache.class.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 _put has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  async _put({ key, data }: { key: string; data: any }) {
    const lengthRaw = isString(data)
      ? data.length
      : JSON.stringify(data).length;
Severity: Minor
Found in src/cache/s3-cache.class.ts - About 1 hr to fix

    Avoid too many return statements within this function.
    Open

        return null;
    Severity: Major
    Found in src/cache/s3-cache.class.ts - About 30 mins to fix

      Function _delete has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

        async _delete({ key }: { key: string }) {
    try {
      await this.s3Client.deleteObject(key);
    } catch (error) {
      if (error instanceof Error) {
      Severity: Minor
      Found in src/cache/s3-cache.class.ts - About 25 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.
      Open

        constructor({
    s3Client,
    compressData = true,
    serializer = Serializers.json,
  }: {
      Severity: Major
      Found in src/cache/s3-cache.class.ts and 1 other location - About 1 hr to fix
      src/cache/s3-resource-cache.class.ts on lines 8..24

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

      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 {
      const res = await this.s3Client.getObject(key);

      if (!res.Body) return "";
      let content = res.Body;
      Severity: Minor
      Found in src/cache/s3-cache.class.ts and 1 other location - About 30 mins to fix
      src/cache/s3-cache.class.ts on lines 135..143

      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

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

          try {
      await this.s3Client.deleteObject(key);
    } catch (error) {
      if (error instanceof Error) {
        if (error.name !== "ClientNoSuchKey") {
      Severity: Minor
      Found in src/cache/s3-cache.class.ts and 1 other location - About 30 mins to fix
      src/cache/s3-cache.class.ts on lines 103..129

      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