Improve error handling for missing dependency versions for github actions #11144
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
| @@ -35,6 +35,9 @@ def parse | |||
| dependency_set += workfile_file_dependencies(file) | |||
| end | |||
|
|
|||
| dependencies_without_version = dependency_set.dependencies.select { |dep| dep.version.nil? } | |||
| raise UpdateNotPossible, dependencies_without_version.map(&:name) unless dependencies_without_version.empty? | |||
There was a problem hiding this comment.
Can we use a more descriptive error message?
UpdateNotPossible is overloaded and opaque to our users.
There was a problem hiding this comment.
Tagging @kbukum1 since he has a list of some of our common errors that already have paved paths.
There was a problem hiding this comment.
I created a new error class to handle this specific case
robaiken
force-pushed
the
robaiken/show-warning-if-no-version-found
branch
from
c6dcd8e to
36a9651
Compare
robaiken
force-pushed
the
robaiken/show-warning-if-no-version-found
branch
from
36a9651 to
a7f6a67
Compare
|
|
||
| sig { returns(T::Array[String]) } | ||
| attr_reader :dependencies | ||
|
|
There was a problem hiding this comment.
Thanks for adding a new class; I think you'll have to make some changes on the API end too to get this error to sho up. @kbukum1 , can you share some sample past PRs?
robaiken
force-pushed
the
robaiken/show-warning-if-no-version-found
branch
from
a7f6a67 to
085771a
Compare
robaiken
force-pushed
the
robaiken/show-warning-if-no-version-found
branch
from
4ce06e6 to
56728db
Compare
markhallen
approved these changes
Dec 19, 2024
robaiken
force-pushed
the
robaiken/show-warning-if-no-version-found
branch
from
56728db to
ae52141
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.
What are you trying to accomplish?
Improves error handling by raising a clear
UnresolvableVersionErrorerror when dependencies lack version constraints, rather than failing with a generic Sorbet error. This helps users understand exactly which dependencies are failing.Anything you want to highlight for special attention from reviewers?
Chose to fail fast during parsing rather than proceeding with dependencies that are not semver. This provides clearer feedback and prevents Sorbet from raising confusing type errors later in the update process.
How will you know you've accomplished your goal?
When the parse method correctly identifies dependencies without versions and raises an
UnresolvableVersionErrorrather than a Sorbet issue message.Checklist