lupine.api 1.1.58 → 1.1.60

package/src/app/app-cache.ts

@@ -1,55 +1,55 @@
-/**
- * A simple settings/config class for storing key/value pairs in memory
- */
-
-import { AppCacheGlobal, AppCacheKeys, IAppCache } from '../models/app-cache-props';
-// For cross clusters sharing, use AppSharedStorage
-// ApiCache doesn't share cross clusters
-// Since apis and app are independent, so AppCache in apis and app are different instances.
-// That's why replaceInstance is used to copy data from app to apis,
-// and also AppCache is not shared cross app and apis, so `set` is only supposed to be called when app starts
-export class AppCache implements IAppCache {
-  private static instance: AppCache;
-
-  cacheMap: { [key: string]: any } = {};
-
-  private constructor() {}
-
-  public static getInstance(): AppCache {
-    if (!AppCache.instance) {
-      AppCache.instance = new AppCache();
-    }
-    return AppCache.instance;
-  }
-
-  clear(appName: string | undefined) {
-    const preKey = appName + '.';
-    Object.keys(this.cacheMap).forEach((key) => {
-      if (!appName || key.startsWith(preKey)) {
-        delete this.cacheMap[key];
-      }
-    });
-  }
-
-  get(appName: string, key: string) {
-    return this.cacheMap[`${appName}.${key}`];
-  }
-
-  set(appName: string, key: string, value: any) {
-    if (typeof value === 'undefined') {
-      delete this.cacheMap[`${appName}.${key}`];
-    } else {
-      this.cacheMap[`${appName}.${key}`] = value;
-    }
-  }
-
-  clearTemplateCache() {
-    const appList = this.get(AppCacheGlobal, AppCacheKeys.APP_LIST) as string[];
-    appList.forEach((appName) => {
-      this.set(appName, AppCacheKeys.TEMPLATE, undefined);
-    });
-  }
-}
-
-// this can be used in app, but in api, it should use getAppCache()
-export const appCache = /* @__PURE__ */ AppCache.getInstance();
+/**
+ * A simple settings/config class for storing key/value pairs in memory
+ */
+
+import { AppCacheGlobal, AppCacheKeys, IAppCache } from '../models/app-cache-props';
+// For cross clusters sharing, use AppSharedStorage
+// ApiCache doesn't share cross clusters
+// Since apis and app are independent, so AppCache in apis and app are different instances.
+// That's why replaceInstance is used to copy data from app to apis,
+// and also AppCache is not shared cross app and apis, so `set` is only supposed to be called when app starts
+export class AppCache implements IAppCache {
+  private static instance: AppCache;
+
+  cacheMap: { [key: string]: any } = {};
+
+  private constructor() {}
+
+  public static getInstance(): AppCache {
+    if (!AppCache.instance) {
+      AppCache.instance = new AppCache();
+    }
+    return AppCache.instance;
+  }
+
+  clear(appName: string | undefined) {
+    const preKey = appName + '.';
+    Object.keys(this.cacheMap).forEach((key) => {
+      if (!appName || key.startsWith(preKey)) {
+        delete this.cacheMap[key];
+      }
+    });
+  }
+
+  get(appName: string, key: string) {
+    return this.cacheMap[`${appName}.${key}`];
+  }
+
+  set(appName: string, key: string, value: any) {
+    if (typeof value === 'undefined') {
+      delete this.cacheMap[`${appName}.${key}`];
+    } else {
+      this.cacheMap[`${appName}.${key}`] = value;
+    }
+  }
+
+  clearTemplateCache() {
+    const appList = this.get(AppCacheGlobal, AppCacheKeys.APP_LIST) as string[];
+    appList.forEach((appName) => {
+      this.set(appName, AppCacheKeys.TEMPLATE, undefined);
+    });
+  }
+}
+
+// this can be used in app, but in api, it should use getAppCache()
+export const appCache = /* @__PURE__ */ AppCache.getInstance();

package/src/app/app-helper.ts

@@ -1,62 +1,62 @@
-import { Logger } from '../lib';
-import path from 'path';
-import { appCache } from './app-cache';
-import { AppCacheKeys, AppLoaderProps, HostToPathProps, IApiModule, setAppCache } from '../models';
-import { appStorage } from './app-shared-storage';
-
-class AppHelper {
-  logger: Logger = new Logger('app-helper');
-
-  constructor() {}
-
-  async loadApi(config: AppLoaderProps) {
-    // const apps: Set<string> = new Set();
-    // for (let key in config.webHostMap) {
-    //   // one app may be defined for multiple hosts, but Set only stores unique values
-    //   apps.add(config.webHostMap[key].appName);
-    //   config.webHostMap[key].webPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_web');
-    //   config.webHostMap[key].dataPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_data');
-    //   config.webHostMap[key].apiPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_api');
-    // }
-
-    for (let appConfig of config.webHostMap) {
-      await this.callInitApi(appConfig);
-      appCache.set(appConfig.appName, AppCacheKeys.API_CONFIG, appConfig);
-    }
-  }
-
-  async callInitApi(appConfig: HostToPathProps) {
-    const apiPath = path.join(process.cwd(), 'dist/server_root', appConfig.appName + '_api/index.js');
-    try {
-      // const module = await import(apiPath);
-      const module = require(apiPath);
-      this.logger.debug(`========= ${appConfig.appName} apiModule: `, module);
-
-      if (module && module.apiModule && typeof module.apiModule.initApi === 'function') {
-        const apiModule = module.apiModule as IApiModule;
-        appCache.set(appConfig.appName, AppCacheKeys.API_MODULE, apiModule);
-
-        // getAppCache should be only called inside api scope, but set it in app scope in case it's used
-        setAppCache(appCache);
-        // setAppStorage(appStorage);
-        await apiModule.initApi(appConfig, appCache, appStorage);
-      }
-    } catch (err: any) {
-      this.logger.error(`appName: ${appConfig.appName}, load api error: `, err);
-    }
-  }
-
-  async refreshApi(appConfig: HostToPathProps) {
-    // TODO: call unloadApi?
-    const apiPath = path.join(process.cwd(), 'dist/server_root', appConfig.appName + '_api/index.js');
-    for (const path in require.cache) {
-      if (path.endsWith('.js') && path.indexOf(apiPath) <= 0) {
-        console.log(`${process.pid} - clear cache: ${path}`);
-        delete require.cache[path];
-      }
-    }
-    await this.callInitApi(appConfig);
-  }
-}
-
-export const appHelper = /* @__PURE__ */ new AppHelper();
+import { Logger } from '../lib';
+import path from 'path';
+import { appCache } from './app-cache';
+import { AppCacheKeys, AppLoaderProps, HostToPathProps, IApiModule, setAppCache } from '../models';
+import { appStorage } from './app-shared-storage';
+
+class AppHelper {
+  logger: Logger = new Logger('app-helper');
+
+  constructor() {}
+
+  async loadApi(config: AppLoaderProps) {
+    // const apps: Set<string> = new Set();
+    // for (let key in config.webHostMap) {
+    //   // one app may be defined for multiple hosts, but Set only stores unique values
+    //   apps.add(config.webHostMap[key].appName);
+    //   config.webHostMap[key].webPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_web');
+    //   config.webHostMap[key].dataPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_data');
+    //   config.webHostMap[key].apiPath = path.join(config.serverRoot, config.webHostMap[key].appName + '_api');
+    // }
+
+    for (let appConfig of config.webHostMap) {
+      await this.callInitApi(appConfig);
+      appCache.set(appConfig.appName, AppCacheKeys.API_CONFIG, appConfig);
+    }
+  }
+
+  async callInitApi(appConfig: HostToPathProps) {
+    const apiPath = path.join(process.cwd(), 'dist/server_root', appConfig.appName + '_api/index.js');
+    try {
+      // const module = await import(apiPath);
+      const module = require(apiPath);
+      this.logger.debug(`========= ${appConfig.appName} apiModule: `, module);
+
+      if (module && module.apiModule && typeof module.apiModule.initApi === 'function') {
+        const apiModule = module.apiModule as IApiModule;
+        appCache.set(appConfig.appName, AppCacheKeys.API_MODULE, apiModule);
+
+        // getAppCache should be only called inside api scope, but set it in app scope in case it's used
+        setAppCache(appCache);
+        // setAppStorage(appStorage);
+        await apiModule.initApi(appConfig, appCache, appStorage);
+      }
+    } catch (err: any) {
+      this.logger.error(`appName: ${appConfig.appName}, load api error: `, err.message);
+    }
+  }
+
+  async refreshApi(appConfig: HostToPathProps) {
+    // TODO: call unloadApi?
+    const apiPath = path.join(process.cwd(), 'dist/server_root', appConfig.appName + '_api/index.js');
+    for (const path in require.cache) {
+      if (path.endsWith('.js') && path.indexOf(apiPath) <= 0) {
+        console.log(`${process.pid} - clear cache: ${path}`);
+        delete require.cache[path];
+      }
+    }
+    await this.callInitApi(appConfig);
+  }
+}
+
+export const appHelper = /* @__PURE__ */ new AppHelper();

package/src/app/app-message.ts

@@ -1,109 +1,109 @@
-import cluster from 'cluster';
-import { Logger, LogWriter, LogWriterMessageId } from '../lib';
-import { processDebugMessage, sendRestartAppMsgToLoader } from './process-dev-requests';
-import { cleanupAndExit } from './cleanup-exit';
-
-export type AppMessageProps = {
-  id: string;
-  message: string;
-  appName?: string;
-  [id: string]: any;
-};
-const _savedMessageHandler: {
-  fromPrimary: { [messageId: string]: (msgObject: AppMessageProps) => void };
-  fromWorker: { [messageId: string]: (msgObject: AppMessageProps) => void };
-} = {
-  fromPrimary: {},
-  fromWorker: {},
-};
-
-export const registerMessageHandlerFromPrimary = (messageId: string, handler: (msgObject: AppMessageProps) => void) => {
-  _savedMessageHandler.fromPrimary[messageId] = handler;
-};
-
-export const registerMessageHandlerFromWorker = (messageId: string, handler: (msgObject: AppMessageProps) => void) => {
-  _savedMessageHandler.fromWorker[messageId] = handler;
-};
-
-const logger = new Logger('app-message');
-// send msg to all clients
-const broadcast = (msgObject: AppMessageProps) => {
-  for (let i in cluster.workers) {
-    if (cluster.workers[i]) cluster.workers[i].send(msgObject);
-  }
-};
-
-// this is a worker and msg is from Primary
-// when debug is on, it's in primary, but it shouldn't receive those msgs
-export const processMessageFromPrimary = (msgObject: AppMessageProps) => {
-  if (!msgObject || !msgObject.id) {
-    logger.warn(`Unknown message from master in work: ${cluster.worker?.id}`);
-    return;
-  }
-
-  const primaryFn = _savedMessageHandler.fromPrimary[msgObject.id];
-  if (primaryFn) {
-    primaryFn(msgObject);
-    return;
-  }
-
-  if (msgObject.id == 'debug') {
-    processDebugMessage(msgObject);
-    // } else if (msgObject.id == AppSharedStorageMessageId) {
-    //   appStorage.messageFromPrimaryProcess(msgObject);
-  } else {
-    logger.warn(`Unknown message: ${msgObject.id}`);
-  }
-};
-
-// this is primary, msg is from a client
-export const processMessageFromWorker = (msgObject: AppMessageProps) => {
-  if (!msgObject || !msgObject.id) {
-    if (msgObject['watch:require']) return;
-    logger.warn(`Unknown message from work: ${cluster.worker?.id}`);
-    return;
-  }
-
-  const workerFn = _savedMessageHandler.fromWorker[msgObject.id];
-  if (workerFn) {
-    workerFn(msgObject);
-    return;
-  }
-
-  if (msgObject.id == LogWriterMessageId) {
-    LogWriter.messageFromSubProcess(msgObject as any);
-    // } else if (msgObject.id == AppSharedStorageMessageId) {
-    //   appStorage.messageFromSubProcess(msgObject);
-  } else if (msgObject.id == 'debug') {
-    logger.debug(
-      `Message from worker ${cluster.worker?.id}, message: ${msgObject.message}, appName: ${msgObject.appName}`
-    );
-    if (msgObject.message === 'restartApp') {
-      sendRestartAppMsgToLoader();
-      return;
-    } else if (msgObject.message === 'refresh') {
-      broadcast(msgObject);
-    } else if (msgObject.message === 'shutdown') {
-      broadcast(msgObject);
-      // if it's shutdown, the primary process will exit
-      setTimeout(async () => {
-        console.log(`[server primary] Received shutdown command.`, cluster.workers);
-        await cleanupAndExit();
-      }, 100);
-    } else {
-      logger.warn(`Unknown message: ${msgObject.id}`);
-    }
-  } else {
-    logger.warn(`Unknown message id: ${msgObject.id}`);
-  }
-};
-
-// this is primary, and receive messages from loader
-export const receiveMessageFromLoader = () => {
-  process.on('message', async (msg: AppMessageProps) => {
-    if (msg?.id === 'debug' && msg?.message === 'shutdown') {
-      console.log(`App ${process.pid}: received shutdown message from loader.`);
-      processMessageFromWorker(msg);
-    }
-  });
-};
+import cluster from 'cluster';
+import { Logger, LogWriter, LogWriterMessageId } from '../lib';
+import { processDebugMessage, sendRestartAppMsgToLoader } from './process-dev-requests';
+import { cleanupAndExit } from './cleanup-exit';
+
+export type AppMessageProps = {
+  id: string;
+  message: string;
+  appName?: string;
+  [id: string]: any;
+};
+const _savedMessageHandler: {
+  fromPrimary: { [messageId: string]: (msgObject: AppMessageProps) => void };
+  fromWorker: { [messageId: string]: (msgObject: AppMessageProps) => void };
+} = {
+  fromPrimary: {},
+  fromWorker: {},
+};
+
+export const registerMessageHandlerFromPrimary = (messageId: string, handler: (msgObject: AppMessageProps) => void) => {
+  _savedMessageHandler.fromPrimary[messageId] = handler;
+};
+
+export const registerMessageHandlerFromWorker = (messageId: string, handler: (msgObject: AppMessageProps) => void) => {
+  _savedMessageHandler.fromWorker[messageId] = handler;
+};
+
+const logger = new Logger('app-message');
+// send msg to all clients
+const broadcast = (msgObject: AppMessageProps) => {
+  for (let i in cluster.workers) {
+    if (cluster.workers[i]) cluster.workers[i].send(msgObject);
+  }
+};
+
+// this is a worker and msg is from Primary
+// when debug is on, it's in primary, but it shouldn't receive those msgs
+export const processMessageFromPrimary = (msgObject: AppMessageProps) => {
+  if (!msgObject || !msgObject.id) {
+    logger.warn(`Unknown message from master in work: ${cluster.worker?.id}`);
+    return;
+  }
+
+  const primaryFn = _savedMessageHandler.fromPrimary[msgObject.id];
+  if (primaryFn) {
+    primaryFn(msgObject);
+    return;
+  }
+
+  if (msgObject.id == 'debug') {
+    processDebugMessage(msgObject);
+    // } else if (msgObject.id == AppSharedStorageMessageId) {
+    //   appStorage.messageFromPrimaryProcess(msgObject);
+  } else {
+    logger.warn(`Unknown message: ${msgObject.id}`);
+  }
+};
+
+// this is primary, msg is from a client
+export const processMessageFromWorker = (msgObject: AppMessageProps) => {
+  if (!msgObject || !msgObject.id) {
+    if (msgObject['watch:require']) return;
+    logger.warn(`Unknown message from work: ${cluster.worker?.id}`);
+    return;
+  }
+
+  const workerFn = _savedMessageHandler.fromWorker[msgObject.id];
+  if (workerFn) {
+    workerFn(msgObject);
+    return;
+  }
+
+  if (msgObject.id == LogWriterMessageId) {
+    LogWriter.messageFromSubProcess(msgObject as any);
+    // } else if (msgObject.id == AppSharedStorageMessageId) {
+    //   appStorage.messageFromSubProcess(msgObject);
+  } else if (msgObject.id == 'debug') {
+    logger.debug(
+      `Message from worker ${cluster.worker?.id}, message: ${msgObject.message}, appName: ${msgObject.appName}`
+    );
+    if (msgObject.message === 'restartApp') {
+      sendRestartAppMsgToLoader();
+      return;
+    } else if (msgObject.message === 'refresh') {
+      broadcast(msgObject);
+    } else if (msgObject.message === 'shutdown') {
+      broadcast(msgObject);
+      // if it's shutdown, the primary process will exit
+      setTimeout(async () => {
+        console.log(`[server primary] Received shutdown command.`, cluster.workers);
+        await cleanupAndExit();
+      }, 100);
+    } else {
+      logger.warn(`Unknown message: ${msgObject.id}`);
+    }
+  } else {
+    logger.warn(`Unknown message id: ${msgObject.id}`);
+  }
+};
+
+// this is primary, and receive messages from loader
+export const receiveMessageFromLoader = () => {
+  process.on('message', async (msg: AppMessageProps) => {
+    if (msg?.id === 'debug' && msg?.message === 'shutdown') {
+      console.log(`App ${process.pid}: received shutdown message from loader.`);
+      processMessageFromWorker(msg);
+    }
+  });
+};