`next build` fails with "Module did not self-register." #7894

Vista1nik · 2019-07-11T10:19:49Z

Bug report

Describe the bug

next build fails with following error after upgrade to Next 9.

{ Error: Module did not self-register.
    at Object.Module._extensions..node (internal/modules/cjs/loader.js:857:18)
    at Module.load (internal/modules/cjs/loader.js:685:32)
    at Function.Module._load (internal/modules/cjs/loader.js:620:12)
    at Module.require (internal/modules/cjs/loader.js:723:19)
    at require (internal/modules/cjs/helpers.js:14:16)
    at Object.<anonymous> (/home/vista1nik/Documents/nextjs-project/node_modules/grpc/src/grpc_extension.js:32:13)
    at Module._compile (internal/modules/cjs/loader.js:816:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:827:10)
    at Module.load (internal/modules/cjs/loader.js:685:32)
    at Function.Module._load (internal/modules/cjs/loader.js:620:12) type: 'Error', '$error': '$error' }

Error happens after compilation.
Last Build trigger before error is:
https://github.com/zeit/next.js/blob/5a54e8715a7a7a92175addc19f4ec9f8f7bbd2e7/packages/next/build/index.ts#L342

To Reproduce

https://github.com/jpbow/module-register-build-issue

Expected behavior

next build success

System information

OS: Arch Linux
Version of Next.js: 9.0.0

Additional context

Tried yarn install --forceand Clean depends install.

next . dev-command work properly.

The text was updated successfully, but these errors were encountered:

timneutkens · 2019-07-11T11:51:42Z

Please provide a full reproduction

Vista1nik · 2019-07-11T21:54:17Z

I'll provide reproduction tomorrow. Today I don't have access to my pc.

Vista1nik · 2019-07-12T12:34:28Z

Close because it's firebase grpc problem.

Vista1nik · 2019-07-12T12:48:06Z

There is similar problem in #7821

go-rani · 2019-07-13T12:23:29Z

Close because it's firebase grpc problem.

How can i fixed it?
I have same problem

Vista1nik · 2019-07-13T12:31:40Z

@go-rani Currently I don't have a solution because I not fully sure that this problem belongs to firebase. I trying to reproduce this bug in example project.

vbilici · 2019-07-15T08:32:27Z

I have the same problem. It goes normal when I downgrade to v8
here is the image I am using:
gcr.io/google_appengine/nodejs

Vista1nik · 2019-07-15T08:36:22Z

@vbilici interesting...

vbilici · 2019-07-15T09:18:53Z

I have a feeling that it's caused by newly added build report. Because the error throws after build completes

Creating an optimized production build ...

> Using external babel configuration
> Location: "/app/.babelrc"
Compiled successfully.

Warning: You have opted-out of Automatic Prerendering due to `getInitialProps` in `pages/_app`.
Read more: https://err.sh/next.js/opt-out-automatic-prerendering

> Build error occurred
{ Error: Module did not self-register.
    at Object.Module._extensions..node (internal/modules/cjs/loader.js:730:18)
    at Module.load (internal/modules/cjs/loader.js:600:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:539:12)
    at Function.Module._load (internal/modules/cjs/loader.js:531:3)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:22:18)
    at Object.<anonymous> (/app/node_modules/@firebase/firestore/node_modules/grpc/src/grpc_extension.js:32:13)
    at Module._compile (internal/modules/cjs/loader.js:701:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:712:10)
    at Module.load (internal/modules/cjs/loader.js:600:32) type: 'Error', '$error': '$error' }
error Command failed with exit code 1.

partykyoung · 2019-07-17T07:18:38Z

I'm having same issue.

But when I comment out 'import firebase/firestore', this issue did'nt happen.

import firebase from 'firebase/app';
import 'firebase/auth';
import 'firebase/functions';
import 'firebase/database';
// import 'firebase/firestore'; <--

But I need firebase/firestore. this is not solution.

Vista1nik · 2019-07-17T07:39:56Z

As I understand any dependency with grpc breaking nextjs build?

ch4rlesyeo · 2019-07-17T19:53:56Z

Getting this issue as well.

I was able to build at first, but it happens when my /pages grown big. I tried reverting back to an old commit where i can build without issue and duplicate my /pages folder (-v1, -v2 and so on) build after build to a point where it fails.

I couldn't quantify how "big" is big but hope this helps.

jpbow · 2019-07-19T08:27:48Z

@timneutkens @Vista1nik I've created a reproduction here https://github.com/jpbow/module-register-build-issue

Vista1nik · 2019-07-19T14:29:45Z

@jpbow Thanks for repoduction, added to issue.

Pushplaybang · 2019-07-21T17:46:07Z

just chiming in, this also fails when deploying with now 2.0

Vista1nik · 2019-07-22T09:05:37Z

It's seems like NextJS 9 is incompatible with dependencies which use GRPC in anyway.
Currently I trying to find any other package which use GRPC to confirm that.

Pushplaybang · 2019-07-22T10:49:57Z

@Vista1nik it'll fail with both firebase and gcp. Both use grpc.

Pushplaybang · 2019-07-22T12:17:03Z

after updating my next.config.js with the following (as mentioned in #6073 )

 webpack(config, options) {
    if (process.env.NODE_ENV !== "development") {
      config.externals = {
        grpc: "grpc"
      };
    }
    return config;
  }

link: #6073 (comment)

My deployment error has changed, I don't think this is optimal but may be a temporary workaround for others who are trying to update production builds

the new error seems related to AMP toolbox,

running "yarn run now-build"
Jul 22 2019 14:05:48:345 | ...next.config.js | yarn run v1.16.0
Jul 22 2019 14:05:48:403 | ...next.config.js | $ next build
Jul 22 2019 14:05:49:159 | ...next.config.js | Creating an optimized production build ...
Jul 22 2019 14:05:49:824 | ...next.config.js | > Using external babel configuration
Jul 22 2019 14:05:49:824 | ...next.config.js | > Location: "/tmp/bc0fa1c/babel.config.js"
Jul 22 2019 14:07:52:235 | ...next.config.js | Failed to compile.
Jul 22 2019 14:07:52:235 | ...next.config.js | ./node_modules/amp-toolbox-optimizer/lib/transformers/AddBlurryImagePlaceholders.js
Jul 22 2019 14:07:52:235 | ...next.config.js | Module not found: Can't resolve 'jimp' in '/tmp/bc0fa1c/node_modules/amp-toolbox-optimizer/lib/transformers'
Jul 22 2019 14:07:52:235 | ...next.config.js |

which is annoying as I'm not using AMP at all, not sure how related this is but hopefully its helpful.

jayb967 · 2019-08-04T08:57:31Z

I am having the same issue using firebase.. Has anyone found a deployment workaround?

mglonnro · 2019-08-08T06:29:49Z

For some reason building my project on mac OS works, while on Debian I get the same "Module did not self-register" error.

z3r0c00l-2k · 2019-08-08T09:38:57Z

Did anyone found any workaround for this issue?

Vista1nik · 2019-08-08T14:48:40Z

There must be joke about "Buy new Mac".
Currently only downgrade is solution.

notiles · 2019-10-23T15:43:45Z

Try to remove this import : import "firebase/firestore"; only in index.js

ctavan · 2019-10-25T12:06:35Z

@notiles if you remove one of the two firebase/firestore imports then you are no longer provoking a parallel build of two modules that require grpc.

As mentioned above I'm pretty confident that the issue we are observing here is caused by grpc/grpc-node#778 which states that grpc "Does not support multiple threads".

As a workaround I figured out that builds succeed with the following next.config.js:

module.exports = {
  experimental: {
    cpus: 1,
  },
};

and fail as soon as you increase the CPU count (which further proves that parallel worker execution is the root cause). Obviously builds will then no longer take advantage of multiple worker threads, so this is a workaround, not a solution.

@ijjk, @Timer, @timneutkens sorry for bugging you again: how would you deal with this issue?

notiles · 2019-10-25T13:00:46Z

It's clear @ctavan ! Thanks a lot for this explanation. Unfortunately I still have the issue with experimental: {
cpus: 1,
}

`Warning: You have enabled experimental feature(s).
Experimental features are not covered by semver, and may cause unexpected or broken application behavior. Use them at your own risk.

Using external babel configuration
Location: "/Users/me/myproject/.babelrc"
Creating an optimized production build

Compiled successfully.

Automatically optimizing pages ..
Error occurred prerendering /download/[document_id]: Error: Failed to load /Users/me/myproject/node_modules/grpc/src/node/extension_binary/node-v72-darwin-x64-unknown/grpc_node.node. Module did not self-register.

etc...`

I switch form Node 11.9.0 to Node 10.12 and Node 13.0.1 to Node 12.13.0 without success...

ctavan · 2019-10-25T13:06:11Z

I was a bit too quick. With the next.config.js from my previous comment the build did work for f81b6d5 but not with next@9.1.1 because 61b8b73 introduced jest-worker to next export which is called as part of the build step.

My initial idea was to pass the config.experimental.cpus on to the export worker, however I did not succeed. Even with setting numWorkers: 1 the export step in the build will fail with the Module did not self-register. error.

The only way of getting it to work for my use case was setting enableWorkerThreads: false in:

https://github.com/zeit/next.js/blob/a964dc825ecea1e35fb460184828974e00b7d6d6/packages/next/export/index.ts#L265-L273

A possible workaround could be to allow setting config.experimental.cpus: 0 and as a consequence disabling worker threads altogether. I will provide a Pull Request for this suggestion shortly.

notiles · 2019-10-25T14:31:33Z

Ok @ctavan ! That's totally true, I change enableWorkerThreads to false and build succeed with next 9.1.1

So finally it's more a grpc issue than a next issue ? What's your feeling about that ? Do you think that we have to open an issue on grpc ?

Thanks a lots for all your explanations that's really helpfull.

Multiple worker threads can cause problems when certain dependencies are being used, see e.g. vercel#7894 This patch allows disabling of worker threads by setting `config.experimental.cpus = 1`. The benefit of spawning 1 worker thread, if there is any at all, should very limited anyways, so the workload can just as well be processed in the main thread.

ctavan · 2019-10-25T15:00:51Z

I have now proposed #9199 where setting config.experimental.cpus: 1 will disable worker threads altogether. This makes next build succeed for all use cases that involve grpc and that I have tested.

For me, that would be an acceptable workaround until the issue is fixed in grpc or firebase. There is already an issue in the grpc repo (grpc/grpc-node#778) but apparently the solution depends on upstream changes in node (nodejs/nan#844).

I now believe that this is something that rather needs to be fixed in grpc, not here. At least I don't see a straightforward way of fixing it in Next.js without going back to older parallelization technology which would definitely hurt the codebase.

If #9199 gets accepted we would at least have a way to build projects that depend on firebase/firestore, even though build times might be longer since we cannot make use of parallelism.

Multiple worker threads can cause problems when certain dependencies are being used, see e.g. vercel#7894 This patch allows disabling of worker threads by setting `config.experimental.cpus = 1`. The benefit of spawning 1 worker thread, if there is any at all, should very limited anyways, so the workload can just as well be processed in the main thread.

* Pass config.experimental.cpus to export during build Currently, there is no way of specifying the number of worker threads of `next export` when run as part of `next build`. I suggest a sane default should be to just use the same amount of workers that were used during the build process which currently seems to be configured through `config.experimental.cpus`. This setting is already respected in the two other places where jest-workers are in use: The TerserPlugin and the staticCheckWorkers in `next build`. * Only enable worker threads if there is more than 1 worker Multiple worker threads can cause problems when certain dependencies are being used, see e.g. #7894 This patch allows disabling of worker threads by setting `config.experimental.cpus = 1`. The benefit of spawning 1 worker thread, if there is any at all, should very limited anyways, so the workload can just as well be processed in the main thread. * Disable parallel build for firebase authentication example * Add integration test to cover #7894 * Rename test suite and add worker_threads config * Disable worker_threads by default * Update index.test.js * Use workerThreads config for TerserPlugin * Update to use workerThreads config in TerserPlugin for consistency * Disable node 12 specific test

…ったのでnextjsをバージョンアップ(9.1.2) vercel/next.js#7894

The canvas package, which is a dependency of jsdom, has a native binding which causes the following error during Next.js build process: "Module did not self-register". We circuvent that by using a null-loader. See vercel/next.js#7894 The ws package, which is also a dependency of jsdom, tries to optionally load some dependencies. This produces a warning in webpack that we want to avoid. We circuvent that by adding them to externals.

CesarArdilaB · 2020-01-08T01:00:48Z

HEY EVERYBODY!
Just Add

"engines": {
"node": "10.x"
}

To your package.json

You are welcome coders.

mattburman · 2020-03-28T14:55:06Z

for anyone else who was tracking this issue:

I can confirm I no longer get "Module did not self-register" when using grpc.
v9.3.2 includes #11347 which is what fixed it

its-dibo · 2020-04-20T14:07:21Z

I have the same error

repo
building error

Error: Error occurred while parsing your function triggers.

Error: 
Something went wrong installing the "sharp" module

Module did not self-register.

balazsorban44 · 2022-01-30T07:05:51Z

This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.

Vista1nik closed this as completed Jul 12, 2019

Vista1nik reopened this Jul 15, 2019

Pushplaybang mentioned this issue Jul 22, 2019

Can't Deploy with v9 & Now 2.0 #8052

Closed

timneutkens added the Type: Needs Investigation label Aug 8, 2019

timneutkens added this to the 9.0.x milestone Aug 8, 2019

timneutkens assigned ijjk and Timer and unassigned ijjk Aug 8, 2019

This was referenced Oct 25, 2019

Does not support multiple threads grpc/grpc-node#778

Closed

Remove legacy concurrency option from next export #9197

Merged

ctavan mentioned this issue Oct 25, 2019

Disable worker_threads by default for firebase compatibility #9199

Merged

ctavan added a commit to ctavan/next.js that referenced this issue Oct 28, 2019

Add integration test to cover vercel#7894

684c8ff

Timer closed this as completed in #9199 Oct 29, 2019

satazor mentioned this issue Nov 22, 2019

feat: add next plugin that deals with webpack workarounds moxystudio/next-intl#4

Merged

hangindev mentioned this issue Mar 25, 2020

Issue with getStaticPaths and firebase/firestore #11339

Closed

vercel locked as resolved and limited conversation to collaborators Jan 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`next build` fails with "Module did not self-register." #7894

`next build` fails with "Module did not self-register." #7894

Vista1nik commented Jul 11, 2019 •

edited

timneutkens commented Jul 11, 2019

Vista1nik commented Jul 11, 2019

Vista1nik commented Jul 12, 2019

Vista1nik commented Jul 12, 2019

go-rani commented Jul 13, 2019

Vista1nik commented Jul 13, 2019

vbilici commented Jul 15, 2019

Vista1nik commented Jul 15, 2019

vbilici commented Jul 15, 2019

partykyoung commented Jul 17, 2019

Vista1nik commented Jul 17, 2019

ch4rlesyeo commented Jul 17, 2019 •

edited

jpbow commented Jul 19, 2019 •

edited

Vista1nik commented Jul 19, 2019

Pushplaybang commented Jul 21, 2019

Vista1nik commented Jul 22, 2019

Pushplaybang commented Jul 22, 2019

Pushplaybang commented Jul 22, 2019

jayb967 commented Aug 4, 2019

mglonnro commented Aug 8, 2019

z3r0c00l-2k commented Aug 8, 2019

Vista1nik commented Aug 8, 2019

notiles commented Oct 23, 2019

ctavan commented Oct 25, 2019

notiles commented Oct 25, 2019

ctavan commented Oct 25, 2019

notiles commented Oct 25, 2019

ctavan commented Oct 25, 2019

CesarArdilaB commented Jan 8, 2020

mattburman commented Mar 28, 2020

its-dibo commented Apr 20, 2020

balazsorban44 commented Jan 30, 2022

next build fails with "Module did not self-register." #7894

next build fails with "Module did not self-register." #7894

Comments

Vista1nik commented Jul 11, 2019 • edited

Bug report

Describe the bug

To Reproduce

Expected behavior

System information

Additional context

timneutkens commented Jul 11, 2019

Vista1nik commented Jul 11, 2019

Vista1nik commented Jul 12, 2019

Vista1nik commented Jul 12, 2019

go-rani commented Jul 13, 2019

Vista1nik commented Jul 13, 2019

vbilici commented Jul 15, 2019

Vista1nik commented Jul 15, 2019

vbilici commented Jul 15, 2019

partykyoung commented Jul 17, 2019

Vista1nik commented Jul 17, 2019

ch4rlesyeo commented Jul 17, 2019 • edited

jpbow commented Jul 19, 2019 • edited

Vista1nik commented Jul 19, 2019

Pushplaybang commented Jul 21, 2019

Vista1nik commented Jul 22, 2019

Pushplaybang commented Jul 22, 2019

Pushplaybang commented Jul 22, 2019

jayb967 commented Aug 4, 2019

mglonnro commented Aug 8, 2019

z3r0c00l-2k commented Aug 8, 2019

Vista1nik commented Aug 8, 2019

notiles commented Oct 23, 2019

ctavan commented Oct 25, 2019

notiles commented Oct 25, 2019

ctavan commented Oct 25, 2019

notiles commented Oct 25, 2019

ctavan commented Oct 25, 2019

CesarArdilaB commented Jan 8, 2020

mattburman commented Mar 28, 2020

its-dibo commented Apr 20, 2020

balazsorban44 commented Jan 30, 2022

`next build` fails with "Module did not self-register." #7894

`next build` fails with "Module did not self-register." #7894

Vista1nik commented Jul 11, 2019 •

edited

ch4rlesyeo commented Jul 17, 2019 •

edited

jpbow commented Jul 19, 2019 •

edited