Merge lp:~jelmer/bzr-gtk/remove-bzr-notify into lp:bzr-gtk

[Jelmer Vernooij]

Stop shipping bzr-notify.

bzr-notify never really reached its potential - it was meant to notify about background bzr jobs, and commits that happened on the local lan (integrated with bzr-avahi).

There are several open bugs about bzr-notify and it's causing far more harm than good at the moment. Nobody has actively done anything to improve bzr-notify in a long time, so I think we should just remove it.

[Curtis Hovey (sinzui)]

I think this is the right decision. Thank you.

review: Approve (code)

[Vincent Ladeuil (vila)]

Hold on, I'm still using that, can't we just disable it by default instead (with instructions on how to enable it ;)

review: Disapprove

[Jelmer Vernooij (jelmer)]

> Hold on, I'm still using that, can't we just disable it by default instead
> (with instructions on how to enable it ;)
Do we really want to keep something around that's mostly broken though? I wouldn't want any new users picking it up, especially given it's fair number of issues. It's just an extra maintenance burden.

[Vincent Ladeuil (vila)]

'mostly broken' seems slightly excessive given that it just works here.

I have never been able to reproduce bug #949798 myself (I witnessed it once or twice but it was long ago).

[Curtis Hovey (sinzui)]

Removing this feature will also fix these Ubuntu package bugs:
    Bug #919886, Bug #315741, Bug #1001679, Bugs Bug #983830, Bug #925933
and these additional bzr-gtk bugs:
    Bug #159113, Bug #107169,

I think bzr-notify is too brittle. It does not "just work". This could be a separate project and the bugs can be moved to it. Users who want the feature can install it instead of getting errors for a feature they have not asked for.

[Jelmer Vernooij (jelmer)]

Maybe 'mostly broken' is an exaggeration, but it's far from stable and it causes a fair few problems. Given we don't really have the resources to address those issues, do we really want to keep shipping something that has this many problems, and so little real use?

[lp:~jelmer/bzr-gtk/remove-bzr-notify]

795. By Jelmer Vernooij on 2012-07-10

Remove tests and preferences page.

=== modified file 'NEWS'
--- NEWS	2012-03-23 15:02:38 +0000
+++ NEWS	2012-07-10 08:40:24 +0000
@@ -13,6 +13,12 @@
 
   * Fix searching in tree views. (Jelmer Vernooij, #928301)
 
+ CHANGES
+
+  * bzr-notify has been removed, as it was causing regressions
+    on several machines and not particularly useful.
+    (Jelmer Vernooij, #714767, #949798, #998994, #342135, #342136, #394536)
+
 0.103.0	2011-12-11
 
  FEATURES

=== removed file 'bzr-notify'
--- bzr-notify	2012-02-03 19:49:55 +0000
+++ bzr-notify	1970-01-01 00:00:00 +0000
@@ -1,102 +0,0 @@
-#!/usr/bin/env python
-
-"""Run the bzr tray icon.
-
-This is a background program which will pop up a notification on the users
-screen when a commit occurs.
-"""
-
-from bzrlib.plugin import load_plugins
-load_plugins()
-
-from bzrlib.plugins.gtk.commands import open_display
-
-from bzrlib.plugins.gtk.notify import NotifyPopupMenu
-Gtk = open_display()
-
-import cgi
-import sys
-
-import dbus
-import dbus.service
-from gi.repository import GObject
-from gi.repository import Notify
-
-from bzrlib.bzrdir import BzrDir
-from bzrlib.osutils import format_date
-from bzrlib.transport import get_transport
-
-menu = NotifyPopupMenu()
-try:
-    from gi.repository import AppIndicator3
-except ImportError:
-    icon = Gtk.StatusIcon.new_from_icon_name("bzr-panel")
-    icon.connect('popup-menu', menu.display)
-    icon.set_visible(False)
-    hide_icon = lambda: icon.set_visible(False)
-    show_icon = lambda: icon.set_visible(True)
-else:
-    indicator = AppIndicator3.Indicator.new(
-        "bzr-gtk-notify", "bzr-panel", AppIndicator3.IndicatorCategory.OTHER)
-    indicator.set_status (AppIndicator3.IndicatorStatus.PASSIVE)
-    indicator.set_attention_icon("bzr-panel")
-    indicator.set_menu(menu)
-    hide_icon = lambda: indicator.set_status (
-        AppIndicator3.IndicatorStatus.PASSIVE)
-    show_icon = lambda: indicator.set_status (
-        AppIndicator3.IndicatorStatus.ATTENTION)
-
-if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
-    import dbus.glib
-BROADCAST_INTERFACE = "org.bazaarvcs.plugins.dbus.Broadcast"
-bus = dbus.SessionBus()
-
-def catch_branch(revision_id, urls):
-    # TODO: show all the urls, or perhaps choose the 'best'.
-    url = urls[0]
-    try:
-        if isinstance(revision_id, unicode):
-            revision_id = revision_id.encode('utf8')
-        transport = get_transport(url)
-        a_dir = BzrDir.open_from_transport(transport)
-        branch = a_dir.open_branch()
-        revno = branch.revision_id_to_revno(revision_id)
-        revision = branch.repository.get_revision(revision_id)
-        summary = 'New revision %d in %s' % (revno, url)
-        body = 'Committer: %s\n' % revision.committer
-        body += 'Date: %s\n' % format_date(revision.timestamp,
-            revision.timezone)
-        body += '\n'
-        body += revision.message
-        body = cgi.escape(body)
-        nw = Notify.Notification.new(summary, body, None)
-        def start_viz(notification=None, action=None, data=None):
-            """Start the viz program."""
-            from bzrlib.plugins.gtk.commands import start_viz_window
-            pp = start_viz_window(branch, revision_id)
-            pp.show()
-        def start_branch(notification=None, action=None, data=None):
-            """Start a Branch dialog"""
-            from bzrlib.plugins.gtk.branch import BranchDialog
-            bd = BranchDialog(remote_path=url)
-            bd.run()
-        if "actions" in Notify.get_server_caps():
-            nw.add_action("inspect", "Inspect", start_viz, None)
-            nw.add_action("branch", "Branch", start_branch, None)
-        show_icon()
-        GObject.timeout_add(5000, hide_icon)
-        nw.set_timeout(5000)
-        nw.show()
-    except Exception, e:
-        print e
-        raise
-bus.add_signal_receiver(catch_branch,
-                        dbus_interface=BROADCAST_INTERFACE,
-                        signal_name="Revision")
-Notify.init("bzr-notify")
-
-if sys.argv[-1] == 'test':
-    # Exit before main loop.
-    sys.exit(0)
-
-Gtk.main()

=== removed file 'bzr-notify.desktop'
--- bzr-notify.desktop	2011-09-28 07:45:39 +0000
+++ bzr-notify.desktop	1970-01-01 00:00:00 +0000
@@ -1,12 +0,0 @@
-[Desktop Entry]
-Type=Application
-Version=0.1
-Name=Bazaar Notification
-GenericName=Bazaar Notification
-Comment=Notification Area Icon for Bazaar
-Icon=bzr-icon-64
-Exec=bzr-notify
-Categories=Application;Development;RevisionControl;
-Terminal=false
-X-GNOME-Autostart-Delay=30
-

=== removed file 'bzr-notify.desktop.in'
--- bzr-notify.desktop.in	2010-08-21 09:32:13 +0000
+++ bzr-notify.desktop.in	1970-01-01 00:00:00 +0000
@@ -1,10 +0,0 @@
-[Desktop Entry]
-Type=Application
-Version=0.1
-_Name=Bazaar Notification
-_GenericName=Bazaar Notification
-_Comment=Notification Area Icon for Bazaar
-Icon=bzr-icon-64
-Exec=bzr-notify
-Categories=Application;Development;RevisionControl;
-Terminal=false

=== removed file 'notify.py'
--- notify.py	2012-02-03 18:59:38 +0000
+++ notify.py	1970-01-01 00:00:00 +0000
@@ -1,104 +0,0 @@
-# Copyright (C) 2007 by Robert Collins
-#                       Jelmer Vernooij
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""Notification area icon and notification for Bazaar."""
-
-from gi.repository import Gtk
-import bzrlib
-
-
-def has_dbus():
-    return (getattr(bzrlib.plugins, "dbus", None) is not None)
-
-
-def has_avahi():
-    return (getattr(bzrlib.plugins, "avahi", None) is not None)
-
-
-class NotifyPopupMenu(Gtk.Menu):
-
-    SHOW_WIDGETS = True
-
-    def __init__(self):
-        super(NotifyPopupMenu, self).__init__()
-        self.create_items()
-
-    def create_items(self):
-        from bzrlib import errors
-        item = Gtk.CheckMenuItem.new_with_mnemonic('_Gateway to LAN')
-        item.connect('toggled', self.toggle_lan_gateway)
-        self.append(item)
-        self.append(Gtk.SeparatorMenuItem())
-        try:
-            from bzrlib.plugins.dbus.activity import LanGateway
-            self.langateway = LanGateway()
-        except ImportError:
-            item.set_sensitive(False)
-        except errors.BzrError:
-            # FIXME: Should only catch errors that indicate a lan-notify
-            # process is already running.
-            item.set_sensitive(False)
-
-        item = Gtk.CheckMenuItem.new_with_mnemonic(
-            'Announce _branches on LAN')
-        item.connect('toggled', self.toggle_announce_branches)
-        self.append(item)
-        self.append(Gtk.SeparatorMenuItem())
-        try:
-            from bzrlib.plugins.avahi.share import ZeroConfServer
-            from bzrlib import urlutils
-            self.zeroconfserver = ZeroConfServer(urlutils.normalize_url('.'))
-        except ImportError:
-            item.set_sensitive(False)
-
-        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_PREFERENCES, None)
-        item.connect('activate', self.show_preferences)
-        self.append(item)
-        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_ABOUT, None)
-        item.connect('activate', self.show_about)
-        self.append(item)
-        self.append(Gtk.SeparatorMenuItem())
-        item = Gtk.ImageMenuItem.new_from_stock(Gtk.STOCK_QUIT, None)
-        item.connect('activate', Gtk.main_quit)
-        self.append(item)
-        if self.SHOW_WIDGETS:
-            self.show_all()
-
-    def display(self, icon, event_button, event_time):
-        self.popup(None, None, Gtk.status_icon_position_menu,
-               event_button, event_time, icon)
-
-    def toggle_lan_gateway(self, item):
-        if item.get_active():
-            self.langateway.start()
-        else:
-            self.langateway.stop()
-
-    def toggle_announce_branches(self, item):
-        if item.get_active():
-            self.zeroconfserver.start()
-        else:
-            self.zeroconfserver.close()
-
-    def show_about(self, item):
-        from bzrlib.plugins.gtk.about import AboutDialog
-        dialog = AboutDialog()
-        dialog.run()
-
-    def show_preferences(self, item):
-        from bzrlib.plugins.gtk.preferences import PreferencesWindow
-        prefs = PreferencesWindow()
-        prefs.run()

=== modified file 'preferences/__init__.py'
--- preferences/__init__.py	2011-09-07 16:01:14 +0000
+++ preferences/__init__.py	2012-07-10 08:40:24 +0000
@@ -19,7 +19,6 @@
 from bzrlib.config import GlobalConfig
 from bzrlib.plugins.gtk.preferences.identity import IdentityPage
 from bzrlib.plugins.gtk.preferences.plugins import PluginsPage
-from bzrlib.plugins.gtk.preferences.notifications import NotificationsPage
 
 class PreferencesWindow(Gtk.Dialog):
     """Displays global preferences windows."""
@@ -55,8 +54,7 @@
 
     def _create_pages(self):
         return [("Identity", IdentityPage(self.config)),
-                ("Plugins", PluginsPage()),
-                ("Notifications", NotificationsPage(self.config))]
+                ("Plugins", PluginsPage())]
 
     def display(self):
         self.window.show_all()

=== removed file 'preferences/notifications.py'
--- preferences/notifications.py	2011-09-05 03:44:26 +0000
+++ preferences/notifications.py	1970-01-01 00:00:00 +0000
@@ -1,79 +0,0 @@
-# Copyright (C) 2008 Jelmer Vernooij <[e-mail]>
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-from gi.repository import Gtk
-
-import bzrlib.plugins.gtk
-from bzrlib.plugins.gtk.notify import (
-    has_avahi,
-    has_dbus,
-    )
-
-
-def has_email():
-    return (getattr(bzrlib.plugins, "email", None) is not None)
-
-def has_cia():
-    return (getattr(bzrlib.plugins, "cia", None) is not None)
-
-
-class NotificationsPage(Gtk.VBox):
-
-    def __init__(self, config, homogeneous=False, spacing=6):
-        self.config = config
-        super(NotificationsPage, self).__init__(
-            homogeneous=homogeneous, spacing=spacing)
-        self.set_spacing(spacing) # The vertical one
-
-        lan_frame = Gtk.Frame(label="LAN Notifications")
-
-        lan_vbox = Gtk.VBox()
-        lan_frame.add(lan_vbox)
-
-        self.gateway_to_lan = Gtk.CheckButton("_Gateway to LAN")
-        lan_vbox.pack_start(self.gateway_to_lan, False, False, 0)
-        self.gateway_to_lan.set_sensitive(has_dbus())
-
-        self.announce_on_lan = Gtk.CheckButton("_Announce on LAN")
-        lan_vbox.pack_start(self.announce_on_lan, False, False, 0)
-        self.announce_on_lan.set_sensitive(has_avahi())
-
-        self.pack_start(lan_frame, False, False, 0)
-
-        email_frame = Gtk.Frame(label="E-mail notifications")
-
-        email_hbox = Gtk.HBox()
-        self.send_email = Gtk.CheckButton("Send _E-Mail to")
-        email_hbox.pack_start(self.send_email, False, False, 0)
-        self.send_email_to = Gtk.Entry()
-        email_hbox.pack_start(self.send_email_to, False, False, 0)
-
-        email_frame.add(email_hbox)
-        email_frame.set_sensitive(has_email())
-
-        self.pack_start(email_frame, False, False, 0)
-
-        cia_frame = Gtk.Frame(label="CIA notifications")
-
-        cia_user_hbox = Gtk.HBox()
-        cia_user_hbox.pack_start(Gtk.Label("Author name"), False, False, 0)
-        self.cia_user = Gtk.Entry()
-        cia_user_hbox.pack_start(self.cia_user, False, False, 0)
-
-        cia_frame.add(cia_user_hbox)
-        cia_frame.set_sensitive(has_cia())
-
-        self.pack_start(cia_frame, False, False, 0)

=== modified file 'setup.py'
--- setup.py	2012-02-28 17:45:56 +0000
+++ setup.py	2012-07-10 08:40:24 +0000
@@ -148,7 +148,7 @@
         maintainer_email="[e-mail]",
         description="GTK+ Frontends for various Bazaar commands",
         license="GNU GPL v2 or later",
-        scripts=['bzr-handle-patch', 'bzr-notify'],
+        scripts=['bzr-handle-patch'],
         url="http://bazaar-vcs.org/BzrGtk",
         package_dir={
             "bzrlib.plugins.gtk": ".",
@@ -188,8 +188,7 @@
                     # In case Python distutils extra is not available,
                     # install the .desktop files
                     ('share/applications', ['bazaar-properties.desktop',
-                                            'bzr-handle-patch.desktop',
-                                            'bzr-notify.desktop']),
+                                            'bzr-handle-patch.desktop']),
                     ('share/application-registry', ['bzr-gtk.applications']),
                     ('share/pixmaps', ['icons/bzr-icon-64.png']),
                     ('share/icons/hicolor/scalable/apps',

=== removed file 'tests/test_notify.py'
--- tests/test_notify.py	2012-02-19 15:00:34 +0000
+++ tests/test_notify.py	1970-01-01 00:00:00 +0000
@@ -1,64 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2012 Curtis C. Hovey <[e-mail]>
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-import os
-import subprocess
-
-from bzrlib import tests
-from bzrlib.plugins.gtk.notify import NotifyPopupMenu
-
-
-class FakeNotifyPopupMenu(NotifyPopupMenu):
-
-    SHOW_WIDGETS = False
-
-
-class NotifyPopupMenuTestCase(tests.TestCase):
-
-    def test_init(self):
-        menu = FakeNotifyPopupMenu()
-        items = menu.get_children()
-        self.assertEqual(8, len(items))
-        self.assertEqual('_Gateway to LAN', items[0].props.label)
-        self.assertEqual('Announce _branches on LAN', items[2].props.label)
-        self.assertEqual('gtk-preferences', items[4].props.label)
-        self.assertEqual('gtk-about', items[5].props.label)
-        self.assertEqual('gtk-quit', items[7].props.label)
-
-
-class BzrNotifyTestCase(tests.TestCase):
-
-    def setUp(self):
-        top = os.path.abspath(os.path.join(
-            os.path.dirname(__file__), os.pardir))
-        self.script = os.path.join(top, 'bzr-notify')
-        self.env = dict(os.environ)
-        self.env['BZR_PLUGINS_AT'] = 'gtk@%s' % top
-        super(BzrNotifyTestCase, self).setUp()
-
-    def test_smoketest(self):
-        # This is a smoke test to verify the process starts.
-        # The logic of the module must be moved into notify.py
-        # where it can be properly tested.
-        bzr_notify = subprocess.Popen(
-            [self.script, 'test'],
-            stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=self.env)
-        stdout, stderr = bzr_notify.communicate()
-        self.assertEqual('', stdout)
-        self.assertTrue(
-            stderr in (
-            '', 'ERROR:root:Could not find any typelib for AppIndicator3\n'))