forked from GoogleChrome/chrome-extensions-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add examples for testing service worker termination (GoogleChrome#1078)
* Add examples for testing service worker termination * Add example of failing case to tutorial
- Loading branch information
1 parent
b5e3683
commit c5287cd
Showing
14 changed files
with
17,570 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Testing service worker termination | ||
|
||
## Overview | ||
|
||
**Note:** The test extension is intentionally broken as part of a tutorial in | ||
our documentation. See [Test service worker termination with Puppeteer](https://developer.chrome.com/docs/extensions/how-to/test/test-serviceworker-termination-with-puppeteer). | ||
|
||
Sample code to show how to terminate a service worker in Puppeteer or Selenium. | ||
|
||
## Running the tests | ||
|
||
1. Install [Node.JS](https://nodejs.org/). | ||
2. Change to the `puppeteer` or `selenium` directory. | ||
3. Run `npm install`. | ||
4. Run `npm start`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"extends": ["../../../.eslintrc"], | ||
"plugins": ["jest"], | ||
"env": { | ||
"jest/globals": true | ||
} | ||
} |
86 changes: 86 additions & 0 deletions
86
functional-samples/tutorial.terminate-sw/puppeteer/index.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
// Copyright 2023 Google LLC | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// https://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
// eslint-disable-next-line no-undef | ||
const puppeteer = require('puppeteer'); | ||
|
||
const EXTENSION_PATH = '../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; | ||
}); | ||
|
||
/** | ||
* 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} page Puppeteer page that CDP session can be started from | ||
* @param {string} extensionId Extension ID of worker to terminate | ||
*/ | ||
async function stopServiceWorker(page, extensionId) { | ||
const host = `chrome-extension://${extensionId}`; | ||
|
||
// Create a new CDP session | ||
const client = await page.target().createCDPSession(); | ||
|
||
// Find the extension service worker | ||
const targets = await client.send('Target.getTargets'); | ||
const worker = targets.targetInfos.find( | ||
(t) => t.type === 'service_worker' && t.url.startsWith(host) | ||
); | ||
|
||
if (!worker) { | ||
throw new Error(`No worker found for ${host}`); | ||
} | ||
|
||
// Terminate the service worker | ||
await client.send('Target.closeTarget', { | ||
targetId: worker.targetId | ||
}); | ||
|
||
// End the CDP session | ||
await client.detach(); | ||
} | ||
|
||
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'); | ||
}); |
Oops, something went wrong.