@eggjs/utils 3.0.1 → 4.0.0

package/src/plugin.ts

@@ -0,0 +1,162 @@
+import { debuglog } from 'node:util';
+import path from 'node:path';
+import assert from 'node:assert';
+import os from 'node:os';
+import { stat, mkdir, writeFile, realpath } from 'node:fs/promises';
+import { importModule } from './import.js';
+
+const debug = debuglog('@eggjs/utils:plugin');
+
+const tmpDir = os.tmpdir();
+
+function noop() {}
+
+const logger = {
+  debug: noop,
+  info: noop,
+  warn: noop,
+  error: noop,
+};
+
+export interface LoaderOptions {
+  framework: string;
+  baseDir: string;
+  env?: string;
+}
+
+export interface Plugin {
+  name: string;
+  version?: string;
+  enable: boolean;
+  implicitEnable: boolean;
+  path: string;
+  dependencies: string[];
+  optionalDependencies: string[];
+  env: string[];
+  from: string;
+}
+
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/mixin/plugin.js#L203
+ */
+export async function getPlugins(options: LoaderOptions) {
+  const loader = await getLoader(options);
+  await loader.loadPlugin();
+  return loader.allPlugins;
+}
+
+interface Unit {
+  type: 'plugin' | 'framework' | 'app';
+  path: string;
+}
+
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/egg_loader.js#L348
+ */
+export async function getLoadUnits(options: LoaderOptions) {
+  const loader = await getLoader(options);
+  await loader.loadPlugin();
+  return loader.getLoadUnits();
+}
+
+export async function getConfig(options: LoaderOptions) {
+  const loader = await getLoader(options);
+  await loader.loadPlugin();
+  await loader.loadConfig();
+  return loader.config;
+}
+
+async function exists(filepath: string) {
+  try {
+    await stat(filepath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+interface IEggLoader {
+  loadPlugin(): Promise<void>;
+  loadConfig(): Promise<void>;
+  config: Record<string, any>;
+  getLoadUnits(): Unit[];
+  allPlugins: Record<string, Plugin>;
+}
+
+interface IEggLoaderOptions {
+  baseDir: string;
+  app: unknown;
+  logger: object;
+  EggCoreClass?: unknown;
+}
+
+type EggLoaderImplClass<T = IEggLoader> = new(options: IEggLoaderOptions) => T;
+
+async function getLoader(options: LoaderOptions) {
+  assert(options.framework, 'framework is required');
+  assert(await exists(options.framework), `${options.framework} should exist`);
+  if (!(options.baseDir && await exists(options.baseDir))) {
+    options.baseDir = path.join(tmpDir, 'egg_utils', `${Date.now()}`, 'tmp_app');
+    await mkdir(options.baseDir, { recursive: true });
+    await writeFile(path.join(options.baseDir, 'package.json'), JSON.stringify({
+      name: 'tmp_app',
+    }));
+    debug('[getLoader] create baseDir: %o', options.baseDir);
+  }
+
+  const { EggCore, EggLoader } = await findEggCore(options);
+  const mod = await importModule(options.framework);
+  const Application = mod.Application ?? mod.default?.Application;
+  assert(Application, `Application not export on ${options.framework}`);
+  if (options.env) {
+    process.env.EGG_SERVER_ENV = options.env;
+  }
+  return new EggLoader({
+    baseDir: options.baseDir,
+    logger,
+    app: Object.create(Application.prototype),
+    EggCoreClass: EggCore,
+  });
+}
+
+async function findEggCore(options: LoaderOptions): Promise<{ EggCore?: object; EggLoader: EggLoaderImplClass }> {
+  const baseDirRealpath = await realpath(options.baseDir);
+  const frameworkRealpath = await realpath(options.framework);
+  const paths = [ frameworkRealpath, baseDirRealpath ];
+  // custom framework => egg => @eggjs/core
+  try {
+    const { EggCore, EggLoader } = await importModule('egg', { paths });
+    if (EggLoader) {
+      return { EggCore, EggLoader };
+    }
+  } catch (err: any) {
+    debug('[findEggCore] import "egg" from paths:%o error: %o', paths, err);
+  }
+
+  const name = '@eggjs/core';
+  // egg => egg-core
+  try {
+    const { EggCore, EggLoader } = await importModule(name, { paths });
+    if (EggLoader) {
+      return { EggCore, EggLoader };
+    }
+  } catch (err: any) {
+    debug('[findEggCore] import "%s" from paths:%o error: %o', name, paths, err);
+  }
+
+  try {
+    const { EggCore, EggLoader } = await importModule(name);
+    if (EggLoader) {
+      return { EggCore, EggLoader };
+    }
+  } catch (err: any) {
+    debug('[findEggCore] import "%s" error: %o', name, err);
+  }
+
+  let eggCorePath = path.join(options.baseDir, `node_modules/${name}`);
+  if (!(await exists(eggCorePath))) {
+    eggCorePath = path.join(options.framework, `node_modules/${name}`);
+  }
+  assert(await exists(eggCorePath), `Can't find ${name} from ${options.baseDir} and ${options.framework}`);
+  return await importModule(eggCorePath);
+}

package/src/utils.ts

@@ -0,0 +1,8 @@
+import { existsSync, readFileSync } from 'node:fs';
+
+export function readJSONSync(file: string) {
+  if (!existsSync(file)) {
+    throw new Error(`${file} is not found`);
+  }
+  return JSON.parse(readFileSync(file, 'utf-8'));
+}

package/lib/deprecated.js

@@ -1,59 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFrameworkOrEggPath = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const node_fs_1 = require("node:fs");
-const utils_1 = require("./utils");
-/**
- * Try to get framework dir path
- * If can't find any framework, try to find egg dir path
- *
- * @param {String} cwd - current work path
- * @param {Array} [eggNames] - egg names, default is ['egg']
- * @return {String} framework or egg dir path
- * @deprecated
- */
-function getFrameworkOrEggPath(cwd, eggNames) {
-    eggNames = eggNames || ['egg'];
-    const moduleDir = node_path_1.default.join(cwd, 'node_modules');
-    if (!(0, node_fs_1.existsSync)(moduleDir)) {
-        return '';
-    }
-    // try to get framework
-    // 1. try to read egg.framework property on package.json
-    const pkgFile = node_path_1.default.join(cwd, 'package.json');
-    if ((0, node_fs_1.existsSync)(pkgFile)) {
-        const pkg = (0, utils_1.readJSONSync)(pkgFile);
-        if (pkg.egg && pkg.egg.framework) {
-            return node_path_1.default.join(moduleDir, pkg.egg.framework);
-        }
-    }
-    // 2. try the module dependencies includes eggNames
-    const names = (0, node_fs_1.readdirSync)(moduleDir);
-    for (const name of names) {
-        const pkgfile = node_path_1.default.join(moduleDir, name, 'package.json');
-        if (!(0, node_fs_1.existsSync)(pkgfile)) {
-            continue;
-        }
-        const pkg = (0, utils_1.readJSONSync)(pkgfile);
-        if (pkg.dependencies) {
-            for (const eggName of eggNames) {
-                if (pkg.dependencies[eggName]) {
-                    return node_path_1.default.join(moduleDir, name);
-                }
-            }
-        }
-    }
-    // try to get egg
-    for (const eggName of eggNames) {
-        const pkgfile = node_path_1.default.join(moduleDir, eggName, 'package.json');
-        if ((0, node_fs_1.existsSync)(pkgfile)) {
-            return node_path_1.default.join(moduleDir, eggName);
-        }
-    }
-    return '';
-}
-exports.getFrameworkOrEggPath = getFrameworkOrEggPath;

package/lib/index.d.ts

@@ -1,14 +0,0 @@
-import { getFrameworkPath } from './framework';
-import { getPlugins, getConfig, getLoadUnits } from './plugin';
-import { getFrameworkOrEggPath } from './deprecated';
-export { getFrameworkPath } from './framework';
-export { getPlugins, getConfig, getLoadUnits } from './plugin';
-export { getFrameworkOrEggPath } from './deprecated';
-declare const _default: {
-    getFrameworkPath: typeof getFrameworkPath;
-    getPlugins: typeof getPlugins;
-    getConfig: typeof getConfig;
-    getLoadUnits: typeof getLoadUnits;
-    getFrameworkOrEggPath: typeof getFrameworkOrEggPath;
-};
-export default _default;

package/lib/index.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFrameworkOrEggPath = exports.getLoadUnits = exports.getConfig = exports.getPlugins = exports.getFrameworkPath = void 0;
-const framework_1 = require("./framework");
-const plugin_1 = require("./plugin");
-const deprecated_1 = require("./deprecated");
-// support import { getFrameworkPath } from '@eggjs/utils'
-var framework_2 = require("./framework");
-Object.defineProperty(exports, "getFrameworkPath", { enumerable: true, get: function () { return framework_2.getFrameworkPath; } });
-var plugin_2 = require("./plugin");
-Object.defineProperty(exports, "getPlugins", { enumerable: true, get: function () { return plugin_2.getPlugins; } });
-Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return plugin_2.getConfig; } });
-Object.defineProperty(exports, "getLoadUnits", { enumerable: true, get: function () { return plugin_2.getLoadUnits; } });
-var deprecated_2 = require("./deprecated");
-Object.defineProperty(exports, "getFrameworkOrEggPath", { enumerable: true, get: function () { return deprecated_2.getFrameworkOrEggPath; } });
-// support import utils from '@eggjs/utils'
-exports.default = {
-    getFrameworkPath: framework_1.getFrameworkPath,
-    getPlugins: plugin_1.getPlugins, getConfig: plugin_1.getConfig, getLoadUnits: plugin_1.getLoadUnits,
-    getFrameworkOrEggPath: deprecated_1.getFrameworkOrEggPath,
-};

package/lib/plugin.js

@@ -1,98 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-var-requires */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfig = exports.getLoadUnits = exports.getPlugins = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_os_1 = __importDefault(require("node:os"));
-const node_fs_1 = require("node:fs");
-const tmpDir = node_os_1.default.tmpdir();
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-function noop() { }
-const logger = {
-    debug: noop,
-    info: noop,
-    warn: noop,
-    error: noop,
-};
-/**
- * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/mixin/plugin.js#L203
- */
-function getPlugins(options) {
-    const loader = getLoader(options);
-    loader.loadPlugin();
-    return loader.allPlugins;
-}
-exports.getPlugins = getPlugins;
-/**
- * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/egg_loader.js#L348
- */
-function getLoadUnits(options) {
-    const loader = getLoader(options);
-    loader.loadPlugin();
-    return loader.getLoadUnits();
-}
-exports.getLoadUnits = getLoadUnits;
-function getConfig(options) {
-    const loader = getLoader(options);
-    loader.loadPlugin();
-    loader.loadConfig();
-    return loader.config;
-}
-exports.getConfig = getConfig;
-function getLoader(options) {
-    let { framework, baseDir, env } = options;
-    (0, node_assert_1.default)(framework, 'framework is required');
-    (0, node_assert_1.default)((0, node_fs_1.existsSync)(framework), `${framework} should exist`);
-    if (!(baseDir && (0, node_fs_1.existsSync)(baseDir))) {
-        baseDir = node_path_1.default.join(tmpDir, String(Date.now()), 'tmpapp');
-        (0, node_fs_1.mkdirSync)(baseDir, { recursive: true });
-        (0, node_fs_1.writeFileSync)(node_path_1.default.join(baseDir, 'package.json'), JSON.stringify({ name: 'tmpapp' }));
-    }
-    const EggLoader = findEggCore({ baseDir, framework });
-    const { Application } = require(framework);
-    if (env)
-        process.env.EGG_SERVER_ENV = env;
-    return new EggLoader({
-        baseDir,
-        logger,
-        app: Object.create(Application.prototype),
-    });
-}
-function findEggCore({ baseDir, framework }) {
-    const baseDirRealpath = (0, node_fs_1.realpathSync)(baseDir);
-    const frameworkRealpath = (0, node_fs_1.realpathSync)(framework);
-    // custom framework => egg => egg/lib/loader/index.js
-    try {
-        return require(require.resolve('egg/lib/loader', {
-            paths: [frameworkRealpath, baseDirRealpath],
-        })).EggLoader;
-    }
-    catch {
-        // ignore
-    }
-    const name = 'egg-core';
-    // egg => egg-core
-    try {
-        return require(require.resolve(name, {
-            paths: [frameworkRealpath, baseDirRealpath],
-        })).EggLoader;
-    }
-    catch {
-        // ignore
-    }
-    try {
-        return require(name).EggLoader;
-    }
-    catch {
-        let eggCorePath = node_path_1.default.join(baseDir, `node_modules/${name}`);
-        if (!(0, node_fs_1.existsSync)(eggCorePath)) {
-            eggCorePath = node_path_1.default.join(framework, `node_modules/${name}`);
-        }
-        (0, node_assert_1.default)((0, node_fs_1.existsSync)(eggCorePath), `Can't find ${name} from ${baseDir} and ${framework}`);
-        return require(eggCorePath).EggLoader;
-    }
-}

package/lib/utils.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readJSONSync = void 0;
-const node_fs_1 = require("node:fs");
-function readJSONSync(file) {
-    if (!(0, node_fs_1.existsSync)(file)) {
-        throw new Error(`${file} is not found`);
-    }
-    return JSON.parse((0, node_fs_1.readFileSync)(file, 'utf-8'));
-}
-exports.readJSONSync = readJSONSync;