ProdDash/modules/overflow-tap/keywords.selftest.js

'use strict';

/**
 * Self-test for keywords.js — the matching rules, pinned.
 *
 *   node modules/overflow-tap/keywords.selftest.js
 */

const assert = require('node:assert/strict');
const { keywordMatches, matchKeywords, sameSet, cleanNotes } = require('./keywords');

let n = 0;
function test(name, fn) {
  n += 1;
  try {
    fn();
    console.log(`ok   ${name}`);
  } catch (err) {
    console.log(`FAIL ${name}\n     ${err.message}`);
    process.exitCode = 1;
  }
}

test('a keyword fires as a word of the notes, whatever the case', () => {
  assert.equal(keywordMatches('give', 'give'), true);
  assert.equal(keywordMatches('Give', 'give'), true);
  assert.equal(keywordMatches('please GIVE today', 'give'), true);
});

test('surrounding punctuation is ignored, as the helper strips it', () => {
  assert.equal(keywordMatches('give!', 'give'), true);
  assert.equal(keywordMatches('#give now', 'give'), true);
  assert.equal(keywordMatches('go to (give) now', 'give'), true);
  assert.equal(keywordMatches('"give"', 'give'), true);
  assert.equal(keywordMatches('give.', 'give'), true);
});

test('a keyword inside another word does not fire', () => {
  assert.equal(keywordMatches('a sermon on forgiveness', 'give'), false);
  assert.equal(keywordMatches('giveaway', 'give'), false);
  assert.equal(keywordMatches('give_now', 'give'), false);
});

test('a phrase keyword is bounded the same way', () => {
  assert.equal(keywordMatches('Please fill out your Next   Steps card', 'next steps'), true);
  assert.equal(keywordMatches('nextsteps', 'next steps'), false);
});

test('regex characters in a keyword are literal', () => {
  assert.equal(keywordMatches('give.now', 'give.now'), true);
  assert.equal(keywordMatches('giveXnow', 'give.now'), false);
});

test('empty notes never match; zero-width padding is ignored', () => {
  assert.equal(keywordMatches('', 'give'), false);
  assert.equal(keywordMatches('​', 'give'), false);
  assert.equal(cleanNotes('​give'), 'give');
  assert.equal(keywordMatches('​give', 'give'), true);
});

test('matchKeywords returns every hit, in list order, once each', () => {
  const list = ['connect', 'give', 'prayer', { keyword: 'Events' }];
  assert.deepEqual(matchKeywords('give and connect, then events', list), ['connect', 'give', 'Events']);
  assert.deepEqual(matchKeywords('just worship', list), []);
  assert.deepEqual(matchKeywords('give', []), []);
  assert.deepEqual(matchKeywords('give give', ['give', 'GIVE']), ['give']);
});

test('sameSet compares keyword lists regardless of order and case', () => {
  assert.equal(sameSet(['give', 'connect'], ['Connect', 'give']), true);
  assert.equal(sameSet(['give'], ['give', 'connect']), false);
  assert.equal(sameSet([], []), true);
  assert.equal(sameSet(['give'], []), false);
});

console.log(`${n} tests, exit ${process.exitCode || 0}`);