Azure / azure-sdk-for-cpp

This repository is for active development of the Azure SDK for C++. For consumers of the SDK we recommend visiting our versioned developer docs at https://azure.github.io/azure-sdk-for-cpp.
MIT License
177 stars 126 forks source link

Move `UserAgentGenerator` to `_internal` #6067

Closed antkmsft closed 4 weeks ago

antkmsft commented 1 month ago

Possible take on #6064. Fixes #6064.

We would release Core 1.14.1 the same day as EventHubs 1.0.0-beta.10, and they would go to the same vcpkg PR branch and merged into vcpkg together, so ther won;t be a moment when the build in vcpkg CI is broken. Timing-wise, we only have till November release the latest, and then there is no release in December, so I propose to release it on Thursday October 10th, partially out of band, at least after all the in-band releases on October 8th. It would still make it to the release notes for October.

ahsonkhan commented 1 month ago

Considering we have the existing patch, there isn't an end customer impact here to motivate an out of band Core release this month. Imo, we should consider it for the regular November release, rather than rush it out.

This will give us some time to discuss and finalize the design of an internal UserAgentGenerator class which all upstream SDKs will use. Currently, it isn't used by any upstream SDK that has GA'd (only eventhubs uses this atm, why don't others?).

I feel hesitant to ship that as GA this week without settling on how we want SDK authors to use it. It isn't urgent.

P.S. Ideally, we only GA things in core that are used by SDKs that also plan to GA around the same time, to avoid potential for design change or breaking change (this bar applies to any feature in core).

LarryOsterman commented 1 month ago

This will give us some time to discuss and finalize the design of an internal UserAgentGenerator class which all upstream SDKs will use. Currently, it isn't used by any upstream SDK that has GA'd (only eventhubs uses this atm, why don't others?).

Note that the only SDKs which would need to use this are those which are written to protocols other than HTTP. All HTTP based protocols MUST use the TelemetryPolicy.

That effectively means it's use is limited to EventHubs, ServiceBus and (possibly) EventGrid.

antkmsft commented 1 month ago

@ahsonkhan, November release should be fine too. If we are going to have more features to release as Beta first, we will have to cherry-pick the release then (or make two releases in November).

This will give us some time to discuss and finalize the design of an internal UserAgentGenerator class which all upstream SDKs will use.

This PR is a place to bring any issues then. If there are no PR comments/suggestions by the date of the release, and only the PR approvals, I'd consider it as finalized.

azure-sdk commented 1 month ago

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-core-cpp