Add SFTP atomic upload functionality

オープン
#349 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
38/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
node.js, typescript
領域
networking

調査の方向性

リポジトリ内のファイルやテストは指定されていません。まず、SFTP のファイルおよびディレクトリのアップロードのエントリポイントを特定し、次にリンクされた monkeypatched 実装と比較してください。転送で一時的な名前を使用し、完了後にのみ名前を変更するよう、ユーザーがアトミックアップロードを有効化またはフックできれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
TypeScript
スター
1k
フォーク
94
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

steelbrain/node-ssh のほかの issue

steelbrain/node-ssh の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。