Platform: add sync (fsync) (#4345)

Effect-TS · Feb 1, 2025 · c9175ae · c9175ae
1 parent e374d94
commit c9175ae
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/spicy-pumas-kneel.md b/.changeset/spicy-pumas-kneel.md
@@ -0,0 +1,6 @@
+---
+"@effect/platform-node-shared": patch
+"@effect/platform": patch
+---
+
+Addition of `sync` property to `FileSystem.File` representing the `fsync` syscall.
diff --git a/packages/platform-node-shared/src/internal/fileSystem.ts b/packages/platform-node-shared/src/internal/fileSystem.ts
@@ -210,6 +210,12 @@ const makeFile = (() => {
     handleBadArgument("truncate")
   )
 
+  const nodeSync = effectify(
+    NFS.fsync,
+    handleErrnoException("FileSystem", "sync"),
+    handleBadArgument("sync")
+  )
+
   const nodeWriteFactory = (method: string) =>
     effectify(
       NFS.write,
@@ -236,6 +242,10 @@ const makeFile = (() => {
       return Effect.map(nodeStat(this.fd), makeFileInfo)
     }
 
+    get sync() {
+      return nodeSync(this.fd)
+    }
+
     seek(offset: FileSystem.SizeInput, from: FileSystem.SeekMode) {
       const offsetSize = FileSystem.Size(offset)
       return this.semaphore.withPermits(1)(

diff --git a/packages/platform/src/FileSystem.ts b/packages/platform/src/FileSystem.ts
@@ -491,6 +491,7 @@ export interface File {
   readonly fd: File.Descriptor
   readonly stat: Effect.Effect<File.Info, PlatformError>
   readonly seek: (offset: SizeInput, from: SeekMode) => Effect.Effect<void>
+  readonly sync: Effect.Effect<void, PlatformError>
   readonly read: (buffer: Uint8Array) => Effect.Effect<Size, PlatformError>
   readonly readAlloc: (size: SizeInput) => Effect.Effect<Option<Uint8Array>, PlatformError>
   readonly truncate: (length?: SizeInput) => Effect.Effect<void, PlatformError>