استخدام TypeScript لوظائف السحابة الإلكترونية

بالنسبة إلى المطوّرين الذين يفضّلون كتابة الدوالّ في TypeScript، Cloud Functions يوفّر نوعَين من الدعم:

  • إنشاء مشاريع TypeScript وضبطها للترجمة التلقائية عند بدء التشغيل (firebase init functions)
  • تحويل مصدر TypeScript الحالي إلى JavaScript في وقت النشر من خلال خطاف ما قبل النشر

باتّباع التعليمات الواردة في هذا الدليل، يمكنك نقل ملف IDE JavaScript حالي إلى TypeScript ومواصلة نشر الدوال باستخدام ملف IDE predeploy hook لتحويل رمز المصدر. توفّر TypeScript العديد من المزايا مقارنةً بـ JavaScript عند كتابة الدوالّ:

  • تتوافق TypeScript مع أحدث ميزات JavaScript، مثل async/await، ما يسهّل إدارة الوعود.
  • يُبرز مدقّق الأخطاء في Cloud Functions المشاكل الشائعة أثناء كتابة الرموز البرمجية.
  • تساعدك سلامة النوع في تجنُّب أخطاء وقت التشغيل في الدوالّ المنشورة.

إذا كنت مبتدئًا في استخدام TypeScript، راجِع TypeScript في غضون 5 دقائق.

بدء مشروع Cloud Functions جديد باستخدام TypeScript

شغِّل firebase init functions في دليل جديد. تمنحك الأداة خيارات لإنشاء المشروع باستخدام JavaScript أو TypeScript. اختَر TypeScript لإخراج بنية المشروع التالية:

myproject
 +- functions/     # Directory containing all your functions code
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- tsconfig.json
      |
      +- .eslintrc.js # Optional file if you enabled ESLint
      +- tsconfig.dev.json # Optional file that references .eslintrc.js
      |
      +- src/     # Directory containing TypeScript source
      |   |
      |   +- index.ts  # main source file for your Cloud Functions code
      |
      +- lib/
          |
          +- index.js  # Built/transpiled JavaScript code
          |
          +- index.js.map # Source map for debugging

بعد اكتمال الإعداد، يجب إلغاء تعليق النموذج في index.ts ثم تنفيذ npm run serve للاطّلاع على دالة Hello World أثناء عمله.

استخدام مشروع TypeScript حالي

إذا كان لديك مشروع TypeScript حالي، يمكنك إضافة أداة ربط ما قبل النشر لمحاولة تحويل مشروعك إلى رمز برمجي قابل للتنفيذ في كل مرة تنشر فيها الرمز إلىCloud Functions for Firebase. ستحتاج إلى ملف tsconfig.json منسَّق بشكل صحيح ومشروع على Firebase، وسيكون عليك إجراء التعديلات التالية على إعدادات Firebase:

  1. عدِّل package.json لإضافة نص برمجي bash لإنشاء مشروع TypeScript. على سبيل المثال:

     {
   "name": "functions",
   "scripts": {
     "build": "npm run lint && tsc"
   }
 ...

  2. يجب تعديل firebase.json لإضافة عنصر جذب مسبق للنشر من أجل تشغيل النص البرمجي للإصدار. على سبيل المثال:

     {
   "functions": {
     "predeploy": "npm --prefix functions run build",
   }
 }

باستخدام هذه الإعدادات، ينشئ الأمر firebase deploy --only functions رمز TypeScript وينشره كدوالّ.

نقل مشروع JavaScript حالي إلى TypeScript

إذا كان لديك مشروع Cloud Functions حالي أعددته وطوّرته باستخدام JavaScript، يمكنك نقله إلى TypeScript. ننصحك بشدة بإنشاء نقطة تفتيش في git أو إجراء عملية نسخ احتياطي أخرى قبل البدء.

لنقل بيانات مشروع JavaScript Cloud Functions حالي:

  1. أنشئ نقطة تفتيش في git واحفظ نُسخًا من ملفات JavaScript المصدر الحالية.
  2. في دليل المشروع، شغِّل firebase init functions واختَر TypeScript عندما يُطلب منك اختيار لغة لكتابة الدوالّ.
  3. عندما يُطلب منك تحديد ما إذا كنت تريد استبدال ملف package.json الحالي، انقر على لا ما لم تكن متأكدًا من أنّك لا تريد الاحتفاظ بالملف الحالي.
  4. حذف index.ts في الدليل functions/src واستبداله برمز المصدر الحالي
  5. في الملف tsconfig.json الذي تم إنشاؤه أثناء الإعداد، اضبط خيارات برنامج التجميع للسماح بلغة JavaScript: "allowJs": true.
  6. انسخ ملف package.json المحفوظ إلى دليل functions، وعدِّله لضبط "main" على "lib/index.js".

  7. في package.json أيضًا، أضِف نصًا برمجيًا للإصدار TypeScript على النحو التالي:

     {
   "name": "functions",
   "scripts": {
     "build": "npm run lint && tsc"
   }
 ...

  8. أضِف "typescript" كتبعية مطوّر من خلال تشغيل npm install --save-dev typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser.

  9. بالنسبة إلى جميع الموارد التابعة، شغِّل npm install --save @types/<dependency>.

  10. أعِد كتابة رمز المصدر من .js إلى .ts على النحو المطلوب.

محاكاة دوال TypeScript

لاختبار دوال TypeScript محليًا، يمكنك استخدام أدوات المحاكاة الموضّحة في مقالة تشغيل الدوالّ محليًا. من المهم compiling رمزك البرمجي قبل استخدام هذه الأدوات، لذا احرص على تشغيل npm run build داخل دليل الدوالّ قبل تشغيل firebase emulators:start أو firebase functions:shell. بدلاً من ذلك، يمكنك تشغيل npm run serve أو npm run shell كاختصار، حيث يؤدي كلا الأمرَين إلى تشغيل عملية الإنشاء وعرض/بدء shell الدوال.

سجلات الدوال لمشاريع TypeScript

أثناء عملية firebase deploy، يتم تحويل index.ts مشروعك إلى index.js، ما يعني أنّ سجلّ Cloud Functions سيعرض أرقام الأسطر منملف index.js وليس الرمز الذي كتبته. لتسهيل العثور على المسارات وأرقام الأسطر المقابلة في index.ts، أنشأ firebase deploy functions/lib/index.js.map. يمكنك استخدام ملف تخطيط المصادر هذا في بيئة تطوير البرامج المفضّلة لديك أو من خلال وحدة عقدة.