Skip to content

ARROW-2690: [Plasma] Use uniform function names in public APIs in Plasma. Add namespace around Flatbuffers#2242

Closed
wesm wants to merge 3 commits intoapache:masterfrom
wesm:ARROW-2690
Closed

ARROW-2690: [Plasma] Use uniform function names in public APIs in Plasma. Add namespace around Flatbuffers#2242
wesm wants to merge 3 commits intoapache:masterfrom
wesm:ARROW-2690

Conversation

@wesm
Copy link
Member

@wesm wesm commented Jul 10, 2018

I made a pass over Plasma to make the function names more uniform in the style; let me know your comments. It was a little bit painful.

I also wanted to be more explicit about what parts of the Flatbuffers protocol are leaking into the public API. Still flatbuffers/flatbuffers.h is leaking, but this is a step in containing things a bit.

Copy link
Member

Choose a reason for hiding this comment

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

When I was working with the IPC code, it was hard to distinguish between flabuffers and flatbuf.
Later You might consider to use a namespace which implies that it belongs to arrow (something like arrowfbs or whatever instead of flatbuf)

Copy link
Member Author

Choose a reason for hiding this comment

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

A fair point. I can make that change

Copy link
Member

Choose a reason for hiding this comment

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

ToFlatbuffer?

Copy link
Member

Choose a reason for hiding this comment

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

VerifyFlatbuffer?

wesm added 3 commits July 17, 2018 16:41
Change-Id: Iace9fd61a7d77922d2481ade7479752a7d509e45
Change-Id: Ib9c58487ab198b5f86d1176b8a66808a72fc571e
@wesm
Copy link
Member Author

wesm commented Jul 17, 2018

@pcmoritz @robertnishihara could you have a look at this? It's largely cosmetic but the public API for Plasma is impacted. Better to clean up sooner rather than later

How important is it to have details of the client wire protocol in the public API (do you need to get access to those headers in Ray)? Should we try to fix that?

@codecov-io
Copy link

Codecov Report

Merging #2242 into master will increase coverage by 2.38%.
The diff coverage is 95.7%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2242      +/-   ##
==========================================
+ Coverage   84.26%   86.65%   +2.38%     
==========================================
  Files         290      234      -56     
  Lines       44299    41558    -2741     
==========================================
- Hits        37330    36012    -1318     
+ Misses       6942     5546    -1396     
+ Partials       27        0      -27
Impacted Files Coverage Δ
cpp/src/plasma/eviction_policy.h 100% <ø> (ø) ⬆️
cpp/src/plasma/common.h 100% <ø> (ø) ⬆️
cpp/src/plasma/plasma.h 100% <ø> (ø) ⬆️
cpp/src/plasma/store.h 100% <ø> (ø) ⬆️
cpp/src/plasma/common.cc 90.32% <100%> (ø) ⬆️
cpp/src/plasma/plasma.cc 75.86% <100%> (ø) ⬆️
cpp/src/plasma/protocol.h 100% <100%> (ø) ⬆️
cpp/src/plasma/io.cc 74.61% <100%> (ø) ⬆️
cpp/src/plasma/protocol.cc 99.45% <100%> (ø) ⬆️
cpp/src/plasma/test/serialization_tests.cc 100% <100%> (ø) ⬆️
... and 61 more

Continue to review full report at Codecov.

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

@robertnishihara
Copy link
Contributor

This looks good to me, thanks for the cleanups!

@pcmoritz pcmoritz closed this in 5063b33 Jul 17, 2018
@robertnishihara
Copy link
Contributor

@wesm The wire protocol isn't exposed through the public API, is it?

@wesm wesm deleted the ARROW-2690 branch July 18, 2018 04:16
@wesm
Copy link
Member Author

wesm commented Jul 18, 2018

@robertnishihara It is exposed. Do you use the Flatbuffers APIs directly anywhere in Ray? Otherwise we should hide these symbols in the Plasma public headers and stop installing the generated Flatbuffers bindings

@pcmoritz
Copy link
Contributor

pcmoritz commented Jul 18, 2018

@wesm: At the moment we do but can get rid it! I can spend some time cleaning up the plasma code in this regard. Did you already create a JIRA, I couldn't find one?

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.

5 participants