feat: performance results file validation

[ShaswatPrabhat]

Validate performance results files input to compare package using zod

[changeset-bot]

🦋 Changeset detected

Latest commit: fa11aee

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
reassure	Minor
@callstack/reassure-cli	Minor
@callstack/reassure-compare	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[mdjastrzebski]

The code looks pretty good 👍🏻 I've added some comments about improving the code organisation a bit more.

I think we should also add some basic unit tests that would load a couple of hardcode performance files from disk and check that they match the expected output. The goal here is not not test Zod library, as it probably has it's own tests but rather to make sure that we are still able to run load typical performance results files. I would go with four input files: one with header, one without header, one with incorrect JSON, last one with duplicate entries.

[ShaswatPrabhat]

Have resolved all of the code feedback @mdjastrzebski .

Will get started on unit testing.

[ShaswatPrabhat]

@mdjastrzebski will it be a good idea to export loadFile from compare.ts and write tests against it then?

Not very keen on writing tests for the full compare method.

Another approach can be to write tests for the exported methods from validate.ts file.

Please suggest.

[mdjastrzebski]

@ShaswatPrabhat exporting loadFile from file is ok, just do not add it to index.ts exports so that the whole package does not export it.

Also pls do not make the test overly complicated, as simple test fields with/without header row and 2-3 entries should be enough. Then you can put assertions on metadata, total number of entries and values from 1-2 entries per file. In case of single failing test just check the error message.

BTW the code looks really good now, I've added some minor comments but I am very happy with the results 🚀

[ShaswatPrabhat]

Have added 2 basic snapshot tests based on jest and initial setup.

Please let me know if this is similar to what you have in mind @mdjastrzebski

As the errors and success are both too large hence have snapshotted them

[mdjastrzebski]

@ShaswatPrabhat Looks good, I plan on merging it tomorrow. Thank you for contributing this feature.

[mdjastrzebski]

Looks great! Thanks for contributing this feature @ShaswatPrabhat 🚀