Skip to content

Commit

Permalink
fix(@angular-devkit/build-angular): ensure WebWorker main entry is us…
Browse files Browse the repository at this point in the history
…ed in output code

Previously, the check for determining the correct main entry point for a bundled web worker
found in application code could incorrectly use a lazy chunk created from the worker bundling
under certain situations. The check has now been made more strict to mitigate these situations.
  • Loading branch information
clydin committed Feb 8, 2024
1 parent a957ede commit 1aeeb7d
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

import { buildApplication } from '../../index';
import { APPLICATION_BUILDER_INFO, BASE_OPTIONS, describeBuilder } from '../setup';

/**
* A regular expression used to check if a built worker is correctly referenced in application code.
*/
const REFERENCED_WORKER_REGEXP =
/new Worker\(new URL\("worker-[A-Z0-9]{8}\.js", import\.meta\.url\)/;

describeBuilder(buildApplication, APPLICATION_BUILDER_INFO, (harness) => {
describe('Behavior: "Bundles web worker files within application code"', () => {
it('should use the worker entry point when worker lazy chunks are present', async () => {
harness.useTarget('build', {
...BASE_OPTIONS,
});

const workerCodeFile = `
addEventListener('message', () => {
import('./extra').then((m) => console.log(m.default));
});
`;
const extraWorkerCodeFile = `
export default 'WORKER FILE';
`;

// Create a worker file
await harness.writeFile('src/app/worker.ts', workerCodeFile);
await harness.writeFile('src/app/extra.ts', extraWorkerCodeFile);

// Create app component that uses the directive
await harness.writeFile(
'src/app/app.component.ts',
`
import { Component } from '@angular/core'
@Component({
selector: 'app-root',
template: '<h1>Worker Test</h1>',
})
export class AppComponent {
worker = new Worker(new URL('./worker', import.meta.url), { type: 'module' });
}
`,
);

const { result } = await harness.executeOnce();
expect(result?.success).toBeTrue();

// Ensure built worker is referenced in the application code
harness.expectFile('dist/browser/main.js').content.toMatch(REFERENCED_WORKER_REGEXP);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ export function createCompilerPlugin(

// Return bundled worker file entry name to be used in the built output
const workerCodeFile = workerResult.outputFiles.find((file) =>
file.path.endsWith('.js'),
/^worker-[A-Z0-9]{8}.[cm]?js$/.test(path.basename(file.path)),
);
assert(workerCodeFile, 'Web Worker bundled code file should always be present.');
const workerCodePath = path.relative(
Expand Down

0 comments on commit 1aeeb7d

Please sign in to comment.