JiPaix/xdccJS

View on GitHub
src/downloader.ts

Summary

Maintainability
C
1 day
Test Coverage

File downloader.ts has 269 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/* eslint-disable max-len */
/* eslint-disable no-param-reassign */
import * as fs from 'fs';
import * as net from 'net';
import { PassThrough } from 'stream';
Severity: Minor
Found in src/downloader.ts - About 2 hrs to fix

    Function prepareDL has 49 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      private prepareDL(downloadrequest: { fileInfo: FileInfo; candidate: Job }): void {
        const { fileInfo } = downloadrequest;
        const { candidate } = downloadrequest;
        const stream = this.setupStream(fileInfo);
        if (fileInfo.port === 0) {
    Severity: Minor
    Found in src/downloader.ts - About 1 hr to fix

      Function onError has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        private onError(args: Pass, e: Error): void {
          if (args.received === args.fileInfo.length) return;
      
          if (e.message === 'cancel') this.emit('debug', 'xdccJS:: TCP_CANCEL');
          else this.emit('debug', `xdccJS:: TCP_ERROR @ ${e.message}`);
      Severity: Minor
      Found in src/downloader.ts - About 1 hr to fix

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

          private processDL(
            server: net.Server | undefined,
            client: net.Socket,
            stream: fs.WriteStream | PassThrough,
            candidate: Job,
        Severity: Minor
        Found in src/downloader.ts - About 1 hr to fix

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

            private onError(args: Pass, e: Error): void {
              if (args.received === args.fileInfo.length) return;
          
              if (e.message === 'cancel') this.emit('debug', 'xdccJS:: TCP_CANCEL');
              else this.emit('debug', `xdccJS:: TCP_ERROR @ ${e.message}`);
          Severity: Minor
          Found in src/downloader.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 onData has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

            private onData(args: Pass, data: Buffer, sendBuffer: Buffer): void {
              if (args.received === 0) {
                args.candidate.timeout.clear();
                if (!this.path) {
                  args.candidate.emit('pipe', args.stream, args.fileInfo);
          Severity: Minor
          Found in src/downloader.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 setupStream has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Wontfix

            private setupStream(fileInfo: FileInfo): fs.WriteStream | PassThrough {
              if (this.path) {
                if (fileInfo.type === 'DCC ACCEPT') {
                  return fs.createWriteStream(fileInfo.filePath, {
                    flags: 'r+',
          Severity: Minor
          Found in src/downloader.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.
          Invalid

                disconnectAfter: {
                  stream: args.stream,
                  server: args.server,
                  socket: args.client,
                  pick: args.pick,
          Severity: Minor
          Found in src/downloader.ts and 1 other location - About 50 mins to fix
          src/downloader.ts on lines 234..240

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

          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

                disconnectAfter: {
                  stream: args.stream,
                  server: args.server,
                  socket: args.client,
                  pick: args.pick,
          Severity: Minor
          Found in src/downloader.ts and 1 other location - About 50 mins to fix
          src/downloader.ts on lines 205..211

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

          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