From: Austin Clements Date: Mon, 7 Oct 2013 22:33:21 +0000 (+2000) Subject: [PATCH 11/11] emacs: Fix search tagging races X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=01dd1149335ea8c2f8e82120622995e03b498b3f;p=notmuch-archives.git [PATCH 11/11] emacs: Fix search tagging races --- diff --git a/a4/65eb6ef81823baebb55a39d4943aaf9dc2d877 b/a4/65eb6ef81823baebb55a39d4943aaf9dc2d877 new file mode 100644 index 000000000..4d0f68f21 --- /dev/null +++ b/a4/65eb6ef81823baebb55a39d4943aaf9dc2d877 @@ -0,0 +1,208 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 3D7B9431FDD + for ; Mon, 7 Oct 2013 15:33:47 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id X7UnGBxXchRP for ; + Mon, 7 Oct 2013 15:33:43 -0700 (PDT) +Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu + [18.7.68.35]) + by olra.theworths.org (Postfix) with ESMTP id E6F3A431FC2 + for ; Mon, 7 Oct 2013 15:33:32 -0700 (PDT) +X-AuditID: 12074423-b7fc98e0000009a2-02-525336bc1925 +Received: from mailhub-auth-4.mit.edu ( [18.7.62.39]) + by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP + id 45.7B.02466.CB633525; Mon, 7 Oct 2013 18:33:32 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id r97MXTQ8024748; + Mon, 7 Oct 2013 18:33:30 -0400 +Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172]) + (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r97MXShI028593 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Mon, 7 Oct 2013 18:33:29 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1VTJMm-0006c9-P5; Mon, 07 Oct 2013 18:33:28 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 11/11] emacs: Fix search tagging races +Date: Mon, 7 Oct 2013 18:33:21 -0400 +Message-Id: <1381185201-25197-12-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.8.4.rc3 +In-Reply-To: <1381185201-25197-1-git-send-email-amdragon@mit.edu> +References: <1381185201-25197-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFtrMIsWRmVeSWpSXmKPExsUixG6nrrvHLDjI4PF6WYvrN2cyOzB6PFt1 + izmAMYrLJiU1J7MstUjfLoEr40vrIZaCZ3oVOxu+sTQwPlbrYuTkkBAwkfjy5yErhC0mceHe + erYuRi4OIYF9jBLn/s9nh3A2MEpM3NvGDOEcZpKY2zGTFcKZyyix++4MZpB+NgENiW37lzOC + 2CIC0hI7784GKuLgYBZQk/jTpQISFhYwk/j9tAOsnEVAVeLHthNgNq+Ao8T+ZV+hzlCSWHhq + G5jNCRRfsvEiG4gtJOAgMXf/ItYJjPwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrp5WaW + 6KWmlG5iBIeNi/IOxj8HlQ4xCnAwKvHwZhwNChJiTSwrrsw9xCjJwaQkyvvAODhIiC8pP6Uy + I7E4I76oNCe1+BCjBAezkgivgBFQjjclsbIqtSgfJiXNwaIkznuLwz5ISCA9sSQ1OzW1ILUI + JivDwaEkwRtmCtQoWJSanlqRlplTgpBm4uAEGc4DNDwZpIa3uCAxtzgzHSJ/ilFRSpx3NkhC + ACSRUZoH1wuL61eM4kCvCPNuBaniAaYEuO5XQIOZgAbrsgeCDC5JREhJNTDWbumZ+0Lo4Ryv + 9XM/PPwyW6X4ZGVuv/qbI96yl6vPhnwUXLVkgefUh1IzCtxDX25yWeC2ZY/HtlRL76QTry5v + 7H+cvPml97GkiA0/Ll7oWHbnx4ubB1VmMkZ9to5etbdi+0RXc8VFDZ9+5a2LYFdqOWmQ2Lc6 + Xi1586ftH5REbsy08PE4cvzpLSWW4oxEQy3mouJEAJSzu07GAgAA +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 07 Oct 2013 22:33:47 -0000 + +This fixes races in thread-local and global tagging in notmuch-search +(e.g., "+", "-", "a", "*", etc.). Previously, these would modify tags +of new messages that arrived after the search. Now they only operate +on the messages that were in the threads when the search was +performed. This prevents surprises like archiving messages that +arrived in a thread after the search results were shown. + +This eliminates `notmuch-search-find-thread-id-region(-search)' +because these functions strongly encouraged racy usage. + +This fixes the two broken tests added by the previous patch. +--- + devel/TODO | 5 ----- + emacs/notmuch.el | 40 +++++++++++++++++++++++++++------------- + test/emacs | 4 +--- + 3 files changed, 28 insertions(+), 21 deletions(-) + +diff --git a/devel/TODO b/devel/TODO +index f212483..1cf4089 100644 +--- a/devel/TODO ++++ b/devel/TODO +@@ -14,11 +14,6 @@ sender's name containing ';' which causes emacs to drop a search + result.) This may require removing the outer array from the current + "notmuch search --format=json" results. + +-Fix '*' to work by simply calling '+' or '-' on a region consisting of +-the entire buffer, (this would avoid one race condition---while still +-leaving other race conditions---but could also potentially make '*' a +-very expensive operation). +- + Add a global keybinding table for notmuch, and then view-specific + tables that add to it. + +diff --git a/emacs/notmuch.el b/emacs/notmuch.el +index 2c7678d..1c64745 100644 +--- a/emacs/notmuch.el ++++ b/emacs/notmuch.el +@@ -461,14 +461,25 @@ If BARE is set then do not prefix with \"thread:\"" + (let ((thread (plist-get (notmuch-search-get-result) :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" +- (mapcar (lambda (thread) (concat "thread:" thread)) +- (notmuch-search-properties-in-region :thread beg end))) +- +-(defun notmuch-search-find-thread-id-region-search (beg end) +- "Return a search string for threads for the current region" +- (mapconcat 'identity (notmuch-search-find-thread-id-region beg end) " or ")) ++(defun notmuch-search-find-stable-query () ++ "Return the stable queries for the current thread. ++ ++This returns a list (MATCHED-QUERY UNMATCHED-QUERY) for the ++matched and unmatched messages in the current thread." ++ (plist-get (notmuch-search-get-result) :query)) ++ ++(defun notmuch-search-find-stable-query-region (beg end &optional only-matched) ++ "Return the stable query for the current region. ++ ++If ONLY-MATCHED is non-nil, include only matched messages. If it ++is nil, include both matched and unmatched messages." ++ (let ((query-list nil) (all (not only-matched))) ++ (dolist (queries (notmuch-search-properties-in-region :query beg end)) ++ (when (first queries) ++ (push (first queries) query-list)) ++ (when (and all (second queries)) ++ (push (second queries) query-list))) ++ (concat "(" (mapconcat 'identity query-list ") or (") ")"))) + + (defun notmuch-search-find-authors () + "Return the authors for the current thread" +@@ -525,9 +536,12 @@ If BARE is set then do not prefix with \"thread:\"" + (setq output (append output (notmuch-search-get-tags pos))))) + output)) + +-(defun notmuch-search-tag-region (beg end &optional tag-changes) +- "Change tags for threads in the given region." +- (let ((search-string (notmuch-search-find-thread-id-region-search beg end))) ++(defun notmuch-search-tag-region (beg end &optional tag-changes only-matched) ++ "Change tags for threads in the given region. ++ ++If ONLY-MATCHED is non-nil, only tag matched messages." ++ (let ((search-string (notmuch-search-find-stable-query-region ++ beg end only-matched))) + (setq tag-changes (notmuch-tag search-string tag-changes)) + (notmuch-search-foreach-result beg end + (lambda (pos) +@@ -796,7 +810,7 @@ non-authors is found, assume that all of the authors match." + + See `notmuch-tag' for information on the format of TAG-CHANGES." + (interactive) +- (apply 'notmuch-tag notmuch-search-query-string tag-changes)) ++ (notmuch-search-tag-region (point-min) (point-max) tag-changes t)) + + (defun notmuch-search-buffer-title (query) + "Returns the title for a buffer with notmuch search results." +@@ -899,7 +913,7 @@ the configured default sort order." + (save-excursion + (let ((proc (notmuch-start-notmuch + "notmuch-search" buffer #'notmuch-search-process-sentinel +- "search" "--format=sexp" "--format-version=1" ++ "search" "--format=sexp" "--format-version=2" + (if oldest-first + "--sort=oldest-first" + "--sort=newest-first") +diff --git a/test/emacs b/test/emacs +index e0dcd3c..88eb1e5 100755 +--- a/test/emacs ++++ b/test/emacs +@@ -889,7 +889,7 @@ $PWD/notmuch_fail exited with status 1 (see *Notmuch errors* for more details) + --- + [XXX] + $PWD/notmuch_fail exited with status 1 +-command: $PWD/notmuch_fail search --format\=sexp --format-version\=1 --sort\=newest-first tag\:inbox ++command: $PWD/notmuch_fail search --format\=sexp --format-version\=2 --sort\=newest-first tag\:inbox + exit status: 1" + + test_begin_subtest "Search handles subprocess warnings" +@@ -923,7 +923,6 @@ This is a warning + This is another warning" + + test_begin_subtest "Search thread tag operations are race-free" +-test_subtest_known_broken + add_message '[subject]="Search race test"' + gen_msg_id_1=$gen_msg_id + generate_message '[in-reply-to]="<'$gen_msg_id_1'>"' \ +@@ -937,7 +936,6 @@ output=$(notmuch search --output=messages 'tag:search-thread-race-tag') + test_expect_equal "$output" "id:$gen_msg_id_1" + + test_begin_subtest "Search global tag operations are race-free" +-test_subtest_known_broken + generate_message '[in-reply-to]="<'$gen_msg_id_1'>"' \ + '[references]="<'$gen_msg_id_1'>"' \ + '[subject]="Re: Search race test"' +-- +1.8.4.rc3 +