saltstack / saltstack/salt

[TECH DEBT] salt-ssh does unnecessary work related to minion data caching

Open
#63,039 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Salt-SSH tech-debt
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description of the tech debt to be addressed, include links and screenshots

During handling of a wrapped function, https://github.com/saltstack/salt/blob/d7168f8a2c5392c4f10cf9a72f89145045f1a3e6/salt/client/ssh/__init__.py#L1104-L1126 decides whether a minion data cache refresh is in order, but the last statement makes this always apply since https://github.com/saltstack/salt/commit/4fb8f82eb6cdf95418efe67376beaa34bd584c2a.

This e.g. also means the code paths in https://github.com/saltstack/salt/blob/d7168f8a2c5392c4f10cf9a72f89145045f1a3e6/salt/client/ssh/__init__.py#L1184-L1197 are unnecessary and the code could be simplified further.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in salt/client/ssh/init.py, especially lines 1104-1126 and 1184-1197, and compare the behavior with commit 4fb8f82eb6cdf95418efe67376beaa34bd584c2a. Trace the wrapped-function handling and minion data cache refresh decision; done means the unnecessary work and dependent paths are simplified without changing required salt-ssh behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, devops
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.