fix(src/plugins/utils/findOctetSequencePaths.js): Show path to erring…

[distortedsignal]

… element on exception

Recently, I ran across an issue where if the validator throws an
exception in a specific part of the code, the path to the
exception-causing code is swallowed.

After a moderate amount of digging, I decided that an
option for providing more information about this code
would be to put the path to the problematic element or
elements into the exception message. This exception
message is displayed whenever the code crashes out. So,
for example, the previous error message output by
lint-openapi was the following:

Validation Results for epic_tenant.json:

[Error] There was a problem with a validator.
Cannot read property 'type' of null

TypeError: Cannot read property 'type' of null
    at arrayOctetSequences (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:39:20)
    at findOctetSequencePaths (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:22:34)
    at /usr/local/lib/node_modules/ibm-openapi-validator/
                             src/plugins/utils/
                             findOctetSequencePaths.js:72:14
    at Array.forEach (<anonymous>)
    at objectOctetSequences (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:58:35)
    at findOctetSequencePaths (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:24:34)
    at /usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:72:14
    at Array.forEach (<anonymous>)
    at objectOctetSequences (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:58:35)
    at findOctetSequencePaths (/usr/local/lib/node_modules/
                             ibm-openapi-validator/src/
                             plugins/utils/
                             findOctetSequencePaths.js:24:34)

After this change, the output should be the following:

[Error] There was a problem with a validator.
items.type and items.format must resolve for the path "paths/my/datatype/path/etc/etc"

TypeError: Cannot read property 'type' of null
    at arrayOctetSequences (/usr/local/lib/node_modules/
                            ibm-openapi-validator/src/
                            plugins/utils/
                            findOctetSequencePaths.js:39:22)
    (same stack as above, I would rather not edit it again)

re #180

[distortedsignal]

Sorry about how the title on this PR got chowdered, but I tried to use git cz and that's what came out. I can change it if you (pl. "the repo-maintainers") would like.

[distortedsignal]

Hey @mkistler - the PR that I referenced in #180 should be here. Looking forward to your comments.

[distortedsignal]

Hey @dpopp07 @jorge-ibm and @mkistler - I know this probably isn't high on your priority list, but I do think this code would help out the community.

[jorge-ibm]

So all it looks like you're doing is enhancing the error handling in this scenario, which I think is fine. I'll let @mkistler @dpopp07 give their opinion on this, since they might have some other thoughts.

Thanks for the contribution!

[dpopp07]

Looks good! Thanks for the detailed tests for that module as well

[distortedsignal]

I figured being a good citizen meant bumping up the test coverage as well. Hope this project goes great in the future! I might have one more PR for the infinite recursion issue (#179).

[dpopp07]

🎉 This PR is included in version 0.31.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀