Handle String response for "find latest version" #246
Merged
Conversation
This file contains 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
See rails#245 for context. The TL;DR is the response sometimes returns a String instead of Hash object. This should be handled properly. The way to handle this is up for discussion. To start addressing the issue the String response will just be surfaced as `latest_version`.
|
Not exactly sure why the CI checks are failing, but it seems to have nothing to do with the proposed changes. |
We only care to assert on the `latest_version` since this is what we care about. Can revert the change if it is desired to assert the rest.
vietqhoang
changed the title
vietqhoang
commented
Feb 15, 2024
| @@ -86,7 +86,7 @@ def get_json(uri) | |||
| end | |||
|
|
|||
| def find_latest_version(response) | |||
| latest_version = response.dig('dist-tags', 'latest') | |||
| latest_version = response.is_a?(String) ? response : response.dig('dist-tags', 'latest') | |||
There was a problem hiding this comment.
The response may be a blank String. One reported issue (#245 (comment)) made me question this possibility.
If this is the case then a fallback may be worthwhile. I am writing it with available Rails methods, but can change it to use Ruby-only accessible ones.
Suggested change
| latest_version = response.is_a?(String) ? response : response.dig('dist-tags', 'latest') | |
| latest_version = response.is_a?(String) ? (response.presence || 'unknown') : response.dig('dist-tags', 'latest') |
|
Any chance this fix could be merged or at least considered? Without this it's making it very hard for us to figure out which JS dependencies are out of date since we were relying heavily on the |
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.
Closes #245
Problem
It is expected NPM to return a Hash for the response.
importmap-rails/lib/importmap/npm.rb
Line 89 in ddf9be4
But for whatever reason the response can now also return a String, which is not accounted for in
npm.rb.See the referenced issue for further context.
Expectation
The
importmap outdatedcommand should handle the problem more gracefully. In this case, a reasonable expectation is to surface the String response.Solution
How to handle is up for discussion.
Just to get the fix process started the propose change is to surface the String in the response as
latest_versionsince it isn't clear what the contents of the String could be.Using the fork with change on our production app which has the problematic pinned dependency, the following
outdatedis now returned.