Unverified Commit c594b9fb authored by Sam Poder's avatar Sam Poder Committed by GitHub

[turbopack] Compile service workers registered from pages router pages (#95583)

Thanks @mischnic for catching this! I've added a test to ensure that
service workers work in pages router.
parent 29bbdfbd
...@@ -83,6 +83,7 @@ use crate::{ ...@@ -83,6 +83,7 @@ use crate::{
}, },
project::Project, project::Project,
route::{Endpoint, EndpointOutput, EndpointOutputPaths, ModuleGraphs, Route, Routes}, route::{Endpoint, EndpointOutput, EndpointOutputPaths, ModuleGraphs, Route, Routes},
service_worker::service_worker_output_assets,
sri_manifest::get_sri_manifest_asset, sri_manifest::get_sri_manifest_asset,
}; };
...@@ -1324,6 +1325,18 @@ impl PageEndpoint { ...@@ -1324,6 +1325,18 @@ impl PageEndpoint {
client_assets.extend(client_chunk_group.all_assets().await?.iter().copied()); client_assets.extend(client_chunk_group.all_assets().await?.iter().copied());
let client_chunks = *client_chunk_group.await?.assets; let client_chunks = *client_chunk_group.await?.assets;
// Compile any service workers registered via `navigator.serviceWorker.register(new
// URL(...), { scope })` reachable from this page's client graph.
client_assets.extend(
service_worker_output_assets(
this.pages_project.project(),
self.client_module_graph(),
)
.await?
.iter()
.copied(),
);
let build_manifest = self.build_manifest(client_chunks).to_resolved().await?; let build_manifest = self.build_manifest(client_chunks).to_resolved().await?;
let page_loader = self.page_loader(client_chunks).to_resolved().await?; let page_loader = self.page_loader(client_chunks).to_resolved().await?;
let client_build_manifest = self let client_build_manifest = self
......
/// <reference lib="webworker" />
// A minimal service worker used to verify that
// `navigator.serviceWorker.register(new URL(...))` is compiled and served
// correctly. It claims clients immediately and intercepts a sentinel request.
declare const self: ServiceWorkerGlobalScope
self.addEventListener('install', () => {
self.skipWaiting()
})
self.addEventListener('activate', (event) => {
event.waitUntil(self.clients.claim())
})
self.addEventListener('fetch', (event) => {
const url = new URL(event.request.url)
if (url.pathname === '/sw-intercepted') {
event.respondWith(
new Response('intercepted-by-sw', {
headers: { 'content-type': 'text/plain' },
})
)
}
})
export {}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}
module.exports = nextConfig
import { useEffect, useState } from 'react'
export default function Page() {
const [scope, setScope] = useState('default')
const [controller, setController] = useState('default')
const [script, setScript] = useState('default')
const [fetchResult, setFetchResult] = useState('default')
useEffect(() => {
if (!('serviceWorker' in navigator)) {
setController('unsupported')
return
}
async function register() {
const registration = await navigator.serviceWorker.register(
new URL('../lib/pwa', import.meta.url)
)
setScope(registration.scope)
await navigator.serviceWorker.ready
const updateController = () => {
const active = navigator.serviceWorker.controller
setController(active ? 'controlled' : 'none')
if (active) {
setScript(new URL(active.scriptURL).pathname)
}
}
updateController()
navigator.serviceWorker.addEventListener(
'controllerchange',
updateController
)
}
register().catch((err) => {
setController('error: ' + err.message)
})
}, [])
return (
<div>
<p id="sw-scope">{scope}</p>
<p id="sw-controller">{controller}</p>
<p id="sw-script">{script}</p>
<button
onClick={async () => {
const res = await fetch('/sw-intercepted')
setFetchResult(await res.text())
}}
>
Fetch through service worker
</button>
<p id="fetch-result">{fetchResult}</p>
</div>
)
}
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
// Compiling `navigator.serviceWorker.register(new URL(...))` is a
// Turbopack-only feature.
;(process.env.IS_TURBOPACK_TEST ? describe : describe.skip)(
'pages dir - service worker register',
() => {
const { next } = nextTestSetup({
files: __dirname,
})
it('registers the service worker and controls the page at scope "/"', async () => {
const browser = await next.browser('/')
await retry(async () => {
expect(await browser.elementByCss('#sw-controller').text()).toBe(
'controlled'
)
})
const scope = await browser.elementByCss('#sw-scope').text()
expect(new URL(scope).pathname).toBe('/')
const script = await browser.elementByCss('#sw-script').text()
expect(script).toBe('/_next/static/service-worker/sw.js')
})
it('serves the worker chunk as a revalidated, mutable asset', async () => {
const res = await next.fetch('/_next/static/service-worker/sw.js')
expect(res.status).toBe(200)
const cacheControl = res.headers.get('cache-control')
expect(cacheControl).not.toContain('immutable')
expect(cacheControl).toContain('max-age=0')
expect(res.headers.get('service-worker-allowed')).toBe('/')
})
it('intercepts fetches within scope', async () => {
const browser = await next.browser('/')
await retry(async () => {
expect(await browser.elementByCss('#sw-controller').text()).toBe(
'controlled'
)
})
await browser.elementByCss('button').click()
await retry(async () => {
expect(await browser.elementByCss('#fetch-result').text()).toBe(
'intercepted-by-sw'
)
})
})
}
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment