Title: Fix handling of non-`string` values from repository properties API by mbg · Pull Request #3557 · github/codeql-action · GitHub
Open Graph Title: Fix handling of non-`string` values from repository properties API by mbg · Pull Request #3557 · github/codeql-action
X Title: Fix handling of non-`string` values from repository properties API by mbg · Pull Request #3557 · github/codeql-action
Description: Fixes #3555. The repository property API will return repository property objects where the value field is either string or string[]. We do not currently handle the latter. This PR makes the following changes: The first commit updates our type representation of the API responses to account for string[] values. The second changes the validation logic to only validate the type of value if it is for a property we care about. This also protects us against future changes to what types of value may be returned by the API. These two commits are enough to fix the bug. The third commit goes beyond this to enable us to use array-typed properties in the future by: Introducing a mapping from known repository properties to the expected API value types (RepositoryPropertyApiType). Changing repositoryPropertyParsers to return an object for each known property that contains both a validator function and a parser (PropertyInfo). The validator function (.validate) accepts any RepositoryPropertyValue (i.e. string | string[]), checks that it is the expected type, and narrows the type of value if successful. The value type validation is now in setProperty, which retrieves the PropertyInfo object for the repository property, calls validate, and then is either able to call parse if the check was successful (and the type narrowed) or throws the validation error. Risk assessment For internal use only. Please select the risk level of this change: Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only. Which use cases does this change impact? Workflow types: Advanced setup - Impacts users who have custom CodeQL workflows. Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...). Products: Code Scanning - The changes impact analyses when analysis-kinds: code-scanning. Code Quality - The changes impact analyses when analysis-kinds: code-quality. Other first-party - The changes impact other first-party analyses. Environments: Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency. How did/will you validate this change? Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files). End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks). If something goes wrong after this change is released, what are the mitigation and rollback strategies? Feature flags - All new or changed code paths can be fully disabled with corresponding feature flags. Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix. The repository properties feature is already FF-ed. If something goes wrong with this change, we can either disable the existing FF or perform a rollback. How will you know if something goes wrong after this change is released? Telemetry - I rely on existing telemetry or have made changes to the telemetry. Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release. Alerts - New or existing monitors will trip if something goes wrong with this change. Are there any special considerations for merging or releasing this change? No special considerations - This change can be merged at any time. Merge / deployment checklist Confirm this change is backwards compatible with existing workflows. Consider adding a changelog entry for this change. Confirm the readme and docs have been updated if necessary.
Open Graph Description: Fixes #3555. The repository property API will return repository property objects where the value field is either string or string[]. We do not currently handle the latter. This PR makes the followi...
X Description: Fixes #3555. The repository property API will return repository property objects where the value field is either string or string[]. We do not currently handle the latter. This PR makes the followi...
Opengraph URL: https://github.com/github/codeql-action/pull/3557
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:f8079ef1-f97a-c322-690d-7839ac88f569 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | DFDE:236C7E:A865BA:E57CE7:6A4C8FAF |
| html-safe-nonce | 3b0c3c0bef507ee1199ed66ab009120dcbb3681c89460c49d38b8370e016b938 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJERkRFOjIzNkM3RTpBODY1QkE6RTU3Q0U3OjZBNEM4RkFGIiwidmlzaXRvcl9pZCI6IjQ0Njc0NjczMTkxMjgxMzM1NTEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 575d6f16acfe3bdfe228a009e4d5ebb0ed26b561a81f7caf524f3aa5014fbcea |
| hovercard-subject-tag | pull_request:3373327609 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/github/codeql-action/pull/3557/files |
| twitter:image | https://avatars.githubusercontent.com/u/278086?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/278086?s=400&v=4 |
| og:image:alt | Fixes #3555. The repository property API will return repository property objects where the value field is either string or string[]. We do not currently handle the latter. This PR makes the followi... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/github/codeql-action git https://github.com/github/codeql-action.git |
| octolytics-dimension-user_id | 9919 |
| octolytics-dimension-user_login | github |
| octolytics-dimension-repository_id | 259445878 |
| octolytics-dimension-repository_nwo | github/codeql-action |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 259445878 |
| octolytics-dimension-repository_network_root_nwo | github/codeql-action |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7a2dede45637df6b92ddcfe2a557e67d4b5854ae |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width