Add support for injecting manifest into service workers

packages/configs/default/index.json

@@ -47,7 +47,8 @@
   "runtimes": [
     "@parcel/runtime-js",
     "@parcel/runtime-browser-hmr",
-    "@parcel/runtime-react-refresh"
+    "@parcel/runtime-react-refresh",
+    "@parcel/runtime-service-worker"
   ],
   "optimizers": {
     "data-url:*": ["...", "@parcel/optimizer-data-url"],

packages/configs/default/package.json

@@ -35,6 +35,7 @@
     "@parcel/runtime-browser-hmr": "2.0.0-rc.0",
     "@parcel/runtime-js": "2.0.0-rc.0",
     "@parcel/runtime-react-refresh": "2.0.0-rc.0",
+    "@parcel/runtime-service-worker": "2.0.0-rc.0",
     "@parcel/transformer-babel": "2.0.0-rc.0",
     "@parcel/transformer-css": "2.0.0-rc.0",
     "@parcel/transformer-html": "2.0.0-rc.0",

packages/core/core/src/BundleGraph.js

@@ -30,7 +30,7 @@ import {ContentGraph, ALL_EDGE_TYPES, mapVisitor} from '@parcel/graph';
 import {Hash, hashString} from '@parcel/hash';
 import {objectSortedEntriesDeep, getRootDir} from '@parcel/utils';
 
-import {Priority, BundleBehavior} from './types';
+import {Priority, BundleBehavior, SpecifierType} from './types';
 import {getBundleGroupId, getPublicId} from './utils';
 import {ISOLATED_ENVS} from './public/Environment';
 import {fromProjectPath} from './projectPath';
@@ -703,11 +703,12 @@ export default class BundleGraph {
       this._graph
         .getNodeIdsConnectedTo(assetNodeId, 'references')
         .map(id => this._graph.getNode(id))
-        .filter(
+        .some(
           node =>
             node?.type === 'dependency' &&
-            node.value.priority === Priority.lazy,
-        ).length > 0
+            node.value.priority === Priority.lazy &&
+            node.value.specifierType !== SpecifierType.url,
+        )
     ) {
       // If this asset is referenced by any async dependency, it's referenced.
       return true;

packages/core/core/src/requests/EntryRequest.js

@@ -248,7 +248,9 @@ export class EntryResolver {
         if (!allTargetsHaveSource && pkg.source != null) {
           let pkgSources = Array.isArray(pkg.source)
             ? pkg.source
-            : [pkg.source];
+            : typeof pkg.source === 'string'
+            ? [pkg.source]
+            : [];
           let i = 0;
           for (let pkgSource of pkgSources) {
             let source = path.join(path.dirname(filePath), pkgSource);

packages/core/integration-tests/test/integration/service-worker/manifest-worker.js

@@ -0,0 +1,3 @@
+import {manifest, version} from '@parcel/runtime-service-worker';
+
+output(manifest, version);

packages/core/integration-tests/test/integration/service-worker/manifest.js

@@ -0,0 +1 @@
+navigator.serviceWorker.register(new URL('manifest-worker.js', import.meta.url), {type: 'module'});

packages/core/integration-tests/test/javascript.js

@@ -1587,6 +1587,39 @@ describe('javascript', function() {
     assert(errored);
   });
 
+  it('should expose a manifest to service workers', async function() {
+    let b = await bundle(
+      path.join(__dirname, '/integration/service-worker/manifest.js'),
+      {
+        defaultTargetOptions: {
+          shouldScopeHoist: true,
+        },
+      },
+    );
+
+    assertBundles(b, [
+      {
+        name: 'manifest.js',
+        assets: ['manifest.js', 'bundle-url.js'],
+      },
+      {
+        assets: ['manifest-worker.js', 'browser.js'],
+      },
+    ]);
+
+    let bundles = b.getBundles();
+    let worker = bundles.find(b => b.env.isWorker());
+    let manifest, version;
+    await await runBundle(b, worker, {
+      output(m, v) {
+        manifest = m;
+        version = v;
+      },
+    });
+    assert.deepEqual(manifest, ['/manifest.js']);
+    assert.equal(typeof version, 'string');
+  });
+
   it('should recognize serviceWorker.register with static URL and import.meta.url', async function() {
     let b = await bundle(
       path.join(

packages/core/package-manager/src/NodeResolverBase.js

@@ -84,7 +84,15 @@ export class NodeResolverBase<T> {
       pkg.name.startsWith('@parcel/') &&
       pkg.name !== '@parcel/watcher'
     ) {
-      main = pkg.source;
+      if (
+        pkg.main &&
+        typeof pkg.source === 'object' &&
+        !Array.isArray(pkg.source)
+      ) {
+        main = pkg.source[pkg.main];
+      } else {
+        main = pkg.source;
+      }
     }
 
     return [main]

packages/core/test-utils/src/utils.js

@@ -310,7 +310,8 @@ export async function runBundles(
       promises = prepared.promises;
       break;
     }
-    case 'web-worker': {
+    case 'web-worker':
+    case 'service-worker': {
       let prepared = prepareWorkerContext(parent.filePath, globals);
       ctx = prepared.ctx;
       promises = prepared.promises;

packages/core/types/index.js

@@ -258,7 +258,7 @@ export type PackageJSON = {
   module?: FilePath,
   types?: FilePath,
   browser?: FilePath | {[FilePath]: FilePath | boolean, ...},
-  source?: FilePath | Array<FilePath>,
+  source?: FilePath | Array<FilePath> | {|[string]: string|},
   alias?: {[PackageName | FilePath | Glob]: PackageName | FilePath, ...},
   browserslist?: Array<string> | {[string]: Array<string>},
   engines?: Engines,

packages/packagers/js/src/ScopeHoistingPackager.js

@@ -244,7 +244,7 @@ export class ScopeHoistingPackager {
         this.bundleGraph.isAssetReferenced(this.bundle, asset) ||
         this.bundleGraph
           .getIncomingDependencies(asset)
-          .some(dep => dep.meta.shouldWrap)
+          .some(dep => dep.meta.shouldWrap && dep.specifierType !== 'url')
       ) {
         this.wrappedAssets.add(asset.id);
         return true;

packages/runtimes/service-worker/browser.d.ts

@@ -0,0 +1,2 @@
+export const manifest: string[];
+export const version: string;

packages/runtimes/service-worker/browser.js

@@ -0,0 +1,8 @@
+export let manifest = [];
+export let version = '';
+
+// Called by the runtime.
+export function _register(m, v) {
+  manifest = m;
+  version = v;
+}

packages/runtimes/service-worker/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@parcel/runtime-service-worker",
+  "version": "2.0.0-rc.0",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/parcel"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/parcel-bundler/parcel.git"
+  },
+  "main": "./lib/ServiceWorkerRuntime.js",
+  "source": {
+    "./lib/ServiceWorkerRuntime.js": "./src/ServiceWorkerRuntime.js"
+  },
+  "browser": "browser.js",
+  "types": "browser.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">= 12.0.0",
+    "parcel": "^2.0.0-beta.1"
+  },
+  "dependencies": {
+    "@parcel/plugin": "2.0.0-rc.0",
+    "@parcel/utils": "2.0.0-rc.0",
+    "nullthrows": "^1.1.1"
+  }
+}

packages/runtimes/service-worker/src/ServiceWorkerRuntime.js

@@ -0,0 +1,50 @@
+// @flow
+import {Runtime} from '@parcel/plugin';
+import {urlJoin} from '@parcel/utils';
+
+export default (new Runtime({
+  async apply({bundle, bundleGraph}) {
+    if (bundle.env.context !== 'service-worker') {
+      return [];
+    }
+
+    let hasDep;
+    bundle.traverse((node, _, actions) => {
+      if (
+        node.type === 'dependency' &&
+        node.value.specifier === '@parcel/runtime-service-worker'
+      ) {
+        hasDep = true;
+        actions.stop();
+      }
+    });
+
+    if (!hasDep) {
+      return [];
+    }
+
+    let manifest = [];
+    bundleGraph.traverseBundles((b, _, actions) => {
+      if (b.bundleBehavior === 'inline' || b.id === bundle.id) {
+        return;
+      }
+
+      manifest.push(urlJoin(b.target.publicUrl, b.name));
+    });
+
+    let code = `import {_register} from '@parcel/runtime-service-worker';
+const manifest = ${JSON.stringify(manifest)};
+const version = ${JSON.stringify(bundle.hashReference)};
+_register(manifest, version);
+`;
+
+    return [
+      {
+        filePath: __filename,
+        code,
+        isEntry: true,
+        env: {sourceType: 'module'},
+      },
+    ];
+  },
+}): Runtime);