Use lowercase environment value during searching #831
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
gladjohn
reviewed
Jun 13, 2025
msal/token_cache.py
Outdated
| query_with_lowercase_environment = { | ||
| # __add() canonicalized entry's environment value to lower case, | ||
| # so we do the same here. | ||
| k: v.lower() if k == "environment" else v |
gladjohn
reviewed
Jun 13, 2025
| # __add() canonicalized entry's environment value to lower case, | ||
| # so we do the same here. | ||
| k: v.lower() if k == "environment" else v | ||
| for k, v in query.items() |
There was a problem hiding this comment.
would be good to have some unit tests to assert retrieval with mixed-case query succeeds
rayluo
force-pushed
the
lowercase-instane-name
branch
from
ad317f4 to
a2a772e
Compare
rayluo
force-pushed
the
lowercase-instane-name
branch
from
a2a772e to
b1d8cd7
Compare
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.
Context: The "environment" field in the token cache contains an authority's domain name, which is stored as lowercase in cache. We did that right. But we noticed that when performing a search in the token cache, we were not converting the "environment" field to lowercase. This is usually not a problem, because the domain name is typically in lowercase. And no customer reported any issue. However, recently when we are running Managed Identity test cases on Windows, we found out that the domain name placeholder that we use, turns out to be mixed case on Windows, such as "CPC-raylu-UB85C". This would cause cache miss when running the Managed Identity client on a Windows machine.
This PR improves the token cache search/match logic to always search environment by lowercase.