From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "J.P." Newsgroups: gmane.emacs.bugs Subject: bug#50009: 28.0.50; add CRLF to outgoing ERC protocol logger lines Date: Wed, 11 Aug 2021 07:26:26 -0700 Message-ID: <87v94chxbh.fsf@neverwas.me> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16181"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) To: 50009@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Aug 11 16:27:18 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mDpCP-0003zS-OQ for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 11 Aug 2021 16:27:17 +0200 Original-Received: from localhost ([::1]:49108 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mDpCO-0005cF-9e for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 11 Aug 2021 10:27:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42590) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mDpCA-0005Mj-J7 for bug-gnu-emacs@gnu.org; Wed, 11 Aug 2021 10:27:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:52936) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mDpCA-000118-Bh for bug-gnu-emacs@gnu.org; Wed, 11 Aug 2021 10:27:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mDpCA-0006qn-6z for bug-gnu-emacs@gnu.org; Wed, 11 Aug 2021 10:27:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "J.P." Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 11 Aug 2021 14:27:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 50009 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.162869199826297 (code B ref -1); Wed, 11 Aug 2021 14:27:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 11 Aug 2021 14:26:38 +0000 Original-Received: from localhost ([127.0.0.1]:36249 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mDpBl-0006q4-Ue for submit@debbugs.gnu.org; Wed, 11 Aug 2021 10:26:38 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:35466) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mDpBj-0006pu-CY for submit@debbugs.gnu.org; Wed, 11 Aug 2021 10:26:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42468) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mDpBj-0004lK-5Y for bug-gnu-emacs@gnu.org; Wed, 11 Aug 2021 10:26:35 -0400 Original-Received: from mail-108-mta254.mxroute.com ([136.175.108.254]:45585) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mDpBg-0000kx-Mk for bug-gnu-emacs@gnu.org; Wed, 11 Aug 2021 10:26:34 -0400 Original-Received: from filter004.mxroute.com ([149.28.56.236] filter004.mxroute.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta254.mxroute.com (ZoneMTA) with ESMTPSA id 17b359b851900074ba.001 for (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256); Wed, 11 Aug 2021 14:26:29 +0000 X-Zone-Loop: e39a0bb88a61f0df01addf14f636b025773cebec080f X-Originating-IP: [149.28.56.236] X-AuthUser: masked@neverwas.me X-Zone-Spam-Resolution: no action X-Zone-Spam-Status: No, score=-0.1, required=15, tests=[ARC_NA=0, NEURAL_SPAM=0, FROM_HAS_DN=0, HAS_ATTACHMENT=0, FROM_EQ_ENVFROM=0, MIME_TRACE=0, MIME_GOOD=-0.1, RCPT_COUNT_ONE=0, MID_RHS_MATCH_FROM=0, RCVD_COUNT_ZERO=0, TO_DN_NONE=0] Received-SPF: pass client-ip=136.175.108.254; envelope-from=jp@neverwas.me; helo=mail-108-mta254.mxroute.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:211603 Archived-At: --=-=-= Content-Type: text/plain Tags: patch Hi, this patch or similar would really make generating test data a lot easier (please see the behavioral tests in these bugs [1] for examples). If it were up to me, we'd also get rid of the interactive toggling, at least while sessions are ongoing. The reason is that I find the most interesting/important parts of a session to be the initial "connection registration" phase and subsequent server burst (and possibly any NickServ interactions and early JOIN activity that immediately follow). But out of respect for tradition, I've left all of that alone. Thanks. [1] https://debbugs.gnu.org/cgi/bugreport.cgi?bug=48598 https://debbugs.gnu.org/cgi/bugreport.cgi?bug=49860 In GNU Emacs 28.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.30, cairo version 1.17.4) of 2021-08-09 built on localhost Repository revision: aeec97fae0ccfcc4dc406a5e0e4c0a94b834cac4 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12011000 System Description: Fedora 34 (Workstation Edition) Configured features: ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG JSON LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM GTK3 ZLIB Important settings: value of $LANG: en_US.UTF-8 value of $XMODIFIERS: @im=ibus locale-coding-system: utf-8-unix Major mode: Lisp Interaction Minor modes in effect: tooltip-mode: t global-eldoc-mode: t eldoc-mode: t electric-indent-mode: t mouse-wheel-mode: t tool-bar-mode: t menu-bar-mode: t file-name-shadow-mode: t global-font-lock-mode: t font-lock-mode: t blink-cursor-mode: t auto-composition-mode: t auto-encryption-mode: t auto-compression-mode: t line-number-mode: t indent-tabs-mode: t transient-mark-mode: t Load-path shadows: None found. Features: (shadow sort mail-extr emacsbug message rmc puny dired dired-loaddefs rfc822 mml mml-sec epa derived epg epg-config gnus-util rmail rmail-loaddefs auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs password-cache json map text-property-search time-date subr-x seq byte-opt gv bytecomp byte-compile cconv mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader cl-loaddefs cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils iso-transl tooltip eldoc electric uniquify ediff-hook vc-hooks lisp-float-type mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe tabulated-list replace newcomment text-mode elisp-mode lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock font-lock syntax font-core term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european ethiopic indian cyrillic chinese composite charscript charprop case-table epa-hook jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice button loaddefs faces cus-face macroexp files window text-properties overlay sha1 md5 base64 format env code-pages mule custom widget hashtable-print-readable backquote threads dbusbind inotify lcms2 dynamic-setting system-font-setting font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty make-network-process emacs) Memory information: ((conses 16 51538 6355) (symbols 48 6607 1) (strings 32 18255 1368) (string-bytes 1 616656) (vectors 16 14292) (vector-slots 8 185252 10153) (floats 8 21 47) (intervals 56 205 0) (buffers 992 10)) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Add-CRLF-to-outgoing-ERC-protocol-logger-lines.patch >From 871669a52a6a410f17e1d22960490a274cc36f54 Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Mon, 14 Jun 2021 22:24:01 -0700 Subject: [PATCH] Add CRLF to outgoing ERC protocol logger lines * erc.el (erc-debug-irc-protocol): Previously, the newline handling was disguising a subtle, semi-important bug in which phantom line feeds were accidentally being sent to servers. Also, there was a harmless but annoying mismatch between outgoing and incoming lines: the latter lacked carriage returns. This adds them everywhere to make machine parsing easier. This also makes room for the addition of a session identifier, if one is ever introduced. When set, such a variable would make logging more meaningful when multiple sessions exist for the same network. Also added are timestamps to aid in reproducing bugs. And outgoing lines are no longer propertized. (erc-debug-irc-protocol-time-format): Add new variable to help with reproducing bugs. (erc-debug-irc-protocol-version): Add new variable to print atop erc-protocol log files for tracking format used for logging. (erc-toggle-debug-irc-protocol): Add headers to log buffer for the benefit of bug-reproduction tools, so they can detect the format used in a log. Clean up overlong lines. --- lisp/erc/erc.el | 74 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 48 insertions(+), 26 deletions(-) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 73202016ba..2eba4a900c 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -2312,6 +2312,14 @@ erc-error ;;; Debugging the protocol +(defvar erc-debug-irc-protocol-time-format "%FT%T.%6N%z " + "An optional format string for optional I/O timestamps.") + +(defconst erc-debug-irc-protocol-version "1" + "Protocol log format version number. +These logs are machine-readable, but external tools used in bug +reproduction, etc. need a way to track changes to the format.") + (defvar erc-debug-irc-protocol nil "If non-nil, log all IRC protocol traffic to the buffer \"*erc-protocol*\". @@ -2333,32 +2341,36 @@ erc-log-irc-protocol The buffer is created if it doesn't exist. -If OUTBOUND is non-nil, STRING is being sent to the IRC server -and appears in face `erc-input-face' in the buffer." +If OUTBOUND is non-nil, STRING is being sent to the IRC server and +appears in face `erc-input-face' in the buffer. Lines must already +contain CRLF endings. Peer is identified by the most precise label +available at run time, starting with the network name, followed by the +self-reported host name, and falling back to the dialed :. +When capturing logs for multiple peers and sorting them into buckets, +such inconsistent labeling may pose a problem during an initial server +burst. For now, the recommended approach is to wrap this function with +advice that temporarily redefines the symbol-function `erc-network'." (when erc-debug-irc-protocol - (let ((network-name (or (ignore-errors (erc-network-name)) - "???"))) + (let ((esid (or (and (fboundp 'erc-network) + (erc-network) + (erc-network-name)) + erc-server-announced-name + (format "%s:%s" erc-session-server erc-session-port))) + (ts (when erc-debug-irc-protocol-time-format + (format-time-string erc-debug-irc-protocol-time-format)))) (with-current-buffer (get-buffer-create "*erc-protocol*") (save-excursion (goto-char (point-max)) (let ((inhibit-read-only t)) - (insert (if (not outbound) - ;; Cope with the fact that string might - ;; contain multiple lines of text. - (let ((lines (delete "" (split-string string - "\n\\|\r\n"))) - (result "")) - (dolist (line lines) - (setq result (concat result network-name - " << " line "\n"))) - result) - (propertize - (concat network-name " >> " string - (if (/= ?\n - (aref string - (1- (length string)))) - "\n")) - 'font-lock-face 'erc-input-face))))) + (insert (if outbound + (concat ts esid " >> " string) + ;; Cope with multi-line messages + (let ((lines (split-string string "[\r\n]+" t)) + result) + (dolist (line lines) + (setq result (concat result ts esid + " << " line "\r\n"))) + result))))) (let ((orig-win (selected-window)) (debug-buffer-window (get-buffer-window (current-buffer) t))) (when debug-buffer-window @@ -2371,24 +2383,34 @@ erc-log-irc-protocol (defun erc-toggle-debug-irc-protocol (&optional arg) "Toggle the value of `erc-debug-irc-protocol'. -If ARG is non-nil, show the *erc-protocol* buffer." +If ARG is non-nil, show the *erc-protocol* buffer. Everything before +the first CRLF is front matter. Everything before the first double +linefeed is a header." (interactive "P") (let* ((buf (get-buffer-create "*erc-protocol*"))) (with-current-buffer buf (view-mode-enter) (when (null (current-local-map)) - (let ((inhibit-read-only t)) - (insert (erc-make-notice "This buffer displays all IRC protocol traffic exchanged with each server.\n")) - (insert (erc-make-notice "Kill this buffer to terminate protocol logging.\n\n"))) + (let ((inhibit-read-only t) + (headers (concat "Version: " erc-debug-irc-protocol-version "\n" + "Emacs-Version: " emacs-version "\n" + "\n")) + (msg (concat "This buffer displays all IRC protocol traffic " + "exchanged with servers.\n" + "Kill it to disable logging.\n" + "Press `t' to toggle.\n"))) + (insert headers (erc-make-notice msg))) (use-local-map (make-sparse-keymap)) (local-set-key (kbd "t") 'erc-toggle-debug-irc-protocol)) (add-hook 'kill-buffer-hook (lambda () (setq erc-debug-irc-protocol nil)) nil 'local) (goto-char (point-max)) + ;; Searchable phrase printed twice between logs and once before + ;; the first. This is a single line with CRLF endings. (let ((inhibit-read-only t)) (insert (erc-make-notice - (format "IRC protocol logging %s at %s -- Press `t' to toggle logging.\n" + (format "IRC protocol logging %s at %s\r\n" (if erc-debug-irc-protocol "disabled" "enabled") (current-time-string)))))) (setq erc-debug-irc-protocol (not erc-debug-irc-protocol)) -- 2.31.1 --=-=-=--