lupine.api 1.1.58 → 1.1.60

package/src/api/shell-service.ts

@@ -1,74 +1,74 @@
-import { spawn, exec, ChildProcessWithoutNullStreams } from 'child_process';
-import os from 'os';
-import { MiniWebSocket } from './mini-web-socket';
-import { Duplex } from 'stream';
-
-// This is only used in debug mode (no clusters)
-export class ShellService {
-  private _shell?: ChildProcessWithoutNullStreams;
-  private _socket: Duplex;
-  private _miniWebSocket: MiniWebSocket;
-
-  constructor(socket: Duplex, miniWebSocket: MiniWebSocket) {
-    this._socket = socket;
-    this._miniWebSocket = miniWebSocket;
-    try {
-      const shellCmd: string = ShellService.getDefaultShell();
-      this._shell = spawn(shellCmd, [], {
-        stdio: ['pipe', 'pipe', 'pipe'],
-      });
-    } catch (error) {
-      console.error(error);
-      this._miniWebSocket.sendMessage(this._socket!, JSON.stringify({ error: error }));
-      return;
-    }
-
-    this._shell.stdout.on('data', (data) => {
-      this._miniWebSocket.sendMessage(this._socket!, data.toString());
-    });
-    this._shell.stderr.on('data', (data) => {
-      this._miniWebSocket.sendMessage(this._socket!, data.toString());
-    });
-    this._shell.on('exit', (code, signal) => {
-      this._miniWebSocket.sendMessage(this._socket!, `Shell exited with code ${code}, signal ${signal}`);
-      this._shell = undefined;
-    });
-  }
-
-  static getDefaultShell() {
-    const platform = os.platform();
-    if (platform === 'win32') {
-      return process.env.COMSPEC || 'cmd.exe';
-    }
-    return process.env.SHELL || 'bash';
-  }
-
-  public stop() {
-    this._shell?.kill();
-    this._shell = undefined;
-  }
-
-  public isRunning() {
-    return this._shell !== undefined;
-  }
-
-  public getShell() {
-    return this._shell;
-  }
-
-  public cmd(cmd: string) {
-    if (this._shell && this._shell.stdin.writable) {
-      this._shell.stdin.write(cmd + '\n');
-    } else {
-      this._miniWebSocket.sendMessage(this._socket!, 'Shell is not available.');
-    }
-  }
-
-  public static async directCmd(cmd: string): Promise<string> {
-    return new Promise((resolve) => {
-      exec(cmd, { shell: this.getDefaultShell() }, (error, stdout, stderr) => {
-        resolve(stdout + stderr);
-      });
-    });
-  }
-}
+import { spawn, exec, ChildProcessWithoutNullStreams } from 'child_process';
+import os from 'os';
+import { MiniWebSocket } from './mini-web-socket';
+import { Duplex } from 'stream';
+
+// This is only used in debug mode (no clusters)
+export class ShellService {
+  private _shell?: ChildProcessWithoutNullStreams;
+  private _socket: Duplex;
+  private _miniWebSocket: MiniWebSocket;
+
+  constructor(socket: Duplex, miniWebSocket: MiniWebSocket) {
+    this._socket = socket;
+    this._miniWebSocket = miniWebSocket;
+    try {
+      const shellCmd: string = ShellService.getDefaultShell();
+      this._shell = spawn(shellCmd, [], {
+        stdio: ['pipe', 'pipe', 'pipe'],
+      });
+    } catch (error) {
+      console.error(error);
+      this._miniWebSocket.sendMessage(this._socket!, JSON.stringify({ error: error }));
+      return;
+    }
+
+    this._shell.stdout.on('data', (data) => {
+      this._miniWebSocket.sendMessage(this._socket!, data.toString());
+    });
+    this._shell.stderr.on('data', (data) => {
+      this._miniWebSocket.sendMessage(this._socket!, data.toString());
+    });
+    this._shell.on('exit', (code, signal) => {
+      this._miniWebSocket.sendMessage(this._socket!, `Shell exited with code ${code}, signal ${signal}`);
+      this._shell = undefined;
+    });
+  }
+
+  static getDefaultShell() {
+    const platform = os.platform();
+    if (platform === 'win32') {
+      return process.env.COMSPEC || 'cmd.exe';
+    }
+    return process.env.SHELL || 'bash';
+  }
+
+  public stop() {
+    this._shell?.kill();
+    this._shell = undefined;
+  }
+
+  public isRunning() {
+    return this._shell !== undefined;
+  }
+
+  public getShell() {
+    return this._shell;
+  }
+
+  public cmd(cmd: string) {
+    if (this._shell && this._shell.stdin.writable) {
+      this._shell.stdin.write(cmd + '\n');
+    } else {
+      this._miniWebSocket.sendMessage(this._socket!, 'Shell is not available.');
+    }
+  }
+
+  public static async directCmd(cmd: string): Promise<string> {
+    return new Promise((resolve) => {
+      exec(cmd, { shell: this.getDefaultShell() }, (error, stdout, stderr) => {
+        resolve(stdout + stderr);
+      });
+    });
+  }
+}

package/src/api/simple-storage.ts

@@ -1,80 +1,80 @@
-import * as fs from 'fs/promises';
-import { ISimpleStorage, SimpleStorageDataProps } from '../models/simple-storage-props';
-
-// This class is used by both BE and FE (cookie for SSR).
-export class SimpleStorage implements ISimpleStorage {
-  private settings: SimpleStorageDataProps = {};
-  private dirty: boolean = false;
-
-  constructor(settings: SimpleStorageDataProps) {
-    this.settings = settings;
-  }
-
-  setContent(settings: SimpleStorageDataProps) {
-    this.settings = settings;
-    this.dirty = true;
-  }
-  async saveContent(filePath: string) {
-    await fs.writeFile(filePath, JSON.stringify(this.settings));
-    this.dirty = false;
-  }
-
-  set Dirty(dirty: boolean) {
-    this.dirty = dirty;
-  }
-  get Dirty(): boolean {
-    return this.dirty;
-  }
-
-  contains(key: string): boolean {
-    return key in this.settings;
-  }
-  size(): number {
-    return Object.keys(this.settings).length;
-  }
-  set(key: string, value: string) {
-    this.dirty = true;
-    if (typeof value === 'undefined') {
-      delete this.settings[key];
-    } else {
-      this.settings[key] = value;
-    }
-  }
-
-  getWithPrefix(prefixKey: string): SimpleStorageDataProps {
-    // get all key startswith prefixKey
-    const result: SimpleStorageDataProps = {};
-    for (let key in this.settings) {
-      if (key.startsWith(prefixKey)) {
-        result[key] = this.settings[key];
-      }
-    }
-    return result;
-  }
-
-  get(key: string, defaultValue: string): string {
-    return key in this.settings ? this.settings[key] : defaultValue;
-  }
-  getInt(key: string, defaultValue: number): number {
-    if (key in this.settings) {
-      const i = parseInt(this.settings[key]);
-      if (!isNaN(i)) {
-        return i;
-      }
-    }
-    return defaultValue;
-  }
-  getBoolean(key: string, defaultValue: boolean): boolean {
-    return key in this.settings
-      ? this.settings[key] === '1' || this.settings[key].toLowerCase() === 'true'
-      : defaultValue;
-  }
-  getJson(key: string, defaultValue: object): object {
-    if (key in this.settings) {
-      try {
-        return JSON.parse(this.settings[key]);
-      } catch (error) {}
-    }
-    return defaultValue;
-  }
-}
+import * as fs from 'fs/promises';
+import { ISimpleStorage, SimpleStorageDataProps } from '../models/simple-storage-props';
+
+// This class is used by both BE and FE (cookie for SSR).
+export class SimpleStorage implements ISimpleStorage {
+  private settings: SimpleStorageDataProps = {};
+  private dirty: boolean = false;
+
+  constructor(settings: SimpleStorageDataProps) {
+    this.settings = settings;
+  }
+
+  setContent(settings: SimpleStorageDataProps) {
+    this.settings = settings;
+    this.dirty = true;
+  }
+  async saveContent(filePath: string) {
+    await fs.writeFile(filePath, JSON.stringify(this.settings));
+    this.dirty = false;
+  }
+
+  set Dirty(dirty: boolean) {
+    this.dirty = dirty;
+  }
+  get Dirty(): boolean {
+    return this.dirty;
+  }
+
+  contains(key: string): boolean {
+    return key in this.settings;
+  }
+  size(): number {
+    return Object.keys(this.settings).length;
+  }
+  set(key: string, value: string) {
+    this.dirty = true;
+    if (typeof value === 'undefined') {
+      delete this.settings[key];
+    } else {
+      this.settings[key] = value;
+    }
+  }
+
+  getWithPrefix(prefixKey: string): SimpleStorageDataProps {
+    // get all key startswith prefixKey
+    const result: SimpleStorageDataProps = {};
+    for (let key in this.settings) {
+      if (key.startsWith(prefixKey)) {
+        result[key] = this.settings[key];
+      }
+    }
+    return result;
+  }
+
+  get(key: string, defaultValue: string): string {
+    return key in this.settings ? this.settings[key] : defaultValue;
+  }
+  getInt(key: string, defaultValue: number): number {
+    if (key in this.settings) {
+      const i = parseInt(this.settings[key]);
+      if (!isNaN(i)) {
+        return i;
+      }
+    }
+    return defaultValue;
+  }
+  getBoolean(key: string, defaultValue: boolean): boolean {
+    return key in this.settings
+      ? this.settings[key] === '1' || this.settings[key].toLowerCase() === 'true'
+      : defaultValue;
+  }
+  getJson(key: string, defaultValue: object): object {
+    if (key in this.settings) {
+      try {
+        return JSON.parse(this.settings[key]);
+      } catch (error) {}
+    }
+    return defaultValue;
+  }
+}

package/src/api/static-server.ts

@@ -1,125 +1,128 @@
-// const request = require('request');
-import * as fs from 'fs';
-import * as path from 'path';
-import { ServerResponse } from 'http';
-import { Logger } from '../lib';
-import { ServerRequest } from '../models/locals-props';
-import { handler200, handler404, handler500 } from './handle-status';
-import { isServerSideRenderUrl, serverSideRenderPage } from './server-render';
-import { serverContentType } from './server-content-type';
-import { apiCache } from './api-cache';
-
-export class StaticServer {
-  logger = new Logger('StaticServer');
-
-  private async sendFile(realPath: string, requestPath: string, res: ServerResponse) {
-    try {
-      // const text = fs.readFileSync(realPath);
-      // createReadStream has default autoClose(true)
-      // https://nodejs.org/api/fs.html#fscreatereadstreampath-options
-      const fileStream = fs.createReadStream(realPath);
-      fileStream.on('error', (error) => {
-        this.logger.warn(`File not found: ${realPath}`);
-        handler404(res);
-        return true;
-      });
-      fileStream.on('open', () => {
-        let ext = path.extname(realPath);
-        ext = ext ? ext.slice(1) : 'unknown';
-        const contentType = serverContentType[ext] || 'application/octet-stream';
-        res.writeHead(200, {
-          'Content-Type': contentType + '; charset=UTF-8',
-        });
-      });
-      fileStream.on('end', function () {
-        res.end();
-      });
-      // res.write(text);
-      // res.end();
-      fileStream.pipe(res);
-
-      return true;
-    } catch (err: any) {
-      if (err.code === 'ENOENT') {
-        this.logger.warn(`File not found: ${realPath}`);
-        handler200(res, `File not found: ${requestPath}`);
-      } else {
-        this.logger.error(`Error for: ${realPath}`, err);
-        handler200(res, 'Service failed: ' + err.message);
-      }
-      return true;
-    }
-  }
-
-  async processRequest(req: ServerRequest, res: ServerResponse, rootUrl?: string) {
-    this.logger.info(`StaticServer, url: ${req.locals.url}, host: ${req.locals.host}, rootUrl: ${rootUrl}`);
-
-    const hostPath = apiCache.getAsyncStore().hostPath;
-    const urlSplit = (rootUrl || req.locals.urlWithoutQuery).split('?');
-    const fullPath = path.join(hostPath.webPath, urlSplit[0]);
-
-    const jumpToServerSideRender = () => {
-      const error = new Error();
-      (error as any).code = 'ENOENT';
-      // jump to serverSideRenderPage
-      throw error;
-    };
-    try {
-      if (urlSplit[0] === '/' || urlSplit[0] === '/index.html') {
-        jumpToServerSideRender();
-      }
-
-      // if fullPath doesn't exist, it will throw ENOENT error
-      const realPath = await fs.promises.realpath(fullPath);
-      console.log(`${process.pid} - request: ${realPath}`);
-      // for security reason, the requested file should be inside of wwwRoot
-      if (realPath.substring(0, hostPath.webPath.length) !== hostPath.webPath) {
-        this.logger.warn(`ACCESS DENIED: ${urlSplit[0]}`);
-        handler200(res, `ACCESS DENIED: ${urlSplit[0]}`);
-        return true;
-      }
-
-      let finalPath = '';
-      if ((await fs.promises.lstat(realPath)).isDirectory()) {
-        if ((await fs.promises.lstat(path.join(realPath, 'index.js'))).isFile()) {
-          // because it's directory, it means index.html, and if it has index.js, it will jump to serverSideRenderPage
-          jumpToServerSideRender();
-        }
-        // if index.js doesn't exist, it will send index.html
-        finalPath = path.join(realPath, 'index.html');
-      } else {
-        // it's a file, and if it's index.html and the same directory has index.js, it will jump to serverSideRenderPage
-        if (realPath.endsWith('/index.html') && (await fs.promises.lstat(path.join(path.dirname(realPath), 'index.js'))).isFile()) {
-          jumpToServerSideRender();
-        }
-        finalPath = realPath;
-      }
-
-      // now we need to send finalPath file. If finalPath doesn't exist, it will cause error and jump to serverSideRenderPage
-      try {
-        const allowOrigin = (req.headers.origin && req.headers.origin !== 'null') ? req.headers.origin : '*';
-        res.setHeader('Access-Control-Allow-Origin', allowOrigin);
-
-        await this.sendFile(finalPath, urlSplit[0], res);
-      } catch (err: any) {
-        this.logger.warn(`File not found: ${urlSplit[0]}`);
-        handler200(res, `File not found: ${urlSplit[0]}`);
-      }
-      return true;
-    } catch (err: any) {
-      // file doesn't exist
-      if (err.code === 'ENOENT') {
-        if (isServerSideRenderUrl(urlSplit[0])) {
-          serverSideRenderPage(hostPath.appName, hostPath.webPath, urlSplit[0], urlSplit[1], req, res);
-        } else {
-          this.logger.error(`File not found: ${urlSplit[0]}`);
-          handler404(res, `File not found: ${urlSplit[0]}`);
-        }
-      } else {
-        this.logger.error(`Error for: ${urlSplit[0]}`, err);
-        handler500(res, `processRequest error: ${err.message}`);
-      }
-      return true;
-    }
-  }
-}
+// const request = require('request');
+import * as fs from 'fs';
+import * as path from 'path';
+import { ServerResponse } from 'http';
+import { Logger } from '../lib';
+import { ServerRequest } from '../models/locals-props';
+import { handler200, handler404, handler500 } from './handle-status';
+import { isServerSideRenderUrl, serverSideRenderPage } from './server-render';
+import { serverContentType } from './server-content-type';
+import { apiCache } from './api-cache';
+
+export class StaticServer {
+  logger = new Logger('StaticServer');
+
+  private async sendFile(realPath: string, requestPath: string, res: ServerResponse) {
+    try {
+      // const text = fs.readFileSync(realPath);
+      // createReadStream has default autoClose(true)
+      // https://nodejs.org/api/fs.html#fscreatereadstreampath-options
+      const fileStream = fs.createReadStream(realPath);
+      fileStream.on('error', (error) => {
+        this.logger.warn(`File not found: ${realPath}`);
+        handler404(res);
+        return true;
+      });
+      fileStream.on('open', () => {
+        let ext = path.extname(realPath);
+        ext = ext ? ext.slice(1) : 'unknown';
+        const contentType = serverContentType[ext] || 'application/octet-stream';
+        res.writeHead(200, {
+          'Content-Type': contentType + '; charset=UTF-8',
+        });
+      });
+      fileStream.on('end', function () {
+        res.end();
+      });
+      // res.write(text);
+      // res.end();
+      fileStream.pipe(res);
+
+      return true;
+    } catch (err: any) {
+      if (err.code === 'ENOENT') {
+        this.logger.warn(`File not found: ${realPath}`);
+        handler200(res, `File not found: ${requestPath}`);
+      } else {
+        this.logger.error(`Error for: ${realPath}`, err);
+        handler200(res, 'Service failed: ' + err.message);
+      }
+      return true;
+    }
+  }
+
+  async processRequest(req: ServerRequest, res: ServerResponse, rootUrl?: string) {
+    this.logger.info(`StaticServer, url: ${req.locals.url}, host: ${req.locals.host}, rootUrl: ${rootUrl}`);
+
+    const hostPath = apiCache.getAsyncStore().hostPath;
+    const urlSplit = (rootUrl || req.locals.urlWithoutQuery).split('?');
+    const fullPath = path.join(hostPath.webPath, urlSplit[0]);
+
+    const jumpToServerSideRender = () => {
+      const error = new Error();
+      (error as any).code = 'ENOENT';
+      // jump to serverSideRenderPage
+      throw error;
+    };
+    try {
+      if (urlSplit[0] === '/' || urlSplit[0] === '/index.html') {
+        jumpToServerSideRender();
+      }
+
+      // if fullPath doesn't exist, it will throw ENOENT error
+      const realPath = await fs.promises.realpath(fullPath);
+      console.log(`${process.pid} - request: ${realPath}`);
+      // for security reason, the requested file should be inside of wwwRoot
+      if (realPath.substring(0, hostPath.webPath.length) !== hostPath.webPath) {
+        this.logger.warn(`ACCESS DENIED: ${urlSplit[0]}`);
+        handler200(res, `ACCESS DENIED: ${urlSplit[0]}`);
+        return true;
+      }
+
+      let finalPath = '';
+      if ((await fs.promises.lstat(realPath)).isDirectory()) {
+        if ((await fs.promises.lstat(path.join(realPath, 'index.js'))).isFile()) {
+          // because it's directory, it means index.html, and if it has index.js, it will jump to serverSideRenderPage
+          jumpToServerSideRender();
+        }
+        // if index.js doesn't exist, it will send index.html
+        finalPath = path.join(realPath, 'index.html');
+      } else {
+        // it's a file, and if it's index.html and the same directory has index.js, it will jump to serverSideRenderPage
+        if (
+          realPath.endsWith('/index.html') &&
+          (await fs.promises.lstat(path.join(path.dirname(realPath), 'index.js'))).isFile()
+        ) {
+          jumpToServerSideRender();
+        }
+        finalPath = realPath;
+      }
+
+      // now we need to send finalPath file. If finalPath doesn't exist, it will cause error and jump to serverSideRenderPage
+      try {
+        const allowOrigin = req.headers.origin && req.headers.origin !== 'null' ? req.headers.origin : '*';
+        res.setHeader('Access-Control-Allow-Origin', allowOrigin);
+
+        await this.sendFile(finalPath, urlSplit[0], res);
+      } catch (err: any) {
+        this.logger.warn(`File not found: ${urlSplit[0]}`);
+        handler200(res, `File not found: ${urlSplit[0]}`);
+      }
+      return true;
+    } catch (err: any) {
+      // file doesn't exist
+      if (err.code === 'ENOENT') {
+        if (isServerSideRenderUrl(urlSplit[0])) {
+          serverSideRenderPage(hostPath.appName, hostPath.webPath, urlSplit[0], urlSplit[1], req, res);
+        } else {
+          this.logger.error(`File not found: ${urlSplit[0]}`);
+          handler404(res, `File not found: ${urlSplit[0]}`);
+        }
+      } else {
+        this.logger.error(`Error for: ${urlSplit[0]}`, err);
+        handler500(res, `processRequest error: ${err.message}`);
+      }
+      return true;
+    }
+  }
+}

package/src/api/to-client-delivery.ts

@@ -1,26 +1,26 @@
-import { IToClientDelivery } from '../models/to-client-delivery-props';
-import { ISimpleStorage } from '../models/simple-storage-props';
-
-export class ToClientDelivery implements IToClientDelivery {
-  private webEnv: { [k: string]: string };
-  private webSetting: { [k: string]: string };
-  private cookies: ISimpleStorage;
-
-  constructor(webEnv: { [k: string]: string }, webSetting: { [k: string]: string }, cookies: ISimpleStorage) {
-    this.webEnv = webEnv;
-    this.webSetting = webSetting;
-    this.cookies = cookies;
-  }
-
-  public getWebEnv() {
-    return this.webEnv;
-  }
-
-  public getWebSetting() {
-    return this.webSetting;
-  }
-
-  public getServerCookie() {
-    return this.cookies;
-  }
-}
+import { IToClientDelivery } from '../models/to-client-delivery-props';
+import { ISimpleStorage } from '../models/simple-storage-props';
+
+export class ToClientDelivery implements IToClientDelivery {
+  private webEnv: { [k: string]: string };
+  private webSetting: { [k: string]: string };
+  private cookies: ISimpleStorage;
+
+  constructor(webEnv: { [k: string]: string }, webSetting: { [k: string]: string }, cookies: ISimpleStorage) {
+    this.webEnv = webEnv;
+    this.webSetting = webSetting;
+    this.cookies = cookies;
+  }
+
+  public getWebEnv() {
+    return this.webEnv;
+  }
+
+  public getWebSetting() {
+    return this.webSetting;
+  }
+
+  public getServerCookie() {
+    return this.cookies;
+  }
+}