@lenne.tech/nest-server 11.26.3 → 11.27.1

package/src/core/common/interfaces/server-options.interface.ts

@@ -1591,6 +1591,17 @@ export interface IServerOptions {
    */
   env?: string;
 
+  /**
+   * Semantic version of the running build (e.g. from package.json / meta.json).
+   *
+   * Surfaced via the build-identity health indicator alongside the commit SHA.
+   * Unlike the commit (which uniquely pins the exact build), the version is a
+   * rarely-bumped semver and may legitimately differ between API and frontend.
+   *
+   * @since 11.27.0
+   */
+  version?: string;
+
   /**
    * Configuration for the error code module
    *
@@ -1671,6 +1682,24 @@ export interface IServerOptions {
      * Configuration of single health checks
      */
     configs?: {
+      /**
+       * Configuration for the build-identity health indicator.
+       *
+       * Always reports status "up" and surfaces the running build's commit SHA,
+       * version and environment under the health check's `info`/`details`, so a
+       * drifted / stale container can be detected after a partial rollout. The
+       * commit is read from `process.env.APP_VERSION_COMMIT` (baked at build
+       * time from the CI commit SHA); `version` comes from {@link IServerOptions.version}.
+       *
+       * @since 11.27.0
+       */
+      build?: {
+        /**
+         * Whether to include build identity in the health check (default: true)
+         */
+        enabled?: boolean;
+      };
+
       /**
        * Configuration for database health check
        */

package/src/core/modules/health-check/core-health-check.service.ts

@@ -9,6 +9,7 @@ import {
 import type { MongoosePingCheckSettings } from '@nestjs/terminus/dist/health-indicator/database/mongoose.health.js';
 import type { DiskHealthIndicatorOptions } from '@nestjs/terminus/dist/health-indicator/disk/disk-health-options.type.js';
 
+import { getBuildInfo } from '../../common/helpers/meta.helper';
 import { ConfigService } from '../../common/services/config.service';
 
 /**
@@ -64,6 +65,18 @@ export class CoreHealthCheckService {
         ),
       );
     }
+    // Build identity (commit / version / env) — always reported as "up", so it
+    // surfaces under `info`/`details` without ever affecting the overall health
+    // status. Lets ops/monitoring detect a drifted or stale container after a
+    // partial rollout (the same commit-SHA signal the admin UI compares). The
+    // commit is baked into the image at build time (APP_VERSION_COMMIT, fed from
+    // the CI commit SHA); `version`/`env` come from the config. Opt out with
+    // `healthCheck.configs.build.enabled: false`.
+    if (this.config.get<boolean>('healthCheck.configs.build.enabled') !== false) {
+      const build = getBuildInfo({ env: this.config.get<string>('env'), version: this.config.get<string>('version') });
+      healthIndicatorFunctions.push(async () => ({ build: { ...build, status: 'up' as const } }));
+    }
+
     return this.health.check(healthIndicatorFunctions);
   }
 }

package/src/index.ts

@@ -40,6 +40,7 @@ export * from './core/common/helpers/interceptor.helper';
 export * from './core/common/helpers/gridfs.helper';
 export * from './core/common/helpers/input.helper';
 export * from './core/common/helpers/logging.helper';
+export * from './core/common/helpers/meta.helper';
 export * from './core/common/helpers/model.helper';
 export * from './core/common/helpers/register-enum.helper';
 export * from './core/common/helpers/scim.helper';