Skip to content

Report DSC execution diagnostics on a timer #6196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcPMS merged 4 commits into from
May 7, 2026
+358 −5
Merged

Report DSC execution diagnostics on a timer #6196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99d32fd
Stream dsc.exe output to diagnostics via time-based batching
JohnMcPMS May 1, 2026
8e8fc94
fixes
JohnMcPMS May 2, 2026
bed8bb8
Add export debug command for testing, exporter resource type, and the…
JohnMcPMS May 6, 2026
73ab6d9
Disable test for a bit
JohnMcPMS May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions src/AppInstallerCLICore/Commands/DebugCommand.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#if _DEBUG
#include "DebugCommand.h"
#include "Public/ConfigurationSetProcessorFactoryRemoting.h"
#include <AppInstallerRuntime.h>
#include <winrt/Microsoft.Management.Configuration.h>
#include <winrt/Microsoft.Management.Configuration.SetProcessorFactory.h>
#include "AppInstallerDownloader.h"
Expand Down Expand Up @@ -62,6 +64,7 @@ namespace AppInstaller::CLI
std::make_unique<DumpErrorResourceCommand>(FullName()),
std::make_unique<ShowSixelCommand>(FullName()),
std::make_unique<ProgressCommand>(FullName()),
std::make_unique<DebugDscResourceCommand>(FullName()),
});
}

Expand Down Expand Up @@ -365,6 +368,191 @@ namespace AppInstaller::CLI
context.Reporter.Info() << context.Args.GetArg(WINGET_DEBUG_PROGRESS_POST) << std::endl;
}
}

#define WINGET_DEBUG_DSC_RESOURCE_RESOURCE Args::Type::SourceName
#define WINGET_DEBUG_DSC_RESOURCE_EXPORT Args::Type::AllVersions

std::vector<Argument> DebugDscResourceCommand::GetArguments() const
{
return {
Argument{ "resource", 'r', WINGET_DEBUG_DSC_RESOURCE_RESOURCE, Resource::String::SourceListUpdatedNever, ArgumentType::Positional },
Argument{ "export", 'e', WINGET_DEBUG_DSC_RESOURCE_EXPORT, Resource::String::SourceListUpdatedNever, ArgumentType::Flag },
Argument::ForType(Args::Type::ConfigurationProcessorPath),
};
}

Resource::LocString DebugDscResourceCommand::ShortDescription() const
{
return Utility::LocIndString("Run DSCv3 resource actions"sv);
}

Resource::LocString DebugDscResourceCommand::LongDescription() const
{
return Utility::LocIndString("Directly invokes DSCv3 resource functions through WinGet's infrastructure, without requiring a full configuration document."sv);
}

void DebugDscResourceCommand::ExecuteInternal(Execution::Context& context) const
{
using namespace winrt::Microsoft::Management::Configuration;
using namespace winrt::Windows::Foundation::Collections;

if (!context.Args.Contains(WINGET_DEBUG_DSC_RESOURCE_EXPORT))
{
OutputHelp(context.Reporter);
return;
}

std::string resourceName{ context.Args.GetArg(WINGET_DEBUG_DSC_RESOURCE_RESOURCE) };

context.Reporter.Info() << "Creating OOP DSCv3 processor factory..." << std::endl;

IConfigurationSetProcessorFactory factory;
if (Runtime::IsRunningWithLimitedToken())
{
factory = ConfigurationRemoting::CreateDynamicRuntimeFactory(ConfigurationRemoting::ProcessorEngine::DSCv3);
}
else
{
factory = ConfigurationRemoting::CreateOutOfProcessFactory(ConfigurationRemoting::ProcessorEngine::DSCv3);
}

auto factoryMap = factory.as<IMap<winrt::hstring, winrt::hstring>>();

if (context.Args.Contains(Args::Type::ConfigurationProcessorPath))
{
factoryMap.Insert(ConfigurationRemoting::ToHString(ConfigurationRemoting::PropertyName::DscExecutablePath), Utility::ConvertToUTF16(context.Args.GetArg(Args::Type::ConfigurationProcessorPath)));
}
else
{
// Run the state machine to locate dsc.exe.
for (;;)
{
winrt::hstring nextTransition = factoryMap.Lookup(ConfigurationRemoting::ToHString(ConfigurationRemoting::PropertyName::FindDscStateMachine));
AICLI_LOG(CLI, Info, << "FindDscStateMachine: " << Utility::ConvertToUTF8(nextTransition));

if (nextTransition == L"Found")
{
break;
}
else if (nextTransition == L"NotFound")
{
context.Reporter.Error() << Resource::String::ConfigurationInstallDscPackageFailed << std::endl;
AICLI_TERMINATE_CONTEXT(HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND));
}
else
{
// InstallStable/InstallPreview etc. are not supported in debug mode; install DSCv3 manually.
context.Reporter.Error() << "DSCv3 unavailable (" << Utility::ConvertToUTF8(nextTransition) << "); use --processor-path or install DSCv3." << std::endl;
AICLI_TERMINATE_CONTEXT(E_NOTIMPL);
}
}
}

if (Logging::Log().IsEnabled(Logging::Channel::Config, Logging::Level::Verbose))
{
factoryMap.Insert(ConfigurationRemoting::ToHString(ConfigurationRemoting::PropertyName::DiagnosticTraceEnabled), L"True");
}

// Build and configure the processor.
ConfigurationProcessor processor{ factory };
processor.Caller(L"winget-debug");

if (Logging::Log().IsEnabled(Logging::Channel::Config, Logging::Level::Verbose))
{
processor.MinimumLevel(DiagnosticLevel::Verbose);
}

processor.Diagnostics([&context](const winrt::Windows::Foundation::IInspectable&, const IDiagnosticInformation& diag)
{
Logging::Level level = Logging::Level::Info;
switch (diag.Level())
{
case DiagnosticLevel::Verbose: level = Logging::Level::Verbose; break;
case DiagnosticLevel::Informational: level = Logging::Level::Info; break;
case DiagnosticLevel::Warning: level = Logging::Level::Warning; break;
case DiagnosticLevel::Error: level = Logging::Level::Error; break;
case DiagnosticLevel::Critical: level = Logging::Level::Crit; break;
}
context.GetThreadGlobals().GetDiagnosticLogger().Write(Logging::Channel::Config, level, Utility::ConvertToUTF8(diag.Message()));
});

// Construct a minimal ConfigurationUnit for the named resource.
ConfigurationUnit unit;
unit.Type(Utility::ConvertToUTF16(resourceName));
unit.Identifier(L"debug-item");
unit.Intent(ConfigurationUnitIntent::Inform);

context.Reporter.Info() << "Exporting resource: " << resourceName << std::endl;

auto progressScope = context.Reporter.BeginAsyncProgress(true);
progressScope->Callback().SetProgressMessage(Resource::String::ConfigurationExportingUnit());

GetAllConfigurationUnitsResult exportResult = nullptr;
{
auto exportAction = processor.GetAllUnitsAsync(unit);
auto cancellationScope = progressScope->Callback().SetCancellationFunction([&]() { exportAction.Cancel(); });
exportResult = exportAction.get();
}

progressScope.reset();

HRESULT hr = exportResult.ResultInformation().ResultCode();
if (FAILED(hr))
{
auto description = exportResult.ResultInformation().Description();
context.Reporter.Error() << "Export failed (0x" << Logging::SetHRFormat << hr << "): ";
if (!description.empty())
{
context.Reporter.Error() << Utility::ConvertToUTF8(description);
}
context.Reporter.Error() << std::endl;
AICLI_TERMINATE_CONTEXT(hr);
}

auto units = exportResult.Units();
context.Reporter.Info() << "Exported " << units.Size() << " instance(s):" << std::endl;

for (const auto& resultUnit : units)
{
context.Reporter.Info() << " Type: " << Utility::ConvertToUTF8(resultUnit.Type()) << std::endl;
context.Reporter.Info() << " Identifier: " << Utility::ConvertToUTF8(resultUnit.Identifier()) << std::endl;

auto settings = resultUnit.Settings();
if (settings && settings.Size() > 0)
{
context.Reporter.Info() << " Settings:" << std::endl;
for (const auto& [key, value] : settings)
{
auto prop = value.try_as<winrt::Windows::Foundation::IPropertyValue>();
if (prop)
{
std::string valueStr;
switch (prop.Type())
{
case winrt::Windows::Foundation::PropertyType::String:
valueStr = Utility::ConvertToUTF8(prop.GetString());
break;
case winrt::Windows::Foundation::PropertyType::Boolean:
valueStr = prop.GetBoolean() ? "true" : "false";
break;
case winrt::Windows::Foundation::PropertyType::Int32:
valueStr = std::to_string(prop.GetInt32());
break;
case winrt::Windows::Foundation::PropertyType::Int64:
valueStr = std::to_string(prop.GetInt64());
break;
default:
valueStr = "(unsupported type)";
break;
}
context.Reporter.Info() << " " << Utility::ConvertToUTF8(key) << ": " << valueStr << std::endl;
}
}
}

context.Reporter.Info() << std::endl;
}
}
}

#endif
14 changes: 14 additions & 0 deletions src/AppInstallerCLICore/Commands/DebugCommand.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,20 @@ namespace AppInstaller::CLI
protected:
void ExecuteInternal(Execution::Context& context) const override;
};

// Directly invokes a DSCv3 resource function through WinGet's infrastructure.
struct DebugDscResourceCommand final : public Command
{
DebugDscResourceCommand(std::string_view parent) : Command("dsc-resource", {}, parent) {}

std::vector<Argument> GetArguments() const override;

Resource::LocString ShortDescription() const override;
Resource::LocString LongDescription() const override;

protected:
void ExecuteInternal(Execution::Context& context) const override;
};
}

#endif
1 change: 1 addition & 0 deletions src/AppInstallerCLIE2ETests/ConfigureExportCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ public void ExportTestPackageWithVersion()
/// Export all.
/// </summary>
[Test]
[Ignore("DSC 3.2 design changes ", Until = "2026-05-10")]
public void ExportAll()
{
var exportDir = TestCommon.GetRandomTestDir();
Expand Down
12 changes: 10 additions & 2 deletions src/Microsoft.Management.Configuration.Processor/DSCv3/Helpers/ProcessExecution.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ namespace Microsoft.Management.Configuration.Processor.DSCv3.Helpers
/// </summary>
internal class ProcessExecution
{
private static int nextExecutionNumber = 0;

private List<string> outputLines = new List<string>();
private List<string> errorLines = new List<string>();

Expand All @@ -26,6 +28,7 @@ internal class ProcessExecution
/// </summary>
public ProcessExecution()
{
this.ExecutionNumber = Interlocked.Increment(ref nextExecutionNumber);
}

/// <summary>
Expand All @@ -38,6 +41,11 @@ public ProcessExecution()
/// </summary>
public event EventHandler<string>? ErrorLineReceived;

/// <summary>
/// Gets the monotonically increasing number assigned to this process execution.
/// </summary>
public int ExecutionNumber { get; }

/// <summary>
/// Gets the executable path.
/// </summary>
Expand All @@ -52,7 +60,7 @@ public ProcessExecution()
/// <summary>
/// Gets the data to write to standard input of the process.
/// </summary>
public string? Input { get; init; } = null;
public string? Input { get; init; } = string.Empty;

/// <summary>
/// Gets the list of custom environment variables to use for the process.
Expand Down Expand Up @@ -264,7 +272,7 @@ private static string GetAllLines(List<string> lines)

foreach (string line in lines)
{
stringBuilder.AppendLine(line);
stringBuilder.Append(line).Append('\n');
Copy link
Copy Markdown
Member

@florelis florelis May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not AppendLine() anymore? And why not Environment.NewLine?

Copy link
Copy Markdown
Member Author

@JohnMcPMS JohnMcPMS May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because what ended up being in the log file was \r\r\n and VS Code was showing that as two lines. I did not attempt to find out exactly why that was happening.

}

return stringBuilder.ToString();
Expand Down
Loading
Loading