refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side #9334

russellwheatley · 2022-08-10T15:22:55Z

Description

Removed the handler system on the Method channel. android & iOS track the HttpMetric & Trace instances on their implementations. This makes it much safer and easier to understand.

Something that I wasn't sure on was behaviour for hot restart. Implementation will now stop() and remove all HttpMetric & Trace instances on a hot restart. android & iOS.

I've also added additional e2e tests for start() and stop(). You can now start() and stop() HttpMetric & Trace instances as many times as you wish (They only go to the native side on the first start() and stop(). So no side effects to calling multiple times.)

To clarify, HttpMetric & Trace are a one time only transaction. Once stopped, they are removed on the native side.

I've also committed like the following to make it a bit easier to follow:

Dart (method channel implementation, e2e tests, unit tests)
iOS
android
example app (last 2 commits)

Related Issues

fixes #7465, #7447

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

I read the Contributor Guide and followed the process outlined there for submitting PRs.
My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
All existing and new tests are passing.
I updated/added relevant documentation (doc comments with ///).
The analyzer (melos run analyze) does not report any problems on my PR.
I read and followed the Flutter Style Guide.
I signed the CLA.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change.
No, this is not a breaking change.

…dart code)

…iOS code)

…android code)

…example app code)

rwrz

Did a quick code review, everything seems fine to me.
I will start to use it, here on my dev machine, to ensure nothing is missing. Thanks for the great work!

rwrz · 2022-09-27T17:59:03Z

btw, the question is, do you need someone to review it?

russellwheatley · 2022-09-28T07:44:11Z

@rwrz - thanks! We'll aim to get this PR merged at some point next week hopefully 🤞. In the mean time, if you do have any feedback could you update this channel, please? 😄

To your question, if you wish to leave a review, that would be awesome! The more eyes the better 💪 . However, the PR requires 2 approvals from contributors before it can be merged 👌

russellwheatley · 2022-10-06T08:06:35Z

@rwrz Have you started to use this in your project?

rwrz · 2022-10-06T10:27:52Z

Yes. We were using it in DEV for a while, and now it is going to production.

Lyokone

LGTM, I'm wondering if we should make it a major version since it's a major rewriting of the firebase_performance plugin? It would also help version it properly and revert back to a previous version if anything would go wrong?

russellwheatley · 2022-10-06T12:19:00Z

@Lyokone Agreed, I must've missed the (!) in the title 😓

# Conflicts: # packages/firebase_performance/firebase_performance/example/lib/firebase_config.dart

Ehesp · 2022-10-25T07:46:43Z

I'm a bit confused by the ! in the title - what about this change makes it breaking? It's mentioned about hot reload but could someone explain how that is effected here?

Ehesp · 2022-10-25T07:54:19Z

...rebase_performance_platform_interface/lib/src/method_channel/method_channel_http_metric.dart

    this._url,
    this._httpMethod,
  ) : super();

-  final int _methodChannelHandle;
-  final int _httpMetricHandle;
+  late final int _httpMetricHandle;


Could this not be simplified? Instead use int? _httpMetricHandle within the start/stop methods to detect whether it's been started/stopped already?

I've updated implementation, but you still need an additional boolean to check if it has ran once. Otherwise, you would set _httpMetricHandle to null again and you would be able to start/stop again.

russellwheatley · 2022-10-25T08:59:36Z

@Ehesp I've made it a breaking change because of the following reasons:

It will remove all Trace & HttpMetric instances on a hot reload (admittedly, probably not a good reason to make it a breaking change).
Previously, you could call start() stop() and it would keep hitting the native side creating new instance (or throwing exceptions as the case may be). Now, we stop it from hitting native and creating new instances.
It's a complete refactor of existing underlying implementation. Is it worth the risk not making it a breaking change?

rwrz · 2022-10-27T17:23:54Z

@russellwheatley I had to switch back to "master". Your implementation is lacking the possibility to create "custom traces".

MissingPluginException(No implementation found for method FirebasePerformance#newTrace on channel plugins.flutter.io/firebase_performance

russellwheatley · 2022-11-07T13:22:43Z

@rwrz you must be using the old version because that method channel call (FirebasePerformance#newTrace) does not exist on this PR. See here.

You can also check the CI which is running these Firebase Performance e2e tests for custom traces.

Successful CI run here

# Conflicts: # packages/firebase_performance/firebase_performance/example/.firebaserc # packages/firebase_performance/firebase_performance/example/android/app/google-services.json # packages/firebase_performance/firebase_performance/example/ios/Runner.xcodeproj/project.pbxproj # packages/firebase_performance/firebase_performance/example/ios/firebase_app_id_file.json # packages/firebase_performance/firebase_performance/example/lib/firebase_options.dart # packages/firebase_performance/firebase_performance/example/lib/main.dart

carlosfiori · 2022-12-15T15:13:28Z

Any update on this?

russellwheatley added 5 commits August 10, 2022 16:17

refactor(perf): refactor the handle system for method channels pt.1 (…

0340de7

…dart code)

refactor(perf): refactor the handle system for method channels pt.2 (…

f521cf0

…iOS code)

refactor(perf): refactor the handle system for method channels pt.3 (…

7bb6bd0

…android code)

refactor(perf): refactor the handle system for method channels pt.4 (…

01853c7

…example app code)

refactor(perf): refactor the handle system for method channels pt.4 (…

1c6f436

…example app code)

russellwheatley marked this pull request as ready for review August 11, 2022 09:32

russellwheatley added plugin: performance platform: android Issues / PRs which are specifically for Android. platform: ios Issues / PRs which are specifically for iOS. labels Aug 17, 2022

russellwheatley added 2 commits August 18, 2022 09:52

Merge branch 'master' into @russell/perf-7465

55426b8

Merge branch 'master' into @russell/perf-7465

2d708f1

russellwheatley mentioned this pull request Aug 23, 2022

🐛 [firebase_messaging, firestore] uses or overrides a deprecated API. on Android #8073

Closed

Merge branch 'master' into @russell/perf-7465

8b75570

rwrz reviewed Sep 27, 2022

View reviewed changes

Lyokone reviewed Oct 6, 2022

View reviewed changes

russellwheatley changed the title ~~refactor(firebase_performance): refactor "handler system" so the handlers are generated on native side~~ refactor(firebase_performance)!: refactor "handler system" so the handlers are generated on native side Oct 6, 2022

Lyokone approved these changes Oct 6, 2022

View reviewed changes

Merge branch 'master' into @russell/perf-7465

350c04c

# Conflicts: # packages/firebase_performance/firebase_performance/example/lib/firebase_config.dart

Ehesp reviewed Oct 25, 2022

View reviewed changes

chore(perf): improve implementation

49c9d23

russellwheatley added 3 commits October 25, 2022 10:05

chore(perf): improve implementation

49164bf

chore(perf): fix incorrect conditional

18b9e7d

Merge branch 'master' into @russell/perf-7465

04246db

russellwheatley requested a review from Ehesp October 25, 2022 12:51

Merge branch 'master' into @russell/perf-7465

c314659

russellwheatley added 3 commits November 17, 2022 14:45

Merge branch 'master' into @russell/perf-7465

01eee77

delete unneeded file

47697d1

russellwheatley added 2 commits December 23, 2022 11:56

test(perf): use constant var

2c47c05

chore(perf): ensure handle is set to avoid race condition

30d4ffe

russellwheatley changed the title ~~refactor(firebase_performance)!: refactor "handler system" so the handlers are generated on native side~~ refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side Dec 23, 2022

Merge branch 'master' into @russell/perf-7465

cab6596

Salakar approved these changes Dec 23, 2022

View reviewed changes

russellwheatley merged commit 08a4be6 into master Dec 23, 2022

russellwheatley deleted the @russell/perf-7465 branch December 23, 2022 14:45

firebase locked and limited conversation to collaborators Jan 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side #9334

refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side #9334

russellwheatley commented Aug 10, 2022 •

edited

Loading

rwrz left a comment

rwrz commented Sep 27, 2022

russellwheatley commented Sep 28, 2022 •

edited

Loading

russellwheatley commented Oct 6, 2022

rwrz commented Oct 6, 2022

Lyokone left a comment

russellwheatley commented Oct 6, 2022

Ehesp commented Oct 25, 2022

Ehesp Oct 25, 2022

russellwheatley Oct 25, 2022 •

edited

Loading

russellwheatley commented Oct 25, 2022 •

edited

Loading

rwrz commented Oct 27, 2022

russellwheatley commented Nov 7, 2022

carlosfiori commented Dec 15, 2022

refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side #9334

refactor(firebase_performance): refactor underlying implementation for the "handler system" so the handlers are generated on native side #9334

Conversation

russellwheatley commented Aug 10, 2022 • edited Loading

Description

Related Issues

Checklist

Breaking Change

rwrz left a comment

Choose a reason for hiding this comment

rwrz commented Sep 27, 2022

russellwheatley commented Sep 28, 2022 • edited Loading

russellwheatley commented Oct 6, 2022

rwrz commented Oct 6, 2022

Lyokone left a comment

Choose a reason for hiding this comment

russellwheatley commented Oct 6, 2022

Ehesp commented Oct 25, 2022

Ehesp Oct 25, 2022

Choose a reason for hiding this comment

russellwheatley Oct 25, 2022 • edited Loading

Choose a reason for hiding this comment

russellwheatley commented Oct 25, 2022 • edited Loading

rwrz commented Oct 27, 2022

russellwheatley commented Nov 7, 2022

carlosfiori commented Dec 15, 2022

russellwheatley commented Aug 10, 2022 •

edited

Loading

russellwheatley commented Sep 28, 2022 •

edited

Loading

russellwheatley Oct 25, 2022 •

edited

Loading

russellwheatley commented Oct 25, 2022 •

edited

Loading