Node compat: Add path member to fs.Dirent

[NReilingh]

What does this PR do?

This changes the output of fs.readdir({ withFileTypes: true }) (and all of its variants) to be consistent with node, such that the Dirent.name property is the path basename and the Dirent.path property is the path dirname. Fixes #7358. This is a "breaking" change since the Dirent.name property currently contains the full relative path for { recursive: true }.

• Documentation or TypeScript types (it's okay to leave the rest blank in this case)
• Code changes

How did you verify your code works?

I wrote a script at test/dirent.js to manually compare the behavior of node and bun for a mock set of folders, subfolders, and files addressed by different paths. I'm new to this repo and to Zig so I know this isn't idiomatic, but it's the best I could come up with so far.

• I checked the lifetime of memory allocated to verify it's (1) freed and (2) only freed when it should be
• I included a test for the new code, or an existing test covers it
• JSValue used outside outside of the stack is either wrapped in a JSC.Strong or is JSValueProtect'ed
• I wrote TypeScript/JavaScript tests and they pass locally (bun-debug test test-file-name.test)

I'm coming in here with very little systems programming experience, so I did my best to follow any patterns I could find that appeared to be relevant to my changes. For example, I added item.path.deref() anywhere I saw item.name.deref().

• I added TypeScript types for the new methods, getters, or setters

@since parameter on the TS type needs to be populated if/when this is scheduled to a release.

None of my changes seem to affect the behavior of bun repl.

[Jarred-Sumner]

Please add automated tests

This is not an automated test. It won't run in CI.

Have a look at files with .test.js or .test.ts for an exmaple

[NReilingh]

Ah, I now see the readdir tests in test/js/node/fs/fs.test.ts -- is it preferred to add these tests to that same file?

[paperclover]

that sounds like a good place for the test

[NReilingh]

Added some passing tests to test/js/node/fs/fs.test.ts. Ideally I would also test relative paths (i.e. readdir('../..')) for behavior consistent with node, but I'm not sure if it's worthwhile to do so, or what a good approach would be for setting the test's working directory.

[paperclover]

overall looks fine

however path is deprecated in node and they intend to replace it with parentPath

nodejs/node#50976
nodejs/node#51020

we should add both properties, where one is an alias for the other.

[NReilingh]

@paperdave Ah, didn't know about that Node.js deprecation. I made a change so that both path and parentPath work.

[paperclover]

since ???? should be removed

[NReilingh]

Seems like this entire file gets deleted to resolve the merge conflict -- if I'm understanding things correctly, type definitions are now in https://github.com/DefinitelyTyped/DefinitelyTyped per #7670.

[paperclover]

i can update the comment in the code that needs to be changed. looks to go me otherwise

[Jarred-Sumner]

I don't think this should've been approved

We should use a rope string for the path getter. The path getter will rarely be called. As-is, this will be a significant memory usage increase to readdir, which matters when calling it on a large directory tree

To create a rope string, we can use jsRopeString in C++. We would need to add a binding to BunString.cpp that creates a rope string from two different BunString pointers and increment the reference count for the path string.

[NReilingh]

Closing because a different implementation was merged: #11135