button/views/core: Support opening external links in browser.

This commit uses the open_in_browser() function (previously
view_in_browser()) to handle opening all external links as well
as internal media links in the browser.

Now, pressing ENTER on any MsgLinkButton will:
- Open the link in the browser, if the link is an external link
or an internal media link.
- Narrow to the message in ZT, if the link is an internal link.
i.e. near_message_url.

Tests amended.

Author: zee-bit

tests/core/test_core.py

@@ -272,25 +272,23 @@ def test_narrow_to_all_mentions(
         msg_ids = {widget.original_widget.message['id'] for widget in widgets}
         assert msg_ids == id_list
 
-    @pytest.mark.parametrize('server_url', [
-        'https://chat.zulip.org/',
-        'https://foo.zulipchat.com/',
+    @pytest.mark.parametrize('url', [
+        'https://chat.zulip.org/#narrow/stream/test',
+        'https://chat.zulip.org/user_uploads/abcd/efg.png',
+        'https://github.com/',
     ])
-    def test_view_in_browser(self, mocker, controller, message_fixture,
-                             server_url):
+    def test_open_in_browser(self, mocker, controller, message_fixture, url):
         # Set DISPLAY environ to be able to run test in CI
         os.environ['DISPLAY'] = ':0'
-        controller.model.server_url = server_url
-        message_id = message_fixture['id']
+
         mocked_get = mocker.patch(CORE + '.webbrowser.get')
         mocked_open = mocker.patch(CORE + '.webbrowser.open')
 
-        controller.view_in_browser(message_fixture)
-        url = mocked_open.call_args[0][0]
+        controller.open_in_browser(url)
+        called_url = mocked_open.call_args[0][0]
 
         assert mocked_open.call_count == 1
-        assert url.startswith(controller.model.server_url)
-        assert url.endswith('/{}'.format(message_id))
+        assert called_url == url
 
     def test_main(self, mocker, controller):
         controller.view.palette = {

tests/ui_tools/test_buttons.py

@@ -369,19 +369,21 @@ def test_update_widget(self, mocker, caption, expected_cursor_position,
     @pytest.mark.parametrize([
             'link',
             'handle_narrow_link_called',
+            'open_in_browser_called',
         ],
         [
-            (SERVER_URL + '/#narrow/stream/1-Stream-1', True),
-            (SERVER_URL + '/user_uploads/some/path/image.png', False),
-            ('https://foo.com', False),
+            (SERVER_URL + '/#narrow/stream/1-Stream-1', True, False),
+            (SERVER_URL + '/user_uploads/some/path/image.png', False, True),
+            ('https://foo.com', False, True),
         ],
         ids=[
             'internal_narrow_link',
             'internal_media_link',
             'external_link',
         ]
     )
-    def test_handle_link(self, mocker, link, handle_narrow_link_called):
+    def test_handle_link(self, mocker, link, handle_narrow_link_called,
+                         open_in_browser_called):
         self.controller.model.server_url = SERVER_URL
         self.handle_narrow_link = (
             mocker.patch(BUTTONS + '.MessageLinkButton.handle_narrow_link')
@@ -391,6 +393,7 @@ def test_handle_link(self, mocker, link, handle_narrow_link_called):
         mocked_button.handle_link()
 
         assert self.handle_narrow_link.called == handle_narrow_link_called
+        assert self.controller.open_in_browser.called == open_in_browser_called
 
     @pytest.mark.parametrize('stream_data, expected_response', [
             ('206-zulip-terminal', dict(stream_id=206, stream_name=None)),

tests/ui_tools/test_popups.py

@@ -516,14 +516,15 @@ def test_keypress_exit_popup(self, key, widget_size):
         assert self.controller.exit_popup.called
 
     @pytest.mark.parametrize('key', keys_for_command('VIEW_IN_BROWSER'))
-    def test_keypress_view_in_browser(self, widget_size,
+    def test_keypress_view_in_browser(self, mocker, widget_size,
                                       message_fixture, key):
         size = widget_size(self.msg_info_view)
+        self.msg_info_view.server_url = 'https://chat.zulip.org/'
+        mocker.patch(VIEWS + '.near_message_url')
 
         self.msg_info_view.keypress(size, key)
 
-        (self.controller.view_in_browser.
-         assert_called_once_with(message_fixture))
+        assert self.controller.open_in_browser.called
 
     def test_height_noreactions(self):
         expected_height = 4

zulipterminal/core.py

@@ -17,7 +17,6 @@
 from zulipterminal.config.themes import ThemeSpec
 from zulipterminal.helper import LINUX, asynch, suppress_output
 from zulipterminal.model import Model
-from zulipterminal.server_url import near_message_url
 from zulipterminal.ui import Screen, View
 from zulipterminal.ui_tools.utils import create_msg_box_list
 from zulipterminal.ui_tools.views import (
@@ -255,10 +254,7 @@ def show_edit_history(
             'area:msg'
         )
 
-    def view_in_browser(self, message: Message) -> None:
-        # Truncate extra '/' from the server url.
-        url = near_message_url(self.model.server_url[:-1], message)
-
+    def open_in_browser(self, url: str) -> None:
         # Don't try to open web browser if running without a GUI
         if (LINUX and not os.environ.get('DISPLAY')
                 and os.environ.get('TERM')):

zulipterminal/ui_tools/buttons.py

@@ -341,6 +341,8 @@ def handle_link(self, *_: Any) -> None:
         server_url = self.model.server_url
         if self.link.startswith(urljoin(server_url, '/#narrow/')):
             self.handle_narrow_link()
+        else:
+            self.controller.open_in_browser(self.link)
 
     @staticmethod
     def _decode_stream_data(encoded_stream_data: str) -> DecodedStream:

zulipterminal/ui_tools/views.py

@@ -29,6 +29,7 @@
     match_stream,
     match_user,
 )
+from zulipterminal.server_url import near_message_url
 from zulipterminal.ui_tools.boxes import MessageBox, PanelSearchBox
 from zulipterminal.ui_tools.buttons import (
     HomeButton,
@@ -1227,6 +1228,7 @@ def __init__(self, controller: Any, msg: Message, title: str,
         self.topic_links = topic_links
         self.message_links = message_links
         self.time_mentions = time_mentions
+        self.server_url = controller.model.server_url
         date_and_time = controller.model.formatted_local_time(
             msg['timestamp'], show_seconds=True, show_year=True
         )
@@ -1351,7 +1353,8 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 time_mentions=self.time_mentions,
             )
         elif is_command_key('VIEW_IN_BROWSER', key):
-            self.controller.view_in_browser(self.msg)
+            url = near_message_url(self.server_url[:-1], self.msg)
+            self.controller.open_in_browser(url)
         return super().keypress(size, key)