git-annex/doc/design/assistant/blog/day_46__notification_pools.mdwn
Joey Hess b6d46c212e git-annex (5.20140402) unstable; urgency=medium
* unannex, uninit: Avoid committing after every file is unannexed,
    for massive speedup.
  * --notify-finish switch will cause desktop notifications after each
    file upload/download/drop completes
    (using the dbus Desktop Notifications Specification)
  * --notify-start switch will show desktop notifications when each
    file upload/download starts.
  * webapp: Automatically install Nautilus integration scripts
    to get and drop files.
  * tahoe: Pass -d parameter before subcommand; putting it after
    the subcommand no longer works with tahoe-lafs version 1.10.
    (Thanks, Alberto Berti)
  * forget --drop-dead: Avoid removing the dead remote from the trust.log,
    so that if git remotes for it still exist anywhere, git annex info
    will still know it's dead and not show it.
  * git-annex-shell: Make configlist automatically initialize
    a remote git repository, as long as a git-annex branch has
    been pushed to it, to simplify setup of remote git repositories,
    including via gitolite.
  * add --include-dotfiles: New option, perhaps useful for backups.
  * Version 5.20140227 broke creation of glacier repositories,
    not including the datacenter and vault in their configuration.
    This bug is fixed, but glacier repositories set up with the broken
    version of git-annex need to have the datacenter and vault set
    in order to be usable. This can be done using git annex enableremote
    to add the missing settings. For details, see
    http://git-annex.branchable.com/bugs/problems_with_glacier/
  * Added required content configuration.
  * assistant: Improve ssh authorized keys line generated in local pairing
    or for a remote ssh server to set environment variables in an
    alternative way that works with the non-POSIX fish shell, as well
    as POSIX shells.

# imported from the archive
2014-04-02 21:42:53 +01:00

68 lines
2.8 KiB
Markdown

Focus today was writing a notification broadcaster library. This is a way to
send a notification to a set of clients, any of which can be blocked
waiting for a new notification to arrive. A complication is that any number
of clients may be be dead, and we don't want stale notifications for those
clients to pile up and leak memory.
It took me 3 tries to find the solution, which turns out to be head-smackingly
simple: An array of SampleVars, one per client.
Using SampleVars means that clients only see the most recent notification,
but when the notification is just "the assistant's state changed somehow;
display a refreshed rendering of it", that's sufficient.
----
First use of that was to make the thread that woke up every 10 minutes
and checkpointed the daemon status to disk also wait for a notification
that it changed. So that'll be more current, and use less IO.
----
Second use, of course, was to make the WebApp block long polling clients
until there is really a change since the last time the client polled.
To do that, I made one change to my Yesod routes:
[[!format diff """
-/status StatusR GET
+/status/#NotificationId StatusR GET
"""]]
Now I find another reason to love Yesod, because after doing that,
I hit "make".. and fixed the type error. And hit make.. and fixed
the type error. And then it just freaking worked! Html was generated with
all urls to /status including a `NotificationId`, and the handler for
that route got it and was able to use it:
[[!format haskell """
{- Block until there is an updated status to display. -}
b <- liftIO $ getNotificationBroadcaster webapp
liftIO $ waitNotification $ notificationHandleFromId b nid
"""]]
And now the WebApp is able to display transfers in realtime!
When I have both the WebApp and `git annex get` running on the same screen,
the WebApp displays files that git-annex is transferring about as fast
as the terminal updates.
The [[progressbars]] still need to be sorted out, but otherwise
the WebApp is a nice live view of file transfers.
---
I also had some fun with Software Transactional Memory. Now when the
assistant moves a transfer from its queue of transfers to do, to its map of
transfers that are currently running, it does so in an atomic transaction.
This will avoid the transfer seeming to go missing (or be listed twice) if
the webapp refreshes at just the wrong point in time. I'm really starting
to get into STM.
----
Next up, I will be making the WebApp maintain a list of notices, displayed
on its sidebar, scrolling new notices into view, and removing ones the user
closes, and ones that expire. This will be used for displaying errors, as
well as other communication with the user (such as displaying a notice
while a git sync is in progress with a remote, etc). Seems worth doing now,
so the basic UI of the WebApp is complete with no placeholders.