readFileSync should return a Buffer instead of Uint8Array

[borkdude]

Repro:

index.mjs

import { readFileSync } from 'fs'

console.log(readFileSync('index.cljs').toString())

index.cljs:

(defn foo []
  (prn :hello))

(foo)

On Node, this prints the contents of index.mjs as text. On bun it prints a bunch of numbers.

See https://github.com/babashka/nbb/blob/main/doc/bun.md for more context on this.

[borkdude]

I realize that I maybe should not use toString on the buffer, but use utf-8 as the encoding argument. TIL!

[borkdude]

Yep, I was able to work around this using an explicit encoding.

[blackmann]

Please remember to close this issue if you're good

[borkdude]

I think it would still be good to fix for Node compatibility?

On Wed, 6 Jul 2022 at 13:34, Degreat ***@***.***> wrote: Please remember to close this issue if you're good — Reply to this email directly, view it on GitHub <https://github.com/Jarred-Sumner/bun/issues/256#issuecomment-1176112951>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACFSBSI5BMTGWKGIZSVOLLVSVVNJANCNFSM52ZBLGGA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- https://www.michielborkent.nl https://www.eetvoorjeleven.nu

[SheetJSDev]

The underlying issue is that readFileSync returns a Buffer in NodeJS but currently returns a Uint8Array in Bun:

% cat > bun.mjs <<EOF
import { readFileSync } from 'fs';
console.log(Buffer.isBuffer(readFileSync('bun.mjs')));
EOF

% node bun.mjs     
true
% bun bun.mjs     
false

Explicitly converting to a Buffer "just works" in Node and Bun:

import { readFileSync } from 'fs';
const rFS = path => Buffer.from(readFileSync(path));
console.log(rFS('index.cljs').toString());

Looking at the roadmap https://github.com/Jarred-Sumner/bun/issues/159 , fs hopefully will be changed once Buffer is in a good spot

[Electroid]

Yes we should fix this! Thanks @SheetJSDev and @borkdude for reproducing the issue, we're tracking it.

[Jarred-Sumner]

This has been fixed