@nerest/nerest 0.0.6 → 0.0.7

package/README.md

@@ -86,7 +86,17 @@ Here `react` and `react-dom` imports will be replaced with accessing the respect
 
 ### Runtime Hooks
 
-TODO
+If the module `nerest-runtime.ts` exists in the root of the micro frontend and exports a default function, this function will be executed when the server starts, and the fastify app instance will be passed to it as its only argument. Example of `nerest-runtime.ts`:
+
+```typescript
+import type { FastifyInstance } from 'fastify';
+
+export default function (app: FastifyInstance) {
+  console.log('Hello from nerest-runtime.ts');
+}
+```
+
+This runtime hook can be used to adjust fastify settings, register additional plugins or add custom routes.
 
 ## Development
 

package/dist/server/development.js

@@ -16,6 +16,8 @@ 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");
+const runtime_hook_1 = require("./parts/runtime-hook");
+// eslint-disable-next-line max-statements
 async function runDevelopmentServer() {
     const root = process.cwd();
     // TODO: move build config into a separate file
@@ -136,6 +138,8 @@ async function runDevelopmentServer() {
             res.setHeader('Access-Control-Allow-Headers', 'X-Requested-With, content-type, Authorization');
         },
     });
+    // Execute runtime hook in nerest-runtime.ts if it exists
+    await (0, runtime_hook_1.runRuntimeHook)(app, () => viteSsr.ssrLoadModule('/nerest-runtime.ts'));
     // TODO: remove hardcoded port
     await app.listen({
         host: '0.0.0.0',

package/dist/server/parts/runtime-hook.d.ts

@@ -0,0 +1,2 @@
+import type { FastifyInstance } from 'fastify';
+export declare function runRuntimeHook(app: FastifyInstance, loader: () => Promise<Record<string, any>>): Promise<void>;

package/dist/server/parts/runtime-hook.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runRuntimeHook = void 0;
+// Load the runtime hook module and run it if it exists, passing down our
+// fastify instance. This hook can be used to modify fastify settings, add
+// plugins or routes on an individual app level.
+async function runRuntimeHook(app, loader) {
+    let module;
+    try {
+        module = (await loader());
+    }
+    catch { }
+    if (typeof module?.default === 'function') {
+        // If module exists and exports a default function, execute it and
+        // pass down the fastify instance
+        try {
+            await module.default(app);
+        }
+        catch (e) {
+            console.error('Failed to execute runtime hook', e);
+            process.exit(1);
+        }
+    }
+    else if (module) {
+        console.error("Runtime hook found, but doesn't export default function!");
+        process.exit(1);
+    }
+    else {
+        console.log('Runtime hook not found, skipping...');
+    }
+}
+exports.runRuntimeHook = runRuntimeHook;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nerest/nerest",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "React micro frontend framework",
   "homepage": "https://github.com/nerestjs/nerest#readme",
   "repository": {
@@ -52,13 +52,13 @@
     ]
   },
   "dependencies": {
-    "@fastify/static": "^6.11.2",
+    "@fastify/static": "^6.12.0",
     "@fastify/swagger": "^8.12.0",
     "@fastify/swagger-ui": "^1.10.1",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "dotenv": "^16.3.1",
-    "fast-uri": "^2.2.0",
+    "fast-uri": "^2.3.0",
     "fastify": "^4.24.3",
     "fastify-graceful-shutdown": "^3.5.1",
     "nanoid": "^3.3.6",
@@ -69,7 +69,7 @@
     "@tinkoff/eslint-config": "^1.54.4",
     "@tinkoff/eslint-config-react": "^1.54.4",
     "@tinkoff/prettier-config": "^1.52.1",
-    "@types/react": "^18.2.29",
+    "@types/react": "^18.2.33",
     "@types/react-dom": "^18.2.14",
     "jest": "^29.7.0",
     "json-schema-to-typescript": "^13.1.1",

package/server/development.ts

@@ -17,7 +17,9 @@ import { renderPreviewPage } from './parts/preview';
 import { validator } from './parts/validator';
 import { setupSwagger } from './parts/swagger';
 import { setupK8SProbes } from './parts/k8s-probes';
+import { runRuntimeHook } from './parts/runtime-hook';
 
+// eslint-disable-next-line max-statements
 export async function runDevelopmentServer() {
   const root = process.cwd();
 
@@ -171,6 +173,9 @@ export async function runDevelopmentServer() {
     },
   });
 
+  // Execute runtime hook in nerest-runtime.ts if it exists
+  await runRuntimeHook(app, () => viteSsr.ssrLoadModule('/nerest-runtime.ts'));
+
   // TODO: remove hardcoded port
   await app.listen({
     host: '0.0.0.0',

package/server/parts/runtime-hook.ts

@@ -0,0 +1,35 @@
+import type { FastifyInstance } from 'fastify';
+
+type RuntimeHookModule = {
+  default: (app: FastifyInstance) => unknown;
+};
+
+// Load the runtime hook module and run it if it exists, passing down our
+// fastify instance. This hook can be used to modify fastify settings, add
+// plugins or routes on an individual app level.
+export async function runRuntimeHook(
+  app: FastifyInstance,
+  loader: () => Promise<Record<string, any>>
+) {
+  let module: RuntimeHookModule | undefined;
+
+  try {
+    module = (await loader()) as RuntimeHookModule;
+  } catch {}
+
+  if (typeof module?.default === 'function') {
+    // If module exists and exports a default function, execute it and
+    // pass down the fastify instance
+    try {
+      await module.default(app);
+    } catch (e) {
+      console.error('Failed to execute runtime hook', e);
+      process.exit(1);
+    }
+  } else if (module) {
+    console.error("Runtime hook found, but doesn't export default function!");
+    process.exit(1);
+  } else {
+    console.log('Runtime hook not found, skipping...');
+  }
+}

package/server/production.ts

@@ -12,6 +12,7 @@ import { setupSwagger } from './parts/swagger';
 import { validator } from './parts/validator';
 import { renderPreviewPage } from './parts/preview';
 import { setupK8SProbes } from './parts/k8s-probes';
+import { runRuntimeHook } from './parts/runtime-hook';
 
 // TODO: refactor to merge the similar parts between production and development server?
 async function runProductionServer() {
@@ -103,6 +104,12 @@ async function runProductionServer() {
     await setupK8SProbes(app);
   }
 
+  // Execute runtime hook in nerest-runtime.ts if it exists
+  await runRuntimeHook(app, async () => {
+    const glob = import.meta.glob('/nerest-runtime.ts', { eager: true });
+    return glob['/nerest-runtime.ts'];
+  });
+
   // TODO: remove hardcoded port
   await app.listen({
     host: '0.0.0.0',