[PATCH 07/11] emacs: Use notmuch tag --batch for large tag queries

[Mark Walters]

On Mon, 07 Oct 2013, Austin Clements <amdragon at MIT.EDU> wrote:
> (Unfortunately, it's difficult to first demonstrate this problem with
> a known-broken test because modern Linux kernels have argument length
> limits in the megabytes, which makes Emacs really slow!)
> ---
>  emacs/notmuch-lib.el |  8 ++++++++
>  emacs/notmuch-tag.el | 12 ++++++++++--
>  test/emacs           |  8 ++++++++
>  3 files changed, 26 insertions(+), 2 deletions(-)
>
> diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
> index 22156f1..348112b 100644
> --- a/emacs/notmuch-lib.el
> +++ b/emacs/notmuch-lib.el
> @@ -261,6 +261,14 @@ user-friendly queries."
>    "Return a query that matches the message with id ID."
>    (concat "id:" (notmuch-escape-boolean-term id)))
>  
> +(defun notmuch-hex-encode (str)
> +  "Hex-encode STR (e.g., as used by batch tagging).
> +
> +This replaces spaces, percents, and double quotes in STR with
> +%NN where NN is the hexadecimal value of the character."
> +  (replace-regexp-in-string
> +   "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
> +
>  ;;
>  
>  (defun notmuch-common-do-stash (text)
> diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el
> index 064cfa8..a4eec14 100644
> --- a/emacs/notmuch-tag.el
> +++ b/emacs/notmuch-tag.el
> @@ -242,6 +242,8 @@ from TAGS if present."
>  	   (error "Changed tag must be of the form `+this_tag' or `-that_tag'")))))
>      (sort result-tags 'string<)))
>  
> +(defconst notmuch-tag-argument-limit 1000)
> +

Another triviality: I think this should have a doc string saying use
batch tag if the query is longer than this.

The other patches in the series up to this point LGTM.

Mark


>  (defun notmuch-tag (query &optional tag-changes)
>    "Add/remove tags in TAG-CHANGES to messages matching QUERY.
>  
> @@ -268,8 +270,14 @@ notmuch-after-tag-hook will be run."
>  	tag-changes)
>    (unless (null tag-changes)
>      (run-hooks 'notmuch-before-tag-hook)
> -    (apply 'notmuch-call-notmuch-process "tag"
> -	   (append tag-changes (list "--" query)))
> +    (if (<= (length query) notmuch-tag-argument-limit)
> +	(apply 'notmuch-call-notmuch-process "tag"
> +	       (append tag-changes (list "--" query)))
> +      ;; Use batch tag mode to avoid argument length limitations
> +      (let ((batch-op (concat (mapconcat #'notmuch-hex-encode tag-changes " ")
> +			      " -- " query)))
> +	(message "Batch tagging with %s" batch-op)
> +	(notmuch-call-notmuch-process :stdin-string batch-op "tag" "--batch")))
>      (run-hooks 'notmuch-after-tag-hook))
>    ;; in all cases we return tag-changes as a list
>    tag-changes)
> diff --git a/test/emacs b/test/emacs
> index 05295af..2917189 100755
> --- a/test/emacs
> +++ b/test/emacs
> @@ -122,6 +122,14 @@ test_emacs "(notmuch-search \"$os_x_darwin_thread\")
>  output=$(notmuch search $os_x_darwin_thread | notmuch_search_sanitize)
>  test_expect_equal "$output" "thread:XXX   2009-11-18 [4/4] Jjgod Jiang, Alexander Botero-Lowry; [notmuch] Mac OS X/Darwin compatibility issues (inbox unread)"
>  
> +test_begin_subtest "Add tag (large query)"
> +# We use a long query to force us into batch mode and use a funny tag
> +# that requires escaping for batch tagging.
> +test_emacs "(notmuch-tag (concat \"$os_x_darwin_thread\" \" or \" (make-string notmuch-tag-argument-limit ?x)) \"+tag-from-%-large-query\")"
> +output=$(notmuch search $os_x_darwin_thread | notmuch_search_sanitize)
> +test_expect_equal "$output" "thread:XXX   2009-11-18 [4/4] Jjgod Jiang, Alexander Botero-Lowry; [notmuch] Mac OS X/Darwin compatibility issues (inbox tag-from-%-large-query unread)"
> +notmuch tag -tag-from-%-large-query $os_x_darwin_thread
> +
>  test_begin_subtest "notmuch-show: add single tag to single message"
>  test_emacs "(notmuch-show \"$os_x_darwin_thread\")
>  	    (execute-kbd-macro \"+tag-from-show-view\")"
> -- 
> 1.8.4.rc3
>
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch