paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 22:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

hash_util: Rename _uri functions to _url.

Browse Source 
It's 2022 and the WHATWG no longer recognizes the term URI. Everything
is now a URL or a type of URL. Which is great because it's way less
confusing. Details here:
https://url.spec.whatwg.org/
This commit is contained in:
Austin Riba
2022-03-01 10:14:26 -08:00
committed by Tim Abbott
parent b39d47995d
commit b22578f975
27 changed files with 59 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
frontend_tests/node_tests/compose_actions.js
View File

@@ -350,7 +350,7 @@ test("quote_and_reply", ({override, override_rewire}) => {
sender_full_name: "Steve Stephenson", sender_full_name: "Steve Stephenson",
sender_id: 90, sender_id: 90,
}; };
hash_util.by_conversation_and_time_uri = () => hash_util.by_conversation_and_time_url = () =>
"https://chat.zulip.org/#narrow/stream/92-learning/topic/Tornado"; "https://chat.zulip.org/#narrow/stream/92-learning/topic/Tornado";
let success_function; let success_function;

2
frontend_tests/node_tests/compose_ui.js
View File

@@ -265,7 +265,7 @@ run_test("quote_and_reply", ({override, override_rewire}) => {
override( override(
hash_util, hash_util,
"by_conversation_and_time_uri", "by_conversation_and_time_url",
() => "https://chat.zulip.org/#narrow/stream/92-learning/topic/Tornado", () => "https://chat.zulip.org/#narrow/stream/92-learning/topic/Tornado",
); );

10
frontend_tests/node_tests/hash_util.js
View File

@@ -129,15 +129,15 @@ run_test("test_parse_narrow", () => {
]); ]);
}); });
run_test("test_stream_edit_uri", () => { run_test("test_stream_edit_url", () => {
const sub = { const sub = {
name: "research & development", name: "research & development",
stream_id: 42, stream_id: 42,
}; };
assert.equal(hash_util.stream_edit_uri(sub), "#streams/42/research.20.26.20development"); assert.equal(hash_util.stream_edit_url(sub), "#streams/42/research.20.26.20development");
}); });
run_test("test_by_conversation_and_time_uri", () => { run_test("test_by_conversation_and_time_url", () => {
let message = { let message = {
type: "stream", type: "stream",
stream_id: frontend.stream_id, stream_id: frontend.stream_id,
@@ -146,7 +146,7 @@ run_test("test_by_conversation_and_time_uri", () => {
}; };
assert.equal( assert.equal(
hash_util.by_conversation_and_time_uri(message), hash_util.by_conversation_and_time_url(message),
"http://zulip.zulipdev.com/#narrow/stream/99-frontend/topic/testing/near/42", "http://zulip.zulipdev.com/#narrow/stream/99-frontend/topic/testing/near/42",
); );
@@ -161,7 +161,7 @@ run_test("test_by_conversation_and_time_uri", () => {
}; };
assert.equal( assert.equal(
hash_util.by_conversation_and_time_uri(message), hash_util.by_conversation_and_time_url(message),
"http://zulip.zulipdev.com/#narrow/pm-with/15-pm/near/43", "http://zulip.zulipdev.com/#narrow/pm-with/15-pm/near/43",
); );
}); });

8
frontend_tests/node_tests/internal_url.js
View File

@@ -39,14 +39,14 @@ run_test("test encode_stream_id", () => {
assert.equal(result, "123-stream-.28with-brackets.29"); assert.equal(result, "123-stream-.28with-brackets.29");
}); });
run_test("test by_stream_uri", () => { run_test("test by_stream_url", () => {
const maybe_get_stream_name = () => "a test stream"; const maybe_get_stream_name = () => "a test stream";
const result = internal_url.by_stream_uri(123, maybe_get_stream_name); const result = internal_url.by_stream_url(123, maybe_get_stream_name);
assert.equal(result, "#narrow/stream/123-a-test-stream"); assert.equal(result, "#narrow/stream/123-a-test-stream");
}); });
run_test("test by_stream_topic_uri", () => { run_test("test by_stream_topic_url", () => {
const maybe_get_stream_name = () => "a test stream"; const maybe_get_stream_name = () => "a test stream";
const result = internal_url.by_stream_topic_uri(123, "test topic", maybe_get_stream_name); const result = internal_url.by_stream_topic_url(123, "test topic", maybe_get_stream_name);
assert.equal(result, "#narrow/stream/123-a-test-stream/topic/test.20topic"); assert.equal(result, "#narrow/stream/123-a-test-stream/topic/test.20topic");
}); });

12
frontend_tests/node_tests/narrow.js
View File

@@ -171,14 +171,14 @@ run_test("uris", () => {
people.add_active_user(me); people.add_active_user(me);
people.initialize_current_user(me.user_id); people.initialize_current_user(me.user_id);
let uri = hash_util.pm_with_uri(ray.email); let url = hash_util.pm_with_url(ray.email);
assert.equal(uri, "#narrow/pm-with/22-ray"); assert.equal(url, "#narrow/pm-with/22-ray");
uri = hash_util.huddle_with_uri("22,23"); url = hash_util.huddle_with_url("22,23");
assert.equal(uri, "#narrow/pm-with/22,23-group"); assert.equal(url, "#narrow/pm-with/22,23-group");
uri = hash_util.by_sender_uri(ray.email); url = hash_util.by_sender_url(ray.email);
assert.equal(uri, "#narrow/sender/22-ray"); assert.equal(url, "#narrow/sender/22-ray");
let emails = hash_util.decode_operand("pm-with", "22,23-group"); let emails = hash_util.decode_operand("pm-with", "22,23-group");
assert.equal(emails, "alice@example.com,ray@example.com"); assert.equal(emails, "alice@example.com,ray@example.com");

2
frontend_tests/node_tests/popovers.js
View File

@@ -182,7 +182,7 @@ test_ui("sender_hover", ({override, mock_template}) => {
user_circle_class: "user_circle_empty", user_circle_class: "user_circle_empty",
user_last_seen_time_status: user_last_seen_time_status:
"translated: Last active: translated: More than 2 weeks ago", "translated: Last active: translated: More than 2 weeks ago",
pm_with_uri: "#narrow/pm-with/42-alice", pm_with_url: "#narrow/pm-with/42-alice",
sent_by_uri: "#narrow/sender/42-alice", sent_by_uri: "#narrow/sender/42-alice",
private_message_class: "respond_personal_button", private_message_class: "respond_personal_button",
show_email: false, show_email: false,

4
frontend_tests/node_tests/recent_topics.js
View File

@@ -76,9 +76,9 @@ mock_esm("../../static/js/compose_closed_ui", {
update_buttons_for_recent_topics: noop, update_buttons_for_recent_topics: noop,
}); });
mock_esm("../../static/js/hash_util", { mock_esm("../../static/js/hash_util", {
by_stream_uri: () => "https://www.example.com", by_stream_url: () => "https://www.example.com",
by_stream_topic_uri: () => "https://www.example.com", by_stream_topic_url: () => "https://www.example.com",
}); });
mock_esm("../../static/js/message_list_data", { mock_esm("../../static/js/message_list_data", {
MessageListData: class {}, MessageListData: class {},

2
frontend_tests/node_tests/stream_settings_ui.js
View File

@@ -14,7 +14,7 @@ const ui = mock_esm("../../static/js/ui", {
}); });
mock_esm("../../static/js/hash_util", { mock_esm("../../static/js/hash_util", {
by_stream_uri: () => {}, by_stream_url: () => {},
get_current_hash_section: () => denmark_stream_id, get_current_hash_section: () => denmark_stream_id,
}); });

2
static/js/buddy_data.js
View File

@@ -181,7 +181,7 @@ export function info_for(user_id) {
const user_circle_status = status_description(user_id); const user_circle_status = status_description(user_id);
return { return {
href: hash_util.pm_with_uri(person.email), href: hash_util.pm_with_url(person.email),
name: person.full_name, name: person.full_name,
user_id, user_id,
my_user_status, my_user_status,

2
static/js/click_handlers.js
View File

@@ -244,7 +244,7 @@ export function initialize() {
// so we re-encode the hash. // so we re-encode the hash.
const stream_id = Number.parseInt($(this).attr("data-stream-id"), 10); const stream_id = Number.parseInt($(this).attr("data-stream-id"), 10);
if (stream_id) { if (stream_id) {
browser_history.go_to_location(hash_util.by_stream_uri(stream_id)); browser_history.go_to_location(hash_util.by_stream_url(stream_id));
return; return;
} }
window.location.href = $(this).attr("href"); window.location.href = $(this).attr("href");

2
static/js/compose_actions.js
View File

@@ -507,7 +507,7 @@ export function quote_and_reply(opts) {
{defaultMessage: "{username} [said]({link_to_message}):"}, {defaultMessage: "{username} [said]({link_to_message}):"},
{ {
username: `@_**${message.sender_full_name}|${message.sender_id}**`, username: `@_**${message.sender_full_name}|${message.sender_id}**`,
link_to_message: `${hash_util.by_conversation_and_time_uri(message)}`, link_to_message: `${hash_util.by_conversation_and_time_url(message)}`,
}, },
); );
content += "\n"; content += "\n";

24
static/js/hash_util.js
View File

@@ -76,14 +76,14 @@ export function decode_operand(operator, operand) {
return operand; return operand;
} }
export function by_stream_uri(stream_id) { export function by_stream_url(stream_id) {
// Wrapper for web use of internal_url.by_stream_uri // Wrapper for web use of internal_url.by_stream_url
return internal_url.by_stream_uri(stream_id, stream_data.maybe_get_stream_name); return internal_url.by_stream_url(stream_id, stream_data.maybe_get_stream_name);
} }
export function by_stream_topic_uri(stream_id, topic) { export function by_stream_topic_url(stream_id, topic) {
// Wrapper for web use of internal_url.by_stream_topic_uri // Wrapper for web use of internal_url.by_stream_topic_url
return internal_url.by_stream_topic_uri(stream_id, topic, stream_data.maybe_get_stream_name); return internal_url.by_stream_topic_url(stream_id, topic, stream_data.maybe_get_stream_name);
} }
// Encodes an operator list into the // Encodes an operator list into the
@@ -113,16 +113,16 @@ export function operators_to_hash(operators) {
return hash; return hash;
} }
export function by_sender_uri(reply_to) { export function by_sender_url(reply_to) {
return operators_to_hash([{operator: "sender", operand: reply_to}]); return operators_to_hash([{operator: "sender", operand: reply_to}]);
} }
export function pm_with_uri(reply_to) { export function pm_with_url(reply_to) {
const slug = people.emails_to_slug(reply_to); const slug = people.emails_to_slug(reply_to);
return "#narrow/pm-with/" + slug; return "#narrow/pm-with/" + slug;
} }
export function huddle_with_uri(user_ids_string) { export function huddle_with_url(user_ids_string) {
// This method is convenient for callers // This method is convenient for callers
// that have already converted emails to a comma-delimited // that have already converted emails to a comma-delimited
// list of user_ids. We should be careful to keep this // list of user_ids. We should be careful to keep this
@@ -130,7 +130,7 @@ export function huddle_with_uri(user_ids_string) {
return "#narrow/pm-with/" + user_ids_string + "-group"; return "#narrow/pm-with/" + user_ids_string + "-group";
} }
export function by_conversation_and_time_uri(message) { export function by_conversation_and_time_url(message) {
const absolute_url = const absolute_url =
window.location.protocol + window.location.protocol +
"//" + "//" +
@@ -141,13 +141,13 @@ export function by_conversation_and_time_uri(message) {
const suffix = "/near/" + internal_url.encodeHashComponent(message.id); const suffix = "/near/" + internal_url.encodeHashComponent(message.id);
if (message.type === "stream") { if (message.type === "stream") {
return absolute_url + by_stream_topic_uri(message.stream_id, message.topic) + suffix; return absolute_url + by_stream_topic_url(message.stream_id, message.topic) + suffix;
} }
return absolute_url + people.pm_perma_link(message) + suffix; return absolute_url + people.pm_perma_link(message) + suffix;
} }
export function stream_edit_uri(sub) { export function stream_edit_url(sub) {
const hash = `#streams/${sub.stream_id}/${internal_url.encodeHashComponent(sub.name)}`; const hash = `#streams/${sub.stream_id}/${internal_url.encodeHashComponent(sub.name)}`;
return hash; return hash;
} }

4
static/js/markdown_config.js
View File

@@ -40,8 +40,8 @@ export const get_helpers = () => ({
// stream hashes // stream hashes
get_stream_by_name: stream_data.get_sub, get_stream_by_name: stream_data.get_sub,
stream_hash: hash_util.by_stream_uri, stream_hash: hash_util.by_stream_url,
stream_topic_hash: hash_util.by_stream_topic_uri, stream_topic_hash: hash_util.by_stream_topic_url,
// settings // settings
should_translate_emoticons: () => user_settings.translate_emoticons, should_translate_emoticons: () => user_settings.translate_emoticons,

6
static/js/message_list_view.js
View File

@@ -399,10 +399,10 @@ export class MessageListView {
} }
if (message_container.msg.stream) { if (message_container.msg.stream) {
message_container.stream_url = hash_util.by_stream_uri( message_container.stream_url = hash_util.by_stream_url(
message_container.msg.stream_id, message_container.msg.stream_id,
); );
message_container.topic_url = hash_util.by_stream_topic_uri( message_container.topic_url = hash_util.by_stream_topic_url(
message_container.msg.stream_id, message_container.msg.stream_id,
message_container.msg.topic, message_container.msg.topic,
); );
@@ -672,7 +672,7 @@ export class MessageListView {
message.starred_status = $t({defaultMessage: "Star"}); message.starred_status = $t({defaultMessage: "Star"});
} }
message.url = hash_util.by_conversation_and_time_uri(message); message.url = hash_util.by_conversation_and_time_url(message);
return {msg: message}; return {msg: message};
}); });

2
static/js/notifications.js
View File

@@ -652,7 +652,7 @@ export function notify_local_mixes(messages, need_user_to_scroll) {
function get_above_composebox_narrow_url(message) { function get_above_composebox_narrow_url(message) {
let above_composebox_narrow_url; let above_composebox_narrow_url;
if (message.type === "stream") { if (message.type === "stream") {
above_composebox_narrow_url = hash_util.by_stream_topic_uri( above_composebox_narrow_url = hash_util.by_stream_topic_url(
message.stream_id, message.stream_id,
message.topic, message.topic,
); );

2
static/js/pm_list.js
View File

@@ -97,7 +97,7 @@ export function _get_convos() {
unread: num_unread, unread: num_unread,
is_zero: num_unread === 0, is_zero: num_unread === 0,
is_active, is_active,
url: hash_util.pm_with_uri(reply_to), url: hash_util.pm_with_url(reply_to),
status_emoji_info, status_emoji_info,
user_circle_class, user_circle_class,
is_group, is_group,

6
static/js/popovers.js
View File

@@ -225,10 +225,10 @@ function render_user_info_popover(
is_bot: user.is_bot, is_bot: user.is_bot,
is_me, is_me,
is_sender_popover, is_sender_popover,
pm_with_uri: hash_util.pm_with_uri(user.email), pm_with_url: hash_util.pm_with_url(user.email),
user_circle_class: buddy_data.get_user_circle_class(user.user_id), user_circle_class: buddy_data.get_user_circle_class(user.user_id),
private_message_class: private_msg_class, private_message_class: private_msg_class,
sent_by_uri: hash_util.by_sender_uri(user.email), sent_by_uri: hash_util.by_sender_url(user.email),
show_email: settings_data.show_email(), show_email: settings_data.show_email(),
show_user_profile: !user.is_bot, show_user_profile: !user.is_bot,
user_email: people.get_visible_email(user), user_email: people.get_visible_email(user),
@@ -504,7 +504,7 @@ export function toggle_actions_popover(element, id) {
const should_display_quote_and_reply = const should_display_quote_and_reply =
message.content !== "<p>(deleted)</p>" && not_spectator; message.content !== "<p>(deleted)</p>" && not_spectator;
const conversation_time_uri = hash_util.by_conversation_and_time_uri(message); const conversation_time_uri = hash_util.by_conversation_and_time_url(message);
const should_display_delete_option = const should_display_delete_option =
message_edit.get_deletability(message) && not_spectator; message_edit.get_deletability(message) && not_spectator;

4
static/js/recent_topics_ui.js
View File

@@ -303,13 +303,13 @@ function format_topic(topic_data) {
stream_color: stream_info.color, stream_color: stream_info.color,
invite_only: stream_info.invite_only, invite_only: stream_info.invite_only,
is_web_public: stream_info.is_web_public, is_web_public: stream_info.is_web_public,
stream_url: hash_util.by_stream_uri(stream_id), stream_url: hash_util.by_stream_url(stream_id),
topic, topic,
topic_key: get_topic_key(stream_id, topic), topic_key: get_topic_key(stream_id, topic),
unread_count, unread_count,
last_msg_time, last_msg_time,
topic_url: hash_util.by_stream_topic_uri(stream_id, topic), topic_url: hash_util.by_stream_topic_url(stream_id, topic),
senders: senders_info, senders: senders_info,
other_senders_count: Math.max(0, all_senders.length - MAX_AVATAR), other_senders_count: Math.max(0, all_senders.length - MAX_AVATAR),
other_sender_names_html, other_sender_names_html,

2
static/js/reminder.js
View File

@@ -137,7 +137,7 @@ export function do_set_reminder_for_message(message_id, timestamp) {
return; return;
} }
const link_to_msg = hash_util.by_conversation_and_time_uri(message); const link_to_msg = hash_util.by_conversation_and_time_url(message);
const reminder_msg_content = const reminder_msg_content =
message.raw_content + "\n\n[Link to conversation](" + link_to_msg + ")"; message.raw_content + "\n\n[Link to conversation](" + link_to_msg + ")";
let reminder_message = { let reminder_message = {

2
static/js/stream_edit.js
View File

@@ -35,7 +35,7 @@ export let toggler;
export let select_tab = "personal_settings"; export let select_tab = "personal_settings";
function setup_subscriptions_stream_hash(sub) { function setup_subscriptions_stream_hash(sub) {
const hash = hash_util.stream_edit_uri(sub); const hash = hash_util.stream_edit_url(sub);
browser_history.update(hash); browser_history.update(hash);
} }

2
static/js/stream_list.js
View File

@@ -243,7 +243,7 @@ function build_stream_sidebar_li(sub) {
const args = { const args = {
name, name,
id: sub.stream_id, id: sub.stream_id,
uri: hash_util.by_stream_uri(sub.stream_id), uri: hash_util.by_stream_url(sub.stream_id),
is_muted: stream_data.is_muted(sub.stream_id) === true, is_muted: stream_data.is_muted(sub.stream_id) === true,
invite_only: sub.invite_only, invite_only: sub.invite_only,
is_web_public: sub.is_web_public, is_web_public: sub.is_web_public,

2
static/js/stream_popover.js
View File

@@ -567,7 +567,7 @@ export function register_stream_handlers() {
const sub = stream_popover_sub(e); const sub = stream_popover_sub(e);
hide_stream_popover(); hide_stream_popover();
const stream_edit_hash = hash_util.stream_edit_uri(sub); const stream_edit_hash = hash_util.stream_edit_url(sub);
browser_history.go_to_location(stream_edit_hash); browser_history.go_to_location(stream_edit_hash);
}); });

2
static/js/stream_settings_data.js
View File

@@ -47,7 +47,7 @@ export function add_settings_fields(sub) {
sub.can_access_subscribers = stream_data.can_view_subscribers(sub); sub.can_access_subscribers = stream_data.can_view_subscribers(sub);
sub.can_add_subscribers = stream_data.can_subscribe_others(sub); sub.can_add_subscribers = stream_data.can_subscribe_others(sub);
sub.preview_url = hash_util.by_stream_uri(sub.stream_id); sub.preview_url = hash_util.by_stream_url(sub.stream_id);
sub.is_old_stream = sub.stream_weekly_traffic !== null; sub.is_old_stream = sub.stream_weekly_traffic !== null;
} }

2
static/js/topic_list_data.js
View File

@@ -103,7 +103,7 @@ export function get_list_info(stream_id, zoomed) {
is_zero: num_unread === 0, is_zero: num_unread === 0,
is_muted: is_topic_muted, is_muted: is_topic_muted,
is_active_topic, is_active_topic,
url: hash_util.by_stream_topic_uri(stream_id, topic_name), url: hash_util.by_stream_topic_url(stream_id, topic_name),
resolved, resolved,
resolved_topic_prefix: message_edit.RESOLVED_TOPIC_PREFIX, resolved_topic_prefix: message_edit.RESOLVED_TOPIC_PREFIX,
}; };

4
static/js/user_profile.js
View File

@@ -43,7 +43,7 @@ function format_user_stream_list_item(stream, user) {
is_web_public: stream.is_web_public, is_web_public: stream.is_web_public,
show_unsubscribe_button, show_unsubscribe_button,
show_private_stream_unsub_tooltip, show_private_stream_unsub_tooltip,
stream_edit_url: hash_util.stream_edit_uri(stream), stream_edit_url: hash_util.stream_edit_url(stream),
}); });
} }
@@ -278,7 +278,7 @@ export function register_click_handlers() {
} }
if (sub.invite_only && people.is_my_user_id(target_user_id)) { if (sub.invite_only && people.is_my_user_id(target_user_id)) {
const new_hash = hash_util.stream_edit_uri(sub); const new_hash = hash_util.stream_edit_url(sub);
hide_user_profile(); hide_user_profile();
browser_history.go_to_location(new_hash); browser_history.go_to_location(new_hash);
return; return;

4
static/shared/js/internal_url.js
View File

@@ -39,11 +39,11 @@ export function encode_stream_id(stream_id, maybe_get_stream_name) {
return encodeHashComponent(slug); return encodeHashComponent(slug);
} }
export function by_stream_uri(stream_id, maybe_get_stream_name) { export function by_stream_url(stream_id, maybe_get_stream_name) {
return "#narrow/stream/" + encode_stream_id(stream_id, maybe_get_stream_name); return "#narrow/stream/" + encode_stream_id(stream_id, maybe_get_stream_name);
} }
export function by_stream_topic_uri(stream_id, topic, maybe_get_stream_name) { export function by_stream_topic_url(stream_id, topic, maybe_get_stream_name) {
return ( return (
"#narrow/stream/" + "#narrow/stream/" +
encode_stream_id(stream_id, maybe_get_stream_name) + encode_stream_id(stream_id, maybe_get_stream_name) +

2
static/templates/user_info_popover_content.hbs
View File

@@ -151,7 +151,7 @@
{{/if}} {{/if}}
<hr /> <hr />
<li> <li>
<a href="{{ pm_with_uri }}" class="narrow_to_private_messages"> <a href="{{ pm_with_url }}" class="narrow_to_private_messages">
<i class="fa fa-lock" aria-hidden="true"></i> <i class="fa fa-lock" aria-hidden="true"></i>
{{#if is_me}} {{#if is_me}}
{{#tr}}View private messages to myself{{/tr}} {{#tr}}View private messages to myself{{/tr}}