bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Daniel Semyonov via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 1345 bytes --]

Tags: patch

Hi,

I realized a few days ago I barely tested group descriptions in nnatom
(and by extension nnfeed), and turns out they were in fact broken.
Attached is a patch which should fix them.

Also, while working on this patch I found out the Gnus backend interface
docs are slightly misleading on this subject - Gnus reads a group
description per line inserted in the " *nntpd*" buffer, with each line
containing a group's name followed by its description.
Contrary to the docs, the separator between the name and its associated
description is either a space or a tab (the docs only mention a tab).
This is why this is "mostly" fixed, as groups with a space in their name
will incorrectly include any part of the name after the first space in
the description.

I don't currently have time to go over all other backends to see if
changing this to reflect the docs will break anything, so I just added a
comment about it.

Daniel



In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.41, cairo version 1.18.0) of 2024-06-12 built on coldharbour
Repository revision: 3905db6e3aa947b847c072259ad6d08c8a15e10e
Repository branch: master
System Description: Void Linux

Configured using:
 'configure -C --prefix=/opt/Emacs --without-x --with-pgtk
 --with-small-ja-dic --with-native-compilation 'CFLAGS=-march=native
 -O2''


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-nnfeed-Mostly-fix-group-descriptions.patch --]
[-- Type: text/patch, Size: 2123 bytes --]

From b7cbb2d58cab74eb6137ad05d64466b249cbadf4 Mon Sep 17 00:00:00 2001
From: Daniel Semyonov <daniel@dsemy.com>
Date: Tue, 2 Jul 2024 01:42:26 +0300
Subject: [PATCH] nnfeed: (Mostly) fix group descriptions

* lisp/gnus/nnfeed.el (nnfeed--group-description): New function.
(nnfeed-request-group-description)
(nnfeed-request-list-newsgroups): Use
`nnfeed--group-description' and always return t if group data is
found.
---
 lisp/gnus/nnfeed.el | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/lisp/gnus/nnfeed.el b/lisp/gnus/nnfeed.el
index d6963b2e929..2d33d4c813b 100644
--- a/lisp/gnus/nnfeed.el
+++ b/lisp/gnus/nnfeed.el
@@ -630,12 +630,21 @@ nnfeed-retrieve-groups
 (deffoo nnfeed-request-type (_group &optional _article)
   'unknown)
 
+;; FIXME: Works incorrectly when a group name contains spaces as Gnus actually
+;; separates the group name from the description with either a tab or a space.
+(defun nnfeed--group-description (name group)
+  "Return a description line for a GROUP called NAME."
+  (when-let ((desc (aref group 5))
+             ((not (string-blank-p desc))))
+    (insert name "\t" desc "\n")))
+
 (deffoo nnfeed-request-group-description (group &optional server)
   (when-let ((server (or server (nnfeed--current-server-no-prefix)))
              (g (nnfeed--group-data group server)))
     (with-current-buffer nntp-server-buffer
       (erase-buffer)
-      (insert group "	" (aref g 5) "\n"))))
+      (nnfeed--group-description group g)
+      t)))
 
 (deffoo nnfeed-request-list-newsgroups (&optional server)
   (when-let ((server (or server (nnfeed--current-server-no-prefix)))
@@ -643,9 +652,8 @@ nnfeed-request-list-newsgroups
              ((hash-table-p s)))
     (with-current-buffer nntp-server-buffer
       (erase-buffer)
-      (maphash (lambda (group g)
-                 (insert group "	" (aref g 5) "\n"))
-               s))))
+      (maphash #'nnfeed--group-description s)
+      t)))
 
 (deffoo nnfeed-request-rename-group (group new-name &optional server)
   (when-let ((server (or server (nnfeed--current-server-no-prefix)))
-- 
2.45.2

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Eli Zaretskii]

> Date: Tue, 02 Jul 2024 02:43:29 +0300
> From:  Daniel Semyonov via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> I realized a few days ago I barely tested group descriptions in nnatom
> (and by extension nnfeed), and turns out they were in fact broken.
> Attached is a patch which should fix them.

Thanks, but please tell whether this is for the emacs-30 release
branch or for master.  IOW, does the problem exist on emacs-30 or only
on master?

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Daniel Semyonov via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>>>>> Eli Zaretskii writes:

    >> Date: Tue, 02 Jul 2024 02:43:29 +0300
    >> From:  Daniel Semyonov via "Bug reports for GNU Emacs,
    >> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
    >> 
    >> I realized a few days ago I barely tested group descriptions in nnatom
    >> (and by extension nnfeed), and turns out they were in fact broken.
    >> Attached is a patch which should fix them.

    > Thanks, but please tell whether this is for the emacs-30 release
    > branch or for master.  IOW, does the problem exist on emacs-30 or only
    > on master?

Sorry, this problem exists on both emacs-30 and on master (it was
unfortunately broken since nnfeed and nnatom were added to Emacs last
year).

I'm currently going over nnfeed and nnatom when I have free time to
hopefully find any issues I missed before Emacs 30 is released (as it
will be the first stable release to include them).

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Eli Zaretskii]

> From: Daniel Semyonov <daniel@dsemy.com>
> Cc: 71888@debbugs.gnu.org
> Date: Wed, 03 Jul 2024 00:01:57 +0300
> 
> >>>>> Eli Zaretskii writes:
> 
>     >> Date: Tue, 02 Jul 2024 02:43:29 +0300
>     >> From:  Daniel Semyonov via "Bug reports for GNU Emacs,
>     >> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>     >> 
>     >> I realized a few days ago I barely tested group descriptions in nnatom
>     >> (and by extension nnfeed), and turns out they were in fact broken.
>     >> Attached is a patch which should fix them.
> 
>     > Thanks, but please tell whether this is for the emacs-30 release
>     > branch or for master.  IOW, does the problem exist on emacs-30 or only
>     > on master?
> 
> Sorry, this problem exists on both emacs-30 and on master (it was
> unfortunately broken since nnfeed and nnatom were added to Emacs last
> year).

Thanks, so I've now installed the patch on the emacs-30 release
branch.

> I'm currently going over nnfeed and nnatom when I have free time to
> hopefully find any issues I missed before Emacs 30 is released (as it
> will be the first stable release to include them).

So I'm not yet closing this bug, given that you say there's more to be
done here.

Thanks.

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Stefan Kangas]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Daniel Semyonov <daniel@dsemy.com>
>> Cc: 71888@debbugs.gnu.org
>> Date: Wed, 03 Jul 2024 00:01:57 +0300
>>
>> I'm currently going over nnfeed and nnatom when I have free time to
>> hopefully find any issues I missed before Emacs 30 is released (as it
>> will be the first stable release to include them).
>
> So I'm not yet closing this bug, given that you say there's more to be
> done here.

Any news here?  Thanks.

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Daniel Semyonov via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>>>>> Stefan Kangas writes:

    > Eli Zaretskii <eliz@gnu.org> writes:
    >>> From: Daniel Semyonov <daniel@dsemy.com>
    >>> Cc: 71888@debbugs.gnu.org
    >>> Date: Wed, 03 Jul 2024 00:01:57 +0300
    >>> 
    >>> I'm currently going over nnfeed and nnatom when I have free time to
    >>> hopefully find any issues I missed before Emacs 30 is released (as it
    >>> will be the first stable release to include them).
    >> 
    >> So I'm not yet closing this bug, given that you say there's more to be
    >> done here.

    > Any news here?  Thanks.

Sorry but no, I really hoped I would have more time to spend on this but
life has been getting in the way lately unfortunately. (Also, sorry for
taking this long to respond)

I don't think there are many issues remaining in the code FWIW, as I've
been using it for years at this point so hopefully I already found and
fixed most of them; I was mostly worried about parts of Gnus I don't use
frequently interacting with my code in weird ways (and I have had time
to test some of these parts at least, and they seem to work as
expected).

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Stefan Kangas]

Daniel Semyonov <daniel@dsemy.com> writes:

> Sorry but no, I really hoped I would have more time to spend on this but
> life has been getting in the way lately unfortunately. (Also, sorry for
> taking this long to respond)

Thanks, and no worries.  We're all volunteers here.

> I don't think there are many issues remaining in the code FWIW, as I've
> been using it for years at this point so hopefully I already found and
> fixed most of them; I was mostly worried about parts of Gnus I don't use
> frequently interacting with my code in weird ways (and I have had time
> to test some of these parts at least, and they seem to work as
> expected).

Should we perhaps close this bug, then?  You could always open a new one
if any new issues should arise.

bug#71888: [PATCH] nnfeed: (Mostly) fix group descriptions

[Stefan Kangas]

Stefan Kangas <stefankangas@gmail.com> writes:

> Daniel Semyonov <daniel@dsemy.com> writes:
>
>> Sorry but no, I really hoped I would have more time to spend on this but
>> life has been getting in the way lately unfortunately. (Also, sorry for
>> taking this long to respond)
>
> Thanks, and no worries.  We're all volunteers here.
>
>> I don't think there are many issues remaining in the code FWIW, as I've
>> been using it for years at this point so hopefully I already found and
>> fixed most of them; I was mostly worried about parts of Gnus I don't use
>> frequently interacting with my code in weird ways (and I have had time
>> to test some of these parts at least, and they seem to work as
>> expected).
>
> Should we perhaps close this bug, then?  You could always open a new one
> if any new issues should arise.

That was 2 weeks ago, so I'm closing this bug report now.

Thanks!