feat(bytesRead-to-bytesWritten): implement Node.js DEP0108 migration #224

Eliekhoury17 · 2025-10-06T09:02:52Z

This pull request implements the codemod to replace deprecated zlib.bytesRead
with zlib.bytesWritten in Node.js transform streams, addressing DEP0108 (#196).

Changes included:

Updated the codemod workflow to track zlib stream variables and function parameters.
Added tests for assigned variables, destructured imports, and trackStreamProgress.
Updated README.md and package.json metadata.
Ensured all tracked usages of .bytesRead are replaced correctly.

This PR is part of the feature branch feat/bytesread-to-bytesWritten.

…dejs#196)

AugustinMauroy

WOW good for first issue 🎉, there are some thing to adjust but on logic/approach it's good for me.
The readme is cool IMO.

There are a missing part which is the dynamic import (also missing on the issue spec my bad 😅).
@brunocroh for that do the resolve binding already work with dynamic import ?

// In CommonJS

async function main() {
    const zlib = await import("node:zlib");

    const gzip = zlib.createGzip();
    const processed = gzip.bytesWritten;
}

main();

// or in ESM
const zlib = await import("node:zlib");

const gzip = zlib.createGzip();
const processed = gzip.bytesWritten;

for the red ci you just have to resolve the new npm workspace on the monorepo for that just run npm I 👍

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

Copilot

Pull Request Overview

This PR implements a Node.js codemod to migrate from the deprecated zlib.bytesRead property to zlib.bytesWritten as part of DEP0108 deprecation handling. The codemod automatically transforms zlib stream usage across various import patterns and variable declarations.

Implements comprehensive AST transformation logic to track zlib stream variables and replace deprecated property access
Adds extensive test coverage for different import patterns (CommonJS, ESM, destructured, dynamic) and variable declarations
Includes documentation and package configuration for the new codemod

Reviewed Changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/workflow.ts	Core transformation logic with import tracking, variable resolution, and property replacement
workflow.yaml	Workflow configuration defining the AST transformation step
tests/input/*.js	Test input files covering various zlib usage patterns
tests/expected/*.js	Expected transformation outputs for test validation
package.json	Package metadata and dependencies for the codemod
codemod.yaml	Codemod registry configuration and metadata
README.md	Documentation with examples and usage instructions

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

recipes/zlib-bytesread-to-byteswritten/workflow.yaml

recipes/zlib-bytesread-to-byteswritten/README.md

Co-authored-by: Copilot <[email protected]>

Co-authored-by: Augustin Mauroy <[email protected]>

AugustinMauroy

Wow impressive. That nice some small review

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

Co-authored-by: Augustin Mauroy <[email protected]>

AugustinMauroy

WOW impressive first contribution. For me everything is covered.

I hope you enjoyed this contribution.

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

JakobJingleheimer

LGTM 🙌

JakobJingleheimer · 2025-10-06T20:26:04Z

recipes/zlib-bytesread-to-byteswritten/README.md

+Before:
+
+```js
+const zlib = require("node:zlib");
+const gzip = zlib.createGzip();
+gzip.on("end", () => {
+  console.log("Bytes processed:", gzip.bytesRead);
+});
+```
+
+After:
+
+```js
+const zlib = require("node:zlib");
+const gzip = zlib.createGzip();
+gzip.on("end", () => {
+  console.log("Bytes processed:", gzip.bytesWritten);
+});
+```


@alexbit-codemod what was the verdict about diff fenced blocks?

@JakobJingleheimer FYI I asked for that on codemod slack

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

Co-authored-by: Jacob Smith <[email protected]>

brunocroh

I think this code can be simplified using our utilities, and using more specific kinds at AST-grep rules.

I created this patch, please let me know what you think about it @Eliekhoury17
https://gist.github.com/brunocroh/7723a63af5b0f25f0f98d4475166f663

Eliekhoury17 · 2025-10-07T17:35:47Z

Okay I'm looking at it now to use your utilities and simplify the code.

brunocroh · 2025-10-07T17:41:40Z

Okay I'm looking at it now to use your utilities and simplify the code.

I just noticed that patch is applying a lot of code formatting changes. This happens because the previous code didn’t follow our Biome formatting rules. If you want me to create a new one without these style changes, let me know. (And sorry about that)

By the way, the code will need to be formatted according to our Biome rules before we can merge this PR.

Eliekhoury17 · 2025-10-07T17:45:09Z

Is it possible for you to explain a little bit what the link to the patch contains and what i need to change. I am new in theses things and I'm a little lost here on what to do in the code because i don't see what to do or use. @brunocroh

Eliekhoury17 · 2025-10-07T17:48:29Z

I applied your patch on my code and all the test passes. So do I need to do something else than this or I can commit the changes?

brunocroh · 2025-10-07T17:53:04Z

you to explain a little bit what the link to the patch co

Oh, sorry, you just need to download the file on the link I share, and use git apply name_of_file, and git will apply the changes in the code for you.

brunocroh · 2025-10-07T17:56:48Z

I applied your patch on my code and all the test passes. So do I need to do something else than this or I can commit the changes?

Now you can review it on your side, check if you agree with the changes, make sure everything makes sense to you, and feel free to ask any questions about the differences. You can also fix any mistakes I might have made (for example, update comments, I didn’t touch them, so they might be outdated due to the logic changes).

If the changes make sense, and you agree with them, you can create a new commit and push it for review again.

Feel free to ask any questions you have, I’ll be glad to help! 😊

…lities

Eliekhoury17 · 2025-10-07T18:08:41Z

Now you can review it on your side, check if you agree with the changes, make sure everything makes sense to you, and feel free to ask any questions about the differences. You can also fix any mistakes I might have made (for example, update comments, I didn’t touch them, so they might be outdated due to the logic changes).

If the changes make sense, and you agree with them, you can create a new commit and push it for review again.

Feel free to ask any questions you have, I’ll be glad to help! 😊

Thank you for the explanations :) . I checked everything, added the changes and modified one comment and committed the changes. For me everything looks good.

You can review the commit . @brunocroh

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

…lities

Eliekhoury17 · 2025-10-07T18:57:15Z

I checked everything, added the changes and committed the changes of your last patch and the tests and the code changes are good. For me everything looks good. @brunocroh

Eliekhoury17 · 2025-10-07T19:07:11Z

Is there anything else you want me to do or modify in the code before it can be merged?

brunocroh · 2025-10-07T21:44:17Z

Is there anything else you want me to do or modify in the code before it can be merged?

I think all scenarios are covered. Great work, and thank you for your awesome contribution! 😁

Eliekhoury17 added 3 commits October 6, 2025 10:33

feat(bytesRead-to-bytesWritten): handle Node.js DEP0108 migration (no…

af2bd57

…dejs#196)

Merge branch 'nodejs:main' into feat/bytesread-to-byteswritten

806f4c3

chore(bytesRead-to-bytesWritten): update package name in package.json

62ec425

AugustinMauroy reviewed Oct 6, 2025

View reviewed changes

AugustinMauroy added the awaiting author Reviewer has requested something from the author label Oct 6, 2025

apply code review

5c34494

AugustinMauroy requested a review from Copilot October 6, 2025 12:35

Copilot AI reviewed Oct 6, 2025

View reviewed changes

recipes/zlib-bytesread-to-byteswritten/workflow.yaml Outdated Show resolved Hide resolved

recipes/zlib-bytesread-to-byteswritten/README.md Outdated Show resolved Hide resolved

recipes/zlib-bytesread-to-byteswritten/README.md Outdated Show resolved Hide resolved

Eliekhoury17 and others added 5 commits October 6, 2025 14:42

Update recipes/zlib-bytesread-to-byteswritten/workflow.yaml

5e2c8cf

Co-authored-by: Copilot <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/README.md

e92bac6

Co-authored-by: Copilot <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

847e000

Co-authored-by: Augustin Mauroy <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

7e316ca

Co-authored-by: Augustin Mauroy <[email protected]>

docs/cleanup: clarify import check and fix loop formatting

0909317

AugustinMauroy reviewed Oct 6, 2025

View reviewed changes

Eliekhoury17 and others added 6 commits October 6, 2025 15:23

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

ef52444

Co-authored-by: Augustin Mauroy <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

1cfa52d

Co-authored-by: Augustin Mauroy <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

bb1223d

Co-authored-by: Augustin Mauroy <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

e9df49a

Co-authored-by: Augustin Mauroy <[email protected]>

Update recipes/zlib-bytesread-to-byteswritten/src/workflow.ts

a209d7e

Co-authored-by: Augustin Mauroy <[email protected]>

Apply suggestions from code review

6e18827

Co-authored-by: Augustin Mauroy <[email protected]>

AugustinMauroy approved these changes Oct 6, 2025

View reviewed changes

AugustinMauroy requested a review from a team October 6, 2025 13:33

AugustinMauroy added awaiting reviewer Author has responded and needs action from the reviewer and removed awaiting author Reviewer has requested something from the author labels Oct 6, 2025

brunocroh reviewed Oct 6, 2025

View reviewed changes

chore(zlib-codemod): apply all review feedback

147e783

JakobJingleheimer approved these changes Oct 6, 2025

View reviewed changes

JakobJingleheimer requested a review from brunocroh October 6, 2025 20:47

Eliekhoury17 and others added 2 commits October 7, 2025 08:54

Apply suggestions from code review

5be0912

Co-authored-by: Jacob Smith <[email protected]>

chore(zlib-codemod): apply all review feedback

6d14a43

chore(zlib-codemod): apply all review feedback

e626aab

JakobJingleheimer approved these changes Oct 7, 2025

View reviewed changes

Merge branch 'main' into feat/bytesread-to-byteswritten

89dea38

brunocroh reviewed Oct 7, 2025

View reviewed changes

Eliekhoury17 added 2 commits October 7, 2025 19:57

refactor: apply @brunocroh patch to simplify workflow and use AST uti…

88717b5

…lities

docs: clarify comment to include dynamic imports in zlib transform

0b25d1e

brunocroh reviewed Oct 7, 2025

View reviewed changes

recipes/zlib-bytesread-to-byteswritten/src/workflow.ts Show resolved Hide resolved

refactor: apply @brunocroh patch to simplify workflow and use AST uti…

a20437b

…lities

brunocroh approved these changes Oct 7, 2025

View reviewed changes

brunocroh merged commit 0a41672 into nodejs:main Oct 7, 2025
15 checks passed

Uh oh!

feat(bytesRead-to-bytesWritten): implement Node.js DEP0108 migration #224

feat(bytesRead-to-bytesWritten): implement Node.js DEP0108 migration #224

Conversation

Eliekhoury17 commented Oct 6, 2025

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JakobJingleheimer left a comment

Choose a reason for hiding this comment

Uh oh!

JakobJingleheimer Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

AugustinMauroy Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brunocroh left a comment

Choose a reason for hiding this comment

Uh oh!

Eliekhoury17 commented Oct 7, 2025

Uh oh!

brunocroh commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Eliekhoury17 commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Eliekhoury17 commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brunocroh commented Oct 7, 2025

Uh oh!

brunocroh commented Oct 7, 2025

Uh oh!

Eliekhoury17 commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

brunocroh commented Oct 7, 2025 •

edited

Loading

Eliekhoury17 commented Oct 7, 2025 •

edited

Loading

Eliekhoury17 commented Oct 7, 2025 •

edited

Loading

Eliekhoury17 commented Oct 7, 2025 •

edited

Loading

Eliekhoury17 commented Oct 7, 2025 •

edited

Loading

Eliekhoury17 commented Oct 7, 2025 •

edited

Loading