@nerest/nerest 0.0.4 → 0.0.5

package/README.md

@@ -6,6 +6,8 @@ React micro frontend framework
 
 ## Installation
 
+TODO: update package
+
 ```
 npm i --save @nerest/nerest react react-dom
 ```
@@ -23,7 +25,7 @@ npm i --save @nerest/nerest react react-dom
 
 The `apps` directory must contain all of the apps provided by the micro frontend. E.g. `/apps/foo/index.tsx` is the entrypoint component of the `foo` app. It becomes available as the `/api/foo` route of the micro frontend server.
 
-See [nerest-harness](https://github.com/nerestjs/harness) for the minimal example of a nerest micro frontend.
+See [nerest-harness](https://gitlab.tcsbank.ru/tj/nerest-harness) for the minimal example of a nerest micro frontend.
 
 ### Examples (`/examples/*.json`)
 
@@ -37,7 +39,7 @@ OpenAPI specification is compiled automatically based on the provided schemas an
 
 ## Configuration
 
-Different aspects of Nerest apps can be configured via environment variables, JSON configuration and runtime hooks written in TypeScript. Examples of all kinds of configuration can be viewed in the [nerest-harness](https://github.com/nerestjs/harness) repository.
+Different aspects of Nerest apps can be configured via environment variables, JSON configuration and runtime hooks written in TypeScript. Examples of all kinds of configuration can be viewed in the [nerest-harness](https://gitlab.tcsbank.ru/tj/nerest-harness) repository.
 
 ### Environment Variables
 
@@ -47,8 +49,16 @@ Different aspects of Nerest apps can be configured via environment variables, JS
 
 #### Runtime
 
+##### Client
+
 All environment variables prefixed with `NEREST_` will be bundled with your app during buildtime. You can access them in the code using the special `import.meta.env` object. For example, `import.meta.env.NEREST_SOMEVAR` will be statically replaced during buildtime with the value of this environment variable on the build machine.
 
+##### Server
+
+Additional environment variables which can be setup for a runtime:
+
+- `ENABLE_K8S_PROBES`: activates additional routes `/livenessProbe` and `/readinessProbe` to check application status
+
 ### JSON Configuration
 
 TODO
@@ -66,4 +76,4 @@ npm install
 npm run build
 ```
 
-Use [nerest-harness](https://github.com/nerestjs/harness) to test changes locally.
+Use [nerest-harness](https://gitlab.tcsbank.ru/tj/nerest-harness) to test changes locally.

package/dist/server/development.js

@@ -9,11 +9,13 @@ const path_1 = __importDefault(require("path"));
 const vite_1 = __importDefault(require("vite"));
 const fastify_1 = __importDefault(require("fastify"));
 const static_1 = __importDefault(require("@fastify/static"));
+const fastify_graceful_shutdown_1 = __importDefault(require("fastify-graceful-shutdown"));
 const apps_1 = require("./parts/apps");
 const render_1 = require("./parts/render");
 const preview_1 = require("./parts/preview");
 const validator_1 = require("./parts/validator");
 const swagger_1 = require("./parts/swagger");
+const k8s_probes_1 = require("./parts/k8s-probes");
 async function runDevelopmentServer() {
     const root = process.cwd();
     // TODO: move build config into a separate file
@@ -119,6 +121,11 @@ async function runDevelopmentServer() {
             });
         }
     }
+    // Add graceful shutdown handler to prevent requests errors
+    await app.register(fastify_graceful_shutdown_1.default);
+    if (process.env.ENABLE_K8S_PROBES) {
+        await (0, k8s_probes_1.setupK8SProbes)(app);
+    }
     // TODO: only do this locally, load from CDN in production
     await app.register(static_1.default, {
         root: path_1.default.join(root, 'build'),

package/dist/server/parts/k8s-probes.d.ts

@@ -0,0 +1,2 @@
+import type { FastifyInstance } from 'fastify';
+export declare function setupK8SProbes(app: FastifyInstance): Promise<void>;

package/dist/server/parts/k8s-probes.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupK8SProbes = void 0;
+// Setup routes for k8s probes to check if application is live
+async function setupK8SProbes(app) {
+    // Handler for graceful shutdowns
+    // K8s can initiate shutdown at any moment: on pods restart or on deploy.
+    // So, if we receive shutdown request, we:
+    // - starts to send 503 response code on readiness probes to stop receiving requests
+    // - finishes all current requests
+    // - shuts down the server
+    let isShutdownInProgress = false;
+    app.gracefulShutdown((code, next) => {
+        // TODO: replace with nerest logger, when it'll be ready
+        console.log('Graceful shutdown in process...');
+        isShutdownInProgress = true;
+        next();
+    });
+    app.get('/livenessProbe', { logLevel: 'silent' }, (req, res) => {
+        res.status(200).send();
+    });
+    app.get('/readinessProbe', { logLevel: 'silent' }, (req, res) => {
+        if (isShutdownInProgress) {
+            res.status(503).send({ status: 'Shutdown in progress' });
+        }
+        else {
+            res.status(200).send();
+        }
+    });
+}
+exports.setupK8SProbes = setupK8SProbes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nerest/nerest",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "React micro frontend framework",
   "homepage": "https://github.com/nerestjs/nerest#readme",
   "repository": {
@@ -55,6 +55,7 @@
     "dotenv": "^16.1.4",
     "fast-uri": "^2.2.0",
     "fastify": "^4.17.0",
+    "fastify-graceful-shutdown": "^3.5.1",
     "nanoid": "^3.3.6",
     "vite": "^4.3.9"
   },

package/server/development.ts

@@ -9,12 +9,14 @@ import type { RollupWatcher, RollupWatcherEvent } from 'rollup';
 import type { RouteShorthandOptions } from 'fastify';
 import fastify from 'fastify';
 import fastifyStatic from '@fastify/static';
+import fastifyGracefulShutdown from 'fastify-graceful-shutdown';
 
 import { loadApps } from './parts/apps';
 import { renderApp } from './parts/render';
 import { renderPreviewPage } from './parts/preview';
 import { validator } from './parts/validator';
 import { setupSwagger } from './parts/swagger';
+import { setupK8SProbes } from './parts/k8s-probes';
 
 export async function runDevelopmentServer() {
   const root = process.cwd();
@@ -148,6 +150,13 @@ export async function runDevelopmentServer() {
     }
   }
 
+  // Add graceful shutdown handler to prevent requests errors
+  await app.register(fastifyGracefulShutdown);
+
+  if (process.env.ENABLE_K8S_PROBES) {
+    await setupK8SProbes(app);
+  }
+
   // TODO: only do this locally, load from CDN in production
   await app.register(fastifyStatic, {
     root: path.join(root, 'build'),

package/server/parts/k8s-probes.ts

@@ -0,0 +1,30 @@
+import type { FastifyInstance } from 'fastify';
+
+// Setup routes for k8s probes to check if application is live
+export async function setupK8SProbes(app: FastifyInstance) {
+  // Handler for graceful shutdowns
+  // K8s can initiate shutdown at any moment: on pods restart or on deploy.
+  // So, if we receive shutdown request, we:
+  // - starts to send 503 response code on readiness probes to stop receiving requests
+  // - finishes all current requests
+  // - shuts down the server
+  let isShutdownInProgress = false;
+  app.gracefulShutdown((code, next) => {
+    // TODO: replace with nerest logger, when it'll be ready
+    console.log('Graceful shutdown in process...');
+    isShutdownInProgress = true;
+    next();
+  });
+
+  app.get('/livenessProbe', { logLevel: 'silent' }, (req, res) => {
+    res.status(200).send();
+  });
+
+  app.get('/readinessProbe', { logLevel: 'silent' }, (req, res) => {
+    if (isShutdownInProgress) {
+      res.status(503).send({ status: 'Shutdown in progress' });
+    } else {
+      res.status(200).send();
+    }
+  });
+}

package/server/production.ts

@@ -3,6 +3,7 @@ import path from 'path';
 import fs from 'fs/promises';
 
 import fastify from 'fastify';
+import fastifyGracefulShutdown from 'fastify-graceful-shutdown';
 import type { RouteShorthandOptions } from 'fastify';
 
 import type { AppEntry } from './parts/apps';
@@ -10,6 +11,7 @@ import { renderApp } from './parts/render';
 import { setupSwagger } from './parts/swagger';
 import { validator } from './parts/validator';
 import { renderPreviewPage } from './parts/preview';
+import { setupK8SProbes } from './parts/k8s-probes';
 
 // TODO: refactor to merge the similar parts between production and development server?
 async function runProductionServer() {
@@ -22,6 +24,7 @@ async function runProductionServer() {
     })
   ) as Record<string, AppEntry>;
 
+  // TODO: fix client-side vite types
   const components = import.meta.glob('/apps/*/index.tsx', {
     import: 'default',
     eager: true,
@@ -93,6 +96,13 @@ async function runProductionServer() {
     }
   }
 
+  // Add graceful shutdown handler to prevent requests errors
+  await app.register(fastifyGracefulShutdown);
+
+  if (process.env.ENABLE_K8S_PROBES) {
+    await setupK8SProbes(app);
+  }
+
   // TODO: remove hardcoded port
   await app.listen({
     host: '0.0.0.0',