Merge pull request #656 from 2chanhaeng/main

Fixed errors occurring when using certain web framework integration packages and MySQL options simultaneously in `@fedify/init`

Author: dahlia

CHANGES.md

@@ -47,6 +47,17 @@ To be released.
 [#601]: https://github.com/fedify-dev/fedify/pull/601
 [#652]: https://github.com/fedify-dev/fedify/pull/652
 
+### @fedify/init
+
+ -  Fixed errors when using `fedify init` with certain web framework
+    integration packages (Astro, ElysiaJS, Nitro) alongside `@fedify/mysql`.
+    Environment variables are now properly loaded at runtime, resolving the
+    `TypeError: Cannot read properties of undefined` from `mysql2`.
+    [[#649], [#656] by ChanHaeng Lee]
+
+[#649]: https://github.com/fedify-dev/fedify/issues/649
+[#656]: https://github.com/fedify-dev/fedify/pull/656
+
 
 Version 2.1.4
 -------------

cspell.json

@@ -28,9 +28,11 @@
     "dereferenceable",
     "discoverability",
     "docloader",
+    "dotenvx",
     "draft-cavage",
     "eddsa",
     "elysia",
+    "elysiajs",
     "fanout",
     "federatable",
     "Federatable",

mise.toml

@@ -176,6 +176,7 @@ run = "deno run -A examples/test-examples/mod.ts"
 [tasks."test:init"]
 description = "Run tests for the init package"
 run = "deno task -f @fedify/init test-init"
+depends = ["prepare"]
 
 # Snapshot updates
 # Note: vocab uses @std/testing/snapshot which only works on Deno

packages/init/src/action/deps.ts

@@ -13,7 +13,7 @@ import { PACKAGE_VERSION } from "../lib.ts";
 import type { InitCommandData, PackageManager } from "../types.ts";
 import { merge, replace } from "../utils.ts";
 import { getPackagesPath } from "./const.ts";
-import { isDeno } from "./utils.ts";
+import { isDeno, needsDenoDotenv } from "./utils.ts";
 
 type Deps = Record<string, string>;
 
@@ -26,16 +26,18 @@ type Deps = Record<string, string>;
  * @returns A record of dependencies with their versions
  */
 export const getDependencies = (
-  { initializer, kv, mq, testMode, packageManager }: Pick<
+  { initializer, kv, mq, env, testMode, packageManager }: Pick<
     InitCommandData,
-    "initializer" | "kv" | "mq" | "packageManager" | "testMode"
+    "initializer" | "kv" | "mq" | "env" | "packageManager" | "testMode"
   >,
 ): Deps =>
   pipe(
     {
       "@fedify/fedify": PACKAGE_VERSION,
       "@fedify/vocab": PACKAGE_VERSION,
       "@logtape/logtape": deps["@logtape/logtape"],
+      ...(needsDenoDotenv({ packageManager, env }) &&
+        { "@std/dotenv": deps["@std/dotenv"] }),
     },
     merge(initializer.dependencies),
     merge(kv.dependencies),

packages/init/src/action/patch.ts

@@ -1,9 +1,9 @@
 import { always, apply, entries, map, pipe, pipeLazy, tap } from "@fxts/core";
 import { toMerged } from "es-toolkit";
 import { readFile } from "node:fs/promises";
-import { formatJson, merge, replaceAll, set } from "../utils.ts";
 import { createFile, throwUnlessNotExists } from "../lib.ts";
 import type { InitCommandData } from "../types.ts";
+import { formatJson, merge, replaceAll, set } from "../utils.ts";
 import {
   devToolConfigs,
   loadDenoConfig,

packages/init/src/action/set.ts

@@ -12,6 +12,7 @@ import type {
   MessageQueue,
   MessageQueueDescription,
   WebFrameworkDescription,
+  WebFrameworkInitializer,
 } from "../types.ts";
 import webFrameworks from "../webframeworks/mod.ts";
 
@@ -58,6 +59,11 @@ const setMq = set(
 const setEnv = set(
   "env",
   <
-    T extends { kv: KvStoreDescription; mq: MessageQueueDescription },
-  >({ kv, mq }: T) => merge(kv.env)(mq.env),
+    T extends {
+      initializer: WebFrameworkInitializer;
+      kv: KvStoreDescription;
+      mq: MessageQueueDescription;
+    },
+  >({ initializer, kv, mq }: T) =>
+    merge(initializer.env)(merge(kv.env)(mq.env)),
 );

packages/init/src/action/templates.ts

@@ -1,14 +1,17 @@
-import { entries, join, map, pipe } from "@fxts/core";
+import { concat, entries, join, map, pipe, when } from "@fxts/core";
 import { toMerged } from "es-toolkit";
-import { replace } from "../utils.ts";
 import { readTemplate } from "../lib.ts";
 import type { InitCommandData, PackageManager } from "../types.ts";
+import { replace } from "../utils.ts";
+import { needsDenoDotenv } from "./utils.ts";
 
 /**
  * Loads the federation configuration file content from template.
- * Reads the default federation template and replaces placeholders with actual configuration values.
+ * Reads the default federation template and replaces placeholders with actual
+ * configuration values.
  *
- * @param param0 - Configuration object containing imports, project name, KV store, message queue, and package manager
+ * @param param0 - Configuration object containing imports, project name,
+ * KV store, message queue, and package manager
  * @returns The complete federation configuration file content as a string
  */
 export const loadFederation = async (
@@ -43,12 +46,19 @@ export const loadLogging = async ({ projectName }: InitCommandData) =>
 
 /**
  * Generates import statements for KV store and message queue dependencies.
- * Merges imports from both KV and MQ configurations and creates proper ES module import syntax.
+ * Merges imports from both KV and MQ configurations and creates proper
+ * ES module import syntax.
  *
- * @param param0 - Destructured object containing kv and mq configurations
+ * Destructured parameters:
+ * - kv: KV store configuration, including module import mappings
+ * - mq: Message queue configuration, including module import mappings
+ * - packageManager: Package manager used for environment-specific handling
+ * - env: Environment variable setup used to determine loading requirements
+ *
+ * @param param0 - InitCommandData containing kv, mq, packageManager, and env
  * @returns A multi-line string containing all necessary import statements
  */
-export const getImports = ({ kv, mq }: InitCommandData) =>
+export const getImports = ({ kv, mq, packageManager, env }: InitCommandData) =>
   pipe(
     toMerged(kv.imports, mq.imports),
     entries,
@@ -61,12 +71,17 @@ export const getImports = ({ kv, mq }: InitCommandData) =>
           .join(", ")
       } from ${JSON.stringify(module)};`
     ),
+    when(
+      () => needsDenoDotenv({ packageManager, env }),
+      concat(['import "@std/dotenv/load";']),
+    ),
     join("\n"),
   );
 
 /**
  * Converts import mappings to named import string with aliases.
- * Creates proper ES module named import syntax, using aliases when the import name differs from the local name.
+ * Creates proper ES module named import syntax, using aliases when the import
+ * name differs from the local name.
  *
  * @param imports - A record mapping import names to their local aliases
  * @returns A comma-separated string of named imports with aliases where needed
@@ -81,12 +96,16 @@ export const getAlias = (imports: Record<string, string>) =>
 
 const ENV_REG_EXP = /process\.env\.(\w+)/g;
 /**
- * Converts Node.js environment variable access to Deno-compatible syntax when needed.
- * Transforms `process.env.VAR_NAME` to `Deno.env.get("VAR_NAME")` for Deno projects.
+ * Converts Node.js environment variable access to Deno-compatible syntax when
+ * needed.
+ * Transforms `process.env.VAR_NAME` to `Deno.env.get("VAR_NAME")` for Deno
+ * projects.
  *
- * @param obj - The object string containing potential environment variable references
+ * @param obj - The object string containing potential environment variable
+ * references
  * @param pm - The package manager (runtime) being used
- * @returns The converted object string with appropriate environment variable access syntax
+ * @returns The converted object string with appropriate environment variable
+ * access syntax
  */
 export const convertEnv = (obj: string, pm: PackageManager) =>
   pm === "deno" && ENV_REG_EXP.test(obj)

packages/init/src/action/utils.ts

@@ -13,6 +13,14 @@ export const isDeno = (
   { packageManager }: Pick<InitCommandData, "packageManager">,
 ) => packageManager === "deno";
 
+/**
+ * Returns `true` when the `@std/dotenv` dependency should be included:
+ * the project uses Deno and has at least one environment variable to load.
+ */
+export const needsDenoDotenv = (
+  { packageManager, env }: Pick<InitCommandData, "packageManager" | "env">,
+) => packageManager === "deno" && Object.keys(env).length > 0;
+
 /**
  * Returns a function that prepends the project directory to a
  * `[filename, content]` tuple, resolving the filename into an absolute path.

packages/init/src/templates/bare-bones/main/deno.ts.tpl

@@ -1,4 +1,3 @@
-import "@std/dotenv/load";
 import { behindProxy } from "@hongminhee/x-forwarded-fetch";
 import federation from "./federation.ts";
 import "./logging.ts";

packages/init/src/templates/hono/index/deno.ts.tpl

@@ -1,5 +1,4 @@
 import { behindProxy } from "@hongminhee/x-forwarded-fetch";
-import "@std/dotenv/load";
 import app from "./app.tsx";
 import "./logging.ts";