Support partners in SDK by mgyucht · Pull Request #925 · databricks/databricks-sdk-go

mgyucht · 2024-05-17T14:44:21Z

Changes

Partners of Databricks need a mechanism to register themselves in libraries or applications that they write. In this way, requests made by users of those libraries will include sufficient information to link those requests to the original users.

This PR adds a new function WithPartner that can be used by a partner to add partner information to the User-Agent header for requests made by the SDK. The new header will have the form partner/<parther id>. The partner identifier is opaque for the SDK, but it must be alphanumeric.

This PR also lifts the requirement that there may only be a single copy of an entry in the user agent. This allows multiple partners to register themselves in the same library or application.

Tests

Unit tests for user agent were modified to support multiple entries for the same header key. A unit test is added to cover the WithProduct method.

make test passing
make fmt applied
relevant integration tests applied

codecov-commenter · 2024-05-28T11:52:28Z

Codecov Report

Attention: Patch coverage is 25.00000% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 7.12%. Comparing base (21acc0b) to head (c0b5eb3).
Report is 2 commits behind head on main.

Files	Patch %	Lines
examples/useragent/main.go	0.00%	9 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##            main    #925      +/-   ##
========================================
- Coverage   7.14%   7.12%   -0.03%     
========================================
  Files        281     282       +1     
  Lines      64475   64585     +110     
========================================
- Hits        4609    4602       -7     
- Misses     59558   59675     +117     
  Partials     308     308

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

## Changes This PR is a port of databricks/databricks-sdk-go#925 to the Java SDK. Partners of Databricks need a mechanism to register themselves in libraries or applications that they write. In this way, requests made by users of those libraries will include sufficient information to link those requests to the original users. This PR adds a new function `withPartner` that can be used by a partner to add partner information to the User-Agent header for requests made by the SDK. The new header will have the form `partner/<parther id>`. The partner identifier is opaque for the SDK, but it must be alphanumeric. This PR also lifts the requirement that there may only be a single copy of an entry in the user agent. This allows multiple partners to register themselves in the same library or application. Additionally, this PR adds validation on keys and values of entries in the user agent to match the Go SDK: alphanumeric keys and alphanumeric or semver values. ## Tests Unit tests cover the implementation of the `UserAgent` class.

## Changes Ports databricks/databricks-sdk-go#925 to the Python SDK. Partners of Databricks need a mechanism to register themselves in libraries or applications that they write. In this way, requests made by users of those libraries will include sufficient information to link those requests to the original users. This PR adds a new `useragent` module with functions to manipulate the user agent. * `product()`: returns the globally configured product & version. * `with_product(product: str, product_version: str)`: configure the global product & version. * `extra()`: returns the globally configured extra user agent metadata. * `with_extra(key: str, value: str)`: add an extra entry to the global extra user agent metadata. * `with_partner(partner: str)`: add a partner to the global extra user agent metadata. * `to_string(product_override: Optional[Tuple[str, str]]=None, other_info: Optional[List[Tuple[str, str]]] = None): str`: return the User-Agent header as a string. One new function here is `with_partner`, which can be used by a partner to add partner information to the User-Agent header for requests made by the SDK. The new header will have the form `partner/<parther id>`. The partner identifier is opaque for the SDK, but it must be alphanumeric. This PR also removes the requirement that a user agent entry contain only a single copy of each key. This allows multiple partners to register in the same library or application. In this PR, I've also refactored the user agent library to be more static, aligning it with the Go and Java SDKs. This makes it easier to maintain and ensures similar behavior between all 3 SDKs. Note that this SDK has extra functionality that doesn't exist in the Go and Java SDKs, namely config-level user agent info; that is preserved here. ## Tests Unit tests were added to verify that the user agent contains all expected parts and supports multiple partners. - [ ] `make test` run locally - [ ] `make fmt` applied - [ ] relevant integration tests applied

mgyucht added 4 commits May 17, 2024 10:25

partner integration

75722ff

Merge branch 'main' into partner-integration

d8939e1

work

ceac218

fix test

d19ee8c

This was referenced May 17, 2024

Support partners in SDK databricks/databricks-sdk-py#648

Merged

Support partners in SDK databricks/databricks-sdk-java#291

Merged

mgyucht requested a review from tanmay-db May 17, 2024 15:20

tanmay-db approved these changes May 17, 2024

View reviewed changes

docs

c0b5eb3

mgyucht added this pull request to the merge queue Jun 7, 2024

Merged via the queue into main with commit d098b1a Jun 7, 2024

mgyucht deleted the partner-integration branch June 7, 2024 15:05

hectorcast-db mentioned this pull request Jun 24, 2024

Release v0.43.0 #955

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support partners in SDK#925

Support partners in SDK#925
mgyucht merged 5 commits intomainfrom
partner-integration

mgyucht commented May 17, 2024 •

edited

Loading

Uh oh!

codecov-commenter commented May 28, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mgyucht commented May 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

codecov-commenter commented May 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mgyucht commented May 17, 2024 •

edited

Loading

codecov-commenter commented May 28, 2024 •

edited

Loading