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

[firebase_messaging] Declares Android Firebase Messaging dependency as api #1983

Conversation

josh-burton
Copy link
Contributor

Description

An app shouldn’t have to define the the Firebase Messaging dependency in order to access it, as it’s already included within this plugin. By declaring it as an api dependency, this allows the app to access it and removes an extra step from the setup.

Related Issues

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.

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • If the pull request affects only one plugin, the PR title starts with the name of the plugin in brackets (e.g. [cloud_firestore])
  • 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 (flutter analyze) does not report any problems on my PR.
  • I read and followed the [Flutter Style Guide].
  • I updated pubspec.yaml with an appropriate new version according to the [pub versioning philosophy].
  • I updated CHANGELOG.md to add a description of the change.
  • 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 (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@@ -61,18 +61,6 @@ for more.

By default background messaging is not enabled. To handle messages in the background:

1. Add the `com.google.firebase:firebase-messaging` dependency in your app-level `build.gradle` file that is typically located at `<app-name>/android/app/build.gradle`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens to apps that have already followed this step when they receive this change? Will gradle complain in an actionable way, or is this going to break consumers of the plugin?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No there won't be any conflicts, the user would effectively just be redeclaring a dependency already available to them. Gradles dependency resolution will handle everything.

…o be accessed from the app

An app shouldn’t have to define the the Firebase Messaging dependency in order to access it, as it’s already included within this plugin. By declaring it as an `api` dependency, this allows the app to access it and removes an extra step from the setup.
@josh-burton josh-burton force-pushed the firebase-messaging-api-dependency branch from 11a8887 to 5a65868 Compare March 24, 2020 20:11
@josh-burton josh-burton requested a review from ditman March 24, 2020 22:02
@josh-burton
Copy link
Contributor Author

@kroikie any chance of a review here?

@Salakar Salakar closed this in #4012 Nov 3, 2020
@firebase firebase locked and limited conversation to collaborators Dec 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants