python / python/cpython

logging: `SMTPHandler.emit()` leaks the SMTP connection when sending fails

Đang mở
#155,946 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

stdlib type-bug
Ngôn ngữ chính
Python
Star
77.2k
Fork
36k
Chỉ số merge pull request
Chỉ số pull request đang chờ

Mô tả

Bug report

Bug description:

SMTPHandler.emit() only closes its SMTP connection on the success path: smtp.quit() is the last statement of the try block (Lib/logging/handlers.py#L1109-L1154).

If starttls(), login() or send_message() raises, control jumps to except Exception: self.handleError(record) and the connection is never closed — cleanup is left to the garbage collector.

Reproducer
import gc, logging, logging.handlers, socket, threading, time

logging.raiseExceptions = False
open_conns = []

def handle(conn):
    conn.sendall(b"220 fake ESMTP\r\n")
    for line in conn.makefile("rb"):
        cmd = line.strip().upper()
        if cmd.startswith(b"EHLO"):
            conn.sendall(b"250-fake\r\n250 AUTH PLAIN LOGIN\r\n")
        elif cmd.startswith(b"AUTH"):
            conn.sendall(b"535 authentication failed\r\n")
        else:
            conn.sendall(b"250 ok\r\n")
    open_conns.remove(conn)  # reached when the client closes the connection
    conn.close()

def serve(listener):
    while True:
        conn, _ = listener.accept()
        open_conns.append(conn)
        threading.Thread(target=handle, args=(conn,), daemon=True).start()

listener = socket.create_server(("127.0.0.1", 0))
threading.Thread(target=serve, args=(listener,), daemon=True).start()

h = logging.handlers.SMTPHandler(("127.0.0.1", listener.getsockname()[1]),
                                 "me@example.com", "you@example.com", "subject",
                                 credentials=("user", "wrong-password"))
for i in range(5):
    h.emit(logging.makeLogRecord({"msg": "hello"}))  # SMTPAuthenticationError
time.sleep(0.5)
print("open connections after 5 failed emits:", len(open_conns))
gc.collect(); time.sleep(0.5)
print("after gc.collect():", len(open_conns))

Output on main:

open connections after 5 failed emits: 5
after gc.collect(): 0
CPython versions tested on:

CPython main branch

Operating systems tested on:

macOS

Linked PRs
  • gh-155950

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu tại Lib/logging/handlers.py, ở SMTPHandler.emit(), và chạy trình tái hiện lỗi xác thực được cung cấp. Hoàn tất nghĩa là các nhánh mà starttls(), login() hoặc send_message() thất bại không còn để lại các kết nối SMTP đang mở; kiểm tra hành vi bằng trình tái hiện. PR được liên kết gh-155950 cho biết công việc đã được tiến hành.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
backend
Loại issue
Lỗi
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.