Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation of Private Filesystem and Other Cleanups #68

Merged
merged 14 commits into from
Oct 21, 2022
Merged

Documentation of Private Filesystem and Other Cleanups #68

merged 14 commits into from
Oct 21, 2022

Conversation

appcypher
Copy link
Member

@appcypher appcypher commented Oct 13, 2022 •
edited
Loading

Summary

This PR adds and updates existing documentation, doc tests and makes other API clean ups.

  • Add doc tests
  • Fix API snags like Rng/RngCore diffs
  • Update README
  • Update logo

Test plan (required)

  • Testing the Rust core.

    cargo test -p wnfs --release

  • Testing the wasm bindings.

    cd crates/wasm
    yarn playwright test

Closing issues

@codecov-commenter
Copy link

codecov-commenter commented Oct 13, 2022 •
edited by codecov bot
Loading

Codecov Report

Merging #68 (46570e3) into main (bbc977e) will decrease coverage by 2.20%.
The diff coverage is 51.92%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
- Coverage   66.55%   64.35%   -2.21%     
==========================================
  Files          23       24       +1     
  Lines        1540     1613      +73     
  Branches      392      416      +24     
==========================================
+ Hits         1025     1038      +13     
- Misses        174      212      +38     
- Partials      341      363      +22
Impacted Files Coverage Δ
crates/fs/common/blockstore.rs 38.46% <ø> (ø)
crates/fs/common/error.rs 0.00% <ø> (ø)
crates/fs/examples/private.rs 0.00% <0.00%> (ø)
crates/fs/examples/public.rs 0.00% <0.00%> (ø)
crates/fs/private/hamt/pointer.rs 50.87% <ø> (ø)
crates/fs/private/namefilter/namefilter.rs 100.00% <ø> (ø)
crates/fs/common/metadata.rs 67.56% <22.22%> (-11.75%) ⬇️
crates/fs/private/key.rs 58.33% <42.85%> (+0.43%) ⬆️
crates/fs/private/hamt/hamt.rs 48.57% <66.66%> (+0.65%) ⬆️
crates/fs/private/node.rs 70.55% <72.72%> (+2.13%) ⬆️
... and 15 more

zeeshanlakhani
zeeshanlakhani reviewed Oct 14, 2022
View reviewed changes
Copy link
Contributor

@zeeshanlakhani zeeshanlakhani left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

other than rebase and a few minor things, this looks great so far (and yep, need for doc tests is ace). Dope cleanup work. There's a bit more structure I want to do on pub fns w/ code comments, but that can be in another PR.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
crates/fs/README.md Outdated Show resolved Hide resolved
crates/fs/examples/private.rs Show resolved Hide resolved
@zeeshanlakhani zeeshanlakhani mentioned this pull request Oct 17, 2022
Closed
5 tasks
@appcypher appcypher self-assigned this Oct 17, 2022
@appcypher appcypher marked this pull request as ready for review October 19, 2022 14:21
@zeeshanlakhani
Copy link
Contributor

minor: @appcypher maybe we should make patch just informational vs threshold for project (related to codecov)

@appcypher
Copy link
Member Author

@zeeshanlakhani If I understand you correctly, you are suggesting removing the threshold for now?

@zeeshanlakhani
Copy link
Contributor

@appcypher yep, just for patch (not project)

@zeeshanlakhani zeeshanlakhani mentioned this pull request Oct 19, 2022
Merged
2 tasks
matheus23
matheus23 reviewed Oct 21, 2022
View reviewed changes
Copy link
Member

@matheus23 matheus23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small notes, wow, so many docs 👀 📚 ✨

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
crates/fs/README.md Outdated Show resolved Hide resolved
crates/fs/common/error.rs Outdated Show resolved Hide resolved
crates/fs/common/metadata.rs Outdated Show resolved Hide resolved
crates/fs/private/forest.rs Outdated Show resolved Hide resolved
crates/fs/private/forest.rs Outdated Show resolved Hide resolved
crates/fs/private/hamt/hash.rs Outdated Show resolved Hide resolved
@appcypher
Fix issues identified by @matheus23
46570e3 
- Minor semantic changes
- Making `Metadata`'s `created` and `modified` fields optional
- Add doc tests to `Metadata`
- Reinstate UNIX timestamp constraint in `Metadata`
@appcypher appcypher merged commit c88a0f8 into main Oct 21, 2022
@appcypher appcypher deleted the appcypher/document-private branch October 21, 2022 10:56
@appcypher appcypher restored the appcypher/document-private branch October 21, 2022 10:56
@appcypher appcypher deleted the appcypher/document-private branch October 21, 2022 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zeeshanlakhani zeeshanlakhani zeeshanlakhani approved these changes

@matheus23 matheus23 matheus23 approved these changes

Assignees

@appcypher appcypher

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@appcypher @codecov-commenter @zeeshanlakhani @matheus23