Add new event handler to allow tracking of progress of extraction progress for individual entry #226

gardebring · 2017-04-25T08:23:25Z

Add new event handler to allow tracking of progress of extraction progress for individual entry. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract.

This allows us to assign an event to the reader as such:
reader.EntryExtractionProgress += Reader_EntryExtractionProgress;

And then for example use it as such:
`
private int lastPercentage = -1;
//---//

private void Reader_EntryExtractionProgress(object sender, ReaderExtractionEventArgs e)
{
var progress = (SharpCompress.Readers.ReaderProgress)e.ParamList[0];
if (progress.PercentageRead % 10 == 0 && lastPercentage != progress.PercentageRead)
{
// Do something for every 10 percent of the extraction
}
}
`

…rocess. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract.

…action process. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract." This reverts commit 467fc2d.

…l entry when extracting an archive. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract.

adamhathcock · 2017-04-25T08:31:48Z

Why did you close the other PR to recreate it? My review comments are still the same: #225

gardebring · 2017-04-25T08:52:22Z

Hi. The code is completely rewritten so I thought it made sense to close the existing one and create a new instead. Sorry if it was confusing, was not my intention. The review comments in #225 is not really valid anymore since the code is now rewritten using an event handler instead.

adamhathcock · 2017-04-25T08:53:45Z

It's the same code on the same branch. Did you mean to make this pull request from a different branch other than gardebring:master ?

gardebring · 2017-04-25T08:59:52Z

Sorry but you lost me now.
The old code used an action as a parameter passed along. The new code use an event handler, so it is not the same code.
However, the PR do contain the old commits that were reverted.
So, first commit is old code, second is revert, third is the new code.
I can create a completely new PR with only the final change instead if you want. It will not have a functional difference, but the commit history will look nicer.

adamhathcock · 2017-04-25T09:35:10Z

So the code is correct as you only have your master branch. Pull Requests work per branch so it was updated when you pushed the latest changes.

My review from the other Pull Request is the same as this Pull Request as it's the same branch with the same code.

Ill just move over my comments.

adamhathcock · 2017-04-25T09:35:25Z

src/SharpCompress/Common/ReaderExtractionEventArgs.cs

        }

        public T Item { get; private set; }
+        public object[] ParamList { get; private set; }


Make this strongly typed. I don't see a need for this as is.

The idea here was to generalize what could be passed, but am I correct in assuming that you want ReaderProgress here instead of object[] ?

Yeah. We'll worry about other options later. No need to over genericize at the moment I think.

adamhathcock · 2017-04-25T09:35:42Z

src/SharpCompress/Readers/AbstractReader.cs

        {
            using (Stream s = OpenEntryStream())
            {
-                s.TransferTo(writeStream);
+                s.TransferTo(writeStream, (sizeTransferred, iterations) => streamListener.FireEntryExtractionProgress(Entry, sizeTransferred, iterations));


I guess this is okay. I wouldn't have a problem just duplicating the transfer code to have listening and not listening.

Kind of doesn't make sense to have a lambda just to call the listener when the listener can just be passed in.

adamhathcock · 2017-04-25T09:35:59Z

src/SharpCompress/Readers/IReader.cs

@@ -8,6 +8,7 @@ public interface IReader : IDisposable
    {
        event EventHandler<ReaderExtractionEventArgs<IEntry>> EntryExtractionBegin;


I would dump the Begin and End and only have Progress. They can check iterations or something to see if it's started.

I sort of agree, but this would break current implementations using those event handlers. Would this be ok?

Yeah, I break things all the time :)

I keep this library "beta" just because I haven't given things enough thought nor have the time to worry about API breaking on updates. Users should expect to at least recompile to find API breakages.

adamhathcock · 2017-04-25T09:36:10Z

src/SharpCompress/Readers/ReaderProgress.cs

+        public int Iterations { get; private set; }
+
+        public int PercentageRead => (int)Math.Round(PercentageReadExact);
+        public double PercentageReadExact => (float)BytesTransferred / _entry.Size * 100;


I like the way this was done

adamhathcock · 2017-04-25T09:36:23Z

src/SharpCompress/Utility.cs

@@ -229,15 +229,18 @@ public static DateTime DosDateToDateTime(Int32 iTime)
            return DosDateToDateTime((UInt32)iTime);
        }

-        public static long TransferTo(this Stream source, Stream destination)
+        public static long TransferTo(this Stream source, Stream destination, Action<long, int> action = null)


Again, I would just pass IStreamListener as an optional value like this.

As I stated, my thought process was to not introduce a new dependency into utility, but if you are fine with this I will change to that behavior.

This Utility won't be reused and it's just for the library. I'm fine with internal dependencies.

gardebring · 2017-04-25T10:19:17Z

Hi again and thanks for feedback. For some strange reason I could not see your code comments previously, which probably explains the confusion. I will look into them and get back to you.

…ener instead of passing an action lambda.

…s instead

gardebring · 2017-04-25T11:26:05Z

Alright, so I believe the requested changes now has been implemented. Let me know if there is anything else :)

Anders Gardebring added 3 commits April 20, 2017 11:45

Add new feature to allow injection of an action into the extraction p…

467fc2d

…rocess. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract.

Revert "Add new feature to allow injection of an action into the extr…

b8ef1ec

…action process. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract." This reverts commit 467fc2d.

Add new event to be able to track progress of extraction of individua…

683d271

…l entry when extracting an archive. This allows for showing or logging progress of the extraction process, especially useful for large files that might take a long time to extract.

adamhathcock requested changes Apr 25, 2017

View reviewed changes

Anders Gardebring added 3 commits April 25, 2017 12:36

Use strongly typed ReaderProgress instead of object[]

e05f984

Create new TransferTo method and pass Entry and IReaderExtractionList…

0990b06

…ener instead of passing an action lambda.

Remove begin and end events since this can now be tracked via progres…

2aa123c

…s instead

adamhathcock approved these changes Apr 25, 2017

View reviewed changes

adamhathcock merged commit bf55595 into adamhathcock:master Apr 25, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new event handler to allow tracking of progress of extraction progress for individual entry #226

Add new event handler to allow tracking of progress of extraction progress for individual entry #226

gardebring commented Apr 25, 2017

adamhathcock commented Apr 25, 2017

gardebring commented Apr 25, 2017

adamhathcock commented Apr 25, 2017

gardebring commented Apr 25, 2017 •

edited

Loading

adamhathcock commented Apr 25, 2017

adamhathcock Apr 25, 2017

gardebring Apr 25, 2017

adamhathcock Apr 25, 2017

adamhathcock Apr 25, 2017

adamhathcock Apr 25, 2017

gardebring Apr 25, 2017

adamhathcock Apr 25, 2017

adamhathcock Apr 25, 2017

adamhathcock Apr 25, 2017

gardebring Apr 25, 2017

adamhathcock Apr 25, 2017

gardebring commented Apr 25, 2017

gardebring commented Apr 25, 2017

		@@ -8,6 +8,7 @@ public interface IReader : IDisposable
		{
		event EventHandler<ReaderExtractionEventArgs<IEntry>> EntryExtractionBegin;

Add new event handler to allow tracking of progress of extraction progress for individual entry #226

Add new event handler to allow tracking of progress of extraction progress for individual entry #226

Conversation

gardebring commented Apr 25, 2017

adamhathcock commented Apr 25, 2017

gardebring commented Apr 25, 2017

adamhathcock commented Apr 25, 2017

gardebring commented Apr 25, 2017 • edited Loading

adamhathcock commented Apr 25, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gardebring commented Apr 25, 2017

gardebring commented Apr 25, 2017

gardebring commented Apr 25, 2017 •

edited

Loading