@cparkerwebm/webmonterey 1.1.0 → 1.2.0

package/src/includes/webmonterey/credits/credit.test.ts

@@ -1,111 +0,0 @@
-import { test } from 'node:test';
-import assert from 'node:assert/strict';
-import { readFileSync } from 'node:fs';
-
-import { contentTag, CREDIT_TEXT, creditUrl } from './credit.ts';
-
-/*
- * Credit.astro read as SOURCE, because it cannot be imported here: it pulls in ../site.ts, which
- * imports virtual:webm/site, which only resolves inside an Astro build. A source assertion is the
- * weaker tool and it is the one available - and the alternative in place until now was nothing.
- *
- * WHY IT NEEDS ONE AT ALL. This anchor once carried rel="noopener" and no target, which does
- * nothing whatsoever - noopener only means anything alongside a target - so the credit navigated
- * the visitor away from the client's site in the same tab. That shipped to live sites. The
- * regression test written afterwards guards the EMAIL footer, in emails/footer.test.ts; the
- * component where the bug actually happened had no test until this one.
- */
-const componentSource = readFileSync(new URL('./Credit.astro', import.meta.url), 'utf8');
-/** The template with its {/* *\/} comment blocks removed, so prose about the rule is not read as the rule. */
-const template = componentSource.replace(/\{\s*\/\*[\s\S]*?\*\/\s*\}/g, '');
-const anchors: string[] = template.match(/<a\s[^>]*>/g) ?? [];
-/** The single credit anchor. Asserted to be the only one below. */
-const anchor = (): string => anchors[0] ?? '';
-
-test('creditUrl points at the main site, not a /credits page', () => {
-  const url = new URL(creditUrl('example.com'));
-  assert.equal(url.origin, 'https://webmonterey.com');
-  assert.equal(url.pathname, '/', 'the credit link must not reintroduce a /credits path');
-});
-
-test('creditUrl carries all four UTM parameters', () => {
-  const { searchParams } = new URL(creditUrl('example.com'));
-  assert.equal(searchParams.get('utm_source'), 'client');
-  assert.equal(searchParams.get('utm_campaign'), 'credits');
-  assert.equal(searchParams.get('utm_content'), 'example_com');
-});
-
-test('utm_medium separates the two surfaces', () => {
-  const site = new URL(creditUrl('example.com', 'website'));
-  const email = new URL(creditUrl('example.com', 'email'));
-  assert.equal(site.searchParams.get('utm_medium'), 'website');
-  assert.equal(email.searchParams.get('utm_medium'), 'email');
-});
-
-test('utm_medium defaults to website', () => {
-  assert.equal(new URL(creditUrl('example.com')).searchParams.get('utm_medium'), 'website');
-});
-
-test('utm_content is the production domain, with every dot as an underscore', () => {
-  // Not the host the page is served from — a preview build must not fragment attribution.
-  const url = new URL(creditUrl('sub.example.co.uk', 'email'));
-  assert.equal(url.searchParams.get('utm_content'), 'sub_example_co_uk');
-});
-
-test('both surfaces tag the same client the same way', () => {
-  const site = new URL(creditUrl('example.com', 'website'));
-  const email = new URL(creditUrl('example.com', 'email'));
-  assert.equal(site.searchParams.get('utm_content'), email.searchParams.get('utm_content'));
-});
-
-test('no dot survives into the credit URL, so nothing can linkify it', () => {
-  const url = new URL(creditUrl('example.com', 'email'));
-  assert.equal(url.searchParams.get('utm_content'), 'example_com');
-  /*
-   * Scoped to the QUERY STRING, not the whole URL: the destination host is webmonterey.com
-   * and is allowed to look like a host. It is the parameter value that must not.
-   */
-  assert.equal(url.search.includes('.'), false);
-});
-
-test('contentTag leaves a domain that has no dots alone', () => {
-  assert.equal(contentTag('localhost'), 'localhost');
-});
-
-test('contentTag changes nothing but the dots', () => {
-  // The value still has to be recognisably the site it came from in the report.
-  assert.equal(contentTag('steven-glaze.com'), 'steven-glaze_com');
-});
-
-test('CREDIT_TEXT is the shared wording', () => {
-  assert.equal(CREDIT_TEXT, 'Powered by WebMonterey');
-});
-
-/* ── the footer credit's link, mirroring emails/footer.test.ts ────────────────────────────── */
-
-test('the site credit renders exactly one link', () => {
-  assert.equal(anchors.length, 1, `expected one anchor, found ${anchors.length}`);
-});
-
-test('the site credit opens in a new tab', () => {
-  // The half that was missing. Without it the visitor leaves the client's site to read ours.
-  assert.match(anchor(), /target="_blank"/);
-});
-
-test('the new tab cannot reach back into the client page', () => {
-  assert.match(anchor(), /rel="[^"]*noopener/);
-});
-
-/*
- * Locking a decision rather than an implementation detail: the referrer IS the attribution, so
- * stripping it would leave only utm_content. This is the kind of thing someone adds in good faith
- * while "hardening" a target=_blank link.
- */
-test('the credit link deliberately does not send noreferrer', () => {
-  assert.doesNotMatch(anchor(), /noreferrer/);
-});
-
-test('the new tab is announced, not just implemented', () => {
-  // A link that moves the user to another tab without saying so is a semantics bug.
-  assert.match(template, /webm-visually-hidden[^>]*>\s*\(opens in a new tab\)/);
-});

package/src/includes/webmonterey/credits/credit.ts

@@ -1,59 +0,0 @@
-/*
- * The agency credit's wording and link, in ONE place.
- *
- * Two surfaces render this credit and they cannot share a component: the site footer is an
- * .astro component with scoped CSS, and transactional email is a string with inline styles
- * (email clients strip <style> blocks). Without this module the wording exists twice, and the
- * next time it changes one copy gets missed — which is exactly how "a WebMonterey website"
- * would have survived in email after the footer moved to "Powered by WebMonterey".
- *
- * utm_content is ALWAYS the production domain from webmonterey.json, never the host the page
- * happens to be served from. A preview build at `feature-x-webm-example-com.workers.dev`
- * still reports the client's own domain, so staging traffic does not fragment the attribution.
- *
- * IT IS WRITTEN WITH UNDERSCORES — `example_com`, not `example.com`. A dot makes the value look
- * like a hostname, and analytics UIs read it as one rather than as the label it is. Underscores
- * keep it a label. Every dot goes, subdomains included: `sub.example.co.uk` is `sub_example_co_uk`.
- *
- * This comment used to also claim a mail client would linkify `example.com` inside the query
- * string and truncate the URL there. That does not apply: auto-linkification acts on plain text,
- * and here the URL only ever appears inside an href. Corrected rather than deleted, because a
- * justification that does not survive scrutiny invites someone to reverse the decision it
- * defends — and the analytics reason on its own is enough.
- *
- * The link points at the WebMonterey home page, not a /credits landing page. The UTM
- * parameters carry the whole story, so the destination stays the main site and there is no
- * separate page to keep alive. utm_medium is what separates the two surfaces: `website` from
- * the footer, `email` from a transactional template.
- */
-
-/** The credit wording. Rendered verbatim on the site and in email. */
-export const CREDIT_TEXT = 'Powered by WebMonterey';
-
-/**
- * Which surface the click came from. Kept separate from utm_content so the report can tell
- * a footer click from an email click without splitting it per client.
- */
-export type CreditMedium = 'website' | 'email';
-
-/**
- * The client's domain as a UTM label rather than as a domain. Dots only — the value is
- * otherwise left exactly as webmonterey.json wrote it, so what lands in the report is still
- * recognisably the site it came from.
- */
-export function contentTag(domain: string): string {
-  return domain.replace(/\./g, '_');
-}
-
-/** The attributed credit link for one client site. */
-export function creditUrl(domain: string, medium: CreditMedium = 'website'): string {
-  const params = new URLSearchParams({
-    utm_source: 'client',
-    utm_medium: medium,
-    utm_campaign: 'credits',
-    /* See the note above: a dot here is a link waiting to be made out of the query string. */
-    utm_content: contentTag(domain),
-  });
-
-  return `https://webmonterey.com/?${params}`;
-}