electron-rebuild problems with MagicMirror 2.22.0

KristjanESPERANTO

The problems on my machine are obviously of a different nature. I’ll investigate that later.

For the original issue it should be worth using @electron/rebuild instead of magicmirror-rebuild or electron-rebuild. I tested it in a virtual machine and it works great. Here is my solution which is less invasive:
https://github.com/Tom-Hirschberger/MMM-GPIO-Notifications/pull/7

What do you think?

sdetweil

@KristjanESPERANTO my postinstall script uses electron-rebuild

his development branch

KristjanESPERANTO

Yes, but @electron/rebuild is the successor of electron-rebuild. And the “trick” in the postinstall script seems not necessary at all.

wishmaster270

@KristjanESPERANTO

Hi and thank you for contributing. I confirm that changing to magicmirror-rebuild did not make things batter but worse. I now followed the suggestion of @sdetweil and implemented his postinstall script. Things are working perfectly now and should work in future releases, too.

I merged the new changes to the master a few minutes ago and released version 0.0.7 of MMM-GPIO-Notifications. I will implement this approach in my other modules, too.

KristjanESPERANTO

@wishmaster270 OK, you’re welcome.

Since the thread is also for other developers: I recommend considering my approach, as I consider the other approach (installing to a higher-level directory) to be more error-prone. But it’s a creative workaround.

wishmaster270

@KristjanESPERANTO
The problem with installing it in the module directory is that we need to compile the library against the electron version installed in the MagicMirror project.
If electron-rebuild is installed in the module directory it might fail to detect the right electron version (which was the cause of the rebuild problems in the past).
So the right way is to install electron-rebuild in the same project as electron and call it from there.

It might be worth to think about adding it as a dependency in the main project.

KristjanESPERANTO

@wishmaster270 Okay, thanks for the explanation! I haven’t been able to read that anywhere in such clear words and I haven’t dealt with the past problems. Then I withdraw my recommendation because I lack the overview.

sdetweil

@KristjanESPERANTO ah I see

haven’t heard of @electron/rebuild

karsten13

@wishmaster270 said in electron-rebuild problems with MagicMirror 2.22.0:

So the right way is to install electron-rebuild in the same project as electron and call it from there.

installing module stuff in the node_modules folder of mm is a hack and will not work out of the box with a docker setup because this folder is only in the container (you have to map it on the host to get changes there persistent)

It might be worth to think about adding it as a dependency in the main project.

in this case may the best solution

sdetweil

@karsten13 yes, that’s what I think we come to but doesn’t help any existing broken modules

sdetweil

@karsten13 docker is a pita with this stuff. too much/not enough in the container. which is supposed to be immutable.

KristjanESPERANTO

@sdetweil As a soft step, the broken modules could switch to @electron/rebuild. This should also work for docker.

wishmaster270

@KristjanESPERANTO

I have a docker installation running for development here on my notebook.
Everytime a module needs “npm install” I exec to the container and run the command in the container cause there will be called the correct npm and node version in the container and not the ones I currently use on my notebook.
In this case the directory structure is the same as with a locally installed MagicMirror and the postinstall script will work as excepted.

karsten13

@wishmaster270 said in electron-rebuild problems with MagicMirror 2.22.0:

and the postinstall script will work as excepted.

yes, will work, but all the changes in the node_modules folder of mm are gone with the next restart of the container …

wishmaster270

@karsten13
In case of electron-rebuild this is no problem as it is only required during compile but not at runtime.

karsten13

@wishmaster270

o.k., but where are the compile results stored?

wishmaster270

@karsten13
They are stored in the node_modules folder of the module which should be persistent

Edit: Do not misunderstand me. In my opinion the best way to solve the electron-rebuild problems of a lot of modules would be to put “@electron/rebuild” as a dependency to “package.json” of MagicMirror.

karsten13

@wishmaster270 said in electron-rebuild problems with MagicMirror 2.22.0:

@karsten13
They are stored in the node_modules folder of the module which should be persistent

thats good, so the construction with installing electron-rebuild in mm folder has no side effects and works also in a docker setup.

karsten13

@wishmaster270 said in electron-rebuild problems with MagicMirror 2.22.0:

Edit: Do not misunderstand me. In my opinion the best way to solve the electron-rebuild problems of a lot of modules would be to put “@electron/rebuild” as a dependency to “package.json” of MagicMirror.

I don’t have a final opinion on that yet, but if so, we should put it under optionalDependencies as electron

wishmaster270

@karsten13

You are right. I think optionalDependencies would be a great solution. Module developers could then add a hint to run npm ci in the MagicMirror directory to their installations instructions.

As the container it self is untouched it should be no problem. It only causes @electron/rebuild to be installed the next time the script is called.