Intégrer d'autres frameworks avec Express.js

Avec quelques configurations supplémentaires, vous pouvez vous appuyer sur la fonctionnalité CLI de base compatible avec les frameworks pour étendre la prise en charge de l'intégration à d'autres frameworks qu'Angular et Next.js.

Avant de commencer

Avant de commencer à déployer votre application sur Firebase, passez en revue les exigences et les options suivantes :

  • Firebase CLI version 12.1.0 ou ultérieure. Veillez à installer la CLI en utilisant la méthode de votre choix.
  • (Facultatif) La facturation est activée dans votre projet Firebase (obligatoire si vous prévoyez d'utiliser le rendu côté serveur).

Initialiser Firebase

Pour commencer, initialisez Firebase pour votre projet de framework. Utilisez la CLI Firebase pour un nouveau projet ou modifiez firebase.json pour un projet existant.

Initialiser un nouveau projet

  1. Dans l'interface de ligne de commande Firebase, activez l'aperçu des frameworks Web : 
    firebase experiments:enable webframeworks

  2. Exécutez la commande d'initialisation depuis la CLI, puis suivez les instructions : 

    firebase init hosting

  3. Répondez "Oui" à la question "Do you want to use a web framework?" (Voulez-vous utiliser un framework Web ?). (version expérimentale)"

  4. Choisissez le répertoire source de l'hébergement. Il peut s'agir d'une application Web existante.

  5. Si vous y êtes invité, sélectionnez Express.js / custom.

Initialiser un projet existant

Modifiez votre configuration d'hébergement dans firebase.json pour avoir une option source plutôt qu'une option public. Exemple :

{
  "hosting": {
    "source": "./path-to-your-express-directory"
  }
}

Diffuser du contenu statique

Avant de déployer du contenu statique, vous devez configurer votre application.

Configurer

Pour savoir comment déployer votre application, la CLI Firebase doit pouvoir à la fois compiler votre application et savoir où vos outils placent les éléments destinés à Hosting. Pour ce faire, utilisez le script de compilation npm et la directive de répertoires CJS dans package.json.

Compte tenu du package.json suivant :

{
    "name": "express-app",
    "version": "0.0.0",
    "scripts": {
        "build": "spack",
        "static": "cp static/* dist",
        "prerender": "ts-node prerender.ts"
    },
    …
}

La CLI Firebase n'appelle que votre script de compilation. Vous devez donc vous assurer qu'il est exhaustif.

{
    "name": "express-app",
    "version": "0.0.0",
    "scripts": {
        "build": "spack && npm run static && npm run prerender",
        "static": "cp static/* dist",
        "prerender": "ts-node prerender.ts"
    },
    …
}

Si votre framework ne prend pas en charge le prérendu prêt à l'emploi, envisagez d'utiliser un outil tel que Rendertron. Rendertron vous permettra d'effectuer des requêtes Chrome sans interface graphique sur une instance locale de votre application. Vous pourrez ainsi enregistrer le code HTML obtenu pour le diffuser sur Hosting.

Enfin, différents frameworks et outils de compilation stockent leurs artefacts à différents endroits. Utilisez directories.serve pour indiquer à la CLI où votre script de compilation génère les artefacts résultants :

{
    "name": "express-app",
    "version": "0.0.0",
    "scripts": {
        "build": "spack && npm run static && npm run prerender",
        "static": "cp static/* dist",
        "prerender": "ts-node prerender.ts"
    },
    "directories": {
        "serve": "dist"
    },
    …
}

Déployer

Après avoir configuré votre application, vous pouvez diffuser du contenu statique avec la commande de déploiement standard :

firebase deploy

Diffuser du contenu dynamique

Pour diffuser votre application Express sur Cloud Functions for Firebase, assurez-vous que votre application Express (ou votre gestionnaire d'URL de type Express) est exportée de manière à ce que Firebase puisse la trouver une fois votre bibliothèque compressée au format npm.

Pour ce faire, assurez-vous que votre directive files inclut tout ce dont le serveur a besoin et que votre point d'entrée principal est correctement configuré dans package.json :

{
    "name": "express-app",
    "version": "0.0.0",
    "scripts": {
        "build": "spack && npm run static && npm run prerender",
        "static": "cp static/* dist",
        "prerender": "ts-node tools/prerender.ts"
    },
    "directories": {
        "serve": "dist"
    },
    "files": ["dist", "server.js"],
    "main": "server.js",
    ...
}

Exportez votre application Express à partir d'une fonction nommée app :

// server.js
export function app() {
  const server = express();
   …
   return server;
}

Si vous préférez exporter un gestionnaire d'URL de style Express, nommez-le handle :

export function handle(req, res) {
   res.send(‘hello world’);
}

Déployer

firebase deploy

Cela déploie votre contenu statique sur Firebase Hosting et permet à Firebase de revenir à votre application Express hébergée sur Cloud Functions for Firebase.

Facultatif : intégrer à Firebase Authentication

L'outil de déploiement Firebase compatible avec les frameworks Web synchronise automatiquement l'état du client et du serveur à l'aide de cookies. Pour accéder au contexte d'authentification, l'objet res.locals Express contient éventuellement une instance d'application Firebase authentifiée (firebaseApp) et l'utilisateur actuellement connecté (currentUser).