Show Inaccuracy Warning on permission error #270

Veykril · 2018-10-01T16:29:39Z

This PR roughly implements issue #165. I am sure there is room for some improvements on my code changes so feel free to comment on everything I changed. One thing I dislike that I did is this weird if let bundle I created to check for a permission error at one place:
https://github.com/Veykril/tokei/blob/0c7e18d1b0b45832c40c3a991be4bd57111ff5e5/src/utils/fs.rs#L52-L61
I couldnt come up with a better way since the nested errors are boxed and box patterns arent stable yet.

Example Output:

C:\Workspace\Rust\tokei (error_output -> origin)                                                                       
λ cargo run -- C:\Workspace\Rust\test                                                                                  
    Finished dev [unoptimized + debuginfo] target(s) in 0.18s                                                          
     Running `target\debug\tokei.exe C:\Workspace\Rust\test`                                                           
ERROR 2018-10-01T16:28:56Z: tokei::utils::fs: Permission denied for reading C:\Workspace\Rust\test\Cargo.toml          
Note: results can be inaccurate for languages marked with '(!)'                                                        
-----------------------------------------------------------------------------------------------------------------------
 Language                                                    Files        Lines         Code     Comments       Blanks 
-----------------------------------------------------------------------------------------------------------------------
 Markdown                                                        4         1380         1380            0            0 
 Rust                                                            1          123           99            1           23 
 Shell                                                           1           40           29            1           10 
 TOML (!)                                                        1           84           69            0           15 
 YAML                                                            1           80           60            8           12 
-----------------------------------------------------------------------------------------------------------------------
 Total (!)                                                        8         1707         1637           10           60
-----------------------------------------------------------------------------------------------------------------------

Veykril · 2018-10-05T14:54:01Z

@Aaronepower sorry for pinging you but I wasnt sure whether you didn't see this PR or not

XAMPPRocky · 2018-10-06T20:08:00Z

@Veykril Sorry, yes I did see it. I have a problem where if I'm unsure about a feature I tend to not reply till I have a more definitive answer 😅. Could you run benchmark.sh in the root of the repo and post the output here?

Veykril · 2018-10-06T20:53:12Z

I was concerned about the performance impact of this as well but i couldn't think of a different way to implement this.

Benchmark 1: tokei "C:WorkspaceRusttokei"  
Summary
Time (mean ± σ):      13.1 ms ±   2.1 ms    [User: 5.3 ms, System: 4.3 ms]
Range (min … max):    10.1 ms …  22.9 ms

Benchmark 2: tokei "C:WorkspaceRusttokei"
Time (mean ± σ):      14.2 ms ±   2.9 ms    [User: 4.2 ms, System: 5.5 ms]
Range (min … max):    10.0 ms …  26.0 ms
Summary
  'tokei.exe "C:WorkspaceRusttokei"' ran
    1.08 ± 0.28 times faster than 'tokei "C:WorkspaceRusttokei"'

I don't think these are accurate though, my machine isnt the best to benchmark things + Im running windows so im not too sure how well that goes.

XAMPPRocky · 2018-10-07T15:38:27Z

@Veykril Sorry, could you run the benchmark on a larger repo such as the rust repo? Also could you have two benchmarks, one with no warnings and one with a warning?

Veykril · 2018-10-07T16:09:00Z

No problem, i can see your concern over this since your tool should stay as fast as possible.

I ran it on the rust repo now and I moved and renamed my exe out of the build dir cause i wasnt sure how windows handles path exes and the exes in the current dir, so iwanted to be safe that it actually executes my build.

Output without an error: https://pastebin.com/3xHqpUJT
Output with an error: https://pastebin.com/ALFnSJqx

XAMPPRocky · 2018-10-15T23:36:54Z

@Veykril Sorry about this, I've since made a large scale refactor to the codebase that makes the changes here incompatible. You'll need to rewrite some of this for it to be accepted.

Veykril · 2018-10-16T12:50:34Z

No problem, will look into your changes sometime later this week and try to adapt my PR to that

Veykril · 2018-10-18T15:25:06Z

Alright, I adapted the changes and tested them. From what I have seen I didnt have to change much unless I've overlooked something. I also fixed an output bug that I didnt even notice at first, as you can see in the example output text from the PR, the total section wasnt correctly aligned. That shouldnt happen anymore now.

XAMPPRocky · 2018-10-19T14:11:19Z

src/language/mod.rs

@@ -104,6 +112,9 @@ impl AddAssign for Language {
        self.blanks += rhs.blanks;
        self.code += rhs.code;
        self.stats.extend(mem::replace(&mut rhs.stats, Vec::new()));
+        if rhs.inaccurate {
+            self.inaccurate = rhs.inaccurate


Can you remove the if statement and replace with the following?

Suggested change

self.inaccurate = rhs.inaccurate

self.inaccurate |= rhs.inaccurate

src/language/language_type.rs

XAMPPRocky · 2018-10-19T14:38:04Z

src/language/language_type.rs


+    /// Parses the text provided.
+    pub fn parse_from_str_with_accuracy(self, path: PathBuf, text: &str) -> Stats


Why is parse_from_str_with_accuracy necessary?

oh it actually isnt now that you say it, i was just confused as to why parse_from_strreturns a result when it never returns an error. Probably due to previous implementations I guess? Will remove the function again

XAMPPRocky · 2018-10-20T12:43:04Z

src/utils/fs.rs

+                    use ignore::Error;
+                    if let Error::WithDepth { err: ref error, .. } = error {
+                        if let Error::WithPath { ref path, err: ref error } = **error {
+                            if let Error::Io(ref error) = **error {


I think we can condense this code. Instead of just checking for Permission denied, couldn't we use the following?

error!("{} reading {}", error.description(), path.display());

Yep, this is indeed better, I guess I was too focused on the PermissionDenied error there. Looks a lot better like this and makes more sense overall

XAMPPRocky

I have a few last change requests 😅 Thank you for your PR and your patience through this process.

src/language/language_type.rs

XAMPPRocky · 2018-10-20T14:19:17Z

src/language/language_type.rs

            s
        };
-
-        self.parse_from_str(path, &text)
+        Ok(self.parse_from_str(path, &text).unwrap())


Can you remove the Ok() and the unwrap()?

Oh right, I did this cause the results have different error cases and parse_from_str cannot fail from its implementation. Probably a bad idea to unwrap though since the implementation could change. Will have to do the same if let Err instead of map_err though due to the closure move that would happen otherwise though

Actually i have a problem here in general cause the parse_from_str error that wouldnt happen in its current implementation doesnt give back the pathbuf, so I am not sure how to even map the error here

XAMPPRocky · 2018-10-20T14:20:03Z

src/language/language_type.rs

    }

    /// Parses the text provided. Returning `Stats` on success.
-    pub fn parse_from_str(self, path: PathBuf, text: &str)
-        -> io::Result<Stats>
+    pub fn parse_from_str(self, path: PathBuf, text: &str) -> io::Result<Stats>


Can you revert the style changes on this method? I prefer the style used previously.

src/language/language_type.rs

Veykril · 2018-10-20T15:08:15Z

No problem, I am still learning you pointing all these things out is only helping me in the end. Better to do this properly than just letting everything through 👍

XAMPPRocky · 2018-10-21T12:01:31Z

@Veykril Okay, I think if you could make the style change and resolve the conflicts this is ready to merge in.

XAMPPRocky · 2018-10-21T13:17:19Z

Haha, sorry you actually can break the API as I'm going to be making some changes that would also break the API so we might as well break them both in the same release.

Veykril · 2018-10-22T14:53:00Z

So i can change the function signatures as I please?

XAMPPRocky · 2018-10-23T17:09:11Z

@Veykril Remove the accuracy functions and change to the API of the current ones.

Veykril · 2018-10-25T13:54:18Z

I suppose this is what you meant right? I hope

XAMPPRocky · 2018-11-09T12:22:21Z

Okay, this PR looks good to me. Thank you again for your PR and for making the requested changes!

inaccuracy warning

0c7e18d

adapt to upstream changes

a947495

XAMPPRocky reviewed Oct 19, 2018

View reviewed changes

src/language/language_type.rs Show resolved Hide resolved

XAMPPRocky reviewed Oct 19, 2018

View reviewed changes

src/language/language_type.rs Show resolved Hide resolved

revert accidental api changes

44def19

XAMPPRocky reviewed Oct 19, 2018

View reviewed changes

remove unnecessary function

e5fc8f7

XAMPPRocky reviewed Oct 20, 2018

View reviewed changes

remove error if nesting

4c37f1b

XAMPPRocky requested changes Oct 20, 2018

View reviewed changes

fix upstream conflicts

834a6c1

revert accidental style change

094df4e

change api

bcce0b5

XAMPPRocky approved these changes Nov 9, 2018

View reviewed changes

XAMPPRocky merged commit 51ecef4 into XAMPPRocky:master Nov 9, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show Inaccuracy Warning on permission error #270

Show Inaccuracy Warning on permission error #270

Veykril commented Oct 1, 2018

Veykril commented Oct 5, 2018

XAMPPRocky commented Oct 6, 2018

Veykril commented Oct 6, 2018

XAMPPRocky commented Oct 7, 2018 •

edited

Loading

Veykril commented Oct 7, 2018 •

edited

Loading

XAMPPRocky commented Oct 15, 2018

Veykril commented Oct 16, 2018

Veykril commented Oct 18, 2018 •

edited

Loading

XAMPPRocky Oct 19, 2018 •

edited

Loading

XAMPPRocky Oct 19, 2018

Veykril Oct 19, 2018

XAMPPRocky Oct 20, 2018 •

edited

Loading

Veykril Oct 20, 2018

XAMPPRocky left a comment

XAMPPRocky Oct 20, 2018

Veykril Oct 20, 2018

Veykril Oct 20, 2018

XAMPPRocky Oct 20, 2018

Veykril commented Oct 20, 2018

XAMPPRocky commented Oct 21, 2018

XAMPPRocky commented Oct 21, 2018

Veykril commented Oct 22, 2018

XAMPPRocky commented Oct 23, 2018

Veykril commented Oct 25, 2018

XAMPPRocky commented Nov 9, 2018

	self.inaccurate = rhs.inaccurate
	self.inaccurate \|= rhs.inaccurate


		/// Parses the text provided.
		pub fn parse_from_str_with_accuracy(self, path: PathBuf, text: &str) -> Stats

Show Inaccuracy Warning on permission error #270

Show Inaccuracy Warning on permission error #270

Conversation

Veykril commented Oct 1, 2018

Veykril commented Oct 5, 2018

XAMPPRocky commented Oct 6, 2018

Veykril commented Oct 6, 2018

XAMPPRocky commented Oct 7, 2018 • edited Loading

Veykril commented Oct 7, 2018 • edited Loading

XAMPPRocky commented Oct 15, 2018

Veykril commented Oct 16, 2018

Veykril commented Oct 18, 2018 • edited Loading

XAMPPRocky Oct 19, 2018 • edited Loading

Choose a reason for hiding this comment

XAMPPRocky Oct 19, 2018

Choose a reason for hiding this comment

Veykril Oct 19, 2018

Choose a reason for hiding this comment

XAMPPRocky Oct 20, 2018 • edited Loading

Choose a reason for hiding this comment

Veykril Oct 20, 2018

Choose a reason for hiding this comment

XAMPPRocky left a comment

Choose a reason for hiding this comment

XAMPPRocky Oct 20, 2018

Choose a reason for hiding this comment

Veykril Oct 20, 2018

Choose a reason for hiding this comment

Veykril Oct 20, 2018

Choose a reason for hiding this comment

XAMPPRocky Oct 20, 2018

Choose a reason for hiding this comment

Veykril commented Oct 20, 2018

XAMPPRocky commented Oct 21, 2018

XAMPPRocky commented Oct 21, 2018

Veykril commented Oct 22, 2018

XAMPPRocky commented Oct 23, 2018

Veykril commented Oct 25, 2018

XAMPPRocky commented Nov 9, 2018

XAMPPRocky commented Oct 7, 2018 •

edited

Loading

Veykril commented Oct 7, 2018 •

edited

Loading

Veykril commented Oct 18, 2018 •

edited

Loading

XAMPPRocky Oct 19, 2018 •

edited

Loading

XAMPPRocky Oct 20, 2018 •

edited

Loading