mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +00:00
268f858f39
This swaps out url_format_string from all of our APIs and replaces it
with url_template. Note that the documentation changes in the following
commits will be squashed with this commit.
We change the "url_format" key to "url_template" for the
realm_linkifiers events in event_schema, along with updating
LinkifierDict. "url_template" is the name chosen to normalize
mixed usages of "url_format_string" and "url_format" throughout
the backend.
The markdown processor is updated to stop handling the format string
interpolation and delegate the task template expansion to the uri_template
library instead.
This change affects many test cases. We mostly just replace "%(name)s"
with "{name}", "url_format_string" with "url_template" to make sure that
they still pass. There are some test cases dedicated for testing "%"
escaping, which aren't relevant anymore and are subject to removal.
But for now we keep most of them as-is, and make sure that "%" is always
escaped since we do not use it for variable substitution any more.
Since url_format_string is not populated anymore, a migration is created
to remove this field entirely, and make url_template non-nullable since
we will always populate it. Note that it is possible to have
url_template being null after migration 0422 and before 0424, but
in practice, url_template will not be None after backfilling and the
backend now is always setting url_template.
With the removal of url_format_string, RealmFilter model will now be cleaned
with URL template checks, and the old checks for escapes are removed.
We also modified RealmFilter.clean to skip the validation when the
url_template is invalid. This avoids raising mulitple ValidationError's
when calling full_clean on a linkifier. But we might eventually want to
have a more centric approach to data validation instead of having
the same validation in both the clean method and the validator.
Fixes #23124.
Signed-off-by: Zixuan James Li <p359101898@gmail.com>
62 lines
1.9 KiB
JavaScript
62 lines
1.9 KiB
JavaScript
"use strict";
|
|
|
|
const {strict: assert} = require("assert");
|
|
|
|
const {zrequire} = require("./lib/namespace");
|
|
const {run_test} = require("./lib/test");
|
|
const blueslip = require("./lib/zblueslip");
|
|
|
|
const linkifiers = zrequire("linkifiers");
|
|
|
|
linkifiers.initialize([]);
|
|
|
|
function get_linkifier_regexes() {
|
|
return [...linkifiers.get_linkifier_map().keys()];
|
|
}
|
|
|
|
run_test("python_to_js_linkifier", () => {
|
|
// The only way to reach python_to_js_linkifier is indirectly, hence the call
|
|
// to update_linkifier_rules.
|
|
linkifiers.update_linkifier_rules([
|
|
{
|
|
pattern: "/a(?im)a/g",
|
|
url_template: "http://example1.example.com",
|
|
id: 10,
|
|
},
|
|
{
|
|
pattern: "/a(?L)a/g",
|
|
url_template: "http://example2.example.com",
|
|
id: 20,
|
|
},
|
|
]);
|
|
let actual_value = get_linkifier_regexes();
|
|
let expected_value = [/\/aa\/g(?!\w)/gim, /\/aa\/g(?!\w)/g];
|
|
assert.deepEqual(actual_value, expected_value);
|
|
// Test case with multiple replacements.
|
|
linkifiers.update_linkifier_rules([
|
|
{
|
|
pattern: "#cf(?P<contest>\\d+)(?P<problem>[A-Z][\\dA-Z]*)",
|
|
url_template: "http://example3.example.com",
|
|
id: 30,
|
|
},
|
|
]);
|
|
actual_value = get_linkifier_regexes();
|
|
expected_value = [/#cf(\d+)([A-Z][\dA-Z]*)(?!\w)/g];
|
|
assert.deepEqual(actual_value, expected_value);
|
|
// Test incorrect syntax.
|
|
blueslip.expect(
|
|
"error",
|
|
"python_to_js_linkifier: Invalid regular expression: /!@#@(!#&((!&(@#((?!\\w)/: Unterminated group",
|
|
);
|
|
linkifiers.update_linkifier_rules([
|
|
{
|
|
pattern: "!@#@(!#&((!&(@#(",
|
|
url_template: "http://example4.example.com",
|
|
id: 40,
|
|
},
|
|
]);
|
|
actual_value = get_linkifier_regexes();
|
|
expected_value = [];
|
|
assert.deepEqual(actual_value, expected_value);
|
|
});
|