danielwippermann/resol-vbus

View on GitHub
examples/json-live-data-server/index.js

Summary

Maintainability
F
5 days
Test Coverage

File index.js has 600 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*! resol-vbus | Copyright (c) 2013-present, Daniel Wippermann | MIT license */

const fs = require('fs');
const os = require('os');
const path = require('path');
Severity: Major
Found in examples/json-live-data-server/index.js - About 1 day to fix

    Function main has 148 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    async function main(options) {
        const { signal, onListen, onRunning } = (options || {});
    
        logger.debug('Starting server...');
    
    
    Severity: Major
    Found in examples/json-live-data-server/index.js - About 5 hrs to fix

      Function main has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
      Open

      async function main(options) {
          const { signal, onListen, onRunning } = (options || {});
      
          logger.debug('Starting server...');
      
      
      Severity: Minor
      Found in examples/json-live-data-server/index.js - About 3 hrs 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 generateDLxDownloadDownloadResponse has 44 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      async function generateDLxDownloadDownloadResponse(rawQuery) {
          const query = {
              source: rawQuery.source,
              outputType: rawQuery.outputType,
              dataLanguage: rawQuery.dataLanguage || 'en',
      Severity: Minor
      Found in examples/json-live-data-server/index.js - About 1 hr to fix

        Function generateEmSimulatorSensorResponse has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        async function generateEmSimulatorSensorResponse(requestParams, requestBody) {
            let { subAddress, sensorNr, sensorType } = requestParams;
        
            if (isNumberString(subAddress)) {
                subAddress = +subAddress;
        Severity: Minor
        Found in examples/json-live-data-server/index.js - About 1 hr to fix

          Function generateKM2WebserviceResponse has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

          async function generateKM2WebserviceResponse(requestBody) {
              const isBatchRequest = Array.isArray(requestBody);
              const requests = isBatchRequest ? requestBody : [ requestBody ];
              const replies = [];
              for (const request of requests) {
          Severity: Minor
          Found in examples/json-live-data-server/index.js - 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 generateKM2WebserviceResponse has 33 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          async function generateKM2WebserviceResponse(requestBody) {
              const isBatchRequest = Array.isArray(requestBody);
              const requests = isBatchRequest ? requestBody : [ requestBody ];
              const replies = [];
              for (const request of requests) {
          Severity: Minor
          Found in examples/json-live-data-server/index.js - About 1 hr to fix

            Function generateEmSimulatorSensorResponse has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

            async function generateEmSimulatorSensorResponse(requestParams, requestBody) {
                let { subAddress, sensorNr, sensorType } = requestParams;
            
                if (isNumberString(subAddress)) {
                    subAddress = +subAddress;
            Severity: Minor
            Found in examples/json-live-data-server/index.js - 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 processEmSimulatorPacket has 30 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            function processEmSimulatorPacket(connection, rxPacket) {
                if (((rxPacket.destinationAddress & 0xFFF0) === 0x6650) && (rxPacket.command === 0x0200) && (rxPacket.frameCount >= 10)) {
                    const subAddress = rxPacket.destinationAddress & 0x000F;
            
                    const state = emSimulatorStates.find(state => state.subAddress === subAddress);
            Severity: Minor
            Found in examples/json-live-data-server/index.js - About 1 hr to fix

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

              function processEmSimulatorPacket(connection, rxPacket) {
                  if (((rxPacket.destinationAddress & 0xFFF0) === 0x6650) && (rxPacket.command === 0x0200) && (rxPacket.frameCount >= 10)) {
                      const subAddress = rxPacket.destinationAddress & 0x000F;
              
                      const state = emSimulatorStates.find(state => state.subAddress === subAddress);
              Severity: Minor
              Found in examples/json-live-data-server/index.js - 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 generateEmSimulatorRelayResponse has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              async function generateEmSimulatorRelayResponse(requestParams) {
                  let { subAddress, relayNr } = requestParams;
              
                  if (isNumberString(subAddress)) {
                      subAddress = +subAddress;
              Severity: Minor
              Found in examples/json-live-data-server/index.js - About 1 hr to fix

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

                async function generateEmSimulatorRelayResponse(requestParams) {
                    let { subAddress, relayNr } = requestParams;
                
                    if (isNumberString(subAddress)) {
                        subAddress = +subAddress;
                Severity: Minor
                Found in examples/json-live-data-server/index.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 generateDLxDownloadDownloadResponse has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                async function generateDLxDownloadDownloadResponse(rawQuery) {
                    const query = {
                        source: rawQuery.source,
                        outputType: rawQuery.outputType,
                        dataLanguage: rawQuery.dataLanguage || 'en',
                Severity: Minor
                Found in examples/json-live-data-server/index.js - About 45 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

                        const onHeaderSet = async (headerSet) => {
                            const datecode = spec.i18n.moment(headerSet.timestamp).format('YYYYMMDD');
                            if (currentDatecode !== datecode) {
                                currentDatecode = datecode;
                
                
                Severity: Major
                Found in examples/json-live-data-server/index.js and 1 other location - About 1 day to fix
                examples/vbustouch-proxy/index.js on lines 611..638

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

                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

                    for (const iface of Object.values(os.networkInterfaces())) {
                        for (const ifaceConfig of iface) {
                            if (ifaceConfig.family === 'IPv4') {
                                logger.info('    - http://' + ifaceConfig.address + ':' + config.httpPort + '/api/v1/live-data' + (ifaceConfig.internal ? ' (internal)' : ''));
                            }
                Severity: Major
                Found in examples/json-live-data-server/index.js and 1 other location - About 3 hrs to fix
                examples/vbustouch-proxy/index.js on lines 424..430

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

                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

                    const onOutputConverterReadable = function() {
                        let chunk;
                        while ((chunk = outputConverter.read()) != null) {
                            chunks.push(chunk);
                        }
                Severity: Minor
                Found in examples/json-live-data-server/index.js and 1 other location - About 45 mins to fix
                examples/vbustouch-proxy/index.js on lines 296..301

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

                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