הפעלת Winscope

המעקב ב-Winscope הוא חלק ממסגרת Android. בדף הזה מפורטים השלבים הנדרשים להורדה, לבנייה ולהפעלה של הכלי Winscope trace viewer באופן מקומי.

פיתוח Winscope באופן מקומי

כדי להגדיר את המחשב להרצת הכלי Winscope Tracer:

1. הורדת המקור של Android

2. עוברים לתיקייה Winscope:

   cd development/tools/winscope
   

3. מתקינים את יחסי התלות באמצעות:

   npm install
   

   כדי לראות את רשימת הפקודות הזמינות, מריצים את הפקודה: npm run

4. כדי ליצור את כל יעדי הייצור והבדיקה, משתמשים בפקודה:

   npm run build:prod
   

5. מפעילים את Winscope באמצעות:

   npm run start
   

יצירת חלקים נפרדים

אפשר ליצור חלקים בודדים של Winscope בנפרד באמצעות הפקודות הבאות:

הרצת בדיקות

‫Winscope מכיל בדיקות יחידה ובדיקות מקצה לקצה. כדי להריץ אותן, משתמשים ב-npm run <command>:

בדיקות מקצה לקצה

לפני שמריצים בדיקות מקצה לקצה, צריך להפעיל את הכלי המרוחק ולהתקין את הגרסה הנכונה של Chrome driver. בקטע הקוד הבא, הפקודה run test:e2e מתקינה באופן אוטומטי את מנהל ההתקן של Chrome.

$ npm run start
$ npm run start:remote_tool_mock
$ npm run test:e2e

בטבלה הבאה מפורטות הפקודות הנדרשות והתיאורים שלהן. כדי להפעיל אותם, משתמשים ב-npm run command:

עדכון המיפוי של ‎ @IntDef

‫@IntDef היא הערה שמשמשת ב-Android להגבלת הערכים האפשריים של מספר שלם. ‫Winscope משתמש במיפוי של ההערות האלה כדי להציג את שם הערך במקום המספר השלם.

אם ערכים חדשים של @IntDef מתווספים למסגרת Android אבל לא מתעדכנים ב-Winscope, הם מוצגים כערכי מספרים שלמים גולמיים במקום כמחרוזות תיאוריות. כדי לפתור את הבעיה, צריך לעדכן את קובץ המיפוי IntDef ‏(development/tools/winscope/src/common/intDefMapping.json).

כדי לעדכן אוטומטית את המיפוי @IntDef:

1. מריצים את הסקריפט update_intdef_mappings.sh מהספרייה development/tools/winscope/scripts/ בעץ Android המקומי. הסקריפט הזה מפעיל את תהליך ההערות שבו מתבצעת חילוץ של הערכים האחרונים@IntDef מהקוד ועדכון של intDefMapping.json:

   cd development/tools/winscope
   ./scripts/update_intdef_mappings.sh
   

2. מבצעים Commit של השינויים ב-src/common/intDefMapping.json באמצעות הפקודה git commit ומעלים אותם באמצעות הפקודה repo upload.

אם הסקריפט לא זמין, צריך לבצע את השלבים הבאים כדי לעדכן את המיפוי של @IntDef באופן ידני מתיקיית הבסיס של Android ($ANDROID_BUILD_TOP):

1. מבצעים build של framework-minus-apex-intdefs כדי להריץ את מעבד ההערות:

   m framework-minus-apex-intdefs
   

2. מעתיקים את קובץ intDefMapping.json שנוצר למאגר prebuilts:

   $ python3 -c 'import sys,json,collections; print(json.dumps(collections.OrderedDict(sorted(collections.ChainMap(*map(lambda x:json.load(open(x)), sys.argv[1:])).items())), indent=2))' $(find out/soong/.intermediates/frameworks/base -iname intDefMapping.json) > ./development/tools/winscope/src/common/intDefMapping.json
   

3. מעלים את השינויים ב-Winscope באמצעות repo upload.

פקודות אחרות

בנוסף לבנייה ולבדיקות, סקריפטים של Winscope מכילים יכולות אחרות, כמו שמוצג בטבלה. כדי להריץ אותן, משתמשים ב-npm run command:

פתרון בעיות

כדאי לנסות את הטיפים הבאים לפתרון בעיות:

• שגיאה ProtocolError: missing required '<FIELD>' או TypeError: Cannot read property '<PROP>' of null

  • המצב הזה קורה כשקובץ פרטי העברה נוצר עם הגדרת פרוטו חדשה, שמכילה שדות חובה חדשים.

    1. חשוב לוודא שפותחים את ה-trace בגרסה הנכונה של Winscope (master,‏ S או R).

    2. אם יוצרים את השדה החדש ב-proto, צריך לקמפל מחדש את ה-proto ב-Winscope באמצעות npm run build:protos.

• חלק מגרסאות יחסי התלות שהותקנו שגויות (הבנייה נכשלת)

  • חזרה לגרסה הקודמת של package.json ושל package-lock.json. הסרה של node_modules. מריצים את npm install שוב.

• הוספתי שדה חדש לאחד מקובצי ה-proto. איך מציגים את המידע?

  • ‫Winscope משתמש בהגדרות פרוטו מהרגע שבו הוא קומפל, ולכן שדות חדשים לא יופיעו כברירת מחדל. כדי להציג שדות חדשים, צריך לבנות מחדש את קובצי ה-proto באמצעות npm run build:protos.