Skip to content

Generate Generic Breaking Change Attribute #1508

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
VeryEarly merged 2 commits into from
Aug 26, 2025
+78 −57
Merged

Generate Generic Breaking Change Attribute #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e42d34
Generate Generic Breaking Change Attribute
isra-fel Aug 25, 2025
b10b0c3
try addressing lint error
isra-fel Aug 25, 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
133 changes: 77 additions & 56 deletions powershell/cmdlets/class.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1307,11 +1307,11 @@ export class CmdletClass extends Class {
description: `the body result as a <see cref="${each.language.csharp?.responseType.replace(/\[|\]|\?/g, '')}">${each.language.csharp?.responseType}</see> from the remote call`
}));
}

if (isBinary) {
parameters.push(new Parameter('response', System.Threading.Tasks.Task({ declaration: 'global::System.IO.Stream' }), { description: 'the body result as a <see cref="global::System.IO.Stream" /> from the remote call' }));
}

if (each.language.csharp?.headerType) {
parameters.push(new Parameter('headers', System.Threading.Tasks.Task({ declaration: each.language.csharp.headerType }), { description: `the header result as a <see cref="${each.language.csharp.headerType}" /> from the remote call` }));
}
Expand Down Expand Up @@ -2251,60 +2251,9 @@ export class CmdletClass extends Class {
//add breaking change attributes for cmdlet, variant, output type
if (operation.details.csharp.breakingChange) {
const breakingChange = operation.details.csharp.breakingChange;
if (breakingChange.cmdlet) {
const parameters = [];
if (!breakingChange.cmdlet.deprecateByVersion || !breakingChange.cmdlet.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}
parameters.push(`"${breakingChange.cmdlet.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.cmdlet.deprecateByVersion}"`);
if (breakingChange.cmdlet.changeInEfectByDate) parameters.push(`"${breakingChange.cmdlet.changeInEfectByDate}"`);
if (breakingChange.cmdlet.replacement) parameters.push(`ReplacementCmdletName = "${breakingChange.cmdlet.replacement}"`);
if (breakingChange.cmdlet.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.cmdlet.changeDescription}"`);

this.add(new Attribute(ClientRuntime.CmdletBreakingChangeAttribute, { parameters: parameters }));
}
if (breakingChange.variant) {
const parameters = [];
parameters.push(`new string[] {"${breakingChange.variant.name}"}`);
if (!breakingChange.variant.deprecateByVersion || !breakingChange.variant.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}
parameters.push(`"${breakingChange.variant.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.variant.deprecateByVersion}"`);
if (breakingChange.variant.changeInEfectByDate) parameters.push(`"${breakingChange.variant.changeInEfectByDate}"`);
if (breakingChange.variant.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.variant.changeDescription}"`);

this.add(new Attribute(ClientRuntime.ParameterSetBreakingChangeAttribute, { parameters: parameters }));
}
if (breakingChange.output) {
const parameters = [];
// if deprecated output types are set in directive, use it
if (breakingChange.output.deprecatedCmdLetOutputType) {
parameters.push(`"${breakingChange.output.deprecatedCmdLetOutputType}"`);
} else {
parameters.push(`"${outputTypes.values().next().value.replace(/typeof\((.*)\)/, '$1')}"`);
}
if (!breakingChange.output.deprecateByVersion || !breakingChange.output.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}
parameters.push(`"${breakingChange.output.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.output.deprecateByVersion}"`);
if (breakingChange.output.changeInEfectByDate) parameters.push(`"${breakingChange.output.changeInEfectByDate}"`);
if (breakingChange.output.replacement) parameters.push(`ReplacementCmdletOutputType = "${breakingChange.output.replacement}"`);
if (breakingChange.output.deprecatedOutputProperties) {
const properties: Array<string> = Object.assign([], breakingChange.output.deprecatedOutputProperties);
properties.forEach((element, index) => properties[index] = '"' + element + '"');
parameters.push(`DeprecatedOutputProperties = new string[] {${properties.join(',')}}`);
}
if (breakingChange.output.newOutputProperties) {
const properties: Array<string> = Object.assign([], breakingChange.output.newOutputProperties);
properties.forEach((element, index) => properties[index] = '"' + element + '"');
parameters.push(`NewOutputProperties = new string[] {${properties.join(',')} } `);
}
if (breakingChange.output.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.output.changeDescription}"`);

this.add(new Attribute(ClientRuntime.OutputBreakingChangeAttribute, { parameters: parameters }));
const breakingChangeAttribute = this.inferBreakingChangeAttribute(breakingChange, outputTypes);
if (breakingChangeAttribute) {
this.add(breakingChangeAttribute);
}
}

Expand Down Expand Up @@ -2350,4 +2299,76 @@ export class CmdletClass extends Class {
this.add(new Attribute(NotSuggestDefaultParameterSetAttribute));
}
}

private inferBreakingChangeAttribute(breakingChange: any, outputTypes: Set<string>) : Attribute | null {
if (breakingChange.cmdlet) {
const parameters = [];
if (!breakingChange.cmdlet.deprecateByVersion || !breakingChange.cmdlet.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}

if (!breakingChange.cmdlet.replacement && breakingChange.cmdlet.changeDescription) {

@isra-fel isra-fel Aug 26, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The core logic of this PR is this if-else. In the case when user preannounces a breaking change with changeDescription, we should prioritize showing it instead of the hardcoded "The cmdlet is being deprecated without replacement".

On the other hand, GenericBreakingChangeAttribute is a more fitting type than CmdletBreakingChangeAttribute in this case.

// use GenericBreakingChangeAttribute because CmdletBreakingChangeAttribute has a predefined message that's weired
// when the change description is present https://github.com/Azure/autorest.powershell/issues/1487
parameters.push('""');
parameters.push(`"${breakingChange.cmdlet.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.cmdlet.deprecateByVersion}"`);
parameters.push(`ChangeDescription = "${breakingChange.cmdlet.changeDescription}"`);
if (breakingChange.cmdlet.changeInEfectByDate) parameters.push(`"${breakingChange.cmdlet.changeInEfectByDate}"`);
return new Attribute(ClientRuntime.GenericBreakingChangeAttribute, { parameters: parameters });
} else {
// use CmdletBreakingChangeAttribute
parameters.push(`"${breakingChange.cmdlet.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.cmdlet.deprecateByVersion}"`);
if (breakingChange.cmdlet.changeInEfectByDate) parameters.push(`"${breakingChange.cmdlet.changeInEfectByDate}"`);
if (breakingChange.cmdlet.replacement) parameters.push(`ReplacementCmdletName = "${breakingChange.cmdlet.replacement}"`);
if (breakingChange.cmdlet.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.cmdlet.changeDescription}"`);

return new Attribute(ClientRuntime.CmdletBreakingChangeAttribute, { parameters: parameters });
}
}
if (breakingChange.variant) {
const parameters = [];
parameters.push(`new string[] {"${breakingChange.variant.name}"}`);
if (!breakingChange.variant.deprecateByVersion || !breakingChange.variant.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}
parameters.push(`"${breakingChange.variant.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.variant.deprecateByVersion}"`);
if (breakingChange.variant.changeInEfectByDate) parameters.push(`"${breakingChange.variant.changeInEfectByDate}"`);
if (breakingChange.variant.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.variant.changeDescription}"`);

return new Attribute(ClientRuntime.ParameterSetBreakingChangeAttribute, { parameters: parameters });
}
if (breakingChange.output) {
const parameters = [];
// if deprecated output types are set in directive, use it
if (breakingChange.output.deprecatedCmdLetOutputType) {
parameters.push(`"${breakingChange.output.deprecatedCmdLetOutputType}"`);
} else {
parameters.push(`"${outputTypes.values().next().value.replace(/typeof\((.*)\)/, '$1')}"`);
}
if (!breakingChange.output.deprecateByVersion || !breakingChange.output.deprecateByAzVersion) {
throw new Error('Cmdlet breaking change requires both \'deprecateByVersion\' and \'deprecateByAzVersion\', please refer to https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/breakingchange-for-autogen-module.md for more details.');
}
parameters.push(`"${breakingChange.output.deprecateByAzVersion}"`);
parameters.push(`"${breakingChange.output.deprecateByVersion}"`);
if (breakingChange.output.changeInEfectByDate) parameters.push(`"${breakingChange.output.changeInEfectByDate}"`);
if (breakingChange.output.replacement) parameters.push(`ReplacementCmdletOutputType = "${breakingChange.output.replacement}"`);
if (breakingChange.output.deprecatedOutputProperties) {
const properties: Array<string> = Object.assign([], breakingChange.output.deprecatedOutputProperties);
properties.forEach((element, index) => properties[index] = '"' + element + '"');
parameters.push(`DeprecatedOutputProperties = new string[] {${properties.join(',')}}`);
}
if (breakingChange.output.newOutputProperties) {
const properties: Array<string> = Object.assign([], breakingChange.output.newOutputProperties);
properties.forEach((element, index) => properties[index] = '"' + element + '"');
parameters.push(`NewOutputProperties = new string[] {${properties.join(',')} } `);
}
if (breakingChange.output.changeDescription) parameters.push(`ChangeDescription = "${breakingChange.output.changeDescription}"`);

return new Attribute(ClientRuntime.OutputBreakingChangeAttribute, { parameters: parameters });
}
return null;
}
}
2 changes: 1 addition & 1 deletion powershell/llcsharp/clientruntime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const ClientRuntime = intersect(clientRuntimeNamespace, {
InfoAttribute: new ClassType(clientRuntimeNamespace, 'Info'),
CompleterInfoAttribute: new ClassType(clientRuntimeNamespace, 'CompleterInfo'),
DefaultInfoAttribute: new ClassType(clientRuntimeNamespace, 'DefaultInfo'),
GeneraricBreakingChangeAttribute: new ClassType(clientRuntimeNamespace, 'GeneraricBreakingChange'),
GenericBreakingChangeAttribute: new ClassType(clientRuntimeNamespace, 'GenericBreakingChange'),
CmdletBreakingChangeAttribute: new ClassType(clientRuntimeNamespace, 'CmdletBreakingChange'),
ParameterSetBreakingChangeAttribute: new ClassType(clientRuntimeNamespace, 'ParameterSetBreakingChange'),
OutputBreakingChangeAttribute: new ClassType(clientRuntimeNamespace, 'OutputBreakingChange'),
Expand Down
Loading