Fix null body response to empty in ApiClient #579

tanmay-db · 2024-03-07T13:57:42Z

Changes

Some delete end points return null instead of empty body, we fix that in SDK Client since the APIs are not available publicly and support isn't available for them yet.

Tests

Thanks to @sodle-splunk for contributing the unit test (#641)

make test run locally
make fmt applied
relevant integration tests applied

mgyucht

Test?

codecov-commenter · 2024-03-07T14:00:00Z

Codecov Report

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

Project coverage is 57.62%. Comparing base (e10bd59) to head (057bf5a).

Files	Patch %	Lines
databricks/sdk/core.py	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #579      +/-   ##
==========================================
+ Coverage   57.61%   57.62%   +0.01%     
==========================================
  Files          47       47              
  Lines       32648    32650       +2     
==========================================
+ Hits        18810    18815       +5     
+ Misses      13838    13835       -3

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

tanmay-db · 2024-03-07T14:05:59Z

Test?

@mgyucht, I have asked on slack for confirmation on the fix, since the API is private, we might need to enable it for our test infra and then repro this, it would be some work, once confirmed I will add unit test. Me and @edwardfeng-db are working on other issues in the meantime parallelly.

…ix-ucx

github-actions · 2024-05-15T13:27:02Z

This PR breaks backwards compatibility for databrickslabs/blueprint downstream. See build logs for more details.

_{Running from downstreams #108}

tanmay-db · 2024-05-15T13:45:11Z

Note: The failing test: downstreams / compatibility (blueprint, databrickslabs) (pull_request) fails on a simple text change: #643. This passed on last commit which was 2 weeks ago and doesn't seem to be happening due to changes in Python SDK.

nkvuong · 2024-05-15T14:27:49Z

the failed check is not related to this change, the same test is failing on blueprint/main

sodle-splunk

Thanks all for quick response and feedback on this one. This bug is one of our final blockers to shipping a new integration. 🥳

* Fix null body response to empty in ApiClient ([#579](#579)). API Changes: * Changed `list()` method for [w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListConnectionsRequest` dataclass. * Removed [w.lakehouse_monitors](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/lakehouse_monitors.html) workspace-level service. * Added [w.quality_monitors](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/quality_monitors.html) workspace-level service. * Removed `databricks.sdk.service.catalog.DeleteLakehouseMonitorRequest` dataclass. * Removed `databricks.sdk.service.catalog.GetLakehouseMonitorRequest` dataclass. * Added `next_page_token` field for `databricks.sdk.service.catalog.ListConnectionsResponse`. * Added `dashboard_id` field for `databricks.sdk.service.catalog.UpdateMonitor`. * Added `databricks.sdk.service.catalog.DeleteQualityMonitorRequest` dataclass. * Added `databricks.sdk.service.catalog.GetQualityMonitorRequest` dataclass. * Added `databricks.sdk.service.catalog.ListConnectionsRequest` dataclass. * Changed `cluster_status()` method for [w.libraries](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/libraries.html) workspace-level service to return `databricks.sdk.service.compute.ClusterLibraryStatuses` dataclass. * Removed `databricks.sdk.service.compute.ClusterStatusResponse` dataclass. * Removed `sort_by_spec` field for `databricks.sdk.service.marketplace.ListListingsRequest`. * Added `is_ascending` field for `databricks.sdk.service.marketplace.ListListingsRequest`. * Added `sort_by` field for `databricks.sdk.service.marketplace.ListListingsRequest`. * Added `is_ascending` field for `databricks.sdk.service.marketplace.SearchListingsRequest`. * Removed `databricks.sdk.service.marketplace.SortBySpec` dataclass. * Removed `databricks.sdk.service.marketplace.SortOrder` dataclass. * Added `gateway_definition` field for `databricks.sdk.service.pipelines.CreatePipeline`. * Added `gateway_definition` field for `databricks.sdk.service.pipelines.EditPipeline`. * Added `table_configuration` field for `databricks.sdk.service.pipelines.ManagedIngestionPipelineDefinition`. * Added `gateway_definition` field for `databricks.sdk.service.pipelines.PipelineSpec`. * Added `table_configuration` field for `databricks.sdk.service.pipelines.SchemaSpec`. * Added `table_configuration` field for `databricks.sdk.service.pipelines.TableSpec`. * Added `databricks.sdk.service.pipelines.IngestionGatewayPipelineDefinition` dataclass. * Added `databricks.sdk.service.pipelines.TableSpecificConfig` dataclass. * Added `databricks.sdk.service.pipelines.TableSpecificConfigScdType` dataclass. * Added `deployment_artifacts` field for `databricks.sdk.service.serving.AppDeployment`. * Added `route_optimized` field for `databricks.sdk.service.serving.CreateServingEndpoint`. * Added `contents` field for `databricks.sdk.service.serving.ExportMetricsResponse`. * Added `endpoint_url` field for `databricks.sdk.service.serving.ServingEndpointDetailed`. * Added `route_optimized` field for `databricks.sdk.service.serving.ServingEndpointDetailed`. * Added `databricks.sdk.service.serving.AppDeploymentArtifacts` dataclass. * Added `scan_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service. * Added `databricks.sdk.service.vectorsearch.ListValue` dataclass. * Added `databricks.sdk.service.vectorsearch.MapStringValueEntry` dataclass. * Added `databricks.sdk.service.vectorsearch.ScanVectorIndexRequest` dataclass. * Added `databricks.sdk.service.vectorsearch.ScanVectorIndexResponse` dataclass. * Added `databricks.sdk.service.vectorsearch.Struct` dataclass. * Added `databricks.sdk.service.vectorsearch.Value` dataclass. OpenAPI SHA: b3f92dd59b5ee4ab919de4f04ed83c7585c86f2f, Date: 2024-05-16

* Fix null body response to empty in ApiClient ([#579](#579)).

## 0.27.1 ### Bug Fixes * Fix null body response to empty in ApiClient ([#579](#579)). Note: This is a patch release. The release with SDK Generation will be done as part of biweekly cadence.

tanmay-db · 2024-05-16T13:53:39Z

Hi @sodle-splunk, thanks for raising this, the release with fix has been done: https://github.com/databricks/databricks-sdk-py/releases/tag/v0.27.1

Fix null body response to empty in ApiClient

c379582

mgyucht reviewed Mar 7, 2024

View reviewed changes

tanmay-db added 2 commits March 7, 2024 15:06

fmt

89a7b26

Merge branch 'main' of github.com:databricks/databricks-sdk-py into f…

6596eba

…ix-ucx

mgyucht mentioned this pull request May 15, 2024

Gracefully handle null JSON responses from API #641

Closed

3 tasks

tanmay-db added 2 commits May 15, 2024 14:21

Merge branch 'main' of github.com:databricks/databricks-sdk-py into f…

a57b659

…ix-ucx

test

ec5d178

tanmay-db and others added 7 commits May 15, 2024 15:28

-

057bf5a

-

4653b1c

-

8007c5f

make test more accurately reflect bug

692139d

-

8a80894

-

80470b8

-

9b87c86

tanmay-db requested a review from mgyucht May 15, 2024 13:49

sodle-splunk approved these changes May 15, 2024

View reviewed changes

mgyucht approved these changes May 16, 2024

View reviewed changes

mgyucht added this pull request to the merge queue May 16, 2024

Merged via the queue into main with commit 53e99a5 May 16, 2024
8 of 9 checks passed

mgyucht deleted the fix-ucx branch May 16, 2024 09:55

tanmay-db mentioned this pull request May 16, 2024

Release v0.28.0 #645

Closed

tanmay-db added a commit that referenced this pull request May 16, 2024

Release v0.27.1

6eeef92

* Fix null body response to empty in ApiClient ([#579](#579)).

tanmay-db mentioned this pull request May 16, 2024

Release v0.27.1 #646

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix null body response to empty in ApiClient #579

Fix null body response to empty in ApiClient #579

tanmay-db commented Mar 7, 2024 •

edited

mgyucht left a comment

codecov-commenter commented Mar 7, 2024 •

edited

tanmay-db commented Mar 7, 2024

github-actions bot commented May 15, 2024 •

edited

tanmay-db commented May 15, 2024

nkvuong commented May 15, 2024 •

edited

sodle-splunk left a comment

tanmay-db commented May 16, 2024

Fix null body response to empty in ApiClient #579

Fix null body response to empty in ApiClient #579

Conversation

tanmay-db commented Mar 7, 2024 • edited

Changes

Tests

mgyucht left a comment

Choose a reason for hiding this comment

codecov-commenter commented Mar 7, 2024 • edited

Codecov Report

tanmay-db commented Mar 7, 2024

github-actions bot commented May 15, 2024 • edited

tanmay-db commented May 15, 2024

nkvuong commented May 15, 2024 • edited

sodle-splunk left a comment

Choose a reason for hiding this comment

tanmay-db commented May 16, 2024

tanmay-db commented Mar 7, 2024 •

edited

codecov-commenter commented Mar 7, 2024 •

edited

github-actions bot commented May 15, 2024 •

edited

nkvuong commented May 15, 2024 •

edited