Enable module/resource syntax and improve file error reporting #3186
Conversation
… on appropriately
…ging; needs much testing
… both in config output; needs tests
| // The line number for the failure reason, if determined. | ||
| UInt32 Line{ get; }; | ||
|
|
||
| // The line number for the failure reason, if determined. |
| { | ||
| AICLI_LOG(Config, Error, << "ConfigurationSetParser error: " << AppInstaller::Logging::SetHRFormat << result << " [" << field << "]"); | ||
| return hstring{ L"0.1" }; |
There was a problem hiding this comment.
shouldn't this be 0.2?
| return std::make_unique<ConfigurationSetParserError>(WINGET_CONFIG_ERROR_UNKNOWN_CONFIGURATION_FILE_VERSION, GetFieldName(FieldName::ConfigurationVersion), versionNode.as<std::string>()); | ||
| } | ||
|
|
||
| bool ConfigurationSetParser::IsRecognizedSchemaVersion(hstring value) try |
There was a problem hiding this comment.
maybe there can be something like an enum that has the recognized versions, unknown and max. a helper method that returns the string or semantic representation and compare with the value given. then Create and current callers of IsRecognizedSchemaVersion throw if the result is unknown and LatestVersion just uses max. but maybe is too much.
There was a problem hiding this comment.
I don't think an enum is warranted here, and I would only expect the value to be set in the event that the caller knows what they are doing with it (and therefore knows the versions).
| QualifiedResourceName(hstring input) | ||
| { | ||
| std::wstring_view inputView = input; | ||
| size_t pos = inputView.find('/'); |
There was a problem hiding this comment.
should we fail if there are more than one / ?
There was a problem hiding this comment.
Given that / isn't a valid character in module or resource names, I don't think I mind if we break non-functional files at a later date.
Change
This change adds a new syntax that can be used when referencing resources in a configuration file:
Module/Resource. This is only added to a new 0.2 schema version, mainly to prevent an issue with older clients failing to run the newer files in a way that is less obvious than "unrecognized configuration file version".As part of adding a new schema version, I also added the schema version as a property to the
ConfigurationSetandConfigurationUnit. This will enable the processor to handle any semantic differences that might arise as schemas evolve.Finally, the result from opening a configuration file now contains the field name and value, as well as the line and column number for the error (all values supplied as appropriate). All of this information is better presented to the user from the family of
winget configurecommands.Validation
New tests are added to validate the result of opening a configuration file.
Microsoft Reviewers: Open in CodeFlow