angular-cli icon indicating copy to clipboard operation
angular-cli copied to clipboard

@angular-devkit/build-angular:server with optimization: true fails in 16.1.4. 16.1.1 works well

Open juanmaldonadodev opened this issue 2 years ago • 36 comments

Command

run

Is this a regression?

  • [X] Yes, this behavior used to work in the previous version

The previous version in which this bug was not present was

16.1.1

Description

Exception appears on run main.js with node 16 after build with optimization using @angular-devkit/[email protected] with @angular-devkit/[email protected] works well

Minimal Reproduction

1 buid the project: ng build --configuration=production && ng run app:server:production Works correctly 2 Run the main.js present exception node dist/app/server/main.js

TypeError: Right-hand side of 'instanceof' is not an object
    at insertElement (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:490276)
    at insertHTMLElement (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:489998)
    at before_head_mode (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:527950)
    at HTMLParser.htmlparser.insertToken (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:489022)
    at emitSimpleTag (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:494203)
    at data_state (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:494241)
    at scanChars (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:485784)
    at Object.parse (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:483851)
    at Object.exports2.createDocument (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:721803)
    at Object.exports2.createWindow (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:722306)

The problem disappears if in angular.json optimization is set to false --> Not a real fix or if downgrade to "@angular-devkit/build-angular": "^16.1.1",

Final configuration: `Angular CLI: 16.1.4 Node: 16.20.0 Package Manager: npm 8.19.4 OS: darwin x64

Angular: 16.1.4 ... animations, cdk, cli, common, compiler, compiler-cli, core ... forms, language-service, localize, material ... platform-browser, platform-browser-dynamic, platform-server ... router

Package Version

@angular-devkit/architect 0.1601.4 @angular-devkit/build-angular 16.1.4 @angular-devkit/core 16.1.4 @angular-devkit/schematics 16.1.4 @nguniversal/builders 16.1.1 @nguniversal/express-engine 16.1.1 @schematics/angular 16.1.4 rxjs 7.8.1 typescript 5.1.6`

Exception or Error

TypeError: Right-hand side of 'instanceof' is not an object
    at insertElement (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:490276)
    at insertHTMLElement (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:489998)
    at before_head_mode (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:527950)
    at HTMLParser.htmlparser.insertToken (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:489022)
    at emitSimpleTag (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:494203)
    at data_state (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:494241)
    at scanChars (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:485784)
    at Object.parse (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:483851)
    at Object.exports2.createDocument (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:721803)
    at Object.exports2.createWindow (/Users/juanmaldonado/dev/ekilu-web-16/dist/app/server/main.js:1:722306)

Your Environment

`Angular CLI: 16.1.4
Node: 16.20.0
Package Manager: npm 8.19.4
OS: darwin x64

Angular: 16.1.4
... animations, cdk, cli, common, compiler, compiler-cli, core
... forms, language-service, localize, material
... platform-browser, platform-browser-dynamic, platform-server
... router

Package                         Version
---------------------------------------------------------
@angular-devkit/architect       0.1601.4
@angular-devkit/build-angular   16.1.4
@angular-devkit/core            16.1.4
@angular-devkit/schematics      16.1.4
@nguniversal/builders           16.1.1
@nguniversal/express-engine     16.1.1
@schematics/angular             16.1.4
rxjs                            7.8.1
typescript                      5.1.6`

Anything else relevant?

No response

juanmaldonadodev avatar Jul 12 '23 08:07 juanmaldonadodev

More users affected in this link: https://stackoverflow.com/questions/76611780/angular-ssr-error-right-hand-side-of-instanceof-is-not-an-object/76668748#76668748

juanmaldonadodev avatar Jul 12 '23 08:07 juanmaldonadodev

It's this line that is throwing : https://github.com/angular/domino/blob/aa8de3486307f57a518b4b0d9e5e16d9fbd998d1/lib/HTMLParser.js#L2645C59-L2645C60

JeanMeche avatar Jul 12 '23 09:07 JeanMeche

It's this line that is throwing : https://github.com/angular/domino/blob/aa8de3486307f57a518b4b0d9e5e16d9fbd998d1/lib/HTMLParser.js#L2645C59-L2645C60

Do you think that the problem is in domino library and not in the build?

juanmaldonadodev avatar Jul 13 '23 06:07 juanmaldonadodev

Hmm, I've been banging my head against this for a couple of days, and @juanico18 's comment made me try removing domino from my server.ts, and now my SSR server starts without this exception.

..my app fails overall of course because I need to provide window for some things in my app, but that does seem to be the right track for this issue.

Routhinator avatar Jul 15 '23 19:07 Routhinator

As a workaround for anyone stuck with this, I dropped in ssr-window instead of domino and things seem to be working now. It's an alternative to downgrading devkit for now.

Example:

import { getWindow, getDocument } from 'ssr-window';
;(global as any).window = getWindow()
;(global as any).document = getDocument()
;(global as any).navigator = {
  language: 'en',
}

I'm a little concerned about this as a long-term workaround as the ssr-window project has been idle longer than domino, but I note that domino itself has also been lacking updates for 2 years now.

Ultimately I should probably get on with doing platform checks to gate loading anything dependent on window/document/navigator and remove the need for this.

Routhinator avatar Jul 15 '23 20:07 Routhinator

Eh, I take it back. domino is hard to replace. It's implementation of DOMParser is more functionally complete than anything else.

Routhinator avatar Jul 15 '23 23:07 Routhinator

any new updated on this issue?

ahmadallw avatar Jul 20 '23 12:07 ahmadallw

@Routhinator @JeanMeche have you resolved this problem? I have been stuck for a couple of days thinking to resolve this.

deni-rhn avatar Jul 27 '23 09:07 deni-rhn

My resolution was to rewrite any components that were using non angular safe methods of using document or window etc.

IE: use Document from angular/core, or if you're looking to get an element use ViewChild and a setter, etc.

I've ripped out libs that don't do this or if they are user-only contexts, wrapped the loading of the module in a platform check.

Routhinator avatar Jul 27 '23 12:07 Routhinator

Hi all, I have the same problem. Are there updates?

manduriomane avatar Jul 27 '23 16:07 manduriomane

I'm experiencing the same issue with post versions @angular-devkit/build-angular v16.1.1, hoping for a fix after the new 16.2.0 RCs?

chakrachi avatar Aug 06 '23 21:08 chakrachi

have the same issue with 16.2.0 official version on production build :(

hiepxanh avatar Aug 10 '23 08:08 hiepxanh

I think this should be top priority fixing issue now. Since it breaks application build workflow

hiepxanh avatar Aug 10 '23 08:08 hiepxanh

Thanks for reporting this issue. However, you didn't provide sufficient information for us to understand and reproduce the problem. Can you setup a minimal repro please?

You can read here why this is needed. A good way to make a minimal repro is to create a new app via ng new repro-app and adding the minimum possible code to show the problem. Then you can push this repository to github and link it here.

This might be related to your directory structure so its really important to get an accurate repro to diagnose this.

alan-agius4 avatar Aug 10 '23 09:08 alan-agius4

aw sorry sir, I though that one provided it. Let me do that. I'm so sorry

hiepxanh avatar Aug 10 '23 10:08 hiepxanh

It's because of the domino package. To reproduce it:

  1. Create a new project
  2. Add ng add @nguniversal/express-engine
  3. npm install domino --save
  4. Add this to server.ts:
 const distFolder = join(process.cwd(), 'dist/YOUR_PROJECT_NAME/browser');
  const window = domino.createWindow(template);
  global['window'] = window;
  global['document'] = window.document;
  1. npm run build:ssr and then npm run server:ssr

This is how it should look like:

// The Express app is exported so that it can be used by serverless Functions.
export function app(): express.Express {
  const server = express();
  const distFolder = join(process.cwd(), 'dist/bug-repro/browser');
  const indexHtml = existsSync(join(distFolder, 'index.original.html'))
    ? 'index.original.html'
    : 'index';

  // Our Universal express-engine (found @ https://github.com/angular/universal/tree/main/modules/express-engine)
  server.engine(
    'html',
    ngExpressEngine({
      bootstrap: AppServerModule,
    })
  );

  const template = fs
  .readFileSync(path.join(join(process.cwd(), 'dist/bug-repro/browser'), 'index.html'))
  .toString();

  server.set('view engine', 'html');
  server.set('views', distFolder);

  // This cause the bug
  const window = domino.createWindow(template);
  global['window'] = window;
  global['document'] = window.document;

  [...]

Wycza avatar Aug 10 '23 11:08 Wycza

@Wycza, thanks I managed to replicate it.

alan-agius4 avatar Aug 10 '23 12:08 alan-agius4

allowing for SSR hydration exacerbates the problem, perhaps you can find a link with these issues

chakrachi avatar Aug 12 '23 23:08 chakrachi

Today converted the app (v16.2.0) to SSR and then try to build and serve and got the same error. As Wycza said in his comment I'm also using domino. I did Google and found this issue. Hope this will fix soon.

djgovani avatar Aug 16 '23 12:08 djgovani

+1 on this

krivanek06 avatar Aug 18 '23 08:08 krivanek06

+1 on this

vc-hitesh avatar Aug 25 '23 09:08 vc-hitesh

Hitting this also v16.2.1

REPTILEHAUS avatar Sep 05 '23 18:09 REPTILEHAUS

Hitting this also v16.2.1

Same. On 16.1.1 it works fine. Im also using domino with angular universal.

D-Biela avatar Sep 11 '23 14:09 D-Biela

@D-Biela you are not facing the same issue?

ahmadallw avatar Sep 11 '23 14:09 ahmadallw

@ahmadallw Im facing the same issue with @angular-devkit/build-angular v16.2.1, but as mentioned in this thread, downgrading to @angular-devkit/build-angular 16.1.1 solves the problem.

D-Biela avatar Sep 11 '23 14:09 D-Biela

Just upgraded Angular to version 16.2.4 and also running into this error.

alucardu avatar Sep 13 '23 20:09 alucardu

Hi to all. Are there updates?

manduriomane avatar Sep 28 '23 14:09 manduriomane

Hi all - Any new updates?

ahmadallw avatar Oct 11 '23 11:10 ahmadallw

Same issue for me.

igordanilovski avatar Oct 29 '23 19:10 igordanilovski

For anyone that runs into this issue but still needs to use Domino, Angular has a forked Domino repository which works with v17s SSR: https://github.com/angular/domino It's not on NPM though, so you will have to install it through git.

geferon avatar Nov 15 '23 14:11 geferon