Skip to content

Commit

Permalink
Add additional version spec options to match rollforward from global …
Browse files Browse the repository at this point in the history 
…json (#2139)

* Add additional version spec options to match rollforward from global.json

Resolves #2138

Need to add some tests, this logic is very WIP
As requested by @lifengl

* Add a lot of tests

* add EVEN more tests

* fix typo

thank you @joeloff

* Fix tests where ' caused build error

* Fix random number generation
Thank you @Forgind for catching this here: https://github.com/dotnet/vscode-dotnet-runtime/pull/2135/files#r1965980900 where there's more information, I'm going to add this fix into this PR so it's easier for everyone

* fix logic for when perc is 100 perc of the time
  • Loading branch information
@nagilson
nagilson authored Feb 25, 2025
1 parent 5c12fe2 commit bedc192
Show file tree
Hide file tree
Showing 4 changed files with 204 additions and 26 deletions.
79 changes: 64 additions & 15 deletions vscode-dotnet-runtime-library/src/Acquisition/DotnetConditionValidator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@
* Licensed to the .NET Foundation under one or more agreements.
* The .NET Foundation licenses this file to you under the MIT license.
*--------------------------------------------------------------------------------------------*/
import * as os from 'os';
import { DotnetFindPathDidNotMeetCondition, DotnetUnableToCheckPATHArchitecture } from '../EventStream/EventStreamEvents';
import { IDotnetFindPathContext } from '../IDotnetFindPathContext';
import { CommandExecutor } from '../Utils/CommandExecutor';
import { FileUtilities } from '../Utils/FileUtilities';
import { ICommandExecutor } from '../Utils/ICommandExecutor';
import { IUtilityContext } from '../Utils/IUtilityContext';
import { IDotnetListInfo } from './IDotnetListInfo';
import { DOTNET_INFORMATION_CACHE_DURATION_MS, SYS_CMD_SEARCH_CACHE_DURATION_MS } from './CacheTimeConstants';
import { IAcquisitionWorkerContext } from './IAcquisitionWorkerContext';
import { IDotnetConditionValidator } from './IDotnetConditionValidator';
import { IDotnetListInfo } from './IDotnetListInfo';
import * as versionUtils from './VersionUtilities';
import * as os from 'os';
import { FileUtilities } from '../Utils/FileUtilities';
import { DotnetFindPathDidNotMeetCondition, DotnetUnableToCheckPATHArchitecture } from '../EventStream/EventStreamEvents';
import { DOTNET_INFORMATION_CACHE_DURATION_MS, SYS_CMD_SEARCH_CACHE_DURATION_MS } from './CacheTimeConstants';

type simplifiedVersionSpec = 'equal' | 'greater_than_or_equal' | 'less_than_or_equal' |
'latestPatch' | 'latestFeature';

export class DotnetConditionValidator implements IDotnetConditionValidator
{
Expand Down Expand Up @@ -108,7 +110,7 @@ Please set the PATH to a dotnet host that matches the architecture ${requirement
const findSDKsCommand = await this.setCodePage() ? CommandExecutor.makeCommand(`chcp`, [`65001`, `|`, `"${existingPath}"`, '--list-sdks']) :
CommandExecutor.makeCommand(`"${existingPath}"`, ['--list-sdks']);

const sdkInfo = await (this.executor!).execute(findSDKsCommand, {dotnetInstallToolCacheTtlMs: DOTNET_INFORMATION_CACHE_DURATION_MS}, false).then((result) =>
const sdkInfo = await (this.executor!).execute(findSDKsCommand, { dotnetInstallToolCacheTtlMs: DOTNET_INFORMATION_CACHE_DURATION_MS }, false).then((result) =>
{
const sdks = result.stdout.split('\n').map((line) => line.trim()).filter((line) => line.length > 0);
const sdkInfos: IDotnetListInfo[] = sdks.map((sdk) =>
Expand All @@ -131,61 +133,108 @@ Please set the PATH to a dotnet host that matches the architecture ${requirement
{
// For Windows, we need to change the code page to UTF-8 to handle the output of the command. https://github.com/nodejs/node-v0.x-archive/issues/2190
// Only certain builds of windows support UTF 8 so we need to check that we can use it.
return os.platform() === 'win32' ? (await this.executor!.tryFindWorkingCommand([CommandExecutor.makeCommand('chcp', ['65001'])], {dotnetInstallToolCacheTtlMs: SYS_CMD_SEARCH_CACHE_DURATION_MS})) !== null : false;
return os.platform() === 'win32' ? (await this.executor!.tryFindWorkingCommand([CommandExecutor.makeCommand('chcp', ['65001'])], { dotnetInstallToolCacheTtlMs: SYS_CMD_SEARCH_CACHE_DURATION_MS })) !== null : false;
}

private stringVersionMeetsRequirement(availableVersion: string, requestedVersion: string, requirement: IDotnetFindPathContext): boolean
public stringVersionMeetsRequirement(availableVersion: string, requestedVersion: string, requirement: IDotnetFindPathContext): boolean
{
const availableMajor = Number(versionUtils.getMajor(availableVersion, this.workerContext.eventStream, this.workerContext));
const requestedMajor = Number(versionUtils.getMajor(requestedVersion, this.workerContext.eventStream, this.workerContext));
const requestedPatchStr: string | null = requirement.acquireContext.mode !== 'sdk' ? versionUtils.getRuntimePatchVersionString(requestedVersion, this.workerContext.eventStream, this.workerContext)
: versionUtils.getSDKCompleteBandAndPatchVersionString(requestedVersion, this.workerContext.eventStream, this.workerContext);
const requestedPatch = requestedPatchStr ? Number(requestedPatchStr) : null;

const adjustedVersionSpec: simplifiedVersionSpec = [requirement.versionSpecRequirement].map(x =>
{
switch (x)
{
case 'latestMajor':
return 'greater_than_or_equal';
case 'disable':
return 'equal';
default:
return x;
}
}).at(0)!;

if (availableMajor === requestedMajor)
{
const availableMinor = Number(versionUtils.getMinor(availableVersion, this.workerContext.eventStream, this.workerContext));
const requestedMinor = Number(versionUtils.getMinor(requestedVersion, this.workerContext.eventStream, this.workerContext));

if (availableMinor === requestedMinor && requestedPatch)
{
const availablePatchStr: string | null = requirement.acquireContext.mode !== 'sdk' ? versionUtils.getRuntimePatchVersionString(availableVersion, this.workerContext.eventStream, this.workerContext)
: versionUtils.getSDKCompleteBandAndPatchVersionString(availableVersion, this.workerContext.eventStream, this.workerContext);
const availablePatchStr: string | null = requirement.acquireContext.mode !== 'sdk' ?
versionUtils.getRuntimePatchVersionString(availableVersion, this.workerContext.eventStream, this.workerContext)
:
(() =>
{
const band = versionUtils.getSDKCompleteBandAndPatchVersionString(availableVersion, this.workerContext.eventStream, this.workerContext);
if (band)
{
return band;
}
return null;
})();
const availablePatch = availablePatchStr ? Number(availablePatchStr) : null;
switch (requirement.versionSpecRequirement)

const availableBandStr: string | null = requirement.acquireContext.mode === 'sdk' ?
(() =>
{
const featureBand = versionUtils.getFeatureBandFromVersion(availableVersion, this.workerContext.eventStream, this.workerContext, false);
if (featureBand)
{
return featureBand;
}
return null;
})() : null;
const availableBand = availableBandStr ? Number(availableBandStr) : null;

switch (adjustedVersionSpec)
{
// the 'availablePatch' must exist, since the version is from --list-runtimes or --list-sdks.
case 'equal':
return availablePatch === requestedPatch;
case 'greater_than_or_equal':
// the 'availablePatch' must exist, since the version is from --list-runtimes or --list-sdks.
case 'latestFeature':
return availablePatch! >= requestedPatch;
case 'less_than_or_equal':
return availablePatch! <= requestedPatch;
case 'latestPatch':
const requestedBandStr = requirement.acquireContext.mode === 'sdk' ? versionUtils.getFeatureBandFromVersion(requestedVersion, this.workerContext.eventStream, this.workerContext, false) ?? null : null;
const requestedBand = requestedBandStr ? Number(requestedBandStr) : null;
return availablePatch! >= requestedPatch && (availableBand ? availableBand === requestedBand : true);
}
}
else
{
switch (requirement.versionSpecRequirement)
switch (adjustedVersionSpec)
{
case 'equal':
return availableMinor === requestedMinor;
case 'greater_than_or_equal':
return availableMinor >= requestedMinor;
case 'less_than_or_equal':
return availableMinor <= requestedMinor;
case 'latestPatch':
case 'latestFeature':
return false
}
}
}
else
{
switch (requirement.versionSpecRequirement)
switch (adjustedVersionSpec)
{
case 'equal':
return false;
case 'greater_than_or_equal':
return availableMajor >= requestedMajor;
case 'less_than_or_equal':
return availableMajor <= requestedMajor;
case 'latestPatch':
case 'latestFeature':
return false
}
}
}
Expand Down Expand Up @@ -213,7 +262,7 @@ Please set the PATH to a dotnet host that matches the architecture ${requirement
const aspnetCoreString = 'Microsoft.AspNetCore.App';
const runtimeString = 'Microsoft.NETCore.App';

const runtimeInfo = await (this.executor!).execute(findRuntimesCommand, {dotnetInstallToolCacheTtlMs: DOTNET_INFORMATION_CACHE_DURATION_MS}, false).then((result) =>
const runtimeInfo = await (this.executor!).execute(findRuntimesCommand, { dotnetInstallToolCacheTtlMs: DOTNET_INFORMATION_CACHE_DURATION_MS }, false).then((result) =>
{
const runtimes = result.stdout.split('\n').map((line) => line.trim()).filter((line) => line.length > 0);
const runtimeInfos: IDotnetListInfo[] = runtimes.map((runtime) =>
Expand Down
15 changes: 14 additions & 1 deletion vscode-dotnet-runtime-library/src/DotnetVersionSpecRequirement.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@
* When this condition is used, the available version is compared to the required version.
* For example, if the request is made looking for 8.0 and allowing 'greater_than_or_equal', then 10.0 would be accepted,
* because 10.0 >= 8.0.
*
* In addition, certain values from globalJson's rollForward property are allowed.
latestPatch - Uses the latest installed patch level that matches the requested major, minor, and feature band with a patch level that's greater than or equal to the specified value.
If not found, fails. (in other words, 200 is not ok if we want 102.)
latestFeature Uses the highest installed feature band and patch level that matches the requested major and minor with a feature band and patch level that's greater than or equal to the specified value.
If not found, fails. (in other words, 200 is ok if we want 102, but 101 is not)
latestMajor This is the same as greater_than_or_equal.
disable - this is the same as equal.
*/
export type DotnetVersionSpecRequirement = 'equal' | 'greater_than_or_equal' | 'less_than_or_equal';
export type DotnetVersionSpecRequirement = 'equal' | 'greater_than_or_equal' | 'less_than_or_equal' |
'latestPatch' | 'latestFeature' | 'latestMajor' | 'disable'; // latestMinor not implemented since minor has not been used since 3.1

2 changes: 1 addition & 1 deletion vscode-dotnet-runtime-library/src/EventStream/EventStreamEvents.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1757,5 +1757,5 @@ export class TestAcquireCalled extends IEvent

function getDisabledTelemetryOnChance(percentIntToSend: number): { [disableTelemetryId: string]: boolean }
{
return { suppressTelemetry: Math.random() * 100 < percentIntToSend };
return { suppressTelemetry: !(Math.random() < percentIntToSend / 100) };
}
Loading

0 comments on commit bedc192

Please sign in to comment.