lupine.api 1.1.58 → 1.1.60

package/src/app/web-processor.ts

@@ -1,42 +1,47 @@
-import { ServerResponse } from 'http';
-import { Logger } from '../lib/logger';
-import { handler404 } from '../api';
-import { ApiRouterCallback, AppCacheKeys, AsyncStorageProps, getAppCache, ServerRequest } from '../models';
-const logger = new Logger('web-processor');
-
-export class WebProcessor {
-  static debugPath: string | undefined;
-  static debugHandler: ApiRouterCallback | undefined;
-
-  static enableDebug(path: string, debugHandler: ApiRouterCallback) {
-    WebProcessor.debugPath = path;
-    WebProcessor.debugHandler = debugHandler;
-  }
-
-  async processRequest(store: AsyncStorageProps, req: ServerRequest, res: ServerResponse) {
-    if (WebProcessor.debugPath && req.locals.urlWithoutQuery.startsWith(WebProcessor.debugPath)) {
-      if (WebProcessor.debugHandler) {
-        await WebProcessor.debugHandler(req, res, req.locals.urlWithoutQuery);
-        return true;
-      }
-    }
-
-    // check if the request is handled by the api
-    try {
-      const _lupineApi = getAppCache().get(store.appName, AppCacheKeys.API_MODULE);
-      if (_lupineApi && _lupineApi.processApi) {
-        const result = await _lupineApi.processApi(store, store.locals.urlWithoutQuery, req, res);
-        if (result) {
-          return true;
-        }
-      } else {
-        logger.error(`url: ${store.locals.url}, appName: ${store.appName}, no api module found`);
-      }
-    } catch (e: any) {
-      logger.error(`url: ${store.locals.url}, appName: ${store.appName}, process api error: `, e.message);
-    }
-
-    handler404(res, `Request is not processed, url: ${req.locals.url}`);
-    return true;
-  }
-}
+import { ServerResponse } from 'http';
+import { Logger } from '../lib/logger';
+import { handler404 } from '../api';
+import { ApiRouterCallback, AppCacheKeys, AsyncStorageProps, getAppCache, ServerRequest } from '../models';
+import { processRestartApp } from './process-dev-requests';
+const logger = new Logger('web-processor');
+
+export class WebProcessor {
+  static debugPath: string | undefined;
+  static debugHandler: ApiRouterCallback | undefined;
+
+  static enableDebug(path: string, debugHandler: ApiRouterCallback) {
+    WebProcessor.debugPath = path;
+    WebProcessor.debugHandler = debugHandler;
+  }
+
+  async processRequest(store: AsyncStorageProps, req: ServerRequest, res: ServerResponse) {
+    if (WebProcessor.debugPath && req.locals.urlWithoutQuery.startsWith(WebProcessor.debugPath)) {
+      if (WebProcessor.debugHandler) {
+        await WebProcessor.debugHandler(req, res, req.locals.urlWithoutQuery);
+        return true;
+      }
+    }
+
+    // check if the request is handled by the api
+    try {
+      const _lupineApi = getAppCache().get(store.appName, AppCacheKeys.API_MODULE);
+      if (_lupineApi && _lupineApi.processApi) {
+        const result = await _lupineApi.processApi(store, store.locals.urlWithoutQuery, req, res);
+        if (result) {
+          return true;
+        }
+      } else {
+        logger.error(`url: ${store.locals.url}, appName: ${store.appName}, no api module found`);
+      }
+    } catch (e: any) {
+      logger.error(`url: ${store.locals.url}, appName: ${store.appName}, process api error: `, e.message);
+    }
+
+    // rescue
+    if (req.locals.urlWithoutQuery.startsWith('/admin_dev')) {
+      await processRestartApp();
+    }
+    handler404(res, `Request is not processed, url: ${req.locals.url}`);
+    return true;
+  }
+}

package/src/app/web-server.ts

@@ -1,100 +1,100 @@
-import { ServerOptions } from 'https';
-import { Logger } from '../lib/logger';
-import { WebListener } from './web-listener';
-import * as fs from 'fs';
-import * as http from 'http';
-import * as https from 'https';
-import { IncomingMessage, ServerResponse } from 'http';
-import { Duplex } from 'stream';
-import { WebProcessor } from './web-processor';
-import { DebugService } from '../api/debug-service';
-import cluster from 'cluster';
-const logger = new Logger('web-server');
-
-export class WebServer {
-  webListener: WebListener;
-  constructor(webListener?: WebListener) {
-    this.webListener = webListener || new WebListener(new WebProcessor());
-  }
-
-  handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer) {
-    const clientIp = `${(socket as any).remoteAddress}:${(socket as any).remotePort}`;
-    if (req.url?.startsWith('/debug') && socket.readable && socket.writable) {
-      logger.debug(`Upgrade WebSocket access: ${req.url} from ${clientIp}.`);
-      DebugService.handleUpgrade(req, socket, head);
-    } else {
-      logger.error(`Unexpected web socket access: ${req.url} from ${clientIp}`);
-      socket.write('HTTP/1.1 404 Not Found\r\n\r\n');
-      socket.destroy();
-    }
-  }
-
-  async listenerWrap(reqOrigin: IncomingMessage, res: ServerResponse) {
-    try {
-      await this.webListener.listener.bind(this.webListener)(reqOrigin, res);
-    } catch (err) {
-      console.error('Request error:', err);
-      if (!res.headersSent) {
-        res.statusCode = 500;
-        res.end('Internal Server Error');
-      }
-    }
-  }
-
-  startHttp(httpPort: number, bindIp?: string, timeout?: number) {
-    const httpServer = http.createServer(this.listenerWrap.bind(this));
-    if (typeof timeout === 'number') httpServer.setTimeout(timeout);
-
-    httpServer.on('upgrade', this.handleUpgrade.bind(this));
-
-    httpServer.listen(httpPort, bindIp, () => {
-      logger.info(`Http Server ${cluster.worker ? cluster.worker.id : -1} is started: http://localhost:${httpPort}`);
-    });
-    httpServer.on('error', (error: any) => {
-      logger.error('Error occurred on http server', error);
-    });
-    return httpServer;
-  }
-
-  // multi domain https hosting
-  // https://stackoverflow.com/questions/38162077/expressjs-multi-domain-https-hosting
-  startHttps(httpsPort: number, bindIp?: string, sslKeyPath?: string, sslCrtPath?: string, timeout?: number) {
-    const httpsOptions: ServerOptions = {};
-    if (sslKeyPath && fs.existsSync(sslKeyPath) && sslCrtPath && fs.existsSync(sslCrtPath)) {
-      logger.info('Load site ssl certificate.');
-      // The options to https.createServer must include key and cert as they are required.
-      // Even though that set won't be used if SNI provides a hostname.
-      httpsOptions['key'] = fs.readFileSync(sslKeyPath, 'utf8');
-      httpsOptions['cert'] = fs.readFileSync(sslCrtPath, 'utf8');
-      // httpsOptions['ca'] = 'pem';
-      // httpsOptions['SNICallback'] = function (domain, cb) {
-      //   if (typeof sites[domain] === "undefined") {
-      //     cb(new Error("domain not found"), null);
-      //     console.log("Error: domain not found: " + domain);
-
-      //   } else {
-      //     cb(null, sites[domain].context);
-      //   }
-      // };
-    } else {
-      logger.warn(
-        `Ssl certificate is not defined or doesn't exist, key file: ${sslKeyPath}, certificate file: ${sslCrtPath}`
-      );
-    }
-
-    const httpsServer = https.createServer(httpsOptions, this.listenerWrap.bind(this));
-    httpsServer.on('upgrade', this.handleUpgrade.bind(this));
-
-    if (typeof timeout === 'number') {
-      httpsServer.setTimeout(timeout);
-    }
-    httpsServer.listen(httpsPort, bindIp, () => {
-      logger.info(`Https Server ${cluster.worker ? cluster.worker.id : -1} is started: https://localhost:${httpsPort}`);
-    });
-    httpsServer.on('error', (error: any) => {
-      logger.error('Error occurred on https server', error);
-    });
-
-    return httpsServer;
-  }
-}
+import { ServerOptions } from 'https';
+import { Logger } from '../lib/logger';
+import { WebListener } from './web-listener';
+import * as fs from 'fs';
+import * as http from 'http';
+import * as https from 'https';
+import { IncomingMessage, ServerResponse } from 'http';
+import { Duplex } from 'stream';
+import { WebProcessor } from './web-processor';
+import { DebugService } from '../api/debug-service';
+import cluster from 'cluster';
+const logger = new Logger('web-server');
+
+export class WebServer {
+  webListener: WebListener;
+  constructor(webListener?: WebListener) {
+    this.webListener = webListener || new WebListener(new WebProcessor());
+  }
+
+  handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer) {
+    const clientIp = `${(socket as any).remoteAddress}:${(socket as any).remotePort}`;
+    if (req.url?.startsWith('/debug') && socket.readable && socket.writable) {
+      logger.debug(`Upgrade WebSocket access: ${req.url} from ${clientIp}.`);
+      DebugService.handleUpgrade(req, socket, head);
+    } else {
+      logger.error(`Unexpected web socket access: ${req.url} from ${clientIp}`);
+      socket.write('HTTP/1.1 404 Not Found\r\n\r\n');
+      socket.destroy();
+    }
+  }
+
+  async listenerWrap(reqOrigin: IncomingMessage, res: ServerResponse) {
+    try {
+      await this.webListener.listener.bind(this.webListener)(reqOrigin, res);
+    } catch (err) {
+      console.error('Request error:', err);
+      if (!res.headersSent) {
+        res.statusCode = 500;
+        res.end('Internal Server Error');
+      }
+    }
+  }
+
+  startHttp(httpPort: number, bindIp?: string, timeout?: number) {
+    const httpServer = http.createServer(this.listenerWrap.bind(this));
+    if (typeof timeout === 'number') httpServer.setTimeout(timeout);
+
+    httpServer.on('upgrade', this.handleUpgrade.bind(this));
+
+    httpServer.listen(httpPort, bindIp, () => {
+      logger.info(`Http Server ${cluster.worker ? cluster.worker.id : -1} is started: http://localhost:${httpPort}`);
+    });
+    httpServer.on('error', (error: any) => {
+      logger.error('Error occurred on http server', error);
+    });
+    return httpServer;
+  }
+
+  // multi domain https hosting
+  // https://stackoverflow.com/questions/38162077/expressjs-multi-domain-https-hosting
+  startHttps(httpsPort: number, bindIp?: string, sslKeyPath?: string, sslCrtPath?: string, timeout?: number) {
+    const httpsOptions: ServerOptions = {};
+    if (sslKeyPath && fs.existsSync(sslKeyPath) && sslCrtPath && fs.existsSync(sslCrtPath)) {
+      logger.info('Load site ssl certificate.');
+      // The options to https.createServer must include key and cert as they are required.
+      // Even though that set won't be used if SNI provides a hostname.
+      httpsOptions['key'] = fs.readFileSync(sslKeyPath, 'utf8');
+      httpsOptions['cert'] = fs.readFileSync(sslCrtPath, 'utf8');
+      // httpsOptions['ca'] = 'pem';
+      // httpsOptions['SNICallback'] = function (domain, cb) {
+      //   if (typeof sites[domain] === "undefined") {
+      //     cb(new Error("domain not found"), null);
+      //     console.log("Error: domain not found: " + domain);
+
+      //   } else {
+      //     cb(null, sites[domain].context);
+      //   }
+      // };
+    } else {
+      logger.warn(
+        `Ssl certificate is not defined or doesn't exist, key file: ${sslKeyPath}, certificate file: ${sslCrtPath}`
+      );
+    }
+
+    const httpsServer = https.createServer(httpsOptions, this.listenerWrap.bind(this));
+    httpsServer.on('upgrade', this.handleUpgrade.bind(this));
+
+    if (typeof timeout === 'number') {
+      httpsServer.setTimeout(timeout);
+    }
+    httpsServer.listen(httpsPort, bindIp, () => {
+      logger.info(`Https Server ${cluster.worker ? cluster.worker.id : -1} is started: https://localhost:${httpsPort}`);
+    });
+    httpsServer.on('error', (error: any) => {
+      logger.error('Error occurred on https server', error);
+    });
+
+    return httpsServer;
+  }
+}

package/src/common-js/web-env.js

@@ -1,104 +1,104 @@
-// This file is defined as CommonJS module, because it's used in dev as well
-const fs = require('fs/promises');
-const path = require('path');
-
-exports.readFile = async (filePath) => {
-  try {
-    const text = await fs.readFile(filePath, 'utf-8');
-    return text;
-  } catch {
-    return undefined;
-  }
-};
-
-exports.parseEnv = async (envFile) => {
-  let obj = {};
-  const text = await exports.readFile(envFile);
-  if (!text) {
-    return obj;
-  }
-
-  let lines = text.replace(/\r\n?/gm, '\n').split('\n');
-  for (let i = 0; i < lines.length; i++) {
-    const line = lines[i].split(/=(.*)/s);
-    const key = line[0].trim();
-
-    if (key && !key.startsWith('#')) {
-      if (key.endsWith('+')) {
-        // if the line is like [key+=...] then it will be added to the same key
-        obj[key.substring(0, key.length - 1)] += line[1] || '';
-      } else if (key.endsWith('*')) {
-        // if the line is like [key*=LINE_MARKER] then it's a multiline string, ending with "LINE_MARKER"
-        const LINE_MARKER = line[1].trim();
-        line[1] = '';
-        for (i++; i < lines.length; i++) {
-          if (lines[i].trim() === LINE_MARKER) {
-            break;
-          }
-          line[1] += lines[i] + '\n';
-        }
-        obj[key.substring(0, key.length - 1)] = line[1];
-      } else {
-        obj[key] = line[1] || ''; // .replace(/\\n/g, '\n').replace(/\\r/g, '\r')
-      }
-    } else if (key.startsWith('#!import ')) {
-      // use "#!import file_name" to import another env file
-      const file = key.substring(9).trim();
-      const newObj = await exports.parseEnv(path.join(path.dirname(envFile), file));
-      obj = Object.assign(obj, newObj);
-    }
-  }
-
-  return obj;
-};
-
-exports.copyToProcessEnv = (envObject, overrideEnv) => {
-  for (const key of Object.keys(envObject)) {
-    if (overrideEnv || typeof process.env[key] === 'undefined') {
-      process.env[key] = envObject[key];
-    }
-  }
-};
-
-exports.loadEnv = async (envFile, overrideEnv = false) => {
-  console.log(`Load env from: ${envFile}`);
-  const envObject = await exports.parseEnv(envFile);
-  exports.copyToProcessEnv(envObject, overrideEnv);
-};
-
-exports.getWebEnv = (appName) => {
-  const envWeb = {};
-  for (const envName in process.env) {
-    if (envName.startsWith(`WEB.`)) {
-      envWeb[envName.substring(4)] = process.env[envName];
-    } else if (envName.startsWith(`${appName}.WEB.`)) {
-      envWeb[envName.substring(appName.length + 5)] = process.env[envName];
-    }
-  }
-  return envWeb;
-};
-
-// defined app-shared-storage-props.ts
-const AppSharedStorageWebPrefix = 'WEB.';
-exports.getWebConfig = (allConfig) => {
-  const result = {};
-  for (let key in allConfig) {
-    if (key.startsWith(AppSharedStorageWebPrefix)) {
-      result[key.substring(AppSharedStorageWebPrefix.length)] = allConfig[key];
-    }
-  }
-  return result;
-};
-
-// // Replace <!--META-ENV-START-->...<!--META-ENV-END--> for mobile app and replace it again for web app
-// exports.replaceWebEnv = (html, appName, addMetaTag) => {
-//   const envWeb = exports.getWebEnv(appName);
-//   return html.replace(
-//     /\<\!--META-ENV-START--\>(.*?)\<\!--META-ENV-END--\>/gm,
-//     addMetaTag
-//       ? '<!--META-ENV-START--><script id="web-env" type="application/json">' +
-//           JSON.stringify(envWeb) +
-//           '</script><!--META-ENV-END-->'
-//       : '<script id="web-env" type="application/json">' + JSON.stringify(envWeb) + '</script>'
-//   );
-// };
+// This file is defined as CommonJS module, because it's used in dev as well
+const fs = require('fs/promises');
+const path = require('path');
+
+exports.readFile = async (filePath) => {
+  try {
+    const text = await fs.readFile(filePath, 'utf-8');
+    return text;
+  } catch {
+    return undefined;
+  }
+};
+
+exports.parseEnv = async (envFile) => {
+  let obj = {};
+  const text = await exports.readFile(envFile);
+  if (!text) {
+    return obj;
+  }
+
+  let lines = text.replace(/\r\n?/gm, '\n').split('\n');
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i].split(/=(.*)/s);
+    const key = line[0].trim();
+
+    if (key && !key.startsWith('#')) {
+      if (key.endsWith('+')) {
+        // if the line is like [key+=...] then it will be added to the same key
+        obj[key.substring(0, key.length - 1)] += line[1] || '';
+      } else if (key.endsWith('*')) {
+        // if the line is like [key*=LINE_MARKER] then it's a multiline string, ending with "LINE_MARKER"
+        const LINE_MARKER = line[1].trim();
+        line[1] = '';
+        for (i++; i < lines.length; i++) {
+          if (lines[i].trim() === LINE_MARKER) {
+            break;
+          }
+          line[1] += lines[i] + '\n';
+        }
+        obj[key.substring(0, key.length - 1)] = line[1];
+      } else {
+        obj[key] = line[1] || ''; // .replace(/\\n/g, '\n').replace(/\\r/g, '\r')
+      }
+    } else if (key.startsWith('#!import ')) {
+      // use "#!import file_name" to import another env file
+      const file = key.substring(9).trim();
+      const newObj = await exports.parseEnv(path.join(path.dirname(envFile), file));
+      obj = Object.assign(obj, newObj);
+    }
+  }
+
+  return obj;
+};
+
+exports.copyToProcessEnv = (envObject, overrideEnv) => {
+  for (const key of Object.keys(envObject)) {
+    if (overrideEnv || typeof process.env[key] === 'undefined') {
+      process.env[key] = envObject[key];
+    }
+  }
+};
+
+exports.loadEnv = async (envFile, overrideEnv = false) => {
+  console.log(`Load env from: ${envFile}`);
+  const envObject = await exports.parseEnv(envFile);
+  exports.copyToProcessEnv(envObject, overrideEnv);
+};
+
+exports.getWebEnv = (appName) => {
+  const envWeb = {};
+  for (const envName in process.env) {
+    if (envName.startsWith(`WEB.`)) {
+      envWeb[envName.substring(4)] = process.env[envName];
+    } else if (envName.startsWith(`${appName}.WEB.`)) {
+      envWeb[envName.substring(appName.length + 5)] = process.env[envName];
+    }
+  }
+  return envWeb;
+};
+
+// defined app-shared-storage-props.ts
+const AppSharedStorageWebPrefix = 'WEB.';
+exports.getWebConfig = (allConfig) => {
+  const result = {};
+  for (let key in allConfig) {
+    if (key.startsWith(AppSharedStorageWebPrefix)) {
+      result[key.substring(AppSharedStorageWebPrefix.length)] = allConfig[key];
+    }
+  }
+  return result;
+};
+
+// // Replace <!--META-ENV-START-->...<!--META-ENV-END--> for mobile app and replace it again for web app
+// exports.replaceWebEnv = (html, appName, addMetaTag) => {
+//   const envWeb = exports.getWebEnv(appName);
+//   return html.replace(
+//     /\<\!--META-ENV-START--\>(.*?)\<\!--META-ENV-END--\>/gm,
+//     addMetaTag
+//       ? '<!--META-ENV-START--><script id="web-env" type="application/json">' +
+//           JSON.stringify(envWeb) +
+//           '</script><!--META-ENV-END-->'
+//       : '<script id="web-env" type="application/json">' + JSON.stringify(envWeb) + '</script>'
+//   );
+// };

package/src/index.ts

@@ -1,7 +1,7 @@
-export * from './models';
-export * from './lib';
-export * from './lang';
-
-export * from './admin-api';
-export * from './api';
-export * from './app';
+export * from './models';
+export * from './lib';
+export * from './lang';
+
+export * from './admin-api';
+export * from './api';
+export * from './app';

package/src/lang/api-lang-en.ts

@@ -1,26 +1,26 @@
-import { OneLangProps } from './lang-props';
-
-export const apiLangEn: OneLangProps = {
-  langName: 'en',
-  langs: {
-    'shared:operation_success': 'Operation success',
-    'shared:operation_error': 'Operation error',
-
-    'shared:wrong_data': 'Wrong data.',
-    'shared:permission_denied': 'Permission denied.',
-    'shared:name_not_existed': '{name} not existed.',
-    'shared:name_not_set': '{name} not set.',
-    'shared:name_is_wrong': '{name} is wrong.',
-
-    'shared:login_success': 'Logged in.',
-    'shared:login_failed': 'Login failed.',
-    'shared:not_logged_in': 'Not logged in.',
-
-    'shared:user_not_found': 'User not found.',
-    'shared:user_locked': 'User locked.',
-
-    'shared:not_found_file': 'File {fileName} is not found.',
-
-    'shared:wrong_hash': 'Wrong hash.',
-  },
-};
+import { OneLangProps } from './lang-props';
+
+export const apiLangEn: OneLangProps = {
+  langName: 'en',
+  langs: {
+    'shared:operation_success': 'Operation success',
+    'shared:operation_error': 'Operation error',
+
+    'shared:wrong_data': 'Wrong data.',
+    'shared:permission_denied': 'Permission denied.',
+    'shared:name_not_existed': '{name} not existed.',
+    'shared:name_not_set': '{name} not set.',
+    'shared:name_is_wrong': '{name} is wrong.',
+
+    'shared:login_success': 'Logged in.',
+    'shared:login_failed': 'Login failed.',
+    'shared:not_logged_in': 'Not logged in.',
+
+    'shared:user_not_found': 'User not found.',
+    'shared:user_locked': 'User locked.',
+
+    'shared:not_found_file': 'File {fileName} is not found.',
+
+    'shared:wrong_hash': 'Wrong hash.',
+  },
+};

package/src/lang/api-lang-zh-cn.ts

@@ -1,27 +1,27 @@
-import { OneLangProps } from './lang-props';
-
-export const apiLangZhCn: OneLangProps = {
-  langName: 'zh-cn',
-  langs: {
-    'shared:operation_success': '操作成功',
-    'shared:operation_error': '操作失败',
-
-    'shared:wrong_data': '数据错误',
-    'shared:permission_denied': '权限拒绝',
-
-    'shared:name_not_existed': '{name} 不存在',
-    'shared:name_not_set': '{name} 未设置',
-    'shared:name_is_wrong': '{name} 是错误的',
-
-    'shared:login_success': '登录成功',
-    'shared:login_failed': '登录失败',
-    'shared:not_logged_in': '未登录',
-
-    'shared:user_not_found': '用户未找到',
-    'shared:user_locked': '用户已封锁',
-
-    'shared:not_found_file': '文件 {fileName} 未找到',
-
-    'shared:wrong_hash': '错误的hash',
-  },
-};
+import { OneLangProps } from './lang-props';
+
+export const apiLangZhCn: OneLangProps = {
+  langName: 'zh-cn',
+  langs: {
+    'shared:operation_success': '操作成功',
+    'shared:operation_error': '操作失败',
+
+    'shared:wrong_data': '数据错误',
+    'shared:permission_denied': '权限拒绝',
+
+    'shared:name_not_existed': '{name} 不存在',
+    'shared:name_not_set': '{name} 未设置',
+    'shared:name_is_wrong': '{name} 是错误的',
+
+    'shared:login_success': '登录成功',
+    'shared:login_failed': '登录失败',
+    'shared:not_logged_in': '未登录',
+
+    'shared:user_not_found': '用户未找到',
+    'shared:user_locked': '用户已封锁',
+
+    'shared:not_found_file': '文件 {fileName} 未找到',
+
+    'shared:wrong_hash': '错误的hash',
+  },
+};

package/src/lang/index.ts

@@ -1,2 +1,2 @@
-export * from './lang-helper';
-export * from './lang-props';
+export * from './lang-helper';
+export * from './lang-props';