This repository has been archived on 2023-03-18. You can view files and clone it, but cannot push or open issues or pull requests.
osr-discourse-src/app/assets/javascripts/discourse/tests/acceptance/admin-watched-words-test.js
Selase Krakani 862007fb18
FEATURE: Add support for case-sensitive Watched Words (#17445)
* FEATURE: Add case-sensitivity flag to watched_words

Currently, all watched words are matched case-insensitively. This flag
allows a watched word to be flagged for case-sensitive matching.
To allow allow for backwards compatibility the flag is set to false by
default.

* FEATURE: Support case-sensitive creation of Watched Words via API

Extend admin creation and upload of Watched Words to support case
sensitive flag. This lays the ground work for supporting
case-insensitive matching of Watched Words.

Support for an extra column has also been introduced for the Watched
Words upload CSV file. The new column structure is as follows:

 word,replacement,case_sentive

* FEATURE: Enable case-sensitive matching of Watched Words

WordWatcher's word_matcher_regexp now returns a list of regular
expressions instead of one case-insensitive regular expression.

With the ability to flag a Watched Word as case-sensitive, an action
can have words of both sensitivities.This makes the use of the global
Regexp::IGNORECASE flag added to all words problematic.

To get around platform limitations around the use of subexpression level
switches/flags, a list of regular expressions is returned instead, one for each
case sensitivity.

Word matching has also been updated to use this list of regular expressions
instead of one.

* FEATURE: Use case-sensitive regular expressions for Watched Words

Update Watched Words regular expressions matching and processing to handle
the extra metadata which comes along with the introduction of
case-sensitive Watched Words.

This allows case-sensitive Watched Words to matched as such.

* DEV: Simplify type casting of case-sensitive flag from uploads

Use builtin semantics instead of a custom method for converting
string case flags in uploaded Watched Words to boolean.

* UX: Add case-sensitivity details to Admin Watched Words UI

Update Watched Word form to include a toggle for case-sensitivity.
This also adds support for, case-sensitive testing and matching of  Watched Word
in the admin UI.

* DEV: Code improvements from review feedback

 - Extract watched word regex creation out to a utility function
 - Make JS array presence check more explicit and readable

* DEV: Extract Watched Word regex creation to utility function

Clean-up work from review feedback. Reduce code duplication.

* DEV: Rename word_matcher_regexp to word_matcher_regexp_list

Since a list is returned now instead of a single regular expression,
change `word_matcher_regexp` to `word_matcher_regexp_list` to better communicate
this change.

* DEV:  Incorporate WordWatcher updates from upstream

Resolve conflicts and ensure apply_to_text does not remove non-word characters in matches
that aren't at the beginning of the line.
2022-08-02 10:06:03 +02:00

155 lines
4.5 KiB
JavaScript

import {
acceptance,
count,
exists,
query,
queryAll,
} from "discourse/tests/helpers/qunit-helpers";
import { click, fillIn, visit } from "@ember/test-helpers";
import { test } from "qunit";
import I18n from "I18n";
acceptance("Admin - Watched Words", function (needs) {
needs.user();
test("list words in groups", async function (assert) {
await visit("/admin/customize/watched_words/action/block");
assert.ok(!exists(".admin-watched-words .alert-error"));
assert.ok(
!exists(".watched-words-list"),
"Don't show bad words by default."
);
assert.ok(
!exists(".watched-words-list .watched-word"),
"Don't show bad words by default."
);
await fillIn(".admin-controls .controls input[type=text]", "li");
assert.strictEqual(
count(".watched-words-list .watched-word"),
1,
"When filtering, show words even if checkbox is unchecked."
);
await fillIn(".admin-controls .controls input[type=text]", "");
assert.ok(
!exists(".watched-words-list .watched-word"),
"Clearing the filter hides words again."
);
await click(".show-words-checkbox");
assert.ok(
exists(".watched-words-list .watched-word"),
"Always show the words when checkbox is checked."
);
await click(".nav-stacked .censor a");
assert.ok(exists(".watched-words-list"));
assert.ok(!exists(".watched-words-list .watched-word"), "Empty word list.");
});
test("add words", async function (assert) {
await visit("/admin/customize/watched_words/action/block");
click(".show-words-checkbox");
fillIn(".watched-word-form input", "poutine");
await click(".watched-word-form button");
let found = [];
[...queryAll(".watched-words-list .watched-word")].forEach((elem) => {
if (elem.innerText.trim() === "poutine") {
found.push(true);
}
});
assert.strictEqual(found.length, 1);
assert.strictEqual(count(".watched-words-list .case-sensitive"), 0);
});
test("add case-sensitve words", async function (assert) {
await visit("/admin/customize/watched_words/action/block");
click(".show-words-checkbox");
fillIn(".watched-word-form input", "Discourse");
click(".case-sensitivity-checkbox");
await click(".watched-word-form button");
assert
.dom(".watched-words-list .watched-word")
.hasText(`Discourse ${I18n.t("admin.watched_words.case_sensitive")}`);
});
test("remove words", async function (assert) {
await visit("/admin/customize/watched_words/action/block");
await click(".show-words-checkbox");
let wordId = null;
[...queryAll(".watched-words-list .watched-word")].forEach((elem) => {
if (elem.innerText.trim() === "anise") {
wordId = elem.getAttribute("id");
}
});
await click(`#${wordId} .delete-word-record`);
assert.strictEqual(count(".watched-words-list .watched-word"), 2);
});
test("test modal - replace", async function (assert) {
await visit("/admin/customize/watched_words/action/replace");
await click(".watched-word-test");
await fillIn(".modal-body textarea", "Hi there!");
assert.strictEqual(query(".modal-body li .match").innerText, "Hi");
assert.strictEqual(query(".modal-body li .replacement").innerText, "hello");
});
test("test modal - tag", async function (assert) {
await visit("/admin/customize/watched_words/action/tag");
await click(".watched-word-test");
await fillIn(".modal-body textarea", "Hello world!");
assert.strictEqual(query(".modal-body li .match").innerText, "Hello");
assert.strictEqual(query(".modal-body li .tag").innerText, "greeting");
});
});
acceptance("Admin - Watched Words - Bad regular expressions", function (needs) {
needs.user();
needs.pretender((server, helper) => {
server.get("/admin/customize/watched_words.json", () => {
return helper.response({
actions: ["block", "censor", "require_approval", "flag", "replace"],
words: [
{
id: 1,
word: "[.*",
regexp: "[.*",
action: "block",
},
],
compiled_regular_expressions: {
block: null,
censor: null,
require_approval: null,
flag: null,
replace: null,
},
});
});
});
test("shows an error message if regex is invalid", async function (assert) {
await visit("/admin/customize/watched_words/action/block");
assert.strictEqual(count(".admin-watched-words .alert-error"), 1);
});
});