paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-06 15:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

linkifier: Support URL templates for linkifiers.

Browse Source 
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>
This commit is contained in:
Zixuan James Li
2022-10-05 14:55:31 -04:00
committed by Tim Abbott
parent ab53e8d3e6
commit 268f858f39
41 changed files with 533 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
web/src/settings_linkifiers.js
View File

@@ -42,7 +42,7 @@ function sort_pattern(a, b) {
}
function sort_url(a, b) {
return compare_values(a.url_format, b.url_format);
return compare_values(a.url_template, b.url_template);
}
function open_linkifier_edit_form(linkifier_id) {
@@ -51,7 +51,7 @@ function open_linkifier_edit_form(linkifier_id) {
const html_body = render_admin_linkifier_edit_form({
linkifier_id,
pattern: linkifier.pattern,
url_format_string: linkifier.url_format,
url_format_string: linkifier.url_template,
});
function submit_linkifier_form() {
@@ -118,8 +118,8 @@ function handle_linkifier_api_error(xhr, pattern_status, format_status, linkifie
xhr.responseText = JSON.stringify({msg: errors.pattern});
ui_report.error($t_html({defaultMessage: "Failed"}), xhr, pattern_status);
}
if (errors.url_format_string !== undefined) {
xhr.responseText = JSON.stringify({msg: errors.url_format_string});
if (errors.url_template !== undefined) {
xhr.responseText = JSON.stringify({msg: errors.url_template});
ui_report.error($t_html({defaultMessage: "Failed"}), xhr, format_status);
}
if (errors.__all__ !== undefined) {
@@ -140,7 +140,7 @@ export function populate_linkifiers(linkifiers_data) {
return render_admin_linkifier_list({
linkifier: {
pattern: linkifier.pattern,
url_format_string: linkifier.url_format,
url_format_string: linkifier.url_template,
id: linkifier.id,
},
can_modify: page_params.is_admin,
@@ -151,7 +151,7 @@ export function populate_linkifiers(linkifiers_data) {
predicate(item, value) {
return (
item.pattern.toLowerCase().includes(value) ||
item.url_format.toLowerCase().includes(value)
item.url_template.toLowerCase().includes(value)
);
},
onupdate() {