Skip to content
Frontend70-100 min

Service Workers and Offline Support

Register a service worker, cache the app shell, use route-specific strategies, and avoid stale-cache deployment bugs.

Service WorkerWorkboxPWACache API

Prerequisites

  • A web app served over HTTPS in production.
  • A list of assets and routes that should work offline.
  • A plan for service worker updates.
1

Plan the implementation

Start by choosing the exact page, route, API, or deployment surface you want to improve. A narrow target makes the implementation measurable and easier to verify.

  1. Write down the current behavior and the user-facing problem it creates.
  2. Pick one measurable success signal such as bundle size, latency, error rate, security coverage, or UI responsiveness.
  3. Identify the files, routes, providers, and environment variables involved.
  4. Create a rollback note before changing production-sensitive configuration.
2

Set up the required tools

Install or configure only the tools needed for this implementation. Keep config close to the feature so future developers can find the moving parts quickly.

Implementation snippet
npm install -D vite-plugin-pwa workbox-window
Checklist
  • Dependencies are added to the correct workspace package.
  • Environment variables are documented in `.env.example` when needed.
  • Local development still starts without production-only secrets.
  • The change is small enough to review in one pull request.
3

Implement the core pattern

  1. Decide whether you need offline fallback, faster repeat visits, or both.
  2. Precache the app shell and static assets generated by the build.
  3. Use network-first for fresh API data and cache-first for versioned assets.
  4. Show an offline page when navigation cannot reach the network.
  5. Test update behavior after deploying a changed build.
Implementation snippet
if ("serviceWorker" in navigator) {
  window.addEventListener("load", () => {
    navigator.serviceWorker.register("/sw.js");
  });
}
4

Handle edge cases

Checklist
  • The app does not serve old JavaScript forever after deploy.
  • Authenticated API responses are not blindly cached.
  • Offline fallback works in airplane mode.
  • Users can recover after a bad or stale service worker update.
5

Verify before production

  1. Run the app locally and test the normal success path.
  2. Test one failure path, one empty state, and one slow-network or retry path.
  3. Run the project build and any related unit or integration tests.
  4. Check browser console, server logs, and network responses for hidden warnings.
  5. Document the final behavior, commands used, and any follow-up work.

Need implementation help?

Want this built correctly in your codebase?

Send us your stack, repo context, and the feature you need. We will help you implement it cleanly and hand over the working code.

Free scoping callFixed timelineFull source ownership
Get implementation help