Explicitily fail instead of returning null if cannot parse resource link #41353
Conversation
This file contains hidden or 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
…into tvaron3/noneCollectionId
…into tvaron3/noneCollectionId
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the resource link parsing logic to fail fast by raising an exception instead of returning None, and propagates the raw string ID through routing map initialization.
- Change
GetResourceIdOrFullNameFromLinkto returnstrand raise aValueErroron parse failure - Remove redundant
str()casts when passingcollection_idinto routing map providers - Ensure both sync and async routing map providers use the updated signature
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/cosmos/azure-cosmos/azure/cosmos/_routing/routing_map_provider.py | Removed str() cast when calling init_collection_routing_map_if_needed |
| sdk/cosmos/azure-cosmos/azure/cosmos/_routing/aio/routing_map_provider.py | Same removal of str() cast in async provider |
| sdk/cosmos/azure-cosmos/azure/cosmos/_base.py | Updated GetResourceIdOrFullNameFromLink signature to -> str and replaced return None with a ValueError |
Comments suppressed due to low confidence (3)
sdk/cosmos/azure-cosmos/azure/cosmos/_base.py:349
- Update the docstring to include a
:raises ValueError:section, clarifying that the function now throws an exception when parsing fails.
def GetResourceIdOrFullNameFromLink(resource_link: str) -> str:
sdk/cosmos/azure-cosmos/azure/cosmos/_base.py:382
- [nitpick] Consider revising the error message to follow consistent capitalization and provide more context, e.g.
Failed parsing resource ID from link: {resource_link}.
raise ValueError("Failed Parsing ResourceID from link: {0}".format(resource_link))
sdk/cosmos/azure-cosmos/azure/cosmos/_base.py:382
- Add a unit test to verify that passing an invalid
resource_linktoGetResourceIdOrFullNameFromLinkraises aValueErroras expected.
raise ValueError("Failed Parsing ResourceID from link: {0}".format(resource_link))
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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
Don't return None when parsing the collection id rather raise an error. If we return, none in the future it would break lots of parts of the sdk with a key error.