@pikku/core 0.12.121 → 0.12.122

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.12.122
+
+### Patch Changes
+
+- 3511717: A virtual user run refused for an unknown or acted-upon persona now answers 400, and one refused for a probing disposition in production answers 403, carrying the reason instead of a bare 500 errorId.
+- 3511717: Enabling a virtual user schedule whose disposition production refuses is now refused when written (403), rather than saved and then failing on every tick with nobody watching. Disabling one, or editing one that is off, is always allowed.
+
 ## 0.12.121
 
 ### Patch Changes

package/dist/wirings/virtual-user/virtual-user-scaffold.d.ts

@@ -210,15 +210,26 @@ export interface WriteVirtualUserScheduleParams {
     minIntervalMs?: number;
     maxIntervalMs?: number;
     nextRunAt?: string;
+    /** The same three signals `startVirtualUserRun` reads to decide production. */
+    config?: {
+        nodeEnv?: string;
+    };
+    environments?: Readonly<Record<string, PersonaEnvironment>>;
+    environment?: string;
 }
 /**
  * Writes a persona's cadence.
  *
- * Applies the same rule `startVirtualUserRun` enforces, at the point the row is
+ * Applies the same rules `startVirtualUserRun` enforces, at the point the row is
  * written rather than every hour afterwards: an acted-upon persona has no
- * session, so a cadence for one is a tick that can only ever fail to start.
+ * session, and an enabled cadence whose disposition production refuses, so
+ * either is a tick that can only ever fail to start, with nobody watching.
+ *
+ * The disposition checked is the one the row will hold, since a field left out
+ * keeps what it had: enabling a row saved earlier as adversarial is refused
+ * just as saving one would be.
  */
-export declare const writeVirtualUserSchedule: ({ store, personas, persona, enabled, disposition, goals, budget, minIntervalMs, maxIntervalMs, nextRunAt, }: WriteVirtualUserScheduleParams) => Promise<VirtualUserScheduleRecord>;
+export declare const writeVirtualUserSchedule: ({ store, personas, persona, enabled, disposition, goals, budget, minIntervalMs, maxIntervalMs, nextRunAt, config, environments, environment, }: WriteVirtualUserScheduleParams) => Promise<VirtualUserScheduleRecord>;
 /** What a due schedule asks `runVirtualUser` for. */
 export declare const virtualUserScheduleRunInput: (schedule: VirtualUserScheduleRecord) => {
     persona: string;

package/dist/wirings/virtual-user/virtual-user-scaffold.js

@@ -1,3 +1,4 @@
+import { BadRequestError, ForbiddenError } from '../../errors/errors.js';
 import { prepareVirtualUserRun } from './prepare-virtual-user-run.js';
 import { runVirtualUser as runVirtualUserEngine } from './run-virtual-user.js';
 import { personaVirtualUserTarget } from './virtual-user-target.js';
@@ -59,10 +60,10 @@ export const signInPathFor = (configured, plugin) => {
 export const runnablePersona = (personas, personaId) => {
     const persona = personas[personaId];
     if (!persona) {
-        throw new Error(`Unknown persona "${personaId}" — declare it with definePersonas()`);
+        throw new BadRequestError(`Unknown persona "${personaId}" — declare it with definePersonas()`);
     }
     if (!persona.runnable) {
-        throw new Error(`Persona "${personaId}" is declared as acted upon, never run`);
+        throw new BadRequestError(`Persona "${personaId}" is declared as acted upon, never run`);
     }
     return persona;
 };
@@ -106,6 +107,14 @@ const isProductionRun = (config, environments, environment) => {
     }
     return environment ? Boolean(environments[environment]?.production) : true;
 };
+// Every disposition other than this one exists to find out what the product
+// does wrong, which is not a thing to do to real customers' data.
+const refuseInProduction = (personaId, disposition, config, environments, environment) => {
+    if (disposition !== PRODUCTION_DISPOSITION &&
+        isProductionRun(config, environments, environment)) {
+        throw new ForbiddenError(`Only the '${PRODUCTION_DISPOSITION}' disposition may run against production; "${personaId}" is ${disposition}`);
+    }
+};
 /**
  * Resolves a request against the declaration and records the run.
  *
@@ -119,13 +128,9 @@ export const startVirtualUserRun = async ({ store, personas, config, environment
     const disposition = (requested ??
         persona.disposition ??
         'realistic');
-    // Every disposition other than this one exists to find out what the product
-    // does wrong, which is not a thing to do to real customers' data. Checked
-    // against the effective disposition, so an override cannot smuggle one in.
-    if (disposition !== PRODUCTION_DISPOSITION &&
-        isProductionRun(config, environments, environment)) {
-        throw new Error(`Only the '${PRODUCTION_DISPOSITION}' disposition may run against production; "${personaId}" is ${disposition}`);
-    }
+    // Checked against the effective disposition, so an override cannot smuggle
+    // one in.
+    refuseInProduction(personaId, disposition, config, environments, environment);
     // Seeded here rather than inside the engine so the record carries the seed
     // even if the run dies before returning — an unreproducible crash costs the
     // most.
@@ -237,17 +242,29 @@ export const serializeVirtualUserSchedule = (schedule, personas) => {
 /**
  * Writes a persona's cadence.
  *
- * Applies the same rule `startVirtualUserRun` enforces, at the point the row is
+ * Applies the same rules `startVirtualUserRun` enforces, at the point the row is
  * written rather than every hour afterwards: an acted-upon persona has no
- * session, so a cadence for one is a tick that can only ever fail to start.
+ * session, and an enabled cadence whose disposition production refuses, so
+ * either is a tick that can only ever fail to start, with nobody watching.
+ *
+ * The disposition checked is the one the row will hold, since a field left out
+ * keeps what it had: enabling a row saved earlier as adversarial is refused
+ * just as saving one would be.
  */
-export const writeVirtualUserSchedule = async ({ store, personas, persona, enabled, disposition, goals, budget, minIntervalMs, maxIntervalMs, nextRunAt, }) => {
+export const writeVirtualUserSchedule = async ({ store, personas, persona, enabled, disposition, goals, budget, minIntervalMs, maxIntervalMs, nextRunAt, config, environments, environment = process.env.PIKKU_ENV, }) => {
     const scheduleStore = requireVirtualUserScheduleStore(store);
-    runnablePersona(personas, persona);
+    const declared = runnablePersona(personas, persona);
+    const current = enabled === undefined || disposition === undefined
+        ? await scheduleStore.get(persona)
+        : null;
+    const created = disposition === undefined && !current ? declared.disposition : undefined;
+    if (enabled ?? current?.enabled) {
+        refuseInProduction(persona, disposition ?? current?.disposition ?? created ?? 'realistic', config, environments, environment);
+    }
     return scheduleStore.set({
         persona,
         enabled,
-        disposition: disposition,
+        disposition: (disposition ?? created),
         goals,
         budget: budget === undefined
             ? undefined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/core",
-  "version": "0.12.121",
+  "version": "0.12.122",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pikkujs/pikku.git",