Bun support

[Thunderducky]

I tried running the base examples with bun and got segmentation errors when calling window.render.
I suspect it's related to differences in how the buffer is handled.

If there is a way around this/workaround that'd be great!

[kmamal]

@Thunderducky I'd like to support bun eventually, but right now their support for napi modules is not even finished (oven-sh/bun#158) and I am encountering too many weird bugs when trying to run the examples. I'd suggest leaving the issue open and I'll revisit it as bun becomes more stable in the future.

[Thunderducky]

Thank you! Love the library

[pedroth]

I could run a small example with bun

// index.js
import sdl from '@kmamal/sdl'

// Setup
const window = sdl.video.createWindow({ title: "Canvas" })
window.setFullscreen(true);
const { pixelWidth: width, pixelHeight: height } = window
const buffer = Buffer.alloc(width * height * 4).fill(0);
for (let n = 0; n < buffer.length; n += 4) {
    const i = Math.floor(n / (4 * width));
    const j = Math.floor((n / 4) % width);
    const x = j;
    const y = height - 1 - i;
    buffer[n] = Math.min(255, (x / width) * 255);
    buffer[n + 1] = Math.min(255, (y / height) * 255);
    buffer[n + 2] = 0;
    buffer[n + 3] = 255;
}
console.log("debug ", buffer)
window.render(width, height, width * 4, 'rgba32', buffer);

Then ran bun index.js, with bun version 1.0.28.

Great lib btw, thank you @kmamal

[kmamal]

Oh interesting, time to have another look then.

[pedroth]

Just a note here about using bun to install node-sdl:

oven-sh/bun#9220

One needs to add node-sdl as a trustedDependencies, for bun to install.

@Thunderducky @kmamal

[kmamal]

Linking this issue so I can track it easier: oven-sh/bun#9743

[rafaellehmkuhl]

I'm still having a hard time making it work with bun. I'm receiving the following:

build started... (x2)
✓ 1 modules transformed.
dist/electron/preload.js  1.85 kB │ gzip: 0.53 kB
built in 80ms.
✓ 14 modules transformed.
[commonjs--resolver] node_modules/@kmamal/sdl/dist/sdl.node (1:0): Unexpected character '�' (Note that you need plugins to import files that are not JavaScript)
file: .../cockpit/node_modules/@kmamal/sdl/src/javascript/audio/audio-playback-instance.js:1:0
1: ����
      � ��h__TEXT��
   ^
2: __text__TEXT�&���&�__stubs__TEXT...
3: H�
     __stub_helper__TEXT��D
.../cockpit/node_modules/electron/index.js:17
    throw new Error('Electron failed to install correctly, please delete node_modules/electron and try installing again');
          ^

Error: Electron failed to install correctly, please delete node_modules/electron and try installing again
    at getElectronPath (.../cockpit/node_modules/electron/index.js:17:11)
    at Object.<anonymous> (.../cockpit/node_modules/electron/index.js:21:18)

An tip around that would be very appreciated. The reproducible repository/commit is here.

.

PS: if I change to version v0.10.7 (last one before the new changes on January), the error moves from javascript/audio to javascript/joystick:

[commonjs--resolver] node_modules/@kmamal/sdl/dist/sdl.node (1:0): Unexpected character '�' (Note that you need plugins to import files that are not JavaScript)
file: .../cockpit/node_modules/@kmamal/sdl/src/javascript/joystick/joystick-instance.js:1:0

[kmamal]

@rafaellehmkuhl Are you sure that error is specific to bun? It doesn't happen with Nodejs?

It looks to me that you are trying to include the @kmamal/sdl package in some sort of bundle (probably via rollup or electron-packager?) and your bundler is complaining because sdl.node is a binary file it doesn't know how to handle. You should probably look into the "Unexpected character '�' (Note that you need plugins to import files that are not JavaScript)" error.

[rafaellehmkuhl]

@rafaellehmkuhl Are you sure that error is specific to bun? It doesn't happen with Nodejs?

It looks to me that you are trying to include the @kmamal/sdl package in some sort of bundle (probably via rollup or electron-packager?) and your bundler is complaining because sdl.node is a binary file it doesn't know how to handle. You should probably look into the "Unexpected character '�' (Note that you need plugins to import files that are not JavaScript)" error.

Hey @kmamal, thanks for the reply!

I actually tried several things and but in the end it it a problem with Bun indeed.

I have removed every configuration and reinstalled everything with Yarn. It's working like a charm. You can see it here.

The "/sdl.node (1:0): Unexpected character" problem was being caused by how I was importing the library, but it was actually not affecting the usage. The real problem was the "Electron failed to install correctly" one.

I'm considering moving to Yarn, not just because of this problem, but from others that I had already by using Bun, but let me know if you see any alternative solution to make the library run with Bun and Electron.

[Kasparsu]

As of right now I can run examples with bun no problem. But there seems to be an issue when I try to compile it with bun build --compile that it runs into. And I would expect that to be the desired feature for would be developer since bun offers a neat way to package code into single executable.

[rafaellehmkuhl]

As of right now I can run examples with bun no problem. But there seems to be an issue when I try to compile it with bun build --compile that it runs into. And I would expect that to be the desired feature for would be developer since bun offers a neat way to package code into single executable.

I think the problem I'm facing is actually about using node-sdl with Bun+Electron, not just Bun. Or maybe just Electron? I didn't test the lib alone with Electron.

[Kasparsu]

@rafaellehmkuhl I feel like there is something going on with your configs instead it is trying to parse .node file as a js file and that causes the issue.

[rafaellehmkuhl]

@rafaellehmkuhl I feel like there is something going on with your configs instead it is trying to parse .node file as a js file and that causes the issue.

I explained it better on #73, but basically electron-builder was trying to rebuild the binaries. It was a matter of forcing it to skip.