react-cheminfo 0.26.0 → 0.27.0

package/bin/check-deploy.mjs

@@ -2,9 +2,10 @@
 /*
  * Report every way a repository would break, or silently mis-deploy, under the
  * server's global deploy script: a compose file it would not find, an image with
- * no selectable tag, an `IMAGE_NAME` naming a package this repository never
- * publishes, an `env_file` that fails on a checkout with no `.env` yet, a
- * service with no health probe to read, an `.env.example` that hides a mode.
+ * no selectable tag, a page the browser keeps across a deploy and then cannot
+ * run, an `IMAGE_NAME` naming a package this repository never publishes, an
+ * `env_file` that fails on a checkout with no `.env` yet, a service with no
+ * health probe to read, an `.env.example` that hides a mode.
  *
  * Wire it as an npm script, next to check-tokens:
  *   "check-deploy": "cheminfo-check-deploy"
@@ -25,6 +26,8 @@ import process from 'node:process';
 
 import {
   DEPLOY_COMPOSE_FILES,
+  NGINX_CONFIG,
+  PAGE_CACHE_CONFIG,
   findDeployProblems,
 } from '../lib/deploy/core/index.js';
 
@@ -67,7 +70,14 @@ if (imageName === undefined) {
 // Every mode is read, present or not: a missing one is itself a problem.
 const expected = composeFiles ?? DEPLOY_COMPOSE_FILES;
 const files = [];
-for (const path of [...expected, '.env.example', '.gitignore']) {
+for (const path of [
+  ...expected,
+  '.env.example',
+  '.gitignore',
+  'Dockerfile',
+  PAGE_CACHE_CONFIG,
+  NGINX_CONFIG,
+]) {
   const text = read(path);
   if (text !== undefined) files.push({ path, text });
 }

package/lib/deploy/core/checkDeploy.d.ts

@@ -8,7 +8,9 @@ import type { CheckDeployOptions, DeployFile, DeployProblem } from './types.ts';
  * reports it healthy. So a repository has to hand it a selectable tag on every
  * image we build, an `IMAGE_NAME` that names the package our own workflow
  * publishes, a compose file that parses on a checkout with no `.env` yet, and a
- * health probe to read. Each of those is invisible until a deploy, which is the
+ * health probe to read. It also has to hand the browser a page the browser will
+ * not keep, or the next deploy leaves returning visitors on a blank one. Each
+ * of those is invisible until a deploy, which is the
  * worst moment to discover it — an `env_file` without `required: false` fails
  * before a container starts, and an `IMAGE_NAME` off by a suffix pulls a
  * package that was never published.

package/lib/deploy/core/checkDeploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkDeploy.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/checkDeploy.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,SAAS,UAAU,EAAE,EAC5B,OAAO,GAAE,kBAAuB,GAC/B,aAAa,EAAE,CA0DjB"}
+{"version":3,"file":"checkDeploy.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/checkDeploy.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,SAAS,UAAU,EAAE,EAC5B,OAAO,GAAE,kBAAuB,GAC/B,aAAa,EAAE,CA6DjB"}

package/lib/deploy/core/checkDeploy.js

@@ -1,5 +1,6 @@
 import { readComposeFile } from "./composeFile.js";
 import { readEnvExample } from "./envExample.js";
+import { readPageCache } from "./pageCache.js";
 import { DEPLOY_COMPOSE_FILES } from "./types.js";
 /**
  * Every way a repository would break, or silently mis-deploy, under the
@@ -10,7 +11,9 @@ import { DEPLOY_COMPOSE_FILES } from "./types.js";
  * reports it healthy. So a repository has to hand it a selectable tag on every
  * image we build, an `IMAGE_NAME` that names the package our own workflow
  * publishes, a compose file that parses on a checkout with no `.env` yet, and a
- * health probe to read. Each of those is invisible until a deploy, which is the
+ * health probe to read. It also has to hand the browser a page the browser will
+ * not keep, or the next deploy leaves returning visitors on a blank one. Each
+ * of those is invisible until a deploy, which is the
  * worst moment to discover it — an `env_file` without `required: false` fails
  * before a container starts, and an `IMAGE_NAME` off by a suffix pulls a
  * package that was never published.
@@ -59,6 +62,9 @@ export function findDeployProblems(files, options = {}) {
     else {
         readEnvExample(envExample, expected, problems);
     }
+    const dockerfile = byPath.get('Dockerfile');
+    if (dockerfile !== undefined)
+        readPageCache(dockerfile, byPath, problems);
     const gitignore = byPath.get('.gitignore');
     if (gitignore === undefined || !/^\s*\/?\.deploy\/?\s*$/m.test(gitignore)) {
         problems.push({

package/lib/deploy/core/checkDeploy.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkDeploy.js","sourceRoot":"","sources":["../../../src/deploy/core/checkDeploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAA4B,EAC5B,UAA8B,EAAE;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,IAAI,oBAAoB,CAAC;IAC9D,MAAM,KAAK,GAAG;QACZ,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,EAAE;QAC1C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;QACtD,iBAAiB,EAAE,CACjB,OAAO,CAAC,iBAAiB,IAAI,gBAAgB,CAC9C,CAAC,WAAW,EAAE;QACf,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,CAAC,WAAW,EAAE;KACzD,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAoB,EAAE,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,8CAA8C;gBACvD,IAAI,EAAE,UAAU,IAAI,yBAAyB;aAC9C,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,8CAA8C;YACvD,IAAI,EAAE,kFAAkF;SACzF,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3C,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1E,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EACL,8EAA8E;YAChF,IAAI,EAAE,kCAAkC;SACzC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}
+{"version":3,"file":"checkDeploy.js","sourceRoot":"","sources":["../../../src/deploy/core/checkDeploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAA4B,EAC5B,UAA8B,EAAE;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,IAAI,oBAAoB,CAAC;IAC9D,MAAM,KAAK,GAAG;QACZ,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,EAAE;QAC1C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;QACtD,iBAAiB,EAAE,CACjB,OAAO,CAAC,iBAAiB,IAAI,gBAAgB,CAC9C,CAAC,WAAW,EAAE;QACf,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,CAAC,WAAW,EAAE;KACzD,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAoB,EAAE,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,8CAA8C;gBACvD,IAAI,EAAE,UAAU,IAAI,yBAAyB;aAC9C,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,8CAA8C;YACvD,IAAI,EAAE,kFAAkF;SACzF,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,UAAU,KAAK,SAAS;QAAE,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE1E,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3C,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1E,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EACL,8EAA8E;YAChF,IAAI,EAAE,kCAAkC;SACzC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/lib/deploy/core/index.d.ts

@@ -1,4 +1,5 @@
 export { findDeployProblems } from './checkDeploy.ts';
 export type { CheckDeployOptions, DeployFile, DeployProblem, DeployProblemKind, } from './types.ts';
+export { NGINX_CONFIG, PAGE_CACHE_CONFIG } from './pageCache.ts';
 export { DEPLOY_COMPOSE_FILES } from './types.ts';
 //# sourceMappingURL=index.d.ts.map

package/lib/deploy/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,YAAY,EACV,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,iBAAiB,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,YAAY,EACV,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,iBAAiB,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC"}

package/lib/deploy/core/index.js

@@ -1,3 +1,4 @@
 export { findDeployProblems } from "./checkDeploy.js";
+export { NGINX_CONFIG, PAGE_CACHE_CONFIG } from "./pageCache.js";
 export { DEPLOY_COMPOSE_FILES } from "./types.js";
 //# sourceMappingURL=index.js.map

package/lib/deploy/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/deploy/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAOtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/deploy/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAOtD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC"}

package/lib/deploy/core/pageCache.d.ts

@@ -0,0 +1,24 @@
+import type { DeployProblem } from './types.ts';
+/** The page cache policy of a static-web-server site, at the repository root. */
+export declare const PAGE_CACHE_CONFIG = "sws.toml";
+/** The nginx configuration of a site served by nginx. */
+export declare const NGINX_CONFIG = "nginx.conf";
+/**
+ * Report a server that lets a browser keep the page itself.
+ *
+ * A page names the hashed bundles of the build that wrote it, so a browser
+ * still holding a copy from an earlier deploy asks the new image for files it
+ * does not have; the request falls through to the page, the browser refuses to
+ * run HTML as a module, and the site comes up blank until the copy expires.
+ * Nothing on the server can see it and no test can either, because a test
+ * always loads a page and its bundles from the same build. So it is read off
+ * the server's configuration instead: static-web-server hands pages out with
+ * `max-age=86400` of its own, and nginx says nothing and lets the browser
+ * guess, so both have to be told. The bundles, named by their content, are the
+ * one thing worth keeping.
+ * @param dockerfile - The Dockerfile, which says what serves the build.
+ * @param byPath - Every file that was read, by repository path.
+ * @param problems - Where each problem found is appended.
+ */
+export declare function readPageCache(dockerfile: string, byPath: ReadonlyMap<string, string>, problems: DeployProblem[]): void;
+//# sourceMappingURL=pageCache.d.ts.map

package/lib/deploy/core/pageCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageCache.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/pageCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,iFAAiF;AACjF,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAE5C,yDAAyD;AACzD,eAAO,MAAM,YAAY,eAAe,CAAC;AAKzC;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,QAAQ,EAAE,aAAa,EAAE,GACxB,IAAI,CAMN"}

package/lib/deploy/core/pageCache.js

@@ -0,0 +1,91 @@
+/** The page cache policy of a static-web-server site, at the repository root. */
+export const PAGE_CACHE_CONFIG = 'sws.toml';
+/** The nginx configuration of a site served by nginx. */
+export const NGINX_CONFIG = 'nginx.conf';
+const NO_CACHE = /cache-control[\s:=]+["']?[^"'\n]*(?:no-cache|no-store|max-age=0)/i;
+/**
+ * Report a server that lets a browser keep the page itself.
+ *
+ * A page names the hashed bundles of the build that wrote it, so a browser
+ * still holding a copy from an earlier deploy asks the new image for files it
+ * does not have; the request falls through to the page, the browser refuses to
+ * run HTML as a module, and the site comes up blank until the copy expires.
+ * Nothing on the server can see it and no test can either, because a test
+ * always loads a page and its bundles from the same build. So it is read off
+ * the server's configuration instead: static-web-server hands pages out with
+ * `max-age=86400` of its own, and nginx says nothing and lets the browser
+ * guess, so both have to be told. The bundles, named by their content, are the
+ * one thing worth keeping.
+ * @param dockerfile - The Dockerfile, which says what serves the build.
+ * @param byPath - Every file that was read, by repository path.
+ * @param problems - Where each problem found is appended.
+ */
+export function readPageCache(dockerfile, byPath, problems) {
+    if (dockerfile.includes('static-web-server')) {
+        readStaticWebServer(dockerfile, byPath, problems);
+    }
+    else if (/^FROM\s+\S*nginx/im.test(dockerfile)) {
+        readNginx(byPath, problems);
+    }
+}
+function readStaticWebServer(dockerfile, byPath, problems) {
+    const named = /^\s*ENV\s+SERVER_CONFIG_FILE=(?<path>\S+)/m.exec(dockerfile);
+    const destination = named?.groups?.path;
+    if (destination === undefined) {
+        problems.push({
+            file: 'Dockerfile',
+            line: lineOf(dockerfile, /static-web-server/),
+            kind: 'cacheable-page',
+            message: 'static-web-server keeps every page in the browser for a day, so each deploy blanks the site for anyone who came by before it',
+            hint: `COPY ${PAGE_CACHE_CONFIG} /etc/sws.toml and set SERVER_CONFIG_FILE to it`,
+        });
+        return;
+    }
+    const copied = new RegExp(String.raw `^\s*COPY\s+(?:--\S+\s+)*${escapeRegExp(PAGE_CACHE_CONFIG)}\s+${escapeRegExp(destination)}\s*$`, 'm');
+    if (!copied.test(dockerfile)) {
+        problems.push({
+            file: 'Dockerfile',
+            line: lineOf(dockerfile, /^\s*ENV\s+SERVER_CONFIG_FILE=/m),
+            kind: 'cacheable-page',
+            message: `SERVER_CONFIG_FILE names ${destination}, which nothing puts there`,
+            hint: `COPY ${PAGE_CACHE_CONFIG} ${destination}`,
+        });
+        return;
+    }
+    readNoCacheRule(PAGE_CACHE_CONFIG, byPath, problems);
+}
+function readNginx(byPath, problems) {
+    readNoCacheRule(NGINX_CONFIG, byPath, problems);
+}
+function readNoCacheRule(path, byPath, problems) {
+    const text = byPath.get(path);
+    if (text === undefined) {
+        problems.push({
+            file: path,
+            line: 0,
+            kind: 'cacheable-page',
+            message: 'the server has no page cache policy to read',
+            hint: `commit ${path} at the repository root, telling the browser to check the page on every visit`,
+        });
+        return;
+    }
+    if (!NO_CACHE.test(text)) {
+        problems.push({
+            file: path,
+            line: 0,
+            kind: 'cacheable-page',
+            message: 'no rule stops a browser from keeping the page between deploys',
+            hint: 'give the page Cache-Control: no-cache, and keep the long life for the hashed bundles alone',
+        });
+    }
+}
+function lineOf(text, pattern) {
+    const match = pattern.exec(text);
+    if (match === null)
+        return 0;
+    return text.slice(0, match.index).split('\n').length;
+}
+function escapeRegExp(value) {
+    return value.replaceAll(/[$()*+.?[\\\]^{|}]/g, String.raw `\$&`);
+}
+//# sourceMappingURL=pageCache.js.map

package/lib/deploy/core/pageCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageCache.js","sourceRoot":"","sources":["../../../src/deploy/core/pageCache.ts"],"names":[],"mappings":"AAEA,iFAAiF;AACjF,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAE5C,yDAAyD;AACzD,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC;AAEzC,MAAM,QAAQ,GACZ,mEAAmE,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAC3B,UAAkB,EAClB,MAAmC,EACnC,QAAyB;IAEzB,IAAI,UAAU,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC7C,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;SAAM,IAAI,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACjD,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,UAAkB,EAClB,MAAmC,EACnC,QAAyB;IAEzB,MAAM,KAAK,GAAG,4CAA4C,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5E,MAAM,WAAW,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC;IACxC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,mBAAmB,CAAC;YAC7C,IAAI,EAAE,gBAAgB;YACtB,OAAO,EACL,8HAA8H;YAChI,IAAI,EAAE,QAAQ,iBAAiB,iDAAiD;SACjF,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,MAAM,CAAC,GAAG,CAAA,2BAA2B,YAAY,CAAC,iBAAiB,CAAC,MAAM,YAAY,CAAC,WAAW,CAAC,MAAM,EACzG,GAAG,CACJ,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,gCAAgC,CAAC;YAC1D,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,4BAA4B,WAAW,4BAA4B;YAC5E,IAAI,EAAE,QAAQ,iBAAiB,IAAI,WAAW,EAAE;SACjD,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,eAAe,CAAC,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,SAAS,CAChB,MAAmC,EACnC,QAAyB;IAEzB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,eAAe,CACtB,IAAY,EACZ,MAAmC,EACnC,QAAyB;IAEzB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,6CAA6C;YACtD,IAAI,EAAE,UAAU,IAAI,+EAA+E;SACpG,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,+DAA+D;YACxE,IAAI,EAAE,4FAA4F;SACnG,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,OAAe;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AACvD,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK,CAAC,UAAU,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,CAAA,KAAK,CAAC,CAAC;AAClE,CAAC"}

package/lib/deploy/core/types.d.ts

@@ -1,5 +1,5 @@
 /** What a repository got wrong against the deployment contract. */
-export type DeployProblemKind = 'missing-compose' | 'invalid-compose' | 'unpinned-image' | 'missing-build' | 'wrong-image-name' | 'required-env-file' | 'floating-sidecar' | 'missing-healthcheck' | 'missing-env-example' | 'missing-deploy-ignore';
+export type DeployProblemKind = 'missing-compose' | 'invalid-compose' | 'unpinned-image' | 'missing-build' | 'wrong-image-name' | 'required-env-file' | 'floating-sidecar' | 'missing-healthcheck' | 'missing-env-example' | 'missing-deploy-ignore' | 'cacheable-page';
 /** One way a repository would fail, or silently mis-deploy, on the server. */
 export interface DeployProblem {
     /** The file it was found in, named as the caller named it. */

package/lib/deploy/core/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/types.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,CAAC;AAE5B,8EAA8E;AAC9E,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,IAAI,EAAE,iBAAiB,CAAC;IACxB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sEAAsE;AACtE,MAAM,WAAW,UAAU;IACzB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAIjD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/deploy/core/types.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,GACvB,gBAAgB,CAAC;AAErB,8EAA8E;AAC9E,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,IAAI,EAAE,iBAAiB,CAAC;IACxB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sEAAsE;AACtE,MAAM,WAAW,UAAU;IACzB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAIjD,CAAC"}

package/lib/deploy/core/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/deploy/core/types.ts"],"names":[],"mappings":"AA8EA;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsB;IACrD,cAAc;IACd,sBAAsB;IACtB,0BAA0B;CAC3B,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/deploy/core/types.ts"],"names":[],"mappings":"AA+EA;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsB;IACrD,cAAc;IACd,sBAAsB;IACtB,0BAA0B;CAC3B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-cheminfo",
-  "version": "0.26.0",
+  "version": "0.27.0",
   "license": "MIT",
   "description": "React components, hooks and framework-free helpers shared by the cheminfo sites: site chrome, citations, sharing, routing, pedagogy, charts, and the structure, orbital and 3D molecule viewers",
   "author": "Luc Patiny",

package/src/deploy/core/checkDeploy.ts

@@ -1,5 +1,6 @@
 import { readComposeFile } from './composeFile.ts';
 import { readEnvExample } from './envExample.ts';
+import { readPageCache } from './pageCache.ts';
 import type { CheckDeployOptions, DeployFile, DeployProblem } from './types.ts';
 import { DEPLOY_COMPOSE_FILES } from './types.ts';
 
@@ -12,7 +13,9 @@ import { DEPLOY_COMPOSE_FILES } from './types.ts';
  * reports it healthy. So a repository has to hand it a selectable tag on every
  * image we build, an `IMAGE_NAME` that names the package our own workflow
  * publishes, a compose file that parses on a checkout with no `.env` yet, and a
- * health probe to read. Each of those is invisible until a deploy, which is the
+ * health probe to read. It also has to hand the browser a page the browser will
+ * not keep, or the next deploy leaves returning visitors on a blank one. Each
+ * of those is invisible until a deploy, which is the
  * worst moment to discover it — an `env_file` without `required: false` fails
  * before a container starts, and an `IMAGE_NAME` off by a suffix pulls a
  * package that was never published.
@@ -68,6 +71,9 @@ export function findDeployProblems(
     readEnvExample(envExample, expected, problems);
   }
 
+  const dockerfile = byPath.get('Dockerfile');
+  if (dockerfile !== undefined) readPageCache(dockerfile, byPath, problems);
+
   const gitignore = byPath.get('.gitignore');
   if (gitignore === undefined || !/^\s*\/?\.deploy\/?\s*$/m.test(gitignore)) {
     problems.push({

package/src/deploy/core/index.ts

@@ -5,4 +5,5 @@ export type {
   DeployProblem,
   DeployProblemKind,
 } from './types.ts';
+export { NGINX_CONFIG, PAGE_CACHE_CONFIG } from './pageCache.ts';
 export { DEPLOY_COMPOSE_FILES } from './types.ts';

package/src/deploy/core/pageCache.ts

@@ -0,0 +1,120 @@
+import type { DeployProblem } from './types.ts';
+
+/** The page cache policy of a static-web-server site, at the repository root. */
+export const PAGE_CACHE_CONFIG = 'sws.toml';
+
+/** The nginx configuration of a site served by nginx. */
+export const NGINX_CONFIG = 'nginx.conf';
+
+const NO_CACHE =
+  /cache-control[\s:=]+["']?[^"'\n]*(?:no-cache|no-store|max-age=0)/i;
+
+/**
+ * Report a server that lets a browser keep the page itself.
+ *
+ * A page names the hashed bundles of the build that wrote it, so a browser
+ * still holding a copy from an earlier deploy asks the new image for files it
+ * does not have; the request falls through to the page, the browser refuses to
+ * run HTML as a module, and the site comes up blank until the copy expires.
+ * Nothing on the server can see it and no test can either, because a test
+ * always loads a page and its bundles from the same build. So it is read off
+ * the server's configuration instead: static-web-server hands pages out with
+ * `max-age=86400` of its own, and nginx says nothing and lets the browser
+ * guess, so both have to be told. The bundles, named by their content, are the
+ * one thing worth keeping.
+ * @param dockerfile - The Dockerfile, which says what serves the build.
+ * @param byPath - Every file that was read, by repository path.
+ * @param problems - Where each problem found is appended.
+ */
+export function readPageCache(
+  dockerfile: string,
+  byPath: ReadonlyMap<string, string>,
+  problems: DeployProblem[],
+): void {
+  if (dockerfile.includes('static-web-server')) {
+    readStaticWebServer(dockerfile, byPath, problems);
+  } else if (/^FROM\s+\S*nginx/im.test(dockerfile)) {
+    readNginx(byPath, problems);
+  }
+}
+
+function readStaticWebServer(
+  dockerfile: string,
+  byPath: ReadonlyMap<string, string>,
+  problems: DeployProblem[],
+): void {
+  const named = /^\s*ENV\s+SERVER_CONFIG_FILE=(?<path>\S+)/m.exec(dockerfile);
+  const destination = named?.groups?.path;
+  if (destination === undefined) {
+    problems.push({
+      file: 'Dockerfile',
+      line: lineOf(dockerfile, /static-web-server/),
+      kind: 'cacheable-page',
+      message:
+        'static-web-server keeps every page in the browser for a day, so each deploy blanks the site for anyone who came by before it',
+      hint: `COPY ${PAGE_CACHE_CONFIG} /etc/sws.toml and set SERVER_CONFIG_FILE to it`,
+    });
+    return;
+  }
+
+  const copied = new RegExp(
+    String.raw`^\s*COPY\s+(?:--\S+\s+)*${escapeRegExp(PAGE_CACHE_CONFIG)}\s+${escapeRegExp(destination)}\s*$`,
+    'm',
+  );
+  if (!copied.test(dockerfile)) {
+    problems.push({
+      file: 'Dockerfile',
+      line: lineOf(dockerfile, /^\s*ENV\s+SERVER_CONFIG_FILE=/m),
+      kind: 'cacheable-page',
+      message: `SERVER_CONFIG_FILE names ${destination}, which nothing puts there`,
+      hint: `COPY ${PAGE_CACHE_CONFIG} ${destination}`,
+    });
+    return;
+  }
+
+  readNoCacheRule(PAGE_CACHE_CONFIG, byPath, problems);
+}
+
+function readNginx(
+  byPath: ReadonlyMap<string, string>,
+  problems: DeployProblem[],
+): void {
+  readNoCacheRule(NGINX_CONFIG, byPath, problems);
+}
+
+function readNoCacheRule(
+  path: string,
+  byPath: ReadonlyMap<string, string>,
+  problems: DeployProblem[],
+): void {
+  const text = byPath.get(path);
+  if (text === undefined) {
+    problems.push({
+      file: path,
+      line: 0,
+      kind: 'cacheable-page',
+      message: 'the server has no page cache policy to read',
+      hint: `commit ${path} at the repository root, telling the browser to check the page on every visit`,
+    });
+    return;
+  }
+  if (!NO_CACHE.test(text)) {
+    problems.push({
+      file: path,
+      line: 0,
+      kind: 'cacheable-page',
+      message: 'no rule stops a browser from keeping the page between deploys',
+      hint: 'give the page Cache-Control: no-cache, and keep the long life for the hashed bundles alone',
+    });
+  }
+}
+
+function lineOf(text: string, pattern: RegExp): number {
+  const match = pattern.exec(text);
+  if (match === null) return 0;
+  return text.slice(0, match.index).split('\n').length;
+}
+
+function escapeRegExp(value: string): string {
+  return value.replaceAll(/[$()*+.?[\\\]^{|}]/g, String.raw`\$&`);
+}

package/src/deploy/core/types.ts

@@ -9,7 +9,8 @@ export type DeployProblemKind =
   | 'floating-sidecar'
   | 'missing-healthcheck'
   | 'missing-env-example'
-  | 'missing-deploy-ignore';
+  | 'missing-deploy-ignore'
+  | 'cacheable-page';
 
 /** One way a repository would fail, or silently mis-deploy, on the server. */
 export interface DeployProblem {