gui: Remaining sync bytes in folder header (fixes #3908) #3928

benshep · 2017-01-24T14:57:35Z

The progress indicator in the folder header in the GUI now shows the
remaining bytes to sync as well as the percentage.

The progress indicator in the folder header in the GUI now shows the remaining bytes to sync as well as the percentage.

canton7 · 2017-01-24T14:59:39Z

gui/default/syncthing/core/syncthingController.js

+            }
+
+            var bytes = $scope.model[folder].globalBytes - $scope.model[folder].inSyncBytes;
+			if (isNaN(bytes)) {


canton7 · 2017-01-24T14:59:44Z

gui/default/syncthing/core/syncthingController.js

@@ -722,6 +722,26 @@ angular.module('syncthing.core')
            return Math.floor(pct);
        };

+        $scope.syncRemaining = function (folder) {
+			// Formats the remaining sync bytes into a string with a suffix


Got a bit of a tab/space mixup here, by the looks of things.

AudriusButkevicius · 2017-01-24T15:01:42Z

A screenshot how this looks would be nice.

calmh

Need screenshot. :)

calmh · 2017-01-24T15:01:31Z

gui/default/syncthing/core/syncthingController.js

+			if (isNaN(bytes)) {
+				return 0;
+			}
+			var k = 1024;


We have a directive for this, {{ ... | binary}} I think.

calmh · 2017-01-24T15:02:07Z

gui/default/index.html

@@ -285,7 +285,7 @@ <h4 class="panel-title">
                  <span ng-switch-when="idle"><span class="hidden-xs" translate>Up to Date</span><span class="visible-xs">&#9724;</span></span>
                  <span ng-switch-when="syncing">
                    <span class="hidden-xs" translate>Syncing</span>
-                    ({{syncPercentage(folder.id)}}%)
+                    ({{syncPercentage(folder.id)}}%, {{syncRemaining(folder.id)}})


It seems that it might be unclear what the amount means. Size? Transferred? Remaining?

I was trying to make it concise! Could add "to go" I suppose, but I think it should be pretty clear when you watch it for a few seconds and it goes down.

Tabs -> spaces

Gets rid of nasty transient 'NaN' display on start of sync.

benshep · 2017-01-24T15:10:05Z

Here's a screenshot.

I fixed the tab thing, and also put in an extra check for zero.

calmh · 2017-01-24T15:22:57Z

I think my comment about the directive got lost in the indentation change. There is no need to do formatting, we have a binary directive. Check the other places that display byte counts.

AudriusButkevicius · 2017-01-24T16:58:10Z

I am still of an opinion that we're duplicating stuff, and I agree that it's not obvious what that number actually means, but I am not against it given you've produced a PR.

uok · 2017-01-24T17:27:40Z

Looks like a good improvement, but I'm not sure about screen space on smaller screens. Keep in mind that some translations are a lot longer than "syncing". I was thinking about two lines, also adding ETA (#899) to the mix: e.g. first line "Syncing (55%)", second line "40 MB, 1h 3min"

calmh · 2017-01-24T17:34:48Z

There is literally no way to guess ETA from the outside. We have no idea at what rate their sync progresses. Also, they may have 250 GiB out of sync, and we'll show "250 GiB" with this change, but that might be a change to the permissions bits of a 250 GiB file which takes literally zero time and nothing to transfer or copy. This is one of the things I mentioned in the original issue - this number doesn't actually mean what most people would think it means.

imsodin · 2017-01-24T17:44:16Z

The same argument applies to the sync percentage, making it useless in such a scenario, right?
The reason why I like displaying the absolute number of bytes more than percentage is mentioned in the original issue: No matter how big the folder, you will get some progress report. With the relative percentage it just duplicates the "syncing" (=99%) - "idle" (=100%) indication.

fti7 · 2017-01-25T01:30:36Z

+1 i think it could be an improvement in terms of showing progress to the User. You might want to use an icon to indicate what the Number does.
Of course it should be self-explanatory if the refresh interval is high enough/the decrease is fluid/snappy

ETA / Transferate would also be nice... but of course we need to gather this Data somehow first.
Also multiline might be an good Option.

Or Multiline:

@calmh

No need to do formatting in syncRemaining function, thanks @calmh.

benshep · 2017-01-25T09:07:17Z

@uok The longest I can find is Turkish! But the GUI seems to resize very gracefully on narrower displays. The box first expands vertically to accommodate the text:

Then the "Syncing" text is hidden altogether, so it's less of an issue:

The only GUI issue I can see is the "Syncing" text overlaps with the computer name in the right-hand box:

But that's a totally separate issue.

benshep · 2017-01-25T09:13:00Z

@calmh Yes, I get that showing ETA is hard. That should be a separate issue if people want it. I see your point that 250GiB might not mean 250GiB to transfer. I have some multi-GiB virtual machine files, and they usually sync very fast due to the hashing thing (thanks for that, BTW!). But in my "normal" use-case (which I admit might not be everyone's), 250GiB usually does mean 250GiB to transfer, and so it's usually meaningful. In any case, it's a conservative estimate, right?

benshep · 2017-01-25T09:18:27Z

@fti7 Nice mockups, but that text is a bit small. The idea of this is really an at-a-glance indication of how much is left to transfer.

@fti7

Small down-pointing triangle next to "syncRemaining" byte count (thanks @fti7).

benshep · 2017-01-25T09:21:50Z

@fti7 Here's one with a little icon.

uok · 2017-01-25T09:45:26Z

Nice mockups, I really like the multi line with ETA very much! 👍
For me "ETA = (remaining size per folder / current global speed)" would be enough although I know that Syncthing re-uses blocks, etc. it would just be a rough estimate. But if your are e.g. on a mobile connection it would give you something to work with.

If we just keep % and MB at the moment, I think the little icon is not needed, maybe use | or - as a separator.

calmh · 2017-01-25T10:10:10Z

current global speed

There is no such thing that we're currently aware of. Not that a device couldn't itself tell us this, it's just not part of the protocol at the moment.

Ferroin · 2017-01-25T12:34:48Z

I'd argue that the icon shown could be misunderstood to indicate that the given number is the download rate, not the amount remaining.

I also kind of agree with @uo, regarding the ETA, but some slightly more complicated math would give a better estimate, Something along the lines of:
(total remaining data for this folder / (current download speed / % of total state across all folders that need to be synced that this folder requires))
should give a slightly more accurate representation. FWIW that's essentially the math used by most web browsers and download managers, they just don't need the division to calculate the stream bandwidth for each file because each file is it's own stream.

This reverts commit ba8934a.

benshep · 2017-01-25T12:59:12Z

OK, removed the icon.

calmh · 2017-01-25T18:17:11Z

Ok, lets shelf the discussions on a theoretical ETA and transfer rate that is not currently in evidence and focus on the PR at hand...

@benshep I'm mostly fine with this. I'd like to preemptively suggest only showing it when the number is >0 though. There are known cases where it will turn negative, which already affects the percentage weirdly. We don't need to add insult to injury by also claiming that there are -542 KiB left to sync.

In edge cases, bytes remaining may show less than zero. Return zero in these cases.

If remaining bytes evaluates to zero (including negative or NaN), hide the (100%, 0 B) part.

benshep · 2017-01-26T08:47:00Z

Slightly out of scope of this issue, but now the percentage and bytes are hidden when there's nothing useful to show (100%, 0 B).

calmh · 2017-01-26T09:39:27Z

All good

calmh · 2017-01-26T09:39:43Z

@st-review merge it

st-review · 2017-01-26T09:39:51Z

👌 Merged as e03be91. Thanks, @benshep!

The progress indicator in the folder header in the GUI now shows the remaining bytes to sync as well as the percentage. GitHub-Pull-Request: #3928

calmh · 2017-01-26T09:40:34Z

(For the record, in much of the discussion above I was, erroneously, thinking about showing this for remote devices, not local folders. My misunderstanding. We can of course calculate a sync rate and an ETA locally. Carry on.)

gui: Remaining sync bytes in folder header (fixes syncthing#3908)

cde5da1

The progress indicator in the folder header in the GUI now shows the remaining bytes to sync as well as the percentage.

canton7 reviewed Jan 24, 2017

View reviewed changes

calmh reviewed Jan 24, 2017

View reviewed changes

benshep added 2 commits January 24, 2017 15:06

Fix indentation

e95d038

Tabs -> spaces

Check for zero

7b0e010

Gets rid of nasty transient 'NaN' display on start of sync.

benshep added 2 commits January 25, 2017 08:47

Use binary directive

22dabb6

No need to do formatting in syncRemaining function, thanks @calmh.

Merge branch 'master' into master

2f5abb5

Icon next to syncRemaining

ba8934a

Small down-pointing triangle next to "syncRemaining" byte count (thanks @fti7).

Revert "Icon next to syncRemaining"

89ebf28

This reverts commit ba8934a.

benshep added 2 commits January 26, 2017 07:58

syncRemaining: return zero when bytes < 0

dc5fbd3

In edge cases, bytes remaining may show less than zero. Return zero in these cases.

Only show (%, bytes) when not zero

b15704a

If remaining bytes evaluates to zero (including negative or NaN), hide the (100%, 0 B) part.

st-review closed this Jan 26, 2017

st-review pushed a commit that referenced this pull request Jan 26, 2017

gui: Remaining sync bytes in folder header (fixes #3908)

e03be91

The progress indicator in the folder header in the GUI now shows the remaining bytes to sync as well as the percentage. GitHub-Pull-Request: #3928

st-review added the pr-merged Legacy label used in the past for pull requests merged to the main tree label Jan 15, 2018

st-review added the frozen-due-to-age Issues closed and untouched for a long time, together with being locked for discussion label Jul 15, 2018

syncthing locked and limited conversation to collaborators Jul 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gui: Remaining sync bytes in folder header (fixes #3908) #3928

gui: Remaining sync bytes in folder header (fixes #3908) #3928

benshep commented Jan 24, 2017

canton7 Jan 24, 2017

canton7 Jan 24, 2017

AudriusButkevicius commented Jan 24, 2017

calmh left a comment

calmh Jan 24, 2017

calmh Jan 24, 2017

benshep Jan 24, 2017

benshep commented Jan 24, 2017

calmh commented Jan 24, 2017

AudriusButkevicius commented Jan 24, 2017

uok commented Jan 24, 2017 •

edited

calmh commented Jan 24, 2017

imsodin commented Jan 24, 2017

fti7 commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

uok commented Jan 25, 2017 •

edited

calmh commented Jan 25, 2017 •

edited

Ferroin commented Jan 25, 2017

benshep commented Jan 25, 2017

calmh commented Jan 25, 2017

benshep commented Jan 26, 2017

calmh commented Jan 26, 2017

calmh commented Jan 26, 2017

st-review commented Jan 26, 2017

calmh commented Jan 26, 2017

gui: Remaining sync bytes in folder header (fixes #3908) #3928

gui: Remaining sync bytes in folder header (fixes #3908) #3928

Conversation

benshep commented Jan 24, 2017

canton7 Jan 24, 2017

Choose a reason for hiding this comment

canton7 Jan 24, 2017

Choose a reason for hiding this comment

AudriusButkevicius commented Jan 24, 2017

calmh left a comment

Choose a reason for hiding this comment

calmh Jan 24, 2017

Choose a reason for hiding this comment

calmh Jan 24, 2017

Choose a reason for hiding this comment

benshep Jan 24, 2017

Choose a reason for hiding this comment

benshep commented Jan 24, 2017

calmh commented Jan 24, 2017

AudriusButkevicius commented Jan 24, 2017

uok commented Jan 24, 2017 • edited

calmh commented Jan 24, 2017

imsodin commented Jan 24, 2017

fti7 commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

benshep commented Jan 25, 2017

uok commented Jan 25, 2017 • edited

calmh commented Jan 25, 2017 • edited

Ferroin commented Jan 25, 2017

benshep commented Jan 25, 2017

calmh commented Jan 25, 2017

benshep commented Jan 26, 2017

calmh commented Jan 26, 2017

calmh commented Jan 26, 2017

st-review commented Jan 26, 2017

calmh commented Jan 26, 2017

uok commented Jan 24, 2017 •

edited

uok commented Jan 25, 2017 •

edited

calmh commented Jan 25, 2017 •

edited