چرخه حیات عامل خدماتی

چرخه حیات عامل خدماتی پیچیده‌ترین بخش آن است. اگر ندانید که این فناوری چه کاری می‌خواهد انجام دهد و مزایای آن چیست، ممکن است احساس کنید که با شما درحال مبارزه است. اما وقتی با نحوه عملکرد آن آشنا شوید، می‌توانید به‌روزرسانی‌های یکپارچه و نامحسوسی را به کاربران ارائه دهید و بهترین الگوهای وب و بومی را باهم ترکیب کنید.

این یک بررسی عمیق است، اما نکات کلیدی در ابتدای هر بخش بیشتر آنچه را که باید بدانید پوشش می‌دهد.

قصد

هدف چرخه حیات این است:

  • امکان‌پذیر کردن اولویت آفلاین.
  • به عامل خدماتی جدید اجازه می‌دهد بدون ایجاد اختلال در عامل خدماتی فعلی، خودش را آماده کند.
  • مطمئن شوید که صفحه درون‌محدوده در سراسر فرایند توسط همان عامل خدماتی (یا بدون عامل خدماتی) کنترل می‌شود.
  • مطمئن شوید که فقط یک نسخه از سایتتان به‌طور هم‌زمان اجرا می‌شود.

مورد آخر بسیار مهم است. بدون کارگران خدماتی، کاربران می‌توانند یک برگه را به سایت شما بارگیری کنند، سپس بعداً برگه دیگری را باز کنند. این امر می‌تواند باعث شود دو نسخه از سایت شما به‌طور هم‌زمان اجرا شود. گاهی اوقات این مشکلی ندارد، اما اگر با فضای ذخیره‌سازی سروکار دارید، به‌راحتی ممکن است به وضعیتی برسید که دو برگه نظرات بسیار متفاوتی درباره نحوه مدیریت فضای ذخیره‌سازی مشترکشان داشته باشند. این کار می‌تواند منجر به خطا یا بدتر از آن، ازدست رفتن داده‌ها شود.

اولین عامل خدماتی

به‌طور خلاصه:

  • رویداد install اولین رویدادی است که یک سرویس‌کار دریافت می‌کند و فقط یک‌بار اتفاق می‌افتد.
  • یک Promise که به installEvent.waitUntil() ارسال می‌شود، مدت‌زمان و موفقیت یا شکست نصب شما را نشان می‌دهد.
  • یک کارگر خدماتی رویدادهایی مانند fetch و push را دریافت نخواهد کرد تا زمانی که نصب آن با موفقیت به پایان برسد و «فعال» شود.
  • به‌طور پیش‌فرض، واکشی‌های صفحه ازطریق عامل خدماتی انجام نمی‌شود، مگراینکه درخواست صفحه ازطریق عامل خدماتی انجام شده باشد. بنابراین باید صفحه را بازآوری کنید تا تأثیرات کارگر سرویس را ببینید.
  • clients.claim() می‌تواند این پیش‌فرض را لغو کند و کنترل صفحه‌های کنترل‌نشده را به‌دست بگیرد.

این HTML را بگیرید:

<!DOCTYPE html>
An image will appear here in 3 seconds:
<script>
  navigator.serviceWorker.register('/sw.js')
    .then(reg => console.log('SW registered!', reg))
    .catch(err => console.log('Boo!', err));

  setTimeout(() => {
    const img = new Image();
    img.src = '/dog.svg';
    document.body.appendChild(img);
  }, 3000);
</script>

این برنامه یک Service Worker را ثبت می‌کند و پس‌از ۳ ثانیه تصویر سگی را اضافه می‌کند.

این هم کارگر خدماتی آن، sw.js:

self.addEventListener('install', event => {
  console.log('V1 installing…');

  // cache a cat SVG
  event.waitUntil(
    caches.open('static-v1').then(cache => cache.add('/cat.svg'))
  );
});

self.addEventListener('activate', event => {
  console.log('V1 now ready to handle fetches!');
});

self.addEventListener('fetch', event => {
  const url = new URL(event.request.url);

  // serve the cat SVG from the cache if the request is
  // same-origin and the path is '/dog.svg'
  if (url.origin == location.origin && url.pathname == '/dog.svg') {
    event.respondWith(caches.match('/cat.svg'));
  }
});

تصویر گربه‌ای را در حافظه پنهان ذخیره می‌کند و هرگاه درخواستی برای /dog.svg وجود داشته باشد، آن را ارائه می‌دهد. بااین‌حال، اگر نمونه بالا را اجرا کنید، اولین باری که صفحه را بار می‌کنید، سگی را خواهید دید. روی بازآوری ضربه بزنید تا گربه را ببینید.

حوزه و کنترل

محدوده پیش‌فرض ثبت عامل خدماتی ./ نسبت به نشانی وب اسکریپت است. یعنی اگر عامل خدماتی را در //example.com/foo/bar.js ثبت کنید، دامنه پیش‌فرض آن //example.com/foo/ است.

صفحه‌ها، کارگران، و کارگران هم‌رسانی‌شده را clients می‌نامیم. کارگر سرویس شما فقط می‌تواند مشتریانی را کنترل کند که در محدوده هستند. وقتی کارخواه «کنترل» شود، واکشی‌های آن ازطریق کارگر سرویس در محدوده انجام می‌شود. می‌توانید ازطریق navigator.serviceWorker.controller تشخیص دهید که آیا کارخواه کنترل می‌شود یا نه، که مقدار آن تهی یا نمونه‌ای از کارگر سرویس خواهد بود.

بارگیری، تجزیه، و اجرا

اولین کارمند خدماتی شما وقتی .register() را فراخوانی می‌کنید بارگیری می‌شود. اگر اسکریپت شما بارگیری یا تجزیه نشود یا در اجرای اولیه خود خطایی ایجاد کند، وعده ثبت رد می‌شود و کارگر سرویس کنار گذاشته می‌شود.

DevTools در Chrome خطا را در کنسول و در بخش سرویس‌کار برگه برنامه نشان می‌دهد:

خطا در برگه DevTools کارگر سرویس نمایش داده شد

نصب

اولین رویدادی که یک کارمند خدمات دریافت می‌کند install است. این رویداد به‌محض اجرای کارگر راه‌اندازی می‌شود و فقط یک‌بار برای هر کارگر سرویس فراخوانی می‌شود. اگر اسکریپت کارگر سرویس خود را تغییر دهید، مرورگر آن را به‌عنوان یک کارگر سرویس متفاوت در نظر می‌گیرد و رویداد install خودش را دریافت می‌کند. بعداً به‌روزرسانی‌ها را با جزئیات پوشش خواهم داد.

رویداد install فرصتی برای شما است تا قبل‌از اینکه بتوانید کارخواه‌ها را کنترل کنید، هرچیزی را که نیاز دارید در حافظه نهان ذخیره کنید. قولی که به event.waitUntil() می‌دهید به مرورگر اطلاع می‌دهد که نصب شما چه زمانی تکمیل می‌شود و آیا موفقیت‌آمیز بوده است یا نه.

اگر promise شما رد شود، این نشان می‌دهد که نصب ناموفق بوده است و مرورگر service worker را دور می‌اندازد. هرگز کارخواه‌ها را کنترل نخواهد کرد. این یعنی می‌توانیم به وجود cat.svg در حافظه نهان در رویدادهای fetch خود تکیه کنیم. این یک وابستگی است.

فعال کردن

وقتی کارگر سرویس شما آماده کنترل مشتریان و رسیدگی به رویدادهای عملکردی مانند push و sync باشد، رویداد activate را دریافت خواهید کرد. اما این بدان معنا نیست که صفحه‌ای که .register() را فراخوانی کرده است کنترل خواهد شد.

اولین باری که نسخه نمایشی را بار می‌کنید، بااینکه dog.svg مدت‌ها پس‌از فعال شدن سرویس‌کار درخواست می‌شود، درخواست را مدیریت نمی‌کند و همچنان تصویر سگ را می‌بینید. پیش‌فرض سازگاری است، اگر صفحه شما بدون کارمند سرویس بار شود، منابع فرعی آن نیز بار نخواهند شد. اگر نسخه نمایشی را برای بار دوم بار کنید (به‌عبارت دیگر، صفحه را بازآوری کنید)، کنترل خواهد شد. هم صفحه و هم تصویر fetch رویداد را پشت سر می‌گذارند و به‌جای آن گربه‌ای خواهید دید.

clients.claim

می‌توانید با فراخوانی clients.claim() در کارگر سرویس خود پس‌از فعال شدن، کنترل مشتریان کنترل‌نشده را به‌دست بگیرید.

در اینجا نسخه دیگری از نسخه نمایشی بالا را می‌بینید که clients.claim() را در رویداد activate خود فراخوانی می‌کند. بار اول باید گربه را ببینید. می‌گویم «باید»، چون این موضوع به زمان حساس است. فقط درصورتی گربه را خواهید دید که عامل خدماتی فعال شود و clients.claim() قبل‌از تلاش برای بار کردن تصویر اعمال شود.

اگر از کارگر سرویس خود برای بار کردن صفحه‌ها به‌شکلی متفاوت از بار شدن آن‌ها ازطریق شبکه استفاده می‌کنید، clients.claim() می‌تواند مشکل‌ساز باشد، زیرا کارگر سرویس شما درنهایت برخی‌از مشتریانی را که بدون آن بار شده‌اند کنترل می‌کند.

درحال به‌روزرسانی کارگر سرویس

به‌طور خلاصه:

  • اگر هریک از موارد زیر اتفاق بیفتد، به‌روزرسانی راه‌اندازی می‌شود:
    • پیمایش به صفحه درون‌محدوده.
    • رویدادهای عملکردی مانند push و sync، مگراینکه در ۲۴ ساعت گذشته بررسی به‌روزرسانی انجام شده باشد.
    • فراخوانی .register() فقط درصورتی‌که نشانی وب Service Worker تغییر کرده باشد. بااین‌حال، باید از تغییر نشانی وب کارگر اجتناب کنید.
  • اکثر مرورگرها، ازجمله Chrome نسخه ۶۸ و بالاتر، به‌طور پیش‌فرض هنگام بررسی به‌روزرسانی‌های اسکریپت ثبت‌شده کارگر سرویس، سرصفحه‌های ذخیره‌سازی موقت را نادیده می‌گیرند. آن‌ها همچنان هنگام واکشی منابع بارشده در یک عامل خدماتی ازطریق importScripts()، به سرایندهای ذخیره‌سازی در حافظه نهان احترام می‌گذارند. می‌توانید این رفتار پیش‌فرض را با تنظیم گزینه updateViaCache هنگام ثبت‌نام کارگر سرویس خود لغو کنید.
  • اگر کارگر سرویس شما ازنظر بایت با کارگر سرویسی که مرورگر ازقبل دارد متفاوت باشد، به‌روزرسانی‌شده درنظر گرفته می‌شود. (درحال گسترش این ویژگی هستیم تا اسکریپت‌ها/ ماژول‌های واردشده را نیز دربرگیرد.)
  • سرویس‌کار به‌روزشده در کنار سرویس‌کار موجود راه‌اندازی می‌شود و رویداد install خودش را دریافت می‌کند.
  • اگر کارگر جدید شما کد وضعیت غیرقابل‌قبول (مثلاً ۴۰۴) داشته باشد، تجزیه نشود، درطول اجرا خطا ایجاد کند، یا درطول نصب رد شود، کارگر جدید دور انداخته می‌شود، اما کارگر فعلی فعال باقی می‌ماند.
  • پس‌از نصب موفقیت‌آمیز، کارگر به‌روزشده wait تا زمانی که کارگر موجود صفر کارخواه را کنترل کند. (توجه داشته باشید که کارخواه‌ها درطول بازآوری هم‌پوشانی دارند.)
  • ‫self.skipWaiting() از انتظار جلوگیری می‌کند، یعنی به‌محض اینکه نصب سرویس‌گر تمام شود، فعال می‌شود.

فرض کنید اسکریپت کارگر سرویس را تغییر داده‌ایم تا به‌جای گربه، تصویر اسب را برگرداند:

const expectedCaches = ['static-v2'];

self.addEventListener('install', event => {
  console.log('V2 installing…');

  // cache a horse SVG into a new cache, static-v2
  event.waitUntil(
    caches.open('static-v2').then(cache => cache.add('/horse.svg'))
  );
});

self.addEventListener('activate', event => {
  // delete any caches that aren't in expectedCaches
  // which will get rid of static-v1
  event.waitUntil(
    caches.keys().then(keys => Promise.all(
      keys.map(key => {
        if (!expectedCaches.includes(key)) {
          return caches.delete(key);
        }
      })
    )).then(() => {
      console.log('V2 now ready to handle fetches!');
    })
  );
});

self.addEventListener('fetch', event => {
  const url = new URL(event.request.url);

  // serve the horse SVG from the cache if the request is
  // same-origin and the path is '/dog.svg'
  if (url.origin == location.origin && url.pathname == '/dog.svg') {
    event.respondWith(caches.match('/horse.svg'));
  }
});

نسخه نمایشی موارد بالا را ببینید. هنوز باید تصویر گربه را ببینید. دلیلش این است…

نصب

توجه داشته باشید که نام حافظه نهان را از static-v1 به static-v2 تغییر داده‌ام. این یعنی می‌توانم حافظه پنهان جدید را بدون رونویسی کردن موارد موجود در حافظه پنهان فعلی (که کارگر سرویس قدیمی هنوز از آن استفاده می‌کند) راه‌اندازی کنم.

این الگو حافظه‌های پنهان مختص نسخه ایجاد می‌کند، شبیه به دارایی‌هایی که یک برنامه به زبان اصلی دستگاه با فایل اجرایی خود بسته‌بندی می‌کند. همچنین ممکن است حافظه‌های پنهانی داشته باشید که مختص نسخه نباشند، مثل avatars.

درحال انتظار

پس‌از نصب موفقیت‌آمیز، فعال‌سازی کارگر سرویس به‌روزشده تا زمانی که کارگر سرویس موجود دیگر مشتریان را کنترل نکند، به تأخیر می‌افتد. این حالت «انتظار» نامیده می‌شود و روشی است که مرورگر اطمینان حاصل می‌کند که فقط یک نسخه از سرویس‌کار شما در هر زمان اجرا می‌شود.

اگر نسخه نمایشی به‌روزشده را اجرا کرده باشید، همچنان باید تصویر گربه را ببینید، زیرا کارگر V2 هنوز فعال نشده است. می‌توانید کارگر سرویس جدید را درحال انتظار در برگه «برنامه» DevTools ببینید:

DevTools درحال نمایش انتظار برای کارمند خدمات جدید

حتی اگر فقط یک برگه برای نسخه نمایشی باز کرده باشید، بازآوری صفحه برای اینکه نسخه جدید جایگزین شود کافی نیست. این به‌دلیل نحوه عملکرد پیمایش‌های مرورگر است. وقتی پیمایش می‌کنید، صفحه فعلی تا زمانی که سرایندهای پاسخ دریافت نشوند ازبین نمی‌رود، و حتی در آن صورت هم اگر پاسخ دارای سرایند Content-Disposition باشد، صفحه فعلی ممکن است باقی بماند. به‌دلیل این هم‌پوشانی، عامل خدماتی فعلی همیشه درطول بازآوری، مشتری را کنترل می‌کند.

برای دریافت به‌روزرسانی، همه برگه‌هایی را که از کارگر سرویس فعلی استفاده می‌کنند ببندید یا از آن‌ها خارج شوید. سپس، وقتی دوباره به نسخه نمایشی پیمایش می‌کنید، باید اسب را ببینید.

این الگو مشابه نحوه به‌روزرسانی Chrome است. به‌روزرسانی‌های Chrome در پس‌زمینه بارگیری می‌شوند، اما تا زمانی که Chrome بازراه‌اندازی نشود اعمال نمی‌شوند. در این مدت، می‌توانید همچنان بدون وقفه از نسخه فعلی استفاده کنید. بااین‌حال، این کار درطول توسعه دردسرساز است، اما DevTools روش‌هایی برای آسان‌تر کردن آن دارد که بعداً در این مقاله به آن‌ها خواهم پرداخت.

فعال کردن

این رویداد زمانی فعال می‌شود که کارگر سرویس قدیمی ازبین رفته باشد و کارگر سرویس جدید بتواند مشتریان را کنترل کند. این زمان ایده‌آلی برای انجام کارهایی است که نمی‌توانستید درحین استفاده از کارگر قدیمی انجام دهید، مانند انتقال پایگاه‌های داده و پاک کردن حافظه‌های پنهان.

در نسخه نمایشی بالا، فهرستی از حافظه‌های پنهان را که انتظار دارم وجود داشته باشند نگه می‌دارم و در رویداد activate از شر بقیه خلاص می‌شوم که حافظه پنهان قدیمی static-v1 را حذف می‌کند.

اگر قولی را به event.waitUntil() منتقل کنید، رویدادهای عملکردی (fetch، push، sync، و غیره) را تا زمانی که قول حل شود بافر می‌کند. بنابراین وقتی رویداد fetch شما فعال می‌شود، فعال‌سازی کاملاً تکمیل شده است.

رد شدن از مرحله انتظار

فاز انتظار به این معنی است که شما فقط یک نسخه از سایت خود را در یک زمان اجرا می‌کنید، اما اگر به این ویژگی نیاز ندارید، می‌توانید با فراخوانی self.skipWaiting()، سرویس‌کار جدید خود را زودتر فعال کنید.

این کار باعث می‌شود عامل خدماتی شما عامل فعال فعلی را بیرون کند و به‌محض ورود به مرحله انتظار (یا بلافاصله اگر ازقبل در مرحله انتظار باشد) خودش را فعال کند. این کار باعث نمی‌شود کارگر شما از نصب صرف‌نظر کند، فقط منتظر می‌ماند.

واقعاً مهم نیست چه زمانی با skipWaiting() تماس می‌گیرید، به‌شرطی که درطول انتظار یا قبل‌از آن باشد. فراخوانی آن در رویداد install بسیار رایج است:

self.addEventListener('install', event => {
  self.skipWaiting();

  event.waitUntil(
    // caching etc
  );
});

اما ممکن است بخواهید آن را به‌عنوان نتیجه postMessage() به کارگر خدمات فراخوانی کنید. مثلاً می‌خواهید skipWaiting() را پس‌از تعامل کاربر انجام دهید.

این نسخه نمایشی از skipWaiting() استفاده می‌کند. باید تصویر گاو را بدون نیاز به خروج از صفحه ببینید. مانند clients.claim() این یک مسابقه است، بنابراین شما فقط در صورتی گاو را خواهید دید که عامل خدماتی جدید قبل از اینکه صفحه تلاش کند تصویر را بارگیری کند، واکشی، نصب و فعال شود.

به‌روزرسانی‌های دستی

همان‌طور که قبلاً اشاره کردم، مرورگر پس‌از پیمایش‌ها و رویدادهای عملکردی به‌طور خودکار به‌روزرسانی‌ها را بررسی می‌کند، اما می‌توانید آن‌ها را به‌صورت دستی نیز راه‌اندازی کنید:

navigator.serviceWorker.register('/sw.js').then(reg => {
  // sometime later…
  reg.update();
});

اگر انتظار دارید کاربر برای مدت طولانی بدون بار کردن مجدد از سایت شما استفاده کند، ممکن است بخواهید update() را در فواصل زمانی (مثلاً ساعتی) فراخوانی کنید.

از تغییر دادن نشانی وب اسکریپت کارگر سرویس خودداری کنید

اگر پست من درباره روال‌های مطلوب ذخیره مؤقت را خوانده باشید، ممکن است بخواهید به هر نسخه از کارگر سرویس خود یک نشانی وب منحصربه‌فرد اختصاص دهید. این کار را نکنید! این معمولاً برای کارگران خدمات بد است، فقط اسکریپت را در مکان فعلی آن به‌روز کنید.

این کار می‌تواند شما را با مشکلی مثل این مواجه کند:

  1. ‫index.html‏ sw-v1.js را به‌عنوان کارگر خدماتی ثبت می‌کند.
  2. sw-v1.js index.html را ذخیره و ارائه می‌کند تا در حالت آفلاین-اول کار کند.
  3. index.html را به‌روز می‌کنید تا sw-v2.js جدید و درخشانتان را ثبت کند.

اگر این کار را انجام دهید، کاربر هرگز sw-v2.js را دریافت نمی‌کند، زیرا sw-v1.js نسخه قدیمی index.html را از حافظه نهان خود ارائه می‌دهد. خودتان را در موقعیتی قرار داده‌اید که برای به‌روزرسانی کارگر خدماتی‌تان باید کارگر خدماتی‌تان را به‌روزرسانی کنید. ایش.

اما برای نمونه نمایشی بالا، نشانی وب سرویس‌کار را تغییر داده‌ام. این کار برای این است که بتوانید برای نسخه نمایشی بین نسخه‌ها جابه‌جا شوید. این چیزی نیست که من در تولید انجام دهم.

توسعه را آسان می‌کنیم

چرخه حیات عامل خدماتی با درنظر گرفتن کاربر ساخته شده است، اما درطول توسعه کمی دردسرساز است. خوشبختانه چند ابزار برای کمک وجود دارد:

به‌روزرسانی هنگام بار کردن مجدد

این یکی موردعلاقه من است.

DevTools «به‌روزرسانی هنگام بار کردن مجدد» را نشان می‌دهد

این کار چرخه حیات را تغییر می‌دهد تا توسعه‌دهنده‌پسند شود. هر پیمایش:

  1. سرویس‌کار را دوباره واکشی کنید.
  2. آن را به‌عنوان نسخه جدید نصب کنید، حتی اگر ازنظر بایت یکسان باشد، یعنی رویداد install شما اجرا می‌شود و حافظه‌های پنهان شما به‌روزرسانی می‌شوند.
  3. از مرحله انتظار رد شوید تا عامل خدماتی جدید فعال شود.
  4. در صفحه پیمایش کنید.

این یعنی به‌روزرسانی‌هایتان را در هر پیمایش (ازجمله بازآوری) بدون نیاز به بار کردن مجدد یا بستن برگه دریافت خواهید کرد.

رد شدن از انتظار

DevTools «رد شدن از انتظار» را نشان می‌دهد

اگر کارگری درحال انتظار دارید، می‌توانید در DevTools روی «رد شدن از انتظار» ضربه بزنید تا فوراً آن را به «فعال» ارتقا دهید.

Shift-reload

اگر صفحه را به‌اجبار مجدداً بار کنید (shift-reload)، به‌طور کامل از سرویس‌کار عبور می‌کند. این حساب کنترل‌نشده خواهد بود. این ویژگی در مشخصات وجود دارد، بنابراین در سایر مرورگرهای پشتیبانی‌کننده از service-worker کار می‌کند.

درحال رسیدگی به به‌روزرسانی‌ها

سرویس‌کار به‌عنوان بخشی از وب توسعه‌پذیر طراحی شده است. ایده این است که ما، به‌عنوان توسعه‌دهندگان مرورگر، تصدیق می‌کنیم که در توسعه وب بهتر از توسعه‌دهندگان وب نیستیم. بنابراین، نباید میاناهای برنامه‌سازی کاربردی سطح بالای محدودی ارائه دهیم که مشکل خاصی را بااستفاده از الگوهایی که ما می‌پسندیم حل می‌کنند، بلکه باید به شما اجازه دهیم به بخش‌های داخلی مرورگر دسترسی داشته باشید و کارتان را به روشی که می‌خواهید و به بهترین شکل برای کاربران شما کار می‌کند انجام دهید.

بنابراین، برای فعال کردن الگوهای بیشتر، کل چرخه به‌روزرسانی قابل‌مشاهده است:

navigator.serviceWorker.register('/sw.js').then(reg => {
  reg.installing; // the installing worker, or undefined
  reg.waiting; // the waiting worker, or undefined
  reg.active; // the active worker, or undefined

  reg.addEventListener('updatefound', () => {
    // A wild service worker has appeared in reg.installing!
    const newWorker = reg.installing;

    newWorker.state;
    // "installing" - the install event has fired, but not yet complete
    // "installed"  - install complete
    // "activating" - the activate event has fired, but not yet complete
    // "activated"  - fully active
    // "redundant"  - discarded. Either failed install, or it's been
    //                replaced by a newer version

    newWorker.addEventListener('statechange', () => {
      // newWorker.state has changed
    });
  });
});

navigator.serviceWorker.addEventListener('controllerchange', () => {
  // This fires when the service worker controlling this page
  // changes, eg a new worker has skipped waiting and become
  // the new active worker.
});

چرخه حیات همیشه ادامه دارد

همان‌طور که می‌بینید، درک چرخه حیات کارگر سرویس ارزشمند است و با این درک، رفتارهای کارگر سرویس باید منطقی‌تر و کمتر مرموز به‌نظر برسند. این دانش به شما اعتمادبه‌نفس بیشتری در هنگام استقرار و به‌روزرسانی Service Worker می‌دهد.