Skip to content

Commit 32f56c7

Browse files
committed
Refactor cleanupAndUploadDatabases querying checkout_path itself
1 parent 30f0cd4 commit 32f56c7

4 files changed

Lines changed: 76 additions & 40 deletions

File tree

‎lib/entry-points.js‎

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/analyze-action.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,12 +406,12 @@ async function run(action: ActionState<["Base", "Logger", "Env", "Actions"]>) {
406406
// Note: Take care with the ordering of this call since databases may be cleaned up
407407
// at the `overlay` or `clear` level.
408408
databaseUploadResults = await cleanupAndUploadDatabases(
409+
{ logger, features },
409410
repositoryNwo,
410411
codeql,
411412
config,
412413
apiDetails,
413-
features,
414-
logger,
414+
checkoutPath,
415415
);
416416

417417
// Possibly upload the TRAP caches for later re-use

‎src/database-upload.test.ts‎

Lines changed: 60 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,15 @@ test.serial(
9999

100100
const loggedMessages: LoggedMessage[] = [];
101101
await cleanupAndUploadDatabases(
102+
{
103+
logger: getRecordingLogger(loggedMessages),
104+
features: createFeatures([]),
105+
},
102106
testRepoName,
103107
getCodeQL(),
104108
getTestConfig(tmpDir),
105109
testApiDetails,
106-
createFeatures([]),
107-
getRecordingLogger(loggedMessages),
110+
"",
108111
);
109112
checkExpectedLogMessages(t, loggedMessages, [
110113
"Database upload disabled in workflow. Skipping upload.",
@@ -128,15 +131,18 @@ test.serial(
128131

129132
const loggedMessages: LoggedMessage[] = [];
130133
await cleanupAndUploadDatabases(
134+
{
135+
logger: getRecordingLogger(loggedMessages),
136+
features: createFeatures([]),
137+
},
131138
testRepoName,
132139
getCodeQL(),
133140
{
134141
...getTestConfig(tmpDir),
135142
analysisKinds: [AnalysisKind.CodeQuality],
136143
},
137144
testApiDetails,
138-
createFeatures([]),
139-
getRecordingLogger(loggedMessages),
145+
"",
140146
);
141147
checkExpectedLogMessages(t, loggedMessages, [
142148
"Not uploading database because 'analysis-kinds: code-scanning' is not enabled.",
@@ -159,12 +165,15 @@ test.serial("Abort database upload if running against GHES", async (t) => {
159165

160166
const loggedMessages: LoggedMessage[] = [];
161167
await cleanupAndUploadDatabases(
168+
{
169+
logger: getRecordingLogger(loggedMessages),
170+
features: createFeatures([]),
171+
},
162172
testRepoName,
163173
getCodeQL(),
164174
config,
165175
testApiDetails,
166-
createFeatures([]),
167-
getRecordingLogger(loggedMessages),
176+
"",
168177
);
169178
checkExpectedLogMessages(t, loggedMessages, [
170179
"Not running against github.com or GHEC-DR. Skipping upload.",
@@ -185,12 +194,15 @@ test.serial(
185194

186195
const loggedMessages: LoggedMessage[] = [];
187196
await cleanupAndUploadDatabases(
197+
{
198+
logger: getRecordingLogger(loggedMessages),
199+
features: createFeatures([]),
200+
},
188201
testRepoName,
189202
getCodeQL(),
190203
getTestConfig(tmpDir),
191204
testApiDetails,
192-
createFeatures([]),
193-
getRecordingLogger(loggedMessages),
205+
"",
194206
);
195207
checkExpectedLogMessages(t, loggedMessages, [
196208
"Not analyzing default branch. Skipping upload.",
@@ -214,12 +226,15 @@ test.serial(
214226

215227
const loggedMessages: LoggedMessage[] = [];
216228
await cleanupAndUploadDatabases(
229+
{
230+
logger: getRecordingLogger(loggedMessages),
231+
features: createFeatures([]),
232+
},
217233
testRepoName,
218234
getCodeQL(),
219235
getTestConfig(tmpDir),
220236
testApiDetails,
221-
createFeatures([]),
222-
getRecordingLogger(loggedMessages),
237+
"",
223238
);
224239

225240
checkExpectedLogMessages(t, loggedMessages, [
@@ -253,12 +268,15 @@ test.serial(
253268

254269
const loggedMessages: LoggedMessage[] = [];
255270
await cleanupAndUploadDatabases(
271+
{
272+
logger: getRecordingLogger(loggedMessages),
273+
features: createFeatures([]),
274+
},
256275
testRepoName,
257276
getCodeQL(),
258277
getTestConfig(tmpDir),
259278
testApiDetails,
260-
createFeatures([]),
261-
getRecordingLogger(loggedMessages),
279+
"",
262280
);
263281

264282
checkExpectedLogMessages(t, loggedMessages, [
@@ -290,12 +308,15 @@ test.serial("Successfully uploading a database to github.com", async (t) => {
290308

291309
const loggedMessages: LoggedMessage[] = [];
292310
await cleanupAndUploadDatabases(
311+
{
312+
logger: getRecordingLogger(loggedMessages),
313+
features: createFeatures([]),
314+
},
293315
testRepoName,
294316
getCodeQL(),
295317
getTestConfig(tmpDir),
296318
testApiDetails,
297-
createFeatures([]),
298-
getRecordingLogger(loggedMessages),
319+
"",
299320
);
300321
checkExpectedLogMessages(t, loggedMessages, [
301322
"Successfully uploaded database for javascript",
@@ -316,6 +337,10 @@ test.serial("Successfully uploading a database to GHEC-DR", async (t) => {
316337

317338
const loggedMessages: LoggedMessage[] = [];
318339
await cleanupAndUploadDatabases(
340+
{
341+
logger: getRecordingLogger(loggedMessages),
342+
features: createFeatures([]),
343+
},
319344
testRepoName,
320345
getCodeQL(),
321346
getTestConfig(tmpDir),
@@ -324,8 +349,7 @@ test.serial("Successfully uploading a database to GHEC-DR", async (t) => {
324349
url: "https://tenant.ghe.com",
325350
apiURL: undefined,
326351
},
327-
createFeatures([]),
328-
getRecordingLogger(loggedMessages),
352+
"",
329353
);
330354
checkExpectedLogMessages(t, loggedMessages, [
331355
"Successfully uploaded database for javascript",
@@ -377,12 +401,15 @@ test.serial(
377401

378402
const loggedMessages: LoggedMessage[] = [];
379403
const results = await cleanupAndUploadDatabases(
404+
{
405+
logger: getRecordingLogger(loggedMessages),
406+
features: createFeatures([Feature.UploadOverlayDbToApi]),
407+
},
380408
testRepoName,
381409
codeql,
382410
config,
383411
testApiDetails,
384-
createFeatures([Feature.UploadOverlayDbToApi]),
385-
getRecordingLogger(loggedMessages),
412+
"",
386413
);
387414

388415
// The database should be cleaned up at the `overlay` level for the upload
@@ -422,12 +449,15 @@ test.serial(
422449
});
423450

424451
const results = await cleanupAndUploadDatabases(
452+
{
453+
logger: getRecordingLogger([]),
454+
features: createFeatures([Feature.UploadOverlayDbToApi]),
455+
},
425456
testRepoName,
426457
codeql,
427458
getTestConfig(tmpDir),
428459
testApiDetails,
429-
createFeatures([Feature.UploadOverlayDbToApi]),
430-
getRecordingLogger([]),
460+
"",
431461
);
432462

433463
// A regular upload is cleaned only once, at the `clear` level.
@@ -465,12 +495,15 @@ test.serial("Does not measure clear cleanup size in debug mode", async (t) => {
465495
config.debugMode = true;
466496

467497
const results = await cleanupAndUploadDatabases(
498+
{
499+
logger: getRecordingLogger([]),
500+
features: createFeatures([Feature.UploadOverlayDbToApi]),
501+
},
468502
testRepoName,
469503
codeql,
470504
config,
471505
testApiDetails,
472-
createFeatures([Feature.UploadOverlayDbToApi]),
473-
getRecordingLogger([]),
506+
"",
474507
);
475508

476509
// In debug mode we clean up at the `overlay` level for the upload but skip
@@ -510,12 +543,15 @@ test.serial(
510543
config.overlayDatabaseMode = OverlayDatabaseMode.OverlayBase;
511544

512545
const results = await cleanupAndUploadDatabases(
546+
{
547+
logger: getRecordingLogger([]),
548+
features: createFeatures([Feature.UploadOverlayDbToApi]),
549+
},
513550
testRepoName,
514551
codeql,
515552
config,
516553
testApiDetails,
517-
createFeatures([Feature.UploadOverlayDbToApi]),
518-
getRecordingLogger([]),
554+
"",
519555
);
520556

521557
// When the `clear` cleanup fails, no size is measured, so we should not

‎src/database-upload.ts‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as fs from "fs";
22

3+
import { ActionState } from "./action-common";
34
import * as actionsUtil from "./actions-util";
45
import { AnalysisKind } from "./analyses";
56
import {
@@ -9,7 +10,7 @@ import {
910
} from "./api-client";
1011
import { type CodeQL } from "./codeql";
1112
import { Config } from "./config-utils";
12-
import { Feature, FeatureEnablement } from "./feature-flags";
13+
import { Feature } from "./feature-flags";
1314
import * as gitUtils from "./git-utils";
1415
import { Logger, withGroupAsync } from "./logging";
1516
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
@@ -45,13 +46,15 @@ export interface DatabaseUploadResult {
4546
}
4647

4748
export async function cleanupAndUploadDatabases(
49+
action: ActionState<["Logger", "FeatureFlags"]>,
4850
repositoryNwo: RepositoryNwo,
4951
codeql: CodeQL,
5052
config: Config,
5153
apiDetails: GitHubApiDetails,
52-
features: FeatureEnablement,
53-
logger: Logger,
54+
checkoutPath: string,
5455
): Promise<DatabaseUploadResult[]> {
56+
const logger = action.logger;
57+
5558
if (actionsUtil.getRequiredInput("upload-database") !== "true") {
5659
logger.debug("Database upload disabled in workflow. Skipping upload.");
5760
return [];
@@ -87,7 +90,7 @@ export async function cleanupAndUploadDatabases(
8790
// If config.overlayDatabaseMode is OverlayBase, then we have overlay base databases for all languages.
8891
const shouldUploadOverlayBase =
8992
config.overlayDatabaseMode === OverlayDatabaseMode.OverlayBase &&
90-
(await features.getValue(Feature.UploadOverlayDbToApi, codeql));
93+
(await action.features.getValue(Feature.UploadOverlayDbToApi, codeql));
9194
const cleanupLevel = shouldUploadOverlayBase
9295
? CleanupLevel.Overlay
9396
: CleanupLevel.Clear;
@@ -110,9 +113,7 @@ export async function cleanupAndUploadDatabases(
110113
includeDiagnostics: false,
111114
});
112115
bundledDbSize = fs.statSync(bundledDb).size;
113-
const commitOid = await gitUtils.getCommitOid(
114-
actionsUtil.getRequiredInput("checkout_path"),
115-
);
116+
const commitOid = await gitUtils.getCommitOid(checkoutPath);
116117
// Upload with manual retry logic. We disable Octokit's built-in retries
117118
// because the request body is a ReadStream, which can only be consumed
118119
// once.

0 commit comments

Comments
 (0)