Pack for local deploy & address potential name collisions in express

Author: jamesdaniels

package.json

@@ -21,7 +21,7 @@
     "ssr"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc && ts-node ./tools/build.ts",
+    "build": "rm -rf dist && tsc && ts-node ./tools/build.ts && npm pack .",
     "test": "echo \"Error: no test specified\" && exit 1",
     "e2e:build-next": "rm -rf e2e && npx create-next-app e2e --use-npm --ts",
     "e2e:build-nuxt": "rm -rf e2e && npx create-nuxt-app e2e --answers '$(cat ./tools/create-nuxt-answers.json)'",

src/frameworks/express/index.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import { promises as fsPromises } from 'fs';
-import { dirname, join } from 'path';
+import { join } from 'path';
 
 import { DeployConfig, PathFactory, exec, spawn } from '../../utils';
 
@@ -72,7 +72,7 @@ export const build = async (config: DeployConfig | Required<DeployConfig>, getPr
     let bootstrapScript = '';
     if (serverRenderMethod) {
         let stack = serverRenderMethod.slice();
-        const entry = `./${packageJson.main || 'index.js'}`;
+        const entry = packageJson.name;
         if (stack.shift() === 'require') {
             bootstrapScript += `const bootstrap = Promise.resolve(require('${entry}'))`;
         } else {
@@ -105,19 +105,11 @@ export const build = async (config: DeployConfig | Required<DeployConfig>, getPr
     }
 
     if (serverRenderMethod) {
-        const npmPackResults = JSON.parse(await exec(`npm pack ${getProjectPath()} --dry-run --json`) as string);
-
-        await Promise.all(
-            // TODO types
-            npmPackResults.
-                find(({ name }: any) => name === packageJson.name ).
-                files.
-                map(({ path }: any) =>
-                    mkdir(dirname(deployPath('functions', path)), { recursive: true }).then(() =>
-                        copyFile(getProjectPath(path), deployPath('functions', path))
-                    )
-                )
-        );
+        const npmPackResults = JSON.parse(await exec(`npm pack ${getProjectPath()} --json`, { cwd: deployPath('functions')}) as string);
+        const matchingPackResult = npmPackResults.find((it: any) => it.name === packageJson.name);
+        const { filename } = matchingPackResult;
+        packageJson.dependencies ||= {};
+        packageJson.dependencies[packageJson.name] = `file:${filename}`;
     }
 
     return { usingCloudFunctions: !!serverRenderMethod, framework: 'express', rewrites: [], redirects: [], headers: [], packageJson, bootstrapScript };

src/index.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { join } from 'path';
+import { basename, join } from 'path';
 import { exit } from 'process';
 import { promises as fs } from 'fs';
 
@@ -123,7 +123,14 @@ export const prepare = async (targetNames: string[], context: any, options: any)
             packageJson.main = 'server.js';
             delete packageJson.devDependencies;
             packageJson.dependencies ||= {};
-            packageJson.dependencies['firebase-frameworks'] = FIREBASE_FRAMEWORKS_VERSION;
+            if (FIREBASE_FRAMEWORKS_VERSION.startsWith('file:')) {
+                const file = FIREBASE_FRAMEWORKS_VERSION.split(':')[1];
+                const filename = basename(file);
+                await copyFile(file, join(functionsDist, filename));
+                packageJson.dependencies['firebase-frameworks'] = `file:${filename}`;
+            } else {
+                packageJson.dependencies['firebase-frameworks'] = FIREBASE_FRAMEWORKS_VERSION;
+            }
             // TODO test these with semver, error if already set out of range
             packageJson.dependencies['firebase-admin'] ||= FIREBASE_ADMIN_VERSION;
             packageJson.dependencies['firebase-functions'] ||= FIREBASE_FUNCTIONS_VERSION;

tools/build.ts

@@ -49,7 +49,7 @@ const main = async () => {
     const { version } = require('../package.json');
     const npmList = JSON.parse(spawnSync('npm', ['list', '--json=true'], { encoding: 'utf8' }).stdout.toString());
     const from = ['__FIREBASE_FRAMEWORKS_VERSION__'];
-    const to = [`file:${process.cwd()}`];
+    const to = [`file:${process.cwd()}/firebase-frameworks-${version}.tgz`];
     for (const [dep, { version }] of Object.entries<Record<string, string>>(npmList.dependencies)) {
         from.push(`__${dep.toUpperCase().replace(/[^A-Z]/g, '_')}_VERSION__`);
         to.push(`^${version}`);