feat: add static code diagnostic check-for-equals-in-render-object-setters

[incendial]

What is the purpose of this pull request? (put an "X" next to an item)

• Documentation update
• Bug fix
• New rule
• Changes an existing rule
• Add autofixing to a rule
• Add a CLI option
• Add something to the core
• Other, please explain:

#997

[incendial]

@fzyzcjy if you have some time to take a look and test the rule - that'd be very much appreciated!

[github-actions]

Dart Code Metrics unused files report of dart_code_metrics. ✅

Summary

• Scanned package folders: bin, example, lib
• No unused files found! ✅

[github-actions]

Dart Code Metrics analyze report of dart_code_metrics. ✅

Summary

• Scanned folders: bin, example, lib, test

• Total scanned files: 506

• Total lines of source code: 8716

• Total classes: 379

• Average Cyclomatic Number per line of code: 0.36 / 1

• Average Source Lines of Code per method: 6

• Total tech debt: 2146.0 hours

• Found issues: 6 ⚠

[fzyzcjy]

Sure, let me have a look :)

As for testing, may not have time now, but you can run it on the flutter/flutter repo, and even possibly fire a bug :)

[fzyzcjy]

Good job! LGTM especially on the demo in the tests. But not sure how many false positives will happen in the real codebase - may need to run it actually :)

[codecov]

Codecov Report

Merging #1003 (f5861ae) into master (36baaa5) will increase coverage by 0.09%.
The diff coverage is 98.24%.

@@            Coverage Diff             @@
##           master    #1003      +/-   ##
==========================================
+ Coverage   87.36%   87.46%   +0.09%     
==========================================
  Files         311      313       +2     
  Lines        6571     6628      +57     
==========================================
+ Hits         5741     5797      +56     
- Misses        830      831       +1     

Impacted Files	Coverage Δ
...c/analyzers/lint_analyzer/rules/rules_factory.dart	71.42% <ø> (ø)
...k_for_equals_in_render_object_setters/visitor.dart	97.43% <97.43%> (ø)
...heck_for_equals_in_render_object_setters_rule.dart	100.00% <100.00%> (ø)
lib/src/utils/flutter_types_utils.dart	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[incendial]

Mostly false-positives with the case you pointed out before, but those:

• https://github.com/flutter/flutter/blob/7fba37848c9f3007795be2d67a3207067b7a0894/packages/flutter/lib/src/rendering/platform_view.dart#L323
• https://github.com/flutter/flutter/blob/8b3aabd61dfd7b7b525ae4be04093ba507d1455a/packages/flutter/lib/src/rendering/editable.dart#L596
• https://github.com/flutter/flutter/blob/a7fe235c8cd1ff64018443b0cca9a19a751642a6/packages/flutter/lib/src/rendering/paragraph.dart#L132
• https://github.com/flutter/flutter/blob/d3bc2bbcdd814beb343719d9b7fed58b3807675f/packages/flutter/lib/src/material/range_slider.dart#L891

look interesting. WDYT?

[fzyzcjy]

https://github.com/flutter/flutter/blob/a7fe235c8cd1ff64018443b0cca9a19a751642a6/packages/flutter/lib/src/rendering/paragraph.dart#L132

No problem since it "return" when "idential"

https://github.com/flutter/flutter/blob/8b3aabd61dfd7b7b525ae4be04093ba507d1455a/packages/flutter/lib/src/rendering/editable.dart#L596

No problem. Inside the inner setter, it is ok https://github.com/flutter/flutter/blob/8b3aabd61dfd7b7b525ae4be04093ba507d1455a/packages/flutter/lib/src/rendering/editable.dart#L2775

https://github.com/flutter/flutter/blob/d3bc2bbcdd814beb343719d9b7fed58b3807675f/packages/flutter/lib/src/material/range_slider.dart#L891

Seems no problem, the settings is a naive field without fancy heavy things

[fzyzcjy]

https://github.com/flutter/flutter/blob/7fba37848c9f3007795be2d67a3207067b7a0894/packages/flutter/lib/src/rendering/platform_view.dart#L323

I strongly suspect this is a bug. That is what I have said in the issue title - "maybe even apply this linter to check potential bugs in Flutter source code" :)

What about giving a PR to flutter repo fixing this 🎉

---

More details:

Where is the controller from?

Where is _UiKitPlatformView used?

Thus, seems like this is really a bug.

[incendial]

What about giving a PR to flutter repo fixing this 🎉

Do you want to do it? It's mostly your effort finding this 🙂

[fzyzcjy]

Do you want to do it?

Sure 🙂

[incendial]

@fzyzcjy found another place https://github.com/flutter/flutter/blob/2aa348b9407e96ffe4eca8e8f213c7984afad3f7/packages/flutter/lib/src/widgets/sliver_prototype_extent_list.dart#L135, WDYT?

[fzyzcjy]

@incendial Not very sure. The only interesting call is:

However it is named "insertRenderObjectChild", where by saying "insert" I suspect it will not happen unconditionally on every update. So I guess it is normal.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information