lupine.api 1.1.52 → 1.1.53

package/admin/admin-release.tsx

@@ -8,6 +8,7 @@ import {
   NotificationMessage,
   formatBytes,
   downloadStream,
+  ActionSheetSelectPromise,
 } from 'lupine.components';
 
 interface ReleaseListProps {
@@ -308,6 +309,15 @@ export const AdminReleasePage = () => {
       }
     }
 
+    const index = await ActionSheetSelectPromise({
+      title: 'Restart App (users may get disconnected errors) ?',
+      options: ['OK'],
+      cancelButtonText: 'Cancel',
+    });
+    if (index !== 0) {
+      return;
+    }
+
     const response = await getRenderPageProps().renderPageFunctions.fetchData('/api/admin/release/restart-app', {
       ...data,
       isLocal,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lupine.api",
-  "version": "1.1.52",
+  "version": "1.1.53",
   "license": "MIT",
   "author": "uuware.com",
   "homepage": "https://github.com/uuware/lupine.js",

package/src/api/debug-service.ts

@@ -48,7 +48,7 @@ export class DebugService {
 
   // broadcast to all frontend clients
   public static broadcastRefresh() {
-    console.log(`broadcast refresh request to clients.`);
+    console.log(`${process.pid} - broadcast refresh request to clients.`);
     this.clientRefreshFlag = Date.now();
     const msg = { message: 'Refresh', flag: this.clientRefreshFlag };
     this.miniWebSocket.broadcast(JSON.stringify(msg));

package/src/api/static-server.ts

@@ -71,7 +71,7 @@ export class StaticServer {
 
       // if fullPath doesn't exist, it will throw ENOENT error
       const realPath = await fs.promises.realpath(fullPath);
-      console.log(`request: ${realPath}`);
+      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]}`);

package/src/app/app-loader.ts

@@ -51,7 +51,7 @@ class AppLoader {
     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(`clear cache: ${path}`);
+        console.log(`${process.pid} - clear cache: ${path}`);
         delete require.cache[path];
       }
     }

package/src/app/app-message.ts

@@ -1,8 +1,7 @@
 import cluster from 'cluster';
 import { Logger, LogWriter, LogWriterMessageId } from '../lib';
-import { processDebugMessage } from './process-dev-requests';
+import { processDebugMessage, snedRestartAppMsgToLoader } from './process-dev-requests';
 import { cleanupAndExit } from './cleanup-exit';
-import { restartApp } from './app-restart';
 
 export type AppMessageProps = {
   id: string;
@@ -80,7 +79,7 @@ export const processMessageFromWorker = (msgObject: AppMessageProps) => {
       `Message from worker ${cluster.worker?.id}, message: ${msgObject.message}, appName: ${msgObject.appName}`
     );
     if (msgObject.message === 'restartApp') {
-      restartApp();
+      snedRestartAppMsgToLoader();
       return;
     } else if (msgObject.message === 'refresh') {
       broadcast(msgObject);
@@ -98,3 +97,13 @@ export const processMessageFromWorker = (msgObject: AppMessageProps) => {
     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);
+    }
+  });
+};

package/src/app/app-shared-storage.ts

@@ -166,7 +166,7 @@ export class AppSharedStorage implements IAppSharedStorage {
   // this can be called in primary or worker
   get(appName: string, key: string): Promise<string> {
     return new Promise((resolve, reject) => {
-      console.log(`AppStorage get value start in ${process.pid}, for key: ${key}`);
+      console.log(`${process.pid} - AppStorage get value for key: ${key}`);
 
       if (!cluster.isPrimary) {
         AppSharedStorageWorker.get(appName, key, resolve, reject);
@@ -196,7 +196,7 @@ export class AppSharedStorage implements IAppSharedStorage {
   }
   getWithPrefix(appName: string, prefixKey: string): Promise<SimpleStorageDataProps> {
     return new Promise((resolve, reject) => {
-      console.log(`AppStorage getWithPrefix start in ${process.pid}, for prefixKey: ${prefixKey}`);
+      console.log(`${process.pid} - AppStorage getWithPrefix for prefixKey: ${prefixKey}`);
 
       if (!cluster.isPrimary) {
         AppSharedStorageWorker.getWithPrefix(appName, prefixKey, resolve, reject);
@@ -238,7 +238,7 @@ class AppSharedStorageWorker {
     }
 
     if (msgObject.action === 'get') {
-      console.log(`AppStorage get value end in process: ${process.pid}, for key: ${msgObject.key}`);
+      console.log(`${process.pid} - AppStorage get value end for key: ${msgObject.key}`);
 
       const value = msgObject.value;
       // how to pass the value to the caller
@@ -250,7 +250,7 @@ class AppSharedStorageWorker {
         throw new Error(`Unknown uniqueKey: ${msgObject.uniqueKey}`);
       }
     } else if (msgObject.action === 'getWithPrefix') {
-      console.log(`AppStorage get value end in process: ${process.pid}, for key: ${msgObject.key}`);
+      console.log(`${process.pid} - AppStorage get value end for key: ${msgObject.key}`);
       const value = JSON.parse(msgObject.value);
       // how to pass the value to the caller
       const map = this.handleMap[msgObject.uniqueKey];

package/src/app/app-start.ts

@@ -8,8 +8,8 @@ import { appCache } from './app-cache';
 import { AppStartProps, InitStartProps, AppCacheGlobal, AppCacheKeys } from '../models';
 import { appStorage } from './app-shared-storage';
 import { HostToPath } from './host-to-path';
-import { cleanupAndExit } from './cleanup-exit';
-import { _restartApp, receiveMessageFromLoader } from './app-restart';
+import { _exitApp, cleanupAndExit } from './cleanup-exit';
+import { receiveMessageFromLoader } from './app-message';
 
 // Don't use logger before set process message
 class AppStart {
@@ -41,9 +41,9 @@ class AppStart {
 
     // call the Logger after initLog
     console.log(
-      `${cluster.isPrimary ? 'Primary Process' : 'Worker Process'}, Starting Server - process id ${
-        process.pid
-      }, path: ${process.cwd()}`
+      `${process.pid} - ${
+        cluster.isPrimary ? 'Primary Process' : 'Worker Process'
+      }, Starting Server, path: ${process.cwd()}`
     );
 
     // when it's cluster.isPrimary or props.debug, initialize the shared storage first
@@ -54,7 +54,7 @@ class AppStart {
     }
 
     if (!cluster.isPrimary) {
-      console.log(`Worker id ${this.getWorkerId()}`);
+      console.log(`${process.pid} - Worker id ${this.getWorkerId()}`);
 
       process.on('message', processMessageFromPrimary);
 
@@ -63,7 +63,7 @@ class AppStart {
       this.initServer(props.serverConfig);
     } else if (cluster.isPrimary) {
       const numCPUs = props.debug ? 1 : require('os').cpus().length;
-      console.log(`Master Process is trying to fork ${numCPUs} processes`);
+      console.log(`${process.pid} - Primary Process is trying to fork ${numCPUs} processes`);
 
       receiveMessageFromLoader();
 
@@ -73,11 +73,11 @@ class AppStart {
       }
 
       cluster.on('death', (worker: any) => {
-        if (!_restartApp.isRestarting) {
-          console.log(`Worker ${worker.pid} died; starting a new one...`);
+        if (!_exitApp.isExiting) {
+          console.log(`${worker.pid} - Worker died; starting a new one...`);
           cluster.fork();
         } else {
-          console.log(`Worker ${worker.pid} exited during restart`);
+          console.log(`${worker.pid} - Worker exited during restart`);
         }
       });
     }
@@ -125,12 +125,11 @@ class AppStart {
     const httpServer = httpPort && this.webServer!.startHttp(httpPort, bindIp);
     const heepsServer = httpsPort && this.webServer!.startHttps(httpsPort, bindIp, sslKeyPath, sslCrtPath);
 
-    process.on("SIGTERM", () => {
+    process.on('SIGTERM', () => {
       console.log(`${process.pid} - Worker closing servers...`);
       httpServer && httpServer.close();
       heepsServer && heepsServer.close();
     });
-
   }
 }
 

package/src/app/cleanup-exit.ts

@@ -1,6 +1,9 @@
 import cluster from 'cluster';
 import { appStorage } from './app-shared-storage';
 
+export const _exitApp = {
+  isExiting: false,
+};
 export const cleanupAndExit = async () => {
   console.log(`${process.pid} - Process on SIGINT, exit.`);
   // save shared storage first
@@ -8,5 +11,6 @@ export const cleanupAndExit = async () => {
     // save only happens once
     await appStorage.save('', true);
   }
+  _exitApp.isExiting = true;
   process.exit(0);
 };

package/src/app/process-dev-requests.ts

@@ -1,3 +1,4 @@
+import cluster from 'cluster';
 import { Logger } from '../lib/logger';
 import { ServerResponse } from 'http';
 import { AddressInfo } from 'net';
@@ -5,7 +6,6 @@ import { appLoader } from './app-loader';
 import { DebugService } from '../api/debug-service';
 import { AppCacheGlobal, AppCacheKeys, getAppCache, ServerRequest } from '../models';
 import { cleanupAndExit } from './cleanup-exit';
-import { restartApp } from './app-restart';
 const logger = new Logger('process-dev-requests');
 
 function deleteRequireCache(moduleName: string) {
@@ -45,18 +45,18 @@ export const processDebugMessage = async (msgObject: any) => {
   }
   if (msgObject.id === 'debug' && msgObject.message === 'shutdown') {
     // Only when it's debug mode, it can go here, otherwise shutdown should be processed in processMessageFromWorker
-    console.log(`[server] Received shutdown command.`);
+    console.log(`${process.pid} - [server] Received shutdown command.`);
     await cleanupAndExit();
   }
 };
 
 export async function processRefreshCache(req: ServerRequest) {
-  // if this is a child process, we need to notice parent process to broadcast to all clients to refresh
-  if (process.send) {
+  // if this is a child process, we need to notice parent process to broadcast to all clients
+  if (!cluster.isPrimary && process.send) {
     const appName = req.locals.query.get('appName');
     process.send({ id: 'debug', message: 'refresh', appName });
   }
-  // if it's debug mode (only one process)
+  // in case if it's only one process (primary process)
   else {
     // if (getAppCache().get(APP_GLOBAL, AppCacheKeys.API_DEBUG) === true)
     const appName = req.locals.query.get('appName');
@@ -65,27 +65,27 @@ export async function processRefreshCache(req: ServerRequest) {
 }
 
 export async function processRestartApp(req: ServerRequest) {
-  // if this is a child process, we need to notice parent process to broadcast to all clients to refresh
-  if (process.send) {
+  // if this is a child process, we need to notice parent process to broadcast to all clients
+  if (!cluster.isPrimary && process.send) {
     // send message to Primary to handle it
     process.send({ id: 'debug', message: 'restartApp' });
   }
   // in case if it's only one process (primary process)
   else {
-    await restartApp();
+    snedRestartAppMsgToLoader();
   }
 }
 
-// this is only for local development
+// this is called from a request in debug mode
 export async function processDevRequests(req: ServerRequest, res: ServerResponse, rootUrl?: string) {
   res.end();
   const address = req.socket.address() as AddressInfo;
   if (address.address !== '127.0.0.1') {
-    console.log(`[server] Ignore request from: `, req.url, address.address);
+    console.log(`${process.pid} - [server] Ignore request from: `, req.url, address.address);
     return true;
   }
   if (req.url === '/debug/shutdown') {
-    console.log(`[server] Received shutdown command.`);
+    console.log(`${process.pid} - [server] Received shutdown command.`);
     if (process.send) {
       // send to parent process to kill all
       process.send({ id: 'debug', message: 'shutdown' });
@@ -97,7 +97,23 @@ export async function processDevRequests(req: ServerRequest, res: ServerResponse
   } else if (req.url === '/debug/refresh') {
     await processRefreshCache(req);
   }
-  if (req.url === '/debug/client') {
-  }
+  // else if (req.url === '/debug/client') {
+  // }
   return true;
 }
+
+// this is called from a request and passes the restartApp message to loader
+export const snedRestartAppMsgToLoader = async () => {
+  if (!cluster.isPrimary) {
+    console.warn(`restartApp: shouldn't come here`);
+    return;
+  }
+
+  if (!process.send) {
+    console.log(`${process.pid} - The primary process is not focked from loader, so cannot restart.`);
+  } else {
+    console.log(`${process.pid} - Old app sends restartApp to loader (${process.execPath})`);
+
+    process.send({ id: 'debug', message: 'restartApp' });
+  }
+};

package/src/app/app-restart.ts

@@ -1,54 +0,0 @@
-import cluster from 'cluster';
-import { spawn } from 'child_process';
-import { appStorage } from './app-shared-storage';
-import { AppMessageProps, processMessageFromWorker } from './app-message';
-
-export const _restartApp = {
-  isRestarting: false,
-};
-export const restartApp = async () => {
-  if (!cluster.isPrimary) {
-    console.warn(`restartApp: shouldn't come here`);
-    return;
-  }
-
-  await appStorage.save('', true);
-  console.log(`Old app ${process.pid} sends SIGTERM to all workors.`);
-  // const closeAll = () => {
-  //   _restartApp.isRestarting = true;
-
-  //   return Object.values(cluster.workers!).map(
-  //     (w) =>
-  //       new Promise((resolve) => {
-  //         console.log(`Sending SIGTERM to workor ${w!.id}.`);
-  //         w!.once('exit', resolve);
-  //         w!.kill('SIGTERM');
-  //       })
-  //   );
-  // };
-  // await Promise.all(closeAll());
-
-  console.log(`Old app ${process.pid} starts new app ${process.execPath}`, process.argv);
-  // spawn(process.execPath, process.argv.slice(1), {
-  //   stdio: 'inherit',
-  //   env: { ...process.env, RESTARTING: '1' },
-  // });
-
-  console.log(`Old app ${process.pid} exists.`);
-  // setTimeout(process.exit, 3000);
-  if (!process.send) {
-    console.log(`The primary process is not focked from loader, so cannot restart.`);
-  } else {
-    process.send({ id: 'debug', message: 'restartApp' });
-  }
-};
-
-// 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);
-    }
-  });
-};