This repository has been archived by the owner on Feb 6, 2023. It is now read-only.
Changing createCacheKey to replace _any_ characters that violate file naming standards #135
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.
By default this tool uses a cache pool that creates local files for caching. The existing implementation covers PSR-6 requirements, but there are some issues that can occur when using the defaults if some bad characters are in the URI used to form the cache key (which is used as the filename).
For example, assume an Okta instance of testing.oktapreview.com with a user of
test**[email protected]
. By making a get for that user with this library, the URI will betesting.oktapreview.com/api/v1/users/test**[email protected]
. Based off of the existing code, this name will get transformed to a cache key oftesting_oktapreview_com_api_v1_users_test**7_test_com
which is an invalid file name.The change I propose would use the regex for valid filenames by default to create cache keys. Under this setup, the cache key would instead be
testing_oktapreview_com_api_v1_users_test__7_test_com
which would be valid.Note: There are still going to be some problems if people include lots of the invalid characters in their usernames because you could have collisions. For example, user of
test**[email protected]
and[email protected]
would both hit the same cache keytesting_oktapreview_com_api_v1_users_test__7_test_com