feat(firebase_analytics): retrieves appInstanceId property on native platforms if available

[willbryant]

Add an appInstanceId property on FirebaseAnalytics, exporting the API from the underlying native Firebase library implementations.

Description

This value is needed to send server-side events through the Measurement Protocol as a part of the same session, and also useful for debugging to pair up with the data visible in DebugView and BigQuery.

Related Issues

Replace this paragraph with a list of issues related to this PR from the issue database. Indicate, which of these issues are resolved or fixed by this PR. Note that you'll have to prefix the issue numbers with flutter/flutter#.

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.

[russellwheatley]

Hey @willbryant, nice work! Couple of things I'd like to see, please:

1. Could you add another mock test for the platform interface here?
2. Do you mind updating the java implementation to use the TaskCompletionSource like
   the example linked?

Thanks! 😄

[willbryant]

Thanks for the code review @russellwheatley!

I'll wait till your PR is merged and rebase, so I don't create a merge conflict.

Just to understand the second point, do we still need to use a TaskCompletionSource when we already have a Task? I think I'd need to Tasks.await to get the value out of that Task to pass to taskCompletionSource.setResult?

[russellwheatley]

Thanks for the code review @russellwheatley!

I'll wait till your PR is merged and rebase, so I don't create a merge conflict.

Just to understand the second point, do we still need to use a TaskCompletionSource when we already have a Task? I think I'd need to Tasks.await to get the value out of that Task to pass to taskCompletionSource.setResult?

@willbryant, yes, for consistency and to use the cachedThreadPool . You can do the following:

taskCompletionSource.setResult(Tasks.await(analytics.getAppInstanceId()));

[willbryant]

Cool, that's basically what I did.

I added a try/finally for consistency with the others.

[russellwheatley]

Hey @willbryant, do you mind also updating analytics web so that it throws this exception, please?

[willbryant]

Done, and squashed.

[russellwheatley]

Hey @willbryant, do you mind also adding an e2e test to analytics if possible? 😄

[google-oss-bot]

Hey @willbryant. We need more information to resolve this issue but there hasn't been an update in 7 weekdays. I'm marking the issue as stale and if there are no new updates in the next 7 days I will close it automatically.

If you have more information that will help us get to the bottom of this, just add a comment!

[willbryant]

@russellwheatley I can't get e2e tests to run for the life of me, but I've pushed a draft, if you wouldn't mind approving a CI run.

[willbryant]

Struggling a bit without CI access, can't get the main e2e test directory to run locally. But, I discovered there's a sort of second copy under example/ in the plugin itself, which showed the same issue, so using that I made a bit more progress.

Hopefully the next run works better.

[russellwheatley]

@willbryant run melos run format and all should be well. Tip for future: comment out all e2e tests here and run melos run test:e2e for testing analytics e2e (provided you've installed melos).

Some of the e2e's need the emulators running to work (e.g. firebase_database) so maybe that was your problem.

I'm also presuming you've ran melos bootstrap in the project directory 😄

[russellwheatley]

ahh, you'll have to run flutter format .in tests/ directory. Melos doesn't pick that up at the moment 😞

[willbryant]

Hopefully that's it, thanks for your help :).