Skip to content

don't throw if engines property is a string array #1400

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
JamieMagee merged 4 commits into from
May 5, 2025
Merged

don't throw if engines property is a string array #1400

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
efd9d04
don't throw if `engines` property is a string array
brettfo May 5, 2025
15fa7c0
use preferred test method
brettfo May 5, 2025
c1a5367
remove unnecessary exception
brettfo May 5, 2025
39de530
lift scope of vscode flag
brettfo May 5, 2025
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
27 changes: 26 additions & 1 deletion src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ namespace Microsoft.ComponentDetection.Detectors.Npm;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -88,7 +89,31 @@ protected virtual bool ProcessIndividualPackageJTokens(string filePath, ISingleF
return false;
}

if (enginesToken != null && enginesToken["vscode"] != null)
var containsVsCodeEngine = false;
if (enginesToken != null)
{
if (enginesToken.Type == JTokenType.Array)
{
var engineStrings = enginesToken
.Children()
.Where(t => t.Type == JTokenType.String)
.Select(t => t.ToString())
.ToArray();
if (engineStrings.Any(e => e.Contains("vscode")))
{
containsVsCodeEngine = true;
}
}
else if (enginesToken.Type == JTokenType.Object)
{
if (enginesToken["vscode"] != null)
{
containsVsCodeEngine = true;
}
}
}

if (containsVsCodeEngine)
{
this.Logger.LogInformation("{NpmPackageName} found at path {NpmPackageLocation} represents a built-in VS Code extension. This package will not be registered.", name, filePath);
return false;
Expand Down
38 changes: 38 additions & 0 deletions test/Microsoft.ComponentDetection.Detectors.Tests/NpmDetectorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,44 @@ public async Task TestNpmDetector_VSCodeEngineCausesSkippedPackageAsync()
detectedComponents.Should().BeEmpty();
}

[TestMethod]
public async Task TestNpmDetector_EnginesAsArray_VSCodeEngine()
{
var packageName = GetRandomString();
var packageVersion = NewRandomVersion();
var engineText = "vscode >= 6.0";
var (packageJsonName, packageJsonContents, packageJsonPath) =
NpmTestUtilities.GetPackageJsonNoDependenciesForNameAndVersionWithEngiesAsArray(packageName, packageVersion, engineText);

var (scanResult, componentRecorder) = await this.DetectorTestUtility
.WithFile(packageJsonName, packageJsonContents, this.packageJsonSearchPattern, fileLocation: packageJsonPath)
.ExecuteDetectorAsync();
scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
var detectedComponents = componentRecorder.GetDetectedComponents();
detectedComponents.Should().BeEmpty();
}

[TestMethod]
public async Task TestNpmDetector_EnginesAsArray_NodeEngine()
{
var packageName = GetRandomString();
var packageVersion = NewRandomVersion();
var engineText = "node >= 6.0";
var (packageJsonName, packageJsonContents, packageJsonPath) =
NpmTestUtilities.GetPackageJsonNoDependenciesForNameAndVersionWithEngiesAsArray(packageName, packageVersion, engineText);

var (scanResult, componentRecorder) = await this.DetectorTestUtility
.WithFile(packageJsonName, packageJsonContents, this.packageJsonSearchPattern, fileLocation: packageJsonPath)
.ExecuteDetectorAsync();
scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
var detectedComponents = componentRecorder.GetDetectedComponents();
detectedComponents.Should().ContainSingle();
detectedComponents.Single().Component.Type.Should().Be(ComponentType.Npm);
var detectedNpmComponent = (NpmComponent)detectedComponents.Single().Component;
detectedNpmComponent.Name.Should().Be(packageName);
detectedNpmComponent.Version.Should().Be(packageVersion);
}

private static void AssertDetectedComponentCount(IEnumerable<DetectedComponent> detectedComponents, int expectedCount)
{
detectedComponents.Should().HaveCount(expectedCount);
Expand Down
13 changes: 13 additions & 0 deletions test/Microsoft.ComponentDetection.Detectors.Tests/NpmTestUtilities.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,19 @@ public static (string PackageJsonName, string PackageJsonContents, string Packag
return ("package.json", packageJsonTemplate, Path.Combine(Path.GetTempPath(), "package.json"));
}

public static (string PackageJsonName, string PackageJsonContents, string PackageJsonPath) GetPackageJsonNoDependenciesForNameAndVersionWithEngiesAsArray(string packageName, string packageVersion, string engineText)
{
var packagejson = @"{{
""name"": ""{0}"",
""version"": ""{1}"",
""engines"": [
""{2}""
]
}}";
var packageJsonTemplate = string.Format(packagejson, packageName, packageVersion, engineText);
return ("package.json", packageJsonTemplate, Path.Combine(Path.GetTempPath(), "package.json"));
}

public static (string PackageJsonName, string PackageJsonContents, string PackageJsonPath) GetPackageJsonNoDependenciesForAuthorAndEmailInJsonFormat(
string authorName, string authorEmail = null)
{
Expand Down