Feature Request: Allow passing in the Require / or actual loaded "better_sqlite.node"

[NathanaelA]

This is similar to #866 & #126
When webpacking (or in my case Rollup) and then the "bindings.js" attempts to look in the completely wrong location. I have found a hack that I think might be a better feature in the better-sqlite than me manually adding the code to the better-sqlite.

So here is the issue, I have the better_sqlite3.node copied to an extracted location in my electron application, however rollup (& webpack) replaces the "require" with their own require making it impossible for me to use the nativeBinding to point to it because a require just uses the replaced call. However, if replace

better-sqlite3/lib/database.js

Lines 49 to 51 in 37b7714

	} else {
	addon = require(path.resolve(nativeBindingPath).replace(/(\.node)?$/, '.node'));
	}

the call inside the lib/database file with:

    const create = nodeModule.createRequire || nodeModule.createRequireFromPath;
    const requireMe = create(  require("node:url").pathToFileURL(__filename).href  );
     addon = requireMe(path.resolve(nativeBindingPath).replace(/(\.node)?$/, '.node'));

Then I can create my own "require" call that actually calls the normal node/electron require statement. (Webpack has I believe a __non_webpack_require__ (I think it is called this) function which is the way you can access it in webpack). And you can also sometimes get access to it via global.require, etc...

Now the feature idea or request is to allow me to pass in the require function call you will use for the nativeBinding OR to allow me to manually load the binding myself and pass it in, so that you can just use it.

[JoshuaWise]

options.nativeBinding already exists.

[NathanaelA]

@JoshuaWise - Sorry, you misunderstood me. options.nativeBinding is just a path to where the better_sqlite.node file is at. This doesn't help me in this specific set of corner cases. ☹️

The issue I'm running into is:

The require on line 50 of your database.js is actually replaced by webpack/rollup with their own custom require function, so it no longer loads .node files. So even passing in the nativeBinding where the .node file is, is useless in this case. Most the time webpack/rollup are fairly good about not replacing require in cases of loading .node, but the detection seems to be failing on your code base. I can hack around for a few more hours on the rollup config to try and make it work, or I work around it using the node:module class (my example above) to get back a real require command (since webpack & rollup don't mess with this) and I'm done.

So I am proposing a feature added to better-sqlite to either allow me to pass in the actual require command that addon = require(path.resolve(nativeBindingPath).replace(/(\.node)?$/, '.node')); calls. Or I think even better yet, make the code base even simpler and remove the options.nativeBindings) and I can just pass in the addon (maybe called nativeNodeModule?) and I am responsible for loading it, so that I can do whatever "hacks" are needed in my code base rather than inside better-sqlite.

I'm willing to submit a PR for either feature if you are on board. I honestly think the second way (me being responsible to load and pass your code the already loaded better-sqlite.node module), makes the most sense because then the developer can workaround any corner case in any webpacker in the future too in their own code base....

I am aware I can exclude better-sqlite (& bindings & file-uri-to-path) node_modules to make sure I don't get the requires replaced. However, this is exponentially more costly in cpu/disk time. Each disk hit for each of the 14 separate files in better-sqlite, +2 for bindings, +2 for file-uri-to-path the is tremendously more expensive then having it all of those in a single minimized vendor.js packed file.

[NathanaelA]

@JoshuaWise would you prefer a PR for passing in the require statement or the actual already loaded better-sqlite.node file?

I assume if it is require that options.require is fine as the parameter, and if it is the .node file, perhaps options.nativeNodeModule or do you have a better optional parameter?

[mceachen]

Fixed by #974, thanks @destyk!

[NathanaelA]

@mceachen - This DOES NOT fix my issue. PLEASE RE-OPEN.

I'm actually using Vite/Rollup and it replaces the "require" also, but in a different way. The proposal I'm proposing is a lot more generic and not dependent upon which bundler people are using, and totally future safe...

Either allow me to pass in the node "require" function, or I the dev can externally require the .node file and pass it in for usage.. ;-) (I prefer the second method, over the first, but either would solve the issue).

Again, I'm willing to make a PR if you can tell me which way you prefer!

[JoshuaWise]

@NathanaelA After giving this some thought, I think options.nativeBinding could accept a loaded addon object, and it should keep the current behavior if a string is passed to it. If you open a PR we can try to get it merged soon.

I apologize for taking so long to address this issue. Work and life have been quite busy.

[destyk]

@NathanaelA After giving this some thought, I think options.nativeBinding could accept a loaded addon object, and it should keep the current behavior if a string is passed to it. If you open a PR we can try to get it merged soon.

I apologize for taking so long to address this issue. Work and life have been quite busy.

resolved: #974

[SamTV12345]

@NathanaelA I am in the same situation. I need to rollup a library but when I do that and need the sqlite database type it throws the before mentioned error. Is there a workaround or do we have to wait until #974 is merged?