Cleanup, add __firebaseAppName to query

Author: jamesdaniels

src/client/auth/index.ts

@@ -12,12 +12,13 @@ import type { FirebaseApp } from 'firebase/app';
 import { ID_TOKEN_MAX_AGE } from '../../constants';
 
 let alreadySetup = false;
-let lastPostedIdToken: string|undefined;
+let lastPostedIdToken: string|undefined|null = null;
 
 const mintCookie = async (user: User|null) => {
     const idTokenResult = user && await user.getIdTokenResult();
     const idTokenAge = idTokenResult && (new Date().getTime() - Date.parse(idTokenResult.issuedAtTime)) / 1_000;
     if (idTokenAge && idTokenAge > ID_TOKEN_MAX_AGE) return;
+    // Specifically trip null => undefined when logged out, to delete any existing cookie
     const idToken = idTokenResult?.token;
     if (lastPostedIdToken === idToken) return;
     lastPostedIdToken = idToken;

src/constants.ts

@@ -8,3 +8,4 @@ export const LRU_MAX_INSTANCES = 100;
 export const LRU_TTL = 1_000 * 60 * 5;
 export const ID_TOKEN_MAX_AGE = 5 * 60;
 export const COOKIE_MAX_AGE = 60 * 60 * 24 * 5 * 1_000;
+export const MIN_FIREBASE_SDK_FOR_AUTH = '9.8.0';

src/frameworks/angular/index.ts

@@ -30,6 +30,7 @@ export const build = async (config: DeployConfig | Required<DeployConfig>, getPr
         project = angularJson.defaultProject;
         if (!project) throw `angular.json missing defaultProject`;
     }
+
     // TODO if there are multiple projects warn
     const workspaceProject = workspace.projects.get(project);
     if (!workspaceProject) throw `No project ${project} found.`;

src/frameworks/next.js/index.ts

@@ -13,15 +13,15 @@
 // limitations under the License.
 
 import { readFile, mkdir, copyFile, stat } from 'fs/promises';
-import { dirname, extname, join, relative, resolve, sep } from 'path';
+import { dirname, extname, join } from 'path';
 import type { Header, Rewrite, Redirect } from 'next/dist/lib/load-custom-routes';
 import type { NextConfig } from 'next';
 import nextBuild from 'next/dist/build';
+import nextExport from 'next/dist/export';
 import { copy } from 'fs-extra';
-import * as webpack from 'webpack';
-import { lt } from 'semver';
+import { trace } from 'next/dist/trace';
 
-import { DeployConfig, PathFactory, exec, findDependency } from '../../utils';
+import { DeployConfig, PathFactory, exec, findDependency, getWebpackPlugin } from '../../utils';
 
 export const build = async (config: DeployConfig | Required<DeployConfig>, getProjectPath: PathFactory) => {
 
@@ -44,46 +44,39 @@ export const build = async (config: DeployConfig | Required<DeployConfig>, getPr
             webpack: (config, context) => {
                 let newConfig = config;
                 if (nextConfig.webpack) newConfig = nextConfig.webpack(config, context);
-                const plugin = new webpack.NormalModuleReplacementPlugin(/^firebase\/(auth)$/, (resource: any) => {
-                    // Don't allow firebase-frameworks to recurse
-                    const frameworksRoot = resolve(`${dirname(require.resolve('../..'))}${sep}..`);
-                    if (resource.context.startsWith(frameworksRoot)) return;
-                    // Don't mutate their node_modules
-                    if (relative(getProjectPath(), resource.context).startsWith(`node_modules${sep}`)) return;
-                    const client = resource.request.split('firebase/')[1];
-                    // auth requires beforeAuthStateChanged, released in 9.7.1
-                    if (client === 'auth' && lt(firebaseDependency.version, '9.7.1')) return;
-                    resource.request = require.resolve(`../../client/${client}`);
-                });
+                const plugin = getWebpackPlugin(getProjectPath());
                 newConfig.plugins ||= [];
                 newConfig.plugins.push(plugin);
                 return newConfig;
             }
         }
     }
 
-    await nextBuild(getProjectPath(), overrideConfig as any, false, false, true);
-    // TODO be a bit smarter about this
-    await exec(`${getProjectPath('node_modules', '.bin', 'next')} export`, { cwd: getProjectPath() }).catch(() => {});
 
     // SEMVER these defaults are only needed for Next 11
     const { distDir='.next', basePath='' } = nextConfig;
 
     const deployPath = (...args: string[]) => config.dist ? join(config.dist, ...args) : getProjectPath('.deploy', ...args);
     const getHostingPath = (...args: string[]) => deployPath('hosting', ...basePath.split('/'), ...args);
 
-    await mkdir(getHostingPath('_next', 'static'), { recursive: true });
+    await nextBuild(getProjectPath(), overrideConfig as any, false, false, true);
+
+    await nextExport(
+        getProjectPath(),
+        { silent: true, outdir: getHostingPath() },
+        trace('next-export-cli')
+    ).catch(() => {
+        console.warn('\nUnable to export the app, treating as SSR.\n\n');
+    });
 
     let usingCloudFunctions = !!config.function;
     const asyncSteps: Array<Promise<any>> = [];
 
     const exportDetailJson = await readFile(getProjectPath(distDir, 'export-detail.json')).then(it => JSON.parse(it.toString()), () => { success: false });
     if (exportDetailJson.success) {
         usingCloudFunctions = false;
-        asyncSteps.push(
-            copy(exportDetailJson.outDirectory, getHostingPath())
-        );
     } else {
+        await mkdir(getHostingPath('_next', 'static'), { recursive: true });
         await copy(getProjectPath('public'), getHostingPath());
         await copy(getProjectPath(distDir, 'static'), getHostingPath('_next', 'static'));
 
@@ -152,11 +145,11 @@ export const build = async (config: DeployConfig | Required<DeployConfig>, getPr
         return { source, destination };
     }).filter(it => it);
 
+    // TODO use this better detection for usesFirebaseConfig
     return { usingCloudFunctions, usesFirebaseConfig, headers, redirects, rewrites, framework: 'next.js', packageJson, bootstrapScript: null };
 }
 
-
-export type Manifest = {
+type Manifest = {
     distDir?: string,
     basePath?: string,
     headers?: (Header & { regex: string})[],
@@ -166,4 +159,4 @@ export type Manifest = {
         afterFiles?: (Rewrite & { regex: string})[],
         fallback?: (Rewrite & { regex: string})[],
     },
-};
+};

src/frameworks/next.js/server.ts

@@ -1,13 +1,17 @@
 import { parse } from 'url';
 import next from 'next';
-import type { Request } from 'firebase-functions/v2/https';
+import type { Request } from '../../server';
 import type { Response } from 'express';
 
 const nextApp = next({ dev: false, dir: process.cwd() });
 const nextAppPrepare = nextApp.prepare();
 
 export const handle = async (req: Request, res: Response) => {
-    const parsedUrl = parse(req.url, true);
+    const fauxHost = 'http://firebase-frameworks';
+    const url = new URL(`${fauxHost}${req.url}`);
+    url.searchParams.delete('__firebaseAppName');
+    if (req.firebaseApp) url.searchParams.set('__firebaseAppName', req.firebaseApp.name);
+    const parsedUrl = parse(url.toString().slice(fauxHost.length), true);
     await nextAppPrepare;
     nextApp.getRequestHandler()(req, res, parsedUrl);
-};
+};

src/server/index.ts

@@ -1,4 +1,5 @@
 import { onRequest } from 'firebase-functions/v2/https';
+export { Request } from './firebase-aware';
 
 const { HTTPS_OPTIONS, FRAMEWORK } = require(`${process.cwd()}/settings`);
 const { handle } = require(`../frameworks/${FRAMEWORK}/server`);

src/utils.ts

@@ -13,7 +13,10 @@
 // limitations under the License.
 
 import { exec as execCallback, spawn as spawnCallback, ExecOptions, SpawnOptionsWithoutStdio, spawnSync } from 'child_process';
-import { join } from 'path';
+import { dirname, join, relative, resolve, sep } from 'path';
+import { lt } from 'semver';
+import { NormalModuleReplacementPlugin } from 'webpack';
+import { MIN_FIREBASE_SDK_FOR_AUTH } from './constants';
 
 export const exec = (command: string, options: ExecOptions={}) => new Promise((resolve, reject) =>
     execCallback(command, options, (error, stdout) => {
@@ -75,3 +78,18 @@ export const findDependency = (name: string, cwd=process.cwd()) => {
     }
     return search(name, json.dependencies);
 }
+
+export const getWebpackPlugin = (cwd: string) => new NormalModuleReplacementPlugin(/^firebase\/(auth)$/, (resource: any) => {
+    // Don't allow firebase-frameworks to recurse
+    const frameworksRoot = resolve(`${dirname(require.resolve('.'))}${sep}..`);
+    if (resource.context.startsWith(frameworksRoot)) return;
+    // Don't mutate their node_modules
+    if (relative(cwd, resource.context).startsWith(`node_modules${sep}`)) return;
+    const client = resource.request.split('firebase/')[1];
+    const firebaseDependency = findDependency('firebase', cwd);
+    // auth requires beforeAuthStateChanged, released in 9.8.0
+    if (client === 'auth' && lt(firebaseDependency.version, MIN_FIREBASE_SDK_FOR_AUTH)) return;
+    // TODO log to the firebase.log
+    console.log(`Substituting import of '${resource.request}' with 'firebase-frameworks/client/${client}' in ${relative(cwd, resource.context)}.`);
+    resource.request = require.resolve(`./client/${client}`);
+});

tools/build.ts

@@ -7,6 +7,8 @@ const LOCAL_NODE_MODULES = [
     '@angular-devkit/architect/node',
     '@angular-devkit/architect',
     'next/dist/build',
+    'next/dist/export',
+    'next/dist/trace',
     'nuxt',
     '@nuxt/kit/dist/index.mjs',
     'webpack'
@@ -30,19 +32,19 @@ const main = async () => {
     });
 
     await replaceInFile({
-        files: 'dist/frameworks/**/index.js',
+        files: 'dist/**/*',
         from: LOCAL_NODE_MODULES.map(mod => `require("${mod}")`),
         to: LOCAL_NODE_MODULES.map(mod => `require(\`\${process.cwd()}/node_modules/${mod}\`)`),
     });
 
     await replaceInFile({
-        files: 'dist/frameworks/**/index.js',
+        files: 'dist/**/*',
         from: LOCAL_NODE_MODULES.map(mod => `require('${mod}')`),
         to: LOCAL_NODE_MODULES.map(mod => `require(\`\${process.cwd()}/node_modules/${mod}\`)`),
     });
 
     await replaceInFile({
-        files: 'dist/frameworks/**/index.js',
+        files: 'dist/**/*',
         from: LOCAL_NODE_MODULES.map(mod => `import('${mod}')`),
         to: LOCAL_NODE_MODULES.map(mod => `import(\`\${process.cwd()}/node_modules/${mod}\`)`),
     });