@platformatic/runtime 3.66.0 → 3.67.0

package/config.d.ts

@@ -17,6 +17,7 @@ export type PlatformaticRuntimeConfig = {
         options?: {
           [k: string]: unknown;
         };
+        build?: boolean;
       }
     | (
         | string
@@ -25,6 +26,7 @@ export type PlatformaticRuntimeConfig = {
             options?: {
               [k: string]: unknown;
             };
+            build?: boolean;
           }
       )[];
   entrypoint?: string;

package/index.d.ts

@@ -344,7 +344,20 @@ export interface RuntimeExtensionContext {
   health: RuntimeExtensionHealth
 }
 
+export interface RuntimeExtensionBuildContext {
+  applicationId: string
+  applicationPath: string
+}
+
+export type RuntimeExtensionBuild = () => Promise<unknown>
+
 export interface RuntimeExtensionInstance {
+  preBuild?: (context: RuntimeExtensionBuildContext) => void | Promise<void>
+  onBuild?: (
+    context: RuntimeExtensionBuildContext,
+    build: RuntimeExtensionBuild
+  ) => unknown | Promise<unknown>
+  postBuild?: (context: RuntimeExtensionBuildContext, result: unknown) => void | Promise<void>
   start?: () => void | Promise<void>
   stop?: () => void | Promise<void>
   close?: () => void | Promise<void>

package/lib/errors.js

@@ -191,6 +191,11 @@ export const DuplicateITCHandlerNameError = createError(
   'The ITC command "%s" has already been registered'
 )
 
+export const RuntimeExtensionBuildAlreadyCalledError = createError(
+  `${ERROR_PREFIX}_EXTENSION_BUILD_ALREADY_CALLED`,
+  'The build function can only be called once by each runtime extension.'
+)
+
 export const MetricFamilyCollisionError = createError(
   `${ERROR_PREFIX}_METRIC_FAMILY_COLLISION`,
   'Extension "%s" registered metric family "%s" which collides with %s'

package/lib/runtime.js

@@ -54,6 +54,7 @@ import {
   MissingPprofCapture,
   ReservedITCHandlerNameError,
   RuntimeAbortedError,
+  RuntimeExtensionBuildAlreadyCalledError,
   WorkerInterceptorJoinTimeoutError,
   WorkerNotFoundError
 } from './errors.js'
@@ -921,19 +922,63 @@ export class Runtime extends EventEmitter {
 
   async buildApplication (id) {
     const application = await this.#getApplicationById(id)
+    const applicationConfig = this.#applications.get(id)
+    const context = Object.freeze({
+      applicationId: id,
+      applicationPath: applicationConfig.path
+    })
 
     this.emitAndNotify('application:building', id)
-    try {
-      await sendViaITC(application, 'build')
-      this.emitAndNotify('application:built', id)
-    } catch (e) {
-      // The application exports no meta, return an empty object
-      if (e.code === 'PLT_ITC_HANDLER_NOT_FOUND') {
-        return {}
+    for (const extension of this.#extensions) {
+      await extension.instance?.preBuild?.(context)
+    }
+
+    let buildHandlerMissing = false
+    const build = this.#extensions.reduceRight(
+      (next, extension) => {
+        if (typeof extension.instance?.onBuild !== 'function') {
+          return next
+        }
+
+        return () => {
+          let called = false
+          const build = () => {
+            if (called) {
+              throw new RuntimeExtensionBuildAlreadyCalledError()
+            }
+
+            called = true
+            return next()
+          }
+
+          return extension.instance.onBuild(context, build)
+        }
+      },
+      async () => {
+        try {
+          return await sendViaITC(application, 'build')
+        } catch (e) {
+          // The application exports no meta, return an empty object
+          if (e.code === 'PLT_ITC_HANDLER_NOT_FOUND') {
+            buildHandlerMissing = true
+            return {}
+          }
+
+          throw e
+        }
       }
+    )
 
-      throw e
+    const result = await build()
+
+    for (const extension of [...this.#extensions].reverse()) {
+      await extension.instance?.postBuild?.(context, result)
     }
+
+    if (!buildHandlerMissing) {
+      this.emitAndNotify('application:built', id)
+    }
+    return result
   }
 
   async startApplicationProfiling (id, options = {}, ensureStarted = true) {
@@ -4343,8 +4388,7 @@ export class Runtime extends EventEmitter {
   async #loadExtensions () {
     let extensions = this.#config.extensions
 
-    // Do not load extensions when building applications
-    if (!extensions || this.#context.build) {
+    if (!extensions) {
       return
     }
 
@@ -4353,7 +4397,14 @@ export class Runtime extends EventEmitter {
     }
 
     for (const extension of extensions) {
-      const { path, options } = typeof extension === 'string' ? { path: extension } : extension
+      const { path, options, build } = typeof extension === 'string' ? { path: extension } : extension
+
+      // Runtime extensions historically were not loaded by `wattpm build`.
+      // Preserve that behavior unless an extension explicitly opts into the
+      // build lifecycle.
+      if (this.#context.build && !build) {
+        continue
+      }
 
       let imported
       try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.66.0",
+  "version": "3.67.0",
   "description": "Platformatic runtime",
   "main": "index.js",
   "type": "module",
@@ -36,17 +36,17 @@
     "pino-sentry-transport": "^1.6.0",
     "split2": "^4.2.0",
     "tstyche": "^6.2.0",
-    "typescript": "^5.9.3",
+    "typescript": "~6.0.3",
     "undici-oidc-interceptor": "^0.9.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.66.0",
-    "@platformatic/gateway": "3.66.0",
-    "@platformatic/service": "3.66.0",
-    "@platformatic/sql-graphql": "3.66.0",
-    "@platformatic/db": "3.66.0",
-    "@platformatic/sql-mapper": "3.66.0",
-    "@platformatic/wattpm-pprof-capture": "3.66.0",
-    "@platformatic/node": "3.66.0"
+    "@platformatic/composer": "3.67.0",
+    "@platformatic/db": "3.67.0",
+    "@platformatic/node": "3.67.0",
+    "@platformatic/service": "3.67.0",
+    "@platformatic/sql-graphql": "3.67.0",
+    "@platformatic/sql-mapper": "3.67.0",
+    "@platformatic/wattpm-pprof-capture": "3.67.0",
+    "@platformatic/gateway": "3.67.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -77,13 +77,13 @@
     "undici": "^7.27.2",
     "undici-thread-interceptor": "^1.3.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.66.0",
-    "@platformatic/foundation": "3.66.0",
-    "@platformatic/itc": "3.66.0",
-    "@platformatic/metrics": "3.66.0",
-    "@platformatic/globals": "3.66.0",
-    "@platformatic/generators": "3.66.0",
-    "@platformatic/telemetry": "3.66.0"
+    "@platformatic/basic": "3.67.0",
+    "@platformatic/generators": "3.67.0",
+    "@platformatic/foundation": "3.67.0",
+    "@platformatic/itc": "3.67.0",
+    "@platformatic/globals": "3.67.0",
+    "@platformatic/telemetry": "3.67.0",
+    "@platformatic/metrics": "3.67.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.66.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.67.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -42,6 +42,10 @@
             "options": {
               "type": "object",
               "additionalProperties": true
+            },
+            "build": {
+              "type": "boolean",
+              "default": false
             }
           }
         },
@@ -67,6 +71,10 @@
                   "options": {
                     "type": "object",
                     "additionalProperties": true
+                  },
+                  "build": {
+                    "type": "boolean",
+                    "default": false
                   }
                 }
               }