Use trace messaging to indicate composite resources are being ignored

[michaeltlombardi]

Summary of the new feature / enhancement

As a configuration author using PSDSC resources in DSC, I always see debug messages with a warning prefix about "implementation detail not found" for composite resources when the adapter builds the DSC cache. The warning implies that something has gone wrong, but the actual behavior is desired and expected - Invoke-DscResource doesn't work with composite resources. Instead, the adapter should emit trace messages indicating that it's not caching the composite resource because they're not supported.

The code that is causing this behavior is in the Invoke-DscCacheRefresh function in the adapter module:

DSC/powershell-adapter/psDscAdapter/psDscAdapter.psm1

Lines 78 to 82 in 9ee037a

	if ([dscResourceType].GetEnumNames() -notcontains $dscResource.ImplementationDetail) {
	$trace = @{'Debug' = 'WARNING: implementation detail not found: ' + $dscResource.ImplementationDetail } | ConvertTo-Json -Compress
	$host.ui.WriteErrorLine($trace)
	continue
	}

Proposed technical implementation details (optional)

Define an additional check in the foreach loop to specifically discard composite resources:

$dscResourceTypeName = $dscResource.ModuleName + '/' + $dscResource.Name

if ($dscResource.ImplementedAs -eq 'Composite') {
    $trace = @{
        'Trace' = @(
            "Skipping caching composite resource '$dscResourceTypeName'."
            "Composite resources aren't supported in DSCv3."
        ) -join ' '
    } | ConvertTo-Json -Compress
    $host.ui.WriteErrorLine($trace)
    continue
}

Note

Out of scope for this issue, but the trace messages from the adapter all use the Debug level, when they should use the appropriate level for their message, and many of them lack sufficient context for a typical user to understand which resource the message is referring to and what the message indicates.