From: Mark Walters <markwalters1009@gmail.com>
To: Austin Clements <amdragon@MIT.EDU>
Subject: [PATCH v2] emacs: notmuch search bugfix
In-Reply-To: <20120807160352.GA2811@mit.edu>
References: <87boinpqfg.fsf@qmul.ac.uk> <20120806234732.GM22601@mit.edu>
	<87pq72bthc.fsf@qmul.ac.uk> <20120807160352.GA2811@mit.edu>
User-Agent: Notmuch/0.13.2+96~g634443c (http://notmuchmail.org) Emacs/23.4.1
	(x86_64-pc-linux-gnu)
Date: Tue, 07 Aug 2012 17:32:18 +0100
Message-ID: <877gta1x4d.fsf@qmul.ac.uk>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Cc: notmuch@notmuchmail.org
Precedence: list


The recent change to use json for notmuch-search.el introduced a bug
in the code for keeping position on refresh. The problem is a
comparison between (plist-get result :thread) and a thread-id returned
by notmuch-search-find-thread-id: the latter is prefixed with
"thread:"

We fix this by adding an option to notmuch-search-find-thread-id to
return the bare thread-id. It appears that notmuch-search-refresh-view
is the only caller of notmuch-search that supplies a thread-id so this
change should be safe (but could theoretically break users .emacs
functions).
---

I think this implements all of Austin's suggestions, and it adds a short
remark to NEWS (since in unlikely cases it could break users' functions)
and updates the docstring for notmuch-search. 

Best wishes

Mark

 NEWS             |    3 +++
 emacs/notmuch.el |   12 +++++++-----
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/NEWS b/NEWS
index 761b2c1..9916c91 100644
--- a/NEWS
+++ b/NEWS
@@ -55,6 +55,9 @@ user-specified formatting
   you've customized this variable, you may have to change your date
   format from `"%s "` to `"%12s "`.
 
+The thread-id for the `target-thread` argument for `notmuch-search` should
+now be supplied without the "thread:" prefix.
+
 Notmuch 0.13.2 (2012-06-02)
 ===========================
 
diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index d2d82a9..7b61e9b 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -475,10 +475,12 @@ BEG."
 	(push (plist-get (notmuch-search-get-result pos) property) output)))
     output))
 
-(defun notmuch-search-find-thread-id ()
-  "Return the thread for the current thread"
+(defun notmuch-search-find-thread-id (&optional bare)
+  "Return the thread for the current thread
+
+If BARE is set then do not prefix with \"thread:\""
   (let ((thread (plist-get (notmuch-search-get-result) :thread)))
-    (when thread (concat "thread:" thread))))
+    (when thread (concat (unless bare "thread:") thread))))
 
 (defun notmuch-search-find-thread-id-region (beg end)
   "Return a list of threads for the current region"
@@ -936,7 +938,7 @@ If `query' is nil, it is read interactively from the minibuffer.
 Other optional parameters are used as follows:
 
   oldest-first: A Boolean controlling the sort order of returned threads
-  target-thread: A thread ID (with the thread: prefix) that will be made
+  target-thread: A thread ID (without the thread: prefix) that will be made
                  current if it appears in the search results.
   target-line: The line number to move to if the target thread does not
                appear in the search results."
@@ -993,7 +995,7 @@ same relative position within the new buffer."
   (interactive)
   (let ((target-line (line-number-at-pos))
 	(oldest-first notmuch-search-oldest-first)
-	(target-thread (notmuch-search-find-thread-id))
+	(target-thread (notmuch-search-find-thread-id 'bare))
 	(query notmuch-search-query-string)
 	(continuation notmuch-search-continuation))
     (notmuch-kill-this-buffer)
-- 
1.7.9.1