facebook/Docusaurus

Module with Top-level await transformed incorrectly during server build

Open

#7 238 ouverte le 25 avr. 2022

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)JavaScript (1 074 forks)batch import
bugdifficulty: advancedexternalhelp wanted

Métriques du dépôt

Stars
 (12 167 stars)
Métriques de merge PR
 (Merge moyen 14j 13h) (55 PRs mergées en 30 j)

Description

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of Docusaurus.
  • I have tried the npm run clear or yarn clear command.
  • I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
  • I have tried creating a repro with https://new.docusaurus.io.
  • I have read the console error message carefully (if applicable).

Description

Hi, I have enabled top-level await support in webpack config, and things work fine during docusaurus run, but fails during docusaurus build

This is my mdx content:

---
title: Markdown page example
---
export const test = await Promise.resolve('hello') 


<div>{test}</div>

Reproducible demo

https://stackblitz.com/edit/github-7mt6ad?file=src/pages/test.mdx

Steps to reproduce

  1. Enable top-level await support in webpack by setting experiments.topLevelAwait to true using configureWebpack (see plugins at docusaurus.config.js )
  2. Try using top-level await during docusaurus run, things work fine.
  3. It fails during docusaurus build

Expected behavior

top-level await should also work during build process

Actual behavior

top-level await doesn't work during build process


[INFO] [en] Creating an optimized production build...

✔ Client
  

✖ Server
  Compiled with some errors in 18.35s

[ERROR] Docusaurus server-side rendering could not render static page with path /test.


TypeError: Cannot read properties of undefined (reading 'title')
[ERROR] Unable to build website for locale en.
[ERROR] Error: Failed to compile with errors.

Your environment

  • Docusaurus version used: 2.0.0-beta.18
  • Operating system and version (e.g. Ubuntu 20.04.2 LTS): windows 10

Self-service

  • I'd be willing to fix this bug myself.

Guide contributeur

Direction de recherche
Le problème est que la build de Docusaurus échoue lorsque top level await est utilisé dans le contenu MDX, même si cela fonctionne en mode dev. Le problème réside dans la façon dont la build serveur gère le top level await. Étudiez la configuration webpack pour la build serveur, en particulier le paramètre `experiments.topLevelAwait`. Examinez le code source de Docusaurus pour voir comment il configure webpack pour le rendu côté serveur, probablement dans `packages/docusaurus/src/webpack/`. Vérifiez s'il existe une configuration webpack distincte pour la build par rapport au développement. De plus, examinez tous les issues ou PR liés au top level await. La démo reproductible se trouve sur https://stackblitz.com/edit/github 7mt6ad?file=src/pages/test.mdx et la configuration dans docusaurus.config.js.
Stack technique
javascriptreactnodejs
Domaine
frontendbuild system
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Node.jsDocusaurus basicswebpack configuration
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60