Skip to content

feat(node): support for fs.opendir[Sync] #1521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sam Gammon (sgammon) merged 1 commit into from
Jul 5, 2025
Merged

feat(node): support for fs.opendir[Sync] #1521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 128 additions & 2 deletions packages/graalvm/api/graalvm.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3842,6 +3842,14 @@ public abstract interface class elide/runtime/intrinsics/js/node/WritableFilesys
public abstract fun mkdirSync (Lorg/graalvm/polyglot/Value;)Ljava/lang/String;
public abstract fun mkdirSync (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Ljava/lang/String;
public static synthetic fun mkdirSync$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemAPI;Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/MkdirOptions;ILjava/lang/Object;)Ljava/lang/String;
public abstract fun opendir (Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;Lkotlin/jvm/functions/Function2;)V
public abstract fun opendir (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)V
public static synthetic fun opendir$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemAPI;Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)V
public static synthetic fun opendir$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemAPI;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;ILjava/lang/Object;)V
public abstract fun opendirSync (Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;)Lelide/runtime/node/fs/Directory;
public abstract fun opendirSync (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Lelide/runtime/node/fs/Directory;
public static synthetic fun opendirSync$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemAPI;Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;ILjava/lang/Object;)Lelide/runtime/node/fs/Directory;
public static synthetic fun opendirSync$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemAPI;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;ILjava/lang/Object;)Lelide/runtime/node/fs/Directory;
public abstract fun writeFile (Lelide/runtime/intrinsics/js/node/path/Path;Ljava/lang/String;Lelide/runtime/intrinsics/js/node/fs/WriteFileOptions;Lkotlin/jvm/functions/Function1;)V
public abstract fun writeFile (Lelide/runtime/intrinsics/js/node/path/Path;[BLelide/runtime/intrinsics/js/node/fs/WriteFileOptions;Lkotlin/jvm/functions/Function1;)V
public abstract fun writeFile (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)V
Expand All @@ -3865,6 +3873,10 @@ public abstract interface class elide/runtime/intrinsics/js/node/WritableFilesys
public abstract fun mkdir (Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun mkdir (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/JsPromise;
public static synthetic fun mkdir$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemPromiseAPI;Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/MkdirOptions;ILjava/lang/Object;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun opendir (Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun opendir (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/JsPromise;
public static synthetic fun opendir$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemPromiseAPI;Lelide/runtime/intrinsics/js/node/path/Path;Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;ILjava/lang/Object;)Lelide/runtime/intrinsics/js/JsPromise;
public static synthetic fun opendir$default (Lelide/runtime/intrinsics/js/node/WritableFilesystemPromiseAPI;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;ILjava/lang/Object;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun writeFile (Lelide/runtime/intrinsics/js/node/path/Path;Ljava/lang/Object;Lelide/runtime/intrinsics/js/node/fs/WriteFileOptions;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun writeFile (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/JsPromise;
public abstract fun writeFile (Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/JsPromise;
Expand Down Expand Up @@ -4597,10 +4609,25 @@ public final class elide/runtime/intrinsics/js/node/events/RemoveEventListenerOp
public final fun getDEFAULTS ()Lelide/runtime/intrinsics/js/node/events/RemoveEventListenerOptions;
}

public abstract interface class elide/runtime/intrinsics/js/node/fs/Dir {
public abstract interface class elide/runtime/intrinsics/js/node/fs/Dir : elide/runtime/interop/ReadOnlyProxyObject, java/lang/AutoCloseable, org/graalvm/polyglot/proxy/ProxyIterable {
public abstract fun close (Lkotlin/jvm/functions/Function0;)V
public abstract fun close (Lorg/graalvm/polyglot/Value;)V
public abstract fun closeSync ()V
public abstract fun getPath ()Ljava/lang/String;
public abstract fun read (Lorg/graalvm/polyglot/Value;)V
public abstract fun readSync ()Lelide/runtime/intrinsics/js/node/fs/Dirent;
}

public abstract interface class elide/runtime/intrinsics/js/node/fs/Dirent {
public abstract interface class elide/runtime/intrinsics/js/node/fs/Dirent : elide/runtime/interop/ReadOnlyProxyObject {
public abstract fun getName ()Ljava/lang/String;
public abstract fun getParentPath ()Ljava/lang/String;
public abstract fun isBlockDevice ()Z
public abstract fun isCharacterDevice ()Z
public abstract fun isDirectory ()Z
public abstract fun isFIFO ()Z
public abstract fun isFile ()Z
public abstract fun isSocket ()Z
public abstract fun isSymbolicLink ()Z
}

public abstract interface class elide/runtime/intrinsics/js/node/fs/FSWatcher {
Expand Down Expand Up @@ -4631,6 +4658,30 @@ public final class elide/runtime/intrinsics/js/node/fs/MkdirOptions$Companion {
public final fun getDEFAULTS ()Lelide/runtime/intrinsics/js/node/fs/MkdirOptions;
}

public final class elide/runtime/intrinsics/js/node/fs/OpenDirOptions {
public static final field Companion Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions$Companion;
public fun <init> ()V
public fun <init> (Ljava/lang/Object;Ljava/lang/Integer;Z)V
public synthetic fun <init> (Ljava/lang/Object;Ljava/lang/Integer;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()Ljava/lang/Object;
public final fun component2 ()Ljava/lang/Integer;
public final fun component3 ()Z
public final fun copy (Ljava/lang/Object;Ljava/lang/Integer;Z)Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;
public static synthetic fun copy$default (Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;Ljava/lang/Object;Ljava/lang/Integer;ZILjava/lang/Object;)Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;
public fun equals (Ljava/lang/Object;)Z
public static final fun from (Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;
public final fun getBufferSize ()Ljava/lang/Integer;
public final fun getEncoding ()Ljava/lang/Object;
public final fun getRecursive ()Z
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class elide/runtime/intrinsics/js/node/fs/OpenDirOptions$Companion {
public final fun from (Lorg/graalvm/polyglot/Value;)Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;
public final fun getDEFAULTS ()Lelide/runtime/intrinsics/js/node/fs/OpenDirOptions;
}

public final class elide/runtime/intrinsics/js/node/fs/ReadFileOptions {
public static final field Companion Lelide/runtime/intrinsics/js/node/fs/ReadFileOptions$Companion;
public fun <init> ()V
Expand Down Expand Up @@ -8162,6 +8213,81 @@ public synthetic class elide/runtime/node/fs/$VfsInitializerListener$Definition
public fun load ()Lio/micronaut/inject/BeanDefinition;
}

public final class elide/runtime/node/fs/Directory : elide/runtime/intrinsics/js/node/fs/Dir {
public static final field Factory Lelide/runtime/node/fs/Directory$Factory;
public synthetic fun <init> (Ljava/io/File;Ljava/lang/String;Ljava/nio/file/DirectoryStream;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public fun close ()V
public fun close (Lkotlin/jvm/functions/Function0;)V
public fun close (Lorg/graalvm/polyglot/Value;)V
public fun closeSync ()V
public synthetic fun getIterator ()Ljava/lang/Object;
public fun getIterator ()Lorg/graalvm/polyglot/proxy/ProxyIterator;
public fun getMember (Ljava/lang/String;)Ljava/lang/Object;
public synthetic fun getMemberKeys ()Ljava/lang/Object;
public fun getMemberKeys ()[Ljava/lang/String;
public fun getPath ()Ljava/lang/String;
public static final fun of (Ljava/io/File;Ljava/nio/file/Path;)Lelide/runtime/node/fs/Directory;
public fun read (Lorg/graalvm/polyglot/Value;)V
public fun readSync ()Lelide/runtime/intrinsics/js/node/fs/Dirent;
public static final fun wrap (Ljava/io/File;Ljava/nio/file/DirectoryStream;)Lelide/runtime/node/fs/Directory;
}

public final class elide/runtime/node/fs/Directory$Factory : org/graalvm/polyglot/proxy/ProxyInstantiable {
public fun newInstance ([Lorg/graalvm/polyglot/Value;)Ljava/lang/Object;
public final fun of (Ljava/io/File;Ljava/nio/file/Path;)Lelide/runtime/node/fs/Directory;
public final fun wrap (Ljava/io/File;Ljava/nio/file/DirectoryStream;)Lelide/runtime/node/fs/Directory;
}

public abstract interface class elide/runtime/node/fs/DirectoryEntry : elide/runtime/intrinsics/js/node/fs/Dirent {
public static final field Factory Lelide/runtime/node/fs/DirectoryEntry$Factory;
public static fun forFile (Ljava/io/File;)Lelide/runtime/node/fs/DirectoryEntry$FileEntry;
public static fun forPath (Ljava/nio/file/Path;)Lelide/runtime/node/fs/DirectoryEntry$PathEntry;
public fun getMember (Ljava/lang/String;)Ljava/lang/Object;
public synthetic fun getMemberKeys ()Ljava/lang/Object;
public fun getMemberKeys ()[Ljava/lang/String;
}

public final class elide/runtime/node/fs/DirectoryEntry$Factory : org/graalvm/polyglot/proxy/ProxyInstantiable {
public final fun forFile (Ljava/io/File;)Lelide/runtime/node/fs/DirectoryEntry$FileEntry;
public final fun forPath (Ljava/nio/file/Path;)Lelide/runtime/node/fs/DirectoryEntry$PathEntry;
public fun newInstance ([Lorg/graalvm/polyglot/Value;)Ljava/lang/Object;
}

public final class elide/runtime/node/fs/DirectoryEntry$FileEntry : elide/runtime/node/fs/DirectoryEntry {
public synthetic fun <init> (Ljava/io/File;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun getFile ()Ljava/io/File;
public fun getName ()Ljava/lang/String;
public fun getParentPath ()Ljava/lang/String;
public fun isBlockDevice ()Z
public fun isCharacterDevice ()Z
public fun isDirectory ()Z
public fun isFIFO ()Z
public fun isFile ()Z
public fun isSocket ()Z
public fun isSymbolicLink ()Z
public static final fun of (Ljava/io/File;)Lelide/runtime/node/fs/DirectoryEntry$FileEntry;
}

public final class elide/runtime/node/fs/DirectoryEntry$PathEntry : elide/runtime/node/fs/DirectoryEntry {
public synthetic fun <init> (Ljava/nio/file/Path;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public fun getName ()Ljava/lang/String;
public fun getParentPath ()Ljava/lang/String;
public final fun getPath ()Ljava/nio/file/Path;
public fun isBlockDevice ()Z
public fun isCharacterDevice ()Z
public fun isDirectory ()Z
public fun isFIFO ()Z
public fun isFile ()Z
public fun isSocket ()Z
public fun isSymbolicLink ()Z
public static final fun of (Ljava/nio/file/Path;)Lelide/runtime/node/fs/DirectoryEntry$PathEntry;
}

public final class elide/runtime/node/fs/DirectoryEntryKt {
public static final fun asDirectoryEntry (Ljava/io/File;)Lelide/runtime/node/fs/DirectoryEntry$FileEntry;
public static final fun asDirectoryEntry (Ljava/nio/file/Path;)Lelide/runtime/node/fs/DirectoryEntry$PathEntry;
}

public final class elide/runtime/node/fs/VfsInitializerListener : elide/runtime/plugins/vfs/VfsListener, java/util/function/Supplier {
public fun <init> ()V
public fun get ()Lelide/runtime/vfs/GuestVFS;
Expand Down
2 changes: 1 addition & 1 deletion packages/graalvm/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,6 @@ graalvmNative {
classpath(tasks.compileJava, tasks.compileKotlin, configurations.nativeImageClasspath)

buildArgs(sharedLibArgs.plus(listOf(
// "-H:LayerUse=${baseLayer.get().asFile.absolutePath}",
"-H:LayerCreate=${layerOut.get().asFile.name}"
)))
}
Expand All @@ -432,6 +431,7 @@ graalvmNative {
fallback = false
sharedLibrary = false
quickBuild = true
jvmArgs("-Dpolyglot.engine.WarnInterpreterOnly=false")
buildArgs(sharedLibArgs.plus(testLibArgs).plus(listOf(
"--features=org.graalvm.junit.platform.JUnitPlatformFeature",
)))
Expand Down
77 changes: 76 additions & 1 deletion packages/graalvm/src/main/kotlin/elide/runtime/intrinsics/js/node/FilesystemAPI.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 Elide Technologies, Inc.
* Copyright (c) 2024-2025 Elide Technologies, Inc.
*
* Licensed under the MIT license (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
Expand All @@ -17,6 +17,7 @@ import java.nio.file.AccessMode
import elide.annotations.API
import elide.runtime.intrinsics.js.node.fs.*
import elide.runtime.intrinsics.js.node.path.Path
import elide.runtime.node.fs.Directory
import elide.vm.annotations.Polyglot

/**
Expand Down Expand Up @@ -512,6 +513,80 @@ import elide.vm.annotations.Polyglot
* @param dest The destination path to copy to.
*/
@Polyglot public fun copyFileSync(src: Value, dest: Value)

/**
* ## Method: `fs.opendir`
*
* Asynchronously open a directory at the provided [path], employing the provided [options]; a `Dir` instance is
* passed to the provided [callback] for directory operations.
*
* From the Node.js docs:
* "Asynchronously open a directory. See the POSIX `opendir(3)` documentation for more details. Creates an `fs.Dir`,
* which contains all further functions for reading from and cleaning up the directory. The `encoding` option sets the
* encoding for the path while opening the directory and subsequent read operations."
*
* This method variant is meant for implementation and host-side dispatch.
*
* @param path Path to the directory to open.
* @param options Options to apply to the operation.
* @param callback Callback function to invoke with the directory iterator.
*/
@Polyglot public fun opendir(path: Path, options: OpenDirOptions = OpenDirOptions.DEFAULTS, callback: OpenDirCallback)

/**
* ## Method: `fs.opendir`
*
* Asynchronously open a directory at the provided [path], employing the provided [options]; a `Dir` instance is
* passed to the provided [callback] for directory operations.
*
* From the Node.js docs:
* "Asynchronously open a directory. See the POSIX `opendir(3)` documentation for more details. Creates an `fs.Dir`,
* which contains all further functions for reading from and cleaning up the directory. The `encoding` option sets the
* encoding for the path while opening the directory and subsequent read operations."
*
* This method variant is meant for guest-side dispatch.
*
* @param path Path to the directory to open.
* @param options Options to apply to the operation.
* @param callback Callback function to invoke with the directory iterator.
*/
@Polyglot public fun opendir(path: Value, options: Value? = null, callback: Value)

/**
* ## Method: `fs.opendirSync`
*
* Synchronously open a directory at the provided [path], employing the provided [options].
*
* From the Node.js docs:
* "Synchronously open a directory. See `opendir(3)`. Creates an `fs.Dir`, which contains all further functions for
* reading from and cleaning up the directory. The encoding option sets the encoding for the path while opening the
* directory and subsequent read operations."
*
* This method variant is meant for implementation and host-side dispatch.
*
* @param path Path to the directory to open.
* @param options Options to apply to the operation.
* @return [Directory] handle instance.
*/
@Polyglot public fun opendirSync(path: Path, options: OpenDirOptions = OpenDirOptions.DEFAULTS): Directory

/**
* ## Method: `fs.opendirSync`
*
* Synchronously open a directory at the provided [path], employing the provided [options], if any.
*
* From the Node.js docs:
* "Synchronously open a directory. See `opendir(3)`. Creates an `fs.Dir`, which contains all further functions for
* reading from and cleaning up the directory. The encoding option sets the encoding for the path while opening the
* directory and subsequent read operations."
*
* This method variant is meant for guest-side dispatch.
*
* @param path Path to the directory to open.
* @param options Options to apply to the operation.
* @return [Directory] handle instance.
*/
@Polyglot public fun opendirSync(path: Value, options: Value? = null): Directory
}

/**
Expand Down
24 changes: 23 additions & 1 deletion packages/graalvm/src/main/kotlin/elide/runtime/intrinsics/js/node/FilesystemPromiseAPI.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 Elide Technologies, Inc.
* Copyright (c) 2024-2025 Elide Technologies, Inc.
*
* Licensed under the MIT license (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
Expand Down Expand Up @@ -341,6 +341,28 @@ import elide.vm.annotations.Polyglot
* @return Upon success, fulfills with `undefined`; otherwise, rejects with an error.
*/
@Polyglot public fun copyFile(src: Value, dest: Value, mode: Int): JsPromise<Value>

/**
* ## Method: `fs.opendir`
*
* Asynchronously opens a directory for the streaming of entries.
*
* @param path Path to the directory to stream entries for.
* @param options Options to apply to the operation.
* @return Upon success, fulfills with an instance of [Dir]; otherwise, errors.
*/
public fun opendir(path: Path, options: OpenDirOptions? = null): JsPromise<Dir>

/**
* ## Method: `fs.opendir`
*
* Asynchronously opens a directory for the streaming of entries.
*
* @param path Path to the directory to stream entries for.
* @param options Options to apply to the operation.
* @return Upon success, fulfills with an instance of [Dir]; otherwise, errors.
*/
@Polyglot public fun opendir(path: Value, options: Value? = null): JsPromise<Dir>
}

/**
Expand Down
43 changes: 40 additions & 3 deletions packages/graalvm/src/main/kotlin/elide/runtime/intrinsics/js/node/fs/Dir.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 Elide Technologies, Inc.
* Copyright (c) 2024-2025 Elide Technologies, Inc.
*
* Licensed under the MIT license (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
Expand All @@ -12,10 +12,47 @@
*/
package elide.runtime.intrinsics.js.node.fs

import org.graalvm.polyglot.Value
import org.graalvm.polyglot.proxy.ProxyIterable
import elide.annotations.API
import elide.runtime.interop.ReadOnlyProxyObject
import elide.vm.annotations.Polyglot

/**
*
* ## Node Filesystem: Directory
*/
@API public interface Dir {
@API public interface Dir : AutoCloseable, ProxyIterable, ReadOnlyProxyObject {
/**
* Public access to the original path used to create this instance.
*/
@get:Polyglot public val path: String

/**
* Close the underlying resource for this directory instance, and then invoke the provided [callback].
*
* @param callback Callback to invoke after closing
*/
@Polyglot public fun close(callback: Value)

/**
* Close the underlying resource for this directory instance, and then invoke the provided [callback].
*
* @param callback Callback to invoke after closing
*/
public fun close(callback: () -> Unit)

/**
* Synchronously close underlying file resources.
*/
@Polyglot public fun closeSync()

/**
* Asynchronously read the next directory entry via `readdir(3)` as an instance of [Dirent].
*/
@Polyglot public fun read(callback: Value)

/**
* Synchronously read the next directory entry as an instance of [Dirent].
*/
@Polyglot public fun readSync(): Dirent?
}
Loading
Loading