Workbox v5 থেকে v6-এ মাইগ্রেট করা

এই গাইডে Workbox v6-এ করা ব্রেকিং পরিবর্তন সম্পর্কে আলোচনা করা হয়েছে এবং Workbox v5 থেকে আপগ্রেড করার সময় আপনাকে কী কী পরিবর্তন করতে হবে তার উদাহরণ দেওয়া হয়েছে।

ব্রেকিং পরিবর্তন

workbox-core

workbox-core-এ skipWaiting() পদ্ধতি আর install হ্যান্ডলারে যোগ করবে না এবং এটি শুধু self.skipWaiting() কল করার সমতুল্য।

এখন থেকে, পরিবর্তে self.skipWaiting() ব্যবহার করুন কারণ Workbox v7 থেকে skipWaiting() সরিয়ে দেওয়া হতে পারে।

workbox-precaching

  • HTTP রিডাইরেক্টের সাথে সম্পর্কিত URL-এর জন্য ক্রস-অরিজিন HTML ডকুমেন্ট আর workbox-precaching-এর সাথে নেভিগেশন অনুরোধ পূরণ করতে ব্যবহার করা যাবে না। এই ধরনের পরিস্থিতি সাধারণত বিরল।
  • প্রদত্ত অনুরোধের জন্য প্রি-ক্যাশে করা উত্তর খোঁজার সময় workbox-precaching এখন fbclid URL কোয়েরি প্যারামিটার উপেক্ষা করে।
  • PrecacheController কনস্ট্রাক্টর এখন স্ট্রিংয়ের পরিবর্তে প্যারামিটার হিসেবে নির্দিষ্ট প্রপার্টি সহ অবজেক্ট নেয়। এই অবজেক্টে নিম্নলিখিত প্রপার্টি কাজ করে: cacheName (v5-এ কনস্ট্রাক্টরে পাস করা স্ট্রিংয়ের মতো একই উদ্দেশ্যে কাজ করে), plugins (v5 থেকে addPlugins() পদ্ধতি পরিবর্তন করে) এবং fallbackToNetwork (v5-এ createHandler() এবং `createHandlerBoundToURL() পদ্ধতিতে পাস করা একই ধরনের বিকল্প পরিবর্তন করে)।
  • PrecacheController-এর install() এবং activate() পদ্ধতিতে এখন ঠিক একটি প্যারামিটার লাগে, যা যথাক্রমে সংশ্লিষ্ট InstallEvent বা ActivateEvent-এ সেট করতে হবে।
  • PrecacheController থেকে addRoute() পদ্ধতি সরিয়ে দেওয়া হয়েছে। এর পরিবর্তে, নতুন PrecacheRoute ক্লাস ব্যবহার করে রুট তৈরি করা যাবে এবং আপনি সেটি রেজিস্টার করতে পারবেন।
  • PrecacheController থেকে precacheAndRoute() পদ্ধতি সরিয়ে দেওয়া হয়েছে। (এটি এখনও workbox-precaching মডিউল দ্বারা এক্সপোর্ট করা একটি স্ট্যাটিক হেল্পার পদ্ধতি হিসাবে বিদ্যমান।) এটি সরিয়ে দেওয়া হয়েছে কারণ এর পরিবর্তে PrecacheRoute ব্যবহার করা যেতে পারে।
  • PrecacheController থেকে createMatchCalback() পদ্ধতি সরিয়ে দেওয়া হয়েছে। পরিবর্তে নতুন PrecacheRoute ব্যবহার করা যেতে পারে।
  • PrecacheController থেকে createHandler() পদ্ধতি সরিয়ে দেওয়া হয়েছে। পরিবর্তে, অনুরোধ ম্যানেজ করার জন্য PrecacheController অবজেক্টের strategy প্রপার্টি ব্যবহার করা যেতে পারে।
  • workbox-precaching মডিউল থেকে createHandler() স্ট্যাটিক এক্সপোর্ট আগেই সরিয়ে দেওয়া হয়েছে। এর পরিবর্তে, ডেভেলপারদের একটি PrecacheController ইনস্ট্যান্স তৈরি করতে হবে এবং এর strategy প্রপার্টি ব্যবহার করতে হবে।
  • precacheAndRoute()-এর সাথে রেজিস্টার করা রুটটি এখন একটি "আসল" রুট যা workbox-routing-এর Router ক্লাস ব্যবহার করে। আপনি registerRoute() এবং precacheAndRoute()-এ ইন্টারলিভ কল করলে, এর ফলে আপনার রুটের মূল্যায়ন ক্রম আলাদা হতে পারে।

workbox-routing

setDefaultHandler() পদ্ধতিতে এখন একটি ঐচ্ছিক দ্বিতীয় প্যারামিটার লাগে যা HTTP পদ্ধতির সাথে সম্পর্কিত, ডিফল্ট হিসেবে 'GET'-এ সেট করা থাকে।

  • আপনি setDefaultHandler() ব্যবহার করলে এবং আপনার সব অনুরোধ GET হলে, কোনও পরিবর্তন করতে হবে না।
  • আপনার কাছে যদি এমন কোনও অনুরোধ থাকে যা GET (POST, PUT, ইত্যাদি...) নয়, setDefaultHandler() আর সেইসব অনুরোধের সাথে ম্যাচ করবে না।

বিল্ড কনফিগারেশন

workbox-build এবং workbox-cli-এ getManifest এবং injectManifest মোডের জন্য mode বিকল্পটি কাজ করার কথা ছিল না এবং এটি সরিয়ে দেওয়া হয়েছে। এটি workbox-webpack-plugin-এর ক্ষেত্রে প্রযোজ্য নয়, যা InjectManifest প্লাগ-ইনে mode-কে সাপোর্ট করে।

বিল্ড টুলের জন্য Node.js v10 বা তার পরবর্তী ভার্সন প্রয়োজন

v10-এর আগের Node.js ভার্সন workbox-webpack-plugin, workbox-build বা workbox-cli-এর জন্য আর কাজ করে না। আপনি v8-এর আগের কোনও Node.js ভার্সন ব্যবহার করলে, রানটাইম আপডেট করে কাজ করে এমন ভার্সন ব্যবহার করুন।

নতুন উন্নতি

workbox-strategies

Workbox v6 থার্ড-পার্টি ডেভেলপারদের জন্য তাদের নিজস্ব Workbox স্ট্র্যাটেজি নির্ধারণ করার একটি নতুন উপায় চালু করেছে। এটি নিশ্চিত করে যে থার্ড-পার্টি ডেভেলপারদের কাছে এমনভাবে Workbox-এর ক্ষমতা বাড়ানোর ক্ষমতা রয়েছে যা তাদের প্রয়োজনগুলি সম্পূর্ণরূপে পূরণ করে।

নতুন স্ট্র্যাটেজি বেস ক্লাস

v6-এ, সব Workbox স্ট্র্যাটেজি ক্লাসকে অবশ্যই নতুন Strategy বেস ক্লাসকে এক্সটেন্ড করতে হবে। এটি যাতে কাজ করে তার জন্য সব বিল্ট-ইন স্ট্র্যাটেজি আবার লেখা হয়েছে।

Strategy মূল ক্লাস দুটি প্রাথমিক বিষয়ের জন্য দায়ী:

  • সব স্ট্র্যাটেজি হ্যান্ডলারের জন্য সাধারণ প্লাগ-ইন লাইফসাইকেল কলব্যাক ইনভোক করা (যেমন, সেগুলি কখন শুরু, উত্তর ও শেষ হয়)।
  • "হ্যান্ডলার" ইনস্ট্যান্স তৈরি করা, যা প্রতিটি স্বতন্ত্র অনুরোধের জন্য স্টেট ম্যানেজ করতে পারে যা একটি স্ট্র্যাটেজি ম্যানেজ করছে।

নতুন "হ্যান্ডলার" ক্লাস

আমাদের আগে ইন্টার্নাল মডিউল কল fetchWrapper এবং cacheWrapper ছিল, যা (তাদের নাম থেকে বোঝা যায়) বিভিন্ন ফেচ এবং ক্যাশে API-কে তাদের লাইফসাইকেলে হুক সহ র‍্যাপ করে। এটি এমন একটি মেকানিজম যা বর্তমানে প্লাগ-ইনকে কাজ করার অনুমতি দেয়, তবে এটি ডেভেলপারদের কাছে প্রকাশ করা হয় না।

নতুন "হ্যান্ডলার" ক্লাস, StrategyHandler, এই পদ্ধতিগুলি প্রকাশ করবে যাতে কাস্টম স্ট্র্যাটেজিগুলি fetch() বা cacheMatch() কল করতে পারে এবং স্ট্র্যাটেজি ইনস্ট্যান্সে যোগ করা যেকোনও প্লাগইন অটোমেটিক চালু করতে পারে।

এই ক্লাস ডেভেলপারদের নিজস্ব কাস্টম, লাইফসাইকেল কলব্যাক যোগ করার সুবিধা দেয় যা তাদের স্ট্র্যাটেজির জন্য নির্দিষ্ট হতে পারে এবং সেগুলি বর্তমান প্লাগ-ইন ইন্টারফেসের সাথে "ঠিকঠাক কাজ করবে"।

নতুন প্লাগ-ইন লাইফসাইকেল স্ট্যাটাস

Workbox v5-এ প্লাগ-ইন স্টেটলেস। এর অর্থ হল, /index.html-এর জন্য কোনও অনুরোধ যদি requestWillFetch এবং cachedResponseWillBeUsed কলব্যাক, দুটিকেই ট্রিগার করে, তাহলে সেই দুটি কলব্যাকের একে অপরের সাথে যোগাযোগ করার বা এমনকি একই অনুরোধের মাধ্যমে যে সেগুলি ট্রিগার হয়েছে তা জানার কোনও উপায় নেই।

v6-এ, সব প্লাগ-ইন কলব্যাকেও একটি নতুন state অবজেক্ট পাস করা হবে। এই স্টেট অবজেক্টটি এই নির্দিষ্ট প্লাগ-ইন অবজেক্ট এবং এই নির্দিষ্ট স্ট্র্যাটেজি ইনভোকেশনের (অর্থাৎ handle()-এ কল) জন্য অনন্য হবে। এটি ডেভেলপারদের এমন প্লাগ-ইন লিখতে দেয় যেখানে একটি কলব্যাক একই প্লাগ-ইনের অন্য কলব্যাক যা করেছে তার উপর ভিত্তি করে শর্তসাপেক্ষে কিছু করতে পারে (যেমন requestWillFetch এবং fetchDidSucceed বা fetchDidFail চালানোর মধ্যে টাইম ডেল্টা গণনা করা)।

নতুন প্লাগ-ইন লাইফসাইকেল কলব্যাক

ডেভেলপারদের প্লাগ-ইন লাইফসাইকেল স্টেট সম্পূর্ণভাবে ব্যবহার করার অনুমতি দিতে নতুন প্লাগ-ইন লাইফসাইকেল কলব্যাক যোগ করা হয়েছে:

  • handlerWillStart: কোনও হ্যান্ডলার লজিক রান করা শুরু হওয়ার আগে কল করা হয়েছে। এই কলব্যাকটি প্রাথমিক হ্যান্ডলার স্টেট সেট করতে ব্যবহার করা যেতে পারে (যেমন, শুরুর সময় রেকর্ড করা)।
  • handlerWillRespond: strategies handle() মেথড উত্তর দেওয়ার আগে কল করা হয়েছে। কোনও রুট হ্যান্ডলার বা অন্যান্য কাস্টম লজিকে ফেরত দেওয়ার আগে সেই উত্তরটি পরিবর্তন করতে এই কলব্যাক ব্যবহার করা যেতে পারে।
  • handlerDidRespond: স্ট্র্যাটেজির handle() পদ্ধতি কোনও উত্তর দেওয়ার পরে কল করা হয়। এই কলব্যাকটি যেকোনও চূড়ান্ত উত্তরের বিবরণ রেকর্ড করতে ব্যবহার করা যেতে পারে, যেমন অন্যান্য প্লাগ-ইন দ্বারা করা পরিবর্তনের পরে।
  • handlerDidComplete: এই স্ট্র্যাটেজি ইনভোক করার মাধ্যমে ইভেন্টে যোগ করা সব লাইফটাইম প্রমিস এক্সটেন্ড করুন সেটেল হওয়ার পরে কল করা হয়েছে। এই কলব্যাকটি এমন যেকোনও ডেটার রিপোর্ট করতে ব্যবহার করা যেতে পারে যা গণনা করার জন্য হ্যান্ডলারের কাজ শেষ না হওয়া পর্যন্ত অপেক্ষা করতে হবে (যেমন ক্যাশে হিট স্ট্যাটাস, ক্যাশে লেটেন্সি, নেটওয়ার্ক লেটেন্সি)।
  • handlerDidError: হ্যান্ডলার কোনও সোর্স থেকে সঠিক উত্তর দিতে না পারলে কল করা হয়। নেটওয়ার্কের সমস্যার বিকল্প হিসেবে "ফলব্যাক" কন্টেন্ট প্রদান করতে এই কলব্যাক ব্যবহার করা যেতে পারে।

যেসব ডেভেলপার নিজস্ব কাস্টম স্ট্র্যাটেজি প্রয়োগ করেন তাদের এইসব কলব্যাক ইনভোক করার ব্যাপারে চিন্তা করতে হবে না; এগুলি সবই নতুন Strategy বেস ক্লাস ম্যানেজ করে।

হ্যান্ডলারের জন্য আরও নির্ভুল TypeScript টাইপ

বিভিন্ন কলব্যাক পদ্ধতির জন্য TypeScript সংজ্ঞা স্বাভাবিক করা হয়েছে। এর ফলে, যেসব ডেভেলপার TypeScript ব্যবহার করেন এবং হ্যান্ডলার প্রয়োগ বা কল করার জন্য নিজস্ব কোড লেখেন, তারা আরও ভালো অভিজ্ঞতা পাবেন।

workbox-window

নতুন messageSkipWaiting() পদ্ধতি

"অপেক্ষারত" সার্ভিস ওয়ার্কারকে অ্যাক্টিভেট করার প্রসেস সহজ করতে, workbox-window মডিউলে একটি নতুন পদ্ধতি, messageSkipWaiting(), যোগ করা হয়েছে। এটি কিছু উন্নতি অফার করে:

  • এটি ডি ফ্যাক্টো স্ট্যান্ডার্ড মেসেজের বিষয়বস্তু, {type: 'SKIP_WAITING'} সহ postMessage()-কে কল করে, যা Workbox-এর মাধ্যমে তৈরি করা কোনও সার্ভিস ওয়ার্কার skipWaiting() ট্রিগার করার জন্য চেক করে।
  • এই মেসেজ পোস্ট করার জন্য এটি সঠিক "অপেক্ষারত" সার্ভিস ওয়ার্কার বেছে নেয়, এমনকি এটি workbox-window-এর সাথে রেজিস্টার করা সার্ভিস ওয়ার্কার না হলেও।

isExternal প্রপার্টির জন্য "এক্সটার্নাল" ইভেন্ট সরিয়ে দেওয়া

workbox-window-এ সব "এক্সটার্নাল" ইভেন্ট সরিয়ে দিয়ে "সাধারণ" ইভেন্ট যোগ করা হয়েছে, যার isExternal প্রপার্টি true-এ সেট করা আছে। এর ফলে, যেসব ডেভেলপার পার্থক্য সম্পর্কে জানতে চান তারা এখনও এটি শনাক্ত করতে পারবেন এবং যেসব ডেভেলপারের জানার প্রয়োজন নেই তারা প্রপার্টি উপেক্ষা করতে পারবেন।

আরও পরিষ্কার "ব্যবহারকারীদের জন্য পৃষ্ঠা রিলোড করার অফার" রেসিপি

উপরের দুটি পরিবর্তনের জন্য ধন্যবাদ, "ব্যবহারকারীদের জন্য পৃষ্ঠা রিলোড করার অফার" রেসিপিটি সরল করা যেতে পারে:

// v6:
<script type="module">
  import {Workbox} from 'https://storage.googleapis.com/workbox-cdn/releases/6.0.0-alpha.1/workbox-window.prod.mjs';

  if ('serviceWorker' in navigator) {
    const wb = new Workbox('/sw.js');

    const showSkipWaitingPrompt = () => {
      // This assumes a hypothetical createUIPrompt() method with
      // onAccept and onReject callbacks:
      const prompt = createUIPrompt({
        onAccept: () => {
          wb.addEventListener('controlling', () => {
            window.location.reload();
          });

          // This will postMessage() to the waiting service worker.
          wb.messageSkipWaiting();
        },

        onReject: () => {
          prompt.dismiss();
        },
      });
    };

    // Listening for externalwaiting is no longer needed.
    wb.addEventListener('waiting', showSkipWaitingPrompt);
    wb.register();
  }
</script>

workbox-routing

workbox-routing-এ ব্যবহৃত matchCallback ফাংশনে একটি নতুন বুলিয়ান প্যারামিটার, sameOrigin, পাস করা হয়েছে। অনুরোধটি একই-উৎসের URL-এর জন্য হলে এটি true-এ সেট করা হয় এবং অন্যথায় মিথ্যা।

এটি কিছু সাধারণ বয়লারপ্লেটকে সহজ করে তোলে:

// In v5:
registerRoute(
  ({url}) =>
    url.origin === self.location.origin && url.pathname.endsWith('.png'),
  new StaleWhileRevalidate({cacheName: 'local-png'})
);

// In v6:
registerRoute(
  ({sameOrigin, url}) => sameOrigin && url.pathname.endsWith('.png'),
  new StaleWhileRevalidate({cacheName: 'local-png'})
);

workbox-expiration-এ matchOptions

আপনি এখন workbox-expiration-এ matchOptions সেট করতে পারবেন, যা পরে cache.delete() কলের জন্য CacheQueryOptions হিসেবে পাস করা হবে। (বেশিরভাগ ডেভেলপারকে এটি করতে হবে না।)

workbox-precaching

workbox-strategies ব্যবহার করে

workbox-strategies-কে বেস হিসেবে ব্যবহার করার জন্য workbox-precaching আবার লেখা হয়েছে। এর ফলে কোনও ব্রেকিং পরিবর্তন হওয়া উচিত নয় এবং দুটি মডিউল কীভাবে নেটওয়ার্ক ও ক্যাশে অ্যাক্সেস করে তার মধ্যে দীর্ঘমেয়াদী সামঞ্জস্য বজায় থাকা উচিত।

প্রি-ক্যাশিং এখন এক এক করে এন্ট্রি প্রসেস করে, বাল্ক হিসেবে নয়

workbox-precaching আপডেট করা হয়েছে যাতে প্রিক্যাশে ম্যানিফেস্টে একবারে শুধু একটি এন্ট্রি অনুরোধ ও ক্যাশে করা হয়, সবকটি একসাথে অনুরোধ ও ক্যাশে করার চেষ্টা করার পরিবর্তে (কীভাবে থ্রটল করতে হবে তা ব্রাউজারকে বুঝতে দেওয়া হয়)।

এটি প্রি-ক্যাশিং করার সময় net::ERR_INSUFFICIENT_RESOURCES সমস্যার সম্ভাবনা কমাবে এবং প্রি-ক্যাশিং ও ওয়েব অ্যাপের মাধ্যমে একই সাথে করা অনুরোধের মধ্যে ব্যান্ডউইথ সংক্রান্ত সমস্যাও কমাবে।

PrecacheFallbackPlugin আরও সহজে অফলাইন ফলব্যাক করার সুবিধা দেয়

workbox-precaching-এ এখন PrecacheFallbackPlugin অন্তর্ভুক্ত আছে, যা v6-এ যোগ করা নতুন handlerDidError লাইফসাইকেল পদ্ধতি প্রয়োগ করে।

এর ফলে, কোনও রেসপন্স উপলভ্য না থাকলে, প্রদত্ত স্ট্র্যাটেজির জন্য "ফলব্যাক" হিসেবে প্রি-ক্যাশে করা URL নির্দিষ্ট করা সহজ হয়। প্রি-ক্যাশে করা URL-এর জন্য সঠিক ক্যাশে কী তৈরি করার কাজটি প্লাগ-ইন করবে, এর মধ্যে প্রয়োজনীয় যেকোনও রিভিশন প্যারামিটারও অন্তর্ভুক্ত।

NetworkOnly স্ট্র্যাটেজি কোনও নেভিগেশন অনুরোধের জন্য উত্তর জেনারেট করতে না পারলে, প্রি-ক্যাশ করা /offline.html-এর মাধ্যমে উত্তর দেওয়ার জন্য এটি ব্যবহার করার একটি স্যাম্পেল এখানে দেওয়া হল—অন্য কথায়, একটি কাস্টম অফলাইন HTML পৃষ্ঠা দেখানো:

import {PrecacheFallbackPlugin, precacheAndRoute} from 'workbox-precaching';
import {registerRoute} from 'workbox-routing';
import {NetworkOnly} from 'workbox-strategies';

// Ensure that /offline.html is part of your precache manifest!
precacheAndRoute(self.__WB_MANIFEST);

registerRoute(
  ({request}) => request.mode === 'navigate',
  new NetworkOnly({
    plugins: [
      new PrecacheFallbackPlugin({
        fallbackURL: '/offline.html',
      }),
    ],
  })
);

রানটাইম ক্যাশিংয়ে precacheFallback

আপনি যদি নিজের হাতে সার্ভিস ওয়ার্কার লেখার পরিবর্তে আপনার জন্য সার্ভিস ওয়ার্কার তৈরি করতে generateSW ব্যবহার করেন, তাহলে একই কাজ সম্পন্ন করতে আপনি runtimeCaching-এ নতুন precacheFallback কনফিগারেশন বিকল্প ব্যবহার করতে পারেন:

{
  // ... other generateSW config options...
  runtimeCaching: [{
    urlPattern: ({request}) => request.mode === 'navigate',
    handler: 'NetworkOnly',
    options: {
      precacheFallback: {
        // This URL needs to be included in your precache manifest.
        fallbackURL: '/offline.html',
      },
    },
  }],
}

সহায়তা পাওয়া

আমরা আশা করি যে বেশিরভাগ মাইগ্রেশন সহজ হবে। এই গাইডে উল্লেখ করা নেই এমন কোনও সমস্যার সম্মুখীন হলে, GitHub-এ সমস্যাটি উল্লেখ করে আমাদের জানান।