Empty object produces an error when passed as document to oa-verify

[Neketek]

Hi, noticed that

//  Cannot read property 'issuers' of undefined
const result = await verify({});

will throw an error because some validators are unable to find issuers data inside the empty object. Prevention of this behavior requires double-checking when validating, and that's not good. I assume that it's better to handle missing keys and just return proper validation error instead of plain JS error.

[Nebulis]

Hi,

What do you mean by proper validation error? Do you expect us to throw an error with a message like "invalid document" or something else?

[Neketek]

@Nebulis I mean, that it's clearly a validator encountered the situation that it didn't expect, unexpected error, in other words. In this case an empty document. So, I think it will be logical if instead of failing to perform validation and interrupting the whole process it will simply return INVALID result with info pointing to the incorrect/unexpected document structure.

[Nebulis]

3 verifiers trigger an error when an empty object is passed down:

• OpenAttestationEthereumDocumentStoreStatus
• OpenAttestationDnsTxt
• OpenAttestationEthereumTokenRegistryStatus

For all those verifiers the error happens during the test function (which determines if a verifier should run or not)

The plan is to fix those test functions so that the verifiers doesn't run if issuers property (in that case) is not provided => the result for those verifiers will be skipped fragment.

On top of that OpenAttestationHash verifier currently return invalid while it shouldn't run because targethash/merkleroot/data are missing => the plan is to fix this behaviour so that the verifier is skipped in that case.

Also to make sure that verifiers test function handle correctly, we should provide a partial object (deeply)

[john-dot-oa]

🎉 This issue has been resolved in version 4.1.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀