fix(@angular-devkit/build-angular): correctly resolve custom service …

…worker configuration file Paths within the `angular.json` file should be relative to the location of the `angular.json` file. The `ngswConfigPath` option was incorrectly using the current working directory for a base path when a relative configuration path was specified. Most of the time this would work as a build command usually is executed from the root of the workspace. However, this may not always be the case and for those cases the actual workspace root is now used to resolve the full path for the service worker configuration file.
angular · Apr 27, 2022 · 7abe212 · 7abe212
1 parent 586f393
commit 7abe212
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/packages/angular_devkit/build_angular/src/builders/app-shell/index.ts b/packages/angular_devkit/build_angular/src/builders/app-shell/index.ts
@@ -115,6 +115,7 @@ async function _renderUniversal(
     if (browserOptions.serviceWorker) {
       await augmentAppWithServiceWorker(
         projectRoot,
+        root,
         outputPath,
         browserOptions.baseHref || '/',
         browserOptions.ngswConfigPath,

diff --git a/packages/angular_devkit/build_angular/src/builders/browser/index.ts b/packages/angular_devkit/build_angular/src/builders/browser/index.ts
@@ -348,6 +348,7 @@ export function buildWebpackBrowser(
                     try {
                       await augmentAppWithServiceWorker(
                         projectRoot,
+                        context.workspaceRoot,
                         outputPath,
                         getLocaleBaseHref(i18n, locale) || options.baseHref || '/',
                         options.ngswConfigPath,

diff --git a/packages/angular_devkit/build_angular/src/builders/browser/specs/service-worker_spec.ts b/packages/angular_devkit/build_angular/src/builders/browser/specs/service-worker_spec.ts
@@ -52,6 +52,24 @@ describe('Browser Builder service worker', () => {
     await run.stop();
   });
 
+  it('supports specifying a custom service worker configuration file', async () => {
+    host.writeMultipleFiles({
+      'src/configs/ngsw.json': JSON.stringify(manifest),
+      'src/assets/folder-asset.txt': 'folder-asset.txt',
+      'src/styles.css': `body { background: url(./spectrum.png); }`,
+    });
+
+    const overrides = { serviceWorker: true, ngswConfigPath: 'src/configs/ngsw.json' };
+
+    const run = await architect.scheduleTarget(target, overrides);
+
+    await expectAsync(run.result).toBeResolvedTo(jasmine.objectContaining({ success: true }));
+
+    await run.stop();
+
+    expect(host.scopedSync().exists(normalize('dist/ngsw.json'))).toBeTrue();
+  });
+
   it('works with service worker', async () => {
     host.writeMultipleFiles({
       'src/ngsw-config.json': JSON.stringify(manifest),

diff --git a/packages/angular_devkit/build_angular/src/utils/service-worker.ts b/packages/angular_devkit/build_angular/src/utils/service-worker.ts
@@ -62,13 +62,14 @@ class CliFilesystem implements Filesystem {
 
 export async function augmentAppWithServiceWorker(
   appRoot: string,
+  workspaceRoot: string,
   outputPath: string,
   baseHref: string,
   ngswConfigPath?: string,
 ): Promise<void> {
   // Determine the configuration file path
   const configPath = ngswConfigPath
-    ? path.normalize(ngswConfigPath)
+    ? path.join(workspaceRoot, ngswConfigPath)
     : path.join(appRoot, 'ngsw-config.json');
 
   // Read the configuration file