danielwippermann/resol-vbus

View on GitHub
src/tcp-data-source-provider.js

Summary

Maintainability
D
2 days
Test Coverage

Function sendBroadcast has 56 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    static async sendBroadcast(options) {
        options = applyDefaultOptions({}, options, {
            broadcastAddress: null,
            localAddress: null,
            netmask: null,
Severity: Major
Found in src/tcp-data-source-provider.js - About 2 hrs to fix

    Function sendBroadcastIPv6 has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        static async sendBroadcastIPv6(options) {
            options = applyDefaultOptions({}, options, {
                broadcastAddress: 'ff02::1',
                localAddress: null,
                broadcastInterface: null,
    Severity: Major
    Found in src/tcp-data-source-provider.js - About 2 hrs to fix

      File tcp-data-source-provider.js has 252 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      /*! resol-vbus | Copyright (c) 2013-present, Daniel Wippermann | MIT license */
      
      const dgram = require('dgram');
      const http = require('http');
      
      
      Severity: Minor
      Found in src/tcp-data-source-provider.js - About 2 hrs to fix

        Function fetchDeviceInformation has 48 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            static async fetchDeviceInformation(addressOrOptions, port) {
                if (port === undefined) {
                    try {
                        return await TcpDataSourceProvider.fetchDeviceInformation(addressOrOptions, 80);
                    } catch (err) {
        Severity: Minor
        Found in src/tcp-data-source-provider.js - About 1 hr to fix

          Function fetchDeviceInformation has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              static async fetchDeviceInformation(addressOrOptions, port) {
                  if (port === undefined) {
                      try {
                          return await TcpDataSourceProvider.fetchDeviceInformation(addressOrOptions, 80);
                      } catch (err) {
          Severity: Minor
          Found in src/tcp-data-source-provider.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

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

              static async discoverDevices(options) {
                  let promises;
                  if (options && (options.family === 'IPv6')) {
                      promises = await TcpDataSourceProvider.sendBroadcastIPv6(options);
                  } else {
          Severity: Minor
          Found in src/tcp-data-source-provider.js - 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

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

                      if ((rinfo.family === 'IPv6') && (rinfo.port === bcastPort) && (msg.length >= replyString.length)) {
                          const msgString = msg.slice(0, replyString.length).toString();
                          if (msgString === replyString) {
                              const { address } = rinfo;
                              if (addressList.indexOf(address) < 0) {
          Severity: Major
          Found in src/tcp-data-source-provider.js and 1 other location - About 2 hrs to fix
          src/tcp-data-source-provider.js on lines 265..273

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

          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

                      if ((rinfo.family === 'IPv4') && (rinfo.port === 7053) && (msg.length >= replyString.length)) {
                          const msgString = msg.slice(0, replyString.length).toString();
                          if (msgString === replyString) {
                              const { address } = rinfo;
                              if (addressList.indexOf(address) < 0) {
          Severity: Major
          Found in src/tcp-data-source-provider.js and 1 other location - About 2 hrs to fix
          src/tcp-data-source-provider.js on lines 175..183

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

          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

                  for (let tries = 0; tries < options.tries; tries++) {
                      const queryBuffer = Buffer.from(queryString);
                      socket.send(queryBuffer, 0, queryBuffer.length, bcastPort, bcastAddress);
          
                      await promisify(cb => setTimeout(cb, options.timeout));
          Severity: Major
          Found in src/tcp-data-source-provider.js and 1 other location - About 2 hrs to fix
          src/tcp-data-source-provider.js on lines 280..285

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

          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

                  for (let tries = 0; tries < options.tries; tries++) {
                      const queryBuffer = Buffer.from(queryString);
                      socket.send(queryBuffer, 0, queryBuffer.length, bcastPort, bcastAddress);
          
                      await promisify(cb => setTimeout(cb, options.timeout));
          Severity: Major
          Found in src/tcp-data-source-provider.js and 1 other location - About 2 hrs to fix
          src/tcp-data-source-provider.js on lines 191..196

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

          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