Warn the user if their local build output is larger than 250MB

src/deploy/apphosting/util.spec.ts

@@ -4,6 +4,7 @@ import * as path from "path";
 import * as tmp from "tmp";
 import * as tar from "tar";
 import * as util from "./util";
+import { FirebaseError } from "../../error";
 
 describe("util", () => {
   let tmpDir: tmp.DirResult;
@@ -78,5 +79,24 @@ describe("util", () => {
       expect(files).to.include("dist/index.js");
       expect(files).to.not.include("apphosting.yaml");
     });
+
+    it("should throw an error if local build archive size exceeds limit", async () => {
+      fs.writeFileSync(path.join(distDir, "index.js"), "console.log('hello')");
+
+      const config = {
+        backendId: "test-backend",
+        rootDir: "",
+        ignore: [],
+        localBuild: true,
+      };
+
+      try {
+        await util.createLocalBuildTarArchive(config, rootDir, path.relative(rootDir, distDir), 1);
+        expect.fail("Should have thrown an error");
+      } catch (err: unknown) {
+        expect(err).to.be.instanceOf(FirebaseError);
+        expect((err as FirebaseError).message).to.match(/The final build artifact is larger than/);
+      }
+    });
   });
 });

src/deploy/apphosting/util.ts

@@ -24,6 +24,7 @@
   config: AppHostingSingle,
   rootDir: string,
   targetSubDir?: string,
+  sizeLimitBytes: number = 250 * 1024 * 1024,
 ): Promise<string> {
   const tmpFile = tmp.fileSync({ prefix: `${config.backendId}-`, postfix: ".tar.gz" }).name;
 
@@ -69,6 +70,16 @@
     },
     allFiles,
   );
+
+  const stats = fs.statSync(tmpFile);
+  if (config.localBuild && stats.size > sizeLimitBytes) {
+    const sizeInMB = stats.size / (1024 * 1024);
+    const limitInMB = sizeLimitBytes / (1024 * 1024);
+    throw new FirebaseError(
+      `The final build artifact is larger than ${limitInMB.toFixed(0)}MB (current size: ${sizeInMB.toFixed(2)}MB). Please reduce the size of your build artifacts.`,
+    );
+  }
+
   return tmpFile;
 }
 
@@ -110,7 +121,7 @@
     await pipeAsync(archive, fileStream);
   } catch (err: unknown) {
     throw new FirebaseError(
       `Could not read source directory. Remove links and shortcuts and try again. Original: ${err}`,
       { original: err as Error, exit: 1 },
     );
   }