ทดสอบการสิ้นสุดการทำงานของ Service Worker ด้วย Puppeteer

คู่มือนี้อธิบายวิธีสร้างส่วนขยายที่มีประสิทธิภาพยิ่งขึ้นด้วยการทดสอบการสิ้นสุดการทำงานของบริการโดยใช้ Puppeteer การเตรียมตัวให้พร้อมรับมือกับการสิ้นสุดการใช้งานได้ทุกเมื่อนั้นถือเป็นสิ่งสำคัญ เนื่องจากกรณีนี้อาจเกิดขึ้นได้โดยไม่มีคำเตือน ส่งผลให้เกิดความไม่ต่อเนื่องใดๆ ในโปรแกรมทำงานของบริการสูญหายไป ดังนั้น ส่วนขยายต้องบันทึกสถานะที่สำคัญและจัดการคำขอได้ทันทีที่เริ่มทำงานอีกครั้งเมื่อมีเหตุการณ์ที่ต้องจัดการ

ก่อนจะเริ่ม

โคลนหรือดาวน์โหลดที่เก็บ chrome-extensions-sample เราจะใช้ส่วนขยายทดสอบใน /functional-samples/tutorial.terminate-sw/test-extension ซึ่งจะส่งข้อความไปยัง Service Worker ทุกครั้งที่มีการคลิกปุ่มและเพิ่มข้อความลงในหน้าหากได้รับการตอบกลับ

นอกจากนี้คุณจะต้องติดตั้ง Node.JS ซึ่งเป็นรันไทม์ที่ Puppeteer สร้างขึ้น

ขั้นตอนที่ 1: เริ่มโปรเจ็กต์ Node.js

สร้างไฟล์ต่อไปนี้ในไดเรกทอรีใหม่ พวกเขาร่วมกันสร้างโปรเจ็กต์ Node.js ใหม่และจัดเตรียมโครงสร้างพื้นฐานของชุดการทดสอบ Puppeteer โดยใช้ Jest เป็นตัวดำเนินการทดสอบ ดูรายละเอียดเพิ่มเติมเกี่ยวกับการตั้งค่านี้ได้ที่ทดสอบส่วนขยาย Chrome ด้วย Puppeteer

package.json:

{
  "name": "puppeteer-demo",
  "version": "1.0",
  "dependencies": {
    "jest": "^29.7.0",
    "puppeteer": "^22.1.0"
  },
  "scripts": {
    "start": "jest ."
  },
  "devDependencies": {
    "@jest/globals": "^29.7.0"
  }
}

index.test.js:

const puppeteer = require('puppeteer');

const SAMPLES_REPO_PATH = 'PATH_TO_SAMPLES_REPOSITORY';
const EXTENSION_PATH = `${SAMPLES_REPO_PATH}/functional-samples/tutorial.terminate-sw/test-extension`;
const EXTENSION_ID = 'gjgkofgpcmpfpggbgjgdfaaifcmoklbl';

let browser;

beforeEach(async () => {
  browser = await puppeteer.launch({
    // Set to 'new' to hide Chrome if running as part of an automated build.
    headless: false,
    args: [
      `--disable-extensions-except=${EXTENSION_PATH}`,
      `--load-extension=${EXTENSION_PATH}`
    ]
  });
});

afterEach(async () => {
  await browser.close();
  browser = undefined;
});

โปรดทราบว่าการทดสอบของเราโหลด test-extension จากที่เก็บตัวอย่าง ตัวแฮนเดิลสำหรับ chrome.runtime.onMessage ต้องใช้สถานะที่ตั้งค่าไว้ในเครื่องจัดการสำหรับเหตุการณ์ chrome.runtime.onInstalled ด้วยเหตุนี้ เนื้อหาของ data จะหายไปเมื่อ Service Worker สิ้นสุดลงและการตอบกลับข้อความในอนาคตจะไม่สำเร็จ เราจะแก้ไขปัญหานี้หลังจากเขียนการทดสอบ

service-worker-broken.js:

let data;

chrome.runtime.onInstalled.addListener(() => {
  data = { version: chrome.runtime.getManifest().version };
});

chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
  sendResponse(data.version);
});

ขั้นตอนที่ 2: ติดตั้งการอ้างอิง

เรียกใช้ npm install เพื่อติดตั้งทรัพยากร Dependency ที่จำเป็น

ขั้นที่ 3: เขียนการทดสอบเบื้องต้น

เพิ่มการทดสอบต่อไปนี้ที่ด้านล่างของ index.test.js ซึ่งจะเปิดหน้าทดสอบจากส่วนขยายทดสอบของเรา คลิกองค์ประกอบปุ่ม และรอการตอบกลับจากโปรแกรมทำงานของบริการ

test('can message service worker', async () => {
  const page = await browser.newPage();
  await page.goto(`chrome-extension://${EXTENSION_ID}/page.html`);

  // Message without terminating service worker
  await page.click('button');
  await page.waitForSelector('#response-0');
});

คุณสามารถทำการทดสอบด้วย npm start ได้ ซึ่งระบบควรจะเห็นว่าการทดสอบเสร็จสมบูรณ์แล้ว

ขั้นตอนที่ 4: สิ้นสุด Service Worker

เพิ่มฟังก์ชันตัวช่วยต่อไปนี้ซึ่งจะยุติการทำงานของ Service Worker

/**
 * Stops the service worker associated with a given extension ID. This is done
 * by creating a new Chrome DevTools Protocol session, finding the target ID
 * associated with the worker and running the Target.closeTarget command.
 *
 * @param {Page} browser Browser instance
 * @param {string} extensionId Extension ID of worker to terminate
 */
async function stopServiceWorker(browser, extensionId) {
  const host = `chrome-extension://${extensionId}`;

  const target = await browser.waitForTarget((t) => {
    return t.type() === 'service_worker' && t.url().startsWith(host);
  });

  const worker = await target.worker();
  await worker.close();
}

สุดท้าย ให้อัปเดตการทดสอบด้วยโค้ดต่อไปนี้ จากนั้นให้สิ้นสุด Service Worker แล้วคลิกปุ่มดังกล่าวอีกครั้งเพื่อตรวจสอบว่าคุณได้รับการตอบกลับหรือไม่

test('can message service worker when terminated', async () => {
  const page = await browser.newPage();
  await page.goto(`chrome-extension://${EXTENSION_ID}/page.html`);

  // Message without terminating service worker
  await page.click('button');
  await page.waitForSelector('#response-0');

  // Terminate service worker
  await stopServiceWorker(page, EXTENSION_ID);

  // Try to send another message
  await page.click('button');
  await page.waitForSelector('#response-1');
});

ขั้นตอนที่ 5: ทำการทดสอบ

เรียกใช้ npm start การทดสอบควรล้มเหลวซึ่งบ่งชี้ว่า Service Worker ไม่ตอบสนองหลังจากที่สิ้นสุดการใช้งานแล้ว

ขั้นตอนที่ 6: แก้ไข Service Worker

ถัดไป ให้แก้ไข Service Worker โดยยกเลิกการพึ่งพาสถานะชั่วคราว อัปเดตส่วนขยายทดสอบเพื่อใช้โค้ดต่อไปนี้ ซึ่งเก็บอยู่ใน service-worker-fixed.js ในที่เก็บ

service-worker-fixed.js:

chrome.runtime.onInstalled.addListener(() => {
  chrome.storage.local.set({ version: chrome.runtime.getManifest().version });
});

chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
  chrome.storage.local.get('version').then((data) => {
    sendResponse(data.version);
  });
  return true;
});

ในส่วนนี้ เราจะบันทึกเวอร์ชันลงใน chrome.storage.local แทนตัวแปรร่วมเพื่อคงสถานะไว้ระหว่างอายุการใช้งานของ Service Worker เนื่องจากจะเข้าถึงพื้นที่เก็บข้อมูลได้แบบไม่พร้อมกันเท่านั้น เราจึงแสดงผลค่าเป็น true จาก Listener ของ onMessage ด้วยเพื่อให้แน่ใจว่าโค้ดเรียกกลับของ sendResponse จะยังคงใช้งานได้

ขั้นตอนที่ 7: ทำการทดสอบอีกครั้ง

ทำการทดสอบอีกครั้งด้วย npm start ตอนนี้รหัสก็น่าจะผ่านแล้ว

ขั้นตอนถัดไป

ตอนนี้คุณใช้แนวทางเดียวกันนี้กับส่วนขยายของตัวเองได้แล้ว ลองพิจารณาสิ่งต่อไปนี้

• สร้างชุดทดสอบเพื่อรองรับการใช้งานโดยมีหรือไม่มีการสิ้นสุดการทำงานของ Service Worker ที่ไม่คาดคิด จากนั้นคุณจะเรียกใช้ทั้ง 2 โหมดแยกกันได้เพื่ออธิบายสาเหตุของความล้มเหลวให้ชัดเจนยิ่งขึ้น
• เขียนโค้ดเพื่อสิ้นสุด Service Worker ที่จุดแบบสุ่มภายในการทดสอบ วิธีนี้เป็นวิธีที่ดีในการค้นพบปัญหาที่อาจคาดการณ์ได้ยาก
• เรียนรู้จากความล้มเหลวในการทดสอบและพยายามเขียนโค้ดเพื่อป้องกันข้อผิดพลาดในอนาคต เช่น เพิ่มกฎ Linting เพื่อไม่ให้ใช้ตัวแปรร่วมและพยายามย้ายข้อมูลให้อยู่ในสถานะถาวรมากขึ้น