Cloud messaging service package

A brick that generates a Firebase cloud messaging flutter project with useful functions for listening to, displaying and handling notifications.

How to use 🚀

mason make cloud_messaging_service_package

Outputs 📦

.
├── CHANGELOG.md
├── README.md
├── analysis_options.yaml
├── lib
│   ├── cloud_messaging_service.dart
│   └── src
│       └── cloud_messaging_service.dart
├── melos_cloud_messaging_service.iml
├── pubspec.lock
├── pubspec.yaml
└── test
    └── src
        └── cloud_messaging_service_test.dart``

Service

import 'dart:async';
import 'dart:convert';
import 'dart:developer';

import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:flutter/rendering.dart';
import 'package:flutter_local_notifications/flutter_local_notifications.dart';
import 'package:logger/logger.dart';

typedef OnMessage = void Function(Map<String, dynamic> message);

class CloudMessagingService {
  CloudMessagingService({
    FirebaseMessaging? firebaseMessaging,
    Logger? logger,
    OnMessage? messageHandler,
  })  : _firebaseMessaging = firebaseMessaging ?? FirebaseMessaging.instance,
        _logger = logger ?? Logger(),
        _messageHandler = messageHandler {
    _requestPermissions();
    _onBackgroundMessage();
    _onForegroundMessage();
    _handleMessageInteraction();
  }

  final FirebaseMessaging _firebaseMessaging;
  final Logger _logger;
  final OnMessage? _messageHandler;

  static final _localNotificationsPlugin = FlutterLocalNotificationsPlugin();

  static const AndroidNotificationChannel _channel = AndroidNotificationChannel(
    'high_importance_channel', // id
    'High Importance Notifications', // title
    description: 'This channel is used for important notifications.',
    importance: Importance.max,
  );

  Future<String?> get token async {
    final response = await _firebaseMessaging.getToken();
    _logger.d('FCM token: $response');

    return response;
  }

  Future<bool> _requestPermissions() async {
    _logger.d('Requesting permissions');
    try {
      final response = await _firebaseMessaging.requestPermission();

      return response.authorizationStatus == AuthorizationStatus.authorized;
    } on Exception catch (e, s) {
      _logger.e('Error requesting permissions', e, s);

      return false;
    }
  }

  /// Listen to foreground notifications
  StreamSubscription<RemoteMessage> _onForegroundMessage() {
    return FirebaseMessaging.onMessage.listen(
      (RemoteMessage message) {
        _logger.d('Foreground message received, data: ${message.data}');

        if (message.notification != null) {
          _logger.d(
            'Message has notification, '
            'notification: ${message.notification?.title}',
          );
          _displayNotificationsAndroid(message);
        }
      },
    );
  }

  /// Listen to background notifications
  void _onBackgroundMessage() {
    return FirebaseMessaging.onBackgroundMessage(_backgroundMessageHandler);
  }

  static Future<void> _backgroundMessageHandler(RemoteMessage message) async {
    await Firebase.initializeApp();

    log(
      'Background message received, '
      'data: ${message.data}, '
      'notification: ${message.notification?.title}',
    );
  }

  static void _displayNotificationsAndroid(RemoteMessage message) {
    final notification = message.notification;
    final android = message.notification?.android;

    if (notification == null || android == null) {
      return;
    }

    final androidNotificationDetails = AndroidNotificationDetails(
      _channel.id,
      _channel.name,
      channelDescription: _channel.description,
      icon: 'ic_notification',
      colorized: true,
      color: const Color(0xFFE07C4F),
    );
    final payload = json.encode(message.data);

    _localNotificationsPlugin.show(
      notification.hashCode,
      notification.title,
      notification.body,
      NotificationDetails(android: androidNotificationDetails),
      payload: payload,
    );
  }

  Future<void> _handleMessageInteraction() async {
    _logger.d('Handling message interactions');
    await _handleBackgroundMessageInteraction();
    _handleForegroundMessageInteraction();
    _handleLocalNotificationInteraction();
  }

  Future<void> _handleBackgroundMessageInteraction() async {
    // Get any messages which caused the application to open from
    // a terminated state.
    final initialMessage = await _firebaseMessaging.getInitialMessage();

    if (initialMessage != null) {
      _handleMessage(initialMessage);
    }
  }

  StreamSubscription<RemoteMessage> _handleForegroundMessageInteraction() {
    return FirebaseMessaging.onMessageOpenedApp.listen(_handleMessage);
  }

  void _handleLocalNotificationInteraction() {
    _localNotificationsPlugin.initialize(
      const InitializationSettings(
        android: AndroidInitializationSettings('ic_notification'),
      ),
      onSelectNotification: (payload) {
        if (payload == null) return;

        final data = json.decode(payload) as Map<String, dynamic>;
        _messageHandler?.call(data);
      },
    );
  }

  void _handleMessage(RemoteMessage message) {
    _messageHandler?.call(message.data);
  }
}

Sample Usage in App

void main() {
  // Create instance of service
  final cloudMessagingService = CloudMessagingService();
  
  // Optionally, inject with you favorite DI package
   getIt.registerSingleton<CloudMessagingService>(cloudMessagingService);
}

Note ℹ️

• This package assumes you have Firebase set up for the flutter project it will be used in. To learn how to setup firebase see the docs.

• To make sure the correct notification icon is displayed: In your AndroidManifest.xml make sure to add

  <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_notification" />
          <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorPrimary" />
          <meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="high_importance_channel" />
  

  In the application section.

  Also make sure you have generated a notification icon with the name ic_notification. See here for information on generating notification icons.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add cloud_messaging_service_package

# Install globally
mason add -g cloud_messaging_service_package

Usage 🚀

mason make cloud_messaging_service_package

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

0.0.1

• initial release 🎉

The MIT License (MIT) Copyright (c) 2020 Prince Nna

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.