microsoft / microsoft/winget-cli

Microsoft.WinGet.DSC/WinGetAdminSettings throws Error

Open
#3,959 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Command-Configure Issue-Bug PowerShell
Dominant language
C++
Stars
26.4k
Forks
1.8k
Avg merge
1d 11h
Merged PRs (30d)
15

Description

Brief description of your issue

When the DSC module attempts to de-serialize the Admin Settings, it fails with an error.

Steps to reproduce

Write a DSC resource to change a WinGet Admin Setting such as LocalManifestFiles. Test the configuration against the system.

Expected behavior

System state is tested and the DSC resource returns the correct status of the admin setting

Actual behavior
Apply :: WinGetAdminSettings
  The configuration unit failed while attempting to test the current system state.
Conversion from JSON failed with error: Unexpected character encountered while parsing value: S. Path '', line 0, position 0.
<See the log file for additional details>

The DSC module attempts to get the settings when testing a configuration file.

# Gets the administrator settings.
    [WinGetAdminSettings] Get()
    {
        Assert-WinGetCommand "Get-WinGetSettings"
        $settingsJson = Get-WinGetSettings | ConvertFrom-Json -AsHashtable
        # Get admin setting values.

        $result = @{
            SID = ''
            Settings = $settingsJson.adminSettings
        }
        return $result
    }

Running Get-WinGetSettings | ConvertFrom-Json -AsHashtable in PowerShell gives same Conversion from JSON error, which leads me to believe that the settings deserialization needs to be updated

Environment
PS C:\Users\Trenly> winget --info
Windows Package Manager (Preview) v1.7.3172-preview
Copyright (c) Microsoft Corporation. All rights reserved.

Windows: Windows.Desktop v10.0.19045.3693
System Architecture: X64
Package: Microsoft.DesktopAppInstaller v1.22.3172.0

Winget Directories
-------------------------------------------------------------------------------------------------------------------------------
Logs                               %LOCALAPPDATA%\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\DiagOutputDir
User Settings                      %LOCALAPPDATA%\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json
Portable Links Directory (User)    %LOCALAPPDATA%\Microsoft\WinGet\Links
Portable Links Directory (Machine) C:\Program Files\WinGet\Links
Portable Package Root (User)       %LOCALAPPDATA%\Microsoft\WinGet\Packages
Portable Package Root              C:\Program Files\WinGet\Packages
Portable Package Root (x86)        C:\Program Files (x86)\WinGet\Packages
Installer Downloads                D:\Users\Trenly\Downloads

Links
---------------------------------------------------------------------------
Privacy Statement   https://aka.ms/winget-privacy
License Agreement   https://aka.ms/winget-license
Third Party Notices https://aka.ms/winget-3rdPartyNotice
Homepage            https://aka.ms/winget
Windows Store Terms https://www.microsoft.com/en-us/storedocs/terms-of-sale

Admin Setting                             State
--------------------------------------------------
LocalManifestFiles                        Enabled
BypassCertificatePinningForMicrosoftStore Disabled
InstallerHashOverride                     Disabled
LocalArchiveMalwareScanOverride           Enabled


PS C:\Users\Trenly> $(Get-Module).Where({$_.Name -match 'winget'})

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Binary     1.6.3133.0            Microsoft.WinGet.Client             {Add-WinGetSource, Assert-WinGetPackageManager, Disable-WinGetSetting, Enable-WinGetSetting…}

PS C:\Users\Trenly> $(Get-DSCResource).Where({$_.ModuleName -match 'winget'})| Select-Object -Property ModuleName,Version -Unique

ModuleName           Version
----------           -------
Microsoft.WinGet.DSC 0.2.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the WinGetAdminSettings Get() method shown in the issue and reproduce Get-WinGetSettings | ConvertFrom-Json -AsHashtable in PowerShell. Trace the returned settings format and the conversion failure. Done means the DSC resource can test the system state and report the administrator setting status without the JSON conversion error.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
cli, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.