chore(storage): add storage benchmark tool for Gaxios refactor comparison by thiyaguk09 · Pull Request #8341 · googleapis/google-cloud-node

thiyaguk09 · 2026-05-21T07:08:47Z

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18

…otprint against baseline versions

…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18

…4856049-gaxios-benchmark

gemini-code-assist

Code Review

This pull request introduces a new benchmarking tool in handwritten/storage/internal-tooling/benchmark.ts along with updated documentation in the README. The tool enables comparative latency and memory benchmarking between the current codebase and a specified baseline NPM version of @google-cloud/storage. Feedback focuses on improving the robustness of dynamic imports for module compatibility, replacing hardcoded values with constants, enhancing type safety by avoiding any[], and refining the throughput calculation logic.

…xible module resolution

Dhriti07 · 2026-05-25T06:52:08Z

+async function runBenchmark(StorageClass: typeof Storage, name: string, bucketName: string) {
+  // 2. Pass custom project ID to the storage client


Nit: Is this comment required ? What do the numbers on the comment refer to ?

Removed prefix numbers (e.g., // 1., // 2.) from all comments and simplified them to clean, standard developer comments.

Dhriti07 · 2026-05-25T06:54:17Z

+
+| Parameter | Description | Requirement | Default |
+| --------- | ----------- | :---: | :---: |
+| `--project` | Google Cloud Project ID | **Required** | - |


Nit: Can we use projectId as the flag name like the other files in this folder for standardization ?

Changed the --project option in benchmark.ts to --projectid.

Dhriti07 · 2026-05-25T07:00:57Z

+
+  try {
+    // Scenario 1: Upload Small File
+    console.log('Starting Scenario 1: Upload (1KB)...');


Consider dividing this into helper functions for each test scenario.

Extracted individual scenario logic out of the main runBenchmark function into distinct, reusable async helper functions:

runUploadScenario(bucket, content, name, uploadedFiles)

runMetadataScenario(mainFile)

runDownloadScenario(mainFile)

Dhriti07 · 2026-05-25T07:07:36Z

+    logMemory('After Metadata');
+
+    // Scenario 3: Download Small File
+    console.log('Starting Scenario 3: Download (1KB)...');


Is there a reason for only choosing only 1KB file size? Can we make this parameterized for other file sizes as well ?

Are there other operations which are affected by the migration ?
Some possible examples: Large file transfers, Resumable uploads. If yes we should be benchmarking them as well to make sure we do not see any regression in them due to the migration

Is there a reason for only choosing only 1KB file size? Can we make this parameterized for other file sizes as well ?

Introduced the --fileSize option (defaulting to 1024 bytes) in yargs. The file size buffer is now allocated dynamically (Buffer.alloc(argv.fileSize, 'a')), and throughput calculations adapt to the configured file size.

Are there other operations which are affected by the migration ? Some possible examples: Large file transfers, Resumable uploads. If yes we should be benchmarking them as well to make sure we do not see any regression in them due to the migration

Agreed! Our resumable uploads currently only support/rely on Gaxios, so testing this path is crucial. To support better benchmarking here, I've added a --resumable boolean flag option. Under the hood, runUploadScenario passes this flag to the storage iterFile.save(content, { resumable: argv.resumable }) option, enabling targeted performance testing of resumable uploads.

…4856049-gaxios-benchmark

…d resumable uploads while updating transport retry defaults

thiyaguk09 added 8 commits May 19, 2026 09:37

fix(storage): standardize URL formatting and enhance transport retry

a2cd00b

refactor(storage): remove Service.ts and migrate logic to StorageTran…

72c17d7

…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18

feat: add internal benchmarking tool to compare latency and memory fo…

1152fb3

…otprint against baseline versions

fix(benchmark): address PR security, cleanup, and type safety comments

8a8f635

fix(storage): standardize URL formatting and enhance transport retry

8eb2d72

refactor(storage): remove Service.ts and migrate logic to StorageTran…

eacb087

…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18

Merge remote-tracking branch 'upstream/storage-node-18' into chore/34…

05f71d9

…4856049-gaxios-benchmark

Merge remote-tracking branch 'upstream/storage-node-18' into chore/34…

afa53c9

…4856049-gaxios-benchmark

product-auto-label Bot added the api: storage Issues related to the Cloud Storage API. label May 21, 2026

gemini-code-assist Bot reviewed May 21, 2026

View reviewed changes

Comment thread handwritten/storage/internal-tooling/benchmark.ts Outdated

Comment thread handwritten/storage/internal-tooling/benchmark.ts Outdated

Comment thread handwritten/storage/internal-tooling/benchmark.ts Outdated

Comment thread handwritten/storage/internal-tooling/benchmark.ts Outdated

refactor: enhance benchmark tool with configurable file sizes and fle…

c0113c7

…xible module resolution

thiyaguk09 marked this pull request as ready for review May 21, 2026 08:26

thiyaguk09 requested a review from a team as a code owner May 21, 2026 08:26

Dhriti07 reviewed May 25, 2026

View reviewed changes

Dhriti07 requested a review from kalragauri May 25, 2026 07:08

thiyaguk09 force-pushed the storage-node-18 branch from eacb087 to 0c58a9a Compare May 25, 2026 08:43

thiyaguk09 requested a review from a team as a code owner May 25, 2026 08:43

thiyaguk09 added 3 commits May 25, 2026 08:50

Merge remote-tracking branch 'upstream/storage-node-18' into chore/34…

679fe27

…4856049-gaxios-benchmark

Merge remote-tracking branch 'upstream/storage-node-18' into chore/34…

d38bfa9

…4856049-gaxios-benchmark

feat(storage): enhance benchmark tool with configurable file sizes an…

2d093dd

…d resumable uploads while updating transport retry defaults

thiyaguk09 requested a review from Dhriti07 May 25, 2026 16:05

		async function runBenchmark(StorageClass: typeof Storage, name: string, bucketName: string) {
		// 2. Pass custom project ID to the storage client

Conversation

thiyaguk09 commented May 21, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants