ReactNative/profile hermes

فحص الأداء Profiling باستخدام هيرميس Hermes

يمكنك تصوّر أداء شيفرة JavaScript في تطبيق React Native باستخدام Hermes، وهو محرك JavaScript صغير وخفيف الوزن ومُحسَّن لتشغيل إطار عمل React Native على نظام Android (اطّلع على المزيد عن استخدام Hermes مع React Native). يساعد Hermes في تحسين أداء التطبيق كما يعرض طرقًا لتحليل أداء شيفرة JavaScript المُشغَّلة.

سنتعلم في هذه الصفحة كيفية فحص أداء تطبيق React Native الذي يعمل على Hermes وكيفية تصوّر فاحص الأداء باستخدام تبويب الأداء Performance في أدوات تطوير كروم Chrome DevTools.

تأكّد من تفعيل hermes في تطبيقك قبل البدء.

اتّبع الإرشادات أدناه لبدء فحص الأداء:

1. سجّل فاحص أداء أخذ عينات من Hermes.
2. نفّذ أمرًا من CLI.
3. افتح فاحص الأداء الذي نُزِّل على الأدوات Chrome DevTools.

تسجيل فاحص أداء أخذ عينات من Hermes

يمكنك تسجيل فاحص أداء أخذ العينات من قائمة المطور كما يلي:

1. انتقل إلى طرفية خادم Metro التي تكون قيد التشغيل.
2. اضغط d من لوحة المفاتيح لفتح قائمة المطور Developer Menu.
3. اختر Enable Sampling Profiler.
4. نفّذ شيفرة JavaScript الخاصة بك في تطبيقك (كالضغط على الأزرار وغير ذلك).
5. افتح قائمة المطور بالضغط على d مرة أخرى.
6. حدّد Disable Sampling Profiler لإيقاف التسجيل وحفظ مراقب أداء أخذ العينات.

ستعرُض قائمة منبثقة الموقعَ الذي حُفِظ فيه فاحص الأداء العينات، الذي هو ‎/data/user/0/com.appName/cache/*.cpuprofile

نفذ أمرًا من CLI

يمكنك استخدام React Native CLI لتحويل تعقّب فاحص أداء Hermes إلى تعقّب فاحص أداء Chrome، ثم سحبه إلى جهازك المحلي باستخدام الأمر:

npx react-native profile-hermes [destinationDir]

تفعيل خريطة الشيفرة البرمجية المحوّلة source map

تُستخدَم خريطة source map لتحسين فاحص الأداء وربط أحداث التعقّب بشيفرة التطبيق. يمكنك إنشاء خريطة source map تلقائيًا عند تحويل تعقّب فاحص أداء Hermes إلى تعقّب فاحص أداء Chrome عن طريق تفعيل bundleInDebug إذا كان التطبيق في وضع التطوير، ويسمح ذلك لإطار عمل React Native ببناء الحزمة bundle أثناء عملية التشغيل بالطريقة التالية:

1. أضف ما يلي في ملف android/app/build.gradle الخاص بتطبيقك:

project.ext.react = [
  bundleInDebug: true,
]

تأكد من تنظيف البناء عند إجراء أي تغييرات في build.gradle.

2. نظّف البناء عن طريق تشغيل الأمر:

cd android && ./gradlew clean

3. ثم شغّل تطبيقك:

npx react-native run-android

أخطاء شائعة

adb: no devices/emulators found أو adb: device offline

• سبب حدوث هذا الخطأ: لا تستطيع CLI الوصول إلى الجهاز أو المحاكي (عبر adb) الذي تستخدمه لتشغيل التطبيق.

• كيفية الإصلاح: تأكد من توصيل جهاز Android أو المحاكي وتشغيله، حيث يعمل الأمر فقط عندما يمكنه الوصول إلى adb.

There is no file in the cache/ directory

• سبب حدوث هذا الخطأ: يتعذر على CLI العثور على أي ملف ‎.cpuprofile في المجلد cache/‎ الخاص بتطبيقك. قد يكون السبب أنك نسيت تسجيل فاحص أداء من الجهاز.
• كيفية الإصلاح: اتبع التعليمات في فقرة "تسجيل فاحص أداء أخذ عينات من Hermes" لتفعيل أو تعطيل فاحص الأداء من الجهاز.

Error: your_profile_name.cpuprofile is an empty file

• سبب حدوث هذا الخطأ: فاحص الأداء فارغ، وقد يكون ذلك بسبب عدم تشغيل Hermes تشغيلًا صحيحًا.
• كيفية الإصلاح: تأكد من تشغيل تطبيقك على أحدث إصدار من Hermes.

افتح فاحص الأداء المُنزَّل في أدوات تطوير كروم Chrome DevTools

يمكنك فتح فاحص الأداء في أدوات Chrome DevTools من خلال الخطوات التالية:

1. افتح أدوات تطوير كروم Chrome DevTools.
2. اختر تبويب "الأداء Performance".
3. انقر بزر الفأرة الأيمن واختر "تحميل فاحص الأداء Load profile".

كيفية عمل محوّل فاحص أداء Hermes

تنسيق فاحص أداء عينات Hermes هو JSON object format، ولكن التنسيق الذي تدعمه أدوات DevTools من Google هو التنسيق JSON Array Format. يمكنك العثور على مزيد من المعلومات حول التنسيقات في مستند تنسيق أحداث التعقّب.

export interface HermesCPUProfile {
  traceEvents: SharedEventProperties[];
  samples: HermesSample[];
  stackFrames: { [key in string]: HermesStackFrame };
}

يحتوي فاحص أداء Hermes على معظم معلوماته المشفَّرة في خصائص العينات samples و إطارات المكدس stackFrames. كل عينة هي لقطة من مكدس استدعاء الدالة في تلك العلامة الزمنية المحدَّدة حيث أن كل عينة لها خاصية sf التي تتوافق مع استدعاء دالة.

export interface HermesSample {
  cpu: string;
  name: string;
  ts: string;
  pid: number;
  tid: string;
  weight: string;
  /**
   * ‫سيشير إلى عنصر في الكائن stackFrames الخاص بفاحص أداء Hermes
   */
  sf: number;
  stackFrameData?: HermesStackFrame;
}

يمكن العثور على معلومات استدعاء الدالة في الكائن stackFrames الذي يحتوي على أزواج مفتاح - كائن key-object، حيث يكون المفتاح هو رقم sf ويعطينا الكائن المقابل جميع المعلومات المتعلّقة بالدالة بما في ذلك رقم sf لدالتها الأب. يمكن تعقّب هذه العلاقة بين الأب والابن للأعلى للعثور على معلومات عن جميع الدوال التي تعمل في علامة زمنية معينة.

export interface HermesStackFrame {
  line: string;
  column: string;
  funcLine: string;
  funcColumn: string;
  name: string;
  category: string;
  /**
   * قد تكون الدالة الأب موجودة أو غير موجودة
   */
  parent?: number;
}

يجب في هذه المرحلة تحديد بعض المصطلحات الأخرى، وهي:

1. العقد Nodes: الكائنات المقابلة لأرقام sf في الكائن stackFrames
2. العقد النشطة Active Nodes: هي العقد التي تُشغَّل في علامة زمنية معينة. تُصنَّف العقدة على أنها مُشغَّلة إذا كان رقمها sf في مكدس استدعاء الدالة، ويمكن الحصول على مكدس الاستدعاءات هذا من رقم sf الخاص بالعينة والتعقّب لأعلى حتى تتوّفر أرقام sf الأب.

يمكن بعد ذلك استخدام العينات samples ومكدس الإطارات stackFrames جنبًا إلى جنب لتوليد جميع أحداث البداية والنهاية في العلامات الزمنية المقابلة، حيث:

1. أحداث أو عقد البداية: هي عقد غير موجودة في مكدس استدعاءات الدالة الخاص بالعينة السابقة ولكنها موجودة في مكدس استدعاءات الدالة للعينة الحالية.
2. أحداث أو عقد النهاية: هي العقد الموجودة في مكدس استدعاءات الدالة الخاص بالعينة السابقة ولكنها غير موجودة في مكدس استدعاءات الدالة للعينة الحالية.

يمكنك الآن إنشاء مخطّط flamechart لاستدعاءات الدوال عندما يكون لديك جميع معلومات هذه الدوال بما في ذلك علامات البداية والنهاية الزمنية.

يمكن للمحوّل hermes-profile-transformer تحويل أي فاحص أداء منشَأ باستخدام Hermes إلى تنسيق يمكن عرضه مباشرة في أدوات Chrome DevTools. يمكنك العثور على مزيد من المعلومات حول هذا الموضوع من خلال react-native-community/hermes-profile-transformer@.

مصادر

• صفحة Profiling with Hermes في توثيق React Native الرسمي.