From f5185881f7b01f67b5b64218804749b733f08d44 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Mon, 21 Nov 2016 22:14:33 +0200 Subject: [PATCH 1/5] cli: consider files vanishing during notmuch new non-fatal If some software other than notmuch new renames or removes files during the notmuch new scan (specifically after scandir but before indexing the file), keep going instead of bailing out. Failing to index the file is just a race condition between notmuch and the other software; the rename could happen after the notmuch new scan anyway. It's not fatal, and we'll catch the renamed files on the next scan. Add a new exit code for when files vanished, so the caller has a chance to detect the race and re-run notmuch new to recover. Reported by Paul Wise at http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=843127 --- notmuch-client.h | 11 +++++++++++ notmuch-new.c | 15 ++++++++++++--- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/notmuch-client.h b/notmuch-client.h index 9ce2aef1..793f32ec 100644 --- a/notmuch-client.h +++ b/notmuch-client.h @@ -25,6 +25,7 @@ #define _GNU_SOURCE /* for getline */ #endif #include +#include #include "compat.h" @@ -114,6 +115,16 @@ chomp_newline (char *str) str[strlen(str)-1] = '\0'; } +/* Exit status code indicating temporary failure; user is invited to + * retry. + * + * For example, file(s) in the mail store were removed or renamed + * after notmuch new scanned the directories but before indexing the + * file(s). If the file was renamed, the indexing might not be + * complete, and the user is advised to re-run notmuch new. + */ +#define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL + /* Exit status code indicating the requested format version is too old * (support for that version has been dropped). CLI code should use * notmuch_exit_if_unsupported_format rather than directly exiting diff --git a/notmuch-new.c b/notmuch-new.c index c55dea7b..cc680b41 100644 --- a/notmuch-new.c +++ b/notmuch-new.c @@ -53,6 +53,7 @@ typedef struct { int total_files; int processed_files; int added_messages, removed_messages, renamed_messages; + int vanished_files; struct timeval tv_start; _filename_list_t *removed_files; @@ -280,11 +281,13 @@ add_file (notmuch_database_t *notmuch, const char *filename, case NOTMUCH_STATUS_FILE_NOT_EMAIL: fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename); break; - /* Fatal issues. Don't process anymore. */ case NOTMUCH_STATUS_FILE_ERROR: + /* Someone renamed/removed the file between scandir and now. */ + state->vanished_files++; fprintf (stderr, "Unexpected error with file %s\n", filename); (void) print_status_database ("add_file", notmuch, status); - goto DONE; + break; + /* Fatal issues. Don't process anymore. */ case NOTMUCH_STATUS_READ_ONLY_DATABASE: case NOTMUCH_STATUS_XAPIAN_EXCEPTION: case NOTMUCH_STATUS_OUT_OF_MEMORY: @@ -1151,5 +1154,11 @@ notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]) if (!no_hooks && !ret && !interrupted) ret = notmuch_run_hook (db_path, "post-new"); - return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS; + if (ret || interrupted) + return EXIT_FAILURE; + + if (add_files_state.vanished_files) + return NOTMUCH_EXIT_TEMPFAIL; + + return EXIT_SUCCESS; } From 0ca79007275ef6430d7f791b1161e39827139c87 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Fri, 25 Nov 2016 22:40:37 -0400 Subject: [PATCH 2/5] cli/new: document new exit code It seems important to give the numeric return code for people writing scripts. Hopefully deviations from this convention are rare. --- doc/man1/notmuch-new.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst index 787ed78f..7f0b2237 100644 --- a/doc/man1/notmuch-new.rst +++ b/doc/man1/notmuch-new.rst @@ -43,6 +43,14 @@ Supported options for **new** include ``--quiet`` Do not print progress or results. +EXIT STATUS +=========== + +This command supports the following special exit status code + +``75 (EX_TEMPFAIL)`` + A temporary failure occured; the user is invited to retry. + SEE ALSO ======== From 7ee022077557f7b2b4e838f5c0fe551864f7d340 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 26 Nov 2016 08:38:13 -0400 Subject: [PATCH 3/5] debian: finalize? changelog for 0.23.3-1 --- debian/changelog | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/debian/changelog b/debian/changelog index a57d63c2..4f3a94cd 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,9 +1,12 @@ -notmuch (0.23.3-1) UNRELEASED; urgency=medium +notmuch (0.23.3-1) unstable; urgency=medium * Re-enable test suite - * Fix test suite compatibility with gnupg 2.1.16 + * Fix test suite compatibility with gnupg 2.1.16. Fixes: "FTBFS: + Tests failures", thanks to Lucas Nussbaum (Closes: #844915). + * Bug fix: "race condition in `notmuch new`?", thanks to Paul Wise + (Closes: #843127). - -- David Bremner Thu, 24 Nov 2016 20:29:35 -0400 + -- David Bremner Sat, 26 Nov 2016 08:37:39 -0400 notmuch (0.23.2-1) unstable; urgency=medium From fb6fd87063adb5fc7cc7f5091cebf00b2d643d5f Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 26 Nov 2016 08:39:32 -0400 Subject: [PATCH 4/5] NEWS: set date --- NEWS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NEWS b/NEWS index 7e565316..720eec8d 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -Notmuch 0.23.3 (UNRELEASED) +Notmuch 0.23.3 (2016-11-26) Test Suite ---------- From 94511fe1c834931cd6a42c740ae0936bc48a32fd Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 26 Nov 2016 08:41:47 -0400 Subject: [PATCH 5/5] NEWS: note disappearing files fix for notmuch new --- NEWS | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/NEWS b/NEWS index 720eec8d..a678fdda 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,10 @@ Notmuch 0.23.3 (2016-11-26) +Command Line Interface +---------------------- + +Treat disappearing files during notmuch new as non-fatal. + Test Suite ----------