Chromium requires that all code that waits on a sync primitive be annotated with ScopedAllowBaseSyncPrimitives(ForTesting). Webrtc already imports ScopedAllowBaseSyncPrimitives. ScopedAllowBaseSyncPrimitivesForTesting is equivalent but can only be used in tests and doesn't required adding a friend declaration to thread_restrictions.h. Previously, the code that is annotated with ScopedAllowBaseSyncPrimitivesForTesting in this CL didn't fail because it ran on a TaskRunner annotated with the deprecated WithBaseSyncPrimitives() trait (cf. https://cs.chromium.org/chromium/src/content/renderer/media/webrtc/task_queue_factory_unittest.cc?l=23&rcl=362f3723ac358d932ea2e3af65512a1243697a31). Change-Id: Id7cfa2ea108870de86dc887458ae783c807791cc Bug: chromium:889029 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/128823 Commit-Queue: Francois Pierre Doray <fdoray@chromium.org> Reviewed-by: Tommi <tommi@webrtc.org> Cr-Commit-Position: refs/heads/master@{#27339}
How to write code in the api/ directory
Mostly, just follow the regular style guide, but:
- Note that
api/code is not exempt from the “.hand.ccfiles come in pairs” rule, so if you declare something inapi/path/to/foo.h, it should be defined inapi/path/to/foo.cc. - Headers in
api/should, if possible, not#includeheaders outsideapi/. It’s not always possible to avoid this, but be aware that it adds to a small mountain of technical debt that we’re trying to shrink. .ccfiles inapi/, on the other hand, are free to#includeheaders outsideapi/.
That is, the preferred way for api/ code to access non-api/ code is to call
it from a .cc file, so that users of our API headers won’t transitively
#include non-public headers.
For headers in api/ that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual rules still apply, though.
.cc files in api/ should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public
code, and just call it from the api/ .cc file.