Skip to content

ValueError: filedescriptor out of range in select() #68136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 3007.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/68136.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix filedescriptor out of range problem in tcp.py by replacing select.sect() with the higher-level selectors API
13 changes: 8 additions & 5 deletions salt/transport/tcp.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import logging
import multiprocessing
import queue
import select
import selectors
import socket
import threading
import time
Expand Down Expand Up @@ -371,10 +371,13 @@ async def recv(self, timeout=None):
if timeout == 0:
for msg in self.unpacker:
return msg[b"body"]
try:
events, _, _ = select.select([self._stream.socket], [], [], 0)
except TimeoutError:
events = []

with selectors.DefaultSelector() as sel:
sel.register(self._stream.socket, selectors.EVENT_READ)
ready = sel.select(timeout=0)
events = [key.fileobj for key, _ in ready]
sel.unregister(self._stream.socket)

if events:
while not self._closing:
async with self._read_in_progress:
Expand Down
37 changes: 37 additions & 0 deletions tests/pytests/unit/transport/test_publish_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import asyncio
import hashlib
import logging
import selectors
import socket
import time

Expand Down Expand Up @@ -295,3 +296,39 @@ async def handler(request):
raise Exception(f"Unknown transport {transport}")
client.close()
await asyncio.sleep(0.03)


async def test_recv_timeout_zero():
"""
Test recv method with timeout=0.
"""
host = "127.0.0.1"
port = 11122
ioloop = MagicMock()
mock_stream = MagicMock()
mock_unpacker = MagicMock()
mock_unpacker.__iter__.return_value = []
mock_socket = MagicMock()
mock_stream.socket = mock_socket

mock_selector_instance = MagicMock()
mock_selector_instance.__enter__.return_value = mock_selector_instance
mock_selector_instance.__exit__.return_value = None
mock_selector_instance.select.return_value = []

with patch(
"salt.transport.tcp.selectors.DefaultSelector",
return_value=mock_selector_instance,
), patch("salt.utils.msgpack.Unpacker", return_value=mock_unpacker):

client = salt.transport.tcp.PublishClient({}, ioloop, host=host, port=port)
client._stream = mock_stream
result = await client.recv(timeout=0)

assert result is None
mock_selector_instance.register.assert_called_once_with(
mock_socket, selectors.EVENT_READ
)
mock_selector_instance.unregister.assert_called_once_with(mock_socket)
mock_selector_instance.__enter__.assert_called_once()
mock_selector_instance.__exit__.assert_called_once()