feat: client identification headers #232
Draft
+68
−6
Conversation
This file contains 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
RikudouSage
reviewed
Jan 21, 2025
|
It's still a draft. I'm working on test coverage. |
Tymek
commented
Jan 21, 2025
Tymek
commented
Jan 22, 2025
| @@ -510,6 +513,7 @@ private function fetchFeatures(): array | |||
| } else { | |||
| $request = $this->requestFactory | |||
| ->createRequest('GET', (string) Url::appendPath($this->configuration->getUrl(), 'client/features')) | |||
| // TODO: remove non-standard headers | |||
There was a problem hiding this comment.
Maybe after some time, for example in a next major version
Tymek
commented
Jan 22, 2025
| @@ -54,7 +57,7 @@ public function register(iterable $strategyHandlers): bool | |||
| 'appName' => $this->configuration->getAppName(), | |||
| 'instanceId' => $this->configuration->getInstanceId(), | |||
| 'sdkVersion' => $this->sdkName . ':' . $this->sdkVersion, | |||
| 'strategies' => array_map(fn (StrategyHandler $strategyHandler): string => $strategyHandler->getStrategyName(), $strategyHandlers), | |||
| 'strategies' => array_map(fn(StrategyHandler $strategyHandler): string => $strategyHandler->getStrategyName(), $strategyHandlers), | |||
Tymek
commented
Jan 22, 2025
| @@ -69,6 +70,8 @@ final class UnleashBuilder | |||
|
|
|||
| private ?string $appName = null; | |||
|
|
|||
| private string $connectionId = Uuid::v4(); | |||
There was a problem hiding this comment.
I'm open to suggestions of there is a better way of having connectionId created only during initialization, and reuse it (alongside with SDK name and version) in both registration and getFeatures calls.
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.
Description
Identification headers consistent with other Unleash SDKs.
This PR adds standardized client identification headers to the feature and metrics calls that the client makes to Unleash. The headers are:
x-unleash-appname: the name of the application that is using the client.UNLEASH-APPNAMEwill be deleted in another PR (expand/contract pattern)x-unleash-connection-id: an internal unique identifier for the current instance of the client generated by the built-in crypto libx-unleash-sdk: sdk information in the formatunleash-client-<language>:<version>All the headers are intended for the Unleash team. Changes should be implemented in a way that does not change SDK behavior in a significant way.
The main use cases we have are:
Reference implementation (work in progress): Unleash/unleash-client-node#690
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: