FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Refactor configuration errors by angelapwen · Pull Request #2105 · github/codeql-action · GitHub

/ codeql-action Public

Refactor configuration errors - #2105

Merged
angelapwen merged 17 commits into
github:mainfrom
angelapwen:refactor-config-errors
Feb 8, 2024
ConversationCommits (17)ChecksFiles changed
Merged

Refactor configuration errors#2105
angelapwen merged 17 commits into
github:mainfrom
angelapwen:refactor-config-errors

Conversation

angelapwen commented Jan 30, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

As we add more configuration errors to improve our uptime measurements, I thought it would be nice to refactor the existing errors into their own file. I took inspiration from the FeatureConfig Record that we use for feature flags.

Also, I thought it would be nice to consolidate the place we check for configuration errors into codeql.ts, where the actual command invocations happen.

The PR also renames the UserError type to ConfigurationError to standardize on a single term.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

angelapwen force-pushed the refactor-config-errors branch from 3bcce67 to 7837cc7 Compare January 30, 2024 14:00
angelapwen marked this pull request as ready for review January 30, 2024 14:25
angelapwen requested a review from a team as a code owner January 30, 2024 14:25
angelapwen changed the title Refactor config errors Refactor configuration errors Jan 30, 2024
nickfyson reviewed Jan 30, 2024
View reviewed changes

nickfyson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I really like the direction, I think it makes a lot of sense to consolidate this class of errors and their handling into a single place. I've added a couple of comments/questions...

Comment thread src/cli-config-errors.ts Outdated
Comment thread src/codeql.ts Outdated
nickfyson reviewed Jan 31, 2024
View reviewed changes
Comment thread src/codeql.ts Outdated
angelapwen force-pushed the refactor-config-errors branch from 2d5e89c to e8fcc9e Compare January 31, 2024 15:33
aeisenberg reviewed Feb 2, 2024
View reviewed changes
Comment thread src/cli-config-errors.ts Outdated
Comment thread src/cli-config-errors.ts Outdated
Comment thread src/cli-config-errors.ts Outdated
Comment thread src/cli-config-errors.ts Outdated
Comment thread src/cli-config-errors.ts Outdated
Refactor existing CLI errors into new class
1c5a7b0
Move config error processing for database init
b5dd04b 
As we add more configuration errors, we can standardize throwing and catching them in the `codeql` file where we actually invoke the commands.

Also, rename to `isCliConfigurationError` for more clarity.
Fix config error checking condition
34d760d 
To maintain parity with the previous logic: only 1 of the 2 conditions needs to hold: either the exit codes match, or the error messages match.
Add processCliConfigurationError method
7fa31b7
Combine action error text into original configuration Record
011aa0d
Rename UserError to ConfigurationError
a84ad63 
And all associated methods/comments that say `user error`
Clarify CliErrorCategory
8c539c5
Refactor configuration error parsing logic per review
fb9a552
Fix up tests
8812654 
Now that we are always appending the original error, this test needs to be updated.
Rename to cli-errors, clean up logging and comments
b62de8d
Clarify comment from PR review
a6cb48e
angelapwen force-pushed the refactor-config-errors branch from e7bd740 to a6cb48e Compare February 6, 2024 15:56

angelapwen commented Feb 6, 2024

Copy link
Copy Markdown
Contributor Author

Okay.. the refactoring based off of the feedback took a bit longer/was more complex than expected, but I think I'm happy with the results 😸

  • Now, we simply call wrapCliConfigurationError on any errors thrown from CLI command invocations in codeql.ts. This will return the appropriate Error type (possibly a ConfigurationError, if it matches any of our known CliConfigErrorCategory values, and possibly with an additional error message prepended for additional context to the user).
  • There was a dependency cycle so I moved CommandInvocationError to the same file as the CLI configuration errors and renamed the file cli-errors.ts to cover both.
  • We're unconditionally appending the original error to the additional error message now, because I didn't think it was worth adding an extra case where we don't include the original CLI error. I updated the test cases in codeql.test.ts to accommodate.

nickfyson reviewed Feb 7, 2024
View reviewed changes

nickfyson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I like the direction, couple of small queries!

Comment thread src/status-report.ts Outdated
Comment thread src/codeql.ts
Comment thread src/codeql.ts
angelapwen requested a review from nickfyson February 8, 2024 10:42
nickfyson previously approved these changes Feb 8, 2024
View reviewed changes

nickfyson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

🚀

nickfyson previously approved these changes Feb 8, 2024
View reviewed changes

nickfyson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

🚀

angelapwen enabled auto-merge (squash) February 8, 2024 17:08
angelapwen merged commit 1515e2b into github:main Feb 8, 2024
angelapwen deleted the refactor-config-errors branch February 8, 2024 17:22
github-actions Bot mentioned this pull request Feb 13, 2024
Merged
8 tasks
henrymercer mentioned this pull request Feb 13, 2024
Merged
13 tasks
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

aeisenberg aeisenberg left review comments
nickfyson nickfyson approved these changes
henrymercer Awaiting requested review from henrymercer

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL