Skip to content
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

chore(deps): update dependency ssh2-sftp-client to v12 #175

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 19, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
ssh2-sftp-client ^10.0.3 -> ^12.0.0 age adoption passing confidence

Release Notes

theophilusx/ssh2-sftp-client (ssh2-sftp-client)

v12.0.0: Major Version Change - Remove retry support

Compare Source

The main change in this version is the removal of the connectiuon retry support. There are 2 main reasons this support has been removed -

  • It provided little benefit over the added connection logic complexity. In 90% of cases, a connection which fails on the first attempt fails all subsequent retries. Very rarely does a connection which fails on the first attempt succeed with one of the retry attempts. This approach did have some benefit in the past when networks were slower and often more congested, but advances in technology, network speeds and infrastructure quality mean the sorts of problems we use to encounter and less prevelent.
  • The inclusion of retry support significantly complicates the event handling logic and creates some rare, but not unknown, corner cases where events don't get correctly handled and can result in the connection promise handing indefinitely, being neither resolved or rejected. The retry support also had a performance hit which could actually cause connection problems, especially on a slower network using a slower key excahgne or cipher.

The other reason to remove this support is that should someone want to have such support, it can easily be added in their own use case via one of the retry promise packages available and can be tailored to their specific needs. Maintaining a flexible and general implementation which did not have any negative impact is much harder and adds an additional maintenance burdon which is only beneficial for a small number of use cases.

The other change in this version is that we are no longer testing against v18.x of node. Highly recommended that at least version v20.x is used.

v11.0.0: New event handling strategy

Compare Source

This release introduces a new event handling strategy.

  • Global event listeners no longer raise errors. Only log events and invalidate connection object.
  • Constructor allows passing in custom global event listeners whi8chn can do whatever is appropriate for the client
  • All temporary local event listeners wil now call the associated promise rejedct method. Previously reject was only called for error events, but this caused problems for some badly behaving sftp servers which ended connections without signalling any error condition. This would cause promises to be stuck in an unfulfilled state.

While the above changes do not change the existing API, the change in global listener behaviour may result in changes for client code behaviour, so this update is marked as a whole new version. However, most clients should not experience any change an in fact, things should be more stable with less liklihood of uncaught errors killing top level processes. It is expected that few clients will need to supply custom global event listeners as the defaults should work fror the vast majority of clients 'out of the box'. Chances are very high you will be able to update to this vwersion from 10.0.3 with no impact or nee3d for code change.


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@renovate renovate bot added the dependencies Pull requests that update a dependency file label Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants