ravensight-playtest 0.3.0 → 0.3.2

package/src/run/noise.js

@@ -0,0 +1,102 @@
+/**
+ * Console noise a developer expects, which is never a finding.
+ *
+ * Two sources: the built in rule (a 401 on a who am I check is what a
+ * signed out page does when it asks "who am I?"; the Snowball round filed it
+ * as a bug), and the brief's own `expected_noise` patterns, which live in the
+ * local brief (see ../briefLocal.js).
+ *
+ * A pattern is matched against an automatic console note:
+ *
+ * - `/.../` is a case insensitive regular expression over the note's text and URL;
+ * - otherwise any status codes (`401`) and paths (`/auth/me`) in it must all
+ *   appear in the note (its status, URL or text), and the other words are a
+ *   description for the reader, such as "before login";
+ * - a pattern with neither is a case insensitive substring of the note's text.
+ */
+
+/** The built in rule, as the prompt and the README state it. */
+export const BUILT_IN_NOISE = 'a 401 on a who am I check, a request whose last path segment is /me, /whoami, /session or /current_user such as /auth/me, while signed out is not a finding';
+
+/**
+ * A request whose final path segment asks who the visitor is: `/auth/me`,
+ * `/me`, `/whoami`, `/session`, `/current_user`. Only the last segment counts,
+ * so `/me/inventory`, `/user/42/save`, `/account/purchase`, `/token` and
+ * `/login` are never this rule's: a 401 there can be a real failure.
+ */
+const AUTH_CHECK = /\/(?:me|whoami|session|current[_-]?user)\/?(?=$|[?#\s)'",])/i;
+
+/**
+ * @param {Object} note
+ * @returns {string}
+ */
+function haystack(note) {
+  return `${note && note.text ? note.text : ''} ${note && note.url ? note.url : ''}`;
+}
+
+/**
+ * Whether a note is the built in case: a 401 on a who am I check.
+ *
+ * @param {Object} note
+ * @returns {boolean}
+ */
+export function isAuthCheck401(note) {
+  if (!note) return false;
+  const is401 = note.status === 401 || /\b401\b/.test(String(note.text || ''));
+  return is401 && AUTH_CHECK.test(haystack(note));
+}
+
+/**
+ * Whether one pattern matches a note.
+ *
+ * @param {Object} note
+ * @param {string} pattern
+ * @returns {boolean}
+ */
+export function matchesPattern(note, pattern) {
+  const value = String(pattern == null ? '' : pattern).trim();
+  if (!value || !note) return false;
+  const text = haystack(note);
+  const regex = value.match(/^\/(.+)\/([a-z]*)$/);
+  if (regex) {
+    try {
+      return new RegExp(regex[1], regex[2].includes('i') ? regex[2] : `${regex[2]}i`).test(text);
+    } catch {
+      return false;
+    }
+  }
+  const statuses = value.match(/\b[1-5]\d\d\b/g) || [];
+  const paths = (value.match(/(?:^|\s)(\/[^\s]*)/g) || []).map(entry => entry.trim().toLowerCase());
+  if (statuses.length === 0 && paths.length === 0) return text.toLowerCase().includes(value.toLowerCase());
+  const lower = text.toLowerCase();
+  return statuses.every(code => note.status === Number(code) || new RegExp(`\\b${code}\\b`).test(text))
+    && paths.every(entry => lower.includes(entry));
+}
+
+/**
+ * Whether an automatic note is expected noise. A persona's own note never is:
+ * if the persona saw the game break, that is a finding whatever the console said.
+ *
+ * @param {Object} note
+ * @param {Array<string>} [patterns] the brief's expected_noise
+ * @returns {boolean}
+ */
+export function isExpectedNoise(note, patterns = []) {
+  if (!note || !note.automatic) return false;
+  if (isAuthCheck401(note)) return true;
+  return (Array.isArray(patterns) ? patterns : []).some(pattern => matchesPattern(note, pattern));
+}
+
+/**
+ * The expected noise block of the persona prompt.
+ *
+ * @param {Array<string>} [patterns]
+ * @returns {string}
+ */
+export function expectedNoiseForPrompt(patterns = []) {
+  const lines = [`- built in: ${BUILT_IN_NOISE}`];
+  for (const pattern of Array.isArray(patterns) ? patterns : []) if (typeof pattern === 'string' && pattern.trim()) lines.push(`- ${pattern.trim()}`);
+  return lines.join('\n');
+}
+
+export default { isExpectedNoise, isAuthCheck401, matchesPattern, expectedNoiseForPrompt, BUILT_IN_NOISE };