prebid/Prebid.js

View on GitHub
modules/sizeMappingV2.js

Summary

Maintainability
F
4 days
Test Coverage

File sizeMappingV2.js has 392 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 * This module adds support for the new size mapping spec, Advanced Size Mapping. It's documented here. https://github.com/prebid/Prebid.js/issues/4129
 * The implementation is an alternative to global sizeConfig. It introduces 'Ad Unit' & 'Bidder' level sizeConfigs and also supports 'labels' for conditional
 * rendering. Read full API documentation on Prebid.org, http://prebid.org/dev-docs/modules/sizeMappingV2.html
 */
Severity: Minor
Found in modules/sizeMappingV2.js - About 5 hrs to fix

    Function checkAdUnitSetupHook has 114 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function checkAdUnitSetupHook(adUnits) {
      const validateSizeConfig = function (mediaType, sizeConfig, adUnitCode) {
        let isValid = true;
        const associatedProperty = {
          banner: 'sizes',
    Severity: Major
    Found in modules/sizeMappingV2.js - About 4 hrs to fix

      Function setupAdUnitMediaTypes has 63 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export function setupAdUnitMediaTypes(adUnits, labels) {
        const duplCounter = {};
        return adUnits.reduce((result, adUnit) => {
          const instance = (() => {
            if (!duplCounter.hasOwnProperty(adUnit.code)) {
      Severity: Major
      Found in modules/sizeMappingV2.js - About 2 hrs to fix

        Function validateSizeConfig has 55 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          const validateSizeConfig = function (mediaType, sizeConfig, adUnitCode) {
            let isValid = true;
            const associatedProperty = {
              banner: 'sizes',
              video: 'playerSize',
        Severity: Major
        Found in modules/sizeMappingV2.js - About 2 hrs to fix

          Function getFilteredMediaTypes has 53 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          export function getFilteredMediaTypes(mediaTypes) {
            let
              activeViewportWidth,
              activeViewportHeight,
              transformedMediaTypes;
          Severity: Major
          Found in modules/sizeMappingV2.js - About 2 hrs to fix

            Function isLabelActivated has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
            Open

            export function isLabelActivated(bidOrAdUnit, activeLabels, adUnitCode, adUnitInstance) {
              let labelOperator;
              const labelsFound = Object.keys(bidOrAdUnit).filter(prop => prop === 'labelAny' || prop === 'labelAll');
              if (labelsFound && labelsFound.length > 1) {
                logWarn(`Size Mapping V2:: ${(bidOrAdUnit.code)
            Severity: Minor
            Found in modules/sizeMappingV2.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 getFilteredMediaTypes has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

            export function getFilteredMediaTypes(mediaTypes) {
              let
                activeViewportWidth,
                activeViewportHeight,
                transformedMediaTypes;
            Severity: Minor
            Found in modules/sizeMappingV2.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 bids has 36 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                      adUnit.bids = adUnit.bids.reduce((bids, bid) => {
                        if (internal.isLabelActivated(bid, labels, adUnit.code, instance)) {
                          if (bid.sizeConfig) {
                            const relevantMediaTypes = internal.getRelevantMediaTypesForBidder(bid.sizeConfig, activeViewport);
                            if (relevantMediaTypes.size === 0) {
            Severity: Minor
            Found in modules/sizeMappingV2.js - About 1 hr to fix

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

              export function isLabelActivated(bidOrAdUnit, activeLabels, adUnitCode, adUnitInstance) {
                let labelOperator;
                const labelsFound = Object.keys(bidOrAdUnit).filter(prop => prop === 'labelAny' || prop === 'labelAll');
                if (labelsFound && labelsFound.length > 1) {
                  logWarn(`Size Mapping V2:: ${(bidOrAdUnit.code)
              Severity: Minor
              Found in modules/sizeMappingV2.js - About 1 hr to fix

                Consider simplifying this complex logical expression.
                Open

                      if ((includes(keys, 'minViewPort') &&
                        includes(keys, 'relevantMediaTypes')) &&
                        isArrayOfNums(config.minViewPort, 2) &&
                        Array.isArray(config.relevantMediaTypes) &&
                        config.relevantMediaTypes.length > 0 &&
                Severity: Major
                Found in modules/sizeMappingV2.js - About 1 hr to fix

                  Avoid deeply nested control flow statements.
                  Open

                                if (bid.sizeConfig) {
                                  const relevantMediaTypes = internal.getRelevantMediaTypesForBidder(bid.sizeConfig, activeViewport);
                                  if (relevantMediaTypes.size === 0) {
                                    logError(`Size Mapping V2:: Ad Unit: ${adUnit.code}(${instance}), Bidder: ${bid.bidder} => 'sizeConfig' is not configured properly. This bidder won't be eligible for sizeConfig checks and will remain active.`);
                                    bids.push(bid);
                  Severity: Major
                  Found in modules/sizeMappingV2.js - About 45 mins to fix

                    Avoid too many return statements within this function.
                    Open

                        return bidOrAdUnit.labelAny.some(label => includes(activeLabels, label));
                    Severity: Major
                    Found in modules/sizeMappingV2.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                        return true;
                      Severity: Major
                      Found in modules/sizeMappingV2.js - About 30 mins to fix

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

                                if (!isBannerValid) {
                                  delete validatedBanner.mediaTypes.banner;
                                } else {
                                  /*
                                    Make sure 'sizes' field is always an array of arrays. If not, make it so.
                        Severity: Major
                        Found in modules/sizeMappingV2.js and 1 other location - About 2 hrs to fix
                        modules/sizeMappingV2.js on lines 193..205

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

                        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

                                if (!isVideoValid) {
                                  delete validatedVideo.mediaTypes.video.sizeConfig;
                                } else {
                                  /*
                                    Make sure 'playerSize' field is always an array of arrays. If not, make it so.
                        Severity: Major
                        Found in modules/sizeMappingV2.js and 1 other location - About 2 hrs to fix
                        modules/sizeMappingV2.js on lines 164..176

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

                        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

                          if (labelOperator === 'labelAll' && Array.isArray(bidOrAdUnit[labelOperator])) {
                            if (bidOrAdUnit.labelAll.length === 0) {
                              logWarn(`Size Mapping V2:: Ad Unit: ${bidOrAdUnit.code}(${adUnitInstance}) => Ad unit has declared property 'labelAll' with an empty array.`);
                              return true;
                            }
                        Severity: Major
                        Found in modules/sizeMappingV2.js and 1 other location - About 1 hr to fix
                        modules/sizeMappingV2.js on lines 304..310

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

                        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

                          } else if (labelOperator === 'labelAny' && Array.isArray(bidOrAdUnit[labelOperator])) {
                            if (bidOrAdUnit.labelAny.length === 0) {
                              logWarn(`Size Mapping V2:: Ad Unit: ${bidOrAdUnit.code}(${adUnitInstance}) => Ad unit has declared property 'labelAny' with an empty array.`);
                              return true;
                            }
                        Severity: Major
                        Found in modules/sizeMappingV2.js and 1 other location - About 1 hr to fix
                        modules/sizeMappingV2.js on lines 298..310

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

                        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