feat: move client-side config headers to client-sdk #211
Conversation
|
This pull request has been linked to Shortcut Story #214574: Move client-side config bindings to dedicated folder. |
| #include <launchdarkly/bindings/c/context_builder.h> | ||
| #include <launchdarkly/client_side/bindings/c/config/builder.h> | ||
|
|
There was a problem hiding this comment.
This demonstrates the customer change necessary: append client_side to the left of /bindings.
| @@ -0,0 +1,487 @@ | |||
| /** @file */ | |||
There was a problem hiding this comment.
This is mostly moving the old builder.h to this new location. Log related config was removed and remains in common (<launchdarkly/bindings/c/config/logging_builder.h>)
| @@ -0,0 +1,27 @@ | |||
| /** @file */ | |||
There was a problem hiding this comment.
This is just moving the file from the old location.
| @@ -43,21 +45,21 @@ add_library(${LIBNAME} | |||
| flag_manager/flag_persistence.cpp | |||
| bindings/c/sdk.cpp) | |||
|
|
|||
| if(MSVC OR (NOT BUILD_SHARED_LIBS)) | |||
There was a problem hiding this comment.
Looks like this got auto formatted.
|
|
||
| // NOLINTEND modernize-use-using |
There was a problem hiding this comment.
Here are the messages.
| } | ||
| #endif | ||
|
|
||
| // NOLINTEND modernize-use-using |
| @@ -0,0 +1,134 @@ | |||
| /** @file */ | |||
| // NOLINTBEGIN modernize-use-using | |||
There was a problem hiding this comment.
This was extracted out of sdk.h. It can remain in common because it'll be shared by the client and server.
cwaldren-ld
force-pushed
the
cw/sc-214574/client-config-refactor
branch
from
f75aabd to
e545cec
Compare
cwaldren-ld
changed the title
cwaldren-ld
changed the title
This is the first in a series of PRs to re-organize the config related C bindings.
Why now?
We need the client and server SDKs to have different configs, because different options apply. At the same time, some config is sharable - such as loggers. The original 1.0 release of the client-side SDK mixed these concerns unintentionally.
This PR focuses on moving the client-side
LDClientConfigandLDClientConfigBuilderout ofcommonand intoclient-sdk.This should be backwards compatible enough for a minor release, with some callouts in the release notes. Although the header locations are moving, no symbol name or function/struct definition is changing.
For
config.h:sdk.h, we can change the path. Upgrade pain should be zero, unless a user has included it elsewhere in their application (withoutsdk.h.)For
builder.h:sdk.hdoesn't include theconfig_builder.h, people would have had to manually include it. Those builds will now break because the header has moved.To ease this transition, I've kept stub headers in the original locations which log messages using
#pragma message. They can't automatically include the new location headers because that'd introduce a circular dependency.Future work includes potentially renaming the sub-builders (such as
LDDataSourceStreamBuilder) to include theClientprefix (e.g.LDClientDataSourceStreamBuilder).We could achieve this with some typedefs + forwarding functions in a backwards compatible manner.
BEGIN_COMMIT_OVERRIDE
refactor: move client-side config headers to client_side/config
END_COMMIT_OVERRIDE