Handle CA1416 violations found in MAUI repo #6237

buyaa-n · 2022-04-19T15:39:58Z

Fix Platform Compatibility Analyzer CA1416 violations found in MAUI repo

There is several issues found while evaluating the violations:

Platform annotation issues in Microsoft.iOS assembly. Xamarin annotation related warnings, these are suppressed with a link to the issue so that it can be removed/evaluated again after the issue resolved:
#pragma warning disable CA1416 // https://github.com/xamarin/xamarin-macios/issues/14619
Plenty of warnings caused by unsupported APIs, MAUI team informed that those are mostly deprecated but still works, there is many more found in other projects which needs review from the team. These are mostly suppressed with TODO:
- #pragma warning disable CA1416 // TODO: 'UIApplication.KeyWindow' is unsupported on: 'ios' 13.0 and later.
- Or asserted: System.Diagnostics.Debug.Assert(!OperatingSystem.IsIOSVersionAtLeast(14));
Warnings caused by supported version of the API were mostly guarded as needed and the PR adds a few more guard, or propagates the warning to the caller with corresponding annotation in a very few cases it is suppressed which needs the team review in the future
There is a few known false positives that will not be fixed which are suppressed with: #pragma warning disable CA1416 // Known false positive with Lambda expression
Several analyzer bugs found and most of them fixed, the repo is dogfooding the analyzer build to consume the fixes. 2 scenarios haven't been fixed from False positives in flow analysis found in Platform compatibility analyzer roslyn-analyzers#5938, if def conditional with a negation operator is not working for related platforms (iOS and MacCatalyst), this violation found several times and all are suppressed
A few warnings found for CA1307;CA1309: Use ordinal StringComparison and fixed as needed

The PR now ready for review

Fixes #823

… bug fix

src/Controls/src/Core/Platform/Android/ColorChangeRevealDrawable.cs

src/Controls/src/Core/Platform/Android/Extensions/BrushExtensions.cs

mattleibow

Looking really good and this is a long running PR with loads of changes. And a extra 👍 for the follow up issue.

I added a few comments that I think are API binding errors, s o maybe we should just ignore for now.

And then Shane's comment on the Debug.Assert. If there are things that will throw at runtime, then maybe we should actually not execute?

mattleibow · 2022-04-27T10:09:22Z

src/Core/src/Platform/iOS/MauiRefreshView.cs

+#pragma warning disable CA1416 // TODO: 'UINavigationBar.PrefersLargeTitles' is only supported on: 'ios' 11.0 and later
+		bool CanUseRefreshControlProperty() => 
 			this.GetNavigationController()?.NavigationBar?.PrefersLargeTitles ?? true;
+#pragma warning restore CA1416


Should this not just use a => IsAtLeast(11) && this.xxx.Prefers == true?

I can do that, I was not sure because that could cause behavioral change, it is returning true if its null, which is strange

src/Core/src/Platform/Android/PickerManager.cs

src/Core/src/ImageSources/UriImageSourceService/UriImageSourceService.iOS.cs

src/Core/src/Handlers/Picker/PickerHandler.Android.cs

src/Core/src/Handlers/DatePicker/DatePickerHandler.iOS.cs

src/Core/src/Fonts/FontManager.iOS.cs

src/Controls/src/Core/Platform/iOS/ModalWrapper.cs

src/Controls/src/Core/Platform/Android/Extensions/ToolbarExtensions.cs

buyaa-n · 2022-04-27T22:46:20Z

I added a few comments that I think are API binding errors, s o maybe we should just ignore for now.

Thanks, suppressed with a link to the existing issues for iOS and Android

And then Shane's comment on the Debug.Assert. If there are things that will throw at runtime, then maybe we should actually not execute?

I have suppressed the Debug.Asserts @PureWeen pointed out. Now a few left, it will only throw in Debug mode, so could throw on dev's local builds/tests or on CI build/test, I thought that could be helpful to catch unsupported platforms during development, but should not cause issue for customers by assuming that they would only consume Release build. But if you guys prefer to suppress instead let me know, I can update.

Some of them got lost in dotnet#6237

#6636) * Restore and fix tvOS checks and annotations Some of them got lost in #6237 * Remove PlatformVersion and use OperatingSystem APIs directly

…n (#6636) * Restore and fix tvOS checks and annotations Some of them got lost in dotnet/maui#6237 * Remove PlatformVersion and use OperatingSystem APIs directly

buyaa-n added 26 commits March 29, 2022 12:29

Handling Platform compatability analyzer warnings

674ec32

Merge conflicts

728d6a7

Review updates

ffd6c24

Merge branch 'main' of https://github.com/dotnet/maui into pca_analyzer

6e8593f

dogfood 7.0 preview netanalyzer

3175677

Suppress warnings caused by annotations

1e810d9

Handle/suppress few more

40fe714

Apply some of the feedbacks, fix some typos

f451e8b

Merge branch 'main' of https://github.com/dotnet/maui into pca_analyzer

a730207

Apply some feedback, handle more warnings found in Core

d3b3858

Handle warnings in Core

34eab5f

Merge conflicts

5134650

Revert windows handlings, handling warnings in Compatibility

2bb7421

Handle warnings found in Compatibility

1a49bc7

Review updates, handle Blazor warnings

92ed958

Merge branch 'main' of https://github.com/dotnet/maui into pca_analyzer

30d6cc6

Suppress some conditionals, update analyzer version to dogfood latest…

050c645

… bug fix

Merge branch 'main' of https://github.com/dotnet/maui into pca_analyzer

ea469bd

Fix CI build failures, disable analyzer on test projects

baefefa

Fix more few failures found in CI run

bc20750

Small updates

700639d

Merge conflicts

2024b94

Propogate the ios version support

c50eaa6

Re review updates

aeed57a

Disable analyzers on test projects

438fbad

Propagate platform supports

1e8f7e4

buyaa-n requested a review from a team as a code owner April 19, 2022 15:39

buyaa-n and others added 3 commits April 19, 2022 09:36

Merge conflicts

b2f38d8

Revert "Disable analyzers on test projects"

a4497db

Merge branch 'main' into pca_analyzer2

f46a710

PureWeen requested review from PureWeen, Redth and mattleibow April 25, 2022 18:24

PureWeen requested changes Apr 25, 2022

View reviewed changes

src/Controls/src/Core/Platform/Android/ColorChangeRevealDrawable.cs Outdated Show resolved Hide resolved

src/Controls/src/Core/Platform/Android/Extensions/BrushExtensions.cs Outdated Show resolved Hide resolved

Suppress Paint.Color setter calls instead guarding

af61b10

buyaa-n force-pushed the pca_analyzer2 branch from 71696b6 to af61b10 Compare April 26, 2022 06:18

mattleibow reviewed Apr 27, 2022

View reviewed changes

This was referenced Apr 27, 2022

Paint.Color is attributed with [SupportedOSPlatform("android29.0")] causing warnings in Maui dotnet/android#6962

Closed

Platform annotation issues in Microsoft.iOS assembly dotnet/macios#14619

Closed

Apply more feedback

74fb449

buyaa-n added 4 commits April 27, 2022 15:49

Merge conflicts

ef64d83

Unsaved change missing from previous commit

98a722b

Merge branch 'main' of https://github.com/dotnet/maui into pca_analyzer2

6e50209

More SpannableString.Length() found with latest code

e266ac6

buyaa-n force-pushed the pca_analyzer2 branch from 37f629c to e266ac6 Compare April 28, 2022 03:28

mattleibow approved these changes Apr 28, 2022

View reviewed changes

PureWeen approved these changes Apr 28, 2022

View reviewed changes

mattleibow merged commit c963d0a into dotnet:main Apr 28, 2022

PureWeen mentioned this pull request Apr 28, 2022

Remove Debug.Asserts Added from this PR #6616

Closed

akoeplinger added a commit to akoeplinger/maui that referenced this pull request Apr 28, 2022

Restore and fix tvOS checks and annotations

74f9f7f

Some of them got lost in dotnet#6237

akoeplinger mentioned this pull request Apr 28, 2022

Restore and fix tvOS checks and annotations and remove PlatformVersion #6636

Merged

akoeplinger added a commit to akoeplinger/maui that referenced this pull request Apr 28, 2022

Restore and fix tvOS checks and annotations

59c06ab

Some of them got lost in dotnet#6237

buyaa-n deleted the pca_analyzer2 branch April 29, 2022 17:45

buyaa-n mentioned this pull request Apr 29, 2022

Remove remaining asserts from PR 6237 #6686

Merged

buyaa-n mentioned this pull request May 8, 2022

Reenable CA1416 in Essentials #6835

Merged

github-actions bot locked and limited conversation to collaborators Dec 23, 2023

samhouts added the fixed-in-6.0.300-rc.3 Look for this fix in 6.0.300-rc.3! label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Handle CA1416 violations found in MAUI repo #6237

Handle CA1416 violations found in MAUI repo #6237

Uh oh!

buyaa-n commented Apr 19, 2022

Uh oh!

Uh oh!

Uh oh!

mattleibow left a comment

Uh oh!

mattleibow Apr 27, 2022

Uh oh!

buyaa-n Apr 27, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

buyaa-n commented Apr 27, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Handle CA1416 violations found in MAUI repo #6237

Handle CA1416 violations found in MAUI repo #6237

Uh oh!

Conversation

buyaa-n commented Apr 19, 2022

Fix Platform Compatibility Analyzer CA1416 violations found in MAUI repo

Fixes #823

Uh oh!

Uh oh!

Uh oh!

mattleibow left a comment

Choose a reason for hiding this comment

Uh oh!

mattleibow Apr 27, 2022

Choose a reason for hiding this comment

Uh oh!

buyaa-n Apr 27, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

buyaa-n commented Apr 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

buyaa-n commented Apr 27, 2022 •

edited

Loading