Overlay: Determine which versions of CodeQL are compatible with cached base DBs#3809
Open
henrymercer wants to merge 2 commits intomainfrom
Open
Overlay: Determine which versions of CodeQL are compatible with cached base DBs#3809henrymercer wants to merge 2 commits intomainfrom
henrymercer wants to merge 2 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Refactors overlay base-database caching into a dedicated module and introduces a helper to discover which CodeQL CLI versions are represented in existing cached overlay base databases (to support future version-selection logic).
Changes:
- Moved overlay base DB cache download/upload and cache-key generation logic into
src/overlay/caching.tsand addedsrc/overlay/caching.test.ts. - Extracted
OverlayDatabaseModeintosrc/overlay/overlay-database-mode.tsand updated imports across the codebase. - Added
getCompatibleCodeQlVersionsForOverlayBaseDatabases(config, logger)to list CodeQL versions inferred from matching cache entries.
Show a summary per file
| File | Description |
|---|---|
| src/testing-utils.ts | Updates OverlayDatabaseMode import path after enum extraction. |
| src/status-report.ts | Updates overlay cache stats type import to the new caching module. |
| src/overlay/overlay-database-mode.ts | New enum module for overlay database mode. |
| src/overlay/index.ts | Removes caching responsibilities; retains overlay file/OID helpers and version constants. |
| src/overlay/index.test.ts | Removes overlay caching tests that were moved to the new caching test file. |
| src/overlay/caching.ts | New home for overlay base DB cache logic + compatible-version discovery helper. |
| src/overlay/caching.test.ts | Adds unit tests for cache key stability, cache restore behavior, and compatible-version discovery. |
| src/init-action.ts | Switches overlay cache download imports to overlay/caching and enum to overlay-database-mode. |
| src/init-action-post-helper.ts | Updates OverlayDatabaseMode import path. |
| src/init-action-post-helper.test.ts | Updates OverlayDatabaseMode import path. |
| src/database-upload.ts | Updates OverlayDatabaseMode import path. |
| src/config-utils.ts | Updates OverlayDatabaseMode import path; keeps overlay min-version constants from overlay/index. |
| src/config-utils.test.ts | Updates OverlayDatabaseMode import path. |
| src/codeql.ts | Updates OverlayDatabaseMode import path. |
| src/analyze.ts | Updates OverlayDatabaseMode import path. |
| src/analyze-action.ts | Switches overlay cache upload import to overlay/caching. |
| lib/upload-sarif-action-post.js | Generated build output update. |
| lib/upload-lib.js | Generated build output update. |
| lib/start-proxy-action-post.js | Generated build output update. |
| lib/resolve-environment-action.js | Generated build output update. |
| lib/init-action.js | Generated build output update. |
| lib/init-action-post.js | Generated build output update. |
| lib/autobuild-action.js | Generated build output update. |
| lib/analyze-action.js | Generated build output update. |
| lib/analyze-action-post.js | Generated build output update. |
Copilot's findings
- Files reviewed: 16/28 changed files
- Comments generated: 1
| import { getRef } from "./git-utils"; | ||
| import { Logger } from "./logging"; | ||
| import { OverlayBaseDatabaseDownloadStats } from "./overlay"; | ||
| import { OverlayBaseDatabaseDownloadStats } from "./overlay/caching"; |
There was a problem hiding this comment.
OverlayBaseDatabaseDownloadStats is only used as a type in this file. Consider switching this to a type-only import to avoid pulling src/overlay/caching.ts (and its runtime deps like @actions/cache) into the status-report module at runtime.
Suggested change
| import { OverlayBaseDatabaseDownloadStats } from "./overlay/caching"; | |
| import type { OverlayBaseDatabaseDownloadStats } from "./overlay/caching"; |
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
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.
overlay/caching.tsgetCompatibleCodeQlVersionsForOverlayBaseDatabases(config, logger)function that looks up overlay base databases for the languages inconfigand returns a list of the CodeQL versions that were used to generate those overlay base databases. The intention is to use this in a future PR to determine what CodeQL version to set up. Returning a list rather than just the latest means we can filter the list down based on the enabled default version feature flags. This gives us the ability to skip a CodeQL version that we might initially roll out but then decide to rollback.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
None yet.
How did/will you validate this change?
.test.tsfiles).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist