feat: add firebase-app-hosting preset (#2864)

Author: pi0

.gitignore

@@ -71,6 +71,7 @@ staticwebapp.config.json
 .eslintcache
 playground/firebase.json
 .zeabur
+.apphosting
 
 test/fixture/functions
 .data

docs/2.deploy/0.index.md

@@ -22,6 +22,7 @@ When deploying to production using CI/CD, Nitro tries to automatically detect th
 - [aws amplify](/deploy/providers/aws-amplify)
 - [azure](/deploy/providers/azure)
 - [cloudflare pages](/deploy/providers/cloudflare#cloudflare-pages)
+- [firebase app hosting](/deploy/providers/firebase#firebase-app-hosting-beta)
 - [netlify](/deploy/providers/netlify)
 - [stormkit](/deploy/providers/stormkit)
 - [vercel](/deploy/providers/vercel)

docs/2.deploy/20.providers/firebase.md

@@ -1,26 +1,58 @@
 # Firebase
 
-> Deploy Nitro apps to Firebase.
+> Deploy Nitro apps to Firebase hosting.
 
-**Preset:** `firebase`
+::note
+You will need to be on the [**Blaze plan**](https://firebase.google.com/pricing) (Pay as you go) to get started.
+::
 
-:read-more{title="Firebase Hosting" to="https://firebase.google.com/docs/hosting"}
+<!--
 
-::note
-You need to be on the **Blaze plan** to use Nitro with cloud functions.
+## Firebase app hosting <sup>(beta)</sup>
+
+Preset: `firebase_app_hosting`
+
+:read-more{title="Firebase App Hosting" to="https://firebase.google.com/docs/app-hosting"}
+
+::important
+Firebase app hosting support is currently available in the Nitro [nightly release channel](/guide/nightly).
 ::
 
+::tip
+You can integrate with this provider using [zero configuration](/deploy/#zero-config-providers).
+::
+
+### Project setup
+
+1. Go to the Firebase [console](https://console.firebase.google.com/) and set up a new project.
+2. Select **Build > App Hosting** from the sidebar.
+    - You may need to upgrade your billing plan at this step.
+3. Click **Get Started**.
+    - Choose a region.
+    - Import a GitHub repository (you’ll need to link your GitHub account).
+    - Configure deployment settings (project root directory and branch), and enable automatic rollouts.
+    - Choose a unique ID for deployment.
+4. Wait for the first release to complete.
+
+-->
+
+## Firebase hosting
+
+**Preset:** `firebase`
+
+:read-more{title="Firebase Hosting" to="https://firebase.google.com/docs/hosting"}
+
 ::important
 This preset will deploy to firebase functions 1st gen by default. If you want to deploy to firebase functions 2nd gen, see the [instructions below](#using-2nd-generation-firebase-functions).
 ::
 
-## Project Setup
+### Project Setup
 
-### Using firebase CLI (recommended)
+#### Using firebase CLI (recommended)
 
 You may instead prefer to set up your project with the Firebase CLI, which will fetch your project ID for you, add required dependencies (see above) and even set up automated deployments via GitHub Actions (for hosting only). [Learn about installing the firebase CLI](https://firebase.google.com/docs/cli#windows-npm).
 
-#### 1. Install firebase CLI globally
+1. Install firebase CLI globally
 
 Always try to use the latest version of the Firebase CLI.
 
@@ -30,7 +62,7 @@ npm install -g firebase-tools@latest
 
 **Note**: You need to be on [^11.18.0](https://github.com/firebase/firebase-tools/releases/tag/v11.18.0) to deploy a `nodejs18` function.
 
-#### 2. Initialize your firebase project
+2. Initialize your firebase project
 
 ```bash
 firebase login
@@ -57,11 +89,11 @@ Once complete, add the following to your `firebase.json` to enable server render
 
 You can find more details in the [Firebase documentation](https://firebase.google.com/docs/hosting/quickstart).
 
-### Alternative method
+#### Alternative method
 
 If you don't already have a `firebase.json` in your root directory, Nitro will create one the first time you run it. In this file, you will need to replace `<your_project_id>` with the ID of your Firebase project. This file should then be committed to the git.
 
-#### 1. Create a `.firebaserc` file
+1. Create a `.firebaserc` file
 
 It is recommended to create a `.firebaserc` file so you don't need to manually pass your project ID to your `firebase` commands (with `--project <your_project_id>`):
 
@@ -75,19 +107,19 @@ It is recommended to create a `.firebaserc` file so you don't need to manually p
 
 This file is usually generated when you initialize your project with the Firebase CLI. But if you don't have one, you can create it manually.
 
-#### 2. Install firebase dependencies
+2. Install firebase dependencies
 
 Then, add Firebase dependencies to your project:
 
 :pm-install{name="firebase-admin firebase-functions firebase-functions-test" dev}
 
-#### 3. Log into the firebase CLI
+3. Log into the firebase CLI
 
 Make sure you are authenticated with the firebase cli. Run this command and follow the prompts:
 
 :pm-x{command="firebase-tools login"}
 
-## Local preview
+### Local preview
 
 You can preview a local version of your site if you need to test things out without deploying.
 
@@ -96,7 +128,7 @@ NITRO_PRESET=firebase npm run build
 firebase emulators:start
 ```
 
-## Build and deploy
+### Build and deploy
 
 Deploy to Firebase Hosting by running a Nitro build and then running the `firebase deploy` command.
 
@@ -112,7 +144,7 @@ If you installed the Firebase CLI globally, you can also run:
 firebase deploy
 ```
 
-## Using 2nd generation firebase functions
+### Using 2nd generation firebase functions
 
 - [Comparison between 1st and 2nd generation functions](https://firebase.google.com/docs/functions/version-comparison)
 
@@ -148,7 +180,7 @@ If you cannot use configuration for any reason, alternatively you can use `NITRO
 
 If you already have a deployed version of your website and want to upgrade to 2nd gen, [see the Migration process on Firebase docs](https://firebase.google.com/docs/functions/2nd-gen-upgrade). Namely, the CLI will ask you to delete your existing functions before deploying the new ones.
 
-## Options
+### Options
 
 You can set options for the firebase functions in your `nitro.config.ts` file:
 
@@ -184,7 +216,7 @@ export default defineNuxtConfig({
 
 You can also set options for 1st generation Cloud Functions if the `gen` option is set to `1`. Note these are different from the options for 2nd generation Cloud Functions.
 
-### Runtime Node.js version
+#### Runtime Node.js version
 
 You can set custom Node.js version in configuration:
 
@@ -225,17 +257,17 @@ You might also need to add a runtime key to your `firebase.json` file:
 
 You can read more about this in [Firebase Docs](https://firebase.google.com/docs/functions/manage-functions?gen=2nd#set_nodejs_version).
 
-## If your firebase project has other cloud functions
+### If your firebase project has other cloud functions
 
 You may be warned that other cloud functions will be deleted when you deploy your nitro project. This is because nitro will deploy your entire project to firebase functions. If you want to deploy only your nitro project, you can use the `--only` flag:
 
 ```bash
 firebase deploy --only functions:server,hosting
 ```
 
-## Advanced
+### Advanced
 
-### Renaming function
+#### Renaming function
 
 When deploying multiple apps within the same Firebase project, you must give your server a unique name in order to avoid overwriting
 your functions.

package.json

@@ -156,7 +156,7 @@
     "semver": "^7.6.3",
     "serve-placeholder": "^2.0.2",
     "serve-static": "^1.16.2",
-    "std-env": "^3.7.0",
+    "std-env": "^3.8.0",
     "ufo": "^1.5.4",
     "uncrypto": "^0.1.3",
     "unctx": "^2.3.1",

pnpm-lock.yaml

@@ -20,6 +20,6 @@ export interface PresetOptions {
 
 export const presetsWithConfig = ["awsAmplify","awsLambda","azure","cloudflare","firebase","netlify","vercel"] as const;
 
-export type PresetName = "alwaysdata" | "aws-amplify" | "aws-lambda" | "azure" | "azure-functions" | "azure-swa" | "base-worker" | "bun" | "cleavr" | "cli" | "cloudflare" | "cloudflare-durable" | "cloudflare-module" | "cloudflare-module-legacy" | "cloudflare-pages" | "cloudflare-pages-static" | "cloudflare-worker" | "deno" | "deno-deploy" | "deno-server" | "digital-ocean" | "edgio" | "firebase" | "flight-control" | "genezio" | "github-pages" | "gitlab-pages" | "heroku" | "iis" | "iis-handler" | "iis-node" | "koyeb" | "layer0" | "netlify" | "netlify-builder" | "netlify-edge" | "netlify-legacy" | "netlify-static" | "nitro-dev" | "nitro-prerender" | "node" | "node-cluster" | "node-listener" | "node-server" | "platform-sh" | "render-com" | "service-worker" | "static" | "stormkit" | "vercel" | "vercel-edge" | "vercel-static" | "winterjs" | "zeabur" | "zeabur-static" | "zerops" | "zerops-static";
+export type PresetName = "alwaysdata" | "aws-amplify" | "aws-lambda" | "azure" | "azure-functions" | "azure-swa" | "base-worker" | "bun" | "cleavr" | "cli" | "cloudflare" | "cloudflare-durable" | "cloudflare-module" | "cloudflare-module-legacy" | "cloudflare-pages" | "cloudflare-pages-static" | "cloudflare-worker" | "deno" | "deno-deploy" | "deno-server" | "digital-ocean" | "edgio" | "firebase" | "firebase-app-hosting" | "flight-control" | "genezio" | "github-pages" | "gitlab-pages" | "heroku" | "iis" | "iis-handler" | "iis-node" | "koyeb" | "layer0" | "netlify" | "netlify-builder" | "netlify-edge" | "netlify-legacy" | "netlify-static" | "nitro-dev" | "nitro-prerender" | "node" | "node-cluster" | "node-listener" | "node-server" | "platform-sh" | "render-com" | "service-worker" | "static" | "stormkit" | "vercel" | "vercel-edge" | "vercel-static" | "winterjs" | "zeabur" | "zeabur-static" | "zerops" | "zerops-static";
 
-export type PresetNameInput = "alwaysdata" | "aws-amplify" | "awsAmplify" | "aws_amplify" | "aws-lambda" | "awsLambda" | "aws_lambda" | "azure" | "azure-functions" | "azureFunctions" | "azure_functions" | "azure-swa" | "azureSwa" | "azure_swa" | "base-worker" | "baseWorker" | "base_worker" | "bun" | "cleavr" | "cli" | "cloudflare" | "cloudflare-durable" | "cloudflareDurable" | "cloudflare_durable" | "cloudflare-module" | "cloudflareModule" | "cloudflare_module" | "cloudflare-module-legacy" | "cloudflareModuleLegacy" | "cloudflare_module_legacy" | "cloudflare-pages" | "cloudflarePages" | "cloudflare_pages" | "cloudflare-pages-static" | "cloudflarePagesStatic" | "cloudflare_pages_static" | "cloudflare-worker" | "cloudflareWorker" | "cloudflare_worker" | "deno" | "deno-deploy" | "denoDeploy" | "deno_deploy" | "deno-server" | "denoServer" | "deno_server" | "digital-ocean" | "digitalOcean" | "digital_ocean" | "edgio" | "firebase" | "flight-control" | "flightControl" | "flight_control" | "genezio" | "github-pages" | "githubPages" | "github_pages" | "gitlab-pages" | "gitlabPages" | "gitlab_pages" | "heroku" | "iis" | "iis-handler" | "iisHandler" | "iis_handler" | "iis-node" | "iisNode" | "iis_node" | "koyeb" | "layer0" | "netlify" | "netlify-builder" | "netlifyBuilder" | "netlify_builder" | "netlify-edge" | "netlifyEdge" | "netlify_edge" | "netlify-legacy" | "netlifyLegacy" | "netlify_legacy" | "netlify-static" | "netlifyStatic" | "netlify_static" | "nitro-dev" | "nitroDev" | "nitro_dev" | "nitro-prerender" | "nitroPrerender" | "nitro_prerender" | "node" | "node-cluster" | "nodeCluster" | "node_cluster" | "node-listener" | "nodeListener" | "node_listener" | "node-server" | "nodeServer" | "node_server" | "platform-sh" | "platformSh" | "platform_sh" | "render-com" | "renderCom" | "render_com" | "service-worker" | "serviceWorker" | "service_worker" | "static" | "stormkit" | "vercel" | "vercel-edge" | "vercelEdge" | "vercel_edge" | "vercel-static" | "vercelStatic" | "vercel_static" | "winterjs" | "zeabur" | "zeabur-static" | "zeaburStatic" | "zeabur_static" | "zerops" | "zerops-static" | "zeropsStatic" | "zerops_static" | (string & {});
+export type PresetNameInput = "alwaysdata" | "aws-amplify" | "awsAmplify" | "aws_amplify" | "aws-lambda" | "awsLambda" | "aws_lambda" | "azure" | "azure-functions" | "azureFunctions" | "azure_functions" | "azure-swa" | "azureSwa" | "azure_swa" | "base-worker" | "baseWorker" | "base_worker" | "bun" | "cleavr" | "cli" | "cloudflare" | "cloudflare-durable" | "cloudflareDurable" | "cloudflare_durable" | "cloudflare-module" | "cloudflareModule" | "cloudflare_module" | "cloudflare-module-legacy" | "cloudflareModuleLegacy" | "cloudflare_module_legacy" | "cloudflare-pages" | "cloudflarePages" | "cloudflare_pages" | "cloudflare-pages-static" | "cloudflarePagesStatic" | "cloudflare_pages_static" | "cloudflare-worker" | "cloudflareWorker" | "cloudflare_worker" | "deno" | "deno-deploy" | "denoDeploy" | "deno_deploy" | "deno-server" | "denoServer" | "deno_server" | "digital-ocean" | "digitalOcean" | "digital_ocean" | "edgio" | "firebase" | "firebase-app-hosting" | "firebaseAppHosting" | "firebase_app_hosting" | "flight-control" | "flightControl" | "flight_control" | "genezio" | "github-pages" | "githubPages" | "github_pages" | "gitlab-pages" | "gitlabPages" | "gitlab_pages" | "heroku" | "iis" | "iis-handler" | "iisHandler" | "iis_handler" | "iis-node" | "iisNode" | "iis_node" | "koyeb" | "layer0" | "netlify" | "netlify-builder" | "netlifyBuilder" | "netlify_builder" | "netlify-edge" | "netlifyEdge" | "netlify_edge" | "netlify-legacy" | "netlifyLegacy" | "netlify_legacy" | "netlify-static" | "netlifyStatic" | "netlify_static" | "nitro-dev" | "nitroDev" | "nitro_dev" | "nitro-prerender" | "nitroPrerender" | "nitro_prerender" | "node" | "node-cluster" | "nodeCluster" | "node_cluster" | "node-listener" | "nodeListener" | "node_listener" | "node-server" | "nodeServer" | "node_server" | "platform-sh" | "platformSh" | "platform_sh" | "render-com" | "renderCom" | "render_com" | "service-worker" | "serviceWorker" | "service_worker" | "static" | "stormkit" | "vercel" | "vercel-edge" | "vercelEdge" | "vercel_edge" | "vercel-static" | "vercelStatic" | "vercel_static" | "winterjs" | "zeabur" | "zeabur-static" | "zeaburStatic" | "zeabur_static" | "zerops" | "zerops-static" | "zeropsStatic" | "zerops_static" | (string & {});

src/presets/_types.gen.ts

@@ -1,8 +1,15 @@
-import { defineNitroPreset } from "nitropack/kit";
-import { basename } from "pathe";
+import { defineNitroPreset, writeFile } from "nitropack/kit";
+import { version as nitroVersion } from "nitropack/meta";
+import { basename, join } from "pathe";
 import type { Plugin } from "rollup";
 import { genSafeVariableName } from "knitwork";
+import { stringifyYAML } from "confbox";
 import { updatePackageJSON, writeFirebaseConfig } from "./utils";
+import type {
+  AppHostingOptions,
+  AppHostingOutputBundleConfig,
+  FirebaseFunctionsOptions,
+} from "./types";
 
 export type { FirebaseOptions as PresetOptions } from "./types";
 
@@ -23,7 +30,8 @@ const firebase = defineNitroPreset(
         await updatePackageJSON(nitro);
       },
       "rollup:before": (nitro, rollupConfig) => {
-        const _gen = nitro.options.firebase?.gen as unknown;
+        const _gen = (nitro.options.firebase as FirebaseFunctionsOptions)
+          ?.gen as unknown;
         if (!_gen || _gen === "default") {
           nitro.logger.warn(
             "Neither `firebase.gen` or `NITRO_FIREBASE_GEN` is set. Nitro will default to Cloud Functions 1st generation. It is recommended to set this to the latest generation (currently `2`). Set the version to remove this warning. See https://nitro.build/deploy/providers/firebase for more information."
@@ -34,7 +42,8 @@ const firebase = defineNitroPreset(
         nitro.options.appConfig.nitro = nitro.options.appConfig.nitro || {};
         nitro.options.appConfig.nitro.firebase = nitro.options.firebase;
 
-        const { serverFunctionName } = nitro.options.firebase;
+        const { serverFunctionName } = nitro.options
+          .firebase as FirebaseFunctionsOptions;
         if (
           serverFunctionName &&
           serverFunctionName !== genSafeVariableName(serverFunctionName)
@@ -68,4 +77,37 @@ const firebase = defineNitroPreset(
   }
 );
 
-export default [firebase] as const;
+const firebaseAppHosting = defineNitroPreset(
+  {
+    extends: "node-server",
+    serveStatic: true,
+    hooks: {
+      async compiled(nitro) {
+        await writeFile(
+          join(nitro.options.rootDir, ".apphosting/bundle.yaml"),
+          stringifyYAML({
+            version: "v1",
+            runConfig: {
+              runCommand: "node .output/server/index.mjs",
+              ...(nitro.options.firebase as AppHostingOptions)?.appHosting,
+            },
+            metadata: {
+              framework: nitro.options.framework.name || "nitropack",
+              frameworkVersion: nitro.options.framework.version || "2.x",
+              adapterPackageName: "nitropack",
+              adapterVersion: nitroVersion,
+            },
+          } satisfies AppHostingOutputBundleConfig),
+          true
+        );
+      },
+    },
+  },
+  {
+    name: "firebase-app-hosting" as const,
+    stdName: "firebase_app_hosting",
+    url: import.meta.url,
+  }
+);
+
+export default [firebase, firebaseAppHosting] as const;