[xamlg] improve error for Xamarin.Forms namespace #19683
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanpeppers
requested review from
mattleibow,
jsuarezruiz and
StephaneDelcroix
jsuarezruiz
previously approved these changes
Jan 8, 2024
| @@ -3,6 +3,7 @@ namespace Microsoft.Maui.Controls.Xaml | |||
| { | |||
| static partial class XamlParser | |||
| { | |||
| public const string FormsUri = "http://xamarin.com/schemas/2014/forms"; | |||
There was a problem hiding this comment.
I don't like reintroducing the old namespace in the source code
There was a problem hiding this comment.
Should I put [Obsolete] on it? and just ignore the warning in one place?
Fixes: dotnet#18637 Using the old namespace `http://xamarin.com/schemas/2014/forms` was causing a NRE: System.NullReferenceException: Object reference not set to an instance of an object. at Microsoft.Maui.Controls.Xaml.XmlTypeXamlExtensions.GetTypeReference[T](XmlType xmlType, IEnumerable`1 xmlnsDefinitions, String defaultAssemblyName, Func`2 refFromTypeInfo) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GetTypeNameFromCustomNamespace(XmlType xmlType, Compilation compilation, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GetTypeName(XmlType xmlType, Compilation compilation, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.TryParseXaml(SourceText text, String uid, Compilation compilation, AssemblyCaches caches, CancellationToken cancellationToken, String targetFramework, String& accessModifier, String& rootType, String& rootClrNamespace, Boolean& generateDefaultCtor, Boolean& addXamlCompilationAttribute, Boolean& hideFromIntellisense, Boolean& xamlResourceIdOnly, String& baseType, IEnumerable`1& namedFields, Exception& exception) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GenerateXamlCodeBehind(ProjectItem projItem, Compilation compilation, SourceProductionContext context, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.<>c.<Initialize>b__1_1(SourceProductionContext sourceProductionContext, ValueTuple`3 provider) at Microsoft.CodeAnalysis.UserFunctionExtensions.<>c__DisplayClass3_0`2.<WrapUserAction>b__0(TInput1 input1, TInput2 input2, CancellationToken token) In f939049, I inadvertently introduced this NRE, but even after fixing it, I would instead get: FormsNamespace.xaml.sg.cs(15,48): error CS1001: Identifier expected Due to the namespace, type, and base type all being `null` in this case, the generated C# is invalid. Instead of generating C# *at all*, let's emit an error message that says to use the correct namespace. I also provided a `Location` for the error message, so we will now know what file the error originated from. I attempted to write some test here, but adding an invalid file like this causes the XAML unit tests project to fail to build. It feels like we actually need to create a unit test project for the source generator -- as there isn't one now.
jonathanpeppers
force-pushed
the
FixFormsXmlNamespace
branch
from
605f06a
to
fb69d19
Compare
StephaneDelcroix
approved these changes
Jan 15, 2024
jfversluis
approved these changes
Jan 15, 2024
rmarinho
added a commit
that referenced
this pull request
Jan 15, 2024
* Fix issue 18110 * Fix SetProgressViewOffset on SwipeRefreshLayout (#19767) * Fix SetProgressViewOffset on SwipeRefreshLayout * - update refresh icon to a better color to trigger screen shot comparison * - remove extra code * - add better exception * Fix incorrect defaults when adding non-BindableObject as AbsoluteLayout child (#19839) * [Windows] Show the Raw HTML for Html Label in case of error (#17470) * Show the Raw HTML in case of error * Try to add UITest for Broken HTML * added optional ReceiveSms permission (#19659) * iOS Keyboard Scrolling Improvements and UITests (not from fork) (#17670) * Squash all the iOS Keyboard Improvements * delay was enough manually, but not for tests * remove debugging * Add logic for Disconnect to be more useful * fix spacing from github merge conflict commit * accidently removed a var declaration * Improve UITests and add double scroll for LargeTitles * Add UITest for the grid star * Style changes * more style * add fixtureTeardown * only check for LargeTitles in portrait mode * Add changes for LargeTitles on iPad * remove the popover code until we get tests * [ci] Bump XCode to 15.2.0 (#19836) * [ci] Bump XCode to 15.1.0 * Go to Xcode 15.2 * New xcode 15.1 doesn't support 14.5 simulators * Add missing AbsoluteLayout section to layout architecture doc (#19841) * [ci] Don't install xharness globally (#19863) * dont install xharness globally * Fix restore * Update README.md (#19797) * [xamlg] improve error for Xamarin.Forms namespace (#19683) * [xamlg] improve error for Xamarin.Forms namespace Fixes: #18637 Using the old namespace `http://xamarin.com/schemas/2014/forms` was causing a NRE: System.NullReferenceException: Object reference not set to an instance of an object. at Microsoft.Maui.Controls.Xaml.XmlTypeXamlExtensions.GetTypeReference[T](XmlType xmlType, IEnumerable`1 xmlnsDefinitions, String defaultAssemblyName, Func`2 refFromTypeInfo) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GetTypeNameFromCustomNamespace(XmlType xmlType, Compilation compilation, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GetTypeName(XmlType xmlType, Compilation compilation, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.TryParseXaml(SourceText text, String uid, Compilation compilation, AssemblyCaches caches, CancellationToken cancellationToken, String targetFramework, String& accessModifier, String& rootType, String& rootClrNamespace, Boolean& generateDefaultCtor, Boolean& addXamlCompilationAttribute, Boolean& hideFromIntellisense, Boolean& xamlResourceIdOnly, String& baseType, IEnumerable`1& namedFields, Exception& exception) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.GenerateXamlCodeBehind(ProjectItem projItem, Compilation compilation, SourceProductionContext context, AssemblyCaches caches) at Microsoft.Maui.Controls.SourceGen.CodeBehindGenerator.<>c.<Initialize>b__1_1(SourceProductionContext sourceProductionContext, ValueTuple`3 provider) at Microsoft.CodeAnalysis.UserFunctionExtensions.<>c__DisplayClass3_0`2.<WrapUserAction>b__0(TInput1 input1, TInput2 input2, CancellationToken token) In f939049, I inadvertently introduced this NRE, but even after fixing it, I would instead get: FormsNamespace.xaml.sg.cs(15,48): error CS1001: Identifier expected Due to the namespace, type, and base type all being `null` in this case, the generated C# is invalid. Instead of generating C# *at all*, let's emit an error message that says to use the correct namespace. I also provided a `Location` for the error message, so we will now know what file the error originated from. I attempted to write some test here, but adding an invalid file like this causes the XAML unit tests project to fail to build. It feels like we actually need to create a unit test project for the source generator -- as there isn't one now. * Add `[Obsolete]` to `FormsUri` --------- Co-authored-by: Mike Parker <mikeparker104> Co-authored-by: Shane Neuville <shneuvil@microsoft.com> Co-authored-by: E.Z. Hart <hartez@users.noreply.github.com> Co-authored-by: Tim Miller <drasticactions@users.noreply.github.com> Co-authored-by: Mike Parker <mikeparker104@users.noreply.github.com> Co-authored-by: Georgy <tarasverq@yandex.ru> Co-authored-by: TJ Lambert <50846373+tj-devel709@users.noreply.github.com> Co-authored-by: James Montemagno <james.montemagno@gmail.com> Co-authored-by: Jonathan Peppers <jonathan.peppers@microsoft.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #18637
Using the old namespace
http://xamarin.com/schemas/2014/formswas causing a NRE:In f939049, I inadvertently introduced this NRE, but even after fixing it, I would instead get:
Due to the namespace, type, and base type all being
nullin this case, the generated C# is invalid.Instead of generating C# at all, let's emit an error message that says to use the correct namespace.
I also provided a
Locationfor the error message, so we will now know what file the error originated from.I attempted to write some test here, but adding an invalid file like this causes the XAML unit tests project to fail to build. It feels like we actually need to create a unit test project for the source generator -- as there isn't one now.