fix(filecoin-proofs): add logging to all public API functions #1137
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tcharding
requested review from
cryptonemo,
dignifiedquire and
porcuquine
as code owners
vmx
previously approved these changes
Jun 3, 2020
|
@tcharding I don't seem to be able to reach you at the email on your profile, so I am opting for this sub-optimal channel. Can you please get on the Filecoin project matrix/slack and join the #fil-proofs channel to simplify any coordination around your contributions here? |
Can do, no worries. Re email; my bad I didn't check that account yesterday, its the correct account though (my personal one). |
porcuquine
previously approved these changes
Jun 18, 2020
From the issue description: "FFI exposed functions should log when called and right before they return." Add logging to all the public functions (excl. public trait implementations) within the `api` module. Closes: #650
porcuquine
approved these changes
Jun 18, 2020
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From the issue description: "FFI exposed functions should log when called and right before they return."
Add logging to all the public functions (excl. public trait implementations) within the
apimodule.This issue (#650) is a bit out of date, I've made the best of what I could understand given the description. If I've missed the mark feel free to say and I can do whatever is needed to fix it up. Thanks.
I elected to use a style with no newline between the final log statement and the return value to help make explicit that the log statement should remain at the end of the function. Also, I made some existing functions more uniform (some had ':end' instead of ':finish' in the log message).
When reviewing, please confirm that this does actually close #650.
Closes: #650