Check disk usage using Node.js API by henrymercer · Pull Request #3247 · github/codeql-action · GitHub

This API was introduced in Node.js 18. Let's use it instead of the check-disk-space package.

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?

Advanced setup - Impacts users who have custom workflows.
Default setup - Impacts users who use default setup.
Code Scanning - Impacts Code Scanning (i.e. analysis-kinds: code-scanning).
Code Quality - Impacts Code Quality (i.e. analysis-kinds: code-quality).
Third-party analyses - Impacts third-party analyses (i.e. upload-sarif).
GHES - Impacts GitHub Enterprise Server.

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?

Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

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.
- Alerts - New or existing monitors will trip if something goes wrong with this change.

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.

This was introduced in Node.js 18

Pull Request Overview

This PR replaces the check-disk-space package with Node.js's native fs.statfs() API for checking disk usage. The change reduces external dependencies by leveraging built-in functionality introduced in Node.js 18.

Key changes:

Replaced check-disk-space package with fs.promises.statfs() API
Updated disk usage calculation to use filesystem block-based metrics (bsize, bavail, blocks)
Removed package dependency from package.json

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.

File	Description
src/util.ts	Replaced external disk space check with native Node.js API and updated calculation logic
package.json	Removed check-disk-space dependency
lib/*.js	Auto-generated JavaScript files reflecting source changes

I'm surprised that we have to go through the block computation, and that there isn't a more direct measure in the API. But 🤷🏻

I don't see any existing tests of checkDiskUsage, we could verify that it produces some positive numbers without tying ourselves too much to the underlying runtime.

I compared https://github.com/github/codeql-action/actions/runs/18873645058/job/53859006836 and https://github.com/github/codeql-action/actions/runs/18844897855, and the numbers look similar.

Nice. As discussed elsewhere, we don't have good test coverage for this, beyond it being run as part of every test workflow and as part of status report tests.

I think a unit test specifically for this would be tricky, beyond checking error conditions / nominal conditions. I am not sure how much that would gain us compared to what is already covered by the e2e workflows and other tests.

In a similar spirit to the log-level change we made in #3240, should we change this from a warning to a debug message? This is only really a best effort, so it may be better to avoid the workflow annotation that results from this.

I think while we expect the workflow validation to fail in a bunch of circumstances, this disk space check shouldn't fail. So I'd suggest we keep it as a warning.

No strong feelings, but I could imagine that this could also fail with weird filesystem / permission setups, especially on self-hosted runners.

Thanks for adding a unit test!

Minor, but I quite like t.truthy in an if condition that guards the check on the property. The && makes it harder to debug which sub-condition failed.

It's hard to write because we can't compare undefined with 0. I'll make two separate assertions.

Check disk usage using Node.js API

239e305

This was introduced in Node.js 18

henrymercer requested a review from a team as a code owner October 28, 2025 11:44

Copilot AI review requested due to automatic review settings October 28, 2025 11:44

github-actions Bot added the size/XS Should be very easy to review label Oct 28, 2025

Copilot AI reviewed Oct 28, 2025

View reviewed changes

esbena reviewed Oct 28, 2025

View reviewed changes

esbena previously approved these changes Oct 28, 2025

View reviewed changes

Disable SIP disablement check

57c7b6a

henrymercer dismissed esbena’s stale review via 57c7b6a October 28, 2025 12:35

github-actions Bot added size/S Should be easy to review and removed size/XS Should be very easy to review labels Oct 28, 2025

mbg previously approved these changes Oct 28, 2025

View reviewed changes

Add unit test for checkDiskUsage

fe16891

henrymercer dismissed mbg’s stale review via fe16891 October 28, 2025 12:40

Stub GITHUB_WORKSPACE in test

55895ef

mbg previously approved these changes Oct 28, 2025

View reviewed changes

Tweak assertions

d4ba404

henrymercer dismissed mbg’s stale review via d4ba404 October 28, 2025 12:50

mbg previously approved these changes Oct 28, 2025

View reviewed changes

Comment thread src/util.test.ts Resolved

henrymercer added 2 commits October 28, 2025 15:04

Apply suggestion

66459ea

Merge branch 'main' into henrymercer/disk-usage-node-api

4256e2e

henrymercer dismissed mbg’s stale review via 4256e2e October 28, 2025 15:05

henrymercer requested a review from mbg October 28, 2025 15:06

henrymercer enabled auto-merge October 28, 2025 15:06

mbg approved these changes Oct 28, 2025

View reviewed changes

henrymercer merged commit e1c8976 into main Oct 28, 2025

henrymercer deleted the henrymercer/disk-usage-node-api branch October 28, 2025 15:24

This was referenced Oct 30, 2025

Merge main into releases/v4 #3252

Merged

Merge releases/v4 into releases/v3 #3254

Merged

+                  const blockSizeInBytes = diskUsage.bsize;
+                  const numBlocksPerMb = (1024 * 1024) / blockSizeInBytes;
+                  const numBlocksPerGb = (1024 * 1024 * 1024) / blockSizeInBytes;
+                  if (diskUsage.bavail < 2 * numBlocksPerGb) {

+                    numTotalBytes: diskUsage.blocks * blockSizeInBytes,
                   };
                 } catch (error) {
                   logger.warning(

+                t.true(
+                  diskUsage?.numAvailableBytes !== undefined &&
+                    diskUsage.numAvailableBytes > 0,
+                );
+                t.true(diskUsage?.numTotalBytes !== undefined && diskUsage.numTotalBytes > 0);

Check disk usage using Node.js API by henrymercer · Pull Request #3247 · github/codeql-action · GitHub

Repository navigation

Check disk usage using Node.js API - #3247

Check disk usage using Node.js API#3247
henrymercer merged 7 commits into
mainfrom
henrymercer/disk-usage-node-api

henrymercer commented Oct 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

esbena Oct 28, 2025

Uh oh!

esbena left a comment

Uh oh!

henrymercer commented Oct 28, 2025

Uh oh!

mbg left a comment

Uh oh!

mbg Oct 28, 2025

Uh oh!

henrymercer Oct 28, 2025

Uh oh!

mbg Oct 28, 2025

Uh oh!

Uh oh!

mbg left a comment

Uh oh!

mbg Oct 28, 2025

Uh oh!

henrymercer Oct 28, 2025

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Check disk usage using Node.js API by henrymercer · Pull Request #3247 · github/codeql-action · GitHub

Repository navigation

Check disk usage using Node.js API - #3247

Check disk usage using Node.js API#3247henrymercer merged 7 commits intomaingithub/codeql-action:mainfrom henrymercer/disk-usage-node-apigithub/codeql-action:henrymercer/disk-usage-node-apiCopy head branch name to clipboard

Conversation

henrymercer commented Oct 28, 2025

Risk assessment

Which use cases does this change impact?

How did/will you validate this change?

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?

Merge / deployment checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

esbena Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

esbena left a comment

Choose a reason for hiding this comment

Uh oh!

henrymercer commented Oct 28, 2025

Uh oh!

mbg left a comment

Choose a reason for hiding this comment

Uh oh!

mbg Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

henrymercer Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

mbg Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mbg left a comment

Choose a reason for hiding this comment

Uh oh!

mbg Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

henrymercer Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Check disk usage using Node.js API#3247
henrymercer merged 7 commits into
mainfrom
henrymercer/disk-usage-node-api