Workbox: हाई-लेवल सर्विस वर्कर टूलकिट

भरोसेमंद वेब ऐप्लिकेशन बनाने में दो एपीआई अहम भूमिका निभाते हैं: सर्विस वर्कर और कैश मेमोरी. हालांकि, इनका असरदार तरीके से इस्तेमाल करना एक चुनौती हो सकती है. ऐसा इसलिए, क्योंकि हो सकता है कि आपको बग या अन्य समस्याओं का सामना करना पड़े. उदाहरण के लिए, आपके सर्विस वर्कर कोड में गड़बड़ियों की वजह से, कैश मेमोरी में सेव करने से जुड़ी समस्याएं हो सकती हैं. उपयोगकर्ताओं को पुराना कॉन्टेंट या काम न करने वाले लिंक दिख सकते हैं.

Workbox एक हाई-लेवल सर्विस वर्कर टूलकिट है. इसे सर्विस वर्कर और कैश मेमोरी स्टोरेज एपीआई के ऊपर बनाया गया है. यह वेब ऐप्लिकेशन में ऑफ़लाइन सहायता जोड़ने के लिए, प्रोडक्शन के लिए तैयार लाइब्रेरी का सेट उपलब्ध कराता है. टूलकिट को दो कलेक्शन में बांटा गया है: ऐसे टूल जो आपके सर्विस वर्कर में चलने वाले कोड को मैनेज करने में मदद करते हैं और ऐसे टूल जो आपकी बिल्ड प्रोसेस के साथ इंटिग्रेट होते हैं.

रनटाइम कोड

यह कोड, आपकी सर्विस वर्कर स्क्रिप्ट में चलता है. साथ ही, यह कंट्रोल करता है कि यह आउटगोइंग अनुरोधों को कैसे इंटरसेप्ट करता है और कैश मेमोरी स्टोरेज एपीआई के साथ कैसे इंटरैक्ट करता है. Workbox में कुल मिलाकर करीब एक दर्जन लाइब्रेरी मॉड्यूल हैं. इनमें से हर मॉड्यूल, इस्तेमाल के अलग-अलग मामलों को हैंडल करता है. सबसे अहम मॉड्यूल यह तय करते हैं कि सर्विस वर्कर जवाब देगा या नहीं (इसे रूटिंग कहा जाता है) और वह जवाब कैसे देगा (इसे कैश मेमोरी में सेव करने की रणनीति कहा जाता है).

इंटिग्रेशन बनाएं

Workbox में कमांड लाइन, Node.js मॉड्यूल, और webpack प्लग इन टूल उपलब्ध हैं. इनकी मदद से, दो काम अलग-अलग तरीकों से किए जा सकते हैं:

  • कॉन्फ़िगरेशन के विकल्पों के सेट के आधार पर, सर्विस वर्कर स्क्रिप्ट बनाएं. जनरेट किया गया सर्विस वर्कर, Workbox की रनटाइम लाइब्रेरी का इस्तेमाल करता है. "अंडर द हुड" का इस्तेमाल करके, कॉन्फ़िगर की गई कैश मेमोरी की रणनीतियों को लागू किया जा सकता है.
  • उन यूआरएल की सूची जनरेट करें जिन्हें "पहले से कैश मेमोरी में सेव" किया जाना चाहिए. यह सूची, कॉन्फ़िगर किए जा सकने वाले पैटर्न के आधार पर जनरेट की जाती है. इन पैटर्न में, बिल्ड प्रोसेस के दौरान जनरेट की गई फ़ाइलों को शामिल किया जाता है और बाहर रखा जाता है.

आपको Workbox का इस्तेमाल क्यों करना चाहिए?

सर्विस वर्कर बनाते समय Workbox का इस्तेमाल करना ज़रूरी नहीं है. ऐसी कई गाइड मौजूद हैं जो "वैनिला" सर्विस वर्कर के नज़रिए से, कैश मेमोरी में सेव करने की सामान्य रणनीतियों के बारे में बताती हैं. अगर आपको Workbox का इस्तेमाल करना है, तो यहां इसके कुछ फ़ायदे बताए गए हैं.

कैश मेमोरी मैनेज करना

Workbox आपके लिए कैश मेमोरी के अपडेट मैनेज करता है. इसके लिए, वह प्रीकैशिंग का इस्तेमाल करते समय आपके बिल्ड प्रोसेस से जुड़ जाता है या रनटाइम कैश मेमोरी का इस्तेमाल करते समय, कॉन्फ़िगर की जा सकने वाली साइज़/उम्र की नीतियों का इस्तेमाल करता है. Cache Storage API काफ़ी असरदार है, लेकिन इसमें कैश मेमोरी की समयसीमा खत्म होने की सुविधा पहले से मौजूद नहीं होती. Workbox जैसे टूल इस कमी को पूरा करते हैं.

ज़्यादा लॉगिंग और गड़बड़ी की रिपोर्टिंग

सर्विस वर्कर का इस्तेमाल शुरू करते समय, यह पता लगाना मुश्किल होता है कि कोई चीज़ क्यों कैश मेमोरी में सेव की जा रही है या क्यों कैश मेमोरी में सेव नहीं की जा रही है. Workbox अपने-आप पता लगा लेता है कि localhost पर आपकी वेबसाइट का डेवलपमेंट वर्शन कब चल रहा है. साथ ही, यह आपके ब्राउज़र के JavaScript कंसोल में डीबग लॉगिंग की सुविधा चालू कर देता है.

DevTools कंसोल में वर्कबॉक्स लॉगिंग

लॉग मैसेज की मदद से, कॉन्फ़िगरेशन या अमान्य होने से जुड़ी किसी भी समस्या की जड़ तक पहुंचा जा सकता है. ऐसा करने पर, समस्या को अकेले हल करने की तुलना में ज़्यादा तेज़ी से हल किया जा सकता है.

एक ऐसा कोड बेस जिसे टेस्ट किया गया हो और जो अलग-अलग ब्राउज़र पर काम करता हो

Workbox को क्रॉस-ब्राउज़र टेस्ट सुइट के हिसाब से डेवलप किया गया है. साथ ही, जब भी संभव हो, यह उन सुविधाओं के लिए अपने-आप अन्य तरीकों का इस्तेमाल करता है जो कुछ ब्राउज़र में मौजूद नहीं होती हैं.

  • workbox-broadcast-cache-update module उपलब्ध होने पर, Broadcast Channel API का इस्तेमाल करता है. साथ ही, जिन ब्राउज़र पर यह काम नहीं करता उन पर postMessage()-based इंप्लिमेंटेशन का इस्तेमाल करता है.
  • अगर मुमकिन हो, तो workbox-background-sync मॉड्यूल, Background Sync API का इस्तेमाल करता है. अगर ऐसा नहीं होता है, तो सर्विस वर्कर के शुरू होने पर, सूची में मौजूद इवेंट को फिर से भेजने की कोशिश की जाती है.

Workbox का इस्तेमाल कैसे करना चाहिए?

फ़्रेमवर्क इंटिग्रेशन

अगर आपको कोई नया प्रोजेक्ट शुरू करना है, तो कई लोकप्रिय स्टार्टर किट और ऐड-ऑन प्लग इन में मौजूद Workbox इंटिग्रेशन का फ़ायदा लिया जा सकता है:

Workbox को अपनी मौजूदा बिल्ड प्रोसेस में जोड़ना

अगर आपकी साइट के लिए पहले से ही कोई बिल्ड प्रोसेस मौजूद है, तो Workbox का इस्तेमाल शुरू करने के लिए, आपको सही कमांड लाइन, Node.js मॉड्यूल या webpack प्लग इन टूल का इस्तेमाल करना पड़ सकता है.

खास तौर पर, Workbox कमांड लाइन इंटरफ़ेस की मदद से, इसे आसानी से सेट अप और इस्तेमाल किया जा सकता है. इसमें wizard मोड की सुविधा होती है, जो आपके लोकल डेवलपमेंट एनवायरमेंट की जांच करेगी और एक सही डिफ़ॉल्ट कॉन्फ़िगरेशन का सुझाव देगी. इसका इस्तेमाल करके, आगे बढ़ा जा सकता है:

workbox wizard
? What is the root of your web app (i.e. which directory do you deploy)? src/
? Which file types would you like to precache? css, js, html
? Where would you like your service worker file to be saved? build/sw.js
? Where would you like to save these configuration options? workbox-config.js

अपना सर्विस वर्कर बनाने के लिए, बिल्ड प्रोसेस के हिस्से के तौर पर workbox generateSW workbox-config.js चलाएं. ज़्यादा जानकारी के लिए, generateSW दस्तावेज़ देखें. workbox-config.js में बदलाव करके, सर्विस वर्कर को अपनी पसंद के मुताबिक बनाया जा सकता है. ज़्यादा जानकारी के लिए, विकल्पों का दस्तावेज़ देखें.

किसी मौजूदा सर्विस वर्कर में रनटाइम के दौरान Workbox का इस्तेमाल करना

अगर आपके पास पहले से कोई सर्विस वर्कर है और आपको Workbox की रनटाइम लाइब्रेरी आज़मानी हैं, तो Workbox को इसके आधिकारिक सीडीएन से इंपोर्ट करें और रनटाइम कैश मेमोरी के लिए इसका इस्तेमाल तुरंत शुरू करें. इस इस्तेमाल के उदाहरण का मतलब है कि आपको प्रीकैशिंग का फ़ायदा नहीं मिलेगा. इसके लिए, बिल्ड-टाइम इंटिग्रेशन की ज़रूरत होती है. हालांकि, यह प्रोटोटाइप बनाने और कैश मेमोरी में सेव करने की अलग-अलग रणनीतियों को तुरंत आज़माने के लिए बेहतरीन है.

// Replace 3.6.3 with the current version number of Workbox.
importScripts('https://storage.googleapis.com/workbox-cdn/releases/3.6.3/workbox-sw.js');

workbox.routing.registerRoute(
  new RegExp('\.png$'),
  workbox.strategies.cacheFirst({
    cacheName: 'images-cache',
  })
);