Added settings to select preferred/required architecture. #1727

jedieaston · 2021-11-18T20:18:52Z

Have you signed the Contributor License Agreement?
Are you working against an Issue?

Resolves #906.

This is the other half of #906, adding settings to select a preferred or required architecture. The required architecture behaves exactly like the --architecture flag, where AllowedArchitectures only contains the architecture that is in the setting. The preferred architecture behaves much like the preferred scope setting, where the installer entry with the preferred architecture is selected over all others, but if there isn't an installer entry with the preferred architecture, the normal rationale is used.

The fields are validated by determining if the architecture selected is compatible with the current system. By default the setting is set to neutral. (although if there is a reason we need to allow users to require neutral manifests, that could just as easily be unknown. I figured there were few scenarios where a user wouldn't want a installer that only had the relevant bits for their system over a neutral one with all of the bits.)

The only other note I have is that I decided to make these just strings instead of arrays since that's what it sounded like in the original ticket. If there's a usecase where someone wants to prefer multiple architectures, that's a quick fix (although there's only ever at most three options, so I doubt that comes up much?).

Tested: manually. I can write unit tests if necessary.

Edit: also, sorry for the big diff on UserSettings.cpp. Visual Studio got upset that the line endings were mixed.

Microsoft Reviewers: Open in CodeFlow

yao-msft · 2021-11-19T02:28:56Z

schemas/JSON/settings/settings.schema.0.2.json

+        },
+        "architecture": {
+          "description": "The architecture for a package install",
+          "type": "string",


Shall we consider making it a list to be more flexible(like locale above) ?

The ticket made it sound like you’d select a preferred (single) architecture instead of multiple, but I can do that.

I was also thinking we would have a "single" preferred or required architecture. I can't think of a valid scenario where there would be three architectures that could all work and you would prefer (a), accept (b), and reject (c). With locale, I could see a set you would like in some kind of order so you could essentially have a bit of control when one of the languages you used was available, but it wasn't a logical close match otherwise. Let's keep this as a singleton for now.

Just after I hit send, I remembered some emulation might be valid, but I think the "requires" forces it to be what I want and "prefers" will take anything else.

That is how it works. Prefers will fallback to the normal logic if the architecture you prefer is not available. If your required architecture is not available you get an error.

Yeah, I was just not completing thoughts last night. Days have bee feeling like weeks lately. I'm trying to close a lot of gaps. We have some heavy investments coming in related to Intune integration for the replacement of store for business, and Win32 support for the store. The next couple of quarters are going to be busy.

I would rather have it be an array to start. At some point someone will want an array and then we will have two settings (or have to implement it allowing both scalar and array). Even requirements makes sense to support multiple, just like locales. I might be an ARM purist on my ARM64 machine and so require { arm64, arm }.

JohnMcPMS · 2021-11-19T18:40:30Z

src/AppInstallerCLICore/Workflows/ManifestComparator.cpp


-            MachineArchitectureComparator(std::vector<Utility::Architecture> allowedArchitectures) :
-                details::ComparisonField("Machine Architecture"), m_allowedArchitectures(std::move(allowedArchitectures))
+            MachineArchitectureComparator(std::vector<Utility::Architecture> allowedArchitectures, Utility::Architecture preference) :


This shouldn't have needed to change to fully support preferences and requirements. An entry of Utility::Architecture::Unknown in Execution::Data::AllowedArchitectures indicates "and all the rest"; aka that the previous architectures are preferences. Thus the only difference between the preferences and requirements settings are whether to append Unknown.

JohnMcPMS · 2021-11-19T18:46:42Z

schemas/JSON/settings/settings.schema.0.2.json

+        },
+        "architecture": {
+          "description": "The architecture for a package install",
+          "type": "string",


I would rather have it be an array to start. At some point someone will want an array and then we will have two settings (or have to implement it allowing both scalar and array). Even requirements makes sense to support multiple, just like locales. I might be an ARM purist on my ARM64 machine and so require { arm64, arm }.

JohnMcPMS · 2021-11-19T18:56:32Z

src/AppInstallerCLICore/Workflows/WorkflowBase.cpp

            context.Add<Execution::Data::AllowedArchitectures>({ Utility::ConvertToArchitectureEnum(std::string(context.Args.GetArg(Execution::Args::Type::InstallArchitecture))) });
        }
+        else if (requiredArchitecture != Utility::Architecture::Neutral)


I would make this an unconditional else and the check the settings (both once you revert the ManifestComparator changes) inside it. That way we don't do unnecessary work getting the setting(s) if there is an argument passed in.

JohnMcPMS · 2021-11-19T18:58:49Z

src/AppInstallerCommonCore/UserSettings.cpp

+        WINGET_VALIDATE_SIGNATURE(InstallArchitecturePreference)
+        {
+            Utility::Architecture arch = Utility::ConvertToArchitectureEnum(value);
+	        if (Utility::IsApplicableArchitecture(arch) != Utility::InapplicableArchitecture)


You have tabs here; please convert to 4 spaces.

JohnMcPMS · 2021-11-19T18:59:19Z

src/AppInstallerCommonCore/UserSettings.cpp

-        WINGET_VALIDATE_PASS_THROUGH(TelemetryDisable)
-        WINGET_VALIDATE_PASS_THROUGH(EFDirectMSI)
-        WINGET_VALIDATE_PASS_THROUGH(EnableSelfInitiatedMinidump)
-


What did whitespace do to you?

jedieaston · 2021-11-25T01:43:07Z

I fixed all of the complaints (array is used, ManifestComparator isn't messed with, whitespace fixed). All of the changes to AllowedArchitectures are now dealt with in SelectInstaller.

Sorry for the delay, I was traveling for Thanksgiving.

…heart-out

src/AppInstallerCLICore/Workflows/WorkflowBase.cpp

jedieaston · 2021-11-30T14:36:26Z

I noticed something when working on that last commit, which is that adding the Unknown architecture to AllowedArchitectures makes the ManifestComparator use its traditional logic instead of accepting the user's preference above all else:

settings.json:

{
    "$schema": "https://aka.ms/winget-settings.schema.json",

    // For documentation on these settings, see: https://aka.ms/winget-settings
    // "source": {
    //    "autoUpdateIntervalInMinutes": 5
    // },
    "installBehavior": {
        "preferences": {
            "architectures": ["x86"]
        }
    },
}

Relevant logs from wingetdev install Google.Chrome

2021-11-30 09:27:59.146 [YAML] Detected UTF-8
2021-11-30 09:27:59.153 [CLI ] Manifest fields: Name [Google Chrome], Version [96.0.4664.45]
2021-11-30 09:28:39.117 [CLI ] Locale Comparator created with Required Locales: [] , Preferred Locales: [en-US]
2021-11-30 09:28:39.117 [CLI ] Architecture Comparator created with allowed architectures: X64, X86, Neutral
2021-11-30 09:28:39.117 [CLI ] Starting installer selection.
2021-11-30 09:28:39.117 [CLI ] Installer [X64,msi,Machine,] is current best choice
2021-11-30 09:28:39.117 [CLI ] Installer [X64,msi,Machine,] is better than [X86,msi,Machine,] due to: Machine Architecture
2021-11-30 09:28:39.117 [CLI ] Completed installer selection.

Am I missing something here or do I still need to do something to ManifestComparator to make sure that the preferences are honored above the traditional logic?

JohnMcPMS · 2021-11-30T19:15:37Z

Am I missing something here or do I still need to do something to ManifestComparator to make sure that the preferences are honored above the traditional logic?

Are you putting the Unknown value at the back of the vector? I would double check in the allowed architectures vector coming in is { x86, Unknown }.

…tor :D

jedieaston · 2021-11-30T19:47:16Z

That was exactly it, thanks! Now it's using emplace_back, and all is right with the world.

JohnMcPMS · 2021-11-30T22:51:19Z

/azp run

azure-pipelines · 2021-11-30T22:51:31Z

Azure Pipelines successfully started running 1 pipeline(s).

…crosoft#1727)" This reverts commit f1c2358.

Added settings to select preferred/required architecture.

d2805fa

jedieaston requested a review from a team as a code owner November 18, 2021 20:18

ghost added the Issue-Feature This is a feature request for the Windows Package Manager client. label Nov 18, 2021

yao-msft reviewed Nov 19, 2021

View reviewed changes

JohnMcPMS requested changes Nov 19, 2021

View reviewed changes

ghost added the Needs-Author-Feedback Issue needs attention from issue or PR author label Nov 19, 2021

Applied suggestions from code review. Sorry for the delay.

01d1029

ghost removed the Needs-Author-Feedback Issue needs attention from issue or PR author label Nov 25, 2021

Merge remote-tracking branch 'upstream/master' into stlouis-eat-your-…

7293c6e

…heart-out

jedieaston requested a review from JohnMcPMS November 29, 2021 23:28

JohnMcPMS requested changes Nov 29, 2021

View reviewed changes

src/AppInstallerCLICore/Workflows/WorkflowBase.cpp Outdated Show resolved Hide resolved

src/AppInstallerCLICore/Workflows/WorkflowBase.cpp Outdated Show resolved Hide resolved

ghost added Needs-Author-Feedback Issue needs attention from issue or PR author and removed Needs-Author-Feedback Issue needs attention from issue or PR author labels Nov 29, 2021

Applied suggestions from code review.

a7286dc

Made doc match schema change.

f535556

Made sure that Architecture::Unknown was going to the back of the vec…

0384fcd

…tor :D

JohnMcPMS approved these changes Dec 1, 2021

View reviewed changes

JohnMcPMS merged commit f1c2358 into microsoft:master Dec 1, 2021

jedieaston deleted the stlouis-eat-your-heart-out branch December 1, 2021 19:45

hackean-msft pushed a commit to hackean-msft/winget-cli that referenced this pull request Dec 22, 2021

Revert "Added settings to select preferred/required architecture. (mi…

16affc6

…crosoft#1727)" This reverts commit f1c2358.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added settings to select preferred/required architecture. #1727

Added settings to select preferred/required architecture. #1727

jedieaston commented Nov 18, 2021 •

edited

Loading

yao-msft Nov 19, 2021 •

edited

Loading

jedieaston Nov 19, 2021

denelon Nov 19, 2021

denelon Nov 19, 2021

jedieaston Nov 19, 2021

denelon Nov 19, 2021

JohnMcPMS Nov 19, 2021

JohnMcPMS Nov 19, 2021

JohnMcPMS Nov 19, 2021

JohnMcPMS Nov 19, 2021

JohnMcPMS Nov 19, 2021

JohnMcPMS Nov 19, 2021

jedieaston commented Nov 25, 2021

jedieaston commented Nov 30, 2021

JohnMcPMS commented Nov 30, 2021

jedieaston commented Nov 30, 2021

JohnMcPMS commented Nov 30, 2021

azure-pipelines bot commented Nov 30, 2021

Added settings to select preferred/required architecture. #1727

Added settings to select preferred/required architecture. #1727

Conversation

jedieaston commented Nov 18, 2021 • edited Loading

Microsoft Reviewers: Open in CodeFlow

yao-msft Nov 19, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jedieaston commented Nov 25, 2021

jedieaston commented Nov 30, 2021

JohnMcPMS commented Nov 30, 2021

jedieaston commented Nov 30, 2021

JohnMcPMS commented Nov 30, 2021

azure-pipelines bot commented Nov 30, 2021

jedieaston commented Nov 18, 2021 •

edited

Loading

yao-msft Nov 19, 2021 •

edited

Loading