-
Notifications
You must be signed in to change notification settings - Fork 2
feat: Add getPacks method to retrieve installed CodeQL packs #9
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.
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
Open
GeekMasher
wants to merge
2
commits into
main
Choose a base branch
from
pack-resolve
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -413,6 +413,69 @@ export class CodeQLService { | |||||||||
return [...new Set(results)]; // Remove any duplicates just in case | ||||||||||
} | ||||||||||
|
||||||||||
public async getPacks(): Promise<string[]> { | ||||||||||
this.logger.logServiceCall("CodeQLService", "getPacks", "started"); | ||||||||||
var packs: string[] = []; | ||||||||||
|
||||||||||
try { | ||||||||||
const config = vscode.workspace.getConfiguration("codeql-scanner"); | ||||||||||
const codeqlPath = config.get<string>("codeqlPath", "codeql"); | ||||||||||
|
||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Getting installed CodeQL packs using CLI at ${codeqlPath}` | ||||||||||
); | ||||||||||
|
||||||||||
const cmd = `${codeqlPath} resolve packs --format=json`; | ||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Running command to get installed CodeQL packs: ${cmd}` | ||||||||||
); | ||||||||||
const { stdout } = await execAsync(cmd); | ||||||||||
|
||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
"Successfully retrieved installed CodeQL packs" | ||||||||||
); | ||||||||||
|
||||||||||
const packsInfo = JSON.parse(stdout); | ||||||||||
|
||||||||||
// Reverse steps | ||||||||||
GeekMasher marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
const steps = packsInfo.steps || []; | ||||||||||
for (const step of steps.reverse()) { | ||||||||||
for (const scans of step.scans || []) { | ||||||||||
const found = scans.found || {}; | ||||||||||
// For each key, add the pack name to the list | ||||||||||
for (const packName of Object.keys(found)) { | ||||||||||
if (!packs.includes(packName)) { | ||||||||||
packs.push(packName); | ||||||||||
Comment on lines
+450
to
+451
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using Array.includes() for duplicate checking has O(n) complexity for each insertion, resulting in O(n²) overall complexity. Consider using a Set for O(1) lookups and convert to array at the end.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||
|
||||||||||
this.logger.debug( | ||||||||||
"CodeQLService", | ||||||||||
`Found CodeQL pack: ${packName}` | ||||||||||
); | ||||||||||
} | ||||||||||
} | ||||||||||
} | ||||||||||
} | ||||||||||
} catch (error) { | ||||||||||
this.logger.error("CodeQLService", "Error getting CodeQL packs", error); | ||||||||||
throw new Error( | ||||||||||
"Failed to get CodeQL packs. Please check your configuration." | ||||||||||
); | ||||||||||
} | ||||||||||
|
||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Found ${packs.length} installed CodeQL packs: ${packs.join(", ")}` | ||||||||||
); | ||||||||||
|
||||||||||
this.logger.logServiceCall("CodeQLService", "getPacks", "completed", { | ||||||||||
packs: packs, | ||||||||||
}); | ||||||||||
return packs; | ||||||||||
} | ||||||||||
|
||||||||||
public async runAnalysis( | ||||||||||
progress: vscode.Progress<{ increment?: number; message?: string }>, | ||||||||||
cancellationToken: vscode.CancellationToken | ||||||||||
|
@@ -908,7 +971,7 @@ export class CodeQLService { | |||||||||
|
||||||||||
// Build the query suite argument | ||||||||||
// var queries = `codeql/${language}-queries`; | ||||||||||
var queries = this.findQueryPack(language); | ||||||||||
const queries = await this.findQueryPack(language); | ||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Using query pack: ${queries} for language: ${language}` | ||||||||||
|
@@ -957,34 +1020,46 @@ export class CodeQLService { | |||||||||
} | ||||||||||
} | ||||||||||
|
||||||||||
private findQueryPack(language: string): string | undefined { | ||||||||||
const codeqlDir = this.getCodeQLDirectory(); | ||||||||||
const queryPackPath = path.join(codeqlDir, "packages"); | ||||||||||
private async findQueryPack(language: string): Promise<string | undefined> { | ||||||||||
try { | ||||||||||
// Get all installed packs using the getPacks method | ||||||||||
const installedPacks = await this.getPacks(); | ||||||||||
|
||||||||||
// List all directories in the packages folder | ||||||||||
if (!fs.existsSync(queryPackPath)) { | ||||||||||
this.logger.warn( | ||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Query pack directory does not exist: ${queryPackPath}` | ||||||||||
`Looking for ${language} query pack among ${installedPacks.length} installed packs` | ||||||||||
); | ||||||||||
return undefined; | ||||||||||
} | ||||||||||
|
||||||||||
const orgDirs = fs.readdirSync(queryPackPath, { withFileTypes: true }); | ||||||||||
for (const orgDir of orgDirs) { | ||||||||||
const orgPath = path.join(queryPackPath, orgDir.name); | ||||||||||
// codeql | ||||||||||
if (!orgDir.isDirectory()) { | ||||||||||
continue; | ||||||||||
} | ||||||||||
// Look for language-specific query pack first | ||||||||||
const queryPack = installedPacks.find( | ||||||||||
(pack) => | ||||||||||
pack.endsWith(`/${language}-queries`) || // Match org/language-queries format | ||||||||||
pack === `${language}-queries` // Direct match for language-queries | ||||||||||
); | ||||||||||
|
||||||||||
for (const packDir of fs.readdirSync(orgPath, { withFileTypes: true })) { | ||||||||||
if (packDir.isDirectory() && packDir.name === `${language}-queries`) { | ||||||||||
return `${orgDir.name}/${packDir.name}`; | ||||||||||
} | ||||||||||
if (queryPack) { | ||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`Found query pack for ${language}: ${queryPack}` | ||||||||||
); | ||||||||||
return queryPack; | ||||||||||
} | ||||||||||
|
||||||||||
// Look for the default codeql pack if no specific pack is found | ||||||||||
const defaultPack = `codeql/${language}-queries`; | ||||||||||
this.logger.info( | ||||||||||
"CodeQLService", | ||||||||||
`No specific query pack found for ${language}, using default: ${defaultPack}` | ||||||||||
); | ||||||||||
return defaultPack; // Fallback to default pack | ||||||||||
} catch (error) { | ||||||||||
this.logger.error( | ||||||||||
"CodeQLService", | ||||||||||
`Error finding query pack for ${language}`, | ||||||||||
error | ||||||||||
); | ||||||||||
return `codeql/${language}-queries`; // Fallback to default pack on error | ||||||||||
} | ||||||||||
return `codeql/${language}-queries`; // Fallback to default pack | ||||||||||
} | ||||||||||
|
||||||||||
private parseSARIFResults( | ||||||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use 'const' instead of 'var' for block-scoped variable declaration. Since 'packs' is reassigned through array methods rather than variable reassignment, it can be declared as const.
Copilot uses AI. Check for mistakes.