Increase memory for server function on Next.js with image optimization

src/firebaseConfig.ts

@@ -94,7 +94,7 @@ export type HostingHeaders = HostingSource & {
 // Allow only serializable options, since this is in firebase.json
 // TODO(jamesdaniels) look into allowing serialized CEL expressions, params, and regexp
 //                    and if we can build this interface automatically via Typescript silliness
-interface FrameworksBackendOptions extends HttpsOptions {
+export interface FrameworksBackendOptions extends HttpsOptions {
   omit?: boolean;
   cors?: string | boolean;
   memory?: MemoryOption;

src/frameworks/index.ts

@@ -61,7 +61,7 @@
 /**
  *
  */
 export async function discover(dir: string, warn = true) {
   const allFrameworkTypes = [
     ...new Set(Object.values(WebFrameworks).map(({ type }) => type)),
   ].sort();
@@ -91,18 +91,18 @@
 function memoizeBuild(
   dir: string,
   build: Framework["build"],
   deps: any[],
   target: string,
   context: FrameworkContext,
 ): ReturnType<Framework["build"]> {
   const key = [dir, ...deps];
   for (const existingKey of BUILD_MEMO.keys()) {
     if (isDeepStrictEqual(existingKey, key)) {
       return BUILD_MEMO.get(existingKey) as ReturnType<Framework["build"]>;
     }
   }
   const value = build(dir, target, context);
   BUILD_MEMO.set(key, value);
   return value;
 }
 
@@ -110,7 +110,7 @@
  * Use a function to ensure the same codebase name is used here and
  * during hosting deploy.
  */
 export function generateSSRCodebaseId(site: string) {
   return `firebase-frameworks-${site}`;
 }
 
@@ -176,7 +176,7 @@
         `Hosting config for site ${site} places server-side content in region ${ssrRegion} which is not known. Valid regions are ${validRegions}`,
       );
     }
     const getProjectPath = (...args: string[]) => join(projectRoot, source, ...args);
     // Combined traffic tag (19 chars) and functionId cannot exceed 46 characters.
     const functionId = `ssr${site.toLowerCase().replace(/-/g, "").substring(0, 20)}`;
     const usesFirebaseAdminSdk = !!findDependency("firebase-admin", { cwd: getProjectPath() });
@@ -214,11 +214,11 @@
       if (selectedSite) {
         const { appId } = selectedSite;
         if (appId) {
           firebaseConfig = isDemoProject
             ? constructDefaultWebSetup(project)
             : await getAppConfig(appId, AppPlatform.WEB);
           firebaseDefaults ||= {};
           firebaseDefaults.config = firebaseConfig;
         } else {
           const defaultConfig = await implicitInit(options);
           if (defaultConfig.json) {
@@ -227,7 +227,7 @@
   You can link a Web app to a Hosting site here https://console.firebase.google.com/project/${project}/settings/general/web`,
             );
             firebaseDefaults ||= {};
             firebaseDefaults.config = JSON.parse(defaultConfig.json);
           } else {
             // N.B. None of us know when this can ever happen and the deploy would
             // still succeed. Maaaaybe if someone tried calling firebase serve
@@ -409,6 +409,7 @@
         frameworksEntry = framework,
         dotEnv = {},
         rewriteSource,
+        frameworksBackend: functionsDirectoryFrameworksBackend,
       } = await codegenFunctionsDirectory(
         getProjectPath(),
         functionsDist,
@@ -536,26 +537,26 @@
 
       if (bootstrapScript) await writeFile(join(functionsDist, "bootstrap.js"), bootstrapScript);
 
-      // TODO move to templates
+      const mergedFrameworksBackend = {
+        ...functionsDirectoryFrameworksBackend,
+        ...frameworksBackend,
+      };
 
+      // TODO move to templates
       if (packageJson.type === "module") {
         await writeFile(
           join(functionsDist, "server.js"),
           `import { onRequest } from 'firebase-functions/v2/https';
   const server = import('firebase-frameworks');
-  export const ${functionId} = onRequest(${JSON.stringify(
-    frameworksBackend || {},
-  )}, (req, res) => server.then(it => it.handle(req, res)));
+  export const ${functionId} = onRequest(${JSON.stringify(mergedFrameworksBackend)} || {}, (req, res) => server.then(it => it.handle(req, res)));
   `,
         );
       } else {
         await writeFile(
           join(functionsDist, "server.js"),
           `const { onRequest } = require('firebase-functions/v2/https');
   const server = import('firebase-frameworks');
-  exports.${functionId} = onRequest(${JSON.stringify(
-    frameworksBackend || {},
-  )}, (req, res) => server.then(it => it.handle(req, res)));
+  exports.${functionId} = onRequest(${JSON.stringify(mergedFrameworksBackend)} || {}, (req, res) => server.then(it => it.handle(req, res)));
   `,
         );
       }

src/frameworks/interfaces.ts

@@ -1,6 +1,11 @@
 import { IncomingMessage, ServerResponse } from "http";
 import { EmulatorInfo } from "../emulator/types";
-import { HostingHeaders, HostingRedirects, HostingRewrites } from "../firebaseConfig";
+import {
+  FrameworksBackendOptions,
+  HostingHeaders,
+  HostingRedirects,
+  HostingRewrites,
+} from "../firebaseConfig";
 import { HostingOptions } from "../hosting/options";
 import { Options } from "../options";
 
@@ -54,6 +59,15 @@ export type FrameworkContext = {
   site?: string;
 };
 
+export type CodegenFunctionDirectoryResult = {
+  bootstrapScript?: string;
+  packageJson: any;
+  frameworksEntry?: string;
+  dotEnv?: Record<string, string>;
+  rewriteSource?: string;
+  frameworksBackend?: FrameworksBackendOptions;
+};
+
 export interface Framework {
   supportedRange?: string;
   discover: (dir: string) => Promise<Discovery | undefined>;
@@ -82,13 +96,7 @@ export interface Framework {
     dest: string,
     target: string,
     context?: FrameworkContext,
-  ) => Promise<{
-    bootstrapScript?: string;
-    packageJson: any;
-    frameworksEntry?: string;
-    dotEnv?: Record<string, string>;
-    rewriteSource?: string;
-  }>;
+  ) => Promise<CodegenFunctionDirectoryResult>;
   getValidBuildTargets?: (purpose: BUILD_TARGET_PURPOSE, dir: string) => Promise<string[]>;
   shouldUseDevModeHandle?: (target: string, dir: string) => Promise<boolean>;
 }

src/frameworks/next/constants.ts

@@ -22,6 +22,7 @@ export const ROUTES_MANIFEST: typeof ROUTES_MANIFEST_TYPE = "routes-manifest.jso
 export const APP_PATHS_MANIFEST: typeof APP_PATHS_MANIFEST_TYPE = "app-paths-manifest.json";
 export const SERVER_REFERENCE_MANIFEST: `${typeof SERVER_REFERENCE_MANIFEST_TYPE}.json` =
   "server-reference-manifest.json";
+export const NEXTJS_IMAGE_OPTIMIZATION_MEMORY = "512MiB";
 
 export const CONFIG_FILES = ["next.config.js", "next.config.mjs"] as const;
 

src/frameworks/next/index.ts

@@ -31,6 +31,7 @@ import {
 } from "../utils";
 import {
   BuildResult,
+  CodegenFunctionDirectoryResult,
   Framework,
   FrameworkContext,
   FrameworkType,
@@ -79,10 +80,12 @@ import {
   APP_PATHS_MANIFEST,
   SERVER_REFERENCE_MANIFEST,
   ESBUILD_VERSION,
+  NEXTJS_IMAGE_OPTIMIZATION_MEMORY,
 } from "./constants";
 import { getAllSiteDomains, getDeploymentDomain } from "../../hosting/api";
 import { logger } from "../../logger";
 import { parseStrict } from "../../functions/env";
+import { FrameworksBackendOptions } from "../../firebaseConfig";
 
 const DEFAULT_BUILD_SCRIPT = ["next build"];
 const PUBLIC_DIR = "public";
@@ -677,8 +680,13 @@ export async function ɵcodegenFunctionsDirectory(
   }
 
   // Add the `sharp` library if app is using image optimization
+  let frameworksBackend: FrameworksBackendOptions | undefined;
   if (await isUsingImageOptimization(sourceDir, distDir)) {
     packageJson.dependencies["sharp"] = SHARP_VERSION;
+
+    frameworksBackend = {
+      memory: NEXTJS_IMAGE_OPTIMIZATION_MEMORY,
+    };
   }
 
   const dotEnv: Record<string, string> = {};
@@ -710,7 +718,17 @@ export async function ɵcodegenFunctionsDirectory(
     ),
   );
 
-  return { packageJson, frameworksEntry: "next.js", dotEnv };
+  const result: CodegenFunctionDirectoryResult = {
+    packageJson,
+    frameworksEntry: "next.js",
+    dotEnv,
+  };
+
+  if (frameworksBackend) {
+    result.frameworksBackend = frameworksBackend;
+  }
+
+  return result;
 }
 
 /**