1- نظرة عامة
في هذا الدرس التطبيقي حول الترميز، ستتعلم كيفية استخدام دوال Cloud في Firebase لإضافة وظائف إلى تطبيق ويب للدردشة عن طريق إرسال إشعارات إلى مستخدمي تطبيق الدردشة.
المعلومات التي ستطّلع عليها
- يمكنك إنشاء دوال Google Cloud باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase.
- يمكنك بدء وظائف السحابة الإلكترونية استنادًا إلى أحداث Auth وCloud Storage وCloud Firestore.
- أضِف ميزة "المراسلة عبر السحابة الإلكترونية من Firebase" إلى تطبيق الويب.
المتطلبات
- بطاقة ائتمان تتطلب الوظائف السحابية في Firebase استخدام خطة Firebase Blaze، ما يعني أنّه يجب تفعيل الفوترة في مشروع Firebase باستخدام بطاقة ائتمان.
- محرِّر IDE/نص من اختيارك، مثل WebStorm أو Atom أو Sublime
- وحدة طرفية لتشغيل أوامر shell مع تثبيت الإصدار 9 من NodeJS
- متصفح، مثل Chrome
- نموذج الرمز. يُرجى الاطّلاع على الخطوة التالية لمعرفة كيفية إجراء ذلك.
2- الحصول على نموذج الرمز
استنسِخ مستودع GitHub من سطر الأوامر:
git clone https://github.com/firebase/friendlychat
استيراد تطبيق إجراء التفعيل
باستخدام بيئة التطوير المتكاملة (IDE)، افتح دليل cloud-functions-start
أو استورِده من نموذج دليل الرموز البرمجية. يحتوي هذا الدليل على الرمز البرمجي الأوّلي لمشروع Codelab الذي يتألف من تطبيق ويب Chat يعمل بكامل طاقته.
3- إنشاء مشروع على Firebase وإعداد تطبيقك
إنشاء مشروع
في وحدة تحكُّم Firebase، انقر على إضافة مشروع واسمه FriendlyChat.
انقر على إنشاء مشروع.
الترقية إلى خطة Blaze
لاستخدام ميزة Cloud Functions مع Firebase وCloud Storage for Firebase، يجب أن يكون مشروعك على Firebase ضمن خطة تسعير "الدفع حسب الاستخدام" (Blaze)، ما يعني أنّه مرتبط بحساب فوترة Cloud.
- يتطلّب حساب "الفوترة في Google Cloud" طريقة دفع، مثل بطاقة الائتمان.
- إذا كنت مستخدمًا جديدًا لمنصة Firebase وGoogle Cloud، يُرجى التحقّق من أهليتك للحصول على رصيد بقيمة 300 دولار أمريكي وحساب فوترة تجريبي مجاني على Cloud.
- إذا كنت تجري هذا الدرس التطبيقي حول الترميز كجزء من حدث، اسأل المنظِّم عما إذا كانت هناك أي أرصدة متوفرة في Cloud.
إذا لم يكن لديك بطاقة ائتمان أو لم تكن مرتاحًا لمواصلة استخدام خطة أسعار Blaze، ننصحك باستخدام مجموعة محاكيات Firebase التي ستتيح لك محاكاة Cloud Functions مجانًا على جهازك المحلي.
ما زال بإمكان جميع مشاريع Firebase، بما في ذلك المشاريع المشتركة في خطة أسعار Blaze، الاستفادة من حصص الاستخدام بدون تكلفة لـ Cloud Functions. تندرج الخطوات الموضّحة في هذا الدرس التطبيقي حول الترميز ضمن حدود استخدام الفئة المجانية. ومع ذلك، ستظهر لك رسوم بسيطة (حوالي 0.03 دولار أمريكي) من Cloud Storage، وهي تُستخدم لاستضافة صور إنشاء دوال السحابة.
لترقية مشروعك إلى خطة Blaze، اتّبِع الخطوات التالية:
- في "وحدة تحكُّم Firebase"، اختَر ترقية خطتك.
- اختَر خطة Blaze. اتّبِع التعليمات الظاهرة على الشاشة لربط حساب "فوترة على Cloud" بمشروعك.
إذا كنت بحاجة إلى إنشاء حساب "فوترة على Cloud" كجزء من هذه الترقية، قد تحتاج إلى الرجوع إلى مسار الترقية في وحدة تحكّم Firebase لإكمال الترقية.
تفعيل Google Auth
للسماح للمستخدمين بتسجيل الدخول إلى التطبيق، سنستخدم مصادقة Google التي يجب تفعيلها.
في "وحدة تحكُّم Firebase"، افتح قسم إنشاء > المصادقة > علامة التبويب طريقة تسجيل الدخول (أو انقر هنا للانتقال إلى الإعدادات). بعد ذلك، فعِّل مقدِّم خدمة تسجيل الدخول باستخدام Google وانقر على حفظ. سيتيح ذلك للمستخدمين تسجيل الدخول إلى تطبيق الويب باستخدام حساباتهم على Google.
يمكنك أيضًا ضبط الاسم العلني لتطبيقك على محادثة ودية:
إعداد Cloud Storage لمنصّة Firebase
يستخدم التطبيق "مساحة التخزين في السحابة الإلكترونية" لتحميل الصور.
في ما يلي كيفية إعداد ميزة "التخزين في السحابة الإلكترونية" لبرنامج Firebase في مشروعك على Firebase:
- في اللوحة اليمنى من وحدة تحكّم Firebase، وسِّع الإصدار، ثم اختَر مساحة التخزين.
- انقر على البدء.
- اختَر موقعًا جغرافيًا لحزمتك التلقائية على مساحة التخزين.
يمكن للحِزم فيUS-WEST1
وUS-CENTRAL1
وUS-EAST1
الاستفادة من المستوى "المجاني دائمًا" في Google Cloud Storage. وتتّبع الحزم في جميع المواقع الجغرافية الأخرى أسعار خدمة Google Cloud Storage واستخدامها. - انقر على البدء في وضع الاختبار. اقرأ بيان إخلاء المسؤولية عن قواعد الأمان.
لا توزِّع تطبيقًا أو تعرضه للجميع بدون إضافة قواعد أمان لحزمة التخزين. - انقر على إنشاء.
إضافة تطبيق ويب
في "وحدة تحكُّم Firebase"، أضِف تطبيق ويب. ولإجراء ذلك، انتقِل إلى إعدادات المشروع (Project Settings) وانتقِل للأسفل إلى إضافة تطبيق. اختَر الويب كنظام أساسي وضَع علامة في مربّع إعداد "استضافة Firebase"، ثم سجِّل التطبيق وانقر على التالي لبقية الخطوات، ثم انقر في النهاية على متابعة إلى وحدة التحكّم.
4. تثبيت واجهة سطر أوامر Firebase
ستسمح لك واجهة سطر أوامر Firebase بعرض تطبيق الويب محليًا ونشر تطبيق الويب و"وظائف السحابة الإلكترونية".
لتثبيت واجهة برمجة التطبيقات أو ترقيتها، شغِّل الأمر التالي في npm:
npm -g install firebase-tools
للتأكّد من أنّه تم تثبيت واجهة برمجة التطبيقات بشكل صحيح، افتح وحدة تحكّم ونفِّذ:
firebase --version
تأكَّد من أنّ إصدار واجهة سطر أوامر Firebase أعلى من 4.0.0 لكي تتوفّر فيه جميع الميزات الحديثة المطلوبة لخدمة "وظائف السحابة الإلكترونية". إذا لم يكن الأمر كذلك، شغِّل npm install -g firebase-tools
للترقية كما هو موضَّح أعلاه.
تفويض واجهة سطر الأوامر لمنصّة Firebase من خلال تنفيذ ما يلي:
firebase login
يُرجى التأكّد من أنّك في دليل cloud-functions-start
، ثم إعداد واجهة سطر الأوامر في Firebase لاستخدام مشروع Firebase:
firebase use --add
بعد ذلك، اختَر رقم تعريف المشروع واتّبِع التعليمات. يمكنك اختيار أي اسم مستعار، مثل codelab
، عندما يُطلب منك ذلك.
5- نشر تطبيق الويب وتشغيله
الآن وبعد أن استوردت مشروعك وتهيئته، فأنت جاهز لتشغيل تطبيق الويب لأول مرة! افتح نافذة طرفية وانتقِل إلى مجلد cloud-functions-start
وانشر تطبيق الويب على خدمة استضافة Firebase باستخدام:
firebase deploy --except functions
في ما يلي نتائج وحدة التحكّم التي من المفترض أن تظهر لك:
i deploying database, storage, hosting
✔ database: rules ready to deploy.
i storage: checking rules for compilation errors...
✔ storage: rules file compiled successfully
i hosting: preparing ./ directory for upload...
✔ hosting: ./ folder uploaded successfully
✔ storage: rules file compiled successfully
✔ hosting: 8 files uploaded successfully
i starting release process (may take several minutes)...
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com
فتح تطبيق الويب
من المفترض أن يعرض السطر الأخير عنوان URL الخاص بالموقع المضيف. من المفترض أن يتم عرض تطبيق الويب الآن من عنوان URL هذا، والذي يجب أن يكون بالتنسيق https://<project-id>.firebaseapp.com. افتحه. من المفترض أن يظهر لك واجهة مستخدم عاملة لتطبيق محادثة.
سجِّل الدخول إلى التطبيق باستخدام زر تسجيل الدخول باستخدام حساب Google ولا تتردد في إضافة بعض الرسائل ونشر الصور:
إذا سجّلت الدخول إلى التطبيق للمرة الأولى على متصفّح جديد، احرص على السماح بالإشعارات عندما يُطلب منك ذلك:
وسنحتاج إلى تفعيل الإشعارات في وقت لاحق.
في حال النقر عن طريق الخطأ على حظر، يمكنك تغيير هذا الإعداد من خلال النقر على الزر 🔒 آمن على يمين عنوان URL في الشريط المتعدد الاستخدامات في Chrome وتبديل الشريط بجانب الإشعارات:
والآن، سنضيف بعض الوظائف باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase لوظائف السحابة الإلكترونية.
6- دليل الدوال
تتيح لك Cloud Functions الحصول على رمز برمجي يعمل في السحابة الإلكترونية بسهولة بدون الحاجة إلى إعداد خادم. سنشرح كيفية إنشاء دوالّ تستجيب لأحداث قاعدة بيانات Firebase Auth وCloud Storage وFirebase Firestore. لنبدأ بـ Auth.
عند استخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase في "وظائف السحابة الإلكترونية"، سيتم وضع رمز Functions ضمن الدليل functions
(تلقائيًا). رمز Functions هو أيضًا تطبيق Node.js، وبالتالي يحتاج إلى package.json
يقدّم بعض المعلومات عن تطبيقك ويسرد التبعيات.
لتسهيل الأمر عليك، أنشأنا ملف functions/index.js
الذي سيتم نقل الرمز إليه. يمكنك فحص هذا الملف قبل المتابعة.
cd functions
ls
إذا لم تكن معتادًا على استخدام Node.js، يمكنك الاطّلاع على مزيد من المعلومات عنها قبل مواصلة الدرس التطبيقي حول الترميز.
يسرد ملف package.json
حاليًا تبعيتين مطلوبتَين: حزمة تطوير البرامج (SDK) لمنصّة Firebase لخدمة "وظائف السحابة الإلكترونية" وحزمة تطوير البرامج (SDK) للمشرف في Firebase. لتثبيت التطبيقات على الجهاز، يُرجى الانتقال إلى مجلد "functions
" وتنفيذ ما يلي:
npm install
لنلقِ الآن نظرة على ملف index.js
:
index.js
/**
* Copyright 2017 Google Inc. All Rights Reserved.
* ...
*/
// TODO(DEVELOPER): Import the Cloud Functions for Firebase and the Firebase Admin modules here.
// TODO(DEVELOPER): Write the addWelcomeMessage Function here.
// TODO(DEVELOPER): Write the blurImages Function here.
// TODO(DEVELOPER): Write the sendNotification Function here.
سنقوم باستيراد الوحدات المطلوبة ثم نكتب ثلاث دوال بدلاً من قوائم المهام. لنبدأ باستيراد وحدات العُقد المطلوبة.
7- استيراد وظائف السحابة الإلكترونية ووحدات "مشرف Firebase"
ستحتاج إلى وحدتَين خلال هذا الدليل التعليمي حول الرموز البرمجية: تتيح الوحدة firebase-functions
كتابة عوامل تشغيل Cloud Functions وسجلّاتها، بينما تتيح الوحدة firebase-admin
استخدام منصة Firebase على خادم يتضمّن إذن وصول مشرف لتنفيذ إجراءات مثل الكتابة إلى Cloud Firestore أو إرسال إشعارات من Firebase.
في ملف index.js
، استبدِل TODO
الأول بما يلي:
index.js
/**
* Copyright 2017 Google Inc. All Rights Reserved.
* ...
*/
// Import the Firebase SDK for Google Cloud Functions.
const functions = require('firebase-functions');
// Import and initialize the Firebase Admin SDK.
const admin = require('firebase-admin');
admin.initializeApp();
// TODO(DEVELOPER): Write the addWelcomeMessage Function here.
// TODO(DEVELOPER): Write the blurImages Function here.
// TODO(DEVELOPER): Write the sendNotification Function here.
يمكن ضبط حزمة تطوير البرامج (SDK) الخاصة بمشرف Firebase تلقائيًا عند نشرها في بيئة Cloud Functions أو حاويات Google Cloud Platform الأخرى، ويحدث ذلك عند استدعاء admin.initializeApp()
بدون وسيطات.
الآن، لنضيف دالة يتم تنفيذها عندما يسجّل المستخدم الدخول لأول مرة في تطبيق المحادثة، وسنضيف رسالة محادثة للترحيب بالمستخدم.
8- الترحيب بالمستخدمين الجدد
بنية رسائل Chat
يتم تخزين الرسائل المنشورة في خلاصة المحادثة في FriendlyChat في Cloud Firestore. لنلقِ نظرة على بنية البيانات التي نستخدمها للرسالة. لإجراء ذلك، انشر رسالة جديدة في المحادثة نصّها "مرحبًا بك":
من المفترض أن يظهر على النحو التالي:
في وحدة تحكُّم Firebase، انقر على قاعدة بيانات Firestore ضمن قسم الإنشاء. من المفترض أن تظهر لك مجموعة الرسائل ومستند واحد يحتوي على الرسالة التي كتبتها:
كما هو موضّح، يتم تخزين رسائل المحادثة في Cloud Firestore كمستند يحتوي على سمات name
وprofilePicUrl
وtext
وtimestamp
التي تمت إضافتها إلى مجموعة messages
.
إضافة رسائل ترحيب
تضيف دالة Cloud الأولى رسالة للترحيب بالمستخدمين الجدد في المحادثة. لهذا الغرض، يمكننا استخدام عامل التفعيل functions.auth().onCreate
الذي يُشغّل الدالة في كل مرة يسجّل فيها المستخدِم الدخول لأول مرة في تطبيق Firebase. أضِف الدالة addWelcomeMessages
إلى ملف index.js
:
ملف index.js
// Adds a message that welcomes new users into the chat.
exports.addWelcomeMessages = functions.auth.user().onCreate(async (user) => {
functions.logger.log('A new user signed in for the first time.');
const fullName = user.displayName || 'Anonymous';
// Saves the new welcome message into the database
// which then displays it in the FriendlyChat clients.
await admin.firestore().collection('messages').add({
name: 'Firebase Bot',
profilePicUrl: '/images/firebase-logo.png', // Firebase logo
text: `${fullName} signed in for the first time! Welcome!`,
timestamp: admin.firestore.FieldValue.serverTimestamp(),
});
functions.logger.log('Welcome message written to database.');
});
إنّ إضافة هذه الدالة إلى العنصر الخاص exports
هي طريقة Node لإتاحة الوصول إلى الدالة خارج الملف الحالي، وهي مطلوبة لاستخدام Cloud Functions.
في الدالة أعلاه، نضيف رسالة ترحيب جديدة نشرها "Firebase Bot" إلى قائمة رسائل المحادثة. ويتم إجراء ذلك باستخدام الطريقة add
على مجموعة messages
في Cloud Firestore، حيث يتم تخزين رسائل المحادثة.
بما أنّ هذه عملية غير متزامنة، يجب عرض الوعد الذي يشير إلى وقت انتهاء Cloud Firestore من الكتابة حتى لا يتم تنفيذ وظائف Cloud في وقت مبكر جدًا.
نشر وظائف السحابة الإلكترونية
لن تكون وظائف السحابة الإلكترونية نشطة إلا بعد تفعيلها. للقيام بذلك، قم بتشغيل هذا في سطر الأوامر:
firebase deploy --only functions
في ما يلي نتائج وحدة التحكّم التي من المفترض أن تظهر لك:
i deploying functions
i functions: ensuring necessary APIs are enabled...
⚠ functions: missing necessary APIs. Enabling now...
i env: ensuring necessary APIs are enabled...
⚠ env: missing necessary APIs. Enabling now...
i functions: waiting for APIs to activate...
i env: waiting for APIs to activate...
✔ env: all necessary APIs are enabled
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: creating function addWelcomeMessages...
✔ functions[addWelcomeMessages]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlypchat-1234/overview
اختبار الدالة
بعد نشر الدالة بنجاح، يجب أن يكون لديك مستخدم يسجّل الدخول لأول مرة.
- افتح التطبيق في المتصفّح باستخدام عنوان URL للاستضافة (على شكل
https://<project-id>.firebaseapp.com
). - سجِّل الدخول للمرة الأولى في تطبيقك باستخدام زر تسجيل الدخول مع مستخدم جديد.
- إذا سبق لك تسجيل الدخول إلى التطبيق، يمكنك فتح مصادقة وحدة تحكُّم Firebase وحذف حسابك من قائمة المستخدمين. وبعد ذلك، سجِّل الدخول مرة أخرى.
- بعد تسجيل الدخول، من المفترض أن تظهر رسالة ترحيب تلقائيًا:
9- الإشراف على الصور
يمكن للمستخدمين تحميل كل أنواع الصور في المحادثة، ومن المهم دائمًا الإشراف على الصور المسيئة، خاصةً على منصات التواصل الاجتماعي العامة. في FriendlyChat، يتم تخزين الصور التي يتم نشرها في المحادثة في حِزم Cloud Storage.
باستخدام Cloud Functions، يمكنك رصد عمليات تحميل الصور الجديدة باستخدام عامل التفعيل functions.storage().onFinalize
. سيتم تنفيذ هذا الإجراء في كل مرة يتم فيها تحميل ملف جديد أو تعديله في Cloud Storage.
للإشراف على الصور، سنتابع العملية التالية:
- تحقَّق ممّا إذا تم الإبلاغ عن الصورة على أنّها محتوى للبالغين أو محتوى عنيف باستخدام Cloud Vision API.
- إذا تم الإبلاغ عن الصورة، نزِّلها على مثيل Functions قيد التشغيل.
- تمويه الصورة باستخدام ImageMagick
- حمِّل الصورة المموّهة إلى Cloud Storage.
تفعيل Cloud Vision API
بما أنّنا سنستخدم Google Cloud Vision API في هذه الوظيفة، عليك تفعيل واجهة برمجة التطبيقات في مشروعك على Firebase. اتّبِع هذا الرابط، ثم اختَر مشروعك على Firebase وفعِّل واجهة برمجة التطبيقات:
تثبيت الاعتماديات
للإشراف على الصور، سنستخدم مكتبة برامج Google Cloud Vision Client Library لنظام Node.js، @google-cloud/vision، لتشغيل الصور من خلال Cloud Vision API لرصد الصور غير الملائمة.
لتثبيت هذه الحزمة في تطبيق Cloud Functions، عليك تشغيل أمر npm install --save
التالي. عليك التأكّد من تنفيذ هذا الإجراء من دليل "functions
".
npm install --save @google-cloud/vision@2.4.0
سيؤدي هذا الإجراء إلى تثبيت الحزمة على الجهاز وإضافتها كتبعية معرَّفة في ملف package.json
.
استيراد الموارد التابعة وضبطها
لاستيراد المكوّنات التابعة التي تم تثبيتها وبعض وحدات Node.js الأساسية (path
وos
وfs
) التي سنحتاج إليها في هذا القسم، أضِف السطور التالية إلى أعلى ملف index.js
:
index.js
const Vision = require('@google-cloud/vision');
const vision = new Vision.ImageAnnotatorClient();
const {promisify} = require('util');
const exec = promisify(require('child_process').exec);
const path = require('path');
const os = require('os');
const fs = require('fs');
بما أنّه سيتم تشغيل وظيفتك داخل بيئة Google Cloud، لن تحتاج إلى ضبط مكتبات Cloud Storage وCloud Vision لأنّه سيتم إعدادها تلقائيًا لاستخدام مشروعك.
رصد الصور غير الملائمة
ستستخدم عامل تشغيل functions.storage.onChange
Cloud Functions الذي يُشغِّل الرمز البرمجي فور إنشاء ملف أو مجلد أو تعديلهما في حزمة تخزين على Cloud Storage. أضِف الدالة blurOffensiveImages
إلى ملف index.js
:
index.js
// Checks if uploaded images are flagged as Adult or Violence and if so blurs them.
exports.blurOffensiveImages = functions.runWith({memory: '2GB'}).storage.object().onFinalize(
async (object) => {
const imageUri = `gs://${object.bucket}/${object.name}`;
// Check the image content using the Cloud Vision API.
const batchAnnotateImagesResponse = await vision.safeSearchDetection(imageUri);
const safeSearchResult = batchAnnotateImagesResponse[0].safeSearchAnnotation;
const Likelihood = Vision.protos.google.cloud.vision.v1.Likelihood;
if (Likelihood[safeSearchResult.adult] >= Likelihood.LIKELY ||
Likelihood[safeSearchResult.violence] >= Likelihood.LIKELY) {
functions.logger.log('The image', object.name, 'has been detected as inappropriate.');
return blurImage(object.name);
}
functions.logger.log('The image', object.name, 'has been detected as OK.');
});
يُرجى العلم أنّنا أضفنا بعض الإعدادات لنسخة Cloud Functions التي ستُشغّل الدالة. في الدالة .runWith({memory: '2GB'})
، نطلب أن يحصل المثيل على ذاكرة بسعة 2 غيغابايت بدلاً من الذاكرة التلقائية، لأنّ هذه الدالة تستهلك الذاكرة.
عند تشغيل الوظيفة، يتم تشغيل الصورة من خلال Cloud Vision API لرصد ما إذا كان قد تم الإبلاغ عنها على أنّها مخصّصة للبالغين أو عنيفة. إذا تم رصد الصورة على أنّها غير ملائمة استنادًا إلى هذه المعايير، سنموه الصورة، وذلك في الدالة blurImage
كما سنرى في ما يلي.
تمويه الصورة
أضِف دالة blurImage
التالية في ملف index.js
:
index.js
// Blurs the given image located in the given bucket using ImageMagick.
async function blurImage(filePath) {
const tempLocalFile = path.join(os.tmpdir(), path.basename(filePath));
const messageId = filePath.split(path.sep)[1];
const bucket = admin.storage().bucket();
// Download file from bucket.
await bucket.file(filePath).download({destination: tempLocalFile});
functions.logger.log('Image has been downloaded to', tempLocalFile);
// Blur the image using ImageMagick.
await exec(`convert "${tempLocalFile}" -channel RGBA -blur 0x24 "${tempLocalFile}"`);
functions.logger.log('Image has been blurred');
// Uploading the Blurred image back into the bucket.
await bucket.upload(tempLocalFile, {destination: filePath});
functions.logger.log('Blurred image has been uploaded to', filePath);
// Deleting the local file to free up disk space.
fs.unlinkSync(tempLocalFile);
functions.logger.log('Deleted local file.');
// Indicate that the message has been moderated.
await admin.firestore().collection('messages').doc(messageId).update({moderated: true});
functions.logger.log('Marked the image as moderated in the database.');
}
في الدالة أعلاه، يتم تنزيل ملف الصورة الثنائي من Cloud Storage. بعد ذلك، يتم تمويه الصورة باستخدام أداة convert
من ImageMagick، وتتم إعادة تحميل النسخة المموّهة على سعة التخزين. بعد ذلك، نحذف الملف على مثيل Cloud Functions لإخلاء بعض مساحة القرص، وندرك أنّه يمكن إعادة استخدام مثيل Cloud Functions نفسه وإذا لم يتم تنظيف الملفات، قد تنفد مساحة القرص. أخيرًا، أضفنا قيمة منطقية إلى رسالة المحادثة تشير إلى أنّ الصورة خاضعة للإشراف، ما سيؤدي إلى إعادة تحميل الرسالة على البرنامج.
نشر الدالة
لن تكون الدالة نشطة إلا بعد نشرها. في سطر الأوامر، شغِّل firebase deploy --only functions
:
firebase deploy --only functions
هذا هو ناتج وحدة التحكم الذي من المفترض أن يظهر لك:
i deploying functions
i functions: ensuring necessary APIs are enabled...
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: updating function addWelcomeMessages...
i functions: creating function blurOffensiveImages...
✔ functions[addWelcomeMessages]: Successful update operation.
✔ functions[blurOffensiveImages]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
اختبار الدالة
بعد نشر الدالة بنجاح:
- افتح تطبيقك في المتصفّح باستخدام عنوان URL الخاص بالخادم (بالتنسيق
https://<project-id>.firebaseapp.com
). - بعد تسجيل الدخول إلى التطبيق، حمِّل صورة:
- اختَر أفضل صورة مسيئة لتحميلها (أو يمكنك استخدام هذا الزومبي آكل اللحم)، وبعد بضع لحظات، من المفترض أن تظهر مشاركة جديدة تتضمّن نسخة مموّهة من الصورة:
10- إشعارات الرسائل الجديدة
في هذا القسم، يمكنك إضافة دالة سحابية ترسل إشعارات إلى المشاركين في المحادثة عند نشر رسالة جديدة.
باستخدام خدمة المراسلة عبر السحابة الإلكترونية من Firebase (FCM)، يمكنك إرسال إشعارات إلى المستخدمين بشكل موثوق على جميع المنصات. لإرسال إشعار إلى مستخدم، تحتاج إلى رمز أمان جهازه على Firebase. يجمع تطبيق الويب للمحادثة الذي نستخدمه حاليًا علامات اعتماد الجهاز من المستخدمين عند فتح التطبيق لأول مرة على متصفّح أو جهاز جديد. يتم حفظ هذه الرموز المميّزة في Cloud Firestore في مجموعة "fcmTokens
".
إذا كنت تريد معرفة كيفية الحصول على رموز جهاز "المراسلة عبر السحابة الإلكترونية من Firebase" من تطبيق ويب، يمكنك الانتقال إلى الدرس التطبيقي حول ترميز الويب من Firebase.
إرسال الإشعارات
لرصد وقت نشر الرسائل الجديدة، ستستخدم مشغِّل functions.firestore.document().onCreate
Cloud Functions الذي يشغِّل الرمز البرمجي عند إنشاء عنصر جديد في مسار معيّن من Cloud Firestore. أضِف دالة sendNotifications
إلى ملف index.js
:
ملف index.js
// Sends a notifications to all users when a new message is posted.
exports.sendNotifications = functions.firestore.document('messages/{messageId}').onCreate(
async (snapshot) => {
// Notification details.
const text = snapshot.data().text;
const payload = {
notification: {
title: `${snapshot.data().name} posted ${text ? 'a message' : 'an image'}`,
body: text ? (text.length <= 100 ? text : text.substring(0, 97) + '...') : '',
icon: snapshot.data().profilePicUrl || '/images/profile_placeholder.png',
click_action: `https://${process.env.GCLOUD_PROJECT}.firebaseapp.com`,
}
};
// Get the list of device tokens.
const allTokens = await admin.firestore().collection('fcmTokens').get();
const tokens = [];
allTokens.forEach((tokenDoc) => {
tokens.push(tokenDoc.id);
});
if (tokens.length > 0) {
// Send notifications to all tokens.
const response = await admin.messaging().sendToDevice(tokens, payload);
await cleanupTokens(response, tokens);
functions.logger.log('Notifications have been sent and tokens cleaned up.');
}
});
في الدالة أعلاه، نجمع كل الرموز المميّزة لأجهزة المستخدمين من قاعدة بيانات Cloud Firestore ونرسل إشعارًا إلى كل منها باستخدام الدالة admin.messaging().sendToDevice
.
تنظيف الرموز المميّزة
وأخيرًا، نريد إزالة الرموز المميزة التي لم تعُد صالحة. ويحدث ذلك عندما لا يستخدم المتصفّح أو الجهاز الرمز المميّز الذي حصلنا عليه من المستخدم. على سبيل المثال، يحدث ذلك إذا أبطل المستخدم إذن إرسال الإشعارات لجلسة المتصفّح. لإجراء ذلك، أضِف دالة cleanupTokens
التالية في ملف index.js
:
index.js
// Cleans up the tokens that are no longer valid.
function cleanupTokens(response, tokens) {
// For each notification we check if there was an error.
const tokensDelete = [];
response.results.forEach((result, index) => {
const error = result.error;
if (error) {
functions.logger.error('Failure sending notification to', tokens[index], error);
// Cleanup the tokens that are not registered anymore.
if (error.code === 'messaging/invalid-registration-token' ||
error.code === 'messaging/registration-token-not-registered') {
const deleteTask = admin.firestore().collection('fcmTokens').doc(tokens[index]).delete();
tokensDelete.push(deleteTask);
}
}
});
return Promise.all(tokensDelete);
}
نشر الدالة
لن تكون الدالة نشطة إلا بعد نشرها، ولنشرها، عليك تشغيل هذا في سطر الأوامر:
firebase deploy --only functions
في ما يلي نتائج وحدة التحكّم التي من المفترض أن تظهر لك:
i deploying functions
i functions: ensuring necessary APIs are enabled...
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: updating function addWelcomeMessages...
i functions: updating function blurOffensiveImages...
i functions: creating function sendNotifications...
✔ functions[addWelcomeMessages]: Successful update operation.
✔ functions[blurOffensiveImages]: Successful updating operation.
✔ functions[sendNotifications]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
اختبار الدالة
- بعد نشر الدالة بنجاح، افتح التطبيق في المتصفّح باستخدام عنوان URL للاستضافة (على شكل
https://<project-id>.firebaseapp.com
). - إذا سجّلت الدخول إلى التطبيق للمرة الأولى، احرص على السماح بالإشعارات عندما يُطلب منك ذلك:
- إغلاق علامة تبويب تطبيق المحادثة أو عرض علامة تبويب مختلفة: لا تظهر الإشعارات إلا إذا كان التطبيق في الخلفية. إذا أردت معرفة كيفية تلقّي الرسائل عندما يكون تطبيقك في المقدّمة، يمكنك الاطّلاع على مستنداتنا.
- باستخدام متصفح مختلف (أو نافذة تصفّح متخفٍ)، سجِّل الدخول إلى التطبيق وانشر رسالة. من المفترض أن يظهر لك إشعار يعرضه المتصفح الأول:
11- تهانينا!
لقد استخدمت حزمة تطوير البرامج (SDK) لمنصّة Firebase في وظائف السحابة الإلكترونية وأضفت مكوّنات من جهة الخادم إلى تطبيق محادثات.
المواضيع التي تناولناها
- إنشاء وظائف السحابة الإلكترونية باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase لوظائف السحابة الإلكترونية
- يمكنك بدء وظائف السحابة الإلكترونية استنادًا إلى أحداث Auth وCloud Storage وCloud Firestore.
- أضِف دعم "المراسلة عبر السحابة الإلكترونية من Firebase" إلى تطبيق الويب.
- تفعيل Cloud Functions باستخدام واجهة سطر الأوامر في Firebase
الخطوات التالية
- تعرَّف على أنواع مشغِّلات الدوال السحابية الأخرى.
- يمكنك استخدام Firebase وCloud Functions مع تطبيقك الخاص.