Skip to content

[rush] Fix an issue where the rush-serve-plugin port parameter was allowed to be a string. #5104

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
iclanton merged 1 commit into from
Feb 11, 2025
Merged

[rush] Fix an issue where the rush-serve-plugin port parameter was allowed to be a string. #5104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions common/changes/@microsoft/rush/fix-parameter-kind_2025-02-11-20-25.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/rush",
"comment": "Fix an issue where the port parameter in `@rushstack/rush-serve-plugin` was allowed to be a string parameter.",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
24 changes: 11 additions & 13 deletions rush-plugins/rush-serve-plugin/src/phasedCommandHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ import {
type IOperationExecutionResult,
OperationStatus,
type IExecutionResult,
type ILogFilePaths
type ILogFilePaths,
RushConstants
} from '@rushstack/rush-sdk';
import { getProjectLogFolders } from '@rushstack/rush-sdk/lib/logic/operations/ProjectLogWritable';
import type { CommandLineStringParameter } from '@rushstack/ts-command-line';
import { type CommandLineIntegerParameter, CommandLineParameterKind } from '@rushstack/ts-command-line';

import { PLUGIN_NAME } from './constants';
import { type IRoutingRule, RushServeConfiguration } from './RushProjectServeConfigFile';
Expand Down Expand Up @@ -102,22 +103,19 @@ export async function phasedCommandHandler(options: IPhasedCommandHandlerOptions
let requestedPort: number = 0;

// If command-line.json has an existing parameter for specifying a port, use it
const portParameter: CommandLineStringParameter | undefined = portParameterLongName
? (customParameters.get(portParameterLongName) as CommandLineStringParameter)
const portParameter: CommandLineIntegerParameter | undefined = portParameterLongName
? (customParameters.get(portParameterLongName) as CommandLineIntegerParameter)
: undefined;
if (portParameter) {
const rawValue: string | undefined = portParameter.value;
const parsedValue: number = rawValue ? parseInt(rawValue, 10) : 0;
if (isNaN(parsedValue)) {
logger.terminal.writeErrorLine(
`Unexpected value "${rawValue}" for parameter "${portParameterLongName}". Expected an integer.`
);
throw new AlreadyReportedError();
if (portParameter.kind !== CommandLineParameterKind.Integer) {
throw new Error(`The "${portParameterLongName}" parameter must be an integer parameter`);
}
requestedPort = parsedValue;

requestedPort = portParameter.value ?? 0;
} else if (portParameterLongName) {
logger.terminal.writeErrorLine(
`Custom parameter "${portParameterLongName}" is not defined for command "${command.actionName}" in "command-line.json".`
`Custom parameter "${portParameterLongName}" is not defined for command "${command.actionName}" ` +
`in "${RushConstants.commandLineFilename}".`
);
throw new AlreadyReportedError();
}
Expand Down