trifid: register plugins

.changeset/early-ads-rescue.md

@@ -0,0 +1,5 @@
+---
+"trifid": patch
+---
+
+Install Helmet

.changeset/sixty-garlics-return.md

@@ -0,0 +1,5 @@
+---
+"trifid": minor
+---
+
+Allow to register plugins

packages/trifid/index.js

@@ -1,8 +1,11 @@
 // @ts-check
 import Fastify from 'fastify'
 import cors from '@fastify/cors'
+import helmet from '@fastify/helmet'
 
-import healthMiddleware from './middlewares/health.js'
+import { registerPlugin } from './lib/registerPlugin.js'
+import healthPlugin from './plugins/health.js'
+import templateEngine from './plugins/templateEngine.js'
 
 const server = Fastify({
   logger: {
@@ -14,9 +17,12 @@ await server.register(cors, {
   origin: '*',
   credentials: true,
 })
+await server.register(helmet, {
+  global: false,
+})
 
-// Health check
-server.get('/healthz', healthMiddleware)
+await registerPlugin(server, templateEngine)
+await registerPlugin(server, healthPlugin)
 
 const start = async () => {
   try {

packages/trifid/lib/registerPlugin.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+/**
+ * Register a Trifid plugin.
+ *
+ * @param {import('fastify').FastifyInstance} fastifyInstance Fastify instance
+ * @param {import('../types/plugin.d.ts').TrifidPlugin} trifidPlugin Trifid plugin
+ * @returns {Promise<void>}
+ */
+export const registerPlugin = async (fastifyInstance, trifidPlugin) => {
+  const { plugin, pluginOptions, routeOptions } = await trifidPlugin()
+
+  if (plugin) {
+    fastifyInstance.register(plugin, pluginOptions)
+  }
+
+  if (routeOptions) {
+    fastifyInstance.route(routeOptions)
+  }
+}

packages/trifid/package.json

@@ -15,6 +15,7 @@
     "url": "https://github.com/zazuko/trifid/issues"
   },
   "scripts": {
+    "dev": "node --watch index.js",
     "test": "true",
     "help": "node server.js --help",
     "start:tbbt": "node server.js -c instances/tbbt/config.yaml",
@@ -25,6 +26,9 @@
   },
   "dependencies": {
     "@fastify/cors": "^8.4.0",
-    "fastify": "^4.23.2"
+    "@fastify/helmet": "^11.1.1",
+    "@fastify/view": "^8.2.0",
+    "fastify": "^4.23.2",
+    "handlebars": "^4.7.8"
   }
 }

packages/trifid/plugins/health.js

@@ -0,0 +1,28 @@
+// @ts-check
+
+/**
+ * Health plugin.
+ *
+ * @param {import('fastify').FastifyRequest} request Fastify request
+ * @param {import('fastify').FastifyReply} reply Fastify reply
+ * @returns {Promise<void>}
+ */
+const healthPlugin = async (request, reply) => {
+  request.log.debug('Some info about the current request')
+  reply
+    .code(200)
+    .header('Content-Type', 'text/plain; charset=utf-8')
+    .send('OK')
+}
+
+/** @type {import('../types/plugin.d.ts').TrifidPlugin}'} */
+const trifidPlugin = async () => {
+  return {
+    routeOptions: {
+      method: 'GET',
+      url: '/healthz',
+      handler: healthPlugin,
+    },
+  }
+}
+export default trifidPlugin

packages/trifid/plugins/templateEngine.js

@@ -0,0 +1,36 @@
+// @ts-check
+import { dirname, join as pathJoin } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import fastifyView from '@fastify/view'
+import Handlebars from 'handlebars'
+
+const trifidRootPath = dirname(dirname(fileURLToPath(import.meta.url)))
+
+/** @type {import('@fastify/view').default} */
+const plugin = fastifyView
+
+/** @type {import('@fastify/view').FastifyViewOptions} */
+const pluginOptions = {
+  engine: {
+    handlebars: Handlebars,
+  },
+  root: pathJoin(trifidRootPath, 'views'),
+  layout: './layouts/main',
+  includeViewExtension: true,
+  viewExt: 'hbs',
+  propertyName: 'view',
+  defaultContext: {
+    dev: process.env.NODE_ENV === 'development',
+  },
+  options: {},
+}
+
+/** @type {import('../types/plugin.d.ts').TrifidPlugin} */
+const trifidPlugin = async () => {
+  return {
+    plugin,
+    pluginOptions,
+  }
+}
+export default trifidPlugin

packages/trifid/types/plugin.d.ts

@@ -0,0 +1,6 @@
+export type TrifidPluginResult = {
+  plugin?: any;
+  pluginOptions?: any;
+  routeOptions?: import("fastify").RouteOptions;
+};
+export type TrifidPlugin = () => Promise<TrifidPluginResult>;

packages/trifid/views/layouts/main.hbs

@@ -0,0 +1 @@
+Hello world!