Catering to malformed documents

[yehjxraymond]

Problem:

There is a test now that checks that the tests are skipped if the input is {}.

The problem is that in the test function, when we perform a getData, and TS shows the return type as WrappedDocument<v2.OpenAttestationDocument> not WrappedDocument<v2.OpenAttestationDocument> | undefined so it will be senseless to check for the malformed object in each and every of the verifier.

Here's some solutions, feel free to add more:

1. Perform the check at OA level in the getData function to ensure that the returned object is of the right shape or throw.
2. Perform the check BEFORE any verifications run to throw immediately instead of waiting for all the verifier to skip.
3. Remove the test. If the user fucks it up, it's none of our business.

[Nebulis]

The problem is that in the test function, when we perform a getData, and TS shows the return type as WrappedDocument<v2.OpenAttestationDocument> not WrappedDocument<v2.OpenAttestationDocument> | undefined so it will be senseless to check for the malformed object in each and every of the verifier.

To be more accurate the problem is the difference between the compile time and the runtime type.

• getData is correct: https://github.com/Open-Attestation/open-attestation/blob/master/src/utils/utils.ts#L9
• this is what expect a test function: https://github.com/Open-Attestation/oa-verify/blob/master/src/types/core.ts#L61 (a deeply partial wrapped document)

I'm for 2. for at least giving a good error message to the user (for 1. I don't think it concerns a lot getData to check more than the presence of the data field, but we could also throw an error from getData if there is no data field)