@nerest/nerest 0.0.9 → 0.1.0

package/README.md

@@ -39,10 +39,14 @@ OpenAPI specification is compiled automatically based on the provided schemas an
 
 ### Props Hook (`/props.ts`)
 
-The app directory may contain a `props.ts` module that exports a default function. If it exists, this function will be executed on the server for every incoming request, receiving a single object as an argument -- the body of the request. You can use this hook to modify and return a new object, which will be passed down to the `index.tsx` entrypoint component instead. For example:
+The app directory may contain a `props.ts` module that exports a default function. If it exists, this function will be executed on the server for every incoming request, receiving the body of the request and a logger as parameters. You can use this hook to modify and return a new object, which will be passed down to the `index.tsx` entrypoint component instead. For example:
 
 ```typescript
-export default function (props: Props) {
+import type { FastifyBaseLogger } from 'fastify';
+
+export default function (props: Props, logger: FastifyBaseLogger) {
+  logger.info('Hello from props.ts!');
+
   return {
     ...props,
     greeting: `${props.greeting} (modified in props.ts)`,
@@ -99,7 +103,7 @@ Excludes modules from the client build and maps them to globally available const
 
 Here `react` and `react-dom` imports will be replaced with accessing the respective `window` constants.
 
-### Runtime Hooks
+### Runtime Hook
 
 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`:
 
@@ -113,6 +117,22 @@ export default function (app: FastifyInstance) {
 
 This runtime hook can be used to adjust fastify settings, register additional plugins or add custom routes.
 
+#### Logger Configuration
+
+Nerest uses the default server-side [fastify logger](https://fastify.dev/docs/latest/Reference/Logging/#logging), enabled by default. To configure or disable it, export a `logger` function from the `nerest-runtime.ts` module. It will be called on server start, and the return value will be passed to fastify as logger configuration.
+
+```typescript
+import type { FastifyServerOptions } from 'fastify';
+
+export function logger(): FastifyServerOptions['logger'] {
+  return { prettyPrint: true };
+}
+```
+
+To disable the logger, return `false` from the function.
+
+You can also supply your own logger instance. Instead of passing configuration options, pass the instance. The logger you supply must conform to the [Pino](https://github.com/pinojs/pino) interface; that is, it must have the following methods: `info`, `error`, `debug`, `fatal`, `warn`, `trace`, `silent`, `child` and a string property `level`.
+
 ## Development
 
 Run the build script to build the framework.

package/dist/server/development.js

@@ -12,6 +12,7 @@ import { setupSwagger } from './parts/swagger.js';
 import { setupK8SProbes } from './parts/k8s-probes.js';
 import { runRuntimeHook } from './hooks/runtime.js';
 import { runPropsHook } from './hooks/props.js';
+import { runLoggerHook } from './hooks/logger.js';
 // eslint-disable-next-line max-statements
 export async function runDevelopmentServer() {
     const root = process.cwd();
@@ -53,7 +54,12 @@ export async function runDevelopmentServer() {
     const apps = await loadApps(root, 'http://0.0.0.0:3000/');
     // Start vite server that will be rendering SSR components
     const viteSsr = await createServer(config);
-    const app = fastify();
+    // Start fastify server that will be processing HTTP requests
+    const app = fastify({
+        // Receive logger configuration from `nerest-runtime.logger()` or
+        // use the default fastify one (`true`)
+        logger: (await runLoggerHook(() => viteSsr.ssrLoadModule('/nerest-runtime.ts'))) ?? true,
+    });
     // Setup schema validation. We have to use our own ajv instance that
     // we can use both to validate request bodies and examples against
     // app schemas
@@ -83,7 +89,7 @@ export async function runDevelopmentServer() {
             const ssrComponent = await viteSsr.ssrLoadModule(entry, {
                 fixStacktrace: true,
             });
-            const props = await runPropsHook(request.body, () => viteSsr.ssrLoadModule(propsHookEntry));
+            const props = await runPropsHook(request.body, request.log, () => viteSsr.ssrLoadModule(propsHookEntry));
             return renderApp({
                 name,
                 assets: appEntry.assets,
@@ -105,11 +111,11 @@ export async function runDevelopmentServer() {
                     // description so it's easier to navigate to
                     description: `Open sandbox: [${exampleRoute}](${exampleRoute})`,
                 },
-            }, async (_, reply) => {
+            }, async (request, reply) => {
                 const ssrComponent = await viteSsr.ssrLoadModule(entry, {
                     fixStacktrace: true,
                 });
-                const props = await runPropsHook(example, () => viteSsr.ssrLoadModule(propsHookEntry));
+                const props = await runPropsHook(example, request.log, () => viteSsr.ssrLoadModule(propsHookEntry));
                 const { html, assets } = renderApp({
                     name,
                     assets: appEntry.assets,
@@ -142,7 +148,6 @@ export async function runDevelopmentServer() {
         host: '0.0.0.0',
         port: 3000,
     });
-    console.log('Nerest is listening on 0.0.0.0:3000');
 }
 // TODO: this should probably be moved from here
 async function startClientBuildWatcher(config) {

package/dist/server/hooks/logger.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" resolution-mode="require"/>
+export declare function runLoggerHook(loader: () => Promise<unknown>): Promise<boolean | import("fastify").FastifyBaseLogger | (import("fastify").FastifyLoggerOptions<import("fastify").RawServerDefault, import("fastify").FastifyRequest<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("http").IncomingMessage, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown, import("fastify").FastifyBaseLogger, import("fastify/types/type-provider.js").ResolveFastifyRequestType<import("fastify").FastifyTypeProviderDefault, import("fastify").FastifySchema, import("fastify").RouteGenericInterface>>, import("fastify").FastifyReply<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>> & import("pino").default.LoggerOptions) | null | undefined>;

package/dist/server/hooks/logger.js

@@ -0,0 +1,21 @@
+// Load the runtime hook module and run it if it exists, to receive
+// logger configuration. If the `logger` function does not exist
+// in the module, ignore it and use default configuration.
+export async function runLoggerHook(loader) {
+    let module;
+    try {
+        module = (await loader());
+    }
+    catch { }
+    if (typeof module?.logger === 'function') {
+        // If module exists and exports a logger function, execute it
+        try {
+            return module.logger();
+        }
+        catch (e) {
+            console.error('Failed to load logger configuration', e);
+            process.exit(1);
+        }
+    }
+    return null;
+}

package/dist/server/hooks/props.d.ts

@@ -1 +1,2 @@
-export declare function runPropsHook(props: unknown, loader: () => Promise<unknown>): Promise<Record<string, unknown>>;
+import type { FastifyBaseLogger } from 'fastify';
+export declare function runPropsHook(props: unknown, logger: FastifyBaseLogger, loader: () => Promise<unknown>): Promise<Record<string, unknown>>;

package/dist/server/hooks/props.js

@@ -1,12 +1,14 @@
 // Load the props hook module and run it if it exists, passing down app's
-// props object. This hook can be used to modify props before they are passed
-// to the root app component.
-export async function runPropsHook(props, loader) {
+// props object and logger. This hook can be used to modify props before
+// they are passed to the root app component.
+export async function runPropsHook(props, logger, loader) {
     let module;
     try {
         module = (await loader());
     }
     catch { }
     // If module exists and exports a default function, run it to modify props
-    return (typeof module?.default === 'function' ? module.default(props) : props);
+    return (typeof module?.default === 'function'
+        ? module.default(props, logger)
+        : props);
 }

package/dist/server/production.js

@@ -10,6 +10,7 @@ import { renderPreviewPage } from './parts/preview.js';
 import { setupK8SProbes } from './parts/k8s-probes.js';
 import { runRuntimeHook } from './hooks/runtime.js';
 import { runPropsHook } from './hooks/props.js';
+import { runLoggerHook } from './hooks/logger.js';
 // TODO: refactor to merge the similar parts between production and development server?
 async function runProductionServer() {
     const root = process.cwd();
@@ -24,7 +25,13 @@ async function runProductionServer() {
     const propsHooks = import.meta.glob('/apps/*/props.ts', {
         eager: true,
     });
-    const app = fastify();
+    const runtimeHook = import.meta.glob('/nerest-runtime.ts', { eager: true });
+    const app = fastify({
+        // Receive logger configuration from `nerest-runtime.logger()` or
+        // use the default fastify one (`true`)
+        logger: (await runLoggerHook(async () => runtimeHook['/nerest-runtime.ts'])) ??
+            true,
+    });
     // Setup schema validation. We have to use our own ajv instance that
     // we can use both to validate request bodies and examples against
     // app schemas
@@ -48,7 +55,7 @@ async function runProductionServer() {
         }
         // POST /api/{name} -> render app with request.body as props
         app.post(`/api/${name}`, routeOptions, async (request) => {
-            const props = await runPropsHook(request.body, propsHook);
+            const props = await runPropsHook(request.body, request.log, propsHook);
             return renderApp({ name, assets, component }, props);
         });
         for (const [exampleName, example] of Object.entries(examples)) {
@@ -61,8 +68,8 @@ async function runProductionServer() {
                     // description so it's easier to navigate to
                     description: `Open sandbox: [${exampleRoute}](${exampleRoute})`,
                 },
-            }, async (_, reply) => {
-                const props = await runPropsHook(example, propsHook);
+            }, async (request, reply) => {
+                const props = await runPropsHook(example, request.log, propsHook);
                 const { html, assets: outAssets } = renderApp({
                     name,
                     assets,
@@ -79,15 +86,11 @@ 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'];
-    });
+    await runRuntimeHook(app, async () => runtimeHook['/nerest-runtime.ts']);
     // TODO: remove hardcoded port
     await app.listen({
         host: '0.0.0.0',
         port: 3000,
     });
-    console.log('Nerest is listening on 0.0.0.0:3000');
 }
 runProductionServer();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nerest/nerest",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "React micro frontend framework",
   "homepage": "https://github.com/nerestjs/nerest#readme",
   "repository": {

package/server/development.ts

@@ -19,6 +19,7 @@ import { setupSwagger } from './parts/swagger.js';
 import { setupK8SProbes } from './parts/k8s-probes.js';
 import { runRuntimeHook } from './hooks/runtime.js';
 import { runPropsHook } from './hooks/props.js';
+import { runLoggerHook } from './hooks/logger.js';
 
 // eslint-disable-next-line max-statements
 export async function runDevelopmentServer() {
@@ -65,7 +66,16 @@ export async function runDevelopmentServer() {
 
   // Start vite server that will be rendering SSR components
   const viteSsr = await createServer(config);
-  const app = fastify();
+
+  // Start fastify server that will be processing HTTP requests
+  const app = fastify({
+    // Receive logger configuration from `nerest-runtime.logger()` or
+    // use the default fastify one (`true`)
+    logger:
+      (await runLoggerHook(() =>
+        viteSsr.ssrLoadModule('/nerest-runtime.ts')
+      )) ?? true,
+  });
 
   // Setup schema validation. We have to use our own ajv instance that
   // we can use both to validate request bodies and examples against
@@ -101,7 +111,7 @@ export async function runDevelopmentServer() {
       const ssrComponent = await viteSsr.ssrLoadModule(entry, {
         fixStacktrace: true,
       });
-      const props = await runPropsHook(request.body, () =>
+      const props = await runPropsHook(request.body, request.log, () =>
         viteSsr.ssrLoadModule(propsHookEntry)
       );
       return renderApp(
@@ -135,11 +145,11 @@ export async function runDevelopmentServer() {
             description: `Open sandbox: [${exampleRoute}](${exampleRoute})`,
           },
         },
-        async (_, reply) => {
+        async (request, reply) => {
           const ssrComponent = await viteSsr.ssrLoadModule(entry, {
             fixStacktrace: true,
           });
-          const props = await runPropsHook(example, () =>
+          const props = await runPropsHook(example, request.log, () =>
             viteSsr.ssrLoadModule(propsHookEntry)
           );
           const { html, assets } = renderApp(
@@ -188,8 +198,6 @@ export async function runDevelopmentServer() {
     host: '0.0.0.0',
     port: 3000,
   });
-
-  console.log('Nerest is listening on 0.0.0.0:3000');
 }
 
 // TODO: this should probably be moved from here

package/server/hooks/logger.ts

@@ -0,0 +1,28 @@
+import type { FastifyServerOptions } from 'fastify';
+
+type LoggerHookModule = {
+  logger?: () => FastifyServerOptions['logger'];
+};
+
+// Load the runtime hook module and run it if it exists, to receive
+// logger configuration. If the `logger` function does not exist
+// in the module, ignore it and use default configuration.
+export async function runLoggerHook(loader: () => Promise<unknown>) {
+  let module: LoggerHookModule | undefined;
+
+  try {
+    module = (await loader()) as LoggerHookModule;
+  } catch {}
+
+  if (typeof module?.logger === 'function') {
+    // If module exists and exports a logger function, execute it
+    try {
+      return module.logger();
+    } catch (e) {
+      console.error('Failed to load logger configuration', e);
+      process.exit(1);
+    }
+  }
+
+  return null;
+}

package/server/hooks/props.ts

@@ -1,12 +1,15 @@
+import type { FastifyBaseLogger } from 'fastify';
+
 type PropsHookModule = {
-  default: (props: unknown) => unknown;
+  default: (props: unknown, logger: FastifyBaseLogger) => unknown;
 };
 
 // Load the props hook module and run it if it exists, passing down app's
-// props object. This hook can be used to modify props before they are passed
-// to the root app component.
+// props object and logger. This hook can be used to modify props before
+// they are passed to the root app component.
 export async function runPropsHook(
   props: unknown,
+  logger: FastifyBaseLogger,
   loader: () => Promise<unknown>
 ) {
   let module: PropsHookModule | undefined;
@@ -17,6 +20,8 @@ export async function runPropsHook(
 
   // If module exists and exports a default function, run it to modify props
   return (
-    typeof module?.default === 'function' ? module.default(props) : props
+    typeof module?.default === 'function'
+      ? module.default(props, logger)
+      : props
   ) as Record<string, unknown>;
 }

package/server/production.ts

@@ -14,6 +14,7 @@ import { renderPreviewPage } from './parts/preview.js';
 import { setupK8SProbes } from './parts/k8s-probes.js';
 import { runRuntimeHook } from './hooks/runtime.js';
 import { runPropsHook } from './hooks/props.js';
+import { runLoggerHook } from './hooks/logger.js';
 
 // TODO: refactor to merge the similar parts between production and development server?
 async function runProductionServer() {
@@ -35,7 +36,15 @@ async function runProductionServer() {
     eager: true,
   });
 
-  const app = fastify();
+  const runtimeHook = import.meta.glob('/nerest-runtime.ts', { eager: true });
+
+  const app = fastify({
+    // Receive logger configuration from `nerest-runtime.logger()` or
+    // use the default fastify one (`true`)
+    logger:
+      (await runLoggerHook(async () => runtimeHook['/nerest-runtime.ts'])) ??
+      true,
+  });
 
   // Setup schema validation. We have to use our own ajv instance that
   // we can use both to validate request bodies and examples against
@@ -65,7 +74,7 @@ async function runProductionServer() {
 
     // POST /api/{name} -> render app with request.body as props
     app.post(`/api/${name}`, routeOptions, async (request) => {
-      const props = await runPropsHook(request.body, propsHook);
+      const props = await runPropsHook(request.body, request.log, propsHook);
       return renderApp({ name, assets, component }, props);
     });
 
@@ -82,8 +91,8 @@ async function runProductionServer() {
             description: `Open sandbox: [${exampleRoute}](${exampleRoute})`,
           },
         },
-        async (_, reply) => {
-          const props = await runPropsHook(example, propsHook);
+        async (request, reply) => {
+          const props = await runPropsHook(example, request.log, propsHook);
           const { html, assets: outAssets } = renderApp(
             {
               name,
@@ -109,18 +118,13 @@ async function runProductionServer() {
   }
 
   // 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'];
-  });
+  await runRuntimeHook(app, async () => runtimeHook['/nerest-runtime.ts']);
 
   // TODO: remove hardcoded port
   await app.listen({
     host: '0.0.0.0',
     port: 3000,
   });
-
-  console.log('Nerest is listening on 0.0.0.0:3000');
 }
 
 runProductionServer();