Make registries distinguish between 'baseline is broken' and 'baselin…

…e missing'. (#1203)

include/vcpkg/base/message-data.inc.h

@@ -283,10 +283,6 @@ DECLARE_MESSAGE(BaselineFileNoDefaultField,
                 (msg::commit_sha),
                 "",
                 "The baseline file at commit {commit_sha} was invalid (no \"default\" field).")
-DECLARE_MESSAGE(BaselineFileNoDefaultFieldPath,
-                (msg::path),
-                "",
-                "baseline file at {path} was invalid (no \"default\" field)")
 DECLARE_MESSAGE(BaselineGitShowFailed,
                 (msg::commit_sha),
                 "",
@@ -300,11 +296,6 @@ DECLARE_MESSAGE(BaselineMissing,
                 "git add versions\n"
                 "git commit -m \"Update version database\"\n"
                 "to set {version} as the baseline version.")
-DECLARE_MESSAGE(BaselineMissingDefault,
-                (msg::commit_sha, msg::url),
-                "",
-                "The baseline.json from commit `\"{commit_sha}\"` in the repo {url} was invalid (did not "
-                "contain a \"default\" field).")
 DECLARE_MESSAGE(BinaryCacheVendorHTTP, (), "", "HTTP servers")
 DECLARE_MESSAGE(BinarySourcesArg,
                 (),
@@ -914,10 +905,6 @@ DECLARE_MESSAGE(CouldNotDeduceNugetIdAndVersion,
                 (msg::path),
                 "",
                 "Could not deduce nuget id and version from filename: {path}")
-DECLARE_MESSAGE(CouldNotFindBaseline,
-                (msg::commit_sha, msg::path),
-                "",
-                "Could not find explicitly specified baseline `\"{commit_sha}\"` in baseline file {path}")
 DECLARE_MESSAGE(CouldNotFindBaselineInCommit,
                 (msg::url, msg::commit_sha, msg::package_name),
                 "",
@@ -1250,7 +1237,6 @@ DECLARE_MESSAGE(FailedToDetermineCurrentCommit, (), "", "Failed to determine the
 DECLARE_MESSAGE(FailedToDownloadFromMirrorSet, (), "", "Failed to download from mirror set")
 DECLARE_MESSAGE(FailedToExtract, (msg::path), "", "Failed to extract \"{path}\":")
 DECLARE_MESSAGE(FailedToFetchRepo, (msg::url), "", "Failed to fetch {url}.")
-DECLARE_MESSAGE(FailedToFindBaseline, (), "", "Failed to find baseline.json")
 DECLARE_MESSAGE(FailedToFindPortFeature,
                 (msg::feature, msg::package_name),
                 "",

include/vcpkg/paragraphparser.h

@@ -48,16 +48,10 @@ namespace vcpkg
     template<class P>
     using ParseExpected = vcpkg::ExpectedT<std::unique_ptr<P>, std::unique_ptr<ParseControlErrorInfo>>;
 
-    template<class P>
-    ExpectedL<P> map_parse_expected_to_localized_string(ParseExpected<P>&& parse_expected)
+    static constexpr struct ToLocalizedString_t
     {
-        if (auto value = parse_expected.get())
-        {
-            return std::move(**value);
-        }
-
-        return LocalizedString::from_raw(parse_expected.error()->to_string());
-    }
+        LocalizedString operator()(std::unique_ptr<ParseControlErrorInfo> p) const;
+    } ToLocalizedString;
 
     using Paragraph = std::map<std::string, std::pair<std::string, TextRowCol>, std::less<>>;
 

include/vcpkg/paragraphs.h

@@ -5,9 +5,13 @@
 #include <vcpkg/fwd/registries.h>
 
 #include <vcpkg/base/expected.h>
+#include <vcpkg/base/stringview.h>
 
 #include <vcpkg/sourceparagraph.h>
 
+#include <utility>
+#include <vector>
+
 namespace vcpkg::Paragraphs
 {
     uint64_t get_load_ports_stats();
@@ -22,11 +26,20 @@ namespace vcpkg::Paragraphs
 
     bool is_port_directory(const ReadOnlyFilesystem& fs, const Path& maybe_directory);
 
-    ParseExpected<SourceControlFile> try_load_port(const ReadOnlyFilesystem& fs, const Path& port_directory);
-    ParseExpected<SourceControlFile> try_load_port_text(const std::string& text,
-                                                        StringView origin,
-                                                        bool is_manifest,
-                                                        MessageSink& warning_sink);
+    // If an error occurs, the Expected will be in the error state.
+    // Otherwise, if the port is known, the unique_ptr contains the loaded port information.
+    // Otherwise, the unique_ptr is nullptr.
+    ExpectedL<std::unique_ptr<SourceControlFile>> try_load_port(const ReadOnlyFilesystem& fs,
+                                                                StringView port_name,
+                                                                const Path& port_directory);
+    // Identical to try_load_port, but the port unknown condition is mapped to an error.
+    ExpectedL<std::unique_ptr<SourceControlFile>> try_load_port_required(const ReadOnlyFilesystem& fs,
+                                                                         StringView port_name,
+                                                                         const Path& port_directory);
+    ExpectedL<std::unique_ptr<SourceControlFile>> try_load_port_text(const std::string& text,
+                                                                     StringView origin,
+                                                                     bool is_manifest,
+                                                                     MessageSink& warning_sink);
 
     ExpectedL<BinaryControlFile> try_load_cached_package(const ReadOnlyFilesystem& fs,
                                                          const Path& package_dir,
@@ -35,7 +48,7 @@ namespace vcpkg::Paragraphs
     struct LoadResults
     {
         std::vector<SourceControlFileAndLocation> paragraphs;
-        std::vector<std::unique_ptr<ParseControlErrorInfo>> errors;
+        std::vector<std::pair<std::string, LocalizedString>> errors;
     };
 
     LoadResults try_load_all_registry_ports(const ReadOnlyFilesystem& fs, const RegistrySet& registries);

include/vcpkg/registries.h

@@ -76,19 +76,24 @@ namespace vcpkg
     {
         virtual StringLiteral kind() const = 0;
 
-        // returns nullptr if the port doesn't exist
+        // If an error occurs, the ExpectedL will be in an error state.
+        // Otherwise, if the port is known, returns a pointer to RegistryEntry describing the port.
+        // Otherwise, returns a nullptr unique_ptr.
         virtual ExpectedL<std::unique_ptr<RegistryEntry>> get_port_entry(StringView port_name) const = 0;
 
-        // appends the names of the ports to the out parameter
-        // may result in duplicated port names; make sure to Util::sort_unique_erase at the end
+        // Appends the names of the known ports to the out parameter.
+        // May result in duplicated port names; make sure to Util::sort_unique_erase at the end
         virtual ExpectedL<Unit> append_all_port_names(std::vector<std::string>& port_names) const = 0;
 
-        // appends the names of the ports to the out parameter if this can be known without
+        // Appends the names of the ports to the out parameter if this can be known without
         // network access.
-        // returns true if names were appended, otherwise returns false.
+        // Returns true iff names were checked without network access.
         virtual ExpectedL<bool> try_append_all_port_names_no_network(std::vector<std::string>& port_names) const = 0;
 
-        virtual ExpectedL<Version> get_baseline_version(StringView port_name) const = 0;
+        // If an error occurs, the ExpectedL will be in an error state.
+        // Otherwise, if the port is in the baseline, returns the version that baseline denotes.
+        // Otherwise, the Optional is disengaged.
+        virtual ExpectedL<Optional<Version>> get_baseline_version(StringView port_name) const = 0;
 
         virtual ~RegistryImplementation() = default;
     };
@@ -130,7 +135,7 @@ namespace vcpkg
         // the returned list is sorted by priority.
         std::vector<const RegistryImplementation*> registries_for_port(StringView name) const;
 
-        ExpectedL<Version> baseline_for_port(StringView port_name) const;
+        ExpectedL<Optional<Version>> baseline_for_port(StringView port_name) const;
 
         View<Registry> registries() const { return registries_; }
 

include/vcpkg/sourceparagraph.h

@@ -206,11 +206,8 @@ namespace vcpkg
         std::string registry_location;
     };
 
-    void print_error_message(Span<const std::unique_ptr<ParseControlErrorInfo>> error_info_list);
-    inline void print_error_message(const std::unique_ptr<ParseControlErrorInfo>& error_info_list)
-    {
-        return print_error_message({&error_info_list, 1});
-    }
+    void print_error_message(const LocalizedString& message);
+    void print_error_message(const std::unique_ptr<ParseControlErrorInfo>& error_info_list);
 
     std::string parse_spdx_license_expression(StringView sv, ParseMessages& messages);
 

locales/messages.json

@@ -192,14 +192,10 @@
   "BaselineConflict": "Specifying vcpkg-configuration.default-registry in a manifest file conflicts with built-in baseline.\nPlease remove one of these conflicting settings.",
   "BaselineFileNoDefaultField": "The baseline file at commit {commit_sha} was invalid (no \"default\" field).",
   "_BaselineFileNoDefaultField.comment": "An example of {commit_sha} is 7cfad47ae9f68b183983090afd6337cd60fd4949.",
-  "BaselineFileNoDefaultFieldPath": "baseline file at {path} was invalid (no \"default\" field)",
-  "_BaselineFileNoDefaultFieldPath.comment": "An example of {path} is /foo/bar.",
   "BaselineGitShowFailed": "while checking out baseline from commit '{commit_sha}', failed to `git show` versions/baseline.json. This may be fixed by fetching commits with `git fetch`.",
   "_BaselineGitShowFailed.comment": "An example of {commit_sha} is 7cfad47ae9f68b183983090afd6337cd60fd4949.",
   "BaselineMissing": "Baseline version not found. Run:\nvcpkg x-add-version {package_name}\ngit add versions\ngit commit -m \"Update version database\"\nto set {version} as the baseline version.",
   "_BaselineMissing.comment": "An example of {package_name} is zlib. An example of {version} is 1.3.8.",
-  "BaselineMissingDefault": "The baseline.json from commit `\"{commit_sha}\"` in the repo {url} was invalid (did not contain a \"default\" field).",
-  "_BaselineMissingDefault.comment": "An example of {commit_sha} is 7cfad47ae9f68b183983090afd6337cd60fd4949. An example of {url} is https://github.com/microsoft/vcpkg.",
   "BinaryCacheVendorHTTP": "HTTP servers",
   "BinarySourcesArg": "Binary caching sources. See 'vcpkg help binarycaching'",
   "_BinarySourcesArg.comment": "'vcpkg help binarycaching' is a command line and should not be localized",
@@ -537,8 +533,6 @@
   "CorruptedInstallTree": "Your vcpkg 'installed' tree is corrupted.",
   "CouldNotDeduceNugetIdAndVersion": "Could not deduce nuget id and version from filename: {path}",
   "_CouldNotDeduceNugetIdAndVersion.comment": "An example of {path} is /foo/bar.",
-  "CouldNotFindBaseline": "Could not find explicitly specified baseline `\"{commit_sha}\"` in baseline file {path}",
-  "_CouldNotFindBaseline.comment": "An example of {commit_sha} is 7cfad47ae9f68b183983090afd6337cd60fd4949. An example of {path} is /foo/bar.",
   "CouldNotFindBaselineInCommit": "Couldn't find baseline in {url} at {commit_sha} for {package_name}.",
   "_CouldNotFindBaselineInCommit.comment": "An example of {url} is https://github.com/microsoft/vcpkg. An example of {commit_sha} is 7cfad47ae9f68b183983090afd6337cd60fd4949. An example of {package_name} is zlib.",
   "CouldNotFindGitTreeAtCommit": "could not find the git tree for `versions` in repo {package_name} at commit {commit_sha}",
@@ -754,7 +748,6 @@
   "_FailedToExtract.comment": "An example of {path} is /foo/bar.",
   "FailedToFetchRepo": "Failed to fetch {url}.",
   "_FailedToFetchRepo.comment": "An example of {url} is https://github.com/microsoft/vcpkg.",
-  "FailedToFindBaseline": "Failed to find baseline.json",
   "FailedToFindPortFeature": "{package_name} has no feature named {feature}.",
   "_FailedToFindPortFeature.comment": "An example of {feature} is avisynthplus. An example of {package_name} is zlib.",
   "FailedToFormatMissingFile": "No files to format.\nPlease pass either --all, or the explicit files to format or convert.",

src/vcpkg-test/registries.cpp

@@ -28,7 +28,7 @@ namespace
             return !no_network_port_names.empty();
         }
 
-        ExpectedL<Version> get_baseline_version(StringView) const override
+        ExpectedL<Optional<Version>> get_baseline_version(StringView) const override
         {
             return LocalizedString::from_raw("error");
         }

src/vcpkg/commands.add-version.cpp

@@ -412,25 +412,25 @@ namespace vcpkg
                 continue;
             }
 
-            auto maybe_scf = Paragraphs::try_load_port(fs, paths.builtin_ports_directory() / port_name);
-            if (!maybe_scf)
+            auto maybe_scf =
+                Paragraphs::try_load_port_required(fs, port_name, paths.builtin_ports_directory() / port_name);
+            auto scf = maybe_scf.get();
+            if (!scf)
             {
                 msg::println_error(msgAddVersionLoadPortFailed, msg::package_name = port_name);
-                print_error_message(maybe_scf.error());
+                msg::println(Color::error, maybe_scf.error());
                 Checks::check_exit(VCPKG_LINE_INFO, !add_all);
                 continue;
             }
 
-            const auto& scf = maybe_scf.value(VCPKG_LINE_INFO);
-
             if (!skip_formatting_check)
             {
                 // check if manifest file is property formatted
                 const auto path_to_manifest = paths.builtin_ports_directory() / port_name / "vcpkg.json";
                 if (fs.exists(path_to_manifest, IgnoreErrors{}))
                 {
                     const auto current_file_content = fs.read_contents(path_to_manifest, VCPKG_LINE_INFO);
-                    const auto json = serialize_manifest(*scf);
+                    const auto json = serialize_manifest(**scf);
                     const auto formatted_content = Json::stringify(json);
                     if (current_file_content != formatted_content)
                     {
@@ -454,7 +454,7 @@ namespace vcpkg
                 msg::println_warning(msgAddVersionUncommittedChanges, msg::package_name = port_name);
             }
 
-            const auto& schemed_version = scf->to_schemed_version();
+            const auto& schemed_version = (*scf)->to_schemed_version();
 
             auto git_tree_it = git_tree_map.find(port_name);
             if (git_tree_it == git_tree_map.end())

src/vcpkg/commands.add.cpp

@@ -96,14 +96,15 @@ namespace vcpkg
 
             auto maybe_manifest_scf =
                 SourceControlFile::parse_project_manifest_object(manifest->path, manifest->manifest, stdout_sink);
-            if (!maybe_manifest_scf)
+            auto pmanifest_scf = maybe_manifest_scf.get();
+            if (!pmanifest_scf)
             {
                 print_error_message(maybe_manifest_scf.error());
                 msg::println(Color::error, msg::msgSeeURL, msg::url = docs::manifests_url);
                 Checks::exit_fail(VCPKG_LINE_INFO);
             }
 
-            auto& manifest_scf = *maybe_manifest_scf.value(VCPKG_LINE_INFO);
+            auto& manifest_scf = **pmanifest_scf;
             for (const auto& spec : specs)
             {
                 auto dep = Util::find_if(manifest_scf.core_paragraph->dependencies, [&spec](Dependency& dep) {

src/vcpkg/commands.autocomplete.cpp

@@ -104,8 +104,8 @@ namespace vcpkg
                 StringView port_name{last_arg.begin(), colon};
                 StringView triplet_prefix{colon + 1, last_arg.end()};
                 // TODO: Support autocomplete for ports in --overlay-ports
-                auto maybe_port =
-                    Paragraphs::try_load_port(paths.get_filesystem(), paths.builtin_ports_directory() / port_name);
+                auto maybe_port = Paragraphs::try_load_port_required(
+                    paths.get_filesystem(), port_name, paths.builtin_ports_directory() / port_name);
                 if (!maybe_port)
                 {
                     Checks::exit_success(VCPKG_LINE_INFO);

src/vcpkg/commands.ci-verify-versions.cpp

@@ -72,7 +72,8 @@ namespace
                     const auto& file = maybe_file.value_or_exit(VCPKG_LINE_INFO);
                     auto maybe_scf =
                         Paragraphs::try_load_port_text(file, treeish, control_file == "vcpkg.json", stdout_sink);
-                    if (!maybe_scf)
+                    auto scf = maybe_scf.get();
+                    if (!scf)
                     {
                         return {msg::format_error(msgWhileParsingVersionsForPort,
                                                   msg::package_name = port_name,
@@ -82,12 +83,11 @@ namespace
                                     .append_raw('\n')
                                     .append(msgWhileLoadingPortFromGitTree, msg::commit_sha = treeish)
                                     .append_raw('\n')
-                                    .append_raw(maybe_scf.error()->error),
+                                    .append(maybe_scf.error()),
                                 expected_right_tag};
                     }
 
-                    const auto& scf = maybe_scf.value(VCPKG_LINE_INFO);
-                    auto&& git_tree_version = scf->to_schemed_version();
+                    auto&& git_tree_version = (*scf)->to_schemed_version();
                     if (version_entry.version.version != git_tree_version.version)
                     {
                         return {
@@ -122,16 +122,17 @@ namespace
             }
         }
 
-        auto maybe_scf = Paragraphs::try_load_port(paths.get_filesystem(), port_path);
-        if (!maybe_scf)
+        auto maybe_scf = Paragraphs::try_load_port_required(paths.get_filesystem(), port_name, port_path);
+        auto scf = maybe_scf.get();
+        if (!scf)
         {
             return {msg::format_error(msgWhileLoadingLocalPort, msg::package_name = port_name)
                         .append_raw('\n')
-                        .append_raw(maybe_scf.error()->error),
+                        .append(maybe_scf.error()),
                     expected_right_tag};
         }
 
-        const auto local_port_version = maybe_scf.value(VCPKG_LINE_INFO)->to_schemed_version();
+        const auto local_port_version = (*scf)->to_schemed_version();
 
         auto versions_end = versions->end();
         auto it = std::find_if(versions->begin(), versions_end, [&](const GitVersionDbEntry& entry) {

src/vcpkg/commands.format-manifest.cpp

@@ -50,7 +50,6 @@ namespace
         {
             msg::println_error(msgFailedToParseManifest, msg::path = path_string);
             print_error_message(scf.error());
-            msg::println();
             return nullopt;
         }