[PATCH] Automatically exclude tags in notmuch-show

[Austin Clements]

Quoth Mark Walters on Jan 23 at  1:13 am:
> On Sun, 22 Jan 2012 13:16:09 -0500, Austin Clements <amdragon at MIT.EDU> wrote:
> > Quoth myself on Jan 20 at 12:18 pm:
> > > Quoth Mark Walters on Jan 20 at 12:10 am:
> > > > 
> > > > Ok Having said this is trivial I have found a problem. What should
> > > > notmuch do if you do something like
> > > > 
> > > > notmuch show id:<some-id>
> > > > and that message is marked with a deleted tag? To be consistent with the
> > > > other cases (where a deleted message is in a matched thread) we might
> > > > want to return the message with the not-matched flag set (eg in
> > > > JSON). But my patch doesn't, as it never even sees the thread since it
> > > > doesn't match.
> > > > 
> > > > Looking at notmuch-show.c I think we should not apply the exclude tags
> > > > to do_show_single, but usually should apply it to do_show. One solution
> > > > which is simple and is at least close to right would be to get do_show
> > > > to return the number of threads found. If this is zero then retry the
> > > > query without the excludes (possible setting the match_flag to zero on
> > > > each message since we know it does not match)
> > > > 
> > > > This is not a completely correct solution as if you ask notmuch-show to
> > > > show more than one thread it might  threads which only contain deleted
> > > > messages.
> > > > 
> > > > I can't see other good possibilities without slowing down the normal
> > > > path a lot (eg find all threads that match the original query and then
> > > > apply the argument above).
> > > > 
> > > > Any thoughts?
> > > 
> > > Oh dear.
> > > 
> > > Well, here's one idea.  Instead of doing a single thread query in
> > > show, do a thread query without the exclusions and then a message
> > > query with the exclusions.  Output all of the messages from the first
> > > query, but use the results of the second query to determine which
> > > messages are "matched".  The same could be accomplished in the library
> > > somewhat more efficiently, but it's not obvious to me what the API
> > > would be.
> > 
> > Here's a slightly crazier idea that's more library-invasive than the
> > original approach, but probably better in the long run.
> > 
> > Have notmuch_query_search_* return everything and make exclusion a
> > message flag like NOTMUCH_MESSAGE_FLAG_MATCH.  Tweak the definition of
> > "matched" to mean "matched and not excluded" (specifically, a message
> > would have the match flag or the excluded flag or neither, but not
> > both).  Search would skip threads with zero matched messages and I
> > think show would Just Work.
> > 
> > I can think of two ways to implement this.  notmuch_query_search_*
> > could perform both the original query and the query with exclusions
> > and use the docid set from the second to compute the "excluded"
> > message flag.  Alternatively, it could examine the tags of each
> > message directly to compute the flag.  The latter is probably easier
> > to implement, but probably slower.
> > 
> > Thoughts?
> 
> I have now thought about this some more and think I understand your idea
> (and how it would work) rather better now. 
> 
> I would suggest one small change: the flags for the messages returned
> should be "independent": so a message can match the query or not, and it
> can be excluded or not, with all 4 combinations being possible. (The
> consumer of notmuch_query_search_* would extract the information it
> wanted.)

I'd initially approached it this way, but went with redefining a
"matched" messages because it had much less impact on the API.  For
example, with the redefined "match",
notmuch_thread_get_matched_messages still does the right thing for
search and things like the thread subject can still be based on
"matched" messages.  If we orthongonalize these flags, then we at
least need to count matched non-excluded messages and provide an API
to access this (while I don't have a solid argument against such an
API it just seems weirdly specific to me).

My other concern is performance.  In thread queries, marking
non-matched messages as excluded would require either an extra query
per thread or a single query to match all excluded messages (not
filtered by the primary query).  The former is prohibitive, though the
latter might be acceptable (that might depend on how many things
people mark as spam or deleted).  If the cost is too high, this
suggests that we shouldn't mark non-matched messages as excluded, but
then we're back to effectively having three levels of matching: not
matched, matched but not excluded, and matched but excluded.

> I have thought about some implementation ideas but I think sorting is
> going to be the deciding factor: what order should
> notmuch_query_search_* return messages/threads? 

Yes.  This is exactly what I've been puzzling over, too.

> For notmuch_query_search_messages either it returns them all together
> with the excluded messages marked, or returns all included ones, and
> then all excluded one.

I would prefer them intermingled.  I feel like returning one and then
the other is just exposing implementation details.  Plus, it's unclear
if the order of the two groups should depend on the sort order, be
configurable, or what.  Intermingling them seems like the obvious
answer.

> For notmuch_query_search_threads it is less clear. Currently it returns
> threads in order of first matching message. It is not clear what
> matching means now: is matching and included, or just matching? If the
> former then we will be returning some threads with no matching and
> included messages so we need to decide where to put them in the order.

I would argue that, if the caller cares about the sort order of the
results, it only makes sense for it to skip over threads consisting
only of excluded messages, and if the caller doesn't care about the
sort order, we can choose whatever's most convenient.

> If we sort in both cases just on matching then we have the same
> output/sort as notmuch pre-excluded flags, just the frontends
> notmuch-search/show can decide to omit some lines/results. Note that
> after omitting "excluded" lines the thread sort would be different from
> the current notmuch-with-excluded implementation.
> 
> Whereas if we sort based on matching and included, we keep the current
> sort order with some stuff appended.
> 
> As regards implementation I think notmuch_query_search_messages is the
> crucial place: once that returns one of its two orders the rest sort of
> takes care of itself.

I think that comes down to exactly how we want to handle the message
flags.

> Best wishes
> 
> Mark