Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

iOS: Migrate FlutterEngineGroup to ARC #55503

Merged
merged 5 commits into from
Sep 30, 2024

Conversation

cbracken
Copy link
Member

@cbracken cbracken commented Sep 28, 2024

This migrates FlutterEngineGroup to automatic reference counting. It also migrates enginesCreatedCount from an ivar to property syntax.

I'll look at migrating engine from NSMutableArray<NSValue*> to a weak pointer array in a followup patch since it's orthogonal to ARC migration.

Issue: flutter/flutter#137801

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I secretly hope people will start referring to me as the dARC knight.
  • I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@stuartmorgan
Copy link
Contributor

test-exempt: code refactor with no semantic change

@cbracken
Copy link
Member Author

cbracken commented Sep 30, 2024

FYI your comment says you changed this but it's still strong in the PR.

entrypointArgs should be strong; it's created by the FlutterEngineGroup and only ever used internally. I changed project to copy (for consistency with name, both of which are copied from the initialiser args.

This migrates FlutterEngineGroup to automatic reference counting. It
also migrates `enginesCreatedCount` from an ivar to property syntax.

In a followup cleanup, I'll look at migrating engine from
`NSMutableArray<NSValue*>` to a weak pointer array.

Issue: flutter/flutter#137801
@cbracken cbracken force-pushed the arc-migration-2-FlutterEngineGroup branch from 9e32a9c to 675c2b2 Compare September 30, 2024 16:53
@cbracken
Copy link
Member Author

Rebased -- turns out FlutterEngineGroup is alphabetically right next to FlutterHeadlessEngine in the build file.

@stuartmorgan
Copy link
Contributor

entrypointArgs should be strong; it's created by the FlutterEngineGroup and only ever used internally.

Internally to the engine maybe, but it's a public field of the class, and unless there's some very compelling reason, non-private collections should be copy. NSArray is CoW, so if it's never actually changed the copy is free anyway.

@cbracken
Copy link
Member Author

cbracken commented Sep 30, 2024

Internally to the engine maybe, but it's a public field of the class.

Is that the case even if it's not exposed in a public header?

Ah sorry -- GitHub comments never cease to confuse me. I didn't look at the filename, and was mixing it up with my recollection of this field which is non-public:

@property(nonatomic, strong) NSMutableArray<NSValue*>* engines;

Alright, yes -- fixing the other one. Thanks for spotting.

@cbracken cbracken added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 30, 2024
@auto-submit auto-submit bot merged commit 5e08e4f into flutter:main Sep 30, 2024
30 checks passed
@cbracken cbracken deleted the arc-migration-2-FlutterEngineGroup branch September 30, 2024 17:57
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 30, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Sep 30, 2024
…155952)

flutter/engine@b466a0d...e61bc85

2024-09-30 [email protected] fix use_of_uninitialized_value in message_loop_task_queues.cc (flutter/engine#55520)
2024-09-30 [email protected] iOS: Migrate FlutterEngineGroup to ARC (flutter/engine#55503)
2024-09-30 [email protected] Reland [skwasm] Scene builder optimizations for platform view placement (flutter/engine#55468)
2024-09-30 [email protected] Roll Dart SDK from c55ae50d619a to 79863e31de87 (1 revision) (flutter/engine#55525)
2024-09-30 [email protected] Roll Skia from 06721a724831 to dfeeb199b226 (2 revisions) (flutter/engine#55524)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Oct 1, 2024
…lutter#155952)

flutter/engine@b466a0d...e61bc85

2024-09-30 [email protected] fix use_of_uninitialized_value in message_loop_task_queues.cc (flutter/engine#55520)
2024-09-30 [email protected] iOS: Migrate FlutterEngineGroup to ARC (flutter/engine#55503)
2024-09-30 [email protected] Reland [skwasm] Scene builder optimizations for platform view placement (flutter/engine#55468)
2024-09-30 [email protected] Roll Dart SDK from c55ae50d619a to 79863e31de87 (1 revision) (flutter/engine#55525)
2024-09-30 [email protected] Roll Skia from 06721a724831 to dfeeb199b226 (2 revisions) (flutter/engine#55524)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App platform-ios
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants