Avoid backtracking in issue spam checks

Copilot-Session: 38cc48ab-6686-41b4-b35e-459fb890f924

Author: Copilot

.github/scripts/test_check_for_spammy_issues.js

@@ -0,0 +1,129 @@
+const assert = require('node:assert/strict');
+const { readFileSync } = require('node:fs');
+const path = require('node:path');
+const { spawnSync } = require('node:child_process');
+const test = require('node:test');
+
+const workflow = readFileSync(
+  path.join(__dirname, '../workflows/check-for-spammy-issues.yml'),
+  'utf8',
+);
+const script = workflow.split('          script: |\n')[1];
+assert.ok(script, 'The workflow must include its github-script body');
+
+const harness = `
+  const { readFileSync } = require('node:fs');
+  const input = JSON.parse(readFileSync(0, 'utf8'));
+  const calls = [];
+  const context = {
+    payload: {
+      issue: { number: 42, title: input.title, body: input.body },
+      sender: { login: 'reporter' },
+    },
+  };
+  const github = {
+    teams: {
+      async getMembershipForUserInOrg() {
+        if (!input.employee) throw new Error('Not a team member');
+      },
+    },
+    issues: {
+      async update(params) { calls.push({ method: 'update', params }); },
+      async createComment(params) { calls.push({ method: 'createComment', params }); },
+    },
+  };
+  const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
+  new AsyncFunction('github', 'context', input.script)(github, context)
+    .then(() => process.stdout.write(JSON.stringify(calls)))
+    .catch(error => {
+      console.error(error);
+      process.exitCode = 1;
+    });
+`;
+
+function runWorkflow(body, { title = 'Too short', employee = false } = {}) {
+  const result = spawnSync(process.execPath, ['-e', harness], {
+    input: JSON.stringify({ script, body, title, employee }),
+    encoding: 'utf8',
+    timeout: 2000,
+  });
+  assert.ifError(result.error);
+  assert.equal(result.status, 0, result.stderr);
+  return JSON.parse(result.stdout);
+}
+
+function assertClosed(body, options) {
+  const calls = runWorkflow(body, options);
+  assert.deepEqual(calls.map(call => call.method), ['update', 'createComment']);
+  assert.deepEqual(calls[0].params, {
+    owner: 'github',
+    repo: 'rest-api-description',
+    issue_number: 42,
+    labels: ['invalid'],
+    state: 'closed',
+  });
+  assert.equal(calls[1].params.issue_number, 42);
+}
+
+test('closes issues with short titles and bodies', () => {
+  assertClosed('Not enough detail');
+});
+
+test('accepts a descriptive title', () => {
+  assert.deepEqual(runWorkflow('', { title: 'A descriptive issue title' }), []);
+});
+
+test('accepts a descriptive body', () => {
+  assert.deepEqual(runWorkflow('This issue contains enough words to explain the problem'), []);
+});
+
+test('does not count template comments or indented headings as body words', () => {
+  assertClosed('<!--- These template words should not count -->\n  # This heading should not count either\nToo short');
+});
+
+test('preserves descriptive text between headings', () => {
+  assert.deepEqual(
+    runWorkflow('# First heading\nThis issue contains enough words to explain the problem\n## Next heading\n'),
+    [],
+  );
+});
+
+test('ignores a heading without a trailing newline', () => {
+  assertClosed('# These heading words alone should not keep an issue open');
+});
+
+test('handles CRLF headings and body text', () => {
+  assertClosed(' \t## These heading words should not count\r\nToo short\r\n');
+  assert.deepEqual(
+    runWorkflow('# Heading\r\nThis issue contains enough words to explain the problem\r\n'),
+    [],
+  );
+});
+
+test('keeps hash characters that are not at the start of a line', () => {
+  assert.deepEqual(runWorkflow('This body refers to #123 and explains the problem'), []);
+});
+
+test('handles empty, null, and missing bodies', () => {
+  for (const body of ['', null, undefined]) {
+    assertClosed(body);
+  }
+});
+
+test('leaves employee issues open', () => {
+  assert.deepEqual(runWorkflow(null, { employee: true }), []);
+});
+
+test('still rejects the unchanged schema template title', () => {
+  assertClosed('This issue contains enough words to explain the problem', {
+    title: '[Schema Inaccuracy] <Describe Problem>',
+  });
+});
+
+test('handles a maximum-length heading followed by whitespace within two seconds', () => {
+  assertClosed('#' + ' '.repeat(65535));
+});
+
+test('handles maximum-length whitespace before a heading within two seconds', () => {
+  assertClosed(' '.repeat(65534) + '#x');
+});

.github/workflows/check-for-spammy-issues.yml

@@ -31,8 +31,11 @@ jobs:
             }
             const titleWordCountMin = 3
 
-            let body = issue.body.replace(/<\!---.*?-->/g, "");
-            body = body.replace(/^\s*(#)\s*(.+?)\s*\n/gm, "");
+            let body = (issue.body ?? '').replace(/<\!---.*?-->/g, "");
+            body = body
+              .split('\n')
+              .filter(line => !line.trimStart().startsWith('#'))
+              .join('\n');
 
             let bodyWordCount = 0
             if (body) {

.github/workflows/scripts-tests.yml

@@ -8,10 +8,12 @@ on:
     paths:
       - '.github/scripts/**'
       - '.github/workflows/scripts-tests.yml'
+      - '.github/workflows/check-for-spammy-issues.yml'
   pull_request:
     paths:
       - '.github/scripts/**'
       - '.github/workflows/scripts-tests.yml'
+      - '.github/workflows/check-for-spammy-issues.yml'
   workflow_dispatch:
 
 jobs:
@@ -27,3 +29,9 @@ jobs:
           python-version: '3.12'
       - run: python3 -m unittest discover --start-directory .github/scripts --verbose
         name: Run script tests
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        name: Install NodeJS
+        with:
+          node-version: '22'
+      - run: node --test .github/scripts/test_*.js
+        name: Run JavaScript script tests

CONTRIBUTING.md

@@ -38,6 +38,15 @@ This workflow is defined in `.github/workflows/linter-failure-notifier.yml`.
 0. Push to your fork and [submit a pull request][pr]
 0. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
+## Workflow script tests
+
+Run the workflow script tests with Python 3 and Node.js 22:
+
+```sh
+python3 -m unittest discover --start-directory .github/scripts --verbose
+node --test .github/scripts/test_*.js
+```
+
 ## Resources
 
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)