From d9ff875ade87c68e78e005d6948ddfe20eab8bf3 Mon Sep 17 00:00:00 2001 From: Sluijsens Date: Sun, 15 Nov 2026 17:02:17 +0100 Subject: [PATCH] Lets the deployment check cope with pages the CMS host has filled The check after a deploy compared the server's answer with dist byte for byte, which fails once the host writes current data into the markers. Both sides are now normalised first (regions, data block, offers, inline prices, site address); everything else still has to match. The stand-in host no longer injects the 404 page, like the real one. Co-Authored-By: Claude Sonnet 5.5 --- docs/deploy-and-ci.md | 4 + web/config/normalizeInjected.test.ts | 106 +++++++++++++++++++++++++++ web/config/normalizeInjected.ts | 77 +++++++++++++++++++ web/config/previewServer.ts | 6 +- web/deploy/verify-deployment.sh | 16 +++- 5 files changed, 207 insertions(+), 2 deletions(-) create mode 100644 web/config/normalizeInjected.test.ts create mode 100644 web/config/normalizeInjected.ts diff --git a/docs/deploy-and-ci.md b/docs/deploy-and-ci.md index 3a9b457..29fd43c 100644 --- a/docs/deploy-and-ci.md +++ b/docs/deploy-and-ci.md @@ -37,6 +37,10 @@ Committing, pushing and deploying a feature branch to test is allowed for the se `feature/contact-form-cms` carries commit **`d449e76` "TEST ONLY: enable the contact form for the ASF test deploy"**, which sets `contactForm.enabled: true` in `web/src/content/siteContent.ts` so the ASF test host shows the real form. It must not reach `master` (the form stays off in production until Bryan gives an explicit go). Before merging, revert it (`git revert d449e76`, or drop it from the branch) and confirm `enabled` is `false` again. The packages branch is based on the contact-form branch, so the merge order is `contact-form-cms` first, then `asf-packages-cms`. Both merges need Bryan's go. +## The check after a deploy and the host injection + +`deploy/verify-deployment.sh` compares what the server sends with the files in `dist`. Once the CMS host injects (packages, banners, prices, JSON-LD price, site address), the pages differ from `dist` by design, so both sides are first normalised with `config/normalizeInjected.ts` (the contents of the CMS regions, the data block, `offers` in structured data, inline prices and the site address are taken out). Everything else must still be equal byte for byte, so an old build or a wrong server config is still caught; the 404 page is not injected and is compared as it is. The preview server can stand in for the host (`node config/previewServer.ts --cms-data=`), which is how the script is tried locally. + ## Own address of the test site The test site stands on its own: in the test build `VITE_SITE_URL` is `https://test.andreaslop.nl`, so canonical, `og:url`, `og:image`, the JSON-LD ids and urls and `sitemap.xml` all point to the test host. A link shared from the test site (WhatsApp, Discord) therefore shows its own picture, not one from production. The production artifact (job `check`) is built without the variable and keeps `https://andreaslop.nl`. `src/lib/siteUrl.ts` only accepts an origin (https, or http on localhost); anything else falls back to production, so a typo cannot move production to another domain. This is a build setting, not TEST ONLY code: nothing has to be reverted before a merge. `robots.txt` on the test host is the nginx one (`Disallow: /`, plus `X-Robots-Tag: noindex`), not `public/robots.txt`, so the test site stays out of search engines. To try it locally: `VITE_SITE_URL=http://localhost:4173 pnpm build`. diff --git a/web/config/normalizeInjected.test.ts b/web/config/normalizeInjected.test.ts new file mode 100644 index 0000000..2776315 --- /dev/null +++ b/web/config/normalizeInjected.test.ts @@ -0,0 +1,106 @@ +import { readFileSync } from 'node:fs'; +import { join } from 'node:path'; +import { describe, expect, it } from 'vitest'; +import { injectCms, type LiveData } from './hostInjector.ts'; +import { normalizeInjected } from './normalizeInjected.ts'; + +const AUTHORED = 'https://andreaslop.nl'; + +const baked = (name: string) => { + try { + return readFileSync( + join(process.cwd(), 'dist', 'client', name), + 'utf8', + ); + } catch { + return null; + } +}; + +const live: LiveData = { + offerings: [ + { + slug: 'newborn', + title: 'Newborn', + price: '€ 999', + features: ['x'], + displayOrder: 0, + }, + ], + banners: { top: { text: 'Boven' }, bottom: null }, +}; + +describe('normalizeInjected', () => { + it('makes a page equal to the same page after the host filled the markers', () => { + const pages = ['index.html', 'soorten-fotoshoots/newborn.html']; + for (const page of pages) { + const html = baked(page); + // The tests of the unit run need no build; skip a page that is not built + if (html === null) continue; + const injected = injectCms(html, { + data: live, + authoredBaseUrl: AUTHORED, + publicBaseUrl: 'https://test.example.nl', + }); + expect(injected).not.toBe(html); + expect( + normalizeInjected(injected, [ + AUTHORED, + 'https://test.example.nl', + ]), + ).toBe( + normalizeInjected(html, [AUTHORED, 'https://test.example.nl']), + ); + } + }); + + const page = (inner: string) => `${inner}`; + + it('empties the regions but keeps the markers', () => { + expect( + normalizeInjected( + page('a'), + ), + ).toBe(page('')); + }); + + it('removes the data block with or without its marker', () => { + const block = + ''; + expect(normalizeInjected(page('' + block))).toBe( + page(''), + ); + expect(normalizeInjected(page(block))).toBe(page('')); + expect(normalizeInjected(page(''))).toBe(page('')); + }); + + it('drops offers from structured data and the marker before it', () => { + const withOffers = + ''; + const without = + ''; + expect(normalizeInjected(page(withOffers))).toBe( + normalizeInjected(page(without)), + ); + }); + + it('leaves structured data that is not JSON, so it still differs', () => { + const broken = ''; + expect(normalizeInjected(page(broken))).toBe(page(broken)); + }); + + it('empties inline prices and replaces the site addresses', () => { + expect( + normalizeInjected( + page('€ 5 https://a.nl/x'), + ['https://a.nl'], + ), + ).toBe(page(' @SITE@/x')); + }); + + it('still sees a real difference', () => { + expect(normalizeInjected(page('

een

'))).not.toBe( + normalizeInjected(page('

twee

')), + ); + }); +}); diff --git a/web/config/normalizeInjected.ts b/web/config/normalizeInjected.ts new file mode 100644 index 0000000..416fd21 --- /dev/null +++ b/web/config/normalizeInjected.ts @@ -0,0 +1,77 @@ +// Makes a prerendered page and the same page after the CMS host filled its +// markers comparable. The deployment check (deploy/verify-deployment.sh) +// compares what the server sends with the file in dist; since the host +// writes the current packages, banners, prices and address into the page, +// those parts are taken out of both sides first. Everything else must still be +// byte for byte equal, so an old build or a wrong server config is still +// caught. The rules mirror the host contract in +// aidlc-docs/features/asf-cms-host-injection/plan.md. +// +// Usage: node config/normalizeInjected.ts [site-url ...] +import { readFileSync, writeFileSync } from 'node:fs'; + +const REGION = + /()[\s\S]*?()/g; +const DATA_BLOCK = + /(?:)?