إدراج الدوال في قائمة انتظار مع "مهام Cloud"


تستفيد وظائف "قائمة المهام" من Google Cloud Tasks لمساعدة تطبيقك على تنفيذ المهام التي تستغرق وقتًا طويلاً أو تستهلك موارد كثيرة أو محدودة النطاق، وذلك بشكل غير متزامن خارج مسار تطبيقك الرئيسي.

على سبيل المثال، لنفترض أنّك تريد إنشاء نُسخ احتياطية من مجموعة كبيرة من ملفات الصور المستضافة حاليًا على واجهة برمجة تطبيقات ذات حدّ أقصى للمعدل. لكي تكون أحد المستهلكين المسؤولين لواجهة برمجة التطبيقات هذه، عليك الالتزام بحدود معدّلاتها. بالإضافة إلى ذلك، قد يكون هذا النوع من الوظائف طويلة الأمد عرضةً للفشل بسبب المهلات وحدود الذاكرة.

لتخفيف هذه التعقيدات، يمكنك كتابة دالة "قائمة انتظار المهام" التي تضبط خيارات المهام الأساسية، مثل scheduleTime وdispatchDeadline، ثم تُرسِل الدالة إلى قائمة انتظار في Cloud Tasks. تم تصميم بيئة "Cloud Tasks" خصيصًا لضمان وضع سياسات فعّالة لمكافحة ازدحام المرور، وإعادة المحاولة لهذه الأنواع من العمليات.

يمكن تشغيل حزمة تطوير البرامج (SDK) لمنصّة Firebase للإصدار 3.20.1 والإصدارات الأحدث من Cloud Functions for Firebase مع الإصدار 10.2.0 من Firebase Admin SDK والإصدارات الأحدث منه، وذلك لإتاحة وظائف قائمة انتظار المهام.

يمكن أن يؤدي استخدام دوال قائمة المهام مع Firebase إلى تحصيل رسوم مقابل معالجة Cloud Tasks. يمكنك الاطّلاع على مزيد من المعلومات حول أسعار Cloud Tasks .

إنشاء دوال قوائم انتظار المهام

لاستخدام وظائف قائمة انتظار المهام، اتبع سير العمل التالي:

  1. اكتب دالة قائمة انتظار المهام باستخدام حزمة تطوير البرامج (SDK) Firebase للنطاق Cloud Functions.
  2. اختبِر الدالة من خلال تشغيلها باستخدام طلب HTTP.
  3. يمكنك نشر الدالة باستخدام واجهة سطر الأوامر Firebase. عند نشر دالة ملف "قائمة المهام" للمرة الأولى، ستنشئ وحدة تحكّم في سطر الأوامر ملف "قائمة مهام" في Cloud Tasks مع خيارات (تقييد معدّل الإرسال وإعادة المحاولة) محدّدة في رمز المصدر.
  4. إضافة مهام إلى قائمة انتظار المهام التي تم إنشاؤها حديثًا، وتمرير المعلمات لإعداد جدول تنفيذي إذا لزم الأمر. يمكنك تحقيق ذلك من خلال كتابة الرمز باستخدام Admin SDK ونشره في Cloud Functions for Firebase.

كتابة دوال قائمة المهام

استخدِم onDispatch لبدء كتابة دوال قائمة المهام. جزء مهم من كتابة دالة قائمة انتظار المهام هو تعيين إعادة المحاولة لكل قائمة انتظار وتهيئة الحد من المعدل. تستند عيّنات التعليمات البرمجية في هذه الصفحة إلى تطبيق يُعدّ خدمة للاحتفاظ بنسخة احتياطية من جميع الصور المأخوذة من صورة اليوم الفلكي التابعة لوكالة ناسا:

ضبط وظائف قائمة انتظار المهام

تأتي دوال قائمة المهام مع مجموعة قوية من إعدادات التهيئة للتحكم بدقة في حدود المعدل وإعادة محاولة سلوك قائمة انتظار المهام:

exports.backupApod = functions
    .runWith( {secrets: ["NASA_API_KEY"]})
    .tasks.taskQueue({
      retryConfig: {
        maxAttempts: 5,
        minBackoffSeconds: 60,
      },
      rateLimits: {
        maxConcurrentDispatches: 6,
      },
    }).onDispatch(async (data) => {
  • retryConfig.maxAttempts=5: تتم تلقائيًا محاولة تنفيذ كل مهمة في قائمة المهام مجددًا حتى 5 مرات. ويساعد ذلك في تخفيف الأخطاء العابرة، مثل أخطاء الشبكة أو انقطاع الخدمة المؤقت لخدمة خارجية تابعة.
  • retryConfig.minBackoffSeconds=60: تتم إعادة محاولة كل مهمة لمدة 60 ثانية على الأقل بغض النظر عن كل محاولة. يوفر ذلك مساحة تخزين كبيرة بين كل محاولة، كي لا نستهلك محاولات إعادة المحاولة الخمس بسرعة كبيرة.
  • rateLimits.maxConcurrentDispatch=6: يتم إرسال 6 مهام كحد أقصى في وقت معيّن. يساعد ذلك في ضمان تدفق طلبات ثابتة إلى الدالة الأساسية ويساعد في تقليل عدد النُسخ النشطة وعمليات التشغيل على البارد.

اختبار وظائف قائمة انتظار المهام

في معظم الحالات، يُعدّ محاكي Cloud Functions أفضل طريقة لاختبار دوال قائمة انتظار المهام. اطّلِع على مستندات Emulator Suite للتعرّف على كيفية تجهيز تطبيقك لمحاكاة وظائف قائمة المهام.

بالإضافة إلى ذلك، يتم عرض دوالّ قائمة المهام كدالّات HTTP بسيطة في Firebase Local Emulator Suite. يمكنك اختبار وظيفة مهمة محاكية من خلال إرسال طلب HTTP POST مع حمولة بيانات json:

 # start the Firebase Emulators
 firebase emulators:start

 # trigger the emulated task queue function
 curl \
  -X POST                                            # An HTTP POST request...
  -H "content-type: application/json" \              # ... with a JSON body
  http://localhost:$PORT/$PROJECT_ID/$REGION/$NAME \ # ... to function url
  -d '{"data": { ... some data .... }}'              # ... with JSON encoded data

نشر وظائف قائمة انتظار المهام

نشر دالة قائمة انتظار المهام باستخدام واجهة سطر الأوامر لـ Firebase:

$ firebase deploy --only functions:backupApod

عند نشر دالة "قائمة المهام" للمرة الأولى، تنشئ وحدة تحكّم سطر الأوامر ملفًا لجدولة المهام في Cloud Tasks مع خيارات (تقييد معدّل تكرار المحاولة وإعادة المحاولة) محددة في رمز المصدر.

إذا واجهتك أخطاء في الأذونات عند نشر الدوال، تأكَّد من إسناد أدوار إدارة الهوية وإمكانية الوصول المناسبة إلى المستخدم الذي يدير أوامر النشر.

إضافة وظائف قائمة انتظار المهام إلى قائمة الانتظار

يمكن إضافة دوال قائمة المهام إلى قائمة الانتظار في Cloud Tasks من بيئة خادم موثوق بها مثل Cloud Functions for Firebase باستخدام Firebase Admin SDK لنظام Node.js. إذا كنت مستخدمًا جديدًا لـ Admin SDK، يُرجى الاطّلاع على إضافة Firebase إلى خادم للبدء.

في المسار المعتاد، ينشئ Admin SDK مهمة جديدة ويضيفها إلى "قائمة الانتظار" في Cloud Tasks ويضبط الإعدادات للمهمة:

exports.enqueueBackupTasks = functions.https.onRequest(
async (_request, response) => {
  const queue = getFunctions().taskQueue("backupApod");
  const enqueues = [];
  for (let i = 0; i <= 10; i += 1) {
    // Enqueue each task with i*60 seconds delay. Our task queue function
    // should process ~1 task/min.
    const scheduleDelaySeconds = i * 60 
    enqueues.push(
        queue.enqueue(
          { id: `task-${i}` },
          {
            scheduleDelaySeconds,
            dispatchDeadlineSeconds: 60 * 5 // 5 minutes
          },
        ),
    );
  }
  await Promise.all(enqueues);
  response.sendStatus(200);

});
  • scheduleDelaySeconds: يحاول نموذج الرمز البرمجي توزيع تنفيذ المهام من خلال ربط تأخير مدته N دقيقة بالمهمة N. ويؤدي ذلك إلى بدء مهمة واحدة تقريبًا في الدقيقة. يُرجى العِلم أنّه يمكنك استخدام scheduleTime إذا أردت أن يشغّل Cloud Tasks مهمة في وقت محدد.
  • dispatchDeadlineSeconds: الحد الأقصى للوقت الذي Cloud Tasks سينتظره لإكمال مهمة سيعيد Cloud Tasks محاولة تنفيذ المهمة بعد إعادة محاولة إعداد قائمة الانتظار أو حتى الوصول إلى الموعد النهائي. في العينة، يتم ضبط قائمة الانتظار لإعادة محاولة تنفيذ المهمة حتى 5 مرات، ولكن يتم إلغاء المهمة تلقائيًا إذا استغرقت العملية بأكملها (بما في ذلك محاولات إعادة المحاولة) أكثر من 5 دقائق.

تحديد المشاكل وحلّها

Cloud Tasks">تفعيل تسجيل Cloud Tasks

تحتوي السجلات من Cloud Tasks على معلومات تشخيصية مفيدة مثل حالة الطلب المرتبط بمهمة ما. يتم تلقائيًا إيقاف السجلّات الواردة من "Cloud Tasks" بسبب حجم السجلات الكبير التي من المحتمل أن تُنشئها في مشروعك. ننصحك بتفعيل سجلّات تصحيح الأخطاء أثناء تطوير وظائف قائمة المهام وتصحيح أخطائها بشكل نشط. اطّلِع على مقالة تفعيل logging.

أذونات إدارة الهوية وإمكانية الوصول

قد تظهر لك أخطاء PERMISSION DENIED عند إضافة المهام إلى "قائمة الانتظار" أو عندما يحاول Cloud Tasks استدعاء وظائف "قائمة انتظار المهام". تأكَّد من أنّ مشروعك يتضمّن عمليات الربط التالية لخدمة إدارة الهوية وإمكانية الوصول:

  • يجب أن تمتلك الهوية المستخدَمة لإضافة المهام إلى "قائمة الانتظار" في Cloud Tasks إذن cloudtasks.tasks.create إدارة الهوية والوصول.

    في النموذج، هذا هو حساب الخدمة التلقائي لـ App Engine.

gcloud projects add-iam-policy-binding $PROJECT_ID \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudtasks.enqueuer
  • تحتاج الهوية المستخدمة لإدراج المهام في قائمة انتظار Cloud Tasks إلى إذن لاستخدام حساب الخدمة المرتبط بمهمة في Cloud Tasks.

    في العيّنة، هذا هو حساب الخدمة التلقائي App Engine.

يمكنك الاطّلاع على مستندات Google Cloud IAM للحصول على تعليمات عن كيفية إضافة حساب الخدمة التلقائي على App Engine كمستخدم لحساب خدمة App Engine التلقائي.

gcloud functions add-iam-policy-binding $FUNCTION_NAME \
  --region=us-central1 \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudfunctions.invoker