chore: data format snapshot tests

[appcypher]

This PR adds snapshot tests for the data format of WNFS.
The tests are identifiable by their encapsulating module, snapshot_tests.

This PR implements the following features

• Snapshot tests for wnfs data format

Test plan (required)

• Snapshot tests

  cargo install cargo-insta
  

  cargo insta test --check -- snapshot_tests    

• Testing

  scripts/rs-wnfs test

Closing issues

[appcypher]

Deciding to push exhaustive tree history snapshotting the to another PR.

[codecov]

Codecov Report

Merging #314 (fa14342) into main (380ee8c) will increase coverage by 1.22%.
The diff coverage is 65.21%.

@@            Coverage Diff             @@
##             main     #314      +/-   ##
==========================================
+ Coverage   56.33%   57.56%   +1.22%     
==========================================
  Files          43       45       +2     
  Lines        3172     3271      +99     
  Branches      770      806      +36     
==========================================
+ Hits         1787     1883      +96     
+ Misses        891      845      -46     
- Partials      494      543      +49     

Files Changed	Coverage Δ
wnfs-common/src/metadata.rs	17.64% <ø> (ø)
wnfs-common/src/utils/common.rs	61.53% <ø> (ø)
wnfs-hamt/src/hamt.rs	40.00% <ø> (+12.50%)	⬆️
wnfs-hamt/src/node.rs	50.00% <0.00%> (+3.33%)	⬆️
wnfs-hamt/src/pointer.rs	21.87% <ø> (+15.62%)	⬆️
wnfs-nameaccumulator/src/name.rs	81.06% <ø> (ø)
wnfs/src/private/directory.rs	68.86% <ø> (+0.42%)	⬆️
wnfs/src/private/forest/hamt.rs	49.52% <ø> (+4.76%)	⬆️
wnfs/src/private/node/keys.rs	78.94% <ø> (ø)
wnfs/src/private/node/serializable.rs	0.00% <ø> (ø)
... and 15 more

... and 1 file with indirect coverage changes

[matheus23]

Wasm tests error out weirdly:

error[E0433]: failed to resolve: use of undeclared crate or module `imp`
Error:   --> /Users/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/wait-timeout-0.2.0/src/lib.rs:66:9
   |
66 |         imp::wait_timeout(self, dur)
   |         ^^^ use of undeclared crate or module `imp`

For more information about this error, try `rustc --explain E0433`.
error: could not compile `wait-timeout` (lib) due to previous error
Error: warning: build failed, waiting for other jobs to finish...
❌ [compile] Failed with exit status 101

[appcypher]

The suggestions given by the nightly linter are incorrect and I'm not sure what is causing it.

[matheus23]

Hmm. Related to this? rust-lang/rust-clippy#11179

Nightly should be the latest latest clippy though, right? That issue seems to be fixed already. Is it a clippy regression?

[matheus23]

If we can't manage to fix the issue, can we add a bunch of allow annotations so we get rid of these errors?
Ideally as local as possible for exactly these parameters

[appcypher]

Or we could ignore the errors since it is likely going to fix itself in the future.
We don't want to sprinkle allows in the code for sth that isn't a real problem.

[matheus23]

Or we could ignore the errors since it is likely going to fix itself in the future.
We don't want to sprinkle allows in the code for sth that isn't a real problem.

Hmmm. As long as these directives are very local, I think they're not too bad.
I don't want us to get used to the ❌ on main. We'd have to check exactly which error it is in the logs everytime to make sure we're not ignoring some error that's more important.

If you think about it: In both cases we're ignoring errors. In one case we're ignoring them for the whole project, in the other we're ignoring them for only a couple of methods.
Perhaps we can set us a reminder to check back in a month to see if we can remove the allow annotations?

[appcypher]

needless_pass_by_mut_ref does not exist on stable yet.

[matheus23]

Ugh. That's so annoying

[matheus23]

Awesome stuff! Thanks so much.

There's some nits, some naming suggestions, one weird output, but I trust you with the rest :)