@delmaredigital/payload-experiments 0.3.0-rc.1 → 0.4.0-rc.1

package/dist/transitions/placementInteractions.js

@@ -0,0 +1,94 @@
+import { placementPathContent, placementTests } from '../db/placements.js';
+import { lockPagePaths } from '../db/locks.js';
+import { normalisePath } from '../runtime/normalisePath.js';
+import { scanBlockPlacements } from './placements.js';
+import { interactingTestsCopy } from '../admin/copy/readiness.js';
+import { XpRefusal } from '../errors.js';
+import { pageTargetPaths } from './checkStart.js';
+export async function detached(req, fn) {
+    const transactionID = req.transactionID;
+    delete req.transactionID;
+    try {
+        return await fn();
+    } finally{
+        req.transactionID = transactionID;
+    }
+}
+export function uniquePlacementDocs(placements) {
+    return [
+        ...new Map(placements.map((p)=>[
+                JSON.stringify([
+                    p.collection,
+                    String(p.id)
+                ]),
+                {
+                    collection: p.collection,
+                    id: p.id
+                }
+            ])).values()
+    ];
+}
+export function scanPlacements(req, options, slug) {
+    return scanBlockPlacements(req, {
+        slug,
+        puckCollections: options.puck?.collections ?? [],
+        blocksCollections: options.blocks?.collections ?? []
+    });
+}
+export async function placementPaths(req, options, docs) {
+    const paths = new Set();
+    for (const doc of docs){
+        const registration = options.pages?.collections.find((r)=>r.slug === doc.collection);
+        if (!registration) continue;
+        const row = await placementPathContent(req, doc.collection, doc.id);
+        if (!row || row._status === 'draft') continue;
+        const path = registration.pathOf(row);
+        if (path !== null) paths.add(normalisePath(path));
+    }
+    return [
+        ...paths
+    ].sort();
+}
+const active = (test)=>test.status === 'running' || test.status === 'decided';
+export async function placementInteractions(req, exec, options, experiment, paths) {
+    const result = [];
+    for (const test of (await placementTests(exec))){
+        if (!active(test) || String(test.id) === String(experiment.id)) continue;
+        if (experiment.kind === 'block' && test.kind === 'page') {
+            for (const path of paths.filter((path)=>pageTargetPaths(test.arms).includes(path)))result.push({
+                experimentId: test.id,
+                slug: test.slug,
+                name: test.name,
+                status: test.status,
+                path,
+                version: test.arms.some((a)=>a.kind === 'variant' && a.pageTarget && normalisePath(a.pageTarget) === path)
+            });
+        } else if (experiment.kind === 'page' && test.kind === 'block') {
+            const docs = test.placementDocs ?? uniquePlacementDocs(await detached(req, ()=>scanPlacements(req, options, test.slug)));
+            const relevant = docs.filter((doc)=>!experiment.pageCollection || doc.collection === experiment.pageCollection);
+            for (const path of (await placementPaths(req, options, relevant)).filter((path)=>paths.includes(path)))result.push({
+                experimentId: test.id,
+                slug: test.slug,
+                name: test.name,
+                status: test.status,
+                path,
+                version: experiment.arms.some((a)=>a.kind === 'variant' && a.pageTarget && normalisePath(a.pageTarget) === path)
+            });
+        }
+    }
+    return result;
+}
+export async function lockAndRescanPlacements(req, exec, options, experiment, before) {
+    const paths = await placementPaths(req, options, uniquePlacementDocs(before));
+    await lockPagePaths(exec, paths);
+    const placements = await detached(req, ()=>scanPlacements(req, options, experiment.slug));
+    const docs = uniquePlacementDocs(placements);
+    const afterPaths = await placementPaths(req, options, docs);
+    if (afterPaths.some((path)=>!paths.includes(path))) throw new XpRefusal('placements-changed', "This test's pages changed while it was starting. Try again.", undefined, 409);
+    const conflicts = await placementInteractions(req, exec, options, experiment, paths);
+    if (conflicts.length) throw new XpRefusal('interacting-tests', interactingTestsCopy(conflicts[0].path, conflicts[0].status, conflicts[0].name, conflicts[0].version), conflicts, 409);
+    return {
+        placements,
+        docs
+    };
+}

package/dist/transitions/placements.d.ts

@@ -1,12 +1,12 @@
 import type { PayloadRequest } from 'payload';
-import type { Arm, DocId, FlagPoint, ResolvedOptions } from '../types/contracts.js';
+import type { Arm, DocId, FlagPoint, PreviewPlacement, ResolvedOptions } from '../types/contracts.js';
 import type { ArmSlot } from '../types/puck.js';
-export interface BlockPlacement {
-    collection: string;
-    id: DocId;
-    title: string;
-    published: boolean;
+export interface BlockPlacement extends PreviewPlacement {
+    editor?: 'puck' | 'blocks' | 'page';
+    doc?: Record<string, unknown>;
     slots: Record<ArmSlot, number>;
+    duplicateRows?: boolean;
+    identicalSlots?: string[];
     locked?: boolean;
     localized?: boolean;
 }
@@ -17,10 +17,14 @@ export type FlagPlacement = Awaited<ReturnType<NonNullable<FlagPoint['placements
 export declare function scanBlockPlacements(req: PayloadRequest, args: {
     slug: string;
     puckCollections: NonNullable<ResolvedOptions['puck']>['collections'];
+    blocksCollections: NonNullable<ResolvedOptions['blocks']>['collections'];
+    compareVersions?: boolean;
 }): Promise<BlockPlacement[]>;
 export declare function scanBlockPlacements(req: PayloadRequest, args: {
     slugs: ReadonlySet<string>;
     puckCollections: NonNullable<ResolvedOptions['puck']>['collections'];
+    blocksCollections: NonNullable<ResolvedOptions['blocks']>['collections'];
+    compareVersions?: boolean;
 }): Promise<Map<string, BlockPlacement[]>>;
 export declare function flagPlacements<TUser extends {
     id: DocId;

package/dist/transitions/placements.js

@@ -1,5 +1,10 @@
+import { BLOCK_SLOTS, EXPERIMENT_BLOCK_SLUG, hostBlocks, slotBlocks } from '../blocks/model.js';
+import { safeError } from '../log.js';
+import { pageVersionContent } from '../db/pageContent.js';
+import { comparableContent } from './pageVersions.js';
+import { isDeepStrictEqual } from 'node:util';
 import { hasLocalizedFields } from './contentFields.js';
-import { puckCollections as normalisePuckCollections } from '../options.js';
+import { documentEditor, puckCollections as normalisePuckCollections } from '../options.js';
 const slots = [
     'control',
     'variantA',
@@ -23,7 +28,9 @@ export async function scanBlockPlacements(req, args) {
             collections: puckCollections
         }
     })){
+        const editors = new Map();
         const publishedIds = new Set();
+        const publishedSlugs = new Map();
         const draftsEnabled = req.payload.config.collections?.some((config)=>config.slug === collection && config.versions && config.versions.drafts);
         for (const draft of [
             false,
@@ -51,7 +58,29 @@ export async function scanBlockPlacements(req, args) {
                 for (const doc of result.docs){
                     if (!draft && doc._status === 'draft') continue;
                     if (draft && doc._status !== 'draft' && publishedIds.has(String(doc.id))) continue;
-                    if (!draft) publishedIds.add(String(doc.id));
+                    if (!draft) {
+                        editors.set(String(doc.id), documentEditor({
+                            puck: {
+                                enabled: true,
+                                collections: puckCollections
+                            },
+                            blocks: {
+                                collections: args.blocksCollections
+                            }
+                        }, collection, doc));
+                        publishedIds.add(String(doc.id));
+                        if (typeof doc.slug === 'string') publishedSlugs.set(String(doc.id), doc.slug);
+                    }
+                    const editor = editors.get(String(doc.id)) ?? documentEditor({
+                        puck: {
+                            enabled: true,
+                            collections: puckCollections
+                        },
+                        blocks: {
+                            collections: args.blocksCollections
+                        }
+                    }, collection, doc);
+                    if (editor !== 'puck') continue;
                     function walk(value) {
                         if (!value || typeof value !== 'object') return;
                         if (Array.isArray(value)) {
@@ -66,8 +95,13 @@ export async function scanBlockPlacements(req, args) {
                             placements.get(experiment).push({
                                 collection,
                                 id: doc.id,
+                                editor: 'puck',
+                                doc,
                                 title: String(doc.title ?? doc.name ?? doc.id),
                                 published: !draft || doc._status === 'published',
+                                ...publishedSlugs.has(String(doc.id)) ? {
+                                    slug: publishedSlugs.get(String(doc.id))
+                                } : {},
                                 slots: Object.fromEntries(slots.map((slot)=>[
                                         slot,
                                         Array.isArray(props[slot]) ? props[slot].length : 0
@@ -80,7 +114,115 @@ export async function scanBlockPlacements(req, args) {
                         }
                         Object.values(node).forEach(walk);
                     }
+                    const offsets = new Map([
+                        ...placements
+                    ].map(([slug, list])=>[
+                            slug,
+                            list.length
+                        ]));
                     walk(doc[field]);
+                    if (args.compareVersions && !draft && [
+                        ...placements
+                    ].some(([slug, list])=>list.length > offsets.get(slug))) {
+                        const raw = await comparisonContent(req, collection, doc.id);
+                        const rawSlots = new Map();
+                        const collect = (value)=>{
+                            if (Array.isArray(value)) {
+                                value.forEach(collect);
+                                return;
+                            }
+                            if (!value || typeof value !== 'object') return;
+                            const node = value, props = node.props;
+                            const ref = props?.experiment;
+                            const slug = typeof ref === 'string' ? ref : ref && typeof ref === 'object' && 'slug' in ref ? ref.slug : undefined;
+                            if (node.type === 'ExperimentSlot' && props && typeof slug === 'string') {
+                                const list = rawSlots.get(slug) ?? [];
+                                list.push(props);
+                                rawSlots.set(slug, list);
+                            }
+                            Object.values(node).forEach(collect);
+                        };
+                        if (raw && raw._status !== 'draft') collect(raw[field]);
+                        for (const [slug, list] of placements)list.slice(offsets.get(slug)).forEach((placement, index)=>{
+                            const props = rawSlots.get(slug)?.[index];
+                            if (props) placement.identicalSlots = slots.filter((slot)=>slot !== 'control' && Array.isArray(props[slot]) && props[slot].length > 0 && isDeepStrictEqual(comparableContent(props.control ?? []), comparableContent(props[slot])));
+                        });
+                    }
+                }
+                if (!result.hasNextPage) break;
+                page++;
+            }
+        }
+    }
+    for (const registration of args.blocksCollections){
+        const { slug: collection, field } = registration;
+        const published = new Map();
+        const draftsEnabled = req.payload.config.collections?.some((c)=>c.slug === collection && c.versions && c.versions.drafts);
+        for (const draft of [
+            false,
+            true
+        ]){
+            let page = 1;
+            while(true){
+                const result = await req.payload.find({
+                    collection,
+                    req,
+                    overrideAccess: false,
+                    depth: 0,
+                    limit: 100,
+                    page,
+                    draft,
+                    includeLockStatus: true,
+                    ...!draft && draftsEnabled ? {
+                        where: {
+                            _status: {
+                                equals: 'published'
+                            }
+                        }
+                    } : {}
+                });
+                for (const doc of result.docs){
+                    if (!draft && doc._status === 'draft') continue;
+                    if (!draft) published.set(String(doc.id), doc);
+                    else if (doc._status !== 'draft' && published.has(String(doc.id))) continue;
+                    const baseline = published.get(String(doc.id)) ?? doc;
+                    if (documentEditor({
+                        blocks: {
+                            collections: args.blocksCollections
+                        },
+                        puck: {
+                            enabled: true,
+                            collections: puckCollections
+                        }
+                    }, collection, baseline) !== 'blocks') continue;
+                    const raw = args.compareVersions && !draft && hostBlocks(doc[field]).some((block)=>block.blockType === (registration.blockSlug ?? EXPERIMENT_BLOCK_SLUG) && typeof block.experiment === 'string' && slugs.has(block.experiment)) ? await comparisonContent(req, collection, doc.id) : undefined;
+                    for (const [index, block] of hostBlocks(doc[field]).entries()){
+                        if (block.blockType !== (registration.blockSlug ?? EXPERIMENT_BLOCK_SLUG) || typeof block.experiment !== 'string' || !slugs.has(block.experiment)) continue;
+                        const stored = raw ? hostBlocks(raw[field]).find((row)=>row.id === block.id) ?? hostBlocks(raw[field])[index] ?? block : block;
+                        const rows = Array.isArray(stored.slots) ? stored.slots : [];
+                        const keys = rows.map((row)=>row?.slot);
+                        placements.get(block.experiment).push({
+                            collection,
+                            id: doc.id,
+                            editor: 'blocks',
+                            doc,
+                            title: String(doc.title ?? doc.name ?? doc.id),
+                            published: !draft || doc._status === 'published',
+                            ...typeof baseline.slug === 'string' ? {
+                                slug: baseline.slug
+                            } : {},
+                            slots: Object.fromEntries(BLOCK_SLOTS.map((slot)=>[
+                                    slot,
+                                    slotBlocks(block, slot).length
+                                ])),
+                            duplicateRows: new Set(keys).size !== keys.length,
+                            identicalSlots: raw ? BLOCK_SLOTS.filter((slot)=>slot !== 'control' && slotBlocks(block, slot).length > 0 && isDeepStrictEqual(comparableContent(slotBlocks(stored, 'control')), comparableContent(slotBlocks(stored, slot)))) : [],
+                            locked: doc._isLocked === true || doc.locked === true,
+                            ...hasLocalizedFields(req.payload.config.collections?.find((c)=>c.slug === collection)?.fields ?? [], req.payload.config) ? {
+                                localized: true
+                            } : {}
+                        });
+                    }
                 }
                 if (!result.hasNextPage) break;
                 page++;
@@ -98,3 +240,15 @@ export async function flagPlacements(options, experiment, req) {
         req
     });
 }
+/** A warning-only comparison must never turn an adapter failure into a Start refusal. */ async function comparisonContent(req, collection, id) {
+    try {
+        return await pageVersionContent(req, collection, id);
+    } catch (cause) {
+        req.payload.logger.error({
+            err: safeError(cause),
+            collection,
+            id
+        }, 'Experiment version comparison failed');
+        return undefined;
+    }
+}

package/dist/transitions/preflightData.d.ts

@@ -13,6 +13,14 @@ export interface PreflightDependencies {
 export declare function loadStartInputs<TUser extends {
     id: DocId;
 }>(req: PayloadRequest, options: ResolvedOptions<TUser>, experimentId: DocId): Promise<CheckStartInput | null>;
+/** Occupancy from the arms the runtime routes on (frozen rounds), shared by preflight and
+ * Start's locked recheck. Raw SQL on the request's transaction when there is one. */
+export declare function loadPageTestsInUse(req: PayloadRequest): Promise<NonNullable<CheckStartInput['pageTestsInUse']>>;
+/** Page targets no registered collection reports as published. A lookup that throws counts as
+ * unpublished (logged) unless propagateErrors is requested by decide. Start calls it again under its page-path locks on a detached request. */
+export declare function unpublishedPageTargets<TUser extends {
+    id: DocId;
+}>(req: PayloadRequest, options: ResolvedOptions<TUser>, experiment: Pick<StartExperiment, 'id' | 'arms' | 'pageCollection'>, propagateErrors?: boolean): Promise<string[]>;
 /** Shared, request-scoped reads for summary; a failed row is null in tolerant mode.
  * Preflight/Start use the same builder and retain their throwing read behaviour.
  */