@produtype/core 1.19.0 → 1.21.0

package/dist/analyzer/detectObservability.js

@@ -5,6 +5,7 @@ const detectContext_1 = require("./detectContext");
 const textSearch_1 = require("../utils/textSearch");
 const absenceEvidence_1 = require("./absenceEvidence");
 const valuesFromPackage_1 = require("./structural/valuesFromPackage");
+const readTextFileSafe_1 = require("../utils/readTextFileSafe");
 /**
  * Logging packages, which the ecosystem names and the author does not.
  *
@@ -32,15 +33,43 @@ const LOGGING_PACKAGES = [
 ];
 /** Elixir reaches for a backend rather than a logger: Logger itself is in OTP. */
 const ELIXIR_LOGGING_PACKAGES = ['logger_json', 'logger_file_backend', 'sentry'];
+/**
+ * The route, in every spelling somebody writes it.
+ *
+ * `\/(health|healthz|readyz|livez|alive)\b` does not match `/healthcheck`: after
+ * `health` comes a `c`, and the boundary fails. Netflix's dispatch declares
+ * `@api_router.get("/healthcheck")` and was told it has no health endpoint — the
+ * plainest spelling there is, missed by the pattern meant to find it.
+ *
+ * This does not disturb the decision recorded below about Dropwizard. That one is
+ * about an endpoint the *framework* publishes, which no Dropwizard application writes
+ * in its own source; a line like dispatch's is somebody declaring the route
+ * themselves.
+ */
+const HEALTH_ROUTE = /\/(health|healthz|healthcheck|health[-_]check|readyz|livez|alive)\b/i;
 async function detectObservability(ctx) {
     const evidence = [];
-    const logDeps = [...(0, detectContext_1.hasAnyDep)(ctx, LOGGING_PACKAGES), ...(0, detectContext_1.hasAnyElixirDep)(ctx, ELIXIR_LOGGING_PACKAGES)];
+    /**
+     * .NET names its logging in the project file and nothing here was reading it.
+     *
+     * Radarr declares `NLog`, `NLog.Extensions.Logging` and
+     * `NLog.Layouts.ClefJsonLayout` — CLEF being the compact JSON event format — and
+     * was reported as logging something but not structurally. The npm list has had
+     * winston and pino since the beginning and treats the dependency alone as enough;
+     * these are the same statement in another manifest.
+     */
+    const DOTNET_LOGGING_PACKAGES = ['NLog', 'NLog.Extensions.Logging', 'Serilog', 'Serilog.AspNetCore', 'Microsoft.Extensions.Logging', 'log4net'];
+    const logDeps = [
+        ...(0, detectContext_1.hasAnyDep)(ctx, LOGGING_PACKAGES),
+        ...(0, detectContext_1.hasAnyElixirDep)(ctx, ELIXIR_LOGGING_PACKAGES),
+        ...(0, detectContext_1.hasAnyDotnetDep)(ctx, DOTNET_LOGGING_PACKAGES),
+    ];
     const sentryDeps = (0, detectContext_1.hasAnyDep)(ctx, ['@sentry/node', 'sentry-sdk']);
     for (const d of logDeps)
         evidence.push({ type: 'dependency', value: d, claim: 'logging' });
     for (const d of sentryDeps)
         evidence.push({ type: 'dependency', value: d, claim: 'logging' });
-    const hits = await (0, textSearch_1.searchInFiles)(ctx.root, ctx.files.source, [/\/(health|healthz|readyz|livez|alive)\b/i, /x-request-id/i, /correlation-id/i, /error\s*handler/i, /RotatingFileHandler/i], 25);
+    const hits = await (0, textSearch_1.searchInFiles)(ctx.root, ctx.files.source, [HEALTH_ROUTE, /x-request-id/i, /correlation-id/i, /error\s*handler/i, /RotatingFileHandler/i], 25);
     /**
      * One search, three answers, so the claim is decided per hit rather than per search.
      *
@@ -49,7 +78,7 @@ async function detectObservability(ctx) {
      * is what the line is evidence of.
      */
     for (const m of hits) {
-        const claim = /\/(health|healthz|readyz|livez|alive)\b/i.test(m.snippet)
+        const claim = HEALTH_ROUTE.test(m.snippet)
             ? 'health'
             : /x-request-id|correlation-id/i.test(m.snippet)
                 ? 'request-id'
@@ -78,9 +107,44 @@ async function detectObservability(ctx) {
     const actuator = (0, detectContext_1.hasAnyGradleDep)(ctx, ['spring-boot-starter-actuator']);
     for (const dep of actuator)
         evidence.push({ type: 'dependency', value: dep, claim: 'health' });
-    const hasHealth = healthFiles.length > 0
+    /**
+     * The probe a platform declares, which is the operator's half of the same answer.
+     *
+     * immich declares `healthcheck:` for its services in all four of its compose files
+     * and was told it has no health endpoint. Something is being probed — that is what
+     * the key means — and the endpoint it probes is inside the image, where no text
+     * search here will find it.
+     *
+     * `HEALTHCHECK` is Docker's instruction, `healthcheck:` is compose's key, and
+     * `livenessProbe:` and `readinessProbe:` are Kubernetes' field names. None is the
+     * author's word, and each one is a statement that this service answers a health
+     * question.
+     *
+     * `disable: true` is the one that says the opposite — compose's way of switching
+     * off an image's own check — so a block carrying it is not counted.
+     */
+    const deploymentManifests = ctx.files.all.filter((file) => /(^|\/)(docker-compose[\w.-]*\.ya?ml|compose[\w.-]*\.ya?ml|Dockerfile[\w.-]*)$/.test(file)
+        || /(^|\/)(k8s|kubernetes|helm|deploy|charts)\/.*\.ya?ml$/i.test(file)).slice(0, 12);
+    const declaredProbes = [];
+    for (const file of deploymentManifests) {
+        const text = (await (0, readTextFileSafe_1.readTextFileSafe)(ctx.root, file)) ?? '';
+        const lines = text.split(/\r?\n/);
+        for (let i = 0; i < lines.length; i++) {
+            if (!/^\s*(?:HEALTHCHECK\s|healthcheck\s*:|livenessProbe\s*:|readinessProbe\s*:)/.test(lines[i]))
+                continue;
+            /** compose writes `healthcheck:` then `disable: true` to switch the image's own off. */
+            if (lines.slice(i + 1, i + 3).some((line) => /^\s*disable\s*:\s*true/.test(line)))
+                continue;
+            declaredProbes.push({ type: 'snippet', value: lines[i].trim().slice(0, 200), file, line: i + 1, claim: 'health' });
+            break;
+        }
+    }
+    for (const probe of declaredProbes.slice(0, 3))
+        evidence.push(probe);
+    const hasHealth = declaredProbes.length > 0
+        || healthFiles.length > 0
         || actuator.length > 0
-        || hits.some((h) => /\/(health|healthz|readyz|livez|alive)\b/i.test(h.snippet));
+        || hits.some((h) => HEALTH_ROUTE.test(h.snippet));
     const hasReqId = hits.some((h) => /x-request-id|correlation-id/i.test(h.snippet));
     // Structured logging without a logging library is still structured logging. What
     // matters is that entries are machine-readable and correlated, not which package
@@ -146,7 +210,7 @@ async function detectObservability(ctx) {
     const hasStructuredLogging = logDeps.length > 0 || structuredHits.length > 0;
     const hasAnyLogging = hasStructuredLogging || plainLogging.length > 0;
     if (!hasHealth) {
-        evidence.push(...(0, absenceEvidence_1.searchedFor)('a health endpoint', ['/health', '/healthz', '/readyz', 'a health, healthz, readyz, liveness or readiness route file'], 'health'));
+        evidence.push(...(0, absenceEvidence_1.searchedFor)('a health endpoint', ['/health', '/healthz', '/readyz', 'a health, healthz, readyz, liveness or readiness route file', 'a HEALTHCHECK, a compose healthcheck or a Kubernetes liveness probe'], 'health'));
     }
     if (!hasAnyLogging) {
         evidence.push(...(0, absenceEvidence_1.searchedFor)('logging', ['winston', 'pino', 'morgan', 'bunyan', 'Monolog', 'slog', 'zap', 'logrus', 'slf4j', 'Rails.logger', 'tracing::', 'logger.info/warn/error/debug', 'Logger.info', 'error_log(', 'JSON.stringify with a level field'], 'logging'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@produtype/core",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "description": "Deterministic CLI and library that analyzes a web application repository and reports how far it is from production-ready for the kind of product it is meant to be.",
   "license": "MIT",
   "bin": {