Extend C++ RecordingStream with global/thread_local/flush/save/connect APIs & introduce C++ SDK tests #2890
Conversation
This file contains hidden or 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
Wumpf
force-pushed
the
andreas/cpp-api/better-recording-stream
branch
from
07edbc1 to
6a4e00b
Compare
Member
|
The tests fail for me: Text version: |
Member
Author
|
uhoh. May or may not be file system delay. I left a comment in there that the test may be dangerous |
teh-cmc
approved these changes
Aug 2, 2023
Member
There was a problem hiding this comment.
There are a lot of expect() calls all over this module 😬
I know this was done so in the interest of development speed, but it feels like it's time to address this before it gets more complicated.
Most of those can probably be replaced by a simple error!(blabla); return void; kinda thing (and I guess we need a constant for RERUN_REC_STREAM_INIT_FAILED?)
Member
Author
There was a problem hiding this comment.
yeah I think we want a large error enum in the API. I'll do a follow-up with that!
Member
Author
There was a problem hiding this comment.
In what emil prototyped so far he added a log library to C++, but I find it less and less useful actually. I'd rather have everything return an error instead of relying on an extra library.
That's somewhat related to not leaking arrow stuff too much: C++ should get its own result type where we use our own "Rerun C++ error"-type
Wumpf
force-pushed
the
andreas/cpp-api/better-recording-stream
branch
from
6a4e00b to
dbe2724
Compare
teh-cmc
approved these changes
Aug 2, 2023
Member
teh-cmc
left a comment
teh-cmc
left a comment
There was a problem hiding this comment.
👍 Really like the new testing approach.
I do not like that we rely on fs metadata to compare file sizes though, but 🤷♂️
| THEN("after destruction, the second stream produced a bigger file") { | ||
| stream0.reset(); | ||
| stream1.reset(); | ||
| CHECK(fs::file_size(test_rrd0) < fs::file_size(test_rrd1)); |
Member
There was a problem hiding this comment.
Using file metadata is asking for flakiness imo
Wumpf
force-pushed
the
andreas/cpp-api/better-recording-stream
branch
from
c626ee7 to
6bdbd12
Compare
6 tasks
Wumpf
added a commit
that referenced
this pull request
Aug 3, 2023
* Fixes #2662 ### What * Runs clang-format to check for unformatted files * Builds and runs the minimal example * Builds and runs rerun_sdk tests Docker image script was in a broken state, fixed it and updated the image everywhere. Do not under any circumstances review commit per commit 😉 (srsly the history is messed up) TODO: * [x] check if overall ci goes green * [x] break both ci jobs on purpose (already did compile failures, try actual test failure instead * [x] fix it again (duh ;)) Future todo: * #2903 * todos from #2890 * cache C++ build results? ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/2901) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/2901) - [Docs preview](https://rerun.io/preview/pr%3Aandreas%2Fcpp%2Fci/docs) - [Examples preview](https://rerun.io/preview/pr%3Aandreas%2Fcpp%2Fci/examples)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
(SDK! Not codegen! :))
What
Adds a test dependency to the Catch2 testing framework in order to start testing all the new RecordingStream features added here.
C++ tests can be conveniently run via
./rerun_cpp/build_and_run_tests.shnow!For quick api overview start with the
rerun.handrecording_stream.hheaders.Fixes a range of compiler warnings as a consequence of improving some of the CMake setup, more to do there!
Adds lots more documentation to RecordingStream as well.
Next steps:
Checklist