Add SFTP atomic upload functionality
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- node.js, typescript
- Domain
- networking
Research direction
No repository file or test is named. Start by locating the SFTP file and directory-upload entry points, then compare the linked monkeypatched implementation. Done means users can opt into or hook atomic uploads so transfers use a temporary name and rename only after completion.
Written by the indexing model from the issue text.
Description
When uploading a file to a remote directory, the file is incomplete until finished. If pushed to a directory with a webserver, clients could download partial files and be very confused (I'm sure there are other situations where this could be an issue as well). rsync doesn't have this issue -- it uploads a temporary file, then rename it once the transfer is completed. However, rsync doesn't work everywhere.
I filed an issue at ssh2, but they were of the opinion that something higher up the stack should do this sort of thing, so here we are. In particular, it would be annoying to have to reimplement the directory upload code to insert this sort of functionality -- so it would be nice if either:
- There was a hook that made this possible for a user to implement
- Or there was an option that could be passed in that would activate the 'atomicPut' functionality
I've created a monkeypatch'ed version of this, works great on my server. It pushes as a dot + filename so that the webserver doesn't show it to clients, and then changes the filename once the upload is finished. I'd rather get rid of the monkeypatch, and I'm happy to do the changes + make a PR here if you'll accept it.
- Dominant language
- TypeScript
- Stars
- 1k
- Forks
- 94
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from steelbrain/node-ssh
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
steelbrain/node-ssh#487 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
steelbrain/node-ssh#482 · 3 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
steelbrain/node-ssh#474 · 3 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
steelbrain/node-ssh#473 · 1 comment · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
steelbrain/node-ssh#472 ·
All issues in steelbrain/node-ssh
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
cli: `execCargoMetadata` decodes stdout per chunk, corrupting non-ASCII paths across pipe boundariesOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 62/100
lingdojo/kana-dojo#34127 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
osmlab/name-suggestion-index#13104 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100