/** * @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.dev/license */ import { join, normalize, tags } from '@angular-devkit/core'; import { Rule, SchematicContext, SchematicsException, Tree, apply, applyTemplates, chain, mergeWith, move, noop, strings, url, } from '@angular-devkit/schematics'; import { parseName } from '../utility/parse-name'; import { relativePathToWorkspaceRoot } from '../utility/paths'; import { buildDefaultPath, getWorkspace, updateWorkspace } from '../utility/workspace'; import { Schema as WebWorkerOptions } from './schema'; function addSnippet(options: WebWorkerOptions): Rule { return (host: Tree, context: SchematicContext) => { context.logger.debug('Updating appmodule'); if (options.path === undefined) { return; } const fileRegExp = new RegExp(`^${options.name}.*\\.ts`); const siblingModules = host .getDir(options.path) .subfiles // Find all files that start with the same name, are ts files, // and aren't spec or module files. .filter((f) => fileRegExp.test(f) && !/(module|spec)\.ts$/.test(f)) // Sort alphabetically for consistency. .sort(); if (siblingModules.length === 0) { // No module to add in. return; } const siblingModulePath = `${options.path}/${siblingModules[0]}`; const logMessage = 'console.log(`page got message: ${data}`);'; const workerCreationSnippet = tags.stripIndent` if (typeof Worker !== 'undefined') { // Create a new const worker = new Worker(new URL('./${options.name}.worker', import.meta.url)); worker.onmessage = ({ data }) => { ${logMessage} }; worker.postMessage('hello'); } else { // Web Workers are not supported in this environment. // You should add a fallback so that your program still executes correctly. } `; // Append the worker creation snippet. const originalContent = host.readText(siblingModulePath); host.overwrite(siblingModulePath, originalContent + '\n' + workerCreationSnippet); return host; }; } export default function (options: WebWorkerOptions): Rule { return async (host: Tree) => { const workspace = await getWorkspace(host); if (!options.project) { throw new SchematicsException('Option "project" is required.'); } const project = workspace.projects.get(options.project); if (!project) { throw new SchematicsException(`Invalid project name (${options.project})`); } const projectType = project.extensions['projectType']; if (projectType !== 'application') { throw new SchematicsException(`Web Worker requires a project type of "application".`); } if (options.path === undefined) { options.path = buildDefaultPath(project); } const parsedPath = parseName(options.path, options.name); options.name = parsedPath.name; options.path = parsedPath.path; const templateSourceWorkerCode = apply(url('./files/worker'), [ applyTemplates({ ...options, ...strings }), move(parsedPath.path), ]); const root = project.root || ''; const templateSourceWorkerConfig = apply(url('./files/worker-tsconfig'), [ applyTemplates({ ...options, relativePathToWorkspaceRoot: relativePathToWorkspaceRoot(root), }), move(root), ]); return chain([ // Add project configuration. updateWorkspace((workspace) => { // eslint-disable-next-line @typescript-eslint/no-non-null-assertion const project = workspace.projects.get(options.project)!; const buildTarget = project.targets.get('build'); const testTarget = project.targets.get('test'); if (!buildTarget) { throw new Error(`Build target is not defined for this project.`); } const workerConfigPath = join(normalize(root), 'tsconfig.worker.json'); (buildTarget.options ??= {}).webWorkerTsConfig ??= workerConfigPath; if (testTarget) { (testTarget.options ??= {}).webWorkerTsConfig ??= workerConfigPath; } }), // Create the worker in a sibling module. options.snippet ? addSnippet(options) : noop(), // Add the worker. mergeWith(templateSourceWorkerCode), mergeWith(templateSourceWorkerConfig), ]); }; }