Improve README of Dart push fcm

dart/send_push_notification/README.md

@@ -1,22 +1,22 @@
 # Send push notification
 
-A Dart Cloud Function that send push notification using Firebase Cloud Messaging to particular user
+A Dart Cloud Function that send push notification using FCM to particular user.
 
-* First of all make sure that you are integrated FCM into your flutter app
- - https://firebase.flutter.dev/docs/messaging/overview/
-* Generate needed `FIREBASE_AUTH_KEY` env variable
+* Make sure that you are integrated FCM into your app (Web/Android/Apple/Flutter)
+* Generate needed `FMC_SERVER_KEY` env variable
 
 ### Hot to get FCM Server Key
-* Go to Messaging settings
- ![FCM Settings](firebase_messaging_setting.png "Firebase Messaging Settings")
+
+* Visit your FCM console and enter your project
+* Go to Project settings and switch to Cloud Messaging tab
+* Enable Cloud Messaging API (Legacy)
 * Copy server key or create a new one
- ![FCM Server Auth Key](firebase_auth_server_key.png "Firebase Server Auth Key")
 
 _Example input 1:_
 
 ```json
 {
- "user_token": "some_valid_token"
+ "user_token": "d0MXntS8ur81...UEFGL"
 }
 ```
 
@@ -50,9 +50,7 @@ _Example output 2:_
 
 List of environment variables used by this cloud function:
 
-* **FIREBASE_AUTH_KEY** - API Key for FCM
-
-<!-- * **TINYURL_API_KEY** - API Key for TinyUrl -->
+* **FMC_SERVER_KEY** - Server Key for FCM settings
 
 ## 🚀 Deployment
 
@@ -84,7 +82,7 @@ runtime [README](https://github.com/open-runtimes/open-runtimes/tree/main/runtim
 4. Execute function:
 
 ```shell
-curl http:https://localhost:3000/ -d '{"variables":{"FIREBASE_AUTH_KEY":"YOUR_FIREBASE_AUTH_KEY"},"payload":"{\"user_token\":\"USER_FCM_TOKEN\"}"}' -H "X-Internal-Challenge: secret-key" -H "Content-Type: application/json"
+curl http:https://localhost:3000/ -d '{"variables":{"FMC_SERVER_KEY":"YOUR_FMC_SERVER_KEY"},"payload":"{\"user_token\":\"USER_FCM_TOKEN\"}"}' -H "X-Internal-Challenge: secret-key" -H "Content-Type: application/json"
 ```
 
 ## 📝 Notes

dart/send_push_notification/lib/fcm_service.dart

@@ -4,15 +4,15 @@ import 'package:http/http.dart' as http;
 
 class FCMService {
  Future<bool> sendFCMToUser(
- {required String firebaseAuthKey,
+ {required String serverKey,
  required String userFCMToken,
  required Map<String, dynamic> notificationData}) async {
  try {
  await http.post(
  Uri.parse('https://fcm.googleapis.com/fcm/send'),
  headers: <String, String>{
  'Content-Type': 'application/json; charset=UTF-8',
- 'Authorization': 'key=$firebaseAuthKey'
+ 'Authorization': 'key=$serverKey'
  },
  body: jsonEncode(<String, dynamic>{
  'to': userFCMToken,

dart/send_push_notification/lib/main.dart

@@ -1,5 +1,4 @@
 import 'dart:convert';
-
 import 'fcm_service.dart';
 
 void returnSuccess(final res, final message) {
@@ -17,11 +16,7 @@ void returnFailure(final res, final String message) {
 }
 
 bool checkEnvVariables(final req, final res) {
- if (req.variables['APPWRITE_FUNCTION_ENDPOINT'] == null ||
- req.variables['APPWRITE_FUNCTION_API_KEY'] == null ||
- req.variables['APPWRITE_FUNCTION_PROJECT_ID'] == null ||
- req.variables['APPWRITE_FUNCTION_USER_ID'] == null ||
- req.variables['FIREBASE_AUTH_KEY'] == null) {
+ if (req.variables['FMC_SERVER_KEY'] == null) {
  returnFailure(res, "Some Environment variables are not set");
  return false;
  }
@@ -42,7 +37,7 @@ Future<void> start(final req, final res) async {
  if (!checkEnvVariables(req, res)) {
  return;
  }
- final String firebaseAuthKey = req.variables['FIREBASE_AUTH_KEY'];
+ final String serverKey = req.variables['FMC_SERVER_KEY'];
 
  final payload = jsonDecode(req.payload == '' ? '{}' : req.payload);
  if (!checkPayload(payload, res)) {
@@ -59,7 +54,7 @@ Future<void> start(final req, final res) async {
  };
 
  final isPushSent = await fcmService.sendFCMToUser(
- firebaseAuthKey: firebaseAuthKey,
+ serverKey: serverKey,
  userFCMToken: userToken,
  notificationData: notificationData);
 

dart/send_push_notification/test/send_push_notification_test.dart

@@ -7,17 +7,13 @@ import 'package:test/test.dart';
 
 
 const fakeFriendDeviceToken = 'fake_friend_device_token';
-const fakeFirebaseAuthKey = 'fake_firebase_auth_key';
+const fakeServerKey = 'fake_server_key';
 
 class Request {
  Map<String, dynamic> headers = {};
  String payload = '';
  Map<String, dynamic> variables = {
- 'APPWRITE_FUNCTION_ENDPOINT': 'fake_url',
- 'APPWRITE_FUNCTION_PROJECT_ID': 'fake_project_id',
- 'APPWRITE_FUNCTION_API_KEY': 'fake_api_key',
- 'APPWRITE_FUNCTION_USER_ID': 'fake_user_id',
- 'FIREBASE_AUTH_KEY': fakeFirebaseAuthKey
+ 'FMC_SERVER_KEY': fakeServerKey
  };
 }
 
@@ -41,7 +37,7 @@ class MockFCMService extends Mock implements FCMService {}
 void main() {
  test('call remote function with incorrect ENV variables', () async {
  final req = Request();
- req.variables['FIREBASE_AUTH_KEY'] = null;
+ req.variables['FMC_SERVER_KEY'] = null;
 
  final res = Response();
  await start(req, res);
@@ -70,15 +66,15 @@ void main() {
  mockFCMService = MockFCMService();
 
  when(() => mockFCMService!.sendFCMToUser(
- firebaseAuthKey: fakeFirebaseAuthKey,
+ serverKey: fakeServerKey,
  userFCMToken: fakeFriendDeviceToken,
  notificationData: any(named: 'notificationData'),
  )).thenAnswer((invocation) async => true);
 
  await start(req, res);
 
  final capturedFCMDataArgs = verify(() => mockFCMService!.sendFCMToUser(
- firebaseAuthKey: fakeFirebaseAuthKey,
+ serverKey: fakeServerKey,
  userFCMToken: captureAny(named: 'userFCMToken'),
  notificationData: captureAny(named: 'notificationData'),
  )).captured;