Implement FolderFileWatcher #2336

msftrubengu · 2022-07-13T19:58:38Z

Implement wrapper around wil::unique_folder_change_reader to track new files created under a directory.

FolderFileWatcher: watch for new files on a given directory and an optional extension.

Also Visual Studio 2022 removing some extra spaces in vcproj files

Microsoft Reviewers: Open in CodeFlow

github-actions · 2022-07-13T20:00:02Z

@check-spelling-bot Report

Unrecognized words, please review:

tmp

Previously acknowledged words that are now absent

activatable amd Archs dsc efgh enr FWW Globals hackathon lww mytool OSVERSION Packagedx parametermap pathpaths symlink Uninitialize WDAG whatif wsb

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the git@github.com:msftrubengu/winget-cli.git repository
on the filewatcher branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/winget-cli/issues/comments/1183622677" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

JohnMcPMS · 2022-07-13T20:50:30Z

src/AppInstallerCommonCore/pch.h

 #include <vector>
+#include <unordered_set>


Suggested change

#include <vector>

#include <unordered_set>

#include <unordered_set>

#include <vector>

T U V #Resolved

JohnMcPMS · 2022-07-13T20:52:20Z

src/AppInstallerCommonCore/Public/winget/FolderFileWatcher.h

+namespace AppInstaller::Utility
+{
+    // Watch for new/renamed files recursively in a given directory.
+    struct FolderFileWatcher


Isn't a FolderFileWatcher just a FolderFileExtensionWatcher with a null_opt optional extension to look for? #Resolved

JohnMcPMS · 2022-07-13T20:53:24Z

src/AppInstallerCommonCore/Public/winget/FolderFileWatcher.h

+        FolderFileWatcher(FolderFileWatcher&&) = delete;
+        FolderFileWatcher& operator=(FolderFileWatcher&&) = delete;
+
+        void start();


Suggested change

void start();

void Start();

Uppercase function names. #Resolved

JohnMcPMS · 2022-07-13T20:54:29Z

src/AppInstallerCommonCore/FolderFileWatcher.cpp

+    {
+        if (m_changeReader)
+        {
+            this->stop();


This seems unnecessary so long as Stop is implemented as delete m_changeReader which will happen at the end of the function anyway. #Resolved

JohnMcPMS · 2022-07-13T20:55:53Z

src/AppInstallerCommonCore/Public/winget/FolderFileWatcher.h

+    private:
+        std::filesystem::path m_path;
+        std::string m_ext;
+        std::unordered_set<std::string> m_files;


Suggested change

std::unordered_set<std::string> m_files;

std::unordered_set<std::filesystem::path> m_files;

Why not this? #Resolved

JohnMcPMS · 2022-07-13T20:56:58Z

src/AppInstallerCommonCore/FolderFileWatcher.cpp

+                // The file was renamed and this is the new name.
+                case wil::FolderChangeEvent::RenameNewName:
+                {
+                    std::filesystem::path path = m_path / std::filesystem::path(filePath);


I would think it fine to store just the relative path if that is what we are given. The user of this can recombine the two if they want. #Resolved

github-actions · 2022-07-15T20:05:47Z

@check-spelling-bot Report

Unrecognized words, please review:

tmp

Previously acknowledged words that are now absent

activatable amd Archs dsc efgh enr FWW Globals hackathon lww mytool OSVERSION Packagedx parametermap pathpaths symlink Uninitialize WDAG whatif wsb

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the git@github.com:msftrubengu/winget-cli.git repository
on the filewatcher branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/winget-cli/issues/comments/1185871241" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

msftrubengu added 3 commits July 12, 2022 14:03

FolderFileWatcher

21bb46b

c_str

aacacee

Remove header

b891e5d

msftrubengu requested a review from a team as a code owner July 13, 2022 19:58

JohnMcPMS requested changes Jul 13, 2022

View reviewed changes

ghost added the Needs-Author-Feedback Issue needs attention from issue or PR author label Jul 13, 2022

msftrubengu added 2 commits July 15, 2022 12:38

Internal compiler error

078df1f

VS 22 hates me

300b9de

ghost removed the Needs-Author-Feedback Issue needs attention from issue or PR author label Jul 15, 2022

Merge remote-tracking branch 'upstream/master' into filewatcher

14a5a25

JohnMcPMS approved these changes Jul 20, 2022

View reviewed changes

msftrubengu added 2 commits July 21, 2022 11:29

Merge remote-tracking branch 'upstream/master' into filewatcher

141f641

Remove string()

0d643c9

msftrubengu merged commit baf0a49 into microsoft:master Jul 21, 2022

msftrubengu deleted the filewatcher branch November 15, 2022 00:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement FolderFileWatcher #2336

Implement FolderFileWatcher #2336

msftrubengu commented Jul 13, 2022 •

edited

Loading

github-actions bot commented Jul 13, 2022 •

edited

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading

	std::unordered_set<std::string> m_files;
	std::unordered_set<std::filesystem::path> m_files;

Implement FolderFileWatcher #2336

Implement FolderFileWatcher #2336

Conversation

msftrubengu commented Jul 13, 2022 • edited Loading

Microsoft Reviewers: Open in CodeFlow

github-actions bot commented Jul 13, 2022 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

JohnMcPMS Jul 13, 2022 • edited by msftrubengu Loading

Choose a reason for hiding this comment

github-actions bot commented Jul 15, 2022 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

msftrubengu commented Jul 13, 2022 •

edited

Loading

github-actions bot commented Jul 13, 2022 •

edited

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

JohnMcPMS Jul 13, 2022 •

edited by msftrubengu

Loading

github-actions bot commented Jul 15, 2022 •

edited

Loading