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.

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

feat: log errors at ffi boundary [WPB-14355] #861

Merged
merged 3 commits into from
Jan 20, 2025

Conversation

coriolinus
Copy link
Contributor

What's new in this PR

Adds a minor non-breaking feature which logs error messages just as they cross the FFI boundary.


PR Submission Checklist for internal contributors
  • The PR Title
    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

Copy link

github-actions bot commented Jan 17, 2025

🐰 Bencher Report

Branchprgn/feat/log-errors-at-ffi-boundary
Testbedubuntu-latest
Click to view all benchmark results
BenchmarkLatencymilliseconds (ms)
Commit add f(group size)/cs1/mem/1002📈 view plot
🚷 view threshold
17.47
Commit add f(group size)/cs1/mem/2📈 view plot
🚷 view threshold
6.74
Commit add f(group size)/cs1/mem/202📈 view plot
🚷 view threshold
9.01
Commit add f(group size)/cs1/mem/402📈 view plot
🚷 view threshold
10.76
Commit add f(group size)/cs1/mem/602📈 view plot
🚷 view threshold
13.82
Commit add f(group size)/cs1/mem/802📈 view plot
🚷 view threshold
15.43
Commit add f(number clients)/cs1/mem/1002📈 view plot
🚷 view threshold
921.16
Commit add f(number clients)/cs1/mem/2📈 view plot
🚷 view threshold
6.68
Commit add f(number clients)/cs1/mem/202📈 view plot
🚷 view threshold
80.98
Commit add f(number clients)/cs1/mem/402📈 view plot
🚷 view threshold
220.45
Commit add f(number clients)/cs1/mem/602📈 view plot
🚷 view threshold
405.05
Commit add f(number clients)/cs1/mem/802📈 view plot
🚷 view threshold
637.84
Commit pending proposals f(group size)/cs1/mem/1002📈 view plot
🚷 view threshold
115.84
Commit pending proposals f(group size)/cs1/mem/2📈 view plot
🚷 view threshold
26.59
Commit pending proposals f(group size)/cs1/mem/202📈 view plot
🚷 view threshold
44.00
Commit pending proposals f(group size)/cs1/mem/402📈 view plot
🚷 view threshold
56.79
Commit pending proposals f(group size)/cs1/mem/602📈 view plot
🚷 view threshold
79.37
Commit pending proposals f(group size)/cs1/mem/802📈 view plot
🚷 view threshold
93.04
Commit pending proposals f(pending size)/cs1/mem/1📈 view plot
🚷 view threshold
18.07
Commit pending proposals f(pending size)/cs1/mem/101📈 view plot
🚷 view threshold
107.58
Commit pending proposals f(pending size)/cs1/mem/21📈 view plot
🚷 view threshold
33.99
Commit pending proposals f(pending size)/cs1/mem/41📈 view plot
🚷 view threshold
55.29
Commit pending proposals f(pending size)/cs1/mem/61📈 view plot
🚷 view threshold
73.70
Commit pending proposals f(pending size)/cs1/mem/81📈 view plot
🚷 view threshold
89.65
Commit remove f(group size)/cs1/mem/1002📈 view plot
🚷 view threshold
26.69
Commit remove f(group size)/cs1/mem/2📈 view plot
🚷 view threshold
6.42
Commit remove f(group size)/cs1/mem/202📈 view plot
🚷 view threshold
8.31
Commit remove f(group size)/cs1/mem/402📈 view plot
🚷 view threshold
11.16
Commit remove f(group size)/cs1/mem/602📈 view plot
🚷 view threshold
15.82
Commit remove f(group size)/cs1/mem/802📈 view plot
🚷 view threshold
20.90
Commit remove f(number clients)/cs1/mem/1002📈 view plot
🚷 view threshold
29.14
Commit remove f(number clients)/cs1/mem/2📈 view plot
🚷 view threshold
129.48
Commit remove f(number clients)/cs1/mem/202📈 view plot
🚷 view threshold
109.33
Commit remove f(number clients)/cs1/mem/402📈 view plot
🚷 view threshold
85.88
Commit remove f(number clients)/cs1/mem/602📈 view plot
🚷 view threshold
65.63
Commit remove f(number clients)/cs1/mem/802📈 view plot
🚷 view threshold
46.26
Commit update f(group size)/cs1/mem/1002📈 view plot
🚷 view threshold
127.61
Commit update f(group size)/cs1/mem/2📈 view plot
🚷 view threshold
7.05
Commit update f(group size)/cs1/mem/202📈 view plot
🚷 view threshold
32.25
Commit update f(group size)/cs1/mem/402📈 view plot
🚷 view threshold
56.03
Commit update f(group size)/cs1/mem/602📈 view plot
🚷 view threshold
86.30
Commit update f(group size)/cs1/mem/802📈 view plot
🚷 view threshold
105.06
🐰 View full continuous benchmarking report in Bencher

@codecov-commenter
Copy link

codecov-commenter commented Jan 17, 2025

Codecov Report

Attention: Patch coverage is 97.29730% with 1 line in your changes missing coverage. Please review.

Project coverage is 76.20%. Comparing base (67a97da) to head (d5b496e).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
crypto-ffi/src/generic/mod.rs 97.29% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #861      +/-   ##
==========================================
+ Coverage   75.94%   76.20%   +0.26%     
==========================================
  Files         113      113              
  Lines       20651    20688      +37     
==========================================
+ Hits        15683    15766      +83     
+ Misses       4968     4922      -46     
Files with missing lines Coverage Δ
crypto-ffi/src/generic/mod.rs 7.46% <97.29%> (+5.31%) ⬆️

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 67a97da...d5b496e. Read the comment docs.

@coriolinus coriolinus marked this pull request as ready for review January 17, 2025 16:01
@coriolinus coriolinus requested a review from a team as a code owner January 17, 2025 16:01
We can't guarantee the method, format, consistency, or existence
of logging of core-crypto error messages in FFI code. So we take
the easy solution and generate a log message for every error
just before it crosses that boundary.
@coriolinus coriolinus force-pushed the prgn/feat/log-errors-at-ffi-boundary branch from 8664fec to d5b496e Compare January 20, 2025 13:37
@coriolinus coriolinus merged commit d5b496e into main Jan 20, 2025
27 checks passed
@coriolinus coriolinus deleted the prgn/feat/log-errors-at-ffi-boundary branch January 20, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants