Xpra: Ticket #1026: file transfer improvements

Split from #494, remaining tasks:

each file needs to be chunked so we can interleave regular xpra traffic - high priority
ability to cancel transfers in progress
client option of showing a dialog to accept files before starting the transfer (and choose download location?)

Tue, 10 Nov 2015 22:04:44 GMT - J. Max Mena:

Edit: comment about a file too big error moved to ticket:494#comment:6

We should probably also handle the file-too-big issue with an alert box?

Thu, 12 Nov 2015 04:55:16 GMT - Antoine Martin: status changed

status changed from new to assigned

Also from ticket:494#comment:8 : GtkWarning: Could not find the icon 'gtk-file'. The 'hicolor' theme was not found either, perhaps you need to install it Looks like we may need to tweak the win32 packaging to include or point to the (more complete?) theme.

Mon, 29 Feb 2016 05:14:18 GMT - Antoine Martin:

#1124 is a nicer, more generic solution to this problem.

Wed, 16 Mar 2016 05:24:48 GMT - Antoine Martin: milestone changed

milestone changed from 0.17 to 0.18

Mon, 13 Jun 2016 06:13:48 GMT - Antoine Martin: attachment set

attachment set to file-transfer-refactoring.diff

refactoring needed to add chunking code only in one place

Mon, 13 Jun 2016 13:15:00 GMT - Antoine Martin: attachment set

attachment set to chunked-file-transfers.patch

mostly complete patch, just needs cleaning up and cancelling the timers

Mon, 13 Jun 2016 15:45:33 GMT - Antoine Martin: owner, status changed

owner changed from Antoine Martin to alas
status changed from assigned to new

Done: preparatory refactoring in r12810 + r12812, actual chunking code in r12813.

The files are now sent in chunks. We wait for the file chunk ack packet before sending the next chunk, which helps to ensure that we don't use up all the bandwidth, though it does reduce the throughput (only 4MB/s on a powerfull system loopback).

New tunables which should be self-explanatory:

XPRA_FILE_CHUNKS_SIZE=65536
XPRA_MAX_CONCURRENT_FILES=10

Here's what the transfer looks like with -d file for an ~80MB file upload to the server:

client side:

show_file_upload(<gtk.ImageMenuItem object at 0x7f95f25496e0 (GtkImageMenuItem at 0x56554cae59c0)>,) can open=False
load_contents: filename=/home/antoine/Downloads/NVIDIA-Linux-x86_64-361.45.11.run, 86205078 bytes, entity=1464443710:327571, response=-5
send_file('/home/antoine/Downloads/NVIDIA-Linux-x86_64-361.45.11.run', '', <type 'str'>, '86205078 bytes', False, False, {})
sha1 digest(/home/antoine/Downloads/NVIDIA-Linux-x86_64-361.45.11.run)=28d1586dd300c04f2e1ce66604a939bccfa51fa6
ack-file-chunk: ['9f4c40d1ebf74aa69f02e8ebd866786c', True, '', 0]
ack-file-chunk: ['9f4c40d1ebf74aa69f02e8ebd866786c', True, '', 1]
...
ack-file-chunk: ['9f4c40d1ebf74aa69f02e8ebd866786c', True, '', 1316]
1316 chunks of 65536 bytes sent in 17338ms (4MB/s)
_check_chunk_sending(9f4c40d1ebf74aa69f02e8ebd866786c, 1316) chunk_state found: False

server side:

receiving file: ['bigfile', '', False, False, 86205078, '0 bytes', {'file-chunk-id': '9f4c40d1ebf74aa69f02e8ebd866786c', 'sha1': '28d1586dd300c04f2e1ce66604a939bccfa51fa6'}]
using filename 'bigfile'
_process_send_file_chunk('9f4c40d1ebf74aa69f02e8ebd866786c', 1, '65536 bytes', True)
_process_send_file_chunk('9f4c40d1ebf74aa69f02e8ebd866786c', 2, '65536 bytes', True)
...
sha1 digest matches: 28d1586dd300c04f2e1ce66604a939bccfa51fa6
86205078 bytes received in 1316 chunks, took 16769ms
downloaded 86205078 bytes to temporary file:
 '/home/guest/Downloads/bigfile'

@afarr: ready for testing, you should now be able to send or print big files without causing much of a slow down for anything else. Logging was also improved, small bugs fixed along the way. (I may backport some)

Mon, 13 Jun 2016 21:25:14 GMT - J. Max Mena: owner changed

owner changed from alas to Antoine Martin

Did some testing of trunk r12814 file uploads (Fedora 23 both ends):

All good with sending files - doesn't seem to hang anything anywhere.

Of note:

The select file dialogue will hang for a solid second or two if you try to upload a large file

Tue, 14 Jun 2016 10:05:31 GMT - Antoine Martin: owner changed

owner changed from Antoine Martin to alas

r12815 closes the dialog more quickly and loads the file in the background as much as possible.

Tue, 12 Jul 2016 16:52:22 GMT - Antoine Martin: milestone changed

milestone changed from 0.18 to 1.0

Milestone renamed

Thu, 29 Sep 2016 00:58:37 GMT - alas: owner changed

owner changed from alas to Antoine Martin

Tested with a 1.0 r13101 win32 client against a 1.0 r13902 fedora 23 server.

Dialog closes very quickly, whether I'm uploading a 4 kb file or a 68 MB file, or even if I'm uploading a 218 MB file... though there wasn't anything to let me know that the 218 MB file was too ambitious, until I noticed the client side warning:

2016-09-28 17:31:12,180 Warning: cannot upload the file 'sound-test-weekend-log.txt'
2016-09-28 17:31:12,180  this file is too large: 218MB
2016-09-28 17:31:12,181  the local file size limit is 100MB

The session wasn't in any way impacted while uploading a 68 MB file though... so, other than considering a popup to warn a user of overzealous ambitions, I think this is ready to close.

Thu, 29 Sep 2016 03:59:33 GMT - Antoine Martin: attachment set

attachment set to file-alert-dialog.png

new alert dialog

Thu, 29 Sep 2016 04:01:06 GMT - Antoine Martin: owner changed

owner changed from Antoine Martin to alas

Good point. Alert dialog added in r13903, looks like this:

We also check the file size sooner and avoid trying to load really big files into memory before showing the error.

Fri, 30 Sep 2016 22:15:54 GMT - J. Max Mena: status changed; resolution set

status changed from new to closed
resolution set to fixed

r13937 Trunk Windows 8.1 client against an r13937 Trunk Fedora 23 machine:

Error noted in the popup (edited) when attempting to upload a 1.7GB ISO.

Not much else left here, closing.

Wed, 15 Nov 2017 12:04:04 GMT - Antoine Martin:

Sat, 23 Jan 2021 05:12:52 GMT - migration script:

this ticket has been moved to: https://github.com/Xpra-org/xpra/issues/1026