stride3d / stride3d/stride

[Build] Assembly processor issues should dump exception to editor build modal

Open
#1,321 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-Build area-GameStudio bug
Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 12h
Merged PRs (30d)
54

Description

Release Type: Github, latest

Describe the bug
When the assembly processor is invoked from the editor building the project, be it when the project is opened, reloaded or played, exceptions generated within the assembly processor are not caught by the modal, just a generic issue specifying that it couldn't build the project.

To Reproduce
Steps to reproduce the behavior:

  1. Append the following to one of the components source added to a scene to trigger a serialization exception within the AssemblyProcessor:
public System.Collections.Generic.List<TestSerializationClass> ListTest = new System.Collections.Generic.List<TestSerializationClass>();
public TestSerializationClass TestObject = new TestSerializationClass();
public class TestSerializationClass
{
    public float testField;
}
  1. Build and run the project, the modal should show an error but not the exact exception

You should be able to see the actual exception within the output window of your IDE when running the project itself.

Expected behavior
Exception inside of the modal

Screenshots
The kind of obtuse issue this outputs:
image
When it should output the exception itself to help the user debug

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the AssemblyProcessor invocation used when building from the editor, then trace how its exceptions reach the editor build modal. Reproduce the serialization exception with the provided component code and compare the modal output with the IDE output window; done when the modal displays the actual exception instead of only the generic build failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.