העברה למניפסט מגרסה V3

מדריך להמרה של תוספי Manifest V2 לתוספי Manifest V3.

הקטע הזה יעזור לך לשדרג תוסף ממניפסט V2 למניפסט V3, הגרסה החדשה ביותר של פלטפורמת התוספים ל-Chrome. עבודת ההעברה מחולקת באופן כללי לקטגוריות הבאות. כדי לעזור לך לעקוב אחרי העבודה שלך, כללנו רשימת משימות שמסכמת את התוכן של המסמכים האלה. אפשר לגשת לתוכן דרך רשימת המשימות או להתעמק בו. שני הנתיבים מסתיימים בתוסף משודרג.

  • עדכון המניפסטmanifest.json חייב להיות ספציפי ל-V3. בקטע הזה מתוארים שינויים שאפשר לבצע לבד. שינויים במניפסט שקשורים לקוד מתוארים עם שינויי הקוד שנתמכים בהם.
  • העברה ל-Service Worker – קובץ שירות (service worker) מחליף את דף הרקע או את דף האירוע של התוסף כדי להבטיח שקוד הרקע לא יופיע ב-thread הראשי, כי הוא עלול לפגוע בביצועים. שינוי זה מחייב גם להעביר DOM, חלון וקריאות מסוימות של תוסף API למסמכים שאינם במסך.
  • עדכון קריאות ל-API – צריך להחליף קריאות מסוימות ל-API בקריאות מקבילות יותר מודרניות.
  • החלפת פונקציות event listener חוסמות של בקשות אינטרנט – חסימה או שינוי של בקשות רשת במניפסט מגרסה V2 עלולים לפגוע בביצועים ולדרוש גישה מוגזמת לנתוני משתמשים רגישים. ה-Delarative Net Request API מאפשר לתוספים לחסום או לשנות תוכן אינטרנט עם פחות הרשאות ובלי לפגוע בביצועים.
  • שיפור האבטחה של תוספים – Manifest V3 משפר את אבטחת התוספים בכמה דרכים. מלבד מדיניות משופרת של אבטחת תוכן, מוסרת התמיכה בקוד באירוח מרוחק ובביצוע מחרוזות שרירותיות.
  • מפרסמים את התוסף – בקטע הזה מוסבר איך לבצע השקה מדורגת, כדי לוודא שתוסף המניפסט V3 יפעל כצפוי על ידי בדיקתו קודם בקרב קהל מוגבל.

יש לנו גם כלי להמרת מניפסט תוספים. הוא לא עושה את כל הפעולות בשבילכם, אבל הוא יעזור לכם להתחיל. קובץ README של הממיר מתאר מה הכלי משנה.

שמירה של קבוצת התכונות הנוכחית

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

בדרך כלל יש תמיכה במניפסט מגרסה V3 ב-Chrome מגרסה 88 ואילך. כשמעדכנים קריאות ל-API, יכול להיות שהתכונות החלופיות הגיעו ל-Chrome רק אחרי גרסה 88. דפי העזר של API מכילים מידע על תמיכה לחברים ספציפיים ב-API. אם גיליתם שדרושה לכם אחת מהתכונות האלה, תוכלו לציין גרסת Chrome מינימלית בקובץ המניפסט.

תכונות חדשות של פלטפורמת התוספים

מאז השקת גרסה 3 של המניפסט, המשכנו להוסיף תכונות חדשות. ניתן להשתמש בהרבה מהן גם במניפסט מגרסה V2 וגם במניפסט מגרסה V3. אין צורך להשתמש בהן במהלך ההמרה. עם זאת, כשהן מחליפות תכונות ישנות יותר, עדיף להשתמש בהן במקום בתכונות שהן יחליפו, ולצפות שהתכונות המוחלפות יוצאו משימוש בסופו של דבר.