mirror of https://github.com/icsharpcode/ILSpy.git
Browse Source
One member the decompiler could not handle aborted the whole export, so a single unsupported method in a large assembly left the user with nothing: no sources, no .csproj, no way around it. Recovering silently would trade that for a worse outcome - broken output nobody knows is broken - so every failure is recorded, written where the content would have gone, and pointed at the issue tracker. The recovery has to hold for anything the export touches, not just method bodies: a file that cannot be created, a resource that cannot be decoded, an output visitor that throws mid-type. Each of those costs its own unit and nothing else, and the units behind a failure are still produced - dropping them would make the export look complete when it is not. Consumers that relied on the exception keep their failure signal: ilspycmd exits non-zero and lists the failures, the PowerShell cmdlets raise an error record per failure, and the round-trip suite asserts the export reported none - otherwise a crash on a method its own tests never call would ship green. Assisted-by: Claude:claude-opus-5[1m]:Claude Codepull/3976/head
11 changed files with 832 additions and 77 deletions
@ -0,0 +1,39 @@ |
|||||||
|
// Copyright (c) 2026 Siegfried Pammer
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||||
|
// software and associated documentation files (the "Software"), to deal in the Software
|
||||||
|
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||||
|
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||||
|
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in all copies or
|
||||||
|
// substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||||
|
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||||
|
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||||
|
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||||
|
// DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
using System.Collections.Generic; |
||||||
|
using System.Management.Automation; |
||||||
|
|
||||||
|
namespace ICSharpCode.Decompiler.PowerShell |
||||||
|
{ |
||||||
|
static class DecompilationErrorReporting |
||||||
|
{ |
||||||
|
/// <summary>
|
||||||
|
/// Raises one non-terminating error per member the decompiler could not handle. The output
|
||||||
|
/// is produced either way - with the error text in place of the affected code - so without
|
||||||
|
/// this a script would take known-broken source for a clean decompilation.
|
||||||
|
/// </summary>
|
||||||
|
public static void WriteDecompilationErrors(this Cmdlet cmdlet, IReadOnlyList<DecompilerException> errors) |
||||||
|
{ |
||||||
|
foreach (var error in errors) |
||||||
|
{ |
||||||
|
cmdlet.WriteError(new ErrorRecord(error, ErrorIds.DecompilationFailed, ErrorCategory.NotSpecified, null)); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,145 @@ |
|||||||
|
// Copyright (c) 2026 Siegfried Pammer
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||||
|
// software and associated documentation files (the "Software"), to deal in the Software
|
||||||
|
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||||
|
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||||
|
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in all copies or
|
||||||
|
// substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||||
|
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||||
|
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||||
|
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||||
|
// DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
using System; |
||||||
|
using System.IO; |
||||||
|
using System.Linq; |
||||||
|
|
||||||
|
using ICSharpCode.Decompiler.CSharp; |
||||||
|
using ICSharpCode.Decompiler.CSharp.OutputVisitor; |
||||||
|
using ICSharpCode.Decompiler.CSharp.Syntax; |
||||||
|
using ICSharpCode.Decompiler.IL; |
||||||
|
using ICSharpCode.Decompiler.IL.Transforms; |
||||||
|
using ICSharpCode.Decompiler.Metadata; |
||||||
|
using ICSharpCode.Decompiler.TypeSystem; |
||||||
|
|
||||||
|
using NUnit.Framework; |
||||||
|
|
||||||
|
namespace ICSharpCode.Decompiler.Tests |
||||||
|
{ |
||||||
|
/// <summary>
|
||||||
|
/// A method body that cannot be decompiled must not take the surrounding type - or, when
|
||||||
|
/// exporting a project, the surrounding assembly - down with it. The failure is turned into
|
||||||
|
/// output the user can copy into a bug report, and decompilation continues.
|
||||||
|
/// </summary>
|
||||||
|
[TestFixture] |
||||||
|
public class DecompilationErrorRecoveryTests |
||||||
|
{ |
||||||
|
const string SimulatedFailure = "Simulated transform failure"; |
||||||
|
|
||||||
|
[Test] |
||||||
|
public void FailingMethodBodyKeepsTheRestOfTheType() |
||||||
|
{ |
||||||
|
var decompiler = CreateDecompiler(); |
||||||
|
decompiler.ILTransforms.Add(new ThrowingILTransform("CleanUpFileName")); |
||||||
|
|
||||||
|
string code = decompiler.DecompileTypeAsString( |
||||||
|
new FullTypeName("ICSharpCode.Decompiler.CSharp.ProjectDecompiler.WholeProjectDecompiler")); |
||||||
|
|
||||||
|
using (Assert.EnterMultipleScope()) |
||||||
|
{ |
||||||
|
Assert.That(code, Does.Contain(SimulatedFailure), "the exception text must show up in the output"); |
||||||
|
Assert.That(code, Does.Contain(CSharpDecompiler.DecompilationErrorReportUrl), "users need to be told where to report this"); |
||||||
|
Assert.That(code, Does.Contain("public static string CleanUpFileName"), "the failing member keeps its signature"); |
||||||
|
Assert.That(code, Does.Contain("DecompileProject"), "the other members of the type are unaffected"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
[Test] |
||||||
|
public void FailingMethodBodyIsRecordedAsError() |
||||||
|
{ |
||||||
|
var decompiler = CreateDecompiler(); |
||||||
|
decompiler.ILTransforms.Add(new ThrowingILTransform("CleanUpFileName")); |
||||||
|
|
||||||
|
decompiler.DecompileTypeAsString( |
||||||
|
new FullTypeName("ICSharpCode.Decompiler.CSharp.ProjectDecompiler.WholeProjectDecompiler")); |
||||||
|
|
||||||
|
var error = decompiler.Errors.Single(); |
||||||
|
Assert.That(error.Message, Does.Contain("CleanUpFileName")); |
||||||
|
} |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// <see cref="CSharpDecompiler.Errors"/> describes the decompilation that just ran, so a
|
||||||
|
/// reused instance must not report the previous one's failures against it.
|
||||||
|
/// </summary>
|
||||||
|
[Test] |
||||||
|
public void ErrorsCoverOnlyTheLastDecompilation() |
||||||
|
{ |
||||||
|
var decompiler = CreateDecompiler(); |
||||||
|
var failing = new ThrowingILTransform("CleanUpFileName"); |
||||||
|
decompiler.ILTransforms.Add(failing); |
||||||
|
decompiler.DecompileTypeAsString( |
||||||
|
new FullTypeName("ICSharpCode.Decompiler.CSharp.ProjectDecompiler.WholeProjectDecompiler")); |
||||||
|
|
||||||
|
decompiler.ILTransforms.Remove(failing); |
||||||
|
decompiler.DecompileTypeAsString( |
||||||
|
new FullTypeName("ICSharpCode.Decompiler.CSharp.ProjectDecompiler.WholeProjectDecompiler")); |
||||||
|
|
||||||
|
Assert.That(decompiler.Errors, Is.Empty); |
||||||
|
} |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// A member whose output throws is replaced by the error text, and writing carries on with
|
||||||
|
/// the rest of the type - a file cut off mid-member would leave the braces around it open
|
||||||
|
/// and every later type unreadable.
|
||||||
|
/// </summary>
|
||||||
|
[Test] |
||||||
|
public void FailingOutputKeepsTheFileWellFormed() |
||||||
|
{ |
||||||
|
var decompiler = CreateDecompiler(); |
||||||
|
var syntaxTree = decompiler.DecompileType( |
||||||
|
new FullTypeName("ICSharpCode.Decompiler.CSharp.ProjectDecompiler.WholeProjectDecompiler")); |
||||||
|
|
||||||
|
// A member that cannot be written: an expression node with no children to write.
|
||||||
|
var victim = syntaxTree.Descendants.OfType<MethodDeclaration>().First(m => m.Name == "CleanUpFileName"); |
||||||
|
victim.Body.Statements.Clear(); |
||||||
|
victim.Body.Statements.Add(new ExpressionStatement(new BinaryOperatorExpression())); |
||||||
|
|
||||||
|
var writer = new StringWriter(); |
||||||
|
var outputVisitor = new ErrorTolerantOutputVisitor(writer, new DecompilerSettings().CSharpFormattingOptions); |
||||||
|
syntaxTree.AcceptVisitor(outputVisitor); |
||||||
|
string code = writer.ToString(); |
||||||
|
|
||||||
|
using (Assert.EnterMultipleScope()) |
||||||
|
{ |
||||||
|
Assert.That(outputVisitor.Errors, Has.Count.EqualTo(1), "the failure is reported to the caller"); |
||||||
|
Assert.That(code, Does.Contain(CSharpDecompiler.DecompilationErrorReportUrl), "and shows up in the file"); |
||||||
|
Assert.That(code, Does.Contain("DecompileProject"), "the members after the failing one are still written"); |
||||||
|
Assert.That(code.Count(c => c == '{'), Is.EqualTo(code.Count(c => c == '}')), |
||||||
|
"every brace the failed member opened is closed again"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static CSharpDecompiler CreateDecompiler() |
||||||
|
{ |
||||||
|
var module = new PEFile("ICSharpCode.Decompiler.dll"); |
||||||
|
var settings = new DecompilerSettings(); |
||||||
|
var typeSystem = new DecompilerTypeSystem(module, new UniversalAssemblyResolver(null, false, null), settings); |
||||||
|
return new CSharpDecompiler(typeSystem, settings); |
||||||
|
} |
||||||
|
|
||||||
|
sealed class ThrowingILTransform(string methodName) : IILTransform |
||||||
|
{ |
||||||
|
public void Run(ILFunction function, ILTransformContext context) |
||||||
|
{ |
||||||
|
if (function.Parent == null && function.Method?.Name == methodName) |
||||||
|
throw new InvalidOperationException(SimulatedFailure); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,138 @@ |
|||||||
|
// Copyright (c) 2026 Siegfried Pammer
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||||
|
// software and associated documentation files (the "Software"), to deal in the Software
|
||||||
|
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||||
|
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||||
|
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in all copies or
|
||||||
|
// substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||||
|
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||||
|
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||||
|
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||||
|
// DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
using System; |
||||||
|
using System.Collections.Generic; |
||||||
|
using System.IO; |
||||||
|
|
||||||
|
using ICSharpCode.Decompiler.CSharp.Syntax; |
||||||
|
|
||||||
|
#nullable enable |
||||||
|
|
||||||
|
namespace ICSharpCode.Decompiler.CSharp.OutputVisitor |
||||||
|
{ |
||||||
|
/// <summary>
|
||||||
|
/// Writes a syntax tree like <see cref="CSharpOutputVisitor"/>, but a member whose output throws
|
||||||
|
/// is replaced by the error text instead of ending the file half-written. Writing resumes with
|
||||||
|
/// the next member, so the reader still gets the rest of the type and a file that closes every
|
||||||
|
/// brace it opened.
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// The failures are collected in <see cref="Errors"/>. An <see cref="IOException"/> from the
|
||||||
|
/// underlying writer is not something to recover from - every following write would fail the
|
||||||
|
/// same way - so it is left to propagate.
|
||||||
|
/// </remarks>
|
||||||
|
public class ErrorTolerantOutputVisitor : CSharpOutputVisitor |
||||||
|
{ |
||||||
|
readonly List<Exception> errors = new List<Exception>(); |
||||||
|
int braceDepth; |
||||||
|
|
||||||
|
public ErrorTolerantOutputVisitor(TextWriter textWriter, CSharpFormattingOptions formattingPolicy) |
||||||
|
: base(textWriter, formattingPolicy) |
||||||
|
{ |
||||||
|
} |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The failures that took the place of a member, in the order they were written.
|
||||||
|
/// </summary>
|
||||||
|
public IReadOnlyList<Exception> Errors => errors; |
||||||
|
|
||||||
|
protected override void OpenBrace(BraceStyle style, bool newLine = true) |
||||||
|
{ |
||||||
|
base.OpenBrace(style, newLine); |
||||||
|
braceDepth++; |
||||||
|
} |
||||||
|
|
||||||
|
protected override void CloseBrace(BraceStyle style, bool unindent = true) |
||||||
|
{ |
||||||
|
base.CloseBrace(style, unindent); |
||||||
|
braceDepth--; |
||||||
|
} |
||||||
|
|
||||||
|
public override void VisitTypeDeclaration(TypeDeclaration typeDeclaration) |
||||||
|
=> Write(typeDeclaration, base.VisitTypeDeclaration); |
||||||
|
|
||||||
|
public override void VisitDelegateDeclaration(DelegateDeclaration delegateDeclaration) |
||||||
|
=> Write(delegateDeclaration, base.VisitDelegateDeclaration); |
||||||
|
|
||||||
|
public override void VisitConstructorDeclaration(ConstructorDeclaration constructorDeclaration) |
||||||
|
=> Write(constructorDeclaration, base.VisitConstructorDeclaration); |
||||||
|
|
||||||
|
public override void VisitDestructorDeclaration(DestructorDeclaration destructorDeclaration) |
||||||
|
=> Write(destructorDeclaration, base.VisitDestructorDeclaration); |
||||||
|
|
||||||
|
public override void VisitEnumMemberDeclaration(EnumMemberDeclaration enumMemberDeclaration) |
||||||
|
=> Write(enumMemberDeclaration, base.VisitEnumMemberDeclaration); |
||||||
|
|
||||||
|
public override void VisitExtensionDeclaration(ExtensionDeclaration extensionDeclaration) |
||||||
|
=> Write(extensionDeclaration, base.VisitExtensionDeclaration); |
||||||
|
|
||||||
|
public override void VisitEventDeclaration(EventDeclaration eventDeclaration) |
||||||
|
=> Write(eventDeclaration, base.VisitEventDeclaration); |
||||||
|
|
||||||
|
public override void VisitCustomEventDeclaration(CustomEventDeclaration customEventDeclaration) |
||||||
|
=> Write(customEventDeclaration, base.VisitCustomEventDeclaration); |
||||||
|
|
||||||
|
public override void VisitFieldDeclaration(FieldDeclaration fieldDeclaration) |
||||||
|
=> Write(fieldDeclaration, base.VisitFieldDeclaration); |
||||||
|
|
||||||
|
public override void VisitFixedFieldDeclaration(FixedFieldDeclaration fixedFieldDeclaration) |
||||||
|
=> Write(fixedFieldDeclaration, base.VisitFixedFieldDeclaration); |
||||||
|
|
||||||
|
public override void VisitIndexerDeclaration(IndexerDeclaration indexerDeclaration) |
||||||
|
=> Write(indexerDeclaration, base.VisitIndexerDeclaration); |
||||||
|
|
||||||
|
public override void VisitMethodDeclaration(MethodDeclaration methodDeclaration) |
||||||
|
=> Write(methodDeclaration, base.VisitMethodDeclaration); |
||||||
|
|
||||||
|
public override void VisitOperatorDeclaration(OperatorDeclaration operatorDeclaration) |
||||||
|
=> Write(operatorDeclaration, base.VisitOperatorDeclaration); |
||||||
|
|
||||||
|
public override void VisitPropertyDeclaration(PropertyDeclaration propertyDeclaration) |
||||||
|
=> Write(propertyDeclaration, base.VisitPropertyDeclaration); |
||||||
|
|
||||||
|
void Write<T>(T node, Action<T> write) where T : AstNode |
||||||
|
{ |
||||||
|
int braces = braceDepth; |
||||||
|
int containers = containerStack.Count; |
||||||
|
try |
||||||
|
{ |
||||||
|
write(node); |
||||||
|
} |
||||||
|
catch (Exception ex) when (!(ex is OperationCanceledException || ex is IOException)) |
||||||
|
{ |
||||||
|
errors.Add(ex); |
||||||
|
// The failed member left the writer inside its own nodes and braces: unwind both, so
|
||||||
|
// what follows is written at the level the member started at.
|
||||||
|
while (containerStack.Count > containers) |
||||||
|
{ |
||||||
|
writer.EndNode(containerStack.Pop()); |
||||||
|
} |
||||||
|
while (braceDepth > braces) |
||||||
|
{ |
||||||
|
CloseBrace(BraceStyle.NextLine); |
||||||
|
} |
||||||
|
NewLine(); |
||||||
|
foreach (string line in CSharpDecompiler.GetErrorCommentLines(ex)) |
||||||
|
{ |
||||||
|
writer.WriteComment(CommentType.SingleLine, " " + line); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue