Skip to content

Find, then filter, SARIF files for upload-sarif Action #3167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 12 commits into from
Oct 2, 2025
Merged

Find, then filter, SARIF files for upload-sarif Action #3167

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fe0376e
Add `getGroupedSarifFilePaths` with tests
mbg Sep 29, 2025
13ae3d4
Add and use `getAnalysisConfig`
mbg Sep 29, 2025
0417531
Add `keysTyped` and `entriesTyped` helpers
mbg Sep 29, 2025
717d581
Add `fixCategory` to `AnalysisConfig`
mbg Sep 29, 2025
63d1b25
Use `getGroupedSarifFilePaths` for `upload-sarif` Action
mbg Sep 29, 2025
056fb86
Call `fixCategory` in `uploadSpecifiedFiles`
mbg Sep 29, 2025
93711d3
Print a warning when there are `sarifFiles` in `getGroupedSarifFilePa…
mbg Sep 29, 2025
ad086e4
Use `path.extname` for some extension checks
mbg Sep 30, 2025
b8c4966
Rename variables in `getGroupedSarifFilePaths`
mbg Sep 30, 2025
9a0b46a
Rename `keys` and `entries` helpers and update docs
mbg Sep 30, 2025
d25fa60
ESLint: Disable `no-unused-vars` for parameters starting with `_`
mbg Oct 1, 2025
91a63dc
Remove `undefined` values from results of `unsafeEntriesInvariant`
mbg Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1287,3 +1287,17 @@ export async function asyncSome<T>(
export function isDefined<T>(value: T | null | undefined): value is T {
return value !== undefined && value !== null;
}

/** Like `Object.keys`, but infers the correct key type. */
export function keysTyped<T extends Record<string, any>>(
object: T,
): Array<keyof T> {
return Object.keys(object) as Array<keyof T>;
}

/** Like `Object.entries`, but infers the correct key type. */
export function entriesTyped<T extends Record<string, any>>(
object: T,
): Array<[keyof T, NonNullable<T[keyof T]>]> {
return Object.entries(object) as Array<[keyof T, NonNullable<T[keyof T]>]>;
Copy link
Contributor

@esbena esbena Sep 30, 2025

Choose a reason for hiding this comment

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

The NonNullable<T[keyof T]> is an undocumented refinement that is unsound.

Copy link
Member Author

@mbg mbg Oct 1, 2025

Choose a reason for hiding this comment

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

You're right. I have been thinking about this a good bit yesterday and I am not entirely sure about the best solution.

I initially thought that maybe using Exclude<T[keyof T], undefined> instead would be better, but then remembered that we can explicitly set a key to undefined in which case Object.entries still returns a pair for the key and undefined as the value.

I am now thinking that perhaps it would be better to explicitly filter the results of these functions to exclude undefined values and keys that don't belong to T?

Copy link
Contributor

@esbena esbena Sep 30, 2025

Choose a reason for hiding this comment

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

I'd like the naming / docstring to be different here for both keysTyped and entriesTyped. Perhaps something with strict/exact/...? And definitely not something with "correct", since the builtin Object.keys is actually the one that is correct already.
See https://stackoverflow.com/questions/55012174/why-doesnt-object-keys-return-a-keyof-type-in-typescript

}