@entur/function-tools 0.0.3 → 0.0.5

package/bin/enturFunctions.js

@@ -5,7 +5,7 @@ import { registerStart } from '../lib/commands/start.js';
 import { registerUnusedExports } from '../lib/commands/unusedExports.js';
 
 const program = new Command();
-program.name("entur-firebase").description("A multi-command CLI built with commander").version("0.0.3").option("-v, --verbose", "Enable verbose output");
+program.name("entur-functions").description("A multi-tool for Firebase functions at Entur").version("0.0.5").option("-v, --verbose", "Enable verbose output");
 registerBuild(program);
 registerDeploy(program);
 registerStart(program);

package/lib/commands/deploy.js

@@ -1,4 +1,3 @@
-import { writeFile } from 'node:fs/promises';
 import { bundle } from '../utils/bundle.js';
 import { flattenDependencies, harmonizeDependencies, calculateDependencies, linkDependencies } from '../utils/dependencies.js';
 import { spawnAsync } from '../utils/exec.js';
@@ -6,7 +5,7 @@ import { getFirebaseJSON, writeFirebaseJSON } from '../utils/firebase.js';
 import { cleanDir, writeJSON } from '../utils/fs.js';
 import { readPackageJSON, getPackageName, writePackageJSON } from '../utils/packageJSON.js';
 import { getWorkspacePackageNames } from '../utils/workspace.js';
-import { resolveProjectConfig } from './utils.js';
+import { resolveProjectConfig, copyEnvFiles } from './utils.js';
 
 function registerDeploy(program) {
     program.command("deploy").description("Deploy the project").option("-o, --output-dir <dir>", "Output directory").option("-P, --project <project id or alias>", "Project id or alias").action(async (options)=>{
@@ -19,7 +18,8 @@ function registerDeploy(program) {
         }
     });
 }
-async function deploy({ projectAlias, projectId, packageJSON, packageRoot, pnpmWorkspaceYAML, projectRoot, outputDir }) {
+async function deploy(projectConfig) {
+    const { projectAlias, projectId, packageJSON, packageRoot, pnpmWorkspaceYAML, projectRoot, outputDir } = projectConfig;
     const { name, version, exports: exports$1 } = await readPackageJSON(packageJSON);
     const workspacePackages = await getWorkspacePackageNames(pnpmWorkspaceYAML);
     const entryFile = new URL(exports$1?.["."] ?? "./index.js", packageRoot);
@@ -29,14 +29,13 @@ async function deploy({ projectAlias, projectId, packageJSON, packageRoot, pnpmW
     const { main, dependencies } = await build(entryFile, outputDir, workspacePackages);
     console.log("⛷️ Prepare deploy");
     const firebaseJSON = await getFirebaseJSON(new URL("firebase.json", projectRoot));
-    await prepareDeploy(getPackageName(name), projectAlias, projectId, {
+    await prepareDeploy(getPackageName(name), {
         name,
         type: "module",
         version,
         main,
         ...dependencies
-    }, firebaseJSON, outputDir);
-    // contentHash,
+    }, firebaseJSON, projectConfig);
     console.log(`🚢 Deploying to ${projectAlias} (${projectId})`);
     await deployToFirebase(outputDir, projectId);
 }
@@ -52,12 +51,17 @@ async function build(entryFile, outputDir, packagesToInline) {
         dependencies
     };
 }
-async function prepareDeploy(codebase, projectAlias, projectId, packageJSON, firebaseJSON, outputDir) {
+async function prepareDeploy(codebase, packageJSON, firebaseJSON, { projectAlias, projectId, outputDir, envFiles }) {
+    const envPrefix = `
+NODE_OPTIONS='--enable-source-maps'
+FUNCTION_CODEBASE='${codebase}'
+ENTUR_PROJECT_ALIAS='${projectAlias}'
+`.trimStart();
     await Promise.all([
         writeFirebaseJSON(codebase, firebaseJSON, outputDir),
         createFirebaseRC(projectAlias, projectId, outputDir),
         writePackageJSON(new URL("./package.json", outputDir), packageJSON),
-        createDotenv(codebase, projectAlias, outputDir)
+        copyEnvFiles(envFiles, envPrefix, outputDir)
     ]);
     await linkDependencies(outputDir);
 }
@@ -80,12 +84,5 @@ function deployToFirebase(workingDir, projectId, extraArgs = []) {
         cwd: workingDir
     });
 }
-async function createDotenv(codebase, projectAlias, outputDir) {
-    const envFile = `
-NODE_OPTIONS='--enable-source-maps'
-FUNCTION_CODEBASE='${codebase}'
-ENTUR_PROJECT_ALIAS='${projectAlias}'`;
-    await writeFile(new URL("./.env", outputDir), envFile.trim());
-}
 
 export { registerDeploy };

package/lib/commands/start.js

@@ -5,12 +5,15 @@ import { getFirebaseJSON, writeFirebaseJSON } from '../utils/firebase.js';
 import { cleanDir, writeJSON } from '../utils/fs.js';
 import { readPackageJSON, getPackageName, writePackageJSON } from '../utils/packageJSON.js';
 import { getWorkspacePackageNames } from '../utils/workspace.js';
-import { resolveProjectConfig } from './utils.js';
+import { resolveProjectConfig, copyEnvFiles } from './utils.js';
 
 function registerStart(program) {
     program.command("start").description("Start function emulator").option("-o, --output-dir <dir>", "Output directory").option("-P, --project <project id or alias>", "Project id or alias").action(async (options)=>{
         try {
-            const projectConfig = await resolveProjectConfig(options);
+            const projectConfig = await resolveProjectConfig({
+                ...options,
+                isEmulator: true
+            });
             await start(projectConfig);
         } catch (error) {
             console.error(error);
@@ -18,7 +21,8 @@ function registerStart(program) {
         }
     });
 }
-async function start({ packageRoot, packageJSON, projectAlias, projectId, projectRoot, pnpmWorkspaceYAML, outputDir }) {
+async function start(projectConfig) {
+    const { packageRoot, packageJSON, projectAlias, projectId, projectRoot, pnpmWorkspaceYAML, outputDir } = projectConfig;
     const { name, version, exports: exports$1 } = await readPackageJSON(packageJSON);
     const codebase = getPackageName(name);
     const packagesToInline = await getWorkspacePackageNames(pnpmWorkspaceYAML);
@@ -33,13 +37,13 @@ async function start({ packageRoot, packageJSON, projectAlias, projectId, projec
         const dependencies = await flattenDependencies(harmonizeDependencies(await calculateDependencies(output)));
         // const { contentHash } = await pack(functionGroupDir, distDir)
         const firebaseJSON = await getFirebaseJSON(new URL("firebase.json", projectRoot));
-        await prepareStart(codebase, projectAlias, projectId, {
+        await prepareStart(codebase, {
             name,
             type: "module",
             version,
             main,
             ...dependencies
-        }, firebaseJSON, outputDir);
+        }, firebaseJSON, projectConfig);
         if (firstRun) {
             firstRun = false;
             runEmulator(codebase, projectAlias, projectId, outputDir, []).catch((error)=>{
@@ -53,11 +57,17 @@ async function start({ packageRoot, packageJSON, projectAlias, projectId, projec
         onBundleEnd
     });
 }
-async function prepareStart(codebase, projectAlias, projectId, packageJSON, firebaseJSON, outputDir) {
+async function prepareStart(codebase, packageJSON, firebaseJSON, { projectAlias, projectId, outputDir, envFiles }) {
+    const envPrefix = `
+NODE_OPTIONS='--enable-source-maps'
+FUNCTION_CODEBASE='${codebase}'
+ENTUR_PROJECT_ALIAS='${projectAlias}'
+`.trimStart();
     await Promise.all([
         writeFirebaseJSON(codebase, firebaseJSON, outputDir),
         createFirebaseRC(projectAlias, projectId, outputDir),
-        writePackageJSON(new URL("./package.json", outputDir), packageJSON)
+        writePackageJSON(new URL("./package.json", outputDir), packageJSON),
+        copyEnvFiles(envFiles, envPrefix, outputDir)
     ]);
     await linkDependencies(outputDir);
 }

package/lib/commands/utils.d.ts

@@ -2,6 +2,7 @@ type Options = {
     outputDir?: string;
     project?: string;
     cwd?: string;
+    isEmulator?: boolean;
 };
 type ProjectConfig = {
     pnpmWorkspaceYAML: URL;
@@ -11,8 +12,10 @@ type ProjectConfig = {
     projectRoot: URL;
     projectAlias: string;
     projectId: string;
+    envFiles: URL[];
 };
-declare function resolveProjectConfig({ outputDir, project, cwd, }?: Options): Promise<ProjectConfig>;
+declare function resolveProjectConfig({ outputDir, project, isEmulator, cwd, }?: Options): Promise<ProjectConfig>;
+declare function copyEnvFiles([envFile, ...envFiles]: URL[], prefix: string, outputDir: URL): Promise<void>;
 
-export { resolveProjectConfig };
+export { copyEnvFiles, resolveProjectConfig };
 export type { ProjectConfig };

package/lib/commands/utils.js

@@ -1,8 +1,12 @@
-import { pathToFileURL } from 'node:url';
+import { readFile, writeFile, cp } from 'node:fs/promises';
+import { basename } from 'node:path';
+import { pathToFileURL, fileURLToPath } from 'node:url';
 import { findUp } from 'find-up-simple';
-import { readJSON } from '../utils/fs.js';
+import { asyncFilterMap } from '../utils/async.js';
+import { readJSON, exists } from '../utils/fs.js';
 
-async function resolveProjectConfig({ outputDir = "dist", project, cwd = process.cwd() } = {}) {
+const FUNCTIONS_EMULATOR_DOTENV = ".env.local";
+async function resolveProjectConfig({ outputDir = "dist", project, isEmulator, cwd = process.cwd() } = {}) {
     const [pnpmWorkspacePath, packageJSONPath, firebaseRCPath] = await Promise.all([
         findUp("pnpm-workspace.yaml", {
             cwd
@@ -28,14 +32,18 @@ async function resolveProjectConfig({ outputDir = "dist", project, cwd = process
     const outputDirUrl = new URL(`./${outputDir}/`, `${pathToFileURL(cwd)}/`);
     const pnpmWorkspaceYAML = pathToFileURL(pnpmWorkspacePath);
     const packageJSONUrl = pathToFileURL(packageJSONPath);
+    const packageRoot = new URL("./", packageJSONUrl);
+    const projectRoot = new URL("./", pnpmWorkspaceYAML);
+    const envFiles = await findEnvFiles(packageRoot, projectId, projectAlias, isEmulator);
     return {
         pnpmWorkspaceYAML,
         packageJSON: packageJSONUrl,
         outputDir: outputDirUrl,
-        packageRoot: new URL("./", packageJSONUrl),
-        projectRoot: new URL("./", pnpmWorkspaceYAML),
+        packageRoot,
+        projectRoot,
         projectAlias,
-        projectId
+        projectId,
+        envFiles
     };
 }
 function getProjectAliasAndId({ default: defaultProjectId, ...projects }, project) {
@@ -67,5 +75,34 @@ function getProjectAliasAndId({ default: defaultProjectId, ...projects }, projec
     }
     throw new Error(`No project with alias or id ${project} found in .firebaserc`);
 }
+function findEnvFiles(packageRoot, projectId, projectAlias, isEmulator) {
+    const files = [
+        ".env"
+    ];
+    files.push(`.env.${projectId}`);
+    if (projectAlias) {
+        files.push(`.env.${projectAlias}`);
+    }
+    if (isEmulator) {
+        files.push(FUNCTIONS_EMULATOR_DOTENV);
+    }
+    return asyncFilterMap(files, async (fileName)=>{
+        const fileUrl = new URL(`./${fileName}`, packageRoot);
+        return await exists(fileUrl) ? fileUrl : undefined;
+    });
+}
+async function copyEnvFiles([envFile, ...envFiles], prefix, outputDir) {
+    if (envFile) {
+        const fileContent = await readFile(envFile, "utf8");
+        const fileName = basename(fileURLToPath(envFile));
+        await writeFile(new URL(`./${fileName}`, outputDir), prefix.trimStart() + fileContent);
+    } else {
+        await writeFile(new URL("./.env", outputDir), prefix);
+    }
+    for (const envFile of envFiles){
+        const fileName = basename(fileURLToPath(envFile));
+        await cp(envFile, new URL(`./${fileName}`, outputDir));
+    }
+}
 
-export { resolveProjectConfig };
+export { copyEnvFiles, resolveProjectConfig };

package/lib/index.d.ts

@@ -1,3 +1,3 @@
-export { ProjectConfig, resolveProjectConfig } from './commands/utils.js';
+export { ProjectConfig, copyEnvFiles, resolveProjectConfig } from './commands/utils.js';
 export { Export, getExports } from './importExports/exports.js';
 export { Import, getImports } from './importExports/imports.js';

package/lib/index.js

@@ -1,3 +1,3 @@
-export { resolveProjectConfig } from './commands/utils.js';
+export { copyEnvFiles, resolveProjectConfig } from './commands/utils.js';
 export { getExports } from './importExports/exports.js';
 export { getImports } from './importExports/imports.js';

package/lib/utils/fs.js

@@ -1,4 +1,4 @@
-import { rm, mkdir, readFile, writeFile } from 'node:fs/promises';
+import { rm, mkdir, readFile, writeFile, access } from 'node:fs/promises';
 
 async function cleanDir(dir) {
     await rm(dir, {
@@ -9,6 +9,14 @@ async function cleanDir(dir) {
         recursive: true
     });
 }
+async function exists(fileOrDirectory) {
+    try {
+        await access(fileOrDirectory);
+        return true;
+    } catch  {
+        return false;
+    }
+}
 async function readJSON(file) {
     const fileContent = await readFile(file, "utf-8");
     return JSON.parse(fileContent);
@@ -17,4 +25,4 @@ async function writeJSON(file, data) {
     await writeFile(file, JSON.stringify(data, undefined, 4));
 }
 
-export { cleanDir, readJSON, writeJSON };
+export { cleanDir, exists, readJSON, writeJSON };

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@entur/function-tools",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "publishConfig": {
     "access": "public"
   },
   "bin": {
     "entur-functions": "./bin/enturFunctions.js"
   },
+  "exports": {
+    ".": "./lib/index.js"
+  },
   "dependencies": {
     "@rollup/plugin-swc": "^0.4.0",
     "@rollup/plugin-node-resolve": "^16.0.3",