[vcpkg] update telemetry

docs/about/privacy.md

@@ -1,22 +1,46 @@
+## vcpkg telemetry and privacy
 
-# Privacy and Vcpkg
+vcpkg collects telemetry data to understand usage issues, such as failing packages, and to guide tool improvements. The collected data is anonymous.
+For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-US/privacystatement#mainenterprisedeveloperproductsmodule 
 
-## Do you collect telemetry data? What is it used for?
+# Scope
 
-We do collect telemetry data from usage of "vcpkg.exe". We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. We use this information to understand usage issues, such as failing packages, and to guide tool improvements.
+We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. Telemetry is collected when using any of the `vcpkg` commands, such as:
 
-## What telemetry is collected?
+```
+vcpkg install
+vcpkg build
+```
 
-We collect the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
-In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
+# How to opt out
+
+The vcpkg telemetry feature is enabled by default. In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
 
 ```PS> .\bootstrap-vcpkg.bat -disableMetrics```
 
 ```~/$ ./bootstrap-vcpkg.sh -disableMetrics```
 
-For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy.
+# Disclosure
 
-Here is an example of an event for the command line `vcpkg install zlib`:
+vcpkg displays text similar to the following when you build vcpkg. This is how Microsoft notifies you about data collection.
+
+```
+Telemetry
+---------
+vcpkg collects usage data in order to help us improve your experience. The data collected by Microsoft is anonymous. You can opt-out of telemetry by adding -disableMetrics after the bootstrap-vcpkg script.
+
+Read more about vcpkg telemetry at docs/about/privacy.md
+```
+
+# Data Collected
+
+The telemetry feature doesn't collect personal data, such as usernames or email addresses. It doesn't scan your code and doesn't extract project-level data, such as name, repository, or author. The data is sent securely to Microsoft servers and held under restricted access.
+
+Protecting your privacy is important to us. If you suspect the telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, file an issue in the Microsoft/vcpkg repository or send an email to vcpkg@microsoft.com for investigation.
+
+We collect various telemetry events such as the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
+
+Here is an example of an event for the command line `vcpkg install zlib`. You can see the telemetry events any command by appending `--printmetrics` after the vcpkg command line.
 ```json
 [{
     "ver": 1,
@@ -46,6 +70,7 @@ Here is an example of an event for the command line `vcpkg install zlib`:
 ```
 In the source code (included in `toolsrc\`), you can search for calls to the functions `TrackProperty()` and `TrackMetric()` to see every specific data point we collect.
 
-## Is the data stored on my system?
+# Avoid inadvertent disclosure information 
 
-We store each event document in your temporary files directory. These will be cleaned out whenever you clear your temporary files.
+vcpkg contributors and anyone else running a version of vcpkg that they built themselves should consider the path to their source code. If a crash occurs when using vcpkg, the file path from the build machine is collected as part of the stack trace and isn't hashed.
+Because of this, builds of vcpkg shouldn't be located in directories whose path names expose personal or sensitive information.

scripts/bootstrap.ps1

@@ -412,6 +412,14 @@ if ($ec -ne 0)
 }
 Write-Host "`nBuilding vcpkg.exe... done.`n"
 
+Write-Host @"
+Telemetry
+---------
+vcpkg collects usage data in order to help us improve your experience. The data collected by Microsoft is anonymous. You can opt-out of telemetry by adding -disableMetrics after the bootstrap-vcpkg.bat script.
+Read more about vcpkg telemetry at docs/about/privacy.md
+
+"@
+
 Write-Verbose "Placing vcpkg.exe in the correct location"
 
 Copy-Item "$vcpkgReleaseDir\vcpkg.exe" "$vcpkgRootDir\vcpkg.exe"

scripts/bootstrap.sh

@@ -262,3 +262,9 @@ mkdir -p "$buildDir"
 
 rm -rf "$vcpkgRootDir/vcpkg"
 cp "$buildDir/vcpkg" "$vcpkgRootDir/"
+
+echo "Telemetry"
+echo "---------"
+echo "vcpkg collects usage data in order to help us improve your experience. The data collected by Microsoft is anonymous. You can opt-out of telemetry by adding -disableMetrics after the bootstrap-vcpkg.sh script."
+echo "Read more about vcpkg telemetry at docs/about/privacy.md"
+echo ""

toolsrc/src/vcpkg.cpp

@@ -304,7 +304,6 @@ int main(const int argc, const char* const* const argv)
     SetConsoleCP(CP_UTF8);
     SetConsoleOutputCP(CP_UTF8);
 
-    const std::string trimmed_command_line = trim_path_from_command_line(Strings::to_utf8(GetCommandLineW()));
 #endif
 
     Checks::register_global_shutdown_handler([]() {
@@ -335,9 +334,6 @@ int main(const int argc, const char* const* const argv)
     {
         auto locked_metrics = Metrics::g_metrics.lock();
         locked_metrics->track_property("version", Commands::Version::version());
-#if defined(_WIN32)
-        locked_metrics->track_property("cmdline", trimmed_command_line);
-#endif
     }
 
     System::register_console_ctrl_handler();

toolsrc/src/vcpkg/build.cpp

@@ -580,7 +580,15 @@ namespace vcpkg::Build
 
         {
             auto locked_metrics = Metrics::g_metrics.lock();
-            locked_metrics->track_buildtime(spec.to_string() + ":[" + Strings::join(",", config.feature_list) + "]",
+
+            locked_metrics->track_buildtime(Hash::get_string_hash(spec.to_string(), Hash::Algorithm::Sha256) + ":[" +
+                                                Strings::join(",",
+                                                              config.feature_list,
+                                                              [](std::string feature) {
+                                                                  return Hash::get_string_hash(feature,
+                                                                                               Hash::Algorithm::Sha256);
+                                                              }) +
+                                                "]",
                                             buildtimeus);
             if (return_code != 0)
             {

toolsrc/src/vcpkg/install.cpp

@@ -1,6 +1,7 @@
 #include "pch.h"
 
 #include <vcpkg/base/files.h>
+#include <vcpkg/base/hash.h>
 #include <vcpkg/base/system.print.h>
 #include <vcpkg/base/util.h>
 #include <vcpkg/build.h>
@@ -690,9 +691,9 @@ namespace vcpkg::Install
         // log the plan
         const std::string specs_string = Strings::join(",", action_plan, [](const AnyAction& action) {
             if (auto iaction = action.install_action.get())
-                return iaction->spec.to_string();
+                return Hash::get_string_hash(iaction->spec.to_string(), Hash::Algorithm::Sha256);
             else if (auto raction = action.remove_action.get())
-                return "R$" + raction->spec.to_string();
+                return "R$" + Hash::get_string_hash(raction->spec.to_string(), Hash::Algorithm::Sha256);
             Checks::unreachable(VCPKG_LINE_INFO);
         });
 

toolsrc/src/vcpkg/metrics.cpp

@@ -184,9 +184,15 @@ namespace vcpkg::Metrics
             if (buildtime_names.size() > 0)
             {
                 if (props_plus_buildtimes.size() > 0) props_plus_buildtimes.push_back(',');
-                props_plus_buildtimes.append(Strings::format(R"("buildnames": [%s], "buildtimes": [%s])",
-                                                             Strings::join(",", buildtime_names, to_json_string),
-                                                             Strings::join(",", buildtime_times)));
+                props_plus_buildtimes.append(
+                    Strings::format(R"("buildnames": [%s], "buildtimes": [%s])",
+                                    Strings::join(",",
+                                                  buildtime_names,
+                                                  [](std::string buildname) {
+                                                      return to_json_string(vcpkg::Hash::get_string_hash(
+                                                          buildname, Hash::Algorithm::Sha256));
+                                                  }),
+                                    Strings::join(",", buildtime_times)));
             }
 
             const std::string& session_id = get_session_id();